puppet-check 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d2defe55b01e90b73fc2cb3dfc12b9004fbe02b73fc751b736529e454c0c92b
-  data.tar.gz: 96bce3d495f0a5778d5475659ba3fbf6360290ef565666478933cd867babc34d
+  metadata.gz: b1e591abda5a49b0731073d14831000016b08d72b505ab3d22a287029fa1243f
+  data.tar.gz: 96bceb6ef51e82582984ab0c88f96591d30c26650e174a0215133af0723c9526
 SHA512:
-  metadata.gz: 52037386f7f9168822a8cc14da2455d3a6a2f38cc3686ef7edbed65bee382a07159328c9ca3e1472c97d533e0966b431b921d78380bec684489e7528ec443694
-  data.tar.gz: 859c21981164a0e002c6e8faeec55b285aa65d7cd953b838415873d482f7a32acf4ede39049329eb9435f435a7a96b741749a7501e1a0cfd045c43444f5cbc94
+  metadata.gz: 805ef299109715901160e9f4c4894ff05f31140c8234ed867273434e85b525e4c91e0e5fd7e6f96fb23352a3b801afa006b31cb4a93515c76182725b510a57f8
+  data.tar.gz: 2fc8340befd7b6c5f9662038aeea6614858ed1a2bd92f0d76c797fe42b316fed9d080e38cd8f4203d16240c365086bc1165c89102f3ee4e496dae6f1cf75b9bd

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+### 2.2.0
+- Add Enable Pending Cops to base RuboCop configuration.
+- Support checking plans.
+- Fix Puppet >= 6.5 error message capture when line/col info.
+- Minimum Ruby version increased to 2.6.
+- Minimum Puppet version increased to 5.4.
+
+### 2.1.0
+- Minimum supported version of Puppet bumped to 5.0.
+- Minimum Ruby version bumped to 2.4.
+- Official support for Puppet 7, Rubocop 1, and Reek 6.
+- Fix Puppet message string transform conditionals.
+
+### 2.0.1
+- Check for existence of executables for dependency module retrieval.
+- Beta support for Puppet 7, Rubocop 1, and Reek 6.
+
 ### 2.0.0
 - Bump minimum version of Puppet to 4.0.0 and remove < 4 support code.
 - Official support for Puppet 6.

data/README.md

@@ -1,5 +1,6 @@
 # Puppet Check
-[![Build Status](https://travis-ci.org/mschuchard/puppet-check.svg?branch=master)](https://travis-ci.org/mschuchard/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)
@@ -124,8 +125,11 @@ The following files have unrecognized formats and therefore were not processed:
 ### What About Puppet Development Kit?
 The fairly recent release of the Puppet Development Kit (PDK) will hopefully eventually bring about the capability to test and validate your Puppet code and data in a streamlined, efficient, comprehensive, and accurate fashion comparable to Puppet Check. Unfortunately, the PDK has not yet achieved feature or efficiency parity with Puppet Check. The goal is for the PDK to one day replace Puppet Check and for Puppet Check to enter maintenance mode, but for now Puppet Check is still needed to lead Puppet testing.
 
+### What About PDK now?
+As of version 2.4.0 of the PDK, the PDK has essentially more or less achieved feature parity with Puppet Check. Although the PDK is not as efficient (including especially that Puppet Check executes significantly faster), it is still supported by Puppetlabs. Therefore, if you need an efficient and comprehensive Puppet validation solution, then you can still utilize Puppet Check, but the PDK is a recommended alternative for the future.
+
 ## Usage
-Please see the [Gemspec](puppet-check.gemspec) for dependency information.  All other dependencies should be fine with various versions. Puppet Check can be used with a CLI, Rake tasks, or API, from your system, rbenv, rvm, Docker, or Vagrant. Please note all interfaces (API by default, but can be modified) will ignore any directories named `fixtures` or specified paths with that directory during file checks and spec tests.
+Please see the [Gemspec](puppet-check.gemspec) for dependency information.  All other dependencies should be fine with various versions. Puppet Check can be used with a CLI, Rake tasks, or API, from your system, rbenv, rvm, Docker, or Vagrant. Please note all interfaces (API by default, but can be modified) will ignore any directories named `fixtures`, or specified paths with that directory during file checks and spec tests.
 
 ### CLI
 ```
@@ -277,45 +281,24 @@ task.pattern = Dir.glob('**/{classes,defines,facter,functions,hosts,puppet,unit,
 
 ### Docker
 
-You can also use Puppet Check inside of Docker for quick, portable, and disposable testing. Below is an example Dockerfile for this purpose:
-
-```dockerfile
-# a reliable and small container at the moment
-FROM ubuntu:18.04
-# you need ruby and any other extra dependencies that come from packages; in this example we install git to use it for downloading external module dependencies
-RUN apt-get update && apt-get install ruby git -y
-# you need puppet-check and any other extra dependencies that come from gems; in this example we install reek because the ruby ABI is 2.3 and then rspec-puppet and rake for extra testing
-RUN gem install --no-document puppet-check reek rspec-puppet rake
-# this is needed for the ruby json parser to not flip out on fresh os installs for some reason (change encoding value as necessary)
-ENV LANG en_US.UTF-8
-# create the directory for your module, directory environment, etc. and change directory into it
-WORKDIR /module_name_or_directory_environment_name
-# copy the module, directory environment, etc. contents into the corresponding directory inside the container; alternative, bind a volume mount for your module(s) into the container at runtime
-COPY / .
-# execute your tests; in this example we are executing the full suite of tests
-ENTRYPOINT ["rake", "puppetcheck"]
-```
-
-You can also build your own general container for testing various Puppet situations by removing the last three lines. You can then test each module, directory environment, etc. on top of that container by merely adding and modifying the final three lines to a Dockerfile that uses the container you built from the first four lines. This is recommended usage due to being very efficient and stable.
-
-As an alternative to copying Puppet code and data into the image for testing, it is also recommended to bind volume mount the container to the directory with your Puppet code and data.
+A supported [Docker image](https://hub.docker.com/r/matthewschuchard/puppet-check) of Puppet-Check is now available from the public Docker Hub registry. Please consult the repository documentation for further usage information.
 
 ### Vagrant
 
-As an alternative to Docker, you can also use Vagrant for quick and disposable testing, but it is not as portable as Docker for these testing purposes. Below is an example Vagrantfile for this purpose.
+As an alternative to Docker, you can also use Vagrant for quick and disposable testing, but it is not as portable as Docker for these testing purposes. Below is an example `Vagrantfile` for this purpose.
 
 ```ruby
 Vagrant.configure(2) do |config|
   # a reliable and small box at the moment
-  config.vm.box = 'fedora/26-cloud-base'
+  config.vm.box = 'fedora/35-cloud-base'
 
   config.vm.provision 'shell', inline: <<-SHELL
     # cd to '/vagrant'
     cd /vagrant
     # you need ruby and any other extra dependencies that come from packages; in this example we install git to use it for downloading external module dependencies
     sudo dnf install ruby rubygems git -y
-    # you need puppet-check and any other extra dependencies that come from gems; in this example we install reek because the ruby ABI is 2.2 and then rspec-puppet and rake for extra testing
-    sudo gem install --no-document puppet-check reek rspec-puppet rake
+    # you need puppet-check and any other extra dependencies that come from gems; in this example we install rspec-puppet and rake for extra testing
+    sudo gem install --no-document puppet-check rspec-puppet rake
     # this is needed for the ruby json parser to not flip out on fresh os installs for some reason (change encoding value as necessary)
     export LANG='en_US.UTF-8'
     # execute your tests; in this example we are executing the full suite of tests
@@ -329,7 +312,7 @@ To overcome the lack of convenient portability, you could try spinning up the Va
 ### Exit Codes
 - 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.
+- 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** (gem): install this if you want to use Puppet Check with `rake` tasks in addition to the CLI.

data/lib/puppet-check/cli.rb

@@ -1,5 +1,5 @@
 require 'optparse'
-require_relative '../puppet-check'
+require_relative '../puppet_check'
 
 # the command line interface for PuppetCheck
 class PuppetCheck::CLI
@@ -27,7 +27,7 @@ class PuppetCheck::CLI
 
       # base options
       opts.on('--version', 'Display the current version.') do
-        puts 'puppet-check 2.0.0'
+        puts 'puppet-check 2.2.0'
         exit 0
       end
 

data/lib/puppet-check/data_parser.rb

@@ -1,4 +1,4 @@
-require_relative '../puppet-check'
+require_relative '../puppet_check'
 
 # executes diagnostics on data files
 class DataParser
@@ -8,19 +8,17 @@ class DataParser
 
     files.each do |file|
       # check yaml syntax
-      begin
-        parsed = YAML.load_file(file)
-      rescue StandardError => err
-        PuppetCheck.settings[:error_files].push("#{file}:\n#{err.to_s.gsub("(#{file}): ", '')}")
-      else
-        warnings = []
+      parsed = YAML.load_file(file)
+    rescue StandardError => err
+      PuppetCheck.settings[:error_files].push("#{file}:\n#{err.to_s.gsub("(#{file}): ", '')}")
+    else
+      warnings = []
 
-        # perform some rudimentary hiera checks if data exists and is hieradata
-        warnings = hiera(parsed, file) if parsed && (File.basename(file) != 'hiera.yaml')
+      # perform some rudimentary hiera checks if data exists and is hieradata
+      warnings = hiera(parsed, file) if parsed && (File.basename(file) != 'hiera.yaml')
 
-        next PuppetCheck.settings[:warning_files].push("#{file}:\n#{warnings.join("\n")}") unless warnings.empty?
-        PuppetCheck.settings[:clean_files].push(file.to_s)
-      end
+      next PuppetCheck.settings[:warning_files].push("#{file}:\n#{warnings.join("\n")}") unless warnings.empty?
+      PuppetCheck.settings[:clean_files].push(file.to_s)
     end
   end
 
@@ -118,8 +116,8 @@ class DataParser
               next warnings.push("'#{req_dep['name']}' is missing an upper bound.") unless req_dep['version_requirement'].include?('<')
 
               # check for semantic versioning
-              if key == 'dependencies'
-                warnings.push("'#{req_dep['name']}' has non-semantic versioning in its 'version_requirement' key.") unless req_dep['version_requirement'] =~ /\d+\.\d+\.\d+.*\d+\.\d+\.\d+/
+              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
@@ -177,16 +175,16 @@ class DataParser
             end
           end
           # check that parameters is a hash
-          if parsed.key?('parameters')
-            warnings.push('parameters value is not a Hash') unless parsed['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')
-            warnings.push('puppet_task_version value is not an Integer') unless parsed['puppet_task_version'].is_a?(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')
-            warnings.push('supports_noop value is not a Boolean') unless parsed['supports_noop'].is_a?(TrueClass) || parsed['supports_noop'].is_a?(FalseClass)
+          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
@@ -205,7 +203,7 @@ class DataParser
     warnings = []
 
     # disregard nil/undef value data check if default values (common)
-    unless file =~ /^common/
+    unless /^common/.match?(file)
       data.each do |key, value|
         # check for nil values in the data (nil keys are fine)
         if (value.is_a?(Hash) && value.values.any?(&:nil?)) || value.nil?

data/lib/puppet-check/output_results.rb

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

data/lib/puppet-check/puppet_parser.rb

@@ -1,5 +1,5 @@
 require 'puppet'
-require_relative '../puppet-check'
+require_relative '../puppet_check'
 
 # executes diagnostics on puppet files
 class PuppetParser
@@ -17,35 +17,29 @@ class PuppetParser
 
       # check puppet syntax
       begin
+        # initialize message
+        message = ''
+        # specify tasks attribute for parser validation if this looks like a plan or not
+        Puppet[:tasks] = file.match?(%r{plans/\w+\.pp$}) ? true : false
         # in puppet >= 6.5 the return of this method is a hash with the error
         new_error = Puppet::Face[:parser, :current].validate(file)
         # puppet 6.5 output format is now a hash from the face api
-        if Puppet::PUPPETVERSION.to_f >= 6.5 && new_error != {}
-          next PuppetCheck.settings[:error_files].push("#{file}:\n#{new_error.values.map(&:to_s).join("\n").gsub(/ \(file: #{File.absolute_path(file)}(, |\))/, '').gsub(/Could not parse.*: /, '')}")
+        if Gem::Version.new(Puppet::PUPPETVERSION) >= Gem::Version.new('6.5.0') && new_error != {}
+          message = new_error.values.map(&:to_s).join("\n").gsub(/ \(file: #{File.absolute_path(file)}(, |\))/, '').gsub('Could not parse for environment *root*: ', '')
         end
       # this is the actual error that we need to rescue Puppet::Face from
       rescue SystemExit
         # puppet 5.4-6.4 has a new validator output format and eof errors have fake dir env info
-        if Puppet::PUPPETVERSION.to_f >= 5.4 && Puppet::PUPPETVERSION.to_f < 6.5
-          next PuppetCheck.settings[:error_files].push("#{file}:\n#{errors.map(&:to_s).join("\n").gsub(/file: #{File.absolute_path(file)}(, |\))/, '').gsub(/Could not parse.*: /, '')}")
-        # puppet 5.0-5.2 can only do one error per line and outputs fake dir env info
-        elsif Puppet::PUPPETVERSION.to_f >= 5.0 && Puppet::PUPPETVERSION.to_f < 5.3
-          next PuppetCheck.settings[:error_files].push("#{file}:\n#{errors.map(&:to_s).join("\n").gsub("#{File.absolute_path(file)}:", '').gsub(/Could not parse.*: /, '')}")
-        end
-        # puppet < 5 and 5.3 parser output style
-        next PuppetCheck.settings[:error_files].push("#{file}:\n#{errors.map(&:to_s).join("\n").gsub("#{File.absolute_path(file)}:", '')}")
+        message = errors.map(&:to_s).join("\n").gsub(/file: #{File.absolute_path(file)}(, |\))/, '').gsub(/Could not parse.*: /, '')
       end
+      # output message
+      next PuppetCheck.settings[:error_files].push("#{file}:\n#{message}") unless message.empty?
 
       # initialize warnings with output from the parser if it exists, since the output is warnings if Puppet::Face did not trigger a SystemExit
       warnings = "#{file}:"
       unless errors.empty?
-        # puppet 5.4-5.x has a new validator output format
-        warnings << if Puppet::PUPPETVERSION.to_f >= 5.4
-                      "\n#{errors.map(&:to_s).join("\n").gsub("file: #{File.absolute_path(file)}, ", '')}"
-                    # puppet <= 5.3 validator output format
-                    else
-                      "\n#{errors.map(&:to_s).join("\n").gsub("#{File.absolute_path(file)}:", '')}"
-                    end
+        # puppet >= 5.4 has a new validator output format
+        warnings << "\n#{errors.map(&:to_s).join("\n").gsub("file: #{File.absolute_path(file)}, ", '')}"
       end
       Puppet::Util::Log.close_all
 
@@ -82,14 +76,12 @@ class PuppetParser
 
     files.each do |file|
       # check puppet template syntax
-      begin
-        # credits to gds-operations/puppet-syntax for the parser function call
-        Puppet::Pops::Parser::EvaluatingParser::EvaluatingEppParser.new.parse_file(file)
-      rescue StandardError => err
-        PuppetCheck.settings[:error_files].push("#{file}:\n#{err.to_s.gsub("#{file}:", '')}")
-      else
-        PuppetCheck.settings[:clean_files].push(file.to_s)
-      end
+      # credits to gds-operations/puppet-syntax for the parser function call
+      Puppet::Pops::Parser::EvaluatingParser::EvaluatingEppParser.new.parse_file(file)
+    rescue StandardError => err
+      PuppetCheck.settings[:error_files].push("#{file}:\n#{err.to_s.gsub("#{file}:", '')}")
+    else
+      PuppetCheck.settings[:clean_files].push(file.to_s)
     end
   end
 end

data/lib/puppet-check/rspec_puppet_support.rb

@@ -3,7 +3,7 @@ class RSpecPuppetSupport
   # code diagram:
   # 'puppetcheck:spec' task invokes 'run'
   # 'run' invokes 'file_setup' always and 'dependency_setup' if metadata.json exists
-  # 'dependency_setup' invokes 'git/forge/hg' if dependencies exist and git/forge/hg is download option
+  # 'dependency_setup' invokes 'git/forge/svn/hg' if dependencies exist and git/forge/svn/hg is download option
   # 'git/forge/svn/hg' downloads module fixture appropriately
 
   # prepare the spec fixtures directory for rspec-puppet testing
@@ -15,10 +15,10 @@ class RSpecPuppetSupport
     # setup fixtures for rspec-puppet testing
     specdirs.each do |specdir|
       # skip to next specdir if it does not seem like a puppet module
-      next unless File.directory?(specdir + '/../manifests')
+      next unless File.directory?("#{specdir}/../manifests")
 
       # change to module directory
-      Dir.chdir(specdir + '/..')
+      Dir.chdir("#{specdir}/..")
 
       # grab the module name from the directory name of the module to pass to file_setup
       file_setup(File.basename(Dir.pwd))
@@ -90,7 +90,11 @@ class RSpecPuppetSupport
     # establish path to clone module to
     path = "spec/fixtures/modules/#{File.basename(git_url, '.git')}"
     # is the module present and already cloned with git? do a pull; otherwise, do a clone
-    File.directory?("#{path}/.git") ? spawn("git -C #{path} pull") : spawn("git clone #{args} #{git_url} #{path}")
+    begin
+      File.directory?("#{path}/.git") ? spawn("git -C #{path} pull") : spawn("git clone #{args} #{git_url} #{path}")
+    rescue Errno::ENOENT
+      warn 'git is not installed and cannot be used to retrieve dependency modules'
+    end
   end
 
   # download external module dependency with forge
@@ -107,7 +111,11 @@ class RSpecPuppetSupport
     # establish path to checkout module to
     path = "spec/fixtures/modules/#{File.basename(svn_url)}"
     # is the module present and already checked out with svn? do an update; otherwise, do a checkout
-    File.directory?("#{path}/.svn") ? spawn("svn update #{path}") : spawn("svn co #{args} #{svn_url} #{path}")
+    begin
+      File.directory?("#{path}/.svn") ? spawn("svn update #{path}") : spawn("svn co #{args} #{svn_url} #{path}")
+    rescue Errno::ENOENT
+      warn 'subversion is not installed and cannot be used to retrieve dependency modules'
+    end
   end
 
   # download external module dependency with hg
@@ -116,6 +124,10 @@ class RSpecPuppetSupport
     # establish path to clone module to
     path = "spec/fixtures/modules/#{File.basename(hg_url)}"
     # is the module present and already cloned with hg? do a pull and update; otherwise do a clone
-    File.directory?("#{path}/.hg") ? spawn("hg --cwd #{path} pull; hg --cwd #{path} update") : spawn("hg clone #{args} #{hg_url} #{path}")
+    begin
+      File.directory?("#{path}/.hg") ? spawn("hg --cwd #{path} pull; hg --cwd #{path} update") : spawn("hg clone #{args} #{hg_url} #{path}")
+    rescue Errno::ENOENT
+      warn 'mercurial is not installed and cannot be used to retrieve dependency modules'
+    end
   end
 end

data/lib/puppet-check/ruby_parser.rb

@@ -1,4 +1,4 @@
-require_relative '../puppet-check'
+require_relative '../puppet_check'
 require_relative 'utils'
 
 # executes diagnostics on ruby files
@@ -7,31 +7,29 @@ class RubyParser
   def self.ruby(files, style, rc_args)
     files.each do |file|
       # check ruby syntax
-      begin
-        # prevents ruby code from actually executing
-        catch(:good) { instance_eval("BEGIN {throw :good}; #{File.read(file)}", file) }
-      rescue ScriptError, StandardError => err
-        PuppetCheck.settings[:error_files].push("#{file}:\n#{err}")
-      else
-        # check ruby style
-        if style
-          require 'rubocop'
+      # prevents ruby code from actually executing
+      catch(:good) { instance_eval("BEGIN {throw :good}; #{File.read(file)}", file) }
+    rescue ScriptError, StandardError => err
+      PuppetCheck.settings[:error_files].push("#{file}:\n#{err}")
+    else
+      # check ruby style
+      if style
+        require 'rubocop'
 
-          # check RuboCop and collect warnings
-          rubocop_warnings = Utils.capture_stdout { RuboCop::CLI.new.run(rc_args + ['--require', 'rubocop-performance', '--format', 'emacs', file]) }
-          warnings = rubocop_warnings == '' ? '' : rubocop_warnings.split("#{File.absolute_path(file)}:").join('')
+        # check RuboCop and collect warnings
+        rubocop_warnings = Utils.capture_stdout { RuboCop::CLI.new.run(rc_args + ['--enable-pending-cops', '--require', 'rubocop-performance', '--format', 'emacs', file]) }
+        warnings = rubocop_warnings == '' ? '' : rubocop_warnings.split("#{File.absolute_path(file)}:").join('')
 
-          # check Reek and collect warnings
-          require 'reek'
-          require 'reek/cli/application'
-          reek_warnings = Utils.capture_stdout { Reek::CLI::Application.new([file]).execute }
-          warnings << reek_warnings.split("\n")[1..-1].map(&:strip).join("\n") unless reek_warnings == ''
+        # check Reek and collect warnings
+        require 'reek'
+        require 'reek/cli/application'
+        reek_warnings = Utils.capture_stdout { Reek::CLI::Application.new([file]).execute }
+        warnings << reek_warnings.split("\n")[1..].map(&:strip).join("\n") unless reek_warnings == ''
 
-          # return warnings
-          next PuppetCheck.settings[:warning_files].push("#{file}:\n#{warnings.strip}") unless warnings == ''
-        end
-        PuppetCheck.settings[:clean_files].push(file.to_s)
+        # return warnings
+        next PuppetCheck.settings[:warning_files].push("#{file}:\n#{warnings.strip}") unless warnings == ''
       end
+      PuppetCheck.settings[:clean_files].push(file.to_s)
     end
   end
 
@@ -43,8 +41,9 @@ class RubyParser
       # check ruby template syntax
       begin
         # need to eventually have this associated with a different binding during each iteration
-        warnings = Utils.capture_stderr { ERB.new(File.read(file), nil, '-').result }
-        # ERB.new(File.read(file), nil, '-').result(RubyParser.new.bind)
+        # older usage throws extra warning and mixes with valid warnings confusingly
+        warnings = Utils.capture_stderr { ERB.new(File.read(file), trim_mode: '-').result }
+                   # ERB.new(File.read(file), trim_mode: '-').result(RubyParser.new.bind)
       rescue NameError, TypeError
         # empty out warnings since it would contain an error if this pass triggers
         warnings = ''
@@ -62,30 +61,27 @@ class RubyParser
     # efficient var assignment prior to iterator
     if style
       require 'rubocop'
-      # cop named differently depending upon version
-      filename_cop = RuboCop::Version::STRING.to_f >= 0.5 ? 'Naming/FileName' : 'Style/FileName'
+
       # 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]},#{filename_cop}" : rc_args.concat(['--except', filename_cop])
+      rc_args.include?('--except') ? rc_args[rc_args.index('--except') + 1] = "#{rc_args[rc_args.index('--except') + 1]},Naming/FileName" : rc_args.concat(['--except', 'Naming/FileName'])
     end
 
     files.each do |file|
       # check librarian puppet syntax
-      begin
-        # prevents ruby code from actually executing
-        catch(:good) { instance_eval("BEGIN {throw :good}; #{File.read(file)}", file) }
-      rescue SyntaxError, LoadError, ArgumentError => err
-        PuppetCheck.settings[:error_files].push("#{file}:\n#{err}")
-      # check librarian puppet style
-      else
-        if style
-          # check Rubocop
-          warnings = Utils.capture_stdout { RuboCop::CLI.new.run(rc_args + ['--require', 'rubocop-performance', '--format', 'emacs', file]) }
+      # prevents ruby code from actually executing
+      catch(:good) { instance_eval("BEGIN {throw :good}; #{File.read(file)}", file) }
+    rescue SyntaxError, LoadError, ArgumentError => err
+      PuppetCheck.settings[:error_files].push("#{file}:\n#{err}")
+    # check librarian puppet style
+    else
+      if style
+        # check Rubocop
+        warnings = Utils.capture_stdout { RuboCop::CLI.new.run(rc_args + ['--enable-pending-cops', '--require', 'rubocop-performance', '--format', 'emacs', file]) }
 
-          # collect style warnings
-          next PuppetCheck.settings[:warning_files].push("#{file}:\n#{warnings.split("#{File.absolute_path(file)}:").join('')}") unless warnings.empty?
-        end
-        PuppetCheck.settings[:clean_files].push(file.to_s)
+        # collect style warnings
+        next PuppetCheck.settings[:warning_files].push("#{file}:\n#{warnings.split("#{File.absolute_path(file)}:").join('')}") unless warnings.empty?
       end
+      PuppetCheck.settings[:clean_files].push(file.to_s)
     end
   end
 

data/lib/puppet-check/tasks.rb

@@ -3,7 +3,7 @@ begin
 rescue LoadError
   raise 'Rake is not installed and you are attempting to execute Rake tasks with Puppet Check. Please install Rake before continuing.'
 end
-require_relative '../puppet-check'
+require_relative '../puppet_check'
 
 # the rake interface for PuppetCheck
 class PuppetCheck::Tasks < ::Rake::TaskLib

data/lib/{puppet-check.rb → puppet_check.rb}

@@ -28,7 +28,7 @@ class PuppetCheck
     execute_parsers(files, settings)
 
     # output the diagnostic results
-    settings[:output_format] == 'text' ? OutputResults.text : OutputResults.markup(settings)
+    settings[:output_format] == 'text' ? OutputResults.text : OutputResults.markup(settings[:output_format])
 
     # progress to regression checks if no errors in file checks
     if self.class.settings[:error_files].empty? && (!settings[:fail_on_warning] || self.class.settings[:warning_files].empty?)

data/spec/fixtures/plans/good.pp

@@ -0,0 +1,3 @@
+plan my_plan::good_plan(
+  TargetSpec $servers
+) {}

data/spec/fixtures/plans/style.pp

@@ -0,0 +1,6 @@
+plan my_plan::style_plan(
+  TargetSpec $servers
+) {
+  $foo = 'bar'
+  $bar = "$bar baz"
+}

data/spec/fixtures/plans/syntax.pp

@@ -0,0 +1,5 @@
+plan my_plan::syntax_plan(
+  TargetSpec $servers
+) {
+  get_targets($servers).each |Target $server| {)
+}

data/spec/octocatalog-diff/{octocatalog-diff.cfg.rb → octocatalog_diff.cfg.rb}

@@ -4,13 +4,13 @@ module OctocatalogDiff
   class Config
     def self.config
       settings = {}
-      octocatalog_diff_dir = File.dirname(__FILE__) + '/'
+      octocatalog_diff_dir = "#{File.dirname(__FILE__)}/"
 
-      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 File.directory?('/home/travis')
-                                   octocatalog_diff_dir + '../../bin/puppet'
+      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