puppet-check 1.6.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4351237d9dbb4f8790fb4b3aa77dce9a3274b9146b566261ca089c4759c634ee
-  data.tar.gz: 4a6c8d9e48b456bea5a130e3984613f7cb923891c9fe6779ac481ffdc043a3c1
+  metadata.gz: 9d2defe55b01e90b73fc2cb3dfc12b9004fbe02b73fc751b736529e454c0c92b
+  data.tar.gz: 96bce3d495f0a5778d5475659ba3fbf6360290ef565666478933cd867babc34d
 SHA512:
-  metadata.gz: dcf4c5c9ec7906f130f8ae74f61b1efaab297d33276f1587c88ac68bea8f25a09aa1deeac0ede9cee835e0b2bed95b404e1a208649df29e76693d56a37ab867c
-  data.tar.gz: 1b4a1c372216d42d5e0e547e98a606866d0576da2e494d56340eb7a025e0f3763a9139ca18c24165a473c03429c1cf271ca0606017889e29dfbead14a0e5e7da
+  metadata.gz: 52037386f7f9168822a8cc14da2455d3a6a2f38cc3686ef7edbed65bee382a07159328c9ca3e1472c97d533e0966b431b921d78380bec684489e7528ec443694
+  data.tar.gz: 859c21981164a0e002c6e8faeec55b285aa65d7cd953b838415873d482f7a32acf4ede39049329eb9435f435a7a96b741749a7501e1a0cfd045c43444f5cbc94

data/CHANGELOG.md

@@ -1,4 +1,14 @@
-### 1.6.1 (Next)
+### 2.0.0
+- Bump minimum version of Puppet to 4.0.0 and remove < 4 support code.
+- Official support for Puppet 6.
+- Minimum Ruby version bumped to 2.2.0.
+- Bumped Rubocop and Reek minimum versions and fully migrated SPDX to Rubygems.
+- Add rubocop-performance extension to Rubocop.
+- Update manifest validation for breaking change in 6.5 API.
+- Fix check on specified dependencies in metadata.
+- Enable parallel module dependency retrieval.
+
+### 1.6.1
 - Removed check for hieradata nil/undef value for Hiera >= 5.
 - Add rudimentary checks for task metadata.
 - Preliminary support for Puppet 6.

data/README.md

@@ -131,7 +131,6 @@ Please see the [Gemspec](puppet-check.gemspec) for dependency information.  All
 ```
 usage: puppet-check [options] paths
         --version                    Display the current version.
-    -f, --future                     Enable future parser
         --fail-on-warnings           Fail on warnings
     -s, --style                      Enable style checks
         --smoke                      Enable smoke testing
@@ -148,7 +147,7 @@ usage: puppet-check [options] paths
         --rubocop arg_one,arg_two    Arguments for Rubocop disabled cops
 ```
 
-The command line interface enables the ability to select the Puppet future parser, additional style checks besides the syntax checks, and to specify PuppetLint and Rubocop checks to ignore. If you require a more robust interface to PuppetLint, Rubocop, and Reek, then please use `.puppet-lint.rc`, `.rubocop.yml` and `*.reek` config files. The `.puppet-lint.rc` can be specified with the `-c` argument. If it is not specified, then PuppetLint will automatically load one from `.puppet-lint.rc`, `~/.puppet-lint.rc`, or `/etc/puppet-lint.rc`, in that order of preference. The nearest `.rubocop.yml` and `*.reek` will be automatically respected.
+The command line interface enables the ability to select additional style checks besides the syntax checks, and to specify PuppetLint and Rubocop checks to ignore. If you require a more robust interface to PuppetLint, Rubocop, and Reek, then please use `.puppet-lint.rc`, `.rubocop.yml` and `*.reek` config files. The `.puppet-lint.rc` can be specified with the `-c` argument. If it is not specified, then PuppetLint will automatically load one from `.puppet-lint.rc`, `~/.puppet-lint.rc`, or `/etc/puppet-lint.rc`, in that order of preference. The nearest `.rubocop.yml` and `*.reek` will be automatically respected.
 
 Example:
 ```
@@ -167,15 +166,14 @@ rake puppetcheck:kitchen:* # Execute Test Kitchen acceptance tests
 ```
 
 #### puppetcheck:file
-You can add style, smoke, and regression checks to and select the future parser for the `rake puppetcheck:file`, or change the output format, by adding the following after the require:
+You can add style, smoke, and regression checks to the `rake puppetcheck:file`, or change the output format, by adding the following after the require:
 
 ```ruby
 # example of modifying Puppet Check behavior
-PuppetCheck.settings[:style_check] = true
+PuppetCheck.settings[:style] = true
 PuppetCheck.settings[:fail_on_warnings] = true
-PuppetCheck.settings[:future_parser] = true
-PuppetCheck.settings[:smoke_check] = true
-PuppetCheck.settings[:regression_check] = true # in progress, do not use
+PuppetCheck.settings[:smoke] = true
+PuppetCheck.settings[:regression] = true # in progress, do not use
 PuppetCheck.settings[:public] = 'public.pem'
 PuppetCheck.settings[:private] = 'private.pem'
 PuppetCheck.settings[:output_format] = 'yaml'
@@ -256,11 +254,10 @@ If you are performing your Puppet testing from within a Ruby script or your own
 require 'puppet-check'
 
 settings = {}
-settings[:future_parser] = true # default false
 settings[:fail_on_warnings] = true # default false
-settings[:style_check] = true # default false
-settings[:smoke_check] = true # default false
-settings[:regression_check] = true # in progress, do not use; default false
+settings[:style] = true # default false
+settings[:smoke] = true # default false
+settings[:regression] = true # in progress, do not use; default false
 settings[:public] = 'public.pem' # default nil
 settings[:private] = 'private.pem' # default nil
 settings[:output_format] = 'yaml' # also 'json'; default 'text'
@@ -301,6 +298,8 @@ ENTRYPOINT ["rake", "puppetcheck"]
 
 You can also build your own general container for testing various Puppet situations by removing the last three lines. You can then test each module, directory environment, etc. on top of that container by merely adding and modifying the final three lines to a Dockerfile that uses the container you built from the first four lines. This is recommended usage due to being very efficient and stable.
 
+As an alternative to copying Puppet code and data into the image for testing, it is also recommended to bind volume mount the container to the directory with your Puppet code and data.
+
 ### Vagrant
 
 As an alternative to Docker, you can also use Vagrant for quick and disposable testing, but it is not as portable as Docker for these testing purposes. Below is an example Vagrantfile for this purpose.

data/lib/puppet-check.rb

@@ -19,19 +19,19 @@ class PuppetCheck
     self.class.settings = settings
 
     # settings defaults
-    self.class.defaults
+    self.class.defaults(settings)
 
     # grab all of the files to be processed
     files = self.class.parse_paths(paths)
 
     # parse the files
-    execute_parsers(files, settings[:future_parser], settings[:style_check], settings[:public], settings[:private], settings[:puppetlint_args], settings[:rubocop_args])
+    execute_parsers(files, settings)
 
     # output the diagnostic results
-    settings[:output_format] == 'text' ? OutputResults.text : OutputResults.markup
+    settings[:output_format] == 'text' ? OutputResults.text : OutputResults.markup(settings)
 
     # progress to regression checks if no errors in file checks
-    if self.class.settings[:error_files].empty? && (!self.class.settings[:fail_on_warning] || self.class.settings[:warning_files].empty?)
+    if self.class.settings[:error_files].empty? && (!settings[:fail_on_warning] || self.class.settings[:warning_files].empty?)
       begin
         require_relative 'puppet-check/regression_check'
       # if octocatalog-diff is not installed then return immediately
@@ -41,7 +41,7 @@ class PuppetCheck
 
       # perform smoke checks if there were no errors and the user desires
       begin
-        catalog = RegressionCheck.smoke(settings[:octonodes], settings[:octoconfig]) if settings[:smoke_check]
+        catalog = RegressionCheck.smoke(settings[:octonodes], settings[:octoconfig]) if settings[:smoke]
       # smoke check failure? output message and return 2
       rescue OctocatalogDiff::Errors::CatalogError => err
         puts 'There was a smoke check error:'
@@ -51,7 +51,7 @@ class PuppetCheck
       end
       # perform regression checks if there were no errors and the user desires
       # begin
-      #   catalog = RegressionCheck.regression(settings[:octonodes], settings[:octoconfig]) if settings[:regression_check]
+      #   catalog = RegressionCheck.regression(settings[:octonodes], settings[:octoconfig]) if settings[:regression]
       # rescue OctocatalogDiff::Errors::CatalogError => err
       #   puts 'There was a catalog compilation error during the regression check:'
       #   puts err
@@ -68,20 +68,19 @@ class PuppetCheck
   end
 
   # establish default settings
-  def self.defaults
-    # initialize future parser, fail on warning,  style check, and regression check bools
-    @settings[:future_parser] ||= false
-    @settings[:fail_on_warning] ||= false
-    @settings[:style_check] ||= false
-    @settings[:smoke_check] ||= false
-    @settings[:regression_check] ||= false
+  def self.defaults(settings)
+    # initialize fail on warning,  style check, and regression check bools
+    settings[:fail_on_warning] ||= false
+    settings[:style] ||= false
+    settings[:smoke] ||= false
+    settings[:regression] ||= false
 
     # initialize ssl keys for eyaml checks
-    @settings[:public] ||= nil
-    @settings[:private] ||= nil
+    settings[:public] ||= nil
+    settings[:private] ||= nil
 
     # initialize output format option
-    @settings[:output_format] ||= 'text'
+    settings[:output_format] ||= 'text'
 
     # initialize diagnostic output arrays
     @settings[:error_files] = []
@@ -90,12 +89,12 @@ class PuppetCheck
     @settings[:ignored_files] = []
 
     # initialize octocatalog-diff options
-    @settings[:octoconfig] ||= '.octocatalog-diff.cfg.rb'
-    @settings[:octonodes] ||= %w[localhost.localdomain]
+    settings[:octoconfig] ||= '.octocatalog-diff.cfg.rb'
+    settings[:octonodes] ||= %w[localhost.localdomain]
 
     # initialize style arg arrays
-    @settings[:puppetlint_args] ||= []
-    @settings[:rubocop_args] ||= []
+    settings[:puppetlint_args] ||= []
+    settings[:rubocop_args] ||= []
   end
 
   # parse the paths and return the array of files
@@ -120,16 +119,16 @@ class PuppetCheck
   end
 
   # categorize and pass the files out to the parsers to determine their status
-  def execute_parsers(files, future, style, public, private, pl_args, rc_args)
+  def execute_parsers(files, settings)
     # check manifests
     manifests, files = files.partition { |file| File.extname(file) == '.pp' }
-    PuppetParser.manifest(manifests, future, style, pl_args) unless manifests.empty?
+    PuppetParser.manifest(manifests, settings[:style], settings[:puppetlint_args]) unless manifests.empty?
     # check puppet templates
     templates, files = files.partition { |file| File.extname(file) == '.epp' }
     PuppetParser.template(templates) unless templates.empty?
     # check ruby files
     rubies, files = files.partition { |file| File.extname(file) == '.rb' }
-    RubyParser.ruby(rubies, style, rc_args) unless rubies.empty?
+    RubyParser.ruby(rubies, settings[:style], settings[:rubocop_args]) unless rubies.empty?
     # check ruby templates
     templates, files = files.partition { |file| File.extname(file) == '.erb' }
     RubyParser.template(templates) unless templates.empty?
@@ -144,7 +143,7 @@ class PuppetCheck
     # DataParser.eyaml(eyamls, public, private) unless eyamls.empty?
     # check misc ruby
     librarians, files = files.partition { |file| File.basename(file) =~ /(?:Puppet|Module|Rake|Gem)file$/ }
-    RubyParser.librarian(librarians, style, rc_args) unless librarians.empty?
+    RubyParser.librarian(librarians, settings[:style], settings[:rubocop_args]) unless librarians.empty?
     # ignore everything else
     self.class.settings[:ignored_files].concat(files)
   end

data/lib/puppet-check/cli.rb

@@ -27,16 +27,15 @@ class PuppetCheck::CLI
 
       # base options
       opts.on('--version', 'Display the current version.') do
-        puts 'puppet-check 1.6.1'
+        puts 'puppet-check 2.0.0'
         exit 0
       end
 
       # bool options
-      opts.on('-f', '--future', 'Enable future parser') { settings[:future_parser] = true }
       opts.on('--fail-on-warnings', 'Fail on warnings') { settings[:fail_on_warnings] = true }
-      opts.on('-s', '--style', 'Enable style checks') { settings[:style_check] = true }
-      opts.on('--smoke', 'Enable smoke testing') { settings[:smoke_check] = true }
-      opts.on('-r', '--regression', 'Enable regression testing (in progress, do not use)') { settings[:regression_check] = true }
+      opts.on('-s', '--style', 'Enable style checks') { settings[:style] = true }
+      opts.on('--smoke', 'Enable smoke testing') { settings[:smoke] = true }
+      opts.on('-r', '--regression', 'Enable regression testing (in progress, do not use)') { settings[:regression] = true }
 
       # ssl key options for eyaml checks
       opts.on('--public cert.pem', String, 'Public key for EYAML checks') { |arg| settings[:public] = arg }

data/lib/puppet-check/data_parser.rb

@@ -85,7 +85,7 @@ class DataParser
         # check metadata.json
         if File.basename(file) == 'metadata.json'
           # metadata-json-lint has issues and is essentially no longer maintained, so here is an improved and leaner version of it
-          require 'spdx-licenses'
+          require 'rubygems/util/licenses'
 
           # check for errors
           errors = []
@@ -97,7 +97,7 @@ class DataParser
 
           # check requirements and dependencies keys
           %w[requirements dependencies].each do |key|
-            # skip if key is missing or or value is an empty string, array, or hash
+            # skip if key is missing or value is an empty string, array, or hash
             next if !parsed.key?(key) || parsed[key].empty?
 
             # check that dependencies and requirements are an array of hashes
@@ -161,16 +161,8 @@ class DataParser
           end
 
           # 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
+          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
         # assume this is task metadata if it has this key
         elsif parsed.key?('description')

data/lib/puppet-check/output_results.rb

@@ -22,7 +22,7 @@ class OutputResults
   end
 
   # output the results as yaml or json
-  def self.markup
+  def self.markup(settings)
     # generate output hash
     hash = {}
     hash['errors'] = PuppetCheck.settings[:error_files] unless PuppetCheck.settings[:error_files].empty?
@@ -31,14 +31,14 @@ class OutputResults
     hash['ignored'] = PuppetCheck.settings[:ignored_files] unless PuppetCheck.settings[:ignored_files].empty?
 
     # convert hash to markup language
-    if PuppetCheck.settings[:output_format] == 'yaml'
+    if settings[:output_format] == 'yaml'
       require 'yaml'
       puts Psych.dump(hash, indentation: 2)
-    elsif PuppetCheck.settings[:output_format] == 'json'
+    elsif settings[:output_format] == 'json'
       require 'json'
       puts JSON.pretty_generate(hash)
     else
-      raise "puppet-check: Unsupported output format '#{PuppetCheck.settings[:output_format]}' was specified."
+      raise "puppet-check: Unsupported output format '#{settings[:output_format]}' was specified."
     end
   end
 end

data/lib/puppet-check/puppet_parser.rb

@@ -4,25 +4,29 @@ require_relative '../puppet-check'
 # executes diagnostics on puppet files
 class PuppetParser
   # checks puppet (.pp)
-  def self.manifest(files, future, style, pl_args)
+  def self.manifest(files, style, pl_args)
     require 'puppet/face'
 
     # prepare the Puppet settings for the error checking
     Puppet.initialize_settings unless Puppet.settings.app_defaults_initialized?
-    Puppet[:parser] = 'future' if future && (Puppet::PUPPETVERSION.to_i < 4)
 
     files.each do |file|
-      # setup error logging and collection
+      # setup error logging and collection; warnings logged for all versions, but errors for only puppet < 6.5
       errors = []
       Puppet::Util::Log.newdestination(Puppet::Test::LogCollector.new(errors))
 
       # check puppet syntax
       begin
-        Puppet::Face[:parser, :current].validate(file)
+        # in puppet >= 6.5 the return of this method is a hash with the error
+        new_error = Puppet::Face[:parser, :current].validate(file)
+        # puppet 6.5 output format is now a hash from the face api
+        if Puppet::PUPPETVERSION.to_f >= 6.5 && new_error != {}
+          next PuppetCheck.settings[:error_files].push("#{file}:\n#{new_error.values.map(&:to_s).join("\n").gsub(/ \(file: #{File.absolute_path(file)}(, |\))/, '').gsub(/Could not parse.*: /, '')}")
+        end
       # this is the actual error that we need to rescue Puppet::Face from
       rescue SystemExit
-        # puppet 5.4-5.x has a new validator output format and eof errors have fake dir env info
-        if Puppet::PUPPETVERSION.to_f >= 5.4
+        # puppet 5.4-6.4 has a new validator output format and eof errors have fake dir env info
+        if Puppet::PUPPETVERSION.to_f >= 5.4 && Puppet::PUPPETVERSION.to_f < 6.5
           next PuppetCheck.settings[:error_files].push("#{file}:\n#{errors.map(&:to_s).join("\n").gsub(/file: #{File.absolute_path(file)}(, |\))/, '').gsub(/Could not parse.*: /, '')}")
         # puppet 5.0-5.2 can only do one error per line and outputs fake dir env info
         elsif Puppet::PUPPETVERSION.to_f >= 5.0 && Puppet::PUPPETVERSION.to_f < 5.3
@@ -77,9 +81,6 @@ class PuppetParser
     require 'puppet/pops'
 
     files.each do |file|
-      # puppet before version 4 cannot check template syntax
-      next PuppetCheck.settings[:ignored_files].push("#{file}: ignored due to Puppet < 4") if Puppet::PUPPETVERSION.to_i < 4
-
       # check puppet template syntax
       begin
         # credits to gds-operations/puppet-syntax for the parser function call

data/lib/puppet-check/rspec_puppet_support.rb

@@ -66,7 +66,7 @@ class RSpecPuppetSupport
     parsed = JSON.parse(File.read('metadata.json'))
 
     # grab dependencies if they exist
-    return if parsed['dependencies'].empty?
+    return unless parsed.key?('dependencies')
     parsed['dependencies'].each do |dependency_hash|
       # determine how the user wants to download the module dependency
       if dependency_hash.key?('git')
@@ -81,6 +81,7 @@ class RSpecPuppetSupport
         warn "#{dependency_hash['name']} has an unspecified, or specified but unsupported, download method."
       end
     end
+    Process.waitall
   end
 
   # download external module dependency with git
@@ -89,7 +90,7 @@ class RSpecPuppetSupport
     # establish path to clone module to
     path = "spec/fixtures/modules/#{File.basename(git_url, '.git')}"
     # is the module present and already cloned with git? do a pull; otherwise, do a clone
-    File.directory?("#{path}/.git") ? system("git -C #{path} pull") : system("git clone #{args} #{git_url} #{path}")
+    File.directory?("#{path}/.git") ? spawn("git -C #{path} pull") : spawn("git clone #{args} #{git_url} #{path}")
   end
 
   # download external module dependency with forge
@@ -97,7 +98,7 @@ class RSpecPuppetSupport
     private_class_method :method
     # is the module present? do an upgrade; otherwise, do an install
     subcommand = File.directory?("spec/fixtures/modules/#{forge_name}") ? 'upgrade' : 'install'
-    system("puppet module #{subcommand} --modulepath spec/fixtures/modules/ #{args} #{forge_name}")
+    spawn("puppet module #{subcommand} --modulepath spec/fixtures/modules/ #{args} #{forge_name}")
   end
 
   # download external module dependency with svn
@@ -106,7 +107,7 @@ class RSpecPuppetSupport
     # establish path to checkout module to
     path = "spec/fixtures/modules/#{File.basename(svn_url)}"
     # is the module present and already checked out with svn? do an update; otherwise, do a checkout
-    File.directory?("#{path}/.svn") ? system("svn update #{path}") : system("svn co #{args} #{svn_url} #{path}")
+    File.directory?("#{path}/.svn") ? spawn("svn update #{path}") : spawn("svn co #{args} #{svn_url} #{path}")
   end
 
   # download external module dependency with hg
@@ -115,6 +116,6 @@ class RSpecPuppetSupport
     # establish path to clone module to
     path = "spec/fixtures/modules/#{File.basename(hg_url)}"
     # is the module present and already cloned with hg? do a pull and update; otherwise do a clone
-    File.directory?("#{path}/.hg") ? system("hg --cwd #{path} pull; hg --cwd #{path} update") : system("hg clone #{args} #{hg_url} #{path}")
+    File.directory?("#{path}/.hg") ? spawn("hg --cwd #{path} pull; hg --cwd #{path} update") : spawn("hg clone #{args} #{hg_url} #{path}")
   end
 end

data/lib/puppet-check/ruby_parser.rb

@@ -18,7 +18,7 @@ class RubyParser
           require 'rubocop'
 
           # check RuboCop and collect warnings
-          rubocop_warnings = Utils.capture_stdout { RuboCop::CLI.new.run(rc_args + ['--format', 'emacs', file]) }
+          rubocop_warnings = Utils.capture_stdout { RuboCop::CLI.new.run(rc_args + ['--require', 'rubocop-performance', '--format', 'emacs', file]) }
           warnings = rubocop_warnings == '' ? '' : rubocop_warnings.split("#{File.absolute_path(file)}:").join('')
 
           # check Reek and collect warnings
@@ -79,7 +79,7 @@ class RubyParser
       else
         if style
           # check Rubocop
-          warnings = Utils.capture_stdout { RuboCop::CLI.new.run(rc_args + ['--format', 'emacs', file]) }
+          warnings = Utils.capture_stdout { RuboCop::CLI.new.run(rc_args + ['--require', 'rubocop-performance', '--format', 'emacs', file]) }
 
           # collect style warnings
           next PuppetCheck.settings[:warning_files].push("#{file}:\n#{warnings.split("#{File.absolute_path(file)}:").join('')}") unless warnings.empty?

data/spec/puppet-check/cli_spec.rb

@@ -13,8 +13,8 @@ describe PuppetCheck::CLI do
       expect { PuppetCheck::CLI.parse(%w[-s -f -asdf foo]) }.to raise_error(OptionParser::InvalidOption)
     end
 
-    it 'allows future parser, fail on warnings, style, smoke, and regression checks to be enabled' do
-      expect(PuppetCheck::CLI.parse(%w[-f --fail-on-warnings -s -r --smoke foo])).to include(future_parser: true, fail_on_warnings: true, style_check: true, smoke_check: true, regression_check: true)
+    it 'allows fail on warnings, style, smoke, and regression checks to be enabled' do
+      expect(PuppetCheck::CLI.parse(%w[--fail-on-warnings -s -r --smoke foo])).to include(fail_on_warnings: true, style: true, smoke: true, regression: true)
     end
 
     it 'correctly parser EYAML options' do
@@ -42,7 +42,7 @@ describe PuppetCheck::CLI do
     end
 
     it 'correctly parses multiple sets of arguments' do
-      expect(PuppetCheck::CLI.parse(%w[-s -f --puppet-lint puppetlint-arg-one,puppetlint-arg-two --rubocop rubocop-arg-one,rubocop-arg-two foo])).to include(future_parser: true, style_check: true, puppetlint_args: ['--puppetlint-arg-one', '--puppetlint-arg-two'], rubocop_args: ['--except', 'rubocop-arg-one,rubocop-arg-two'])
+      expect(PuppetCheck::CLI.parse(%w[-s --puppet-lint puppetlint-arg-one,puppetlint-arg-two --rubocop rubocop-arg-one,rubocop-arg-two foo])).to include(style: true, puppetlint_args: ['--puppetlint-arg-one', '--puppetlint-arg-two'], rubocop_args: ['--except', 'rubocop-arg-one,rubocop-arg-two'])
     end
   end
 end

data/spec/puppet-check/output_results_spec.rb

@@ -37,48 +37,39 @@ describe OutputResults do
     end
 
     it 'outputs files with errors as yaml' do
-      PuppetCheck.settings[:output_format] = 'yaml'
       PuppetCheck.settings[:error_files] = ['foo: i had an error']
-      expect { OutputResults.markup }.to output("---\nerrors:\n- 'foo: i had an error'\n").to_stdout
+      expect { OutputResults.markup(output_format: 'yaml') }.to output("---\nerrors:\n- 'foo: i had an error'\n").to_stdout
     end
     it 'outputs files with warnings as yaml' do
-      PuppetCheck.settings[:output_format] = 'yaml'
       PuppetCheck.settings[:warning_files] = ['foo: i had a warning']
-      expect { OutputResults.markup }.to output("---\nwarnings:\n- 'foo: i had a warning'\n").to_stdout
+      expect { OutputResults.markup(output_format: 'yaml') }.to output("---\nwarnings:\n- 'foo: i had a warning'\n").to_stdout
     end
     it 'outputs files with no errors or warnings as yaml' do
-      PuppetCheck.settings[:output_format] = 'yaml'
       PuppetCheck.settings[:clean_files] = ['foo: i was totally good to go']
-      expect { OutputResults.markup }.to output("---\nclean:\n- 'foo: i was totally good to go'\n").to_stdout
+      expect { OutputResults.markup(output_format: 'yaml') }.to output("---\nclean:\n- 'foo: i was totally good to go'\n").to_stdout
     end
     it 'outputs files that were not processed as yaml' do
-      PuppetCheck.settings[:output_format] = 'yaml'
       PuppetCheck.settings[:ignored_files] = ['foo: who knows what i am']
-      expect { OutputResults.markup }.to output("---\nignored:\n- 'foo: who knows what i am'\n").to_stdout
+      expect { OutputResults.markup(output_format: 'yaml') }.to output("---\nignored:\n- 'foo: who knows what i am'\n").to_stdout
     end
     it 'outputs files with errors as json' do
-      PuppetCheck.settings[:output_format] = 'json'
       PuppetCheck.settings[:error_files] = ['foo: i had an error']
-      expect { OutputResults.markup }.to output("{\n  \"errors\": [\n    \"foo: i had an error\"\n  ]\n}\n").to_stdout
+      expect { OutputResults.markup(output_format: 'json') }.to output("{\n  \"errors\": [\n    \"foo: i had an error\"\n  ]\n}\n").to_stdout
     end
     it 'outputs files with warnings as json' do
-      PuppetCheck.settings[:output_format] = 'json'
       PuppetCheck.settings[:warning_files] = ['foo: i had a warning']
-      expect { OutputResults.markup }.to output("{\n  \"warnings\": [\n    \"foo: i had a warning\"\n  ]\n}\n").to_stdout
+      expect { OutputResults.markup(output_format: 'json') }.to output("{\n  \"warnings\": [\n    \"foo: i had a warning\"\n  ]\n}\n").to_stdout
     end
     it 'outputs files with no errors or warnings as json' do
-      PuppetCheck.settings[:output_format] = 'json'
       PuppetCheck.settings[:clean_files] = ['foo: i was totally good to go']
-      expect { OutputResults.markup }.to output("{\n  \"clean\": [\n    \"foo: i was totally good to go\"\n  ]\n}\n").to_stdout
+      expect { OutputResults.markup(output_format: 'json') }.to output("{\n  \"clean\": [\n    \"foo: i was totally good to go\"\n  ]\n}\n").to_stdout
     end
     it 'outputs files that were not processed as json' do
-      PuppetCheck.settings[:output_format] = 'json'
       PuppetCheck.settings[:ignored_files] = ['foo: who knows what i am']
-      expect { OutputResults.markup }.to output("{\n  \"ignored\": [\n    \"foo: who knows what i am\"\n  ]\n}\n").to_stdout
+      expect { OutputResults.markup(output_format: 'json') }.to output("{\n  \"ignored\": [\n    \"foo: who knows what i am\"\n  ]\n}\n").to_stdout
     end
     it 'raises an error for an unsupported output format' do
-      PuppetCheck.settings[:output_format] = 'awesomesauce'
-      expect { OutputResults.markup }.to raise_error(RuntimeError, 'puppet-check: Unsupported output format \'awesomesauce\' was specified.')
+      expect { OutputResults.markup(output_format: 'awesomesauce') }.to raise_error(RuntimeError, 'puppet-check: Unsupported output format \'awesomesauce\' was specified.')
     end
   end
 end

data/spec/puppet-check/puppet_parser_spec.rb

@@ -10,9 +10,11 @@ describe PuppetParser do
 
   context '.manifest' do
     it 'puts a bad syntax Puppet manifest in the error files array' do
-      PuppetParser.manifest([fixtures_dir + 'manifests/syntax.pp'], false, false, [])
-      # dealing with annoying warning in puppet 5
-      if RUBY_VERSION.to_f < 2.3
+      PuppetParser.manifest([fixtures_dir + 'manifests/syntax.pp'], false, [])
+      if Puppet::PUPPETVERSION.to_f >= 6.5
+        expect(PuppetCheck.settings[:error_files][0]).to match(%r{^#{fixtures_dir}manifests/syntax.pp:\nLanguage validation logged 2 errors})
+      # dealing with annoying warning in puppet 5 and 6
+      elsif RUBY_VERSION.to_f < 2.3
         expect(PuppetCheck.settings[:error_files][0]).to match(%r{^#{fixtures_dir}manifests/syntax.pp:\nSupport for ruby version.*\n.*\nThis Variable has no effect.*\nIllegal variable name})
       else
         expect(PuppetCheck.settings[:error_files][0]).to match(%r{^#{fixtures_dir}manifests/syntax.pp:\nThis Variable has no effect.*\nIllegal variable name})
@@ -21,37 +23,37 @@ describe PuppetParser do
       expect(PuppetCheck.settings[:clean_files]).to eql([])
     end
     it 'puts a bad syntax at eof Puppet manifest in the error files array' do
-      PuppetParser.manifest([fixtures_dir + 'manifests/eof_syntax.pp'], false, false, [])
+      PuppetParser.manifest([fixtures_dir + 'manifests/eof_syntax.pp'], false, [])
       expect(PuppetCheck.settings[:error_files][0]).to match(%r{^#{fixtures_dir}manifests/eof_syntax.pp:\nSyntax error at end of input})
       expect(PuppetCheck.settings[:warning_files]).to eql([])
       expect(PuppetCheck.settings[:clean_files]).to eql([])
     end
     it 'puts a bad parser and lint style Puppet manifest in the warning files array' do
-      PuppetParser.manifest([fixtures_dir + 'manifests/style_parser.pp'], false, true, [])
+      PuppetParser.manifest([fixtures_dir + 'manifests/style_parser.pp'], true, [])
       expect(PuppetCheck.settings[:error_files]).to eql([])
       expect(PuppetCheck.settings[:warning_files][0]).to match(%r{^#{fixtures_dir}manifests/style_parser.pp:\nUnrecognized escape sequence.*\nUnrecognized escape sequence.*\n.*double quoted string containing})
       expect(PuppetCheck.settings[:clean_files]).to eql([])
     end
     it 'puts a bad lint style Puppet manifest in the warning files array' do
-      PuppetParser.manifest([fixtures_dir + 'manifests/style_lint.pp'], false, true, [])
+      PuppetParser.manifest([fixtures_dir + 'manifests/style_lint.pp'], true, [])
       expect(PuppetCheck.settings[:error_files]).to eql([])
       expect(PuppetCheck.settings[:warning_files][0]).to match(%r{^#{fixtures_dir}manifests/style_lint.pp:\n.*double quoted string containing.*\n.*indentation of})
       expect(PuppetCheck.settings[:clean_files]).to eql([])
     end
     it 'puts a bad style Puppet manifest in the clean files array when puppetlint_args ignores its warnings' do
-      PuppetParser.manifest([fixtures_dir + 'manifests/style_lint.pp'], false, true, ['--no-double_quoted_strings-check', '--no-arrow_alignment-check'])
+      PuppetParser.manifest([fixtures_dir + 'manifests/style_lint.pp'], true, ['--no-double_quoted_strings-check', '--no-arrow_alignment-check'])
       expect(PuppetCheck.settings[:error_files]).to eql([])
       expect(PuppetCheck.settings[:warning_files]).to eql([])
       expect(PuppetCheck.settings[:clean_files]).to eql(["#{fixtures_dir}manifests/style_lint.pp"])
     end
     it 'puts a good Puppet manifest in the clean files array' do
-      PuppetParser.manifest([fixtures_dir + 'manifests/good.pp'], false, true, [])
+      PuppetParser.manifest([fixtures_dir + 'manifests/good.pp'], true, [])
       expect(PuppetCheck.settings[:error_files]).to eql([])
       expect(PuppetCheck.settings[:warning_files]).to eql([])
       expect(PuppetCheck.settings[:clean_files]).to eql(["#{fixtures_dir}manifests/good.pp"])
     end
     it 'throws a well specified error for an invalid PuppetLint argument' do
-      expect { PuppetParser.manifest([fixtures_dir + 'manifests/style_lint.pp'], false, true, ['--non-existent', '--does-not-exist']) }.to raise_error(RuntimeError, 'puppet-lint: invalid option supplied among --non-existent --does-not-exist')
+      expect { PuppetParser.manifest([fixtures_dir + 'manifests/style_lint.pp'], true, ['--non-existent', '--does-not-exist']) }.to raise_error(RuntimeError, 'puppet-lint: invalid option supplied among --non-existent --does-not-exist')
     end
   end
 

data/spec/puppet-check/ruby_parser_spec.rb

@@ -72,11 +72,11 @@ describe RubyParser do
     it 'puts a bad style librarian Puppet file in the warning files array' do
       RubyParser.librarian([fixtures_dir + 'librarian_style/Puppetfile'], true, [])
       expect(PuppetCheck.settings[:error_files]).to eql([])
-      expect(PuppetCheck.settings[:warning_files][0]).to match(%r{^#{fixtures_dir}librarian_style/Puppetfile:\n.*Align the parameters.*\n.*Use the new})
+      expect(PuppetCheck.settings[:warning_files][0]).to match(%r{^#{fixtures_dir}librarian_style/Puppetfile:\n.*Align the arguments.*\n.*Use the new})
       expect(PuppetCheck.settings[:clean_files]).to eql([])
     end
     it 'puts a bad style librarian Puppet file in the clean files array when rubocop_args ignores its warnings' do
-      RubyParser.librarian([fixtures_dir + 'librarian_style/Puppetfile'], true, ['--except', 'Layout/AlignParameters,Style/HashSyntax'])
+      RubyParser.librarian([fixtures_dir + 'librarian_style/Puppetfile'], true, ['--except', 'Layout/AlignArguments,Style/HashSyntax'])
       expect(PuppetCheck.settings[:error_files]).to eql([])
       expect(PuppetCheck.settings[:warning_files]).to eql([])
       expect(PuppetCheck.settings[:clean_files]).to eql(["#{fixtures_dir}librarian_style/Puppetfile"])

data/spec/puppet-check_spec.rb

@@ -4,16 +4,15 @@ require_relative '../lib/puppet-check'
 describe PuppetCheck do
   context 'self' do
     it 'settings can be altered' do
-      PuppetCheck.settings[:future_parser] = true
-      expect(PuppetCheck.settings[:future_parser]).to eql(true)
+      expect(PuppetCheck.settings[:future_parser]).to eql(nil)
       PuppetCheck.settings[:fail_on_warnings] = true
       expect(PuppetCheck.settings[:fail_on_warnings]).to eql(true)
-      PuppetCheck.settings[:style_check] = true
-      expect(PuppetCheck.settings[:style_check]).to eql(true)
-      PuppetCheck.settings[:smoke_check] = true
-      expect(PuppetCheck.settings[:smoke_check]).to eql(true)
-      PuppetCheck.settings[:regression_check] = true
-      expect(PuppetCheck.settings[:regression_check]).to eql(true)
+      PuppetCheck.settings[:style] = true
+      expect(PuppetCheck.settings[:style]).to eql(true)
+      PuppetCheck.settings[:smoke] = true
+      expect(PuppetCheck.settings[:smoke]).to eql(true)
+      PuppetCheck.settings[:regression] = true
+      expect(PuppetCheck.settings[:regression]).to eql(true)
       PuppetCheck.settings[:public] = 'public.pem'
       expect(PuppetCheck.settings[:public]).to eql('public.pem')
       PuppetCheck.settings[:private] = 'private.pem'
@@ -66,7 +65,7 @@ describe PuppetCheck do
 
   context '.execute_parsers' do
     it 'correctly organizes a set of files and invokes the correct parsers' do
-      # parser_output = instance_double('execute_parsers', files: %w[puppet.pp puppet_template.epp ruby.rb ruby_template.erb yaml.yaml yaml.yml json.json Puppetfile Modulefile foobarbaz], future: false, style: false, pl_args: [], rc_args: [])
+      # parser_output = instance_double('execute_parsers', files: %w[puppet.pp puppet_template.epp ruby.rb ruby_template.erb yaml.yaml yaml.yml json.json Puppetfile Modulefile foobarbaz], style: false, pl_args: [], rc_args: [])
       # expect(parser_output).to receive(:manifest).with(%w[puppet.pp])
       # expect(parser_output).to receive(:template).with(%w[puppet_template.epp])
       # expect(parser_output).to receive(:ruby).with(%w[ruby.rb])

data/spec/system/system_spec.rb

@@ -38,10 +38,10 @@ describe PuppetCheck do
       PuppetCheck.settings[:warning_files] = []
       PuppetCheck.settings[:clean_files] = []
       PuppetCheck.settings[:ignored_files] = []
-      PuppetCheck.settings[:style_check] = true
+      PuppetCheck.settings[:style] = true
       # see regression_check_spec
       unless File.directory?('/home/travis')
-        PuppetCheck.settings[:smoke_check] = true
+        PuppetCheck.settings[:smoke] = true
         PuppetCheck.settings[:octonodes] = %w[good.example.com]
         PuppetCheck.settings[:octoconfig] = 'spec/octocatalog-diff/octocatalog-diff.cfg.rb'
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-check
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Matt Schuchard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-30 00:00:00.000000000 Z
+date: 2019-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '7'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '7'
@@ -48,7 +48,7 @@ dependencies:
   name: reek
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
     - - "<"
@@ -58,7 +58,7 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
     - - "<"
@@ -70,16 +70,16 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.51'
+        version: '0.58'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.51'
+        version: '0.58'
 - !ruby/object:Gem::Dependency
-  name: spdx-licenses
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -110,22 +110,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '9'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '13'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '9'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '13'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -229,7 +223,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="