Update Github CodeTeam Plugin to enforce github.team presence (#79)

* Update Github CodeTeam Plugin to enforce `github.team` presence

* Use GithubStruct

* Ignore CodeTeams without a `github.team` key

* Add `require_github_teams` configuration option

* Update Github Plugin to enforce required_github_teams

* Fix github_codeowners_up_to_date_spec.rb:759

* Add spec for require_github_teams configuration

* Update uniqueness of github teams spec

* Bump minor version to 1.35.0

* Update Gemfile.lock

Author: timlkelly

Gemfile.lock

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

code_ownership.gemspec

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

lib/code_ownership/configuration.rb

@@ -11,6 +11,7 @@ class Configuration < T::Struct
     const :unbuilt_gems_path, T.nilable(String)
     const :skip_codeowners_validation, T::Boolean
     const :raw_hash, T::Hash[T.untyped, T.untyped]
+    const :require_github_teams, T::Boolean
 
     sig { returns(Configuration) }
     def self.fetch
@@ -27,7 +28,8 @@ def self.fetch
         unowned_globs: config_hash.fetch('unowned_globs', []),
         js_package_paths: js_package_paths(config_hash),
         skip_codeowners_validation: config_hash.fetch('skip_codeowners_validation', false),
-        raw_hash: config_hash
+        raw_hash: config_hash,
+        require_github_teams: config_hash.fetch('require_github_teams', false)
       )
     end
 

lib/code_ownership/private/team_plugins/github.rb

@@ -21,14 +21,26 @@ def github
 
         sig { override.params(teams: T::Array[CodeTeams::Team]).returns(T::Array[String]) }
         def self.validation_errors(teams)
-          all_github_teams = teams.flat_map { |team| self.for(team).github.team }
+          all_github_teams = teams.flat_map { |team| self.for(team).github.team }.compact
 
           teams_used_more_than_once = all_github_teams.tally.select do |_team, count|
             count > 1
           end
 
           errors = T.let([], T::Array[String])
 
+          if require_github_teams?
+            missing_github_teams = teams.select { |team| self.for(team).github.team.nil? }
+
+            if missing_github_teams.any?
+              errors << <<~ERROR
+                The following teams are missing `github.team` entries:
+
+                #{missing_github_teams.map(&:config_yml).join("\n")}
+              ERROR
+            end
+          end
+
           if teams_used_more_than_once.any?
             errors << <<~ERROR
               The following teams are specified multiple times:
@@ -40,6 +52,11 @@ def self.validation_errors(teams)
 
           errors
         end
+
+        sig { returns(T::Boolean) }
+        def self.require_github_teams?
+          CodeOwnership.configuration.require_github_teams
+        end
       end
     end
   end

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

@@ -757,25 +757,81 @@ module CodeOwnership
     end
 
     describe 'uniqueness of github teams' do
+      context 'when the CodeTeam has a github.team key' do
+        before do
+          write_configuration
+
+          write_file('config/teams/bar.yml', <<~CONTENTS)
+            name: Bar
+            github:
+              team: '@MyOrg/bar-team'
+          CONTENTS
+
+          write_file('config/teams/foo.yml', <<~CONTENTS)
+            name: Bar
+            github:
+              team: '@MyOrg/bar-team'
+          CONTENTS
+        end
+
+        it 'expect code teams validations to fail' do
+          expect(CodeTeams.validation_errors(CodeTeams.all)).to eq([
+            "More than 1 definition for Bar found",
+            "The following teams are specified multiple times:\nEach code team must have a unique GitHub team in order to write the CODEOWNERS file correctly.\n\n@MyOrg/bar-team\n"
+          ])
+        end
+      end
+
+      context 'when the CodeTeam does not have a github.team key' do
+        before do
+          write_configuration
+
+          write_file('config/teams/bar.yml', <<~CONTENTS)
+            name: Bar
+          CONTENTS
+
+          write_file('config/teams/foo.yml', <<~CONTENTS)
+            name: Bar
+          CONTENTS
+        end
+
+        it 'does not report CodeTeams without github.teams key' do
+          expect(CodeTeams.validation_errors(CodeTeams.all)).to eq([
+            "More than 1 definition for Bar found"
+          ])
+        end
+      end
+    end
+
+    describe 'require_github_teams configuration option' do
       before do
-        write_file('config/teams/bar.yml', <<~CONTENTS)
-          name: Bar
-          github:
-            team: '@MyOrg/bar-team'
-        CONTENTS
+        write_configuration('require_github_teams' => require_github_teams)
 
         write_file('config/teams/foo.yml', <<~CONTENTS)
+          name: Foo
+        CONTENTS
+
+        write_file('config/teams/bar.yml', <<~CONTENTS)
           name: Bar
-          github:
-            team: '@MyOrg/bar-team'
         CONTENTS
       end
 
-      it 'expect code teams validations to fail' do
-        expect(CodeTeams.validation_errors(CodeTeams.all)).to eq([
-          "More than 1 definition for Bar found",
-          "The following teams are specified multiple times:\nEach code team must have a unique GitHub team in order to write the CODEOWNERS file correctly.\n\n@MyOrg/bar-team\n"
-        ])
+      context 'when require_github_teams is enabled' do
+        let(:require_github_teams) { true }
+
+        it 'reports CodeTeams without github.team keys' do
+          expect(CodeTeams.validation_errors(CodeTeams.all)).to eq([
+            "The following teams are missing `github.team` entries:\n\nconfig/teams/bar.yml\nconfig/teams/foo.yml\n"
+          ])
+        end
+      end
+
+      context 'when require_github_teams is disabled' do
+        let(:require_github_teams) { false }
+
+        it 'does not report any errors' do
+          expect(CodeTeams.validation_errors(CodeTeams.all)).to be_empty
+        end
       end
     end
   end