puppet-check 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a111d0def6afe05d7924d10fe26d46a3c50eef1f
-  data.tar.gz: 17202cf67cac1fae5700d2c332a2c432b753e8a2
+  metadata.gz: 6f163a7745155d25678269090a38458154b83f78
+  data.tar.gz: 916d7c176c97f75f138e9fe5dc3506c51ecdf197
 SHA512:
-  metadata.gz: 86af9837fa801c6b5ace0af98e86d3d999f21adfd627eaa4231606f97835655962e485dda91d6312442934718ab53a10d9dc378f391fb7b41a3ccb0931dc8b3a
-  data.tar.gz: 105522b9b0bc64afbdcafdcc7124b9db9cb0455c8b57d37808080b59a29b423459e6eb0c1c4445419258fd5f89af7c23352f02c786daca8a786f22c85e1d1f71
+  metadata.gz: 30666a5147dbfc9e369c969ed774a7dc056c69ee0489573009fa0c32ef96ac0b6afbb37a40926f7d7471a69f09c6a0e2c663de4418fb896466862c698117c0e8
+  data.tar.gz: 9dc6066fe7e26bdb43c89602de6fc4f4d2644696856d57ab7f37322b6280e4539cd1397a431770e27cb2992e7131e8172d18dd31bedc127e85dcbadee1579042

data/CHANGELOG.md

@@ -8,21 +8,22 @@
 - rspec puppet stubbing (minor)
 - parallel spec option (minor)
 - multiple node testing with octocatalog-diff (minor)
-
-### 1.4.1 (Roadmap)
-- rakefile interface with puppet-lint, rubocop, reek (patch)
 - split syntax and style checks to separate methods for style (patch)
-- change settings to hash (patch)
-- add in begin/rescue on rspec, octocatalog, and rake loading (patch)
-- svn support for module fixtures (patch)
-- fail on warnings option + change exit code logic/possibilities (patch)
-- look into partition for execute_parsers optimization (patch)
-- handle octocatalog-diff not installed situation better (patch)
+- missing puppet binary error changed
+- puppet 5
+- try closing the template to deal with the erb binding issue
+
+### 1.4.1
+- Support for using SVN to download external module dependencies for RSpec Puppet.
+- Better handled situations with uninstalled optional dependencies.
+- Code cleanup and optimization.
+- Added option to fail on warnings.
+- Added additional error info for failed smoke checks.
 
 ### 1.4.0
 - Optimized and fixed checks on dependencies and requirements in `metadata.json`.
-- Optional octocatalog-diff smoke testing
-- Optional octocatalog-diff config file support
+- Optional octocatalog-diff smoke testing.
+- Optional octocatalog-diff config file support.
 
 ### 1.3.2
 - For the Puppet Forge method of downloading external module dependencies as spec fixtures, the module is now updated if it is already present. Previously, a fresh forced install was always attempted.

data/README.md

@@ -129,6 +129,7 @@ The following files have unrecognized formats and therefore were not processed:
 - Puppetlabs Spec Helper requires an additional config file for RSpec Puppet support.
 - Puppetlabs Spec Helper does not update external module dependencies in a stateful/persistent workspace and fails gracefully instead.
 - Puppetlabs Spec Helper requires extra configuration items to setup self-module RSpec testing.
+- Puppetlabs Spec Helper does not frontend to Octocatalog Diff.
 
 It is worth nothing that there is no current development objective for Puppet Check to achieve the same advanced level of robustness for spec testing that Puppetlabs Spec Helper enables. If you are performing standard spec testing on your Puppet code and data, then Puppet Check's spec testing is a fantastic lighter and faster alternative to Puppetlabs Spec Helper. If you require advanced and intricate capabilities in your spec testing (e.g. direct interfacing to the `Puppet::Parser::Scope` API), then you will likely prefer Puppetlabs Spec Helper's spec testing in conjunction with Puppet Check's file validation.
 
@@ -141,15 +142,17 @@ Reek dropped support for Ruby 2.0 when it went to 4.0. Since dependencies by Rub
 ### CLI
 ```
 usage: puppet-check [options] paths
+        --version                    Display the current version.
     -f, --future                     Enable future parser
+        --fail-on-warnings           Fail on warnings
     -s, --style                      Enable style checks
-    --smoke                          Enable smoke testing
+        --smoke                      Enable smoke testing
     -r, --regression                 Enable regression testing (in progress, do not use)
     -o, --output format              Format for results output (default is text): text, json, or yaml
-    --octoconfig config_file         Octocatalog-diff configuration file to use.
-    -n, --octonodes node1.example.com,node2.example.com
-                                     Octocatalog-diff nodes to test catalog on.
-    --puppet-lint arg_one,arg_two
+        --octoconfig config_file     Octocatalog-diff configuration file to use.
+    -n node1.example.com,node2.example.com,
+        --octonodes                  Octocatalog-diff nodes to test catalog on.
+        --puppet-lint arg_one,arg_two
                                      Arguments for PuppetLint ignored checks
     -c, --config file                Load PuppetLint options from file.
         --rubocop arg_one,arg_two    Arguments for Rubocop disabled cops
@@ -176,13 +179,16 @@ rake puppetcheck:beaker    # Execute Beaker acceptance tests
 You can add style, smoke, and regression checks to and select the future parser for the `rake puppetcheck:file`, or change the output format, by adding the following after the require:
 
 ```ruby
-PuppetCheck.style_check = true
-PuppetCheck.future_parser = true
-PuppetCheck.smoke_check = true
-PuppetCheck.regression_check = true # in progress, do not use
-PuppetCheck.output_format = 'yaml'
-PuppetCheck.octoconfig = '.octocatalog-diff.cfg.rb'
-PuppetCheck.octonodes = %w(localhost.localdomain)
+PuppetCheck.settings[:style_check] = true
+PuppetCheck.settings[:fail_on_warnings] = true
+PuppetCheck.settings[:future_parser] = true
+PuppetCheck.settings[:smoke_check] = true
+PuppetCheck.settings[:regression_check] = true # in progress, do not use
+PuppetCheck.settings[:output_format] = 'yaml'
+PuppetCheck.settings[:octoconfig] = '.octocatalog-diff.cfg.rb'
+PuppetCheck.settings[:octonodes] = %w(localhost.localdomain)
+PuppetCheck.settings[:puppetlint_args] = ['--puppetlint-arg-one', '--puppetlint-arg-two']
+PuppetCheck.settings[:rubocop_args] = ['--except', 'rubocop-arg-one,rubocop-arg-two']
 ```
 
 Please note that `rspec` does not support yaml output and therefore would still use the default 'progress' formatter even if `yaml` is specified as the format option to Puppet Check.
@@ -196,7 +202,7 @@ Please note it is perfectly acceptable to only execute standard RSpec tests in y
 
 Prior to executing the spec tests, Puppet Check will parse everything in the current path and identify all `spec` directories not within `fixtures` directories. It will then execute RSpec Puppet setup actions inside all directories one level above that contain a `manifests` directory. This is assumed to be a Puppet module directory. These setup actions include creating all of the necessary directories inside of `spec/fixtures`, creating a blank `site.pp` if it is missing, symlinking everything from the module that is needed into fixtures (automatically replaces functionality of self module symlink in `.fixtures.yaml` from Puppetlabs Spec Helper), and creates the `spec_helper.rb` if it is missing. Note these setup actions can replace `rspec-puppet-init` from RSpec Puppet and currently are both faster and more accurate.
 
-Puppet Check will also automatically download specified external module dependencies for and during RSpec Puppet testing. Currently `git`, `puppet forge`, and `hg` commands are supported. They can be implemented in the following way in your modules' `metadata.json`:
+Puppet Check will also automatically download specified external module dependencies for and during RSpec Puppet testing. Currently `git`, `puppet forge`, `svn`, and `hg` commands are supported. They can be implemented in the following way in your modules' `metadata.json`:
 
 ```json
 "dependencies": [
@@ -214,6 +220,11 @@ Puppet Check will also automatically download specified external module dependen
     "name": "module-name",
     "hg": "hg-url",
     "args": "hg clone optional-arguments"
+  },
+  {
+    "name": "module-name",
+    "svn": "svn-url",
+    "args": "svn co optional arguments"
   }
 ]
 ```
@@ -234,7 +245,7 @@ Example:
 ]
 ```
 
-Note that `args` will be ignored during `git pull` and `hg pull/hg update` when the modules are updated instead of freshly cloned.
+Note that `args` will be ignored during `git pull`, 'svn update', and `hg pull/hg update` when the modules are updated instead of freshly cloned.
 
 #### puppetcheck:beaker
 The spec tests will be executed against everything that matches the pattern `**/acceptance`. Any of these directories inside of a `fixtures` directory will be ignored. This means everything in the current path that appears to be a Puppet module acceptance test for your module (not dependencies) will be regarded as such and executed during this rake task.
@@ -249,15 +260,16 @@ If you are performing your Puppet testing from within a Ruby script or your own
 # file checks
 require 'puppet-check'
 
-PuppetCheck.future_parser = true # default false
-PuppetCheck.style_check = true # default false
-PuppetCheck.smoke_check = true # default false
-PuppetCheck.regression_check = true # in progress, do not use; default false
-PuppetCheck.output_format = 'yaml' # also 'json'; default 'text'
-PuppetCheck.octoconfig = '$HOME/octocatalog-diff.cfg.rb' # default '.octocatalog-diff.cfg.rb'
-PuppetCheck.octonodes = %w(server.example.com) # default: %w(localhost.localdomain)
-PuppetCheck.puppetlint_args = ['--puppetlint-arg-one', '--puppetlint-arg-two'] # default []
-PuppetCheck.rubocop_args = ['--except', 'rubocop-arg-one,rubocop-arg-two'] # default []
+PuppetCheck.settings[:future_parser] = true # default false
+PuppetCheck.settings[:fail_on_warnings] = true # default false
+PuppetCheck.settings[:style_check] = true # default false
+PuppetCheck.settings[:smoke_check] = true # default false
+PuppetCheck.settings[:regression_check] = true # in progress, do not use; default false
+PuppetCheck.settings[:output_format] = 'yaml' # also 'json'; default 'text'
+PuppetCheck.settings[:octoconfig] = '$HOME/octocatalog-diff.cfg.rb' # default '.octocatalog-diff.cfg.rb'
+PuppetCheck.settings[:octonodes] = %w(server.example.com) # default: %w(localhost.localdomain)
+PuppetCheck.settings[:puppetlint_args] = ['--puppetlint-arg-one', '--puppetlint-arg-two'] # default []
+PuppetCheck.settings[:rubocop_args] = ['--except', 'rubocop-arg-one,rubocop-arg-two'] # default []
 
 PuppetCheck.new.run([dirs, files])
 
@@ -318,9 +330,9 @@ end
 To overcome the lack of convenient portability, you could try spinning up the Vagrant instance at the top level of your Puppet code and data and then descend into directories to execute tests as necessary. Cleverness or patience will be necessary if you decide to use Vagrant for testing and desire portability.
 
 ### Exit Codes
-- 0: PuppetCheck exited with no internal exceptions or errors in your Puppet code and data.
-- 1: PuppetCheck exited with an internal exception (takes preference over other non-zero exit codes) or failed spec test.
-- 2: PuppetCheck exited with one or more errors in your Puppet code and data.
+- 0: PuppetCheck exited with no internal exceptions or errors in your code and data.
+- 1: PuppetCheck exited with an internal exception (takes preference over other non-zero exit codes) or failed spec test(s).
+- 2: PuppetCheck exited with one or more errors in your code and data. Alternatively, PuppetCheck exited with one or more warnings in your code and data and you specified to fail on warnings.
 
 ### Optional dependencies
 - **rake**: install this if you want to use Puppet Check with `rake` tasks in addition to the CLI.

data/lib/puppet-check.rb

@@ -2,39 +2,39 @@ require_relative 'puppet-check/puppet_parser'
 require_relative 'puppet-check/ruby_parser'
 require_relative 'puppet-check/data_parser'
 require_relative 'puppet-check/output_results'
-begin
-  require_relative 'puppet-check/regression_check'
-rescue LoadError
-end
 
 # interfaces from CLI/tasks and to individual parsers
 class PuppetCheck
-  # initialize future parser, style check, and regression check bools
-  @future_parser = false
-  @style_check = false
-  @smoke_check = false
-  @regression_check = false
+  # initialize settings hash
+  @settings = {}
+
+  # initialize future parser, fail on warning,  style check, and regression check bools
+  @settings[:future_parser] = false
+  @settings[:fail_on_warning] = false
+  @settings[:style_check] = false
+  @settings[:smoke_check] = false
+  @settings[:regression_check] = false
 
   # initialize output format option
-  @output_format = 'text'
+  @settings[:output_format] = 'text'
 
   # initialize octocatalog-diff options
-  @octoconfig = '.octocatalog-diff.cfg.rb'
-  @octonodes = %w(localhost.localdomain)
+  @settings[:octoconfig] = '.octocatalog-diff.cfg.rb'
+  @settings[:octonodes] = %w[localhost.localdomain]
 
   # initialize diagnostic output arrays
-  @error_files = []
-  @warning_files = []
-  @clean_files = []
-  @ignored_files = []
+  @settings[:error_files] = []
+  @settings[:warning_files] = []
+  @settings[:clean_files] = []
+  @settings[:ignored_files] = []
 
   # initialize style arg arrays
-  @puppetlint_args = []
-  @rubocop_args = []
+  @settings[:puppetlint_args] = []
+  @settings[:rubocop_args] = []
 
   # allow the parser methods read user options and append to the file arrays; allow CLI and tasks write to user options
   class << self
-    attr_accessor :future_parser, :style_check, :smoke_check, :regression_check, :output_format, :octoconfig, :octonodes, :error_files, :warning_files, :clean_files, :ignored_files, :puppetlint_args, :rubocop_args
+    attr_accessor :settings
   end
 
   # main runner for PuppetCheck
@@ -43,23 +43,37 @@ class PuppetCheck
     files = self.class.parse_paths(paths)
 
     # parse the files
-    execute_parsers(files, self.class.future_parser, self.class.style_check, self.class.puppetlint_args, self.class.rubocop_args)
+    execute_parsers(files, self.class.settings[:future_parser], self.class.settings[:style_check], self.class.settings[:puppetlint_args], self.class.settings[:rubocop_args])
 
     # output the diagnostic results
-    PuppetCheck.output_format == 'text' ? OutputResults.text : OutputResults.markup
+    PuppetCheck.settings[:output_format] == 'text' ? OutputResults.text : OutputResults.markup
+
+    if self.class.settings[:error_files].empty? && (!self.class.settings[:fail_on_warning] || self.class.settings[:warning_files].empty?)
+      begin
+        require_relative 'puppet-check/regression_check'
+      rescue LoadError
+      end
 
-    if self.class.error_files.empty?
       # perform smoke checks if there were no errors and the user desires
       begin
-        RegressionCheck.smoke(self.class.octonodes, self.class.octoconfig) if PuppetCheck.smoke_check
+        catalog = RegressionCheck.smoke(self.class.octonodes, self.class.octoconfig) if PuppetCheck.settings[:smoke_check]
       # smoke check failure? output message and return 2
       rescue OctocatalogDiff::Errors::CatalogError => err
         puts 'There was a smoke check error:'
         puts err
+        puts catalog.error_message unless catalog.valid?
         2
       end
       # perform regression checks if there were no errors and the user desires
-      # RegressionCheck.regression(self.class.octonodes, self.class.octoconfig) if PuppetCheck.regression_check
+      # begin
+      #   catalog = RegressionCheck.regression(self.class.octonodes, self.class.octoconfig) if PuppetCheck.settings[:regression_check]
+      # rescue OctocatalogDiff::Errors::CatalogError => err
+      #   puts 'There was a catalog compilation error during the regression check:'
+      #   puts err
+      #   puts catalog.error_message unless catalog.valid?
+      #   2
+      # end
+      # code to output differences in catalog?
       # everything passed? return 0
       0
     else
@@ -91,20 +105,20 @@ class PuppetCheck
 
   # categorize and pass the files out to the parsers to determine their status
   def execute_parsers(files, future, style, pl_args, rc_args)
-    PuppetParser.manifest(files.select { |file| File.extname(file) == '.pp' }, future, style, pl_args)
-    files.reject! { |file| File.extname(file) == '.pp' }
-    PuppetParser.template(files.select { |file| File.extname(file) == '.epp' })
-    files.reject! { |file| File.extname(file) == '.epp' }
-    RubyParser.ruby(files.select { |file| File.extname(file) == '.rb' }, style, rc_args)
-    files.reject! { |file| File.extname(file) == '.rb' }
-    RubyParser.template(files.select { |file| File.extname(file) == '.erb' })
-    files.reject! { |file| File.extname(file) == '.erb' }
-    DataParser.yaml(files.select { |file| File.extname(file) =~ /\.ya?ml$/ })
-    files.reject! { |file| File.extname(file) =~ /\.ya?ml$/ }
-    DataParser.json(files.select { |file| File.extname(file) == '.json' })
-    files.reject! { |file| File.extname(file) == '.json' }
-    RubyParser.librarian(files.select { |file| File.basename(file) =~ /(?:Puppet|Module|Rake|Gem)file$/ }, style, rc_args)
-    files.reject! { |file| File.basename(file) =~ /(?:Puppet|Module|Rake|Gem)file$/ }
-    files.each { |file| self.class.ignored_files.push(file.to_s) }
+    manifests, files = files.partition { |file| File.extname(file) == '.pp' }
+    PuppetParser.manifest(manifests, future, style, pl_args)
+    templates, files = files.partition { |file| File.extname(file) == '.epp' }
+    PuppetParser.template(templates)
+    rubies, files = files.partition { |file| File.extname(file) == '.rb' }
+    RubyParser.ruby(rubies, style, rc_args)
+    templates, files = files.partition { |file| File.extname(file) == '.erb' }
+    RubyParser.template(templates)
+    yamls, files = files.partition { |file| File.extname(file) =~ /\.ya?ml$/ }
+    DataParser.yaml(yamls)
+    jsons, files = files.partition { |file| File.extname(file) == '.json' }
+    DataParser.json(jsons)
+    librarians, files = files.partition { |file| File.basename(file) =~ /(?:Puppet|Module|Rake|Gem)file$/ }
+    RubyParser.librarian(librarians, style, rc_args)
+    files.each { |file| self.class.settings[:ignored_files].push(file.to_s) }
   end
 end

data/lib/puppet-check/cli.rb

@@ -21,31 +21,32 @@ class PuppetCheck::CLI
 
       # base options
       opts.on('--version', 'Display the current version.') do
-        puts 'puppet-check 1.4.0'
+        puts 'puppet-check 1.4.1'
         exit 0
       end
 
       # bool options
-      opts.on('-f', '--future', 'Enable future parser') { PuppetCheck.future_parser = true }
-      opts.on('-s', '--style', 'Enable style checks') { PuppetCheck.style_check = true }
-      opts.on('--smoke', 'Enable smoke testing') { PuppetCheck.smoke_check = true }
-      opts.on('-r', '--regression', 'Enable regression testing (in progress, do not use)') { PuppetCheck.regression_check = true }
+      opts.on('-f', '--future', 'Enable future parser') { PuppetCheck.settings[:future_parser] = true }
+      opts.on('--fail-on-warnings', 'Fail on warnings') { PuppetCheck.settings[:fail_on_warnings] = true }
+      opts.on('-s', '--style', 'Enable style checks') { PuppetCheck.settings[:style_check] = true }
+      opts.on('--smoke', 'Enable smoke testing') { PuppetCheck.settings[:smoke_check] = true }
+      opts.on('-r', '--regression', 'Enable regression testing (in progress, do not use)') { PuppetCheck.settings[:regression_check] = true }
 
       # formatting options
-      opts.on('-o', '--output format', String, 'Format for results output (default is text): text, json, or yaml') { |arg| PuppetCheck.output_format = arg }
+      opts.on('-o', '--output format', String, 'Format for results output (default is text): text, json, or yaml') { |arg| PuppetCheck.settings[:output_format] = arg }
 
       # octocatalog-diff options
-      opts.on('--octoconfig config_file', String, 'Octocatalog-diff configuration file to use.') { |arg| PuppetCheck.octoconfig = arg }
-      opts.on('-n', '--octonodes node1.example.com,node2.example.com', Array, 'Octocatalog-diff nodes to test catalog on.') { |arg| PuppetCheck.octonodes = arg }
+      opts.on('--octoconfig config_file', String, 'Octocatalog-diff configuration file to use.') { |arg| PuppetCheck.settings[:octoconfig] = arg }
+      opts.on('-n', '--octonodes node1.example.com,node2.example.com', Array, 'Octocatalog-diff nodes to test catalog on.') { |arg| PuppetCheck.settings[:octonodes] = arg }
 
       # arguments to style checkers
       opts.on('--puppet-lint arg_one,arg_two', Array, 'Arguments for PuppetLint ignored checks') do |puppetlint_args|
-        PuppetCheck.puppetlint_args += puppetlint_args.map { |arg| "--#{arg}" }
+        PuppetCheck.settings[:puppetlint_args] += puppetlint_args.map { |arg| "--#{arg}" }
       end
       opts.on('-c', '--config file', String, 'Load PuppetLint options from file.') do |file|
-        PuppetCheck.puppetlint_args += File.read(file).split("\n")
+        PuppetCheck.settings[:puppetlint_args] += File.read(file).split("\n")
       end
-      opts.on('--rubocop arg_one,arg_two', String, 'Arguments for Rubocop disabled cops') { |arg| PuppetCheck.rubocop_args = ['--except', arg] }
+      opts.on('--rubocop arg_one,arg_two', String, 'Arguments for Rubocop disabled cops') { |arg| PuppetCheck.settings[:rubocop_args] = ['--except', arg] }
     end
 
     opt_parser.parse!(args)

data/lib/puppet-check/data_parser.rb

@@ -11,7 +11,7 @@ class DataParser
       begin
         parsed = YAML.load_file(file)
       rescue StandardError => err
-        PuppetCheck.error_files.push("#{file}:\n#{err.to_s.gsub("(#{file}): ", '')}")
+        PuppetCheck.settings[:error_files].push("#{file}:\n#{err.to_s.gsub("(#{file}): ", '')}")
       else
         warnings = []
 
@@ -21,8 +21,8 @@ class DataParser
         # check that '---' does not show up more than once in the hieradata
         warnings.push('The string --- appears more than once in this data and Hiera will fail to parse it correctly.') if File.read(file).scan(/---/).count >= 2
 
-        next PuppetCheck.warning_files.push("#{file}:\n#{warnings.join("\n")}") unless warnings.empty?
-        PuppetCheck.clean_files.push(file.to_s)
+        next PuppetCheck.settings[:warning_files].push("#{file}:\n#{warnings.join("\n")}") unless warnings.empty?
+        PuppetCheck.settings[:clean_files].push(file.to_s)
       end
     end
   end
@@ -36,7 +36,7 @@ class DataParser
       begin
         parsed = JSON.parse(File.read(file))
       rescue JSON::ParserError => err
-        PuppetCheck.error_files.push("#{file}:\n#{err.to_s.lines.first.strip}")
+        PuppetCheck.settings[:error_files].push("#{file}:\n#{err.to_s.lines.first.strip}")
       else
         warnings = []
 
@@ -49,12 +49,12 @@ class DataParser
           errors = []
 
           # check for required keys
-          %w(name version author license summary source dependencies).each do |key|
+          %w[name version author license summary source dependencies].each do |key|
             errors.push("Required field '#{key}' not found.") unless parsed.key?(key)
           end
 
           # check requirements and dependencies keys
-          %w(requirements dependencies).each do |key|
+          %w[requirements dependencies].each do |key|
             # skip if key is missing or or value is an empty string, array, or hash
             next unless parsed.key?(key)
             next if parsed[key].empty?
@@ -84,14 +84,14 @@ class DataParser
           end
 
           # check for deprecated fields
-          %w(types checksum).each do |key|
+          %w[types checksum].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
 
-          next PuppetCheck.error_files.push("#{file}:\n#{errors.join("\n")}") unless errors.empty?
+          next PuppetCheck.settings[:error_files].push("#{file}:\n#{errors.join("\n")}") unless errors.empty?
 
           # check for warnings
           # check for operatingsystem_support hash array
@@ -128,8 +128,8 @@ class DataParser
           # perform some rudimentary hiera checks if data exists
           warnings = hiera(parsed) unless parsed.class.to_s == 'NilClass'
         end
-        next PuppetCheck.warning_files.push("#{file}:\n#{warnings.join("\n")}") unless warnings.empty?
-        PuppetCheck.clean_files.push(file.to_s)
+        next PuppetCheck.settings[:warning_files].push("#{file}:\n#{warnings.join("\n")}") unless warnings.empty?
+        PuppetCheck.settings[:clean_files].push(file.to_s)
       end
     end
   end

data/lib/puppet-check/output_results.rb

@@ -4,41 +4,41 @@ require_relative '../puppet-check'
 class OutputResults
   # output the results as text
   def self.text
-    unless PuppetCheck.error_files.empty?
+    unless PuppetCheck.settings[:error_files].empty?
       print "\033[31mThe following files have errors:\033[0m\n-- "
-      puts PuppetCheck.error_files.join("\n\n-- ")
+      puts PuppetCheck.settings[:error_files].join("\n\n-- ")
     end
-    unless PuppetCheck.warning_files.empty?
+    unless PuppetCheck.settings[:warning_files].empty?
       print "\n\033[33mThe following files have warnings:\033[0m\n-- "
-      puts PuppetCheck.warning_files.join("\n\n-- ")
+      puts PuppetCheck.settings[:warning_files].join("\n\n-- ")
     end
-    unless PuppetCheck.clean_files.empty?
+    unless PuppetCheck.settings[:clean_files].empty?
       print "\n\033[32mThe following files have no errors or warnings:\033[0m\n-- "
-      puts PuppetCheck.clean_files.join("\n-- ")
+      puts PuppetCheck.settings[:clean_files].join("\n-- ")
     end
-    return if PuppetCheck.ignored_files.empty?
+    return if PuppetCheck.settings[:ignored_files].empty?
     print "\n\033[36mThe following files have unrecognized formats and therefore were not processed:\033[0m\n-- "
-    puts PuppetCheck.ignored_files.join("\n-- ")
+    puts PuppetCheck.settings[:ignored_files].join("\n-- ")
   end
 
   # output the results as yaml or json
   def self.markup
     # generate output hash
     hash = {}
-    hash['errors'] = PuppetCheck.error_files unless PuppetCheck.error_files.empty?
-    hash['warnings'] = PuppetCheck.warning_files unless PuppetCheck.warning_files.empty?
-    hash['clean'] = PuppetCheck.clean_files unless PuppetCheck.clean_files.empty?
-    hash['ignored'] = PuppetCheck.ignored_files unless PuppetCheck.ignored_files.empty?
+    hash['errors'] = PuppetCheck.settings[:error_files] unless PuppetCheck.settings[:error_files].empty?
+    hash['warnings'] = PuppetCheck.settings[:warning_files] unless PuppetCheck.settings[:warning_files].empty?
+    hash['clean'] = PuppetCheck.settings[:clean_files] unless PuppetCheck.settings[:clean_files].empty?
+    hash['ignored'] = PuppetCheck.settings[:ignored_files] unless PuppetCheck.settings[:ignored_files].empty?
 
     # convert hash to markup language
-    if PuppetCheck.output_format == 'yaml'
+    if PuppetCheck.settings[:output_format] == 'yaml'
       require 'yaml'
       puts Psych.dump(hash, indentation: 2)
-    elsif PuppetCheck.output_format == 'json'
+    elsif PuppetCheck.settings[:output_format] == 'json'
       require 'json'
       puts JSON.pretty_generate(hash)
     else
-      raise "puppet-check: Unsupported output format '#{PuppetCheck.output_format}' was specified."
+      raise "puppet-check: Unsupported output format '#{PuppetCheck.settings[:output_format]}' was specified."
     end
   end
 end