added duplications checks for CHANGELOG

Author: dzinad

scripts/validate-changelog-tests.py

@@ -124,6 +124,26 @@ def test_extract_added_lines_only_changelog_has_added(self):
         '''
         self.assertEqual(validate_changelog_utils.extract_added_lines(diff), expected)
 
+    def test_extract_added_lines_only_changelog_has_added_with_blank_lines(self):
+        expected = {
+            "CHANGELOG.md" : ['- Added third unreleased feature. [#6050](https://github.com/mapbox/mapbox-navigation-android/pull/6050)']
+        }
+        diff = '''diff --git a/CHANGELOG.md b/CHANGELOG.md
+        --- a/CHANGELOG.md	(revision fca6af9072a1b6cb7263460f7c3270e48bffed07)
+        +++ b/CHANGELOG.md	(date 1659101777554)
+        @@ -6,6 +6,7 @@
+         #### Features
+         - Added first unreleased feature. [#6049](https://github.com/mapbox/mapbox-navigation-android/pull/6049)
+         - Added second unreleased feature. [#6048](https://github.com/mapbox/mapbox-navigation-android/pull/6048)
+        +- Added third unreleased feature. [#6050](https://github.com/mapbox/mapbox-navigation-android/pull/6050)
+        +
+        +
+
+         #### Bug fixes and improvements
+         - Fixed first unreleased bug. [#6047](https://github.com/mapbox/mapbox-navigation-android/pull/6047)
+        '''
+        self.assertEqual(validate_changelog_utils.extract_added_lines(diff), expected)
+
     def test_extract_added_lines_only_changelog_with_path_has_added(self):
         expected = {
             "libnavui-androidauto/CHANGELOG.md" : ['- Added third unreleased feature. [#6050](https://github.com/mapbox/mapbox-navigation-android/pull/6050)']
@@ -642,6 +662,27 @@ def test_check_version_section_single_line_repeats_unstable_version(self):
         added_lines = ['- Added first feature to 2.7.0-beta1. [#6045](https://github.com/mapbox/mapbox-navigation-android/pull/6045)']
         validate_changelog_utils.check_version_section(content, added_lines)
 
+    def test_check_for_duplications_empty_list(self):
+        validate_changelog_utils.check_for_duplications([])
+
+    def test_check_for_duplications_single_unique_element(self):
+        added_lines = ['- Line 1']
+        validate_changelog_utils.check_for_duplications(added_lines)
+
+    def test_check_for_duplications_single_repeated_element(self):
+        added_lines = ['- Line 1', '- Line 1']
+        with self.assertRaises(Exception):
+            validate_changelog_utils.check_for_duplications(added_lines)
+
+    def test_check_for_duplications_multiple_unique_elements(self):
+        added_lines = ['- Line 1', '- Line 2', '- Line 3']
+        validate_changelog_utils.check_for_duplications(added_lines)
+
+    def test_check_for_duplications_multiple_elements_with_repeated(self):
+        added_lines = ['- Line 1', '- Line 2', '- Line 3', '- Line 2']
+        with self.assertRaises(Exception):
+            validate_changelog_utils.check_for_duplications(added_lines)
+
     def read_test_changelog(self, filename):
         script_dir = os.path.dirname(__file__)
         rel_path = "test_resources/" + filename

scripts/validate-changelog.py

@@ -29,6 +29,7 @@
             with requests.get(files_url, headers) as files_response:
                 contents_urls_by_file = validate_changelog_utils.parse_contents_url(files_response.json())
                 for (filename, contents_url) in contents_urls_by_file.items():
+                    validate_changelog_utils.check_for_duplications(added_lines_by_file[filename])
                     with requests.get(contents_url, headers) as contents_response:
                         content = base64.b64decode(contents_response.json()["content"]).decode("utf-8")
                         validate_changelog_utils.check_version_section(content, added_lines_by_file[filename])

scripts/validate_changelog_utils.py

@@ -10,6 +10,9 @@
 def is_line_added(line):
     return line.strip().startswith('+')
 
+def is_line_not_blank(line):
+    return len(line.strip()) > 0
+
 def remove_plus(line):
     return line.strip()[1:]
 
@@ -24,7 +27,7 @@ def group_by_versions(lines):
                     groups[group_name] = group
                 group = []
             group_name = line
-        elif len(line.strip()) > 0:
+        elif is_line_not_blank(line):
             group.append(line)
     if len(group) > 0 and len(group_name.strip()) > 0:
         groups[group_name] = group
@@ -98,7 +101,7 @@ def extract_added_lines(whole_diff):
         diff_searchable = diff_starting_at_changelog[first_changelog_diff_index:last_reachable_index]
 
         diff_lines = diff_searchable.split('\n')
-        added_lines[filename] = list(map(remove_plus, list(filter(is_line_added, diff_lines))))
+        added_lines[filename] = list(filter(is_line_not_blank, map(remove_plus, list(filter(is_line_added, diff_lines)))))
         diff = diff[last_reachable_index:]
     return added_lines
 
@@ -118,8 +121,16 @@ def check_version_section(content, added_lines):
 
     for added_line in added_lines:
         if added_line not in unreleased_group:
-            raise Exception(added_line + " should be placed in 'Unreleased' section")
+            raise Exception("\"" + added_line + "\" should be placed in 'Unreleased' section")
 
         for stable_version in stable_versions:
             if added_line in stable_versions[stable_version]:
-                raise Exception("The changelog entry \"" + added_line + "\" is already contained in " + stable_version + " changelog.")
+                raise Exception("The changelog entry \"" + added_line + "\" is already contained in " + stable_version + " changelog.")
+
+def check_for_duplications(added_lines):
+    unique_added_lines = set()
+    for added_line in added_lines:
+        if added_line in unique_added_lines:
+            raise Exception("\"" + added_line + "\" is added more than once" )
+        else:
+            unique_added_lines.add(added_line)