Fix bug with ignored_private_constants in a package.yml failing validation (#28)

* write failing test

* renamespace test

* make test pass

* bump version

Author: Alex Evanczuk

Gemfile.lock

@@ -17,7 +17,7 @@ GIT
 PATH
   remote: .
   specs:
-    packwerk-extensions (0.1.6)
+    packwerk-extensions (0.1.7)
       packwerk (>= 2.2.1)
       railties (>= 6.0.0)
       sorbet-runtime

lib/packwerk/privacy/validator.rb

@@ -31,7 +31,7 @@ def call(package_set, configuration)
 
       sig { override.returns(T::Array[String]) }
       def permitted_keys
-        %w[public_path enforce_privacy private_constants]
+        %w[public_path enforce_privacy private_constants ignored_private_constants]
       end
 
       private

packwerk-extensions.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = 'packwerk-extensions'
-  spec.version       = '0.1.6'
+  spec.version       = '0.1.7'
   spec.authors       = ['Gusto Engineers']
   spec.email         = ['dev@gusto.com']
 

test/unit/privacy/validator_test.rb

@@ -7,114 +7,123 @@
 require 'fixtures/skeleton/components/timeline/app/models/private_thing'
 
 module Packwerk
-  class ValidatorTest < Minitest::Test
-    extend T::Sig
-    include ApplicationFixtureHelper
-    include RailsApplicationFixtureHelper
-
-    setup do
-      setup_application_fixture
-    end
-
-    teardown do
-      teardown_application_fixture
-    end
-
-    test 'check_all returns an error for invalid enforce_privacy value' do
-      use_template(:minimal)
-      merge_into_app_yaml_file('package.yml', { 'enforce_privacy' => 'yes, please.' })
-
-      result = Packwerk::Privacy::Validator.new.call(package_set, config)
-
-      refute result.ok?
-      assert_match(/Invalid 'enforce_privacy' option/, result.error_value)
-    end
-
-    test 'check_all returns success for when enforce_privacy is set to strict' do
-      use_template(:minimal)
-      merge_into_app_yaml_file('package.yml', { 'enforce_privacy' => 'strict' })
-
-      result = Packwerk::Privacy::Validator.new.call(package_set, config)
-
-      assert result.ok?
-    end
-
-    test 'check_all returns success when inflector defines acronym' do
-      use_template(:skeleton)
-
-      result = Packwerk::Privacy::Validator.new.call(package_set, config)
-
-      assert result.ok?
-      assert_nil result.error_value
-    end
-
-    test 'check_all returns an error for invalid public_path value' do
-      use_template(:minimal)
-      merge_into_app_yaml_file('package.yml', { 'public_path' => [] })
-
-      result = Packwerk::Privacy::Validator.new.call(package_set, config)
-
-      refute result.ok?
-      assert_match(/'public_path' option must be a string/, result.error_value)
-    end
-
-    test 'check_package_manifests_for_privacy returns an error for unresolvable privatized constants' do
-      use_template(:skeleton)
-      ConstantResolver.expects(:new).returns(stub('resolver', resolve: nil))
-
-      result = Packwerk::Privacy::Validator.new.call(package_set, config)
-      refute result.ok?, result.error_value
-      assert_match(
-        /'::PrivateThing', listed in #{to_app_path('components\/timeline\/package.yml')}, could not be resolved/,
-        result.error_value
-      )
-      assert_match(
-        /Add a private_thing.rb file/,
-        result.error_value
-      )
-    end
-
-    test 'check_package_manifests_for_privacy returns an error for privatized constants in other packages' do
-      use_template(:skeleton)
-      context = ConstantResolver::ConstantContext.new('::PrivateThing', 'private_thing.rb')
-
-      ConstantResolver.expects(:new).returns(stub('resolver', resolve: context))
-
-      result = Packwerk::Privacy::Validator.new.call(package_set, config)
-
-      refute result.ok?, result.error_value
-      assert_match(
-        %r{'::PrivateThing' is declared as private in the 'components/timeline' package},
-        result.error_value
-      )
-      assert_match(
-        /but appears to be defined\sin the '.' package/,
-        result.error_value
-      )
-    end
-
-    test 'check_package_manifests_for_privacy returns an error for constants without `::` prefix' do
-      use_template(:minimal)
-      merge_into_app_yaml_file('package.yml', { 'private_constants' => ['::PrivateThing', 'OtherThing'] })
-
-      result = Packwerk::Privacy::Validator.new.call(package_set, config)
-
-      refute result.ok?, result.error_value
-      assert_match(
-        /'OtherThing', listed in the 'private_constants' option in .*package.yml, is invalid./,
-        result.error_value
-      )
-      assert_match(
-        /Private constants need to be prefixed with the top-level namespace operator `::`/,
-        result.error_value
-      )
-    end
-
-    private
-
-    sig { returns(Packwerk::ApplicationValidator) }
-    def validator
-      @validator ||= Packwerk::ApplicationValidator.new
+  module Privacy
+    class ValidatorTest < Minitest::Test
+      extend T::Sig
+      include ApplicationFixtureHelper
+      include RailsApplicationFixtureHelper
+
+      setup do
+        setup_application_fixture
+      end
+
+      teardown do
+        teardown_application_fixture
+      end
+
+      test 'check_all returns an error for invalid enforce_privacy value' do
+        use_template(:minimal)
+        merge_into_app_yaml_file('package.yml', { 'enforce_privacy' => 'yes, please.' })
+
+        result = Packwerk::Privacy::Validator.new.call(package_set, config)
+
+        refute result.ok?
+        assert_match(/Invalid 'enforce_privacy' option/, result.error_value)
+      end
+
+      test 'check_all returns success for when enforce_privacy is set to strict' do
+        use_template(:minimal)
+        merge_into_app_yaml_file('package.yml', { 'enforce_privacy' => 'strict' })
+
+        result = Packwerk::Privacy::Validator.new.call(package_set, config)
+
+        assert result.ok?
+      end
+
+      test 'check_all returns success when inflector defines acronym' do
+        use_template(:skeleton)
+
+        result = Packwerk::Privacy::Validator.new.call(package_set, config)
+
+        assert result.ok?
+        assert_nil result.error_value
+      end
+
+      test 'check_all returns an error for invalid public_path value' do
+        use_template(:minimal)
+        merge_into_app_yaml_file('package.yml', { 'public_path' => [] })
+
+        result = Packwerk::Privacy::Validator.new.call(package_set, config)
+
+        refute result.ok?
+        assert_match(/'public_path' option must be a string/, result.error_value)
+      end
+
+      test 'check_package_manifests_for_privacy returns an error for unresolvable privatized constants' do
+        use_template(:skeleton)
+        ConstantResolver.expects(:new).returns(stub('resolver', resolve: nil))
+
+        result = Packwerk::Privacy::Validator.new.call(package_set, config)
+        refute result.ok?, result.error_value
+        assert_match(
+          /'::PrivateThing', listed in #{to_app_path('components\/timeline\/package.yml')}, could not be resolved/,
+          result.error_value
+        )
+        assert_match(
+          /Add a private_thing.rb file/,
+          result.error_value
+        )
+      end
+
+      test 'check_package_manifests_for_privacy returns an error for privatized constants in other packages' do
+        use_template(:skeleton)
+        context = ConstantResolver::ConstantContext.new('::PrivateThing', 'private_thing.rb')
+
+        ConstantResolver.expects(:new).returns(stub('resolver', resolve: context))
+
+        result = Packwerk::Privacy::Validator.new.call(package_set, config)
+
+        refute result.ok?, result.error_value
+        assert_match(
+          %r{'::PrivateThing' is declared as private in the 'components/timeline' package},
+          result.error_value
+        )
+        assert_match(
+          /but appears to be defined\sin the '.' package/,
+          result.error_value
+        )
+      end
+
+      test 'check_package_manifests_for_privacy returns an error for constants without `::` prefix' do
+        use_template(:minimal)
+        merge_into_app_yaml_file('package.yml', { 'private_constants' => ['::PrivateThing', 'OtherThing'] })
+
+        result = Packwerk::Privacy::Validator.new.call(package_set, config)
+
+        refute result.ok?, result.error_value
+        assert_match(
+          /'OtherThing', listed in the 'private_constants' option in .*package.yml, is invalid./,
+          result.error_value
+        )
+        assert_match(
+          /Private constants need to be prefixed with the top-level namespace operator `::`/,
+          result.error_value
+        )
+      end
+
+      test 'does not create a validation error when using ignored_private_constants' do
+        use_template(:minimal)
+        merge_into_app_yaml_file('package.yml', { 'ignored_private_constants' => ['packs/my_other_pack'] })
+        result = validator.call(package_set, config)
+        assert result.ok?
+      end
+
+      private
+
+      sig { returns(ApplicationValidator) }
+      def validator
+        @validator ||= ApplicationValidator.new
+      end
     end
   end
 end