puppet-check 2.3.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d04c10fa6bc7d10b70113b7d93ab7be0d0f5cc1e65e0976e2e40e3edcc561ff8
-  data.tar.gz: 5e0fc0e541f9aa21bc65015cc0bc5958a8d44b3aaf36b8d1ce5e69f3942b9221
+  metadata.gz: c5c74c1af6aee54ad5dcfd3eeefa459ed9fd5eaaafdc847f346a8e3674ffb362
+  data.tar.gz: c11db9238470434a489608d62360d12fe1ff10dda29627a05cdded940785b992
 SHA512:
-  metadata.gz: d762b4386dc42703ffea264872629684f35a98ddbf69b2eb3fb82f9039a614e146a9a6d6961c51086c33dffd80e8d192a973f4025adc355d355d1d20e442d039
-  data.tar.gz: 90cea3c4ebc6a20d48793276f3563f7d82e8067b94ab3f3ff0c6e51bbbe8de00333c34b157baec92ed919d110eb9eb29065d90e04c01c1e7a287ae2ce3ed78fc
+  metadata.gz: 12416f0a0d2d2615c467645cb238e0b14be8f42c9172e5adf7acf3bfbdddbdae1d5b08ccd2a967dcb7b6af41a8149f2e30e22ed5d0db97c5f05e586e384c4a61
+  data.tar.gz: 053f4f90842f2d71ccbc82a3b05cd5ef1347af5399686fc3ed4a7cbf824baeee63ad412c1d6261f3640929bdcba789db7e2fe46d7f3e529cf3cd6b1c8b9690d8

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+### 2.4.0
+- Minimum Ruby version increased to 3.0.
+- Fix `rubocop-performance` inclusion warning.
+- Improve recognition of Ruby support files during filesystem parsing.
+- Fix `file` task for no settings override usage.
+- Add `rubocop-rspec` plugin to Ruby checks.
+- Fix `--fail-on-warnings` functionality.
+- Improve safety of Ruby syntax checks.
+- Safely load Puppet data files.
+
 ### 2.3.1
 - No input target paths now defaults to current working directory instead of error.
 - Additionally check `Vagrantfile` and `gemspec` files.

data/lib/puppet-check/cli.rb

@@ -15,8 +15,7 @@ class PuppetCheck::CLI
   end
 
   # parse the user arguments
-  def self.parse(args)
-    private_class_method :method
+  private_class_method def self.parse(args)
     require 'optparse'
 
     # show help message if no args specified

data/lib/puppet-check/data_parser.rb

@@ -8,7 +8,7 @@ class DataParser
   def self.yaml(files)
     files.each do |file|
       # check yaml syntax
-      parsed = YAML.load_file(file)
+      parsed = YAML.safe_load_file(file, permitted_classes: [Symbol], permitted_symbols: [], aliases: true)
     rescue StandardError => err
       PuppetCheck.files[:errors][file] = err.to_s.gsub("(#{file}): ", '').split("\n")
     else
@@ -44,7 +44,7 @@ class DataParser
 
     files.each do |file|
       # check encoded yaml syntax
-      parsed = YAML.load_file(file)
+      parsed = YAML.safe_load_file(file, permitted_classes: [Symbol], permitted_symbols: [], aliases: true)
 
       # extract encoded values
       # ENC[PKCS7]
@@ -205,8 +205,7 @@ class DataParser
   end
 
   # checks hieradata
-  def self.hiera(data, file)
-    private_class_method :method
+  private_class_method def self.hiera(data, file)
     warnings = []
 
     # disregard nil/undef value data check if default values (common)

data/lib/puppet-check/output_results.rb

@@ -32,9 +32,7 @@ class OutputResults
   end
 
   # output the results as text
-  def self.text(files)
-    private_class_method :method
-
+  private_class_method def self.text(files)
     # output text for each of four file categories
     %i[errors warnings clean ignored].each do |category|
       # immediately return if category is empty

data/lib/puppet-check/regression_check.rb

@@ -23,8 +23,7 @@ begin
     # end
 
     # config file loading
-    def self.config(octoconfig)
-      private_class_method :method
+    private_class_method def self.config(octoconfig)
       OctocatalogDiff::API::V1.config(filename: octoconfig)
     end
   end

data/lib/puppet-check/rspec_puppet_support.rb

@@ -29,8 +29,7 @@ class RSpecPuppetSupport
   end
 
   # setup the files, directories, and symlinks for rspec-puppet testing
-  def self.file_setup(module_name)
-    private_class_method :method
+  private_class_method def self.file_setup(module_name)
     # create all the necessary fixture dirs that are missing
     ['spec/fixtures', 'spec/fixtures/manifests', 'spec/fixtures/modules'].each do |dir|
       Dir.mkdir(dir) unless File.directory?(dir)
@@ -58,8 +57,7 @@ class RSpecPuppetSupport
   end
 
   # setup the module dependencies for rspec-puppet testing
-  def self.dependency_setup
-    private_class_method :method
+  private_class_method def self.dependency_setup
     require 'json'
 
     # parse the metadata.json (assumes DataParser.json has already given it a pass)
@@ -85,8 +83,7 @@ class RSpecPuppetSupport
   end
 
   # download external module dependency with git
-  def self.git(git_url, args = '')
-    private_class_method :method
+  private_class_method def self.git(git_url, args = '')
     # 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
@@ -98,16 +95,14 @@ class RSpecPuppetSupport
   end
 
   # download external module dependency with forge
-  def self.forge(forge_name, args = '')
-    private_class_method :method
+  private_class_method def self.forge(forge_name, args = '')
     # is the module present? do an upgrade; otherwise, do an install
     subcommand = File.directory?("spec/fixtures/modules/#{forge_name}") ? 'upgrade' : 'install'
     spawn("puppet module #{subcommand} --modulepath spec/fixtures/modules/ #{args} #{forge_name}")
   end
 
   # download external module dependency with svn
-  def self.svn(svn_url, args = '')
-    private_class_method :method
+  private_class_method def self.svn(svn_url, args = '')
     # 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
@@ -119,8 +114,7 @@ class RSpecPuppetSupport
   end
 
   # download external module dependency with hg
-  def self.hg(hg_url, args = '')
-    private_class_method :method
+  private_class_method def self.hg(hg_url, args = '')
     # 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

data/lib/puppet-check/ruby_parser.rb

@@ -17,15 +17,14 @@ class RubyParser
 
     files.each do |file|
       # check ruby syntax
-      # prevents ruby code from actually executing the input ruby file
-      catch(:good) { instance_eval("BEGIN {throw :good}; #{File.read(file)} # BEGIN {throw :good}; ruby_file_content", file) }
+      RubyVM::InstructionSequence.compile_file(file)
     rescue ScriptError, StandardError => err
       PuppetCheck.files[:errors][file] = err.to_s.gsub("#{file}:", '').split("\n")
     else
       # check ruby style
       if style
         # check RuboCop and parse warnings' JSON output
-        rubocop_warnings = Utils.capture_stdout { rubocop_cli.run(rc_args + ['--enable-pending-cops', '--require', 'rubocop-performance', '--format', 'json', file]) }
+        rubocop_warnings = Utils.capture_stdout { rubocop_cli.run(rc_args + ['--enable-pending-cops', '--plugin', 'rubocop-performance', '--plugin', 'rubocop-rspec', '--format', 'json', file]) }
         rubocop_offenses = JSON.parse(rubocop_warnings)['files'][0]['offenses'].map { |warning| "#{warning['location']['line']}:#{warning['location']['column']} #{warning['message']}" }
 
         # check Reek and parse warnings' JSON output
@@ -87,7 +86,7 @@ class RubyParser
     # check librarian puppet style
     else
       if style
-        warnings = Utils.capture_stdout { rubocop_cli.run(rc_args + ['--enable-pending-cops', '--require', 'rubocop-performance', '--format', 'json', file]) }
+        warnings = Utils.capture_stdout { rubocop_cli.run(rc_args + ['--enable-pending-cops', '--plugin', 'rubocop-performance', '--format', 'json', file]) }
         offenses = JSON.parse(warnings)['files'][0]['offenses'].map { |warning| "#{warning['location']['line']}:#{warning['location']['column']} #{warning['message']}" }
 
         # collect style warnings

data/lib/puppet-check/tasks.rb

@@ -16,7 +16,8 @@ class PuppetCheck::Tasks < Rake::TaskLib
     namespace :puppetcheck do
       desc 'Execute Puppet-Check file checks'
       task :file, [:settings] do |_, wrapped_settings|
-        PuppetCheck.new.run(wrapped_settings[:settings], Dir.glob('*'))
+        wrapped_settings = wrapped_settings[:settings] || {}
+        PuppetCheck.new.run(wrapped_settings, Dir.glob('*'))
       end
 
       # rspec and rspec-puppet tasks

data/lib/puppet-check/utils.rb

@@ -1,22 +1,26 @@
+require 'stringio'
+
 # utility methods totally not edited from StackOverflow
 class Utils
   # captures stdout from a block: out = capture_stdout { code }
   def self.capture_stdout
-    old_stdout = $stdout
+    Thread.current[:old_stdout] = $stdout
     $stdout = StringIO.new
     yield
     $stdout.string
   ensure
-    $stdout = old_stdout
+    $stdout = Thread.current[:old_stdout] if Thread.current[:old_stdout]
+    Thread.current[:old_stdout] = nil
   end
 
   # captures stderr from a block: err = capture_stderr { code }
   def self.capture_stderr
-    old_stderr = $stderr
+    Thread.current[:old_stderr] = $stderr
     $stderr = StringIO.new
     yield
     $stderr.string
   ensure
-    $stderr = old_stderr
+    $stderr = Thread.current[:old_stderr] if Thread.current[:old_stderr]
+    Thread.current[:old_stderr] = nil
   end
 end

data/lib/puppet_check.rb

@@ -33,7 +33,7 @@ class PuppetCheck
     OutputResults.run(parsed_files.clone, settings[:output_format])
 
     # progress to regression checks if no errors in file checks
-    if parsed_files[:errors].empty? && (!settings[:fail_on_warning] || parsed_files[:warnings].empty?)
+    if parsed_files[:errors].empty? && (!settings[:fail_on_warnings] || parsed_files[:warnings].empty?)
       begin
         require_relative 'puppet-check/regression_check'
 
@@ -68,10 +68,10 @@ class PuppetCheck
     end
   end
 
+  private
+
   # establish default settings
   def self.defaults(settings = {})
-    private_class_method :method
-
     # return settings with defaults where unspecified
     {
       # initialize fail on warning,  style check, and regression check bools
@@ -95,7 +95,6 @@ class PuppetCheck
 
   # parse the paths and return the array of files
   def self.parse_paths(paths = [])
-    private_class_method :method
     files = []
 
     # traverse the unique paths and return all files not explicitly in fixtures
@@ -115,8 +114,6 @@ class PuppetCheck
     files.map { |file| file.gsub('//', '/') }.uniq
   end
 
-  private
-
   # categorize and pass the files out to the parsers to determine their status
   def execute_parsers(files, style, puppetlint_args, rubocop_args, public, private)
     # check manifests
@@ -141,7 +138,7 @@ class PuppetCheck
     eyamls, files = files.partition { |file| File.extname(file) =~ /\.eya?ml$/ }
     DataParser.eyaml(eyamls, public, private) unless eyamls.empty?
     # check misc ruby
-    librarians, files = files.partition { |file| File.basename(file) =~ /(?:Puppet|Module|Rake|Gem|Vagrant)file|.gemspec$/ }
+    librarians, files = files.partition { |file| File.basename(file) =~ /^(?:Puppet|Module|Rake|Gem|Vagrant)file|\.gemspec$/ && File.extname(file) != '.lock' }
     RubyParser.librarian(librarians, style, rubocop_args) unless librarians.empty?
     # ignore everything else
     files.each { |file| self.class.files[:ignored].push(file.to_s) }

data/puppet-check.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = 'puppet-check'
-  spec.version       = '2.3.1'
+  spec.version       = '2.4.0'
   spec.authors       = ['Matt Schuchard']
   spec.description   = 'Puppet Check is a gem that provides a comprehensive, streamlined, and efficient analysis of the syntax, style, and validity of your entire Puppet code and data.'
   spec.summary       = 'A streamlined comprehensive set of checks for your entire Puppet code and data'
@@ -11,12 +11,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |file| File.basename(file) }
   spec.require_paths = Dir['lib']
 
-  spec.required_ruby_version = '>= 2.7.0'
+  spec.required_ruby_version = '>= 3.0.0'
   spec.add_dependency 'puppet', '>= 5.5', '< 9'
   spec.add_dependency 'puppet-lint', '~> 4.0'
   spec.add_dependency 'reek', '~> 6.0'
-  spec.add_dependency 'rubocop', '~> 1.0'
+  spec.add_dependency 'rubocop', '~> 1.72'
   spec.add_dependency 'rubocop-performance', '~> 1.0'
+  spec.add_dependency 'rubocop-rspec', '~> 3.0'
   # spec.add_development_dependency 'octocatalog-diff', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'

data/spec/puppet-check/cli_spec.rb

@@ -6,45 +6,49 @@ describe PuppetCheck::CLI do
     it 'targets the current working directory if no paths were specified' do
       expect { PuppetCheck::CLI.run(%w[--fail-on-warnings]) }.not_to raise_exception
       expect(PuppetCheck.files[:clean].length).to eql(30)
-      expect(PuppetCheck.files[:ignored].length).to eql(7)
+      if ci_env
+        expect(PuppetCheck.files[:ignored].length).to eql(8)
+      else
+        expect(PuppetCheck.files[:ignored].length).to eql(7)
+      end
     end
   end
 
   context '.parse' do
     it 'raises an error if an invalid option was specified' do
-      expect { PuppetCheck::CLI.parse(%w[-s -asdf foo]) }.to raise_error(OptionParser::InvalidOption)
+      expect { PuppetCheck::CLI.send(:parse, %w[-s -asdf foo]) }.to raise_error(OptionParser::InvalidOption)
     end
 
     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)
+      expect(PuppetCheck::CLI.send(: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
-      expect(PuppetCheck::CLI.parse(%w[--public pub.pem --private priv.pem])).to include(public: 'pub.pem', private: 'priv.pem')
+      expect(PuppetCheck::CLI.send(:parse, %w[--public pub.pem --private priv.pem])).to include(public: 'pub.pem', private: 'priv.pem')
     end
 
     it 'correctly parses a formatting option' do
-      expect(PuppetCheck::CLI.parse(%w[-o text])).to include(output_format: 'text')
+      expect(PuppetCheck::CLI.send(:parse, %w[-o text])).to include(output_format: 'text')
     end
 
     it 'correctly parses octocatalog-diff options' do
-      expect(PuppetCheck::CLI.parse(%w[--octoconfig config.cfg.rb --octonodes server1,server2])).to include(octoconfig: 'config.cfg.rb', octonodes: %w[server1 server2])
+      expect(PuppetCheck::CLI.send(:parse, %w[--octoconfig config.cfg.rb --octonodes server1,server2])).to include(octoconfig: 'config.cfg.rb', octonodes: %w[server1 server2])
     end
 
     it 'correctly parses PuppetLint arguments' do
-      expect(PuppetCheck::CLI.parse(%w[--puppet-lint puppetlint-arg-one,puppetlint-arg-two foo])).to include(puppetlint_args: ['--puppetlint-arg-one', '--puppetlint-arg-two'])
+      expect(PuppetCheck::CLI.send(:parse, %w[--puppet-lint puppetlint-arg-one,puppetlint-arg-two foo])).to include(puppetlint_args: ['--puppetlint-arg-one', '--puppetlint-arg-two'])
     end
 
     it 'correctly loads a .puppet-lint.rc' do
-      expect(PuppetCheck::CLI.parse(%W[-c #{fixtures_dir}/manifests/.puppet-lint.rc])).to include(puppetlint_args: ['--puppetlint-arg-one', '--puppetlint-arg-two'])
+      expect(PuppetCheck::CLI.send(:parse, %W[-c #{fixtures_dir}/manifests/.puppet-lint.rc])).to include(puppetlint_args: ['--puppetlint-arg-one', '--puppetlint-arg-two'])
     end
 
     it 'correctly parses Rubocop arguments' do
-      expect(PuppetCheck::CLI.parse(%w[--rubocop rubocop-arg-one,rubocop-arg-two foo])).to include(rubocop_args: ['--except', 'rubocop-arg-one,rubocop-arg-two'])
+      expect(PuppetCheck::CLI.send(:parse, %w[--rubocop rubocop-arg-one,rubocop-arg-two foo])).to include(rubocop_args: ['--except', 'rubocop-arg-one,rubocop-arg-two'])
     end
 
     it 'correctly parses multiple sets of arguments' do
-      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'])
+      expect(PuppetCheck::CLI.send(:parse, %w[-s --puppet-lint puppet-lint-arg-one,puppet-lint-arg-two --rubocop rubocop-arg-one,rubocop-arg-two foo])).to include(style: true, puppetlint_args: ['--puppet-lint-arg-one', '--puppet-lint-arg-two'], rubocop_args: ['--except', 'rubocop-arg-one,rubocop-arg-two'])
     end
   end
 end

data/spec/puppet-check/output_results_spec.rb

@@ -5,19 +5,19 @@ describe OutputResults do
   context '.text' do
     it 'outputs files with errors' do
       files = { errors: { 'foo' => ['i had an error'] } }
-      expect { OutputResults.text(files) }.to output("\033[31mThe following files have errors:\033[0m\n-- foo:\ni had an error\n\n").to_stdout
+      expect { OutputResults.send(:text, files) }.to output("\033[31mThe following files have errors:\033[0m\n-- foo:\ni had an error\n\n").to_stdout
     end
     it 'outputs files with warnings' do
       files = { warnings: { 'foo' => ['i had a warning'] } }
-      expect { OutputResults.text(files) }.to output("\033[33mThe following files have warnings:\033[0m\n-- foo:\ni had a warning\n\n").to_stdout
+      expect { OutputResults.send(:text, files) }.to output("\033[33mThe following files have warnings:\033[0m\n-- foo:\ni had a warning\n\n").to_stdout
     end
     it 'outputs files with no errors or warnings' do
       files = { clean: ['foo'] }
-      expect { OutputResults.text(files) }.to output("\033[32mThe following files have no errors or warnings:\033[0m\n-- foo\n\n").to_stdout
+      expect { OutputResults.send(:text, files) }.to output("\033[32mThe following files have no errors or warnings:\033[0m\n-- foo\n\n").to_stdout
     end
     it 'outputs files that were not processed' do
       files = { ignored: ['foo'] }
-      expect { OutputResults.text(files) }.to output("\033[36mThe following files have unrecognized formats and therefore were not processed:\033[0m\n-- foo\n\n").to_stdout
+      expect { OutputResults.send(:text, files) }.to output("\033[36mThe following files have unrecognized formats and therefore were not processed:\033[0m\n-- foo\n\n").to_stdout
     end
   end
 

data/spec/puppet-check/regression_check_spec.rb

@@ -7,10 +7,10 @@ begin
     context '.config' do
       # json gem is messed up for the EOL Ruby versions
       it 'raise an appropriate error if the file is malformed' do
-        expect { RegressionCheck.config("#{fixtures_dir}metadata.json") }.to raise_error(OctocatalogDiff::Errors::ConfigurationFileContentError, 'Configuration must define OctocatalogDiff::Config!')
+        expect { RegressionCheck.send(:config, "#{fixtures_dir}metadata.json") }.to raise_error(OctocatalogDiff::Errors::ConfigurationFileContentError, 'Configuration must define OctocatalogDiff::Config!')
       end
       it 'loads in a good octocatalog-diff config file' do
-        expect { RegressionCheck.config("#{octocatalog_diff_dir}octocatalog_diff.cfg.rb") }.not_to raise_exception
+        expect { RegressionCheck.send(:config, "#{octocatalog_diff_dir}octocatalog_diff.cfg.rb") }.not_to raise_exception
       end
       it 'loads in the settings from the file correctly' do
         # TODO
@@ -19,7 +19,7 @@ begin
 
     context '.smoke' do
       # octocatalog-diff is returning a blank error for these tests
-      unless ENV['CIRCLECI'] == 'true' || ENV['GITHUB_ACTIONS'] == 'true'
+      unless ci_env
         it 'returns a pass for a successful catalog compilation' do
           expect { RegressionCheck.smoke(['good.example.com'], "#{octocatalog_diff_dir}octocatalog_diff.cfg.rb") }.not_to raise_exception
         end

data/spec/puppet-check/rspec_puppet_support_spec.rb

@@ -15,7 +15,7 @@ describe RSpecPuppetSupport do
 
     it 'creates missing directories, missing site.pp, missing symlinks, and a missing spec_helper' do
       # circle ci and gh actions
-      if ENV['CIRCLECI'] == 'true' || ENV['GITHUB_ACTIONS'] == 'true'
+      if ci_env
         expect { rspec_puppet_setup }.to output("git is not installed and cannot be used to retrieve dependency modules\nsubversion is not installed and cannot be used to retrieve dependency modules\npuppetlabs/gruntmaster has an unspecified, or specified but unsupported, download method.\n").to_stderr
       else
         expect { rspec_puppet_setup }.to output("subversion is not installed and cannot be used to retrieve dependency modules\npuppetlabs/gruntmaster has an unspecified, or specified but unsupported, download method.\n").to_stderr
@@ -29,7 +29,7 @@ describe RSpecPuppetSupport do
       expect(File.file?('spec/spec_helper.rb')).to be true
 
       # .dependency_setup
-      expect(File.directory?('spec/fixtures/modules/puppetlabs-lvm')).to be true unless ENV['CIRCLECI'] == 'true' || ENV['GITHUB_ACTIONS'] == 'true'
+      expect(File.directory?('spec/fixtures/modules/puppetlabs-lvm')).to be true unless ci_env
       expect(File.directory?('spec/fixtures/modules/stdlib')).to be true
     end
   end

data/spec/puppet-check/ruby_parser_spec.rb

@@ -23,7 +23,11 @@ describe RubyParser do
       RubyParser.ruby(["#{fixtures_dir}lib/style.rb"], true, [])
       expect(PuppetCheck.files[:errors]).to eql({})
       expect(PuppetCheck.files[:warnings].keys).to eql(["#{fixtures_dir}lib/style.rb"])
-      expect(PuppetCheck.files[:warnings]["#{fixtures_dir}lib/style.rb"].join("\n")).to match(/Useless assignment.*\n.*Use the new.*\n.*Do not introduce.*\n.*Prefer single.*\n.*Remove unnecessary empty.*\n.*Source code comment is empty.*\n.*is a writable attribute.*\n.*Issue has no descriptive comment/)
+      unless ci_env
+        expect(PuppetCheck.files[:warnings]["#{fixtures_dir}lib/style.rb"].join("\n")).to match(/Useless assignment.*\n.*Use the new.*\n.*Do not introduce.*\n.*Prefer single.*\n.*Remove unnecessary empty.*\n.*Source code comment is empty.*\n.*is a writable attribute.*\n.*Issue has no descriptive comment/)
+      else
+        expect(PuppetCheck.files[:warnings]["#{fixtures_dir}lib/style.rb"].join("\n")).to match(/Useless assignment.*\n.*Use the new.*\n.*Do not introduce.*\n.*Prefer single.*\n.*Remove unnecessary empty.*\n.*Source code comment is empty/)
+      end
       expect(PuppetCheck.files[:clean]).to eql([])
     end
     it 'puts a bad style ruby file in the clean files array when rubocop_args ignores its warnings' do
@@ -75,30 +79,30 @@ describe RubyParser do
 
   context '.librarian' do
     it 'puts a bad syntax librarian Puppet file in the error files hash' do
-      RubyParser.librarian(["#{fixtures_dir}librarian_syntax/Puppetfile"], false, [])
-      expect(PuppetCheck.files[:errors].keys).to eql(["#{fixtures_dir}librarian_syntax/Puppetfile"])
-      expect(PuppetCheck.files[:errors]["#{fixtures_dir}librarian_syntax/Puppetfile"].join("\n")).to match(/^.*syntax error/)
+      RubyParser.librarian(["#{fixtures_dir}librarian/Puppetfile_syntax"], false, [])
+      expect(PuppetCheck.files[:errors].keys).to eql(["#{fixtures_dir}librarian/Puppetfile_syntax"])
+      expect(PuppetCheck.files[:errors]["#{fixtures_dir}librarian/Puppetfile_syntax"].join("\n")).to match(/^.*syntax error/)
       expect(PuppetCheck.files[:warnings]).to eql({})
       expect(PuppetCheck.files[:clean]).to eql([])
     end
     it 'puts a bad style librarian Puppet file in the warning files array' do
-      RubyParser.librarian(["#{fixtures_dir}librarian_style/Puppetfile"], true, [])
+      RubyParser.librarian(["#{fixtures_dir}librarian/Puppetfile_style"], true, [])
       expect(PuppetCheck.files[:errors]).to eql({})
-      expect(PuppetCheck.files[:warnings].keys).to eql(["#{fixtures_dir}librarian_style/Puppetfile"])
-      expect(PuppetCheck.files[:warnings]["#{fixtures_dir}librarian_style/Puppetfile"].join("\n")).to match(/Align the arguments.*\n.*Use the new/)
+      expect(PuppetCheck.files[:warnings].keys).to eql(["#{fixtures_dir}librarian/Puppetfile_style"])
+      expect(PuppetCheck.files[:warnings]["#{fixtures_dir}librarian/Puppetfile_style"].join("\n")).to match(/Align the arguments.*\n.*Use the new/)
       expect(PuppetCheck.files[:clean]).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/ArgumentAlignment,Style/HashSyntax'])
+      RubyParser.librarian(["#{fixtures_dir}librarian/Puppetfile_style"], true, ['--except', 'Layout/ArgumentAlignment,Style/HashSyntax'])
       expect(PuppetCheck.files[:errors]).to eql({})
       expect(PuppetCheck.files[:warnings]).to eql({})
-      expect(PuppetCheck.files[:clean]).to eql(["#{fixtures_dir}librarian_style/Puppetfile"])
+      expect(PuppetCheck.files[:clean]).to eql(["#{fixtures_dir}librarian/Puppetfile_style"])
     end
     it 'puts a good librarian Puppet file in the clean files array' do
-      RubyParser.librarian(["#{fixtures_dir}librarian_good/Puppetfile"], true, [])
+      RubyParser.librarian(["#{fixtures_dir}librarian/Puppetfile_good"], true, [])
       expect(PuppetCheck.files[:errors]).to eql({})
       expect(PuppetCheck.files[:warnings]).to eql({})
-      expect(PuppetCheck.files[:clean]).to eql(["#{fixtures_dir}librarian_good/Puppetfile"])
+      expect(PuppetCheck.files[:clean]).to eql(["#{fixtures_dir}librarian/Puppetfile_good"])
     end
   end
 end

data/spec/puppet_check_spec.rb

@@ -33,7 +33,7 @@ describe PuppetCheck do
 
   context 'defaults' do
     it 'returns defaults correctly' do
-      expect(PuppetCheck.defaults).to eql(
+      expect(PuppetCheck.send(:defaults)).to eql(
         {
           fail_on_warning: false,
           style: false,
@@ -64,18 +64,18 @@ describe PuppetCheck do
         puppetlint_args: %w[--puppetlint-arg-one --puppetlint-arg-two],
         rubocop_args: %w[--rubocop-arg-one --rubocop-arg-two]
       }
-      expect(PuppetCheck.defaults(settings)).to eql(settings)
+      expect(PuppetCheck.send(:defaults, settings)).to eql(settings)
     end
   end
 
   context '.parse_paths' do
     before(:each) { Dir.chdir(fixtures_dir) }
 
-    let(:no_files) { PuppetCheck.parse_paths(%w[foo bar baz]) }
-    let(:file) { PuppetCheck.parse_paths(['lib/good.rb']) }
-    let(:dir) { PuppetCheck.parse_paths(['.']) }
-    let(:multi_dir) { PuppetCheck.parse_paths(%w[hieradata lib manifests]) }
-    let(:repeats) { PuppetCheck.parse_paths(['hieradata', 'hieradata', 'lib', 'hieradata/good.json', 'manifests/good.pp', 'manifests/good.pp']) }
+    let(:no_files) { PuppetCheck.send(:parse_paths, %w[foo bar baz]) }
+    let(:file) { PuppetCheck.send(:parse_paths, ['lib/good.rb']) }
+    let(:dir) { PuppetCheck.send(:parse_paths, ['.']) }
+    let(:multi_dir) { PuppetCheck.send(:parse_paths, %w[hieradata lib manifests]) }
+    let(:repeats) { PuppetCheck.send(: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\'.')
@@ -87,7 +87,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 }
-      if ENV['CIRCLECI'] == 'true' || ENV['GITHUB_ACTIONS'] == 'true'
+      if ci_env
         expect(dir.length).to eql(37)
       else
         expect(dir.length).to eql(40)

data/spec/spec_helper.rb

@@ -11,6 +11,10 @@ module Variables
   def octocatalog_diff_dir
     @octocatalog_diff_dir = "#{File.dirname(__FILE__)}/octocatalog-diff/"
   end
+
+  def ci_env
+    @ci_env = ENV['CIRCLECI'] == 'true' || ENV['GITHUB_ACTIONS'] == 'true'
+  end
 end
 
 RSpec.configure do |config|

data/spec/system/system_spec.rb

@@ -5,24 +5,20 @@ require_relative '../../lib/puppet-check/tasks'
 
 describe PuppetCheck do
   context 'executed as a system from the CLI with arguments and various files to be processed' do
-    # see regression_check_spec
-    if ENV['CIRCLECI'] == 'true' || ENV['GITHUB_ACTIONS'] == 'true'
-      let(:cli) { PuppetCheck::CLI.run(%w[-s --puppet-lint no-hard_tabs-check,no-140chars-check --rubocop Layout/LineLength,Style/Encoding --public keys/public_key.pkcs7.pem --private keys/private_key.pkcs7.pem .]) }
-    else
-      let(:cli) { PuppetCheck::CLI.run(%w[-s --puppet-lint no-hard_tabs-check,no-140chars-check --rubocop Layout/LineLength,Style/Encoding --public keys/public_key.pkcs7.pem --private keys/private_key.pkcs7.pem --smoke -n good.example.com --octoconfig spec/octocatalog-diff/octocatalog-diff.cfg.rb .]) }
-    end
-
     it 'outputs diagnostic results correctly after processing all of the files' do
       Dir.chdir(fixtures_dir)
 
-      expect { cli }.not_to raise_exception
+      # see regression_check_spec
+      if ci_env
+        expect(PuppetCheck::CLI.run(%w[-s --puppet-lint no-hard_tabs-check,no-140chars-check --rubocop Layout/LineLength,Style/Encoding --public keys/public_key.pkcs7.pem --private keys/private_key.pkcs7.pem .])).to eql(2)
+      else
+        expect(PuppetCheck::CLI.run(%w[-s --puppet-lint no-hard_tabs-check,no-140chars-check --rubocop Layout/LineLength,Style/Encoding --public keys/public_key.pkcs7.pem --private keys/private_key.pkcs7.pem --smoke -n good.example.com --octoconfig spec/octocatalog-diff/octocatalog-diff.cfg.rb .])).to eql(2)
+      end
 
       expect(PuppetCheck.files[:errors].length).to eql(11)
-      expect(PuppetCheck.files[:warnings].length).to eql(12)
-      expect(PuppetCheck.files[:clean].length).to eql(14)
+      expect(PuppetCheck.files[:warnings].length).to eql(13)
+      expect(PuppetCheck.files[:clean].length).to eql(13)
       expect(PuppetCheck.files[:ignored].length).to eql(3)
-
-      expect(cli).to eql(2)
     end
   end
 
@@ -38,16 +34,9 @@ describe PuppetCheck do
         clean: [],
         ignored: []
       }
-      settings = { style: true }
-      # see regression_check_spec
-      unless ENV['CIRCLECI'] == 'true' || ENV['GITHUB_ACTIONS'] == 'true'
-        settings[:smoke] = true
-        settings[:octonodes] = %w[good.example.com]
-        settings[:octoconfig] = 'spec/octocatalog-diff/octocatalog-diff.cfg.rb'
-      end
 
       # cannot re-use plan fixture between system tests
-      expect { Rake::Task[:'puppetcheck:file'].invoke(settings) }.to raise_error(ArgumentError, /Attempt to redefine entity/)
+      expect { Rake::Task[:'puppetcheck:file'].execute }.to raise_error(ArgumentError, /Attempt to redefine entity/)
 
       # current puppet pops limitations no longer allow testing this
       # expect(PuppetCheck.files[:errors].length).to eql(11)
@@ -55,5 +44,36 @@ describe PuppetCheck do
       # expect(PuppetCheck.files[:clean].length).to eql(14)
       # expect(PuppetCheck.files[:ignored].length).to eql(3)
     end
+
+    it 'uses override settings and outputs diagnostic results correctly after processing all of the files' do
+        # ensure rake only checks the files inside fixtures
+        Dir.chdir(fixtures_dir)
+
+        # clear out files member from previous system test
+        PuppetCheck.files = {
+          errors: {},
+          warnings: {},
+          clean: [],
+          ignored: []
+        }
+
+        # assign settings
+        settings = { style: true }
+        # see regression_check_spec
+        unless ci_env
+          settings[:smoke] = true
+          settings[:octonodes] = %w[good.example.com]
+          settings[:octoconfig] = 'spec/octocatalog-diff/octocatalog-diff.cfg.rb'
+        end
+
+        # cannot re-use plan fixture between system tests
+        expect { Rake::Task[:'puppetcheck:file'].invoke(settings) }.to raise_error(ArgumentError, /Attempt to redefine entity/)
+
+        # current puppet pops limitations no longer allow testing this
+        # expect(PuppetCheck.files[:errors].length).to eql(11)
+        # expect(PuppetCheck.files[:warnings].length).to eql(12)
+        # expect(PuppetCheck.files[:clean].length).to eql(14)
+        # expect(PuppetCheck.files[:ignored].length).to eql(3)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-check
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.4.0
 platform: ruby
 authors:
 - Matt Schuchard
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-08-09 00:00:00.000000000 Z
+date: 2025-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet
@@ -64,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.72'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.72'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +86,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -153,9 +167,9 @@ files:
 - spec/fixtures/lib/rubocop_style.rb
 - spec/fixtures/lib/style.rb
 - spec/fixtures/lib/syntax.rb
-- spec/fixtures/librarian_good/Puppetfile
-- spec/fixtures/librarian_style/Puppetfile
-- spec/fixtures/librarian_syntax/Puppetfile
+- spec/fixtures/librarian/Puppetfile_good
+- spec/fixtures/librarian/Puppetfile_style
+- spec/fixtures/librarian/Puppetfile_syntax
 - spec/fixtures/manifests/eof_syntax.pp
 - spec/fixtures/manifests/good.pp
 - spec/fixtures/manifests/style_lint.pp
@@ -207,7 +221,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="