puppet-check 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d2defe55b01e90b73fc2cb3dfc12b9004fbe02b73fc751b736529e454c0c92b
-  data.tar.gz: 96bce3d495f0a5778d5475659ba3fbf6360290ef565666478933cd867babc34d
+  metadata.gz: aa44aac16d4ff64057807c913172a7a064352f4fcfee70868b0d0c06dc0dffd6
+  data.tar.gz: 4a1fbf02e9638af8605b26377ac335594ac8d640308f38fdbc9dbae1ada78a99
 SHA512:
-  metadata.gz: 52037386f7f9168822a8cc14da2455d3a6a2f38cc3686ef7edbed65bee382a07159328c9ca3e1472c97d533e0966b431b921d78380bec684489e7528ec443694
-  data.tar.gz: 859c21981164a0e002c6e8faeec55b285aa65d7cd953b838415873d482f7a32acf4ede39049329eb9435f435a7a96b741749a7501e1a0cfd045c43444f5cbc94
+  metadata.gz: 58186b18c0aa0fe1600c158be2d20be6ccaf75389e18baae51041a47b8c314dd550f0817a329aca29e2ed1a6c96249f3220815b8f26387a2795306ce41715d9e
+  data.tar.gz: 616cdc41630d9b06e93cbc27015980baa3777063837ce91e1a88955a0fdbfb41cbcc79473133d4bbe1439961345cb8f745acda8f40b15c1d0bfb58b863a80be0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 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)
+[![CircleCI](https://circleci.com/gh/mschuchard/puppet-check.svg?style=svg)](https://circleci.com/gh/mschuchard/puppet-check)
 
 - [Description](#description)
 - [Usage](#usage)

data/lib/puppet-check/data_parser.rb

@@ -118,8 +118,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 +177,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
@@ -206,6 +206,7 @@ class DataParser
 
     # disregard nil/undef value data check if default values (common)
     unless file =~ /^common/
+    # unless /^common/.match?(file) TODO: use when ruby >= 2.4
       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

@@ -31,10 +31,11 @@ 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 settings[:output_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

data/lib/puppet-check/puppet_parser.rb

@@ -17,30 +17,34 @@ class PuppetParser
 
       # check puppet syntax
       begin
+        # initialize message
+        message = ''
         # 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.*: /, '')
         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.*: /, '')}")
+        if Gem::Version.new(Puppet::PUPPETVERSION) >= Gem::Version.new('5.4') && Gem::Version.new(Puppet::PUPPETVERSION) < Gem::Version.new('6.5')
+          message = 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.*: /, '')}")
+        elsif Gem::Version.new(Puppet::PUPPETVERSION) >= Gem::Version.new('5.0') && Gem::Version.new(Puppet::PUPPETVERSION) < Gem::Version.new('5.3')
+          message = 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.absolute_path(file)}:", '')
       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
+        warnings << if Gem::Version.new(Puppet::PUPPETVERSION) >= Gem::Version.new('5.4')
                       "\n#{errors.map(&:to_s).join("\n").gsub("file: #{File.absolute_path(file)}, ", '')}"
                     # puppet <= 5.3 validator output format
                     else

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/spec/puppet-check/data_parser_spec.rb

@@ -29,7 +29,7 @@ describe DataParser do
     end
   end
 
-  if RUBY_VERSION.to_f >= 2.3
+  if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.3')
     context '.eyaml' do
       before(:each) do
         PuppetCheck.settings[:ignored_files] = []

data/spec/puppet-check/puppet_parser_spec.rb

@@ -11,10 +11,10 @@ describe PuppetParser do
   context '.manifest' do
     it 'puts a bad syntax Puppet manifest in the error files array' do
       PuppetParser.manifest([fixtures_dir + 'manifests/syntax.pp'], false, [])
-      if Puppet::PUPPETVERSION.to_f >= 6.5
+      if Gem::Version.new(Puppet::PUPPETVERSION) >= Gem::Version.new('6.5.0')
         expect(PuppetCheck.settings[:error_files][0]).to match(%r{^#{fixtures_dir}manifests/syntax.pp:\nLanguage validation logged 2 errors})
       # dealing with annoying warning in puppet 5 and 6
-      elsif RUBY_VERSION.to_f < 2.3
+      elsif Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.3')
         expect(PuppetCheck.settings[:error_files][0]).to match(%r{^#{fixtures_dir}manifests/syntax.pp:\nSupport for ruby version.*\n.*\nThis Variable has no effect.*\nIllegal variable name})
       else
         expect(PuppetCheck.settings[:error_files][0]).to match(%r{^#{fixtures_dir}manifests/syntax.pp:\nThis Variable has no effect.*\nIllegal variable name})
@@ -22,11 +22,14 @@ describe PuppetParser do
       expect(PuppetCheck.settings[:warning_files]).to eql([])
       expect(PuppetCheck.settings[:clean_files]).to eql([])
     end
-    it 'puts a bad syntax at eof Puppet manifest in the error files array' do
-      PuppetParser.manifest([fixtures_dir + 'manifests/eof_syntax.pp'], false, [])
-      expect(PuppetCheck.settings[:error_files][0]).to match(%r{^#{fixtures_dir}manifests/eof_syntax.pp:\nSyntax error at end of input})
-      expect(PuppetCheck.settings[:warning_files]).to eql([])
-      expect(PuppetCheck.settings[:clean_files]).to eql([])
+    # puppet 5 api has output issues for this fixture
+    unless Gem::Version.new(Puppet::PUPPETVERSION) < Gem::Version.new('6.0.0')
+      it 'puts a bad syntax at eof Puppet manifest in the error files array' do
+        PuppetParser.manifest([fixtures_dir + 'manifests/eof_syntax.pp'], false, [])
+        expect(PuppetCheck.settings[:error_files][0]).to match(%r{^#{fixtures_dir}manifests/eof_syntax.pp:\nSyntax error at end of input})
+        expect(PuppetCheck.settings[:warning_files]).to eql([])
+        expect(PuppetCheck.settings[:clean_files]).to eql([])
+      end
     end
     it 'puts a bad parser and lint style Puppet manifest in the warning files array' do
       PuppetParser.manifest([fixtures_dir + 'manifests/style_parser.pp'], true, [])
@@ -37,7 +40,7 @@ describe PuppetParser do
     it 'puts a bad lint style Puppet manifest in the warning files array' do
       PuppetParser.manifest([fixtures_dir + 'manifests/style_lint.pp'], true, [])
       expect(PuppetCheck.settings[:error_files]).to eql([])
-      expect(PuppetCheck.settings[:warning_files][0]).to match(%r{^#{fixtures_dir}manifests/style_lint.pp:\n.*double quoted string containing.*\n.*indentation of})
+      expect(PuppetCheck.settings[:warning_files][0]).to match(%r{^#{fixtures_dir}manifests/style_lint.pp:\n.*(?:indentation of|double quoted string containing).*\n.*(?:indentation of|double quoted string containing)})
       expect(PuppetCheck.settings[:clean_files]).to eql([])
     end
     it 'puts a bad style Puppet manifest in the clean files array when puppetlint_args ignores its warnings' do

data/spec/puppet-check/regression_check_spec.rb

@@ -5,7 +5,7 @@ require_relative '../../lib/puppet-check/regression_check'
 describe RegressionCheck do
   context '.config' do
     # json gem got messed up for the EOL Ruby versions
-    if RUBY_VERSION.to_f >= 2.2
+    if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.2')
       it 'raise an appropriate error if the file is malformed' do
         expect { RegressionCheck.config(fixtures_dir + 'metadata.json') }.to raise_error(OctocatalogDiff::Errors::ConfigurationFileContentError, 'Configuration must define OctocatalogDiff::Config!')
       end

data/spec/puppet-check/rspec_puppet_support_spec.rb

@@ -14,7 +14,11 @@ describe RSpecPuppetSupport do
     before(:each) { Dir.chdir(fixtures_dir) }
 
     it 'creates missing directories, missing site.pp, missing symlinks, and a missing spec_helper' do
-      expect { rspec_puppet_setup }.to output("puppetlabs/gruntmaster has an unspecified, or specified but unsupported, download method.\n").to_stderr
+      if File.directory?('/home/travis')
+        expect { rspec_puppet_setup }.to output("puppetlabs/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
+      end
 
       # .file_setup
       expect(File.directory?('spec/fixtures/manifests')).to be true

data/spec/puppet-check/ruby_parser_spec.rb

@@ -38,7 +38,11 @@ describe RubyParser do
   context '.template' do
     it 'puts a bad syntax ruby template file in the error files array' do
       RubyParser.template([fixtures_dir + 'templates/syntax.erb'])
-      expect(PuppetCheck.settings[:error_files][0]).to match(%r{^#{fixtures_dir}templates/syntax.erb:\n.*syntax error, unexpected tIDENTIFIER})
+      if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.7')
+        expect(PuppetCheck.settings[:error_files][0]).to match(%r{^#{fixtures_dir}templates/syntax.erb:\n.*1: syntax error, unexpected.*\n.*ruby})
+      else
+        expect(PuppetCheck.settings[:error_files][0]).to match(%r{^#{fixtures_dir}templates/syntax.erb:\n.*syntax error, unexpected tIDENTIFIER})
+      end
       expect(PuppetCheck.settings[:warning_files]).to eql([])
       expect(PuppetCheck.settings[:clean_files]).to eql([])
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-check
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Matt Schuchard
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-09-27 00:00:00.000000000 Z
+date: 2021-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet
@@ -19,7 +19,7 @@ dependencies:
         version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: puppet-lint
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +53,7 @@ dependencies:
         version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -63,21 +63,27 @@ dependencies:
         version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.58'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.58'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -137,7 +143,7 @@ dependencies:
 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.
-email: 
+email:
 executables:
 - puppet-check
 extensions: []
@@ -215,7 +221,7 @@ homepage: https://www.github.com/mschuchard/puppet-check
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -230,9 +236,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: A streamlined comprehensive set of checks for your entire Puppet code and
   data