Explicitly sort entries in .github/CODEOWNERS file (#69)

* Explicitly sort entries in CODEOWNERS file

* bump version

Author: Alex Evanczuk

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    code_ownership (1.32.18)
+    code_ownership (1.32.19)
       code_teams (~> 1.0)
       packs
       sorbet-runtime (>= 0.5.10821)

code_ownership.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = 'code_ownership'
-  spec.version       = '1.32.18'
+  spec.version       = '1.32.19'
   spec.authors       = ['Gusto Engineers']
   spec.email         = ['[email protected]']
   spec.summary       = 'A gem to help engineering teams declare ownership of code'

lib/code_ownership/private/codeowners_file.rb

@@ -53,7 +53,10 @@ def self.expected_contents_lines
 
         cache.each do |mapper_description, ownership_map_cache|
           ownership_entries = []
-          ownership_map_cache.each do |path, code_team|
+          sorted_ownership_map_cache = ownership_map_cache.sort_by do |glob, team|
+            glob
+          end
+          sorted_ownership_map_cache.to_h.each do |path, code_team|
             team_mapping = github_team_map[code_team.name]
             next if team_mapping.nil?
 

lib/code_ownership/private/validations/github_codeowners_up_to_date.rb

@@ -14,10 +14,8 @@ def validation_errors(files:, autocorrect: true, stage_changes: true)
 
           actual_content_lines = CodeownersFile.actual_contents_lines
           expected_content_lines = CodeownersFile.expected_contents_lines
-          missing_lines = expected_content_lines - actual_content_lines
-          extra_lines = actual_content_lines - expected_content_lines
 
-          codeowners_up_to_date = !missing_lines.any? && !extra_lines.any?
+          codeowners_up_to_date = actual_content_lines == expected_content_lines
           errors = T.let([], T::Array[String])
 
           if !codeowners_up_to_date
@@ -26,8 +24,14 @@ def validation_errors(files:, autocorrect: true, stage_changes: true)
               if stage_changes
                 `git add #{CodeownersFile.path}`
               end
+            # If there is no current file or its empty, display a shorter message.
+            elsif actual_content_lines == [""]
+              errors << <<~CODEOWNERS_ERROR
+                CODEOWNERS out of date. Run `bin/codeownership validate` to update the CODEOWNERS file
+              CODEOWNERS_ERROR
             else
-              # If there is no current file or its empty, display a shorter message.
+              missing_lines = expected_content_lines - actual_content_lines
+              extra_lines = actual_content_lines - expected_content_lines
 
               missing_lines_text = if missing_lines.any?
                 <<~COMMENT
@@ -50,20 +54,19 @@ def validation_errors(files:, autocorrect: true, stage_changes: true)
               elsif extra_lines_text
                 extra_lines_text
               else
-                ""
+                <<~TEXT
+                  There may be extra lines, or lines are out of order.
+                  You can try to regenerate the CODEOWNERS file from scratch:
+                  1) `rm .github/CODEOWNERS`
+                  2) `bin/codeownership validate`
+                TEXT
               end
 
-              if actual_content_lines == [""]
-                errors << <<~CODEOWNERS_ERROR
-                  CODEOWNERS out of date. Run `bin/codeownership validate` to update the CODEOWNERS file
-                CODEOWNERS_ERROR
-              else
-                errors << <<~CODEOWNERS_ERROR
-                  CODEOWNERS out of date. Run `bin/codeownership validate` to update the CODEOWNERS file
+              errors << <<~CODEOWNERS_ERROR
+                CODEOWNERS out of date. Run `bin/codeownership validate` to update the CODEOWNERS file
 
-                  #{diff_text.chomp}
-                CODEOWNERS_ERROR
-              end
+                #{diff_text.chomp}
+              CODEOWNERS_ERROR
             end
           end
 

spec/lib/code_ownership/private/validations/github_codeowners_up_to_date_spec.rb

@@ -476,6 +476,56 @@ module CodeOwnership
           end
         end
 
+        context 'in an application with an unsorted CODEOWNERS file' do
+          before { create_non_empty_application }
+
+          it 'prints out the diff' do
+            FileUtils.mkdir('.github')
+            codeowners_path.write <<~CODEOWNERS
+              # STOP! - DO NOT EDIT THIS FILE MANUALLY
+              # This file was automatically generated by "bin/codeownership validate".
+              #
+              # CODEOWNERS is used for GitHub to suggest code/file owners to various GitHub
+              # teams. This is useful when developers create Pull Requests since the
+              # code/file owner is notified. Reference GitHub docs for more details:
+              # https://help.github.com/en/articles/about-code-owners
+
+
+              # Annotations at the top of file
+              /packs/my_pack/owned_file.rb @MyOrg/bar-team
+              /frontend/javascripts/packages/my_package/owned_file.jsx @MyOrg/bar-team
+
+              # Owner metadata key in package.yml
+              /packs/my_other_package/**/** @MyOrg/bar-team
+
+              # Team-specific owned globs
+              /app/services/bar_stuff/** @MyOrg/bar-team
+              /frontend/javascripts/bar_stuff/** @MyOrg/bar-team
+
+              # Owner metadata key in package.json
+              /frontend/javascripts/packages/my_other_package/**/** @MyOrg/bar-team
+
+              # Team YML ownership
+              /config/teams/bar.yml @MyOrg/bar-team
+            CODEOWNERS
+
+            expect_any_instance_of(codeowners_validation).to_not receive(:`) # rubocop:disable RSpec/AnyInstance
+            expect { CodeOwnership.validate!(autocorrect: false) }.to raise_error do |e|
+              expect(e).to be_a CodeOwnership::InvalidCodeOwnershipConfigurationError
+              expect(e.message).to eq <<~EXPECTED.chomp
+                CODEOWNERS out of date. Run `bin/codeownership validate` to update the CODEOWNERS file
+
+                There may be extra lines, or lines are out of order.
+                You can try to regenerate the CODEOWNERS file from scratch:
+                1) `rm .github/CODEOWNERS`
+                2) `bin/codeownership validate`
+
+                See https://github.com/rubyatscale/code_ownership#README.md for more details
+              EXPECTED
+            end
+          end
+        end
+
         context 'in an application with a CODEOWNERS file that has a reference to a github team that no longer exists' do
           before do
             write_configuration
@@ -656,6 +706,7 @@ module CodeOwnership
               # code/file owner is notified. Reference GitHub docs for more details:
               # https://help.github.com/en/articles/about-code-owners
 
+
               # Annotations at the top of file
               /packs/my_pack/had_annotation_file.rb @MyOrg/bar-team