puppet-check 2.2.2 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8202ec2f014dfda495943251a944a05a2f02dd411d4432d4ae2fa670090147f
-  data.tar.gz: 79926aa5d6f7a5b4abdf5141a110d08f2dd2d678439b89a3a4193ba957b3eb36
+  metadata.gz: caea7da11b0b884512bc9e078c71caece3bfb2045f5798c55b41201b948e5d3f
+  data.tar.gz: 6e4eae239a2cbbeda1709741c523161720dd8b28399d9e1e5cae6add54cef59b
 SHA512:
-  metadata.gz: 5881b391a02f1f7afd9d902e16c578fa02128511275e9c670767ec2c1ebcce263a1137f36244c1e8bb118da057719f955727df577a6df421d66966cb39d3d054
-  data.tar.gz: d74c947acf7b79cbc0f82ba7280617495eb2bfd7574e6e22791b59bffa8a9fa4228aec7194fd3c8c9b77e99993a10dc9886074e43c3166da69b2d0ccccd1a052
+  metadata.gz: 18d8d802b337a1b47de63aa25a4f0c2b7e6f6f6678047b2f941a28766ee7d1a18f07244b287faf37747170d170230dfb58073f67a63dce95513421acd125ca5a
+  data.tar.gz: '09031de8c432747e7967241ff0abd4290d34d38892eb4df0443e3f7e88acd5d30c177fbabf811a6958874533fe951ea795965acea0617d21e0f2f28832987e17'

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 2.3.0
+- Minimum Ruby version increased to 2.7.
+- Support Puppet 8.
+- Upgrade EYAML validation functionality from experimental to beta.
+- Code execution optimization.
+
 ### 2.2.2
 - Workaround Ruby passbyref issue mutating an immutable.
 

data/README.md

@@ -1,7 +1,4 @@
 # Puppet Check
-[![Build Status](https://travis-ci.com/mschuchard/puppet-check.svg?branch=master)](https://travis-ci.com/mschuchard/puppet-check)
-[![CircleCI](https://circleci.com/gh/mschuchard/puppet-check.svg?style=svg)](https://circleci.com/gh/mschuchard/puppet-check)
-
 - [Description](#description)
 - [Usage](#usage)
   - [CLI](#cli)
@@ -16,7 +13,7 @@
 ## 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.
 
-**IMPORTANT**: The current support for encrypted yaml validation is experimental. The code is blocked in the current release (the files will continue to be treated as unrecognized) and will be unblocked when the feature is finished in a future version.
+**IMPORTANT**: The current support for encrypted yaml validation is experimental and should be considered a beta feature as of 2.3.0.
 
 ### Former Method for Code and Data Checks
 ![Old](https://raw.githubusercontent.com/mschuchard/puppet-check/master/images/puppetcheck_old.png)

data/lib/puppet-check/cli.rb

@@ -29,7 +29,9 @@ class PuppetCheck::CLI
 
       # base options
       opts.on('--version', 'Display the current version.') do
-        puts 'puppet-check 2.2.2'
+        require 'rubygems'
+
+        puts Gem::Specification.load("#{File.dirname(__FILE__)}/../../puppet-check.gemspec").version
         exit 0
       end
 

data/lib/puppet-check/data_parser.rb

@@ -43,27 +43,30 @@ class DataParser
     x509 = OpenSSL::X509::Certificate.new(File.read(public))
 
     files.each do |file|
-      # grab all encoded portions of the eyaml
+      # check encoded yaml syntax
+      parsed = YAML.load_file(file)
 
-      # decrypt the encoded portions
-      decrypted = OpenSSL::PKCS7.new(File.read(file)).decrypt(rsa, x509)
+      # extract encoded values
+      # ENC[PKCS7]
 
-      # insert decrypted portions back into eyaml (pass into loader below)
+      # decrypt the encoded yaml
+      # decrypted = OpenSSL::PKCS7.new(File.read(file)).decrypt(rsa, x509)
 
-      # check yaml syntax
-      begin
-        parsed = YAML.load_file(decrypted)
-      rescue StandardError => err
-        PuppetCheck.files[:errors][file] = err.to_s.gsub("(#{file}): ", '').split("\n")
-      else
-        warnings = []
-
-        # perform some rudimentary hiera checks if data exists and is hieradata
-        warnings = hiera(parsed, file) if parsed
-
-        next PuppetCheck.files[:warnings][file] = warnings unless warnings.empty?
-        PuppetCheck.files[:clean].push(file.to_s)
-      end
+      # check decoded eyaml syntax
+      # decoded = YAML.safe_load(decrypted)
+
+      # merge data hashes
+      # parsed = merge(parsed, decoded)
+    rescue StandardError => err
+      PuppetCheck.files[:errors][file] = err.to_s.gsub("(#{file}): ", '').split("\n")
+    else
+      warnings = []
+
+      # perform some rudimentary hiera checks if data exists and is hieradata
+      warnings = hiera(parsed, file) if parsed
+
+      next PuppetCheck.files[:warnings][file] = warnings unless warnings.empty?
+      PuppetCheck.files[:clean].push(file.to_s)
     end
   end
 
@@ -79,127 +82,125 @@ class DataParser
 
     files.each do |file|
       # check json syntax
-      begin
-        parsed = JSON.parse(File.read(file))
-      rescue JSON::ParserError => err
-        PuppetCheck.files[:errors][file] = err.to_s.lines.first.strip.split("\n")
-      else
-        warnings = []
-
-        # 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 'rubygems/util/licenses'
-
-          # check for errors
-          errors = []
-
-          # check for required keys
-          REQUIRED_KEYS.each do |key|
-            errors.push("Required field '#{key}' not found.") unless parsed.key?(key)
-          end
+      parsed = JSON.parse(File.read(file))
+    rescue JSON::ParserError => err
+      PuppetCheck.files[:errors][file] = err.to_s.lines.first.strip.split("\n")
+    else
+      warnings = []
 
-          # check requirements and dependencies keys
-          REQ_DEP_KEYS.each do |key|
-            # skip if key is missing or value is an empty string, array, or hash
-            next if !parsed.key?(key) || parsed[key].empty?
+      # 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 'rubygems/util/licenses'
 
-            # check that dependencies and requirements are an array of hashes
-            next errors.push("Field '#{key}' is not an array of hashes.") unless (parsed[key].is_a? Array) && (parsed[key][0].is_a? Hash)
+        # check for errors
+        errors = []
 
-            # check dependencies and requirements values
-            names = []
-            parsed[key].each do |req_dep|
-              # check for duplicate dependencies and requirements
-              name = req_dep['name']
-              next errors.push("Duplicate #{key} on #{name}.") if names.include?(name)
-              names << name
+        # check for required keys
+        REQUIRED_KEYS.each do |key|
+          errors.push("Required field '#{key}' not found.") unless parsed.key?(key)
+        end
+
+        # check requirements and dependencies keys
+        REQ_DEP_KEYS.each do |key|
+          # 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
+          next errors.push("Field '#{key}' is not an array of hashes.") unless (parsed[key].is_a? Array) && (parsed[key][0].is_a? Hash)
 
-              # warn and skip if key is missing
-              next warnings.push("'#{req_dep['name']}' is missing a 'version_requirement' key.") if req_dep['version_requirement'].nil?
+          # check dependencies and requirements values
+          names = []
+          parsed[key].each do |req_dep|
+            # check for duplicate dependencies and requirements
+            name = req_dep['name']
+            next errors.push("Duplicate #{key} on #{name}.") if names.include?(name)
+            names << name
 
-              # warn and skip if no upper bound
-              next warnings.push("'#{req_dep['name']}' is missing an upper bound.") unless req_dep['version_requirement'].include?('<')
+            # warn and skip if key is missing
+            next warnings.push("'#{req_dep['name']}' is missing a 'version_requirement' key.") if req_dep['version_requirement'].nil?
 
-              # check for semantic versioning
-              if key == 'dependencies' && req_dep['version_requirement'] !~ /\d+\.\d+\.\d+.*\d+\.\d+\.\d+/
-                warnings.push("'#{req_dep['name']}' has non-semantic versioning in its 'version_requirement' key.")
-              end
+            # warn and skip if no upper bound
+            next warnings.push("'#{req_dep['name']}' is missing an upper bound.") unless req_dep['version_requirement'].include?('<')
+
+            # check for semantic versioning
+            if key == 'dependencies' && req_dep['version_requirement'] !~ /\d+\.\d+\.\d+.*\d+\.\d+\.\d+/
+              warnings.push("'#{req_dep['name']}' has non-semantic versioning in its 'version_requirement' key.")
             end
           end
+        end
 
-          # check for deprecated fields
-          DEPRECATED_KEYS.each do |key|
-            errors.push("Deprecated field '#{key}' found.") if parsed.key?(key)
-          end
+        # check for deprecated fields
+        DEPRECATED_KEYS.each do |key|
+          errors.push("Deprecated field '#{key}' found.") if parsed.key?(key)
+        end
 
-          # check for summary under 144 character
-          errors.push('Summary exceeds 144 characters.') if parsed.key?('summary') && parsed['summary'].size > 144
+        # check for summary under 144 character
+        errors.push('Summary exceeds 144 characters.') if parsed.key?('summary') && parsed['summary'].size > 144
 
-          next PuppetCheck.files[:errors][file] = errors unless errors.empty?
+        next PuppetCheck.files[:errors][file] = errors unless errors.empty?
 
-          # check for warnings
-          # check for operatingsystem_support hash array
-          if parsed.key?('operatingsystem_support')
-            # check if operatingsystem_support array is actually empty
-            if !(parsed['operatingsystem_support'].is_a? Array) || parsed['operatingsystem_support'].empty? || (!parsed['operatingsystem_support'].empty? && !(parsed['operatingsystem_support'][0].is_a? Hash))
-              warnings.push('Recommended field \'operatingsystem\' not found.')
-              warnings.push('Recommended field \'operatingsystemrelease\' not found.')
+        # check for warnings
+        # check for operatingsystem_support hash array
+        if parsed.key?('operatingsystem_support')
+          # check if operatingsystem_support array is actually empty
+          if !(parsed['operatingsystem_support'].is_a? Array) || parsed['operatingsystem_support'].empty? || (!parsed['operatingsystem_support'].empty? && !(parsed['operatingsystem_support'][0].is_a? Hash))
+            warnings.push('Recommended field \'operatingsystem\' not found.')
+            warnings.push('Recommended field \'operatingsystemrelease\' not found.')
+          else
+            # check for operatingsystem string
+            if parsed['operatingsystem_support'][0].key?('operatingsystem')
+              warnings.push('Field \'operatingsystem\' is not a string.') unless parsed['operatingsystem_support'][0]['operatingsystem'].is_a? String
             else
-              # check for operatingsystem string
-              if parsed['operatingsystem_support'][0].key?('operatingsystem')
-                warnings.push('Field \'operatingsystem\' is not a string.') unless parsed['operatingsystem_support'][0]['operatingsystem'].is_a? String
-              else
-                warnings.push('Recommended field \'operatingsystem\' not found.')
-              end
-
-              # check for operatingsystemrelease string array
-              if parsed['operatingsystem_support'][0].key?('operatingsystemrelease')
-                warnings.push('Field \'operatingsystemrelease\' is not a string array.') unless parsed['operatingsystem_support'][0]['operatingsystemrelease'][0].is_a? String
-              else
-                warnings.push('Recommended field \'operatingsystemrelease\' not found.')
-              end
+              warnings.push('Recommended field \'operatingsystem\' not found.')
             end
-          else
-            warnings.push('Recommended field \'operatingsystem_support\' not found.')
-          end
 
-          # check for spdx license
-          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')
-          # check that description is a string
-          warnings.push('description value is not a String') unless parsed['description'].is_a?(String)
-          # check that input_method is one of three possible values
-          if parsed.key?('input_method')
-            if parsed['input_method'].is_a?(String)
-              warnings.push('input_method value is not one of environment, stdin, or powershell') unless TASK_INPUTS.include?(parsed['input_method'])
+            # check for operatingsystemrelease string array
+            if parsed['operatingsystem_support'][0].key?('operatingsystemrelease')
+              warnings.push('Field \'operatingsystemrelease\' is not a string array.') unless parsed['operatingsystem_support'][0]['operatingsystemrelease'][0].is_a? String
             else
-              warnings.push('input_method value is not a String')
+              warnings.push('Recommended field \'operatingsystemrelease\' not found.')
             end
           end
-          # check that parameters is a hash
-          if parsed.key?('parameters') && !parsed['parameters'].is_a?(Hash)
-            warnings.push('parameters value is not a Hash')
-          end
-          # check that puppet_task_version is an integer
-          if parsed.key?('puppet_task_version') && !parsed['puppet_task_version'].is_a?(Integer)
-            warnings.push('puppet_task_version value is not an Integer')
-          end
-          # check that supports_noop is a boolean
-          if parsed.key?('supports_noop') && !(parsed['supports_noop'].is_a?(TrueClass) || parsed['supports_noop'].is_a?(FalseClass))
-            warnings.push('supports_noop value is not a Boolean')
+        else
+          warnings.push('Recommended field \'operatingsystem_support\' not found.')
+        end
+
+        # check for spdx license
+        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')
+        # check that description is a string
+        warnings.push('description value is not a String') unless parsed['description'].is_a?(String)
+        # check that input_method is one of three possible values
+        if parsed.key?('input_method')
+          if parsed['input_method'].is_a?(String)
+            warnings.push('input_method value is not one of environment, stdin, or powershell') unless TASK_INPUTS.include?(parsed['input_method'])
+          else
+            warnings.push('input_method value is not a String')
           end
-        # assume this is hieradata and ensure it is non-empty
-        elsif parsed
-          # perform some rudimentary hiera checks if data exists
-          warnings = hiera(parsed, file)
         end
-        next PuppetCheck.files[:warnings][file] = warnings unless warnings.empty?
-        PuppetCheck.files[:clean].push(file.to_s)
+        # check that parameters is a hash
+        if parsed.key?('parameters') && !parsed['parameters'].is_a?(Hash)
+          warnings.push('parameters value is not a Hash')
+        end
+        # check that puppet_task_version is an integer
+        if parsed.key?('puppet_task_version') && !parsed['puppet_task_version'].is_a?(Integer)
+          warnings.push('puppet_task_version value is not an Integer')
+        end
+        # check that supports_noop is a boolean
+        if parsed.key?('supports_noop') && !(parsed['supports_noop'].is_a?(TrueClass) || parsed['supports_noop'].is_a?(FalseClass))
+          warnings.push('supports_noop value is not a Boolean')
+        end
+      # assume this is hieradata and ensure it is non-empty
+      elsif parsed
+        # perform some rudimentary hiera checks if data exists
+        warnings = hiera(parsed, file)
       end
+      next PuppetCheck.files[:warnings][file] = warnings unless warnings.empty?
+      PuppetCheck.files[:clean].push(file.to_s)
     end
   end
 
@@ -219,7 +220,7 @@ class DataParser
     end
 
     # check that '---' does not show up more than once in the hieradata
-    warnings.push('The string --- appears more than once in this data and Hiera may fail to parse it correctly.') if File.read(file).scan(/---/).count >= 2
+    warnings.push('The string --- appears more than once in this data and Hiera may fail to parse it correctly.') if File.read(file).scan('---').count >= 2
 
     warnings
   end

data/lib/puppet-check/output_results.rb

@@ -29,23 +29,30 @@ class OutputResults
     private_class_method :method
 
     # errors
-    if files.key?(:errors)
-      puts "\033[31mThe following files have errors:\033[0m"
-      files[:errors].each { |file, errors| puts "-- #{file}:\n#{errors.join("\n")}" }
-    end
+    category_info("\033[31mThe following files have errors:\033[0m\n", files[:errors]) if files.key?(:errors)
     # warnings
-    if files.key?(:warnings)
-      puts "\n\033[33mThe following files have warnings:\033[0m"
-      files[:warnings].each { |file, warnings| puts "-- #{file}:\n#{warnings.join("\n")}" }
-    end
+    category_info("\033[33mThe following files have warnings:\033[0m\n", files[:warnings]) if files.key?(:warnings)
     # cleans
-    if files.key?(:clean)
-      print "\n\033[32mThe following files have no errors or warnings:\033[0m\n-- "
-      puts files[:clean].join("\n-- ")
-    end
+    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)
-    print "\n\033[36mThe following files have unrecognized formats and therefore were not processed:\033[0m\n-- "
-    puts files[:ignored].join("\n-- ")
+    category_info("\033[36mThe following files have unrecognized formats and therefore were not processed:\033[0m\n-- ", files[:ignored])
+  end
+
+  # 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
+
+    # newline between categories for easier visual parsing
+    puts ''
   end
 end

data/lib/puppet-check/puppet_parser.rb

@@ -10,6 +10,13 @@ class PuppetParser
     # prepare the Puppet settings for the error checking
     Puppet.initialize_settings unless Puppet.settings.app_defaults_initialized?
 
+    # prepare the PuppetLint object for style checks
+    if style
+      require 'puppet-lint'
+      require 'puppet-lint/optparser'
+      puppet_lint = PuppetLint.new
+    end
+
     files.each do |file|
       # setup error logging and collection; warnings logged for all versions, but errors for only puppet < 6.5
       errors = []
@@ -48,9 +55,6 @@ class PuppetParser
 
       # check puppet style
       if style
-        require 'puppet-lint'
-        require 'puppet-lint/optparser'
-
         # check for invalid arguments to PuppetLint
         begin
           PuppetLint::OptParser.build.parse!(pl_args.clone)
@@ -58,8 +62,7 @@ class PuppetParser
           raise "puppet-lint: invalid option supplied among #{pl_args.join(' ')}"
         end
 
-        # prepare the PuppetLint object for style checks
-        puppet_lint = PuppetLint.new
+        # execute puppet-lint style checks
         puppet_lint.file = file
         puppet_lint.run
 

data/lib/puppet-check/ruby_parser.rb

@@ -5,6 +5,16 @@ require_relative 'utils'
 class RubyParser
   # checks ruby (.rb)
   def self.ruby(files, style, rc_args)
+    # prepare rubocop object for style checks
+    if style
+      require 'json'
+      require 'rubocop'
+      require 'reek'
+      require 'reek/cli/application'
+
+      rubocop_cli = RuboCop::CLI.new
+    end
+
     files.each do |file|
       # check ruby syntax
       # prevents ruby code from actually executing
@@ -15,16 +25,10 @@ class RubyParser
       # check ruby style
       if style
         # check RuboCop and parse warnings' JSON output
-        require 'json'
-        require 'rubocop'
-
-        rubocop_warnings = Utils.capture_stdout { RuboCop::CLI.new.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', '--require', 'rubocop-performance', '--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
-        require 'reek'
-        require 'reek/cli/application'
-
         reek_warnings = Utils.capture_stdout { Reek::CLI::Application.new(['-f', 'json', file]).execute }
         reek_offenses = JSON.parse(reek_warnings).map { |warning| "#{warning['lines'].join(',')}: #{warning['context']} #{warning['message']}" }
 
@@ -65,6 +69,11 @@ class RubyParser
   def self.librarian(files, style, rc_args)
     # efficient var assignment prior to iterator
     if style
+      require 'json'
+      require 'rubocop'
+
+      rubocop_cli = RuboCop::CLI.new
+
       # RuboCop is grumpy about non-snake_case filenames so disable the FileName check
       rc_args.include?('--except') ? rc_args[rc_args.index('--except') + 1] = "#{rc_args[rc_args.index('--except') + 1]},Naming/FileName" : rc_args.push('--except', 'Naming/FileName')
     end
@@ -78,11 +87,7 @@ class RubyParser
     # check librarian puppet style
     else
       if style
-        # check Rubocop
-        require 'json'
-        require 'rubocop'
-
-        warnings = Utils.capture_stdout { RuboCop::CLI.new.run(rc_args + ['--enable-pending-cops', '--require', 'rubocop-performance', '--format', 'json', file]) }
+        warnings = Utils.capture_stdout { rubocop_cli.run(rc_args + ['--enable-pending-cops', '--require', '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.rb

@@ -13,7 +13,7 @@ class PuppetCheck
     ignored: []
   }
 
-  # allow the parser methods write to the files
+  # allow the parser methods to write to the files
   class << self
     attr_accessor :files
   end
@@ -27,7 +27,7 @@ class PuppetCheck
     files = self.class.parse_paths(paths)
 
     # parse the files
-    parsed_files = execute_parsers(files, settings)
+    parsed_files = execute_parsers(files, settings[:style], settings[:puppetlint_args], settings[:rubocop_args], settings[:public], settings[:private])
 
     # output the diagnostic results
     OutputResults.run(parsed_files.clone, settings[:output_format])
@@ -38,6 +38,7 @@ class PuppetCheck
         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
 
@@ -72,29 +73,26 @@ class PuppetCheck
   # establish default settings
   def self.defaults(settings = {})
     private_class_method :method
-    # 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
-
-    # initialize output format option
-    settings[:output_format] ||= 'text'
-
-    # initialize octocatalog-diff options
-    settings[:octoconfig] ||= '.octocatalog-diff.cfg.rb'
-    settings[:octonodes] ||= %w[localhost.localdomain]
-
-    # initialize style arg arrays
-    settings[:puppetlint_args] ||= []
-    settings[:rubocop_args] ||= []
-
-    # return update settings
-    settings
+    # return settings with defaults where unspecified
+    {
+      # initialize fail on warning,  style check, and regression check bools
+      fail_on_warning: false,
+      style: false,
+      smoke: false,
+      regression: false,
+      # initialize ssl keys for eyaml checks
+      public: nil,
+      private: nil,
+      # initialize output format option
+      output_format: 'text',
+      # initialize octocatalog-diff options
+      octoconfig: '.octocatalog-diff.cfg.rb',
+      octonodes: %w[localhost.localdomain],
+      # initialize style arg arrays
+      puppetlint_args: [],
+      rubocop_args: []
+    }.merge(settings)
   end
 
   # parse the paths and return the array of files
@@ -102,36 +100,36 @@ class PuppetCheck
     private_class_method :method
     files = []
 
-    # traverse the unique paths and return all files
+    # traverse the unique paths and return all files not explicitly in fixtures
     paths.uniq.each do |path|
       if File.directory?(path)
-        files.concat(Dir.glob("#{path}/**/*").select { |subpath| File.file?(subpath) })
-      elsif File.file?(path)
+        # glob all files in directory and concat them
+        files.concat(Dir.glob("#{path}/**/*").select { |subpath| File.file?(subpath) && !subpath.include?('fixtures') })
+      elsif File.file?(path) && !path.include?('fixtures')
         files.push(path)
+      else
+        warn "puppet-check: #{path} is not a directory, file, or symlink, and will not be considered during parsing"
       end
     end
 
-    # do not process fixtures, check that at least one file was found, and remove double slashes
-    files.reject! { |file| file.include?('fixtures') }
+    # check that at least one file was found, and remove double slashes from returned array
     raise "puppet-check: no files found in supplied paths '#{paths.join(', ')}'." if files.empty?
-    files.map! { |file| file.gsub('//', '/') }
-
-    files.uniq
+    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, settings)
+  def execute_parsers(files, style, puppetlint_args, rubocop_args, public, private)
     # check manifests
     manifests, files = files.partition { |file| File.extname(file) == '.pp' }
-    PuppetParser.manifest(manifests, settings[:style], settings[:puppetlint_args]) unless manifests.empty?
+    PuppetParser.manifest(manifests, style, 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, settings[:style], settings[:rubocop_args]) unless rubies.empty?
+    RubyParser.ruby(rubies, style, rubocop_args) unless rubies.empty?
     # check ruby templates
     templates, files = files.partition { |file| File.extname(file) == '.erb' }
     RubyParser.template(templates) unless templates.empty?
@@ -142,11 +140,11 @@ class PuppetCheck
     jsons, files = files.partition { |file| File.extname(file) == '.json' }
     DataParser.json(jsons) unless jsons.empty?
     # check eyaml data; block this for now
-    # eyamls, files = files.partition { |file| File.extname(file) =~ /\.eya?ml$/ }
-    # DataParser.eyaml(eyamls, public, private) unless eyamls.empty?
+    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$/ }
-    RubyParser.librarian(librarians, settings[:style], settings[:rubocop_args]) unless librarians.empty?
+    RubyParser.librarian(librarians, style, rubocop_args) unless librarians.empty?
     # ignore everything else
     files.each { |file| self.class.files[:ignored].push(file.to_s) }
     # return PuppetCheck.files to mitigate singleton write accessor side effects

data/spec/octocatalog-diff/octocatalog_diff.cfg.rb

@@ -9,11 +9,7 @@ module OctocatalogDiff
       settings[:hiera_config] = "#{octocatalog_diff_dir}hiera.yaml"
       settings[:hiera_path] = "#{octocatalog_diff_dir}hieradata"
       settings[:fact_file] = "#{octocatalog_diff_dir}facts.yaml"
-      settings[:puppet_binary] = if ENV['TRAVIS'] == 'true'
-                                   "#{octocatalog_diff_dir}../../bin/puppet"
-                                 else
-                                   '/usr/local/bin/puppet'
-                                 end
+      settings[:puppet_binary] = '/usr/local/bin/puppet'
       settings[:bootstrapped_to_dir] = octocatalog_diff_dir
 
       settings

data/spec/puppet-check/data_parser_spec.rb

@@ -45,23 +45,24 @@ describe DataParser do
       expect { DataParser.eyaml(['foo.eyaml'], 'public.pem', 'private.pem') }.to output("Specified Public X509 and/or Private RSA PKCS7 certs do not exist. EYAML checks will not be executed.\n").to_stderr
     end
     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][0]).to match(%r{^#{fixtures_dir}hieradata/syntax.eyaml:\nblock sequence entries are not allowed})
+      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[:warnings]).to eql({})
       expect(PuppetCheck.files[:clean]).to eql([])
     end
     it 'puts a good eyaml file with potential hiera issues in the warning files array' do
-      # DataParser.eyaml(["#{fixtures_dir}hieradata/style.eyaml'], fixtures_dir + 'keys/public_key.pkcs7.pem', fixtures_dir + 'keys/private_key.pkcs7.pem")
+      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"]).to match(%r{^Value\(s\) missing in key.*\nValue\(s\) missing in key.*\nThe string --- appears more than once in this data and Hiera will fail to parse it correctly})
+      expect(PuppetCheck.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[:clean]).to eql([])
     end
     it 'puts a good eyaml file in the clean files array' do
-      # DataParser.eyaml(["#{fixtures_dir}hieradata/good.eyaml'], fixtures_dir + 'keys/public_key.pkcs7.pem', fixtures_dir + 'keys/private_key.pkcs7.pem")
+      DataParser.eyaml(["#{fixtures_dir}hieradata/good.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]).to eql({})
-      # expect(PuppetCheck.files[:clean]).to eql(["#{fixtures_dir}hieradata/good.eyaml"])
+      expect(PuppetCheck.files[:clean]).to eql(["#{fixtures_dir}hieradata/good.eyaml"])
     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").to_stdout
+      expect { OutputResults.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("\n\033[33mThe following files have warnings:\033[0m\n-- foo:\ni had a warning\n").to_stdout
+      expect { OutputResults.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("\n\033[32mThe following files have no errors or warnings:\033[0m\n-- foo\n").to_stdout
+      expect { OutputResults.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("\n\033[36mThe following files have unrecognized formats and therefore were not processed:\033[0m\n-- foo\n").to_stdout
+      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
     end
   end
 

data/spec/puppet-check/regression_check_spec.rb

@@ -17,7 +17,7 @@ describe RegressionCheck do
 
   context '.smoke' do
     # octocatalog-diff is returning a blank error for these tests
-    unless ENV['TRAVIS'] == 'true' || ENV['CIRCLECI'] == 'true' || ENV['GITHUB_ACTIONS'] == 'true'
+    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

data/spec/puppet-check/rspec_puppet_support_spec.rb

@@ -14,11 +14,8 @@ describe RSpecPuppetSupport do
     before(:each) { Dir.chdir(fixtures_dir) }
 
     it 'creates missing directories, missing site.pp, missing symlinks, and a missing spec_helper' do
-      # travis ci
-      if ENV['TRAVIS'] == 'true'
-        expect { rspec_puppet_setup }.to output("puppetlabs/gruntmaster has an unspecified, or specified but unsupported, download method.\n").to_stderr
       # circle ci and gh actions
-      elsif ENV['CIRCLECI'] == 'true' || ENV['GITHUB_ACTIONS'] == 'true'
+      if ENV['CIRCLECI'] == 'true' || ENV['GITHUB_ACTIONS'] == 'true'
         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

data/spec/puppet_check_spec.rb

@@ -87,7 +87,11 @@ describe PuppetCheck do
 
     it 'correctly parses one directory and returns all of its files' do
       dir.each { |file| expect(File.file?(file)).to be true }
-      expect(dir.length).to eql(37)
+      if ENV['CIRCLECI'] == 'true' || ENV['GITHUB_ACTIONS'] == 'true'
+        expect(dir.length).to eql(37)
+      else
+        expect(dir.length).to eql(40)
+      end
     end
 
     it 'correctly parses multiple directories and returns all of their files' do

data/spec/system/system_spec.rb

@@ -6,10 +6,10 @@ 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['TRAVIS'] == 'true' || 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 .]) }
+    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 --smoke -n good.example.com --octoconfig spec/octocatalog-diff/octocatalog-diff.cfg.rb .]) }
+      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
@@ -17,10 +17,10 @@ describe PuppetCheck do
 
       expect { cli }.not_to raise_exception
 
-      expect(PuppetCheck.files[:errors].length).to eql(10)
-      expect(PuppetCheck.files[:warnings].length).to eql(11)
-      expect(PuppetCheck.files[:clean].length).to eql(13)
-      expect(PuppetCheck.files[:ignored].length).to eql(6)
+      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)
 
       expect(cli).to eql(2)
     end
@@ -40,7 +40,7 @@ describe PuppetCheck do
       }
       settings = { style: true }
       # see regression_check_spec
-      unless ENV['TRAVIS'] == 'true' || ENV['CIRCLECI'] == 'true' || ENV['GITHUB_ACTIONS'] == 'true'
+      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'
@@ -50,10 +50,10 @@ describe PuppetCheck do
       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(10)
-      # expect(PuppetCheck.files[:warnings].length).to eql(11)
-      # expect(PuppetCheck.files[:clean].length).to eql(13)
-      # expect(PuppetCheck.files[:ignored].length).to eql(6)
+      # 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.2.2
+  version: 2.3.0
 platform: ruby
 authors:
 - Matt Schuchard
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-27 00:00:00.000000000 Z
+date: 2024-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet
@@ -19,7 +19,7 @@ dependencies:
         version: '5.5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,27 +29,21 @@ dependencies:
         version: '5.5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: puppet-lint
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.0'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.0'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: reek
   requirement: !ruby/object:Gem::Requirement
@@ -226,7 +220,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="