puppet-check 1.6.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e965d79b58fb8bb6f0b3a3d01d94a451e628239abd3aeefc472dc6a8965cb59
-  data.tar.gz: 25554b24ad51443eb8b6eabee9aaed19003c20b833a4dc5b74f59db236a607aa
+  metadata.gz: 4351237d9dbb4f8790fb4b3aa77dce9a3274b9146b566261ca089c4759c634ee
+  data.tar.gz: 4a6c8d9e48b456bea5a130e3984613f7cb923891c9fe6779ac481ffdc043a3c1
 SHA512:
-  metadata.gz: 70176578f2be7977ac92d902dd790647962b43fafd32f3a2c1f65af121d84633b8701e759d536f063dd4c692513a35d2e6ca536812626215f571bb587986e19b
-  data.tar.gz: d15e1217350f3c8ee6215d23b2a5806f451564e6b371ffd994004f53dcd49631ebd469782c4e5a025bde864949eddd73007ce053424b77435d571192a0a6b8f0
+  metadata.gz: dcf4c5c9ec7906f130f8ae74f61b1efaab297d33276f1587c88ac68bea8f25a09aa1deeac0ede9cee835e0b2bed95b404e1a208649df29e76693d56a37ab867c
+  data.tar.gz: 1b4a1c372216d42d5e0e547e98a606866d0576da2e494d56340eb7a025e0f3763a9139ca18c24165a473c03429c1cf271ca0606017889e29dfbead14a0e5e7da

data/CHANGELOG.md

@@ -1,4 +1,10 @@
-### 1.6.0 (Next)
+### 1.6.1 (Next)
+- Removed check for hieradata nil/undef value for Hiera >= 5.
+- Add rudimentary checks for task metadata.
+- Preliminary support for Puppet 6.
+- RSpec Puppet fixed its default `spec_helper`. Revert to loading it instead of generating a working one.
+
+### 1.6.0
 - Minimum Ruby version increased to 2.1.
 - Minimum Puppet version increased to 3.7.
 - Minimum Puppet-Lint and Rubocop increased to 2.0 and 0.51.0.

data/README.md

@@ -121,19 +121,8 @@ The following files have unrecognized formats and therefore were not processed:
 -- foobarbaz
 ```
 
-### Why not Puppetlabs Spec Helper?
-- Puppetlabs Spec Helper is focused more on advanced and robust spec testing.  Puppet Check is focused more on efficient and comprehensive Puppet code and data validation.
-- Puppetlabs Spec Helper performs fewer types of checks.
-- Puppetlabs Spec Helper has extra layers of gems in between it and the gems executing the checks.
-- Puppetlabs Spec Helper does not allow interfacing through it to the gems executing the checks.
-- Puppetlabs Spec Helper has no CLI.
-- Puppetlabs Spec Helper intrinsically only executes spec tests against one module at a time.
-- Puppetlabs Spec Helper requires an additional config file for RSpec Puppet support.
-- Puppetlabs Spec Helper does not update external module dependencies in a stateful/persistent workspace and fails gracefully instead.
-- Puppetlabs Spec Helper requires extra configuration items to setup self-module RSpec testing.
-- Puppetlabs Spec Helper does not frontend to Octocatalog Diff or Test-Kitchen.
-
-It is worth nothing that there is no current development objective for Puppet Check to achieve the same advanced level of robustness for spec testing that Puppetlabs Spec Helper enables. If you are performing standard spec testing on your Puppet code and data, then Puppet Check's spec testing is a fantastic lighter and faster alternative to Puppetlabs Spec Helper. If you require advanced and intricate capabilities in your spec testing (e.g. direct interfacing to the `Puppet::Parser::Scope` API), then you will likely prefer Puppetlabs Spec Helper's spec testing in conjunction with Puppet Check's file validation.
+### What About Puppet Development Kit?
+The fairly recent release of the Puppet Development Kit (PDK) will hopefully eventually bring about the capability to test and validate your Puppet code and data in a streamlined, efficient, comprehensive, and accurate fashion comparable to Puppet Check. Unfortunately, the PDK has not yet achieved feature or efficiency parity with Puppet Check. The goal is for the PDK to one day replace Puppet Check and for Puppet Check to enter maintenance mode, but for now Puppet Check is still needed to lead Puppet testing.
 
 ## Usage
 Please see the [Gemspec](puppet-check.gemspec) for dependency information.  All other dependencies should be fine with various versions. Puppet Check can be used with a CLI, Rake tasks, or API, from your system, rbenv, rvm, Docker, or Vagrant. Please note all interfaces (API by default, but can be modified) will ignore any directories named `fixtures` or specified paths with that directory during file checks and spec tests.
@@ -295,7 +284,7 @@ You can also use Puppet Check inside of Docker for quick, portable, and disposab
 
 ```dockerfile
 # a reliable and small container at the moment
-FROM ubuntu:16.04
+FROM ubuntu:18.04
 # you need ruby and any other extra dependencies that come from packages; in this example we install git to use it for downloading external module dependencies
 RUN apt-get update && apt-get install ruby git -y
 # you need puppet-check and any other extra dependencies that come from gems; in this example we install reek because the ruby ABI is 2.3 and then rspec-puppet and rake for extra testing
@@ -304,7 +293,7 @@ RUN gem install --no-document puppet-check reek rspec-puppet rake
 ENV LANG en_US.UTF-8
 # create the directory for your module, directory environment, etc. and change directory into it
 WORKDIR /module_name_or_directory_environment_name
-# copy the module, directory environment, etc. contents into the corresponding directory inside the container
+# copy the module, directory environment, etc. contents into the corresponding directory inside the container; alternative, bind a volume mount for your module(s) into the container at runtime
 COPY / .
 # execute your tests; in this example we are executing the full suite of tests
 ENTRYPOINT ["rake", "puppetcheck"]
@@ -319,7 +308,7 @@ As an alternative to Docker, you can also use Vagrant for quick and disposable t
 ```ruby
 Vagrant.configure(2) do |config|
   # a reliable and small box at the moment
-  config.vm.box = 'fedora/24-cloud-base'
+  config.vm.box = 'fedora/26-cloud-base'
 
   config.vm.provision 'shell', inline: <<-SHELL
     # cd to '/vagrant'

data/lib/puppet-check.rb

@@ -113,7 +113,7 @@ class PuppetCheck
 
     # do not process fixtures, check that at least one file was found, and remove double slashes
     files.reject! { |file| file =~ /fixtures/ }
-    raise "puppet-check: no files found in supplied paths #{paths.join(', ')}." if files.empty?
+    raise "puppet-check: no files found in supplied paths '#{paths.join(', ')}'." if files.empty?
     files.map! { |file| file.gsub('//', '/') }
 
     files.uniq

data/lib/puppet-check/cli.rb

@@ -27,7 +27,7 @@ class PuppetCheck::CLI
 
       # base options
       opts.on('--version', 'Display the current version.') do
-        puts 'puppet-check 1.6.0'
+        puts 'puppet-check 1.6.1'
         exit 0
       end
 

data/lib/puppet-check/data_parser.rb

@@ -160,11 +160,43 @@ class DataParser
             warnings.push('Recommended field \'operatingsystem_support\' not found.')
           end
 
-          # check for spdx license (rubygems/util/licenses for rubygems >= 2.5 in the far future)
-          if parsed.key?('license') && !SpdxLicenses.exist?(parsed['license']) && parsed['license'] !~ /[pP]roprietary/
-            warnings.push("License identifier '#{parsed['license']}' is not in the SPDX list: http://spdx.org/licenses/")
+          # check for spdx license
+          begin
+            require 'rubygems/util/licenses'
+
+            if parsed.key?('license') && !Gem::Licenses.match?(parsed['license']) && parsed['license'] !~ /[pP]roprietary/
+              warnings.push("License identifier '#{parsed['license']}' is not in the SPDX list: http://spdx.org/licenses/")
+            end
+          rescue LoadError
+            if parsed.key?('license') && !SpdxLicenses.exist?(parsed['license']) && parsed['license'] !~ /[pP]roprietary/
+              warnings.push("License identifier '#{parsed['license']}' is not in the SPDX list: http://spdx.org/licenses/")
+            end
+          end
+        # assume this is task metadata if it has this key
+        elsif parsed.key?('description')
+          # check that description is a string
+          warnings.push('description value is not a String') unless parsed['description'].is_a?(String)
+          # check that input_method is one of three possible values
+          if parsed.key?('input_method')
+            if parsed['input_method'].is_a?(String)
+              warnings.push('input_method value is not one of environment, stdin, or powershell') unless %w[environment stdin powershell].include?(parsed['input_method'])
+            else
+              warnings.push('input_method value is not a String')
+            end
+          end
+          # check that parameters is a hash
+          if parsed.key?('parameters')
+            warnings.push('parameters value is not a Hash') unless parsed['parameters'].is_a?(Hash)
+          end
+          # check that puppet_task_version is an integer
+          if parsed.key?('puppet_task_version')
+            warnings.push('puppet_task_version value is not an Integer') unless parsed['puppet_task_version'].is_a?(Integer)
           end
-        # assume this is hieradata
+          # check that supports_noop is a boolean
+          if parsed.key?('supports_noop')
+            warnings.push('supports_noop value is not a Boolean') unless parsed['supports_noop'].is_a?(TrueClass) || parsed['supports_noop'].is_a?(FalseClass)
+          end
+        # assume this is hieradata and ensure it is non-empty
         elsif parsed
           # perform some rudimentary hiera checks if data exists
           warnings = hiera(parsed, file)
@@ -180,15 +212,18 @@ class DataParser
     private_class_method :method
     warnings = []
 
-    data.each do |key, value|
-      # check for nil values in the data (nil keys are fine)
-      if (value.is_a?(Hash) && value.values.any?(&:nil?)) || value.nil?
-        warnings.push("Value(s) missing in key '#{key}'.")
+    # disregard nil/undef value data check if default values (common)
+    unless file =~ /^common/
+      data.each do |key, value|
+        # check for nil values in the data (nil keys are fine)
+        if (value.is_a?(Hash) && value.values.any?(&:nil?)) || value.nil?
+          warnings.push("Value(s) missing in key '#{key}'.")
+        end
       end
     end
 
     # check that '---' does not show up more than once in the hieradata
-    warnings.push('The string --- appears more than once in this data and Hiera will fail to parse it correctly.') if File.read(file).scan(/---/).count >= 2
+    warnings.push('The string --- appears more than once in this data and Hiera may fail to parse it correctly.') if File.read(file).scan(/---/).count >= 2
 
     warnings
   end

data/lib/puppet-check/puppet_parser.rb

@@ -36,12 +36,12 @@ class PuppetParser
       warnings = "#{file}:"
       unless errors.empty?
         # puppet 5.4-5.x has a new validator output format
-        if Puppet::PUPPETVERSION.to_f >= 5.4
-          warnings << "\n#{errors.map(&:to_s).join("\n").gsub("file: #{File.absolute_path(file)}, ", '')}"
-        # puppet <= 5.3 validator output format
-        else
-          warnings << "\n#{errors.map(&:to_s).join("\n").gsub("#{File.absolute_path(file)}:", '')}"
-        end
+        warnings << if Puppet::PUPPETVERSION.to_f >= 5.4
+                      "\n#{errors.map(&:to_s).join("\n").gsub("file: #{File.absolute_path(file)}, ", '')}"
+                    # puppet <= 5.3 validator output format
+                    else
+                      "\n#{errors.map(&:to_s).join("\n").gsub("#{File.absolute_path(file)}:", '')}"
+                    end
       end
       Puppet::Util::Log.close_all
 

data/lib/puppet-check/rspec_puppet_support.rb

@@ -54,7 +54,7 @@ class RSpecPuppetSupport
 
     # create spec_helper if missing
     return if File.file?('spec/spec_helper.rb')
-    File.open('spec/spec_helper.rb', 'w') { |file| file.puts "require 'rspec-puppet'\n\nfixture_path = File.expand_path(File.join(__FILE__, '..', 'fixtures'))\n\nRSpec.configure do |c|\n  c.module_path     = File.join(fixture_path, 'modules')\n  c.manifest_dir    = File.join(fixture_path, 'manifests')\n  c.manifest        = File.join(File.dirname(File.expand_path(__FILE__)), 'fixtures', 'manifests', 'site.pp')\n  c.environmentpath = File.join(Dir.pwd, 'spec')\nend" }
+    File.open('spec/spec_helper.rb', 'w') { |file| file.puts "require 'rspec-puppet/spec_helper'\n" }
   end
 
   # setup the module dependencies for rspec-puppet testing

data/spec/fixtures/task_metadata/task_bad.json

@@ -0,0 +1,10 @@
+{
+  "description": 1,
+  "supports_noop": "false",
+  "input_method": "unsupported",
+  "puppet_task_version": "1",
+  "parameters": [
+    "first",
+    "second"
+  ]
+}

data/spec/fixtures/task_metadata/task_good.json

@@ -0,0 +1,16 @@
+{
+  "description": "Does the things.",
+  "supports_noop": false,
+  "input_method": "stdin",
+  "puppet_task_version": 1,
+  "parameters": {
+    "first": {
+     "description": "First param.",
+     "type": "Optional[String[1]]"
+    },
+    "second": {
+     "description": "Second param.",
+     "type": "Optional[String[1]]"
+    }
+  }
+}

data/spec/puppet-check/data_parser_spec.rb

@@ -18,7 +18,7 @@ describe DataParser do
     it 'puts a good yaml file with potential hiera issues in the warning files array' do
       DataParser.yaml([fixtures_dir + 'hieradata/style.yaml'])
       expect(PuppetCheck.settings[:error_files]).to eql([])
-      expect(PuppetCheck.settings[:warning_files][0]).to match(%r{^#{fixtures_dir}hieradata/style.yaml:\nValue\(s\) missing in key.*\nValue\(s\) missing in key.*\nThe string --- appears more than once in this data and Hiera will fail to parse it correctly})
+      expect(PuppetCheck.settings[:warning_files][0]).to match(%r{^#{fixtures_dir}hieradata/style.yaml:\nValue\(s\) missing in key.*\nValue\(s\) missing in key.*\nThe string --- appears more than once in this data and Hiera may fail to parse it correctly})
       expect(PuppetCheck.settings[:clean_files]).to eql([])
     end
     it 'puts a good yaml file in the clean files array' do
@@ -90,6 +90,12 @@ describe DataParser do
       expect(PuppetCheck.settings[:warning_files][0]).to match(%r{^#{fixtures_dir}metadata_style_two/metadata.json:\n'puppetlabs/one' has non-semantic versioning.*\n'puppetlabs/two' is missing an upper bound\.\n.*operatingsystem.*\n.*operatingsystemrelease})
       expect(PuppetCheck.settings[:clean_files]).to eql([])
     end
+    it 'puts a bad task metadata json file in the warning files array' do
+      DataParser.json([fixtures_dir + 'task_metadata/task_bad.json'])
+      expect(PuppetCheck.settings[:error_files]).to eql([])
+      expect(PuppetCheck.settings[:warning_files][0]).to match(%r{^#{fixtures_dir}task_metadata/task_bad.json:\ndescription value is not a String\ninput_method value is not one of environment, stdin, or powershell\nparameters value is not a Hash\npuppet_task_version value is not an Integer\nsupports_noop value is not a Boolean})
+      expect(PuppetCheck.settings[:clean_files]).to eql([])
+    end
     it 'puts a good json file in the clean files array' do
       DataParser.json([fixtures_dir + 'hieradata/good.json'])
       expect(PuppetCheck.settings[:error_files]).to eql([])
@@ -102,5 +108,11 @@ describe DataParser do
       expect(PuppetCheck.settings[:warning_files]).to eql([])
       expect(PuppetCheck.settings[:clean_files]).to eql(["#{fixtures_dir}metadata_good/metadata.json"])
     end
+    it 'puts a good task metadata json file in the clean files array' do
+      DataParser.json([fixtures_dir + 'task_metadata/task_good.json'])
+      expect(PuppetCheck.settings[:error_files]).to eql([])
+      expect(PuppetCheck.settings[:warning_files]).to eql([])
+      expect(PuppetCheck.settings[:clean_files]).to eql(["#{fixtures_dir}task_metadata/task_good.json"])
+    end
   end
 end

data/spec/puppet-check/regression_check_spec.rb

@@ -14,7 +14,6 @@ describe RegressionCheck do
       expect { RegressionCheck.config(octocatalog_diff_dir + 'octocatalog-diff.cfg.rb') }.not_to raise_exception
     end
     it 'loads in the settings from the file correctly' do
-      #
     end
   end
 
@@ -34,6 +33,5 @@ describe RegressionCheck do
   end
 
   context '.regression' do
-    #
   end
 end

data/spec/puppet-check_spec.rb

@@ -41,7 +41,7 @@ describe PuppetCheck do
     let(:repeats) { PuppetCheck.parse_paths(['hieradata', 'hieradata', 'lib', 'hieradata/good.json', 'manifests/good.pp', 'manifests/good.pp']) }
 
     it 'raises an error if no files were found' do
-      expect { no_files }.to raise_error(RuntimeError, 'puppet-check: no files found in supplied paths foo, bar, baz.')
+      expect { no_files }.to raise_error(RuntimeError, 'puppet-check: no files found in supplied paths \'foo, bar, baz\'.')
     end
 
     it 'correctly parses one file and returns it' do
@@ -50,7 +50,7 @@ describe PuppetCheck do
 
     it 'correctly parses one directory and returns all of its files' do
       dir.each { |file| expect(File.file?(file)).to be true }
-      expect(dir.length).to eql(35)
+      expect(dir.length).to eql(37)
     end
 
     it 'correctly parses multiple directories and returns all of their files' do

data/spec/system/system_spec.rb

@@ -18,8 +18,8 @@ describe PuppetCheck do
       expect { cli }.not_to raise_exception
 
       expect(PuppetCheck.settings[:error_files].length).to eql(9)
-      expect(PuppetCheck.settings[:warning_files].length).to eql(9)
-      expect(PuppetCheck.settings[:clean_files].length).to eql(11)
+      expect(PuppetCheck.settings[:warning_files].length).to eql(10)
+      expect(PuppetCheck.settings[:clean_files].length).to eql(12)
       expect(PuppetCheck.settings[:ignored_files].length).to eql(6)
 
       expect(cli).to eql(2)
@@ -49,8 +49,8 @@ describe PuppetCheck do
       expect { tasks }.not_to raise_exception
 
       expect(PuppetCheck.settings[:error_files].length).to eql(9)
-      expect(PuppetCheck.settings[:warning_files].length).to eql(9)
-      expect(PuppetCheck.settings[:clean_files].length).to eql(11)
+      expect(PuppetCheck.settings[:warning_files].length).to eql(10)
+      expect(PuppetCheck.settings[:clean_files].length).to eql(12)
       expect(PuppetCheck.settings[:ignored_files].length).to eql(6)
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-check
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.6.1
 platform: ruby
 authors:
 - Matt Schuchard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-12 00:00:00.000000000 Z
+date: 2018-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet
@@ -19,7 +19,7 @@ dependencies:
         version: '3.7'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3.7'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: puppet-lint
   requirement: !ruby/object:Gem::Requirement
@@ -48,16 +48,22 @@ dependencies:
   name: reek
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -187,6 +193,8 @@ files:
 - spec/fixtures/metadata_syntax/metadata.json
 - spec/fixtures/spec/facter/facter_spec.rb
 - spec/fixtures/spec/fixtures/do_not_parse_me
+- spec/fixtures/task_metadata/task_bad.json
+- spec/fixtures/task_metadata/task_good.json
 - spec/fixtures/templates/good.epp
 - spec/fixtures/templates/good.erb
 - spec/fixtures/templates/no_method_error.erb
@@ -265,6 +273,8 @@ test_files:
 - spec/fixtures/metadata_syntax/metadata.json
 - spec/fixtures/spec/facter/facter_spec.rb
 - spec/fixtures/spec/fixtures/do_not_parse_me
+- spec/fixtures/task_metadata/task_bad.json
+- spec/fixtures/task_metadata/task_good.json
 - spec/fixtures/templates/good.epp
 - spec/fixtures/templates/good.erb
 - spec/fixtures/templates/no_method_error.erb