puppet-check 2.3.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: caea7da11b0b884512bc9e078c71caece3bfb2045f5798c55b41201b948e5d3f
-  data.tar.gz: 6e4eae239a2cbbeda1709741c523161720dd8b28399d9e1e5cae6add54cef59b
+  metadata.gz: d04c10fa6bc7d10b70113b7d93ab7be0d0f5cc1e65e0976e2e40e3edcc561ff8
+  data.tar.gz: 5e0fc0e541f9aa21bc65015cc0bc5958a8d44b3aaf36b8d1ce5e69f3942b9221
 SHA512:
-  metadata.gz: 18d8d802b337a1b47de63aa25a4f0c2b7e6f6f6678047b2f941a28766ee7d1a18f07244b287faf37747170d170230dfb58073f67a63dce95513421acd125ca5a
-  data.tar.gz: '09031de8c432747e7967241ff0abd4290d34d38892eb4df0443e3f7e88acd5d30c177fbabf811a6958874533fe951ea795965acea0617d21e0f2f28832987e17'
+  metadata.gz: d762b4386dc42703ffea264872629684f35a98ddbf69b2eb3fb82f9039a614e146a9a6d6961c51086c33dffd80e8d192a973f4025adc355d355d1d20e442d039
+  data.tar.gz: 90cea3c4ebc6a20d48793276f3563f7d82e8067b94ab3f3ff0c6e51bbbe8de00333c34b157baec92ed919d110eb9eb29065d90e04c01c1e7a287ae2ce3ed78fc

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 2.3.1
+- No input target paths now defaults to current working directory instead of error.
+- Additionally check `Vagrantfile` and `gemspec` files.
+- Fix and improve behavior for when optional dependency `octocatalog-diff` is absent.
+
 ### 2.3.0
 - Minimum Ruby version increased to 2.7.
 - Support Puppet 8.

data/lib/puppet-check/cli.rb

@@ -6,7 +6,9 @@ class PuppetCheck::CLI
   def self.run(args)
     # gather the user arguments
     settings = parse(args)
-    raise 'puppet-check: no file paths specified; try using --help' if args.empty?
+
+    # target cwd if no paths input as variadic
+    args = [Dir.pwd] if args.empty?
 
     # run PuppetCheck with specified paths
     PuppetCheck.new.run(settings, args)

data/lib/puppet-check/output_results.rb

@@ -2,6 +2,13 @@ require_relative '../puppet_check'
 
 # class to handle outputting diagnostic results in desired format
 class OutputResults
+  HEADER = {
+    errors: "\033[31mThe following files have errors:\033[0m\n",
+    warnings: "\033[33mThe following files have warnings:\033[0m\n",
+    clean: "\033[32mThe following files have no errors or warnings:\033[0m\n-- ",
+    ignored: "\033[36mThe following files have unrecognized formats and therefore were not processed:\033[0m\n-- "
+  }.freeze
+
   # output the results in various formats
   def self.run(files, format)
     # remove empty entries
@@ -28,31 +35,26 @@ class OutputResults
   def self.text(files)
     private_class_method :method
 
-    # errors
-    category_info("\033[31mThe following files have errors:\033[0m\n", files[:errors]) if files.key?(:errors)
-    # warnings
-    category_info("\033[33mThe following files have warnings:\033[0m\n", files[:warnings]) if files.key?(:warnings)
-    # cleans
-    category_info("\033[32mThe following files have no errors or warnings:\033[0m\n-- ", files[:clean]) if files.key?(:clean)
-    # ignores
-    return unless files.key?(:ignored)
-    category_info("\033[36mThe following files have unrecognized formats and therefore were not processed:\033[0m\n-- ", files[:ignored])
-  end
+    # output text for each of four file categories
+    %i[errors warnings clean ignored].each do |category|
+      # immediately return if category is empty
+      next unless files.key?(category)
 
-  # display heading, files, and file messages per category for text formatting
-  def self.category_info(heading, files)
-    private_class_method :method
-    # display category heading
-    print heading
-
-    # display files and optionally messages
-    case files
-    when Hash then files.each { |file, messages| puts "-- #{file}:\n#{messages.join("\n")}" }
-    when Array then puts files.join("\n-- ")
-    else raise "puppet-check: The category files were of unexpected type #{files.class}. Please file an issue with this log message, category heading, and information about the parsed files."
-    end
+      # display heading, files, and file messages per category for text formatting
+      category_files = files[category]
 
-    # newline between categories for easier visual parsing
-    puts ''
+      # display category heading
+      print HEADER[category]
+
+      # display files and optionally messages
+      case category_files
+      when Hash then category_files.each { |file, messages| puts "-- #{file}:\n#{messages.join("\n")}" }
+      when Array then puts category_files.join("\n-- ")
+      else raise "puppet-check: The files category was of unexpected type #{category_files.class}. Please file an issue with this log message, category heading, and information about the parsed files."
+      end
+
+      # newline between categories for easier visual parsing
+      puts ''
+    end
   end
 end

data/lib/puppet-check/regression_check.rb

@@ -1,29 +1,34 @@
-# temporarily supress warning messages for octocatalog-diff redefining puppet constants and then reactivate
-$VERBOSE = nil
-require 'octocatalog-diff'
-$VERBOSE = false
+begin
+  # temporarily supress warning messages for octocatalog-diff redefining puppet constants and then reactivate
+  $VERBOSE = nil
+  require 'octocatalog-diff'
+  $VERBOSE = false
 
-# executes smoke and regression tests on catalogs
-class RegressionCheck
-  # smoke testing
-  def self.smoke(interface_nodes, octoconfig)
-    options = config(octoconfig)
-    nodes = options.key?(:node) ? [options[:node]] : interface_nodes
-    nodes.each do |node|
-      options[:node] = node
-      OctocatalogDiff::API::V1.catalog(options)
+  # executes smoke and regression tests on catalogs
+  class RegressionCheck
+    # smoke testing
+    def self.smoke(interface_nodes, octoconfig)
+      options = config(octoconfig)
+      nodes = options.key?(:node) ? [options[:node]] : interface_nodes
+      nodes.each do |node|
+        options[:node] = node
+        OctocatalogDiff::API::V1.catalog(options)
+      end
     end
-  end
 
-  # regression testing
-  # def self.regression(nodes, octoconfig)
-  #   options = RegressionCheck.config(octoconfig)
-  #   nodes.each { |node| stuff }
-  # end
+    # regression testing
+    # def self.regression(nodes, octoconfig)
+    #   options = RegressionCheck.config(octoconfig)
+    #   nodes.each { |node| stuff }
+    # end
 
-  # config file loading
-  def self.config(octoconfig)
-    private_class_method :method
-    OctocatalogDiff::API::V1.config(filename: octoconfig)
+    # config file loading
+    def self.config(octoconfig)
+      private_class_method :method
+      OctocatalogDiff::API::V1.config(filename: octoconfig)
+    end
   end
+rescue LoadError
+  warn 'puppet-check: octocatalog-diff is not installed, and therefore the regression checks will be skipped'
+  $VERBOSE = false
 end

data/lib/puppet-check/ruby_parser.rb

@@ -17,8 +17,8 @@ class RubyParser
 
     files.each do |file|
       # check ruby syntax
-      # prevents ruby code from actually executing
-      catch(:good) { instance_eval("BEGIN {throw :good}; #{File.read(file)}", file) }
+      # 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) }
     rescue ScriptError, StandardError => err
       PuppetCheck.files[:errors][file] = err.to_s.gsub("#{file}:", '').split("\n")
     else
@@ -80,8 +80,8 @@ class RubyParser
 
     files.each do |file|
       # check librarian puppet syntax
-      # prevents ruby code from actually executing
-      catch(:good) { instance_eval("BEGIN {throw :good}; #{File.read(file)}", file) }
+      # 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) }
     rescue SyntaxError, LoadError, ArgumentError => err
       PuppetCheck.files[:errors][file] = err.to_s.gsub("#{file}:", '').split("\n")
     # check librarian puppet style

data/lib/puppet_check.rb

@@ -36,15 +36,12 @@ class PuppetCheck
     if parsed_files[:errors].empty? && (!settings[:fail_on_warning] || parsed_files[:warnings].empty?)
       begin
         require_relative 'puppet-check/regression_check'
-      # if octocatalog-diff is not installed then return immediately
-      rescue LoadError
-        warn 'octocatalog-diff is not installed, and therefore the regressions check will be skipped'
-        return 0
-      end
 
-      # perform smoke checks if there were no errors and the user desires
-      begin
+        # perform smoke checks if there were no errors and the user desires
         catalog = RegressionCheck.smoke(settings[:octonodes], settings[:octoconfig]) if settings[:smoke]
+      # if octocatalog-diff is not installed then continue immediately
+      rescue NameError
+        puts 'puppet-check: immediately continuing to results'
       # smoke check failure? output message and return 2
       rescue OctocatalogDiff::Errors::CatalogError => err
         puts 'There was a smoke check error:'
@@ -61,6 +58,7 @@ class PuppetCheck
       #   puts catalog.error_message unless catalog.valid?
       #   2
       # end
+
       # code to output differences in catalog?
       # everything passed? return 0
       0
@@ -143,7 +141,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)file$/ }
+    librarians, files = files.partition { |file| File.basename(file) =~ /(?:Puppet|Module|Rake|Gem|Vagrant)file|.gemspec$/ }
     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

@@ -0,0 +1,23 @@
+Gem::Specification.new do |spec|
+  spec.name          = 'puppet-check'
+  spec.version       = '2.3.1'
+  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'
+  spec.homepage      = 'https://www.github.com/mschuchard/puppet-check'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir['bin/**/*', 'lib/**/*', 'spec/**/*', 'CHANGELOG.md', 'LICENSE.md', 'README.md', 'puppet-check.gemspec']
+  spec.executables   = spec.files.grep(%r{^bin/}) { |file| File.basename(file) }
+  spec.require_paths = Dir['lib']
+
+  spec.required_ruby_version = '>= 2.7.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-performance', '~> 1.0'
+  # spec.add_development_dependency 'octocatalog-diff', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/spec/puppet-check/cli_spec.rb

@@ -3,14 +3,16 @@ require_relative '../../lib/puppet-check/cli'
 
 describe PuppetCheck::CLI do
   context '.run' do
-    it 'raises an error if no paths were specified' do
-      expect { PuppetCheck::CLI.run(%w[-s -f]) }.to raise_error(RuntimeError, 'puppet-check: no file paths specified; try using --help')
+    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)
     end
   end
 
   context '.parse' do
     it 'raises an error if an invalid option was specified' do
-      expect { PuppetCheck::CLI.parse(%w[-s -f -asdf foo]) }.to raise_error(OptionParser::InvalidOption)
+      expect { PuppetCheck::CLI.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

data/spec/puppet-check/data_parser_spec.rb

@@ -15,7 +15,7 @@ describe DataParser do
     it 'puts a bad syntax yaml file in the error files hash' do
       DataParser.yaml(["#{fixtures_dir}hieradata/syntax.yaml"])
       expect(PuppetCheck.files[:errors].keys).to eql(["#{fixtures_dir}hieradata/syntax.yaml"])
-      expect(PuppetCheck.files[:errors]["#{fixtures_dir}hieradata/syntax.yaml"].join("\n")).to match(%r{^block sequence entries are not allowed})
+      expect(PuppetCheck.files[:errors]["#{fixtures_dir}hieradata/syntax.yaml"].join("\n")).to match(/^block sequence entries are not allowed/)
       expect(PuppetCheck.files[:warnings]).to eql({})
       expect(PuppetCheck.files[:clean]).to eql([])
     end
@@ -23,7 +23,7 @@ describe DataParser do
       DataParser.yaml(["#{fixtures_dir}hieradata/style.yaml"])
       expect(PuppetCheck.files[:errors]).to eql({})
       expect(PuppetCheck.files[:warnings].keys).to eql(["#{fixtures_dir}hieradata/style.yaml"])
-      expect(PuppetCheck.files[:warnings]["#{fixtures_dir}hieradata/style.yaml"].join("\n")).to match(%r{^Value\(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.files[:warnings]["#{fixtures_dir}hieradata/style.yaml"].join("\n")).to match(/^Value\(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.files[:clean]).to eql([])
     end
     it 'puts a good yaml file in the clean files array' do
@@ -47,7 +47,7 @@ describe DataParser do
     it 'puts a bad syntax eyaml file in the error files hash' do
       DataParser.eyaml(["#{fixtures_dir}hieradata/syntax.eyaml"], "#{fixtures_dir}keys/public_key.pkcs7.pem", "#{fixtures_dir}keys/private_key.pkcs7.pem")
       expect(PuppetCheck.files[:errors].keys).to eql(["#{fixtures_dir}hieradata/syntax.eyaml"])
-      expect(PuppetCheck.files[:errors]["#{fixtures_dir}hieradata/syntax.eyaml"].join("\n")).to match(%r{^block sequence entries are not allowed})
+      expect(PuppetCheck.files[:errors]["#{fixtures_dir}hieradata/syntax.eyaml"].join("\n")).to match(/^block sequence entries are not allowed/)
       expect(PuppetCheck.files[:warnings]).to eql({})
       expect(PuppetCheck.files[:clean]).to eql([])
     end
@@ -55,7 +55,7 @@ describe DataParser do
       DataParser.eyaml(["#{fixtures_dir}hieradata/style.eyaml"], "#{fixtures_dir}keys/public_key.pkcs7.pem", "#{fixtures_dir}keys/private_key.pkcs7.pem")
       expect(PuppetCheck.files[:errors]).to eql({})
       expect(PuppetCheck.files[:warnings].keys).to eql(["#{fixtures_dir}hieradata/style.eyaml"])
-      expect(PuppetCheck.files[:warnings]["#{fixtures_dir}hieradata/style.eyaml"].join("\n")).to match(%r{^Value\(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.files[:warnings]["#{fixtures_dir}hieradata/style.eyaml"].join("\n")).to match(/^Value\(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.files[:clean]).to eql([])
     end
     it 'puts a good eyaml file in the clean files array' do
@@ -70,14 +70,14 @@ describe DataParser do
     it 'puts a bad syntax json file in the error files hash' do
       DataParser.json(["#{fixtures_dir}hieradata/syntax.json"])
       expect(PuppetCheck.files[:errors].keys).to eql(["#{fixtures_dir}hieradata/syntax.json"])
-      expect(PuppetCheck.files[:errors]["#{fixtures_dir}hieradata/syntax.json"].join("\n")).to match(%r{^.*unexpected token})
+      expect(PuppetCheck.files[:errors]["#{fixtures_dir}hieradata/syntax.json"].join("\n")).to match(/after object value, got.*at line 2 column 3/)
       expect(PuppetCheck.files[:warnings]).to eql({})
       expect(PuppetCheck.files[:clean]).to eql([])
     end
     it 'puts a bad metadata json file in the error files hash' do
       DataParser.json(["#{fixtures_dir}metadata_syntax/metadata.json"])
       expect(PuppetCheck.files[:errors].keys).to eql(["#{fixtures_dir}metadata_syntax/metadata.json"])
-      expect(PuppetCheck.files[:errors]["#{fixtures_dir}metadata_syntax/metadata.json"].join("\n")).to match(%r{^Required field.*\nField 'requirements'.*\nDuplicate dependencies.*\nDeprecated field.*\nSummary exceeds})
+      expect(PuppetCheck.files[:errors]["#{fixtures_dir}metadata_syntax/metadata.json"].join("\n")).to match(/^Required field.*\nField 'requirements'.*\nDuplicate dependencies.*\nDeprecated field.*\nSummary exceeds/)
       expect(PuppetCheck.files[:warnings]).to eql({})
       expect(PuppetCheck.files[:clean]).to eql([])
     end
@@ -85,7 +85,7 @@ describe DataParser do
       DataParser.json(["#{fixtures_dir}metadata_style/metadata.json"])
       expect(PuppetCheck.files[:errors]).to eql({})
       expect(PuppetCheck.files[:warnings].keys).to eql(["#{fixtures_dir}metadata_style/metadata.json"])
-      expect(PuppetCheck.files[:warnings]["#{fixtures_dir}metadata_style/metadata.json"].join("\n")).to match(%r{^'pe' is missing an upper bound.\n.*operatingsystem_support.*\nLicense identifier})
+      expect(PuppetCheck.files[:warnings]["#{fixtures_dir}metadata_style/metadata.json"].join("\n")).to match(/^'pe' is missing an upper bound.\n.*operatingsystem_support.*\nLicense identifier/)
       expect(PuppetCheck.files[:clean]).to eql([])
     end
     it 'puts another bad style metadata json file in the warning files array' do
@@ -99,7 +99,7 @@ describe DataParser do
       DataParser.json(["#{fixtures_dir}task_metadata/task_bad.json"])
       expect(PuppetCheck.files[:errors]).to eql({})
       expect(PuppetCheck.files[:warnings].keys).to eql(["#{fixtures_dir}task_metadata/task_bad.json"])
-      expect(PuppetCheck.files[:warnings]["#{fixtures_dir}task_metadata/task_bad.json"].join("\n")).to match(%r{^description 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.files[:warnings]["#{fixtures_dir}task_metadata/task_bad.json"].join("\n")).to match(/^description 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.files[:clean]).to eql([])
     end
     it 'puts a good json file in the clean files array' do

data/spec/puppet-check/puppet_parser_spec.rb

@@ -16,9 +16,9 @@ describe PuppetParser do
       PuppetParser.manifest(["#{fixtures_dir}manifests/syntax.pp"], false, [])
       expect(PuppetCheck.files[:errors].keys).to eql(["#{fixtures_dir}manifests/syntax.pp"])
       if Gem::Version.new(Puppet::PUPPETVERSION) >= Gem::Version.new('6.5.0')
-        expect(PuppetCheck.files[:errors]["#{fixtures_dir}manifests/syntax.pp"].join("\n")).to match(%r{^Language validation logged 2 errors})
+        expect(PuppetCheck.files[:errors]["#{fixtures_dir}manifests/syntax.pp"].join("\n")).to match(/^Language validation logged 2 errors/)
       else
-        expect(PuppetCheck.files[:errors]["#{fixtures_dir}hieradata/syntax.yaml"].join("\n")).to match(%r{^This Variable has no effect.*\nIllegal variable name})
+        expect(PuppetCheck.files[:errors]["#{fixtures_dir}hieradata/syntax.yaml"].join("\n")).to match(/^This Variable has no effect.*\nIllegal variable name/)
       end
       expect(PuppetCheck.files[:warnings]).to eql({})
       expect(PuppetCheck.files[:clean]).to eql([])
@@ -28,7 +28,7 @@ describe PuppetParser do
       it 'puts a bad syntax at eof Puppet manifest in the error files hash' do
         PuppetParser.manifest(["#{fixtures_dir}manifests/eof_syntax.pp"], false, [])
         expect(PuppetCheck.files[:errors].keys).to eql(["#{fixtures_dir}manifests/eof_syntax.pp"])
-        expect(PuppetCheck.files[:errors]["#{fixtures_dir}manifests/eof_syntax.pp"].join("\n")).to match(%r{^Syntax error at end of input})
+        expect(PuppetCheck.files[:errors]["#{fixtures_dir}manifests/eof_syntax.pp"].join("\n")).to match(/^Syntax error at end of input/)
         expect(PuppetCheck.files[:warnings]).to eql({})
         expect(PuppetCheck.files[:clean]).to eql([])
       end
@@ -36,7 +36,7 @@ describe PuppetParser do
     it 'puts a bad syntax Puppet plan in the error files hash' do
       PuppetParser.manifest(["#{fixtures_dir}plans/syntax.pp"], false, [])
       expect(PuppetCheck.files[:errors].keys).to eql(["#{fixtures_dir}plans/syntax.pp"])
-      expect(PuppetCheck.files[:errors]["#{fixtures_dir}plans/syntax.pp"].join("\n")).to match(%r{^Syntax error at '\)'})
+      expect(PuppetCheck.files[:errors]["#{fixtures_dir}plans/syntax.pp"].join("\n")).to match(/^Syntax error at '\)'/)
       expect(PuppetCheck.files[:warnings]).to eql({})
       expect(PuppetCheck.files[:clean]).to eql([])
     end
@@ -44,14 +44,14 @@ describe PuppetParser do
       PuppetParser.manifest(["#{fixtures_dir}manifests/style_parser.pp"], true, [])
       expect(PuppetCheck.files[:errors]).to eql({})
       expect(PuppetCheck.files[:warnings].keys).to eql(["#{fixtures_dir}manifests/style_parser.pp"])
-      expect(PuppetCheck.files[:warnings]["#{fixtures_dir}manifests/style_parser.pp"].join("\n")).to match(%r{^Unrecognized escape sequence.*\nUnrecognized escape sequence.*\n.*double quoted string containing})
+      expect(PuppetCheck.files[:warnings]["#{fixtures_dir}manifests/style_parser.pp"].join("\n")).to match(/^Unrecognized escape sequence.*\nUnrecognized escape sequence.*\n.*double quoted string containing/)
       expect(PuppetCheck.files[:clean]).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"], true, [])
       expect(PuppetCheck.files[:errors]).to eql({})
       expect(PuppetCheck.files[:warnings].keys).to eql(["#{fixtures_dir}manifests/style_lint.pp"])
-      expect(PuppetCheck.files[:warnings]["#{fixtures_dir}manifests/style_lint.pp"].join("\n")).to match(%r{(?:indentation of|double quoted string containing).*\n.*(?:indentation of|double quoted string containing)})
+      expect(PuppetCheck.files[:warnings]["#{fixtures_dir}manifests/style_lint.pp"].join("\n")).to match(/(?:indentation of|double quoted string containing).*\n.*(?:indentation of|double quoted string containing)/)
       expect(PuppetCheck.files[:clean]).to eql([])
     end
     it 'puts a bad style Puppet manifest in the clean files array when puppetlint_args ignores its warnings' do
@@ -64,7 +64,7 @@ describe PuppetParser do
       PuppetParser.manifest(["#{fixtures_dir}plans/style.pp"], true, [])
       expect(PuppetCheck.files[:errors]).to eql({})
       expect(PuppetCheck.files[:warnings].keys).to eql(["#{fixtures_dir}plans/style.pp"])
-      expect(PuppetCheck.files[:warnings]["#{fixtures_dir}plans/style.pp"].join("\n")).to match(%r{variable not enclosed in {}})
+      expect(PuppetCheck.files[:warnings]["#{fixtures_dir}plans/style.pp"].join("\n")).to match(/variable not enclosed in {}/)
       expect(PuppetCheck.files[:clean]).to eql([])
     end
     it 'puts a good Puppet manifest in the clean files array' do
@@ -88,7 +88,7 @@ describe PuppetParser do
     it 'puts a bad syntax Puppet template in the error files hash' do
       PuppetParser.template(["#{fixtures_dir}templates/syntax.epp"])
       expect(PuppetCheck.files[:errors].keys).to eql(["#{fixtures_dir}templates/syntax.epp"])
-      expect(PuppetCheck.files[:errors]["#{fixtures_dir}templates/syntax.epp"].join("\n")).to match(%r{^This Name has no effect})
+      expect(PuppetCheck.files[:errors]["#{fixtures_dir}templates/syntax.epp"].join("\n")).to match(/^This Name has no effect/)
       expect(PuppetCheck.files[:warnings]).to eql({})
       expect(PuppetCheck.files[:clean]).to eql([])
     end

data/spec/puppet-check/regression_check_spec.rb

@@ -1,35 +1,41 @@
 require_relative '../spec_helper'
-require_relative '../../lib/puppet-check/regression_check'
+begin
+  require_relative '../../lib/puppet-check/regression_check'
 
-# once a good config is loaded, bad configs would have no effect so failures are tested first; config is also tested before compilation so that the good config can be loaded at the end and used for compilation and regression tests
-describe RegressionCheck do
-  context '.config' do
-    # json gem got 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!')
-    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
-    end
-    it 'loads in the settings from the file correctly' do
+  # once a good config is loaded, bad configs would have no effect so failures are tested first; config is also tested before compilation so that the good config can be loaded at the end and used for compilation and regression tests
+  describe RegressionCheck do
+    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!')
+      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
+      end
+      it 'loads in the settings from the file correctly' do
+        # TODO
+      end
     end
-  end
 
-  context '.smoke' do
-    # octocatalog-diff is returning a blank error for these tests
-    unless ENV['CIRCLECI'] == 'true' || ENV['GITHUB_ACTIONS'] == 'true'
-      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
+    context '.smoke' do
+      # octocatalog-diff is returning a blank error for these tests
+      unless ENV['CIRCLECI'] == 'true' || ENV['GITHUB_ACTIONS'] == 'true'
+        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
+        it 'returns a failure for a catalog with an error' do
+          expect { RegressionCheck.smoke(['does_not_exist.example.com'], "#{octocatalog_diff_dir}octocatalog_diff.cfg.rb") }.to raise_error(OctocatalogDiff::Errors::CatalogError)
+        end
       end
-      it 'returns a failure for a catalog with an error' do
-        expect { RegressionCheck.smoke(['does_not_exist.example.com'], "#{octocatalog_diff_dir}octocatalog_diff.cfg.rb") }.to raise_error(OctocatalogDiff::Errors::CatalogError)
+      it 'returns a failure for a good and bad catalog' do
+        # RegressionCheck.smoke(['good.example.com', 'syntax_error.example.com'], "#{fixtures_dir}octocatalog_diff.cfg.rb")
       end
     end
-    it 'returns a failure for a good and bad catalog' do
-      # RegressionCheck.smoke(['good.example.com', 'syntax_error.example.com'], "#{fixtures_dir}octocatalog_diff.cfg.rb")
-    end
-  end
 
-  context '.regression' do
+    context '.regression' do
+      # TODO
+    end
   end
+rescue NameError
+  puts 'puppet-check+rspec: octocatalog-diff is not installed, and its unit tests will be skipped'
 end

data/spec/puppet-check/ruby_parser_spec.rb

@@ -15,7 +15,7 @@ describe RubyParser do
     it 'puts a bad syntax ruby file in the error files hash' do
       RubyParser.ruby(["#{fixtures_dir}lib/syntax.rb"], false, [])
       expect(PuppetCheck.files[:errors].keys).to eql(["#{fixtures_dir}lib/syntax.rb"])
-      expect(PuppetCheck.files[:errors]["#{fixtures_dir}lib/syntax.rb"].join("\n")).to match(%r{^.*syntax error})
+      expect(PuppetCheck.files[:errors]["#{fixtures_dir}lib/syntax.rb"].join("\n")).to match(/^.*syntax error/)
       expect(PuppetCheck.files[:warnings]).to eql({})
       expect(PuppetCheck.files[:clean]).to eql([])
     end
@@ -23,7 +23,7 @@ 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(%r{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})
+      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/)
       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
@@ -45,9 +45,9 @@ describe RubyParser do
       RubyParser.template(["#{fixtures_dir}templates/syntax.erb"])
       expect(PuppetCheck.files[:errors].keys).to eql(["#{fixtures_dir}templates/syntax.erb"])
       if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.7')
-        expect(PuppetCheck.files[:errors]["#{fixtures_dir}templates/syntax.erb"].join("\n")).to match(%r{1: syntax error, unexpected.*\n.*ruby})
+        expect(PuppetCheck.files[:errors]["#{fixtures_dir}templates/syntax.erb"].join("\n")).to match(/1: syntax error, unexpected.*\n.*ruby/)
       else
-        expect(PuppetCheck.files[:errors]["#{fixtures_dir}templates/syntax.erb"].join("\n")).to match(%r{syntax error, unexpected tIDENTIFIER})
+        expect(PuppetCheck.files[:errors]["#{fixtures_dir}templates/syntax.erb"].join("\n")).to match(/syntax error, unexpected tIDENTIFIER/)
       end
       expect(PuppetCheck.files[:warnings]).to eql({})
       expect(PuppetCheck.files[:clean]).to eql([])
@@ -56,7 +56,7 @@ describe RubyParser do
       RubyParser.template(["#{fixtures_dir}templates/style.erb"])
       expect(PuppetCheck.files[:errors]).to eql({})
       expect(PuppetCheck.files[:warnings].keys).to eql(["#{fixtures_dir}templates/style.erb"])
-      expect(PuppetCheck.files[:warnings]["#{fixtures_dir}templates/style.erb"].join("\n")).to match(%r{already initialized constant.*\n.*previous definition of})
+      expect(PuppetCheck.files[:warnings]["#{fixtures_dir}templates/style.erb"].join("\n")).to match(/already initialized constant.*\n.*previous definition of/)
       expect(PuppetCheck.files[:clean]).to eql([])
     end
     it 'puts a ruby template file with ignored errors in the clean files array' do
@@ -77,7 +77,7 @@ describe RubyParser 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(%r{^.*syntax error})
+      expect(PuppetCheck.files[:errors]["#{fixtures_dir}librarian_syntax/Puppetfile"].join("\n")).to match(/^.*syntax error/)
       expect(PuppetCheck.files[:warnings]).to eql({})
       expect(PuppetCheck.files[:clean]).to eql([])
     end
@@ -85,7 +85,7 @@ describe RubyParser do
       RubyParser.librarian(["#{fixtures_dir}librarian_style/Puppetfile"], 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(%r{Align the arguments.*\n.*Use the new})
+      expect(PuppetCheck.files[:warnings]["#{fixtures_dir}librarian_style/Puppetfile"].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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-check
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Matt Schuchard
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-12 00:00:00.000000000 Z
+date: 2025-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet
@@ -86,20 +86,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: octocatalog-diff
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -151,6 +137,7 @@ files:
 - lib/puppet-check/tasks.rb
 - lib/puppet-check/utils.rb
 - lib/puppet_check.rb
+- puppet-check.gemspec
 - spec/fixtures/foobarbaz
 - spec/fixtures/hieradata/good.eyaml
 - spec/fixtures/hieradata/good.json
@@ -227,7 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: A streamlined comprehensive set of checks for your entire Puppet code and