Correctly order sections

Author: gasparev

gitlab_codeowners_linter/autofix.py

@@ -115,17 +115,18 @@ def _update_codeowners_file(codeowners_data, file_path):
     with open(file_path, 'w') as f:
         for section in codeowners_data:
             # if the default section is empty let's skip it
-            if section.codeowner_section != DEFAULT_SECTION and section != codeowners_data[0]:
+            if section.codeowner_section != DEFAULT_SECTION:
                 f.write('\n')
             if section.comments:
                 for comment_line in section.comments:
                     f.write(f'{comment_line}\n')
             if section.codeowner_section != DEFAULT_SECTION:
                 f.write(f'[{section.codeowner_section}]')
-            f.write('\n')
-            for entry in section.entries:
-                if entry.comments:
-                    for comment_line in entry.comments:
-                        f.write(f'{comment_line}\n')
-                owners = ' '.join(str(x) for x in entry.owners)
-                f.write(f'{entry.path} {owners}\n')
+            if section.entries:
+                f.write('\n')
+                for entry in section.entries:
+                    if entry.comments:
+                        for comment_line in entry.comments:
+                            f.write(f'{comment_line}\n')
+                    owners = ' '.join(str(x) for x in entry.owners)
+                    f.write(f'{entry.path} {owners}\n')

gitlab_codeowners_linter/parser.py

@@ -101,12 +101,4 @@ def parse_codeowners(file_path):
             if _is_empty_line(section.entries[-1].path):
                 section.entries = section.entries[:-1]
 
-    # let's also check if the default section exists, if not let's remove it
-    if codeowners_content[0].entries == []:
-        if codeowners_content[0].comments:
-            for i in range(0, len(codeowners_content[0].comments)):
-                codeowners_content[1].comments.insert(
-                    i, codeowners_content[0].comments[i])
-        codeowners_content.pop(0)
-
     return codeowners_content

tests/resources/no_default_section_autofix.txt

@@ -4,7 +4,17 @@
 #   - sections are not ordered alphabetically
 #   - paths within sections are not sorted alphabetically
 #   - paths within sections have blank lines
+#   - the default section is missing
 #
+
+# Build Group
+[BUILD]
+.gitlab/.gitlab-ci.yml test@email.com
+.gitlab/ci/ test@email.com test1@email.com test2@email.com test3@email.com
+CODEOWNERS @test/teams/build/admin test@email.com test1@email.com test2@email.com test3@email.com
+/ops/gitlab/ test@email.com
+
+# Comment for SECTION_NAME
 [SECTION_NAME]
 * test@email.com test1@email.com test2@email.com test3@email.com
 # this is a comment for *.md test@email.com
@@ -30,13 +40,6 @@ WORKSPACE test@email.com test1@email.com test2@email.com test3@email.com
 /www/ test@email.com
 /www/gitlab/test/path test@email.com
 
-# Build Group
-[BUILD]
-.gitlab/.gitlab-ci.yml test@email.com
-.gitlab/ci/ test@email.com test1@email.com test2@email.com test3@email.com
-CODEOWNERS @test/teams/build/admin test@email.com test1@email.com test2@email.com test3@email.com
-/ops/gitlab/ test@email.com
-
 # Comment for security
 [SECURITY]
 /ops/terraform/path1 test@email.com

tests/resources/no_default_section_input.txt

@@ -4,8 +4,10 @@
 #   - sections are not ordered alphabetically
 #   - paths within sections are not sorted alphabetically
 #   - paths within sections have blank lines
+#   - the default section is missing
 #
 
+# Comment for SECTION_NAME
 [SECTION_NAME]
 # this is a comment for *.md test@email.com
 *.md test@email.com