Refactor tests into their own files (#36)

* move for_file for file annotations mapper into its own spec

* move files have owners validation tests into their own file

* move files have unique owners test into its own file

* add note about failing test

* move no overlapping globs validation into its own file

* add note about validation tests

* add package ownership spec

* add team YML ownership spec

* fill out team globs spec and prevent false positives

* delete duplicate for_package spec, which is already present in spec/lib/code_ownership/private/ownership_mappers/package_ownership_spec.rb

* move remove_file_annotation spec to file annotation mapper spec

* fix bad indentation

* move "application has invalid JSON in package" test to JsPackageOwnership spec

* remove unnecessary test setup var

* move JS package ownership for_file test to mapper spec

Author: Alex Evanczuk

spec/lib/code_ownership/private/ownership_mappers/file_annotations_spec.rb

@@ -0,0 +1,218 @@
+module CodeOwnership
+  RSpec.describe Private::OwnershipMappers::FileAnnotations do
+    describe '.for_team' do
+      before do
+        create_configuration
+        write_file('config/teams/bar.yml', <<~CONTENTS)
+          name: Bar
+        CONTENTS
+
+        write_file('packs/my_pack/owned_file.rb', <<~CONTENTS)
+          # @team Bar
+        CONTENTS
+      end
+
+      it 'prints out ownership information for the given team' do
+        expect(CodeOwnership.for_team('Bar')).to eq <<~OWNERSHIP
+          # Code Ownership Report for `Bar` Team
+          ## Annotations at the top of file
+          - packs/my_pack/owned_file.rb
+
+          ## Team-specific owned globs
+          This team owns nothing in this category.
+
+          ## Owner metadata key in package.yml
+          This team owns nothing in this category.
+
+          ## Owner metadata key in package.json
+          This team owns nothing in this category.
+
+          ## Team YML ownership
+          - config/teams/bar.yml
+        OWNERSHIP
+      end
+    end
+
+    describe '.for_file' do
+      context 'ruby owned file' do
+        before do
+          create_configuration
+          write_file('config/teams/bar.yml', <<~CONTENTS)
+            name: Bar
+          CONTENTS
+
+          write_file('packs/my_pack/owned_file.rb', <<~CONTENTS)
+            # @team Bar
+          CONTENTS
+        end
+
+        it 'can find the owner of a ruby file with file annotations' do
+          expect(CodeOwnership.for_file('packs/my_pack/owned_file.rb').name).to eq 'Bar'
+        end
+      end
+
+      context 'javascript owned file' do
+        before do
+          create_configuration
+          write_file('config/teams/bar.yml', <<~CONTENTS)
+            name: Bar
+          CONTENTS
+
+          write_file('frontend/javascripts/packages/my_package/owned_file.jsx', <<~CONTENTS)
+            // @team Bar
+          CONTENTS
+        end
+
+        it 'can find the owner of a javascript file with file annotations' do
+          expect(CodeOwnership.for_file('frontend/javascripts/packages/my_package/owned_file.jsx').name).to eq 'Bar'
+        end
+      end
+    end
+
+    describe '.remove_file_annotation!' do
+      subject(:remove_file_annotation) do
+        CodeOwnership.remove_file_annotation!(filename)
+        # Getting the owner gets stored in the cache, so after we remove the file annotation we want to bust the cache
+        CodeOwnership.bust_caches!
+      end
+
+      before do
+        write_file('config/teams/foo.yml', <<~CONTENTS)
+          name: Foo
+        CONTENTS
+      end
+
+      context 'ruby file has no annotation' do
+        let(:filename) { 'app/my_file.rb' }
+
+        before do
+          write_file(filename, <<~CONTENTS)
+            # Empty file
+          CONTENTS
+        end
+
+        it 'has no effect' do
+          expect(File.read(filename)).to eq "# Empty file\n"
+
+          remove_file_annotation
+
+          expect(File.read(filename)).to eq "# Empty file\n"
+        end
+      end
+
+      context 'ruby file has annotation' do
+        let(:filename) { 'app/my_file.rb' }
+
+        before do
+          write_file(filename, <<~CONTENTS)
+            # @team Foo
+
+            # Some content
+          CONTENTS
+
+          write_file('package.yml', <<~CONTENTS)
+            enforce_dependency: true
+            enforce_privacy: true
+          CONTENTS
+        end
+
+        it 'removes the annotation' do
+          current_ownership = CodeOwnership.for_file(filename)
+          expect(current_ownership&.name).to eq 'Foo'
+          expect(File.read(filename)).to eq <<~RUBY
+            # @team Foo
+
+            # Some content
+          RUBY
+
+          remove_file_annotation
+
+          new_ownership = CodeOwnership.for_file(filename)
+          expect(new_ownership).to eq nil
+          expected_output = <<~RUBY
+            # Some content
+          RUBY
+
+          expect(File.read(filename)).to eq expected_output
+        end
+      end
+
+      context 'javascript file has annotation' do
+        let(:filename) { 'app/my_file.jsx' }
+
+        before do
+          write_file(filename, <<~CONTENTS)
+            // @team Foo
+
+            // Some content
+          CONTENTS
+
+          write_file('package.yml', <<~CONTENTS)
+            enforce_dependency: true
+            enforce_privacy: true
+          CONTENTS
+        end
+
+        it 'removes the annotation' do
+          current_ownership = CodeOwnership.for_file(filename)
+          expect(current_ownership&.name).to eq 'Foo'
+          expect(File.read(filename)).to eq <<~JAVASCRIPT
+            // @team Foo
+
+            // Some content
+          JAVASCRIPT
+
+          remove_file_annotation
+
+          new_ownership = CodeOwnership.for_file(filename)
+          expect(new_ownership).to eq nil
+          expected_output = <<~JAVASCRIPT
+            // Some content
+          JAVASCRIPT
+
+          expect(File.read(filename)).to eq expected_output
+        end
+      end
+
+      context 'file has new lines after the annotation' do
+        let(:filename) { 'app/my_file.rb' }
+
+        before do
+          write_file(filename, <<~CONTENTS)
+            # @team Foo
+
+
+            # Some content
+
+
+            # Some other content
+          CONTENTS
+        end
+
+        it 'removes the annotation and the leading new lines' do
+          expect(File.read(filename)).to eq <<~RUBY
+            # @team Foo
+
+
+            # Some content
+
+
+            # Some other content
+          RUBY
+
+          remove_file_annotation
+
+          expected_output = <<~RUBY
+            # Some content
+
+
+            # Some other content
+          RUBY
+
+          expect(File.read(filename)).to eq expected_output
+        end
+      end
+    end
+
+  end
+end

spec/lib/code_ownership/private/ownership_mappers/js_package_ownership_spec.rb

@@ -0,0 +1,51 @@
+module CodeOwnership
+  RSpec.describe Private::OwnershipMappers::JsPackageOwnership do
+    describe 'CodeOwnership.validate!' do
+      context 'application has invalid JSON in package' do
+        before do
+          write_file('config/code_ownership.yml', {}.to_yaml)
+
+          write_file('frontend/javascripts/my_package/package.json', <<~CONTENTS)
+            { syntax error!!!
+              "metadata": {
+                "owner": "Foo"
+              }
+            }
+          CONTENTS
+        end
+
+        it 'lets the user know the their package JSON is invalid' do
+          expect { CodeOwnership.validate! }.to raise_error do |e|
+            expect(e).to be_a CodeOwnership::InvalidCodeOwnershipConfigurationError
+            expect(e.message).to match /JSON::ParserError.*?unexpected token/
+            expect(e.message).to include 'frontend/javascripts/my_package/package.json has invalid JSON, so code ownership cannot be determined.'
+            expect(e.message).to include 'Please either make the JSON in that file valid or specify `js_package_paths` in config/code_ownership.yml.'
+          end
+        end
+      end
+    end
+
+    describe 'CodeOwnershp.for_file' do
+      before do
+        create_configuration
+
+        write_file('frontend/javascripts/packages/my_other_package/package.json', <<~CONTENTS)
+          {
+            "name": "@gusto/my_package",
+            "metadata": {
+              "owner": "Bar"
+            }
+          }
+        CONTENTS
+        write_file('frontend/javascripts/packages/my_other_package/my_file.jsx')
+        write_file('config/teams/bar.yml', <<~CONTENTS)
+          name: Bar
+        CONTENTS
+      end
+
+      it 'can find the owner of files in team-owned javascript packages' do
+        expect(CodeOwnership.for_file('frontend/javascripts/packages/my_other_package/my_file.jsx').name).to eq 'Bar'
+      end
+    end
+  end
+end

spec/lib/code_ownership/private/ownership_mappers/package_ownership_spec.rb

@@ -0,0 +1,57 @@
+module CodeOwnership
+  RSpec.describe Private::OwnershipMappers::PackageOwnership do
+    before do
+      create_configuration
+      write_file('config/teams/bar.yml', <<~CONTENTS)
+        name: Bar
+      CONTENTS
+
+      write_file('packs/my_other_package/package.yml', <<~CONTENTS)
+        enforce_dependency: true
+        enforce_privacy: true
+        metadata:
+          owner: Bar
+      CONTENTS
+
+      write_file('package.yml', <<~CONTENTS)
+        enforce_dependency: true
+        enforce_privacy: true
+      CONTENTS
+    end
+
+    describe 'CodeOwnership.for_team' do
+      it 'prints out ownership information for the given team' do
+        expect(CodeOwnership.for_team('Bar')).to eq <<~OWNERSHIP
+          # Code Ownership Report for `Bar` Team
+          ## Annotations at the top of file
+          This team owns nothing in this category.
+
+          ## Team-specific owned globs
+          This team owns nothing in this category.
+
+          ## Owner metadata key in package.yml
+          - packs/my_other_package/**/**
+
+          ## Owner metadata key in package.json
+          This team owns nothing in this category.
+
+          ## Team YML ownership
+          - config/teams/bar.yml
+        OWNERSHIP
+      end
+    end
+
+    describe 'CodeOwnership.for_file' do
+      it 'can find the owner of files in team-owned pack' do
+        expect(CodeOwnership.for_file('packs/my_other_package/my_file.rb').name).to eq 'Bar'
+      end
+    end
+
+    describe 'CodeOwnership.for_package' do
+      it 'returns the right team' do
+        team = CodeOwnership.for_package(Packs.find('packs/my_other_package'))
+        expect(team.name).to eq 'Bar'
+      end
+    end
+  end
+end

spec/lib/code_ownership/private/ownership_mappers/team_globs_spec.rb

@@ -0,0 +1,24 @@
+module CodeOwnership
+  RSpec.describe Private::OwnershipMappers::TeamGlobs do
+    before do
+      create_configuration
+      write_file('config/teams/bar.yml', <<~CONTENTS)
+        name: Bar
+        owned_globs:
+          - app/services/bar_stuff/**/**
+          - frontend/javascripts/bar_stuff/**/**
+      CONTENTS
+
+      write_file('app/services/bar_stuff/thing.rb')
+      write_file('frontend/javascripts/bar_stuff/thing.jsx')
+    end
+
+    it 'can find the owner of ruby files in owned_globs' do
+      expect(CodeOwnership.for_file('app/services/bar_stuff/thing.rb').name).to eq 'Bar'
+    end
+
+    it 'can find the owner of javascript files in owned_globs' do
+      expect(CodeOwnership.for_file('frontend/javascripts/bar_stuff/thing.jsx').name).to eq 'Bar'
+    end
+  end
+end

spec/lib/code_ownership/private/ownership_mappers/team_yml_ownership_spec.rb

@@ -0,0 +1,38 @@
+module CodeOwnership
+  RSpec.describe Private::OwnershipMappers::TeamYmlOwnership do
+    before do
+      create_configuration
+      write_file('config/teams/bar.yml', <<~CONTENTS)
+        name: Bar
+      CONTENTS
+    end
+
+    describe 'CodeOwnership.for_team' do
+      it 'prints out ownership information for the given team' do
+        expect(CodeOwnership.for_team('Bar')).to eq <<~OWNERSHIP
+          # Code Ownership Report for `Bar` Team
+          ## Annotations at the top of file
+          This team owns nothing in this category.
+
+          ## Team-specific owned globs
+          This team owns nothing in this category.
+
+          ## Owner metadata key in package.yml
+          This team owns nothing in this category.
+
+          ## Owner metadata key in package.json
+          This team owns nothing in this category.
+
+          ## Team YML ownership
+          - config/teams/bar.yml
+        OWNERSHIP
+      end
+    end
+
+    describe 'CodeOwnership.for_file' do
+      it 'maps a team YML to be owned by the team itself' do
+        expect(CodeOwnership.for_file('config/teams/bar.yml').name).to eq 'Bar'
+      end
+    end
+  end
+end