Merge pull request #1114 from jpogran/gh-1111-block-files

(GH-1118) Add ability to skip validating files

Author: michaeltlombardi

docs/pdk_testing.md

@@ -125,6 +125,25 @@ send your validation output to a file in either JUnit or text format.
     command [reference](pdk_reference.md#).
 
 
+### Ignoring files during module validation
+
+There are times when certain files can be ignored when validating the contents of a Puppet module. PDK provides a configuration option to list sets of files to ignore when running any of the validators.
+
+To configure PDK to ignore a file, use `pdk set config project.validate.ignore`.
+The `project.validate.ignore` setting accepts multiple files. To add one or more files, run the command for each file or pattern you want to add.
+
+For example, to ignore a file called `example.yaml` in the folder called `config`, you would run the following command:
+
+```
+pdk set config project.validate.ignore "config/example.yaml"
+```
+
+To add a wildcard, use a valid [Git ignore pattern](http://git-scm.com/docs/gitignore):
+
+```
+pdk set config project.validate.ignore "config/*.yaml"
+```
+
 ## Unit testing modules
 
 Create and run unit tests to verify that your Puppet code compiles on supported
@@ -211,4 +230,3 @@ correctly performs the functions you expect it to.
 PDK reports what Ruby and Puppet versions it is testing against, and after tests
 are completed, test results. For a complete list of command options and usage
 information, see the PDK command [reference](pdk_reference.md#).
-

lib/pdk/config.rb

@@ -94,6 +94,12 @@ def project_config
         if context.is_a?(PDK::Context::ControlRepo)
           mount :environment, PDK::ControlRepo.environment_conf_as_config(File.join(context.root_path, 'environment.conf'))
         end
+
+        mount :validate, PDK::Config::YAML.new('validate', file: File.join(context.root_path, 'pdk.yaml'), persistent_defaults: true) do
+          setting 'ignore' do
+            default_to { [] }
+          end
+        end
       end
     end
 

lib/pdk/validate/invokable_validator.rb

@@ -213,6 +213,14 @@ def ignore_pathspec
           end
         end
 
+        # block will always be [] because it is intialized in config
+        ignore_files = PDK.config.get_within_scopes('validate.ignore')
+        unless ignore_files.nil? || ignore_files.empty?
+          Array(ignore_files).each do |pattern|
+            ignore_pathspec.add(pattern)
+          end
+        end
+
         ignore_pathspec
       end
     end

spec/unit/pdk/config_spec.rb

@@ -17,6 +17,7 @@ def mock_file(path, content)
   end
 
   before(:each) do
+    allow(PDK::Util::Filesystem).to receive(:file?).with(%r{pdk\.yaml}).and_call_original
     # Allow the JSON Schema documents to actually be read. Rspec matchers are LIFO
     allow(PDK::Util::Filesystem).to receive(:file?).with(%r{_schema\.json}).and_call_original
   end

spec/unit/pdk/validate/invokable_validator_spec.rb

@@ -2,6 +2,8 @@
 require 'pdk/validate/invokable_validator'
 
 describe PDK::Validate::InvokableValidator do
+  include_context 'mock configuration'
+
   class PublicInvokableValidator < PDK::Validate::InvokableValidator
     # Expose protected/private methods for testing.
     public :contextual_pattern
@@ -59,6 +61,7 @@ class PublicInvokableValidator < PDK::Validate::InvokableValidator
 
     let(:validator_options) { { targets: targets } }
     let(:pattern) { '**/**.pp' }
+    let(:project_config_exists) { false }
 
     RSpec.shared_examples 'a parsed target list in an invalid context' do |expected_skipped_targets = nil|
       before(:each) do
@@ -81,6 +84,7 @@ class PublicInvokableValidator < PDK::Validate::InvokableValidator
       allow(PDK::Util).to receive(:canonical_path).and_wrap_original do |_m, *args|
         args[0]
       end
+      allow(PDK::Util::Filesystem).to receive(:file?).with(%r{.*pdk\.yaml}).and_return(project_config_exists)
     end
 
     context 'when given no targets' do
@@ -340,6 +344,43 @@ class PublicInvokableValidator < PDK::Validate::InvokableValidator
         expect(target_files[0]).to eq([File.join('manifests', 'init.pp')])
       end
     end
+
+    context 'when a project level configuration file contains a validate.ignore path' do
+      before(:each) do
+        allow(PDK::Util::Filesystem).to receive(:directory?).and_return(true)
+        allow(PDK::Util::Filesystem).to receive(:glob).with(glob_pattern, anything).and_return(globbed_files)
+        allow(PDK::Util::Filesystem).to receive(:expand_path).with(context_root).and_return(context_root)
+        allow(PDK::Util::Filesystem).to receive(:read_file).with(%r{pdk.yaml}).and_return(project_ignore_yaml)
+      end
+
+      let(:project_config_exists) { true }
+      let(:targets) { [] }
+      let(:glob_pattern) { File.join(context_root, validator.pattern) }
+      let(:files) do
+        [
+          'dodgy.yaml',
+          File.join('manifests', 'init.pp'),
+          File.join('vendor', 'bad.yaml'),
+          File.join('plans', 'foo.pp'),
+          File.join('plans', 'fine.yaml'),
+          File.join('plans', 'nested', 'thing.pp'),
+        ]
+      end
+      let(:globbed_files) { files.map { |file| File.join(context_root, file) } }
+      let(:project_ignore_yaml) do
+        <<CONTENTS
+---
+ignore:
+- "/*.yaml"
+- vendor/*.yaml
+CONTENTS
+      end
+
+      it 'does not match the ignored files' do
+        expect(target_files[0].count).to eq(4)
+        expect(target_files[0]).to eq(['manifests/init.pp', 'plans/foo.pp', 'plans/fine.yaml', 'plans/nested/thing.pp'])
+      end
+    end
   end
 
   it 'has an ignore_dotfiles? of true' do
@@ -429,6 +470,12 @@ class PublicInvokableValidator < PDK::Validate::InvokableValidator
   describe '.contextual_pattern' do
     subject(:context_pattern) { validator.contextual_pattern(pattern_for_a_module) }
 
+    before(:each) do
+      allow(PDK::Util::Filesystem).to receive(:file?).with(%r{.*environment\.conf}).and_call_original
+      allow(PDK::Util::Filesystem).to receive(:read_file).with(%r{.*environment\.conf}).and_call_original
+      allow(PDK::Util::Filesystem).to receive(:file?).with(%r{.*pdk\.yaml}).and_call_original
+    end
+
     let(:pattern_for_a_module) { '*.pp' }
 
     context 'given a Module context' do