puppet-lint 3.0.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 780fb18c627fc4498cfbd056762846a70b2240619c52a23121d522b56aaec062
-  data.tar.gz: 59068f03812ef0d9b622fa6b9440567ba4e12f33a5349c1ddc9c642ac7dd51a5
+  metadata.gz: a7cd6dad7a05e7eefb19f4c9efedc5815b1f83376a77def6fd54b321945c520c
+  data.tar.gz: d82288ffc965a3f001269abdb42efe6bb71041575b1106e3331b4a70f2a0fe84
 SHA512:
-  metadata.gz: 32fb18937f47636f80535bcc8db5884aa63a6af9a86f148ee25a37b65890d13f275094ab2a81012a5ef7385d696195c59632d234eca805c94a2bc2d3b4d77905
-  data.tar.gz: 124a921b4ad50b3f923f7180d330a89f313f70c5b77d1dcf8060611a124171e1bf3ef06f8b3d4b27421cad4157c69699c12bc8acc8dd63461a61fb1aecacc14c
+  metadata.gz: b1571f76174d7afaca3da45f692b681aedb4e99a52563c3f3a0171d6db9bbddb9c409f5f21223fbfe249b7254f2d41edb01331b9c154afafb35572f3fdff7e7c
+  data.tar.gz: e594e8917a7ce55bab177449d1a6db41454dbbaacb37eb4a4f1b0ec9a8cf4e82f5ee023d112ca629d83bceceaba413d281d242f45388207a4c707e7380afc3ab

data/README.md

@@ -1,15 +1,13 @@
 # Puppet Lint
 
-[![Build
-Status](https://secure.travis-ci.org/rodjek/puppet-lint.png)](http://travis-ci.org/rodjek/puppet-lint)
-[![Inline docs](http://inch-ci.org/github/rodjek/puppet-lint.png?branch=master)](http://inch-ci.org/github/rodjek/puppet-lint)
-
 Puppet Lint tests Puppet code against the recommended [Puppet language style
 guide](http://puppet.com/docs/puppet/latest/style_guide.html). Puppet Lint validates only code style; it does not validate syntax. To test syntax, use Puppet's `puppet parser validate` command.
 
 ## Compatibility warning
 
-Puppet Lint version 2 is the last planned version with support for Puppet 3 and Ruby 1.8.7. The next major version of Puppet Lint will drop support for these versions.
+Version 3.0.0 and above will no longer support Puppet 6 environments.
+
+In cases where Puppet Lint is required in an environment with Puppet 6, we recommend pinning to version 2.5.2.
 
 ## Installation
 
@@ -213,6 +211,30 @@ There is a GitHub Actions action available to get linter feedback in workflows:
 
 * [puppet-lint-action](https://github.com/marketplace/actions/puppet-lint-action)
 
+## Integration with GitLab Code Quality
+
+[GitLab](https://gitlab.com/) users can use the `--codeclimate-report-file` configuration option to generate a report for use with the
+[Code Quality](https://docs.gitlab.com/ee/ci/testing/code_quality.html) feature.
+
+The easiest way to set this option, (and without having to modify rake tasks), is with the `CODECLIMATE_REPORT_FILE` environment variable.
+
+For example, the following GitLab job sets the environment variable and
+[archives the report](https://docs.gitlab.com/ee/ci/yaml/artifacts_reports.html#artifactsreportscodequality) produced.
+```yaml
+validate lint check rubocop-Ruby 2.7.2-Puppet ~> 7:
+  stage: syntax
+  image: ruby:2.7.2
+  script:
+    - bundle exec rake validate lint check rubocop
+  variables:
+    PUPPET_GEM_VERSION: '~> 7'
+    CODECLIMATE_REPORT_FILE: 'gl-code-quality-report.json'
+  artifacts:
+    reports:
+      codequality: gl-code-quality-report.json
+    expire_in: 1 week
+```
+
 ## Options
 
 See `puppet-lint --help` for a full list of command line options and checks.
@@ -268,7 +290,7 @@ For a complete list of checks, and how to resolve errors on each check, see the
 ## Reporting bugs or incorrect results
 
 If you find a bug in Puppet Lint or its results, please create an issue in the
-[repo issues tracker](https://github.com/rodjek/puppet-lint/issues/). Bonus
+[repo issues tracker](https://github.com/puppetlabs/puppet-lint/issues/). Bonus
 points will be awarded if you also include a patch that fixes the issue.
 
 ## Thank you

data/lib/puppet-lint/bin.rb

@@ -1,6 +1,7 @@
 require 'pathname'
 require 'uri'
 require 'puppet-lint/optparser'
+require 'puppet-lint/report/codeclimate'
 
 # Internal: The logic of the puppet-lint bin script, contained in a class for
 # ease of testing.
@@ -48,7 +49,7 @@ class PuppetLint::Bin
 
     begin
       path = @args[0]
-      full_path = File.expand_path(path, ENV['PWD'])
+      full_path = File.expand_path(path, ENV.fetch('PWD', nil))
       full_base_path = if File.directory?(full_path)
                          full_path
                        else
@@ -78,19 +79,17 @@ class PuppetLint::Bin
 
       path.each do |f|
         next if ignore_paths.any? { |p| File.fnmatch(p, f) }
+
         l = PuppetLint.new
         l.file = f
         l.run
         all_problems << l.print_problems
 
-        if l.errors? || (l.warnings? && PuppetLint.configuration.fail_on_warnings)
-          return_val = 1
-        end
+        return_val = 1 if l.errors? || (l.warnings? && PuppetLint.configuration.fail_on_warnings)
 
         next unless PuppetLint.configuration.fix && l.problems.none? { |r| r[:check] == :syntax }
-        File.open(f, 'wb') do |fd|
-          fd.write(l.manifest)
-        end
+
+        File.binwrite(f, l.manifest)
       end
 
       if PuppetLint.configuration.sarif
@@ -104,6 +103,8 @@ class PuppetLint::Bin
         puts JSON.pretty_generate(all_problems)
       end
 
+      PuppetLint::Report::CodeClimateReporter.write_report_file(all_problems, PuppetLint.configuration.codeclimate_report_file) if PuppetLint.configuration.codeclimate_report_file
+
       return_val
     rescue PuppetLint::NoCodeError
       puts 'puppet-lint: no file specified or specified file does not exist'
@@ -143,7 +144,7 @@ class PuppetLint::Bin
           'ruleIndex' => rule_index,
           'message' => { 'text' => message[:message] },
           'locations' => [{ 'physicalLocation' => { 'artifactLocation' => { 'uri' => relative_path, 'uriBaseId' => 'ROOTPATH' },
-'region' => { 'startLine' => message[:line], 'startColumn' => message[:column] } } }],
+                                                    'region' => { 'startLine' => message[:line], 'startColumn' => message[:column] } } }]
         }
         results << result
       end

data/lib/puppet-lint/checkplugin.rb

@@ -179,10 +179,10 @@ class PuppetLint::CheckPlugin
   # Returns a Hash of default problem information.
   def default_info
     @default_info ||= {
-      check: self.class.const_get('NAME'),
+      check: self.class.const_get(:NAME),
       fullpath: fullpath,
       path: path,
-      filename: filename,
+      filename: filename
     }
   end
 
@@ -202,14 +202,10 @@ class PuppetLint::CheckPlugin
     problem[:kind] = kind
     problem.merge!(default_info) { |_key, v1, _v2| v1 }
 
-    unless [:warning, :error, :fixed].include?(kind)
-      raise ArgumentError, 'unknown value passed for kind'
-    end
+    raise ArgumentError, 'unknown value passed for kind' unless [:warning, :error, :fixed].include?(kind)
 
     [:message, :line, :column, :check].each do |attr|
-      unless problem.key?(attr)
-        raise ArgumentError, "problem hash must contain #{attr.inspect}"
-      end
+      raise ArgumentError, "problem hash must contain #{attr.inspect}" unless problem.key?(attr)
     end
 
     @problems << problem

data/lib/puppet-lint/checks.rb

@@ -39,7 +39,7 @@ class PuppetLint::Checks
         column: e.column,
         fullpath: PuppetLint::Data.fullpath,
         path: PuppetLint::Data.path,
-        filename: PuppetLint::Data.filename,
+        filename: PuppetLint::Data.filename
       }
       PuppetLint::Data.tokens = []
     end
@@ -76,18 +76,18 @@ class PuppetLint::Checks
       kind: :error,
       check: :syntax,
       message: 'Syntax error',
-      fullpath: File.expand_path(fileinfo, ENV['PWD']),
+      fullpath: File.expand_path(fileinfo, ENV.fetch('PWD', nil)),
       filename: File.basename(fileinfo),
       path: fileinfo,
       line: e.token.line,
-      column: e.token.column,
+      column: e.token.column
     }
 
     @problems
-  rescue => e
+  rescue StandardError => e
     $stdout.puts <<-END.gsub(%r{^ {6}}, '')
       Whoops! It looks like puppet-lint has encountered an error that it doesn't
-      know how to handle. Please open an issue at https://github.com/rodjek/puppet-lint
+      know how to handle. Please open an issue at https://github.com/puppetlabs/puppet-lint
       and paste the following output into the issue description.
       ---
       puppet-lint version: #{PuppetLint::VERSION}
@@ -120,10 +120,8 @@ class PuppetLint::Checks
   #
   # Returns an Array of String check names.
   def enabled_checks
-    @enabled_checks ||= begin
-      PuppetLint.configuration.checks.select do |check|
-        PuppetLint.configuration.send("#{check}_enabled?")
-      end
+    @enabled_checks ||= PuppetLint.configuration.checks.select do |check|
+      PuppetLint.configuration.send("#{check}_enabled?")
     end
   end
 
@@ -131,6 +129,6 @@ class PuppetLint::Checks
   #
   # Returns the manifest as a String.
   def manifest
-    PuppetLint::Data.tokens.map(&:to_manifest).join('')
+    PuppetLint::Data.tokens.map(&:to_manifest).join
   end
 end

data/lib/puppet-lint/configuration.rb

@@ -18,7 +18,7 @@ class PuppetLint::Configuration
     #
     # Returns true if the check is enabled, otherwise return false.
     define_method("#{check}_enabled?") do
-      settings["#{check}_disabled"] == true ? false : true
+      settings["#{check}_disabled"] != true
     end
 
     # Public: Disable the named check.
@@ -153,5 +153,6 @@ class PuppetLint::Configuration
     self.show_ignored = false
     self.ignore_paths = ['vendor/**/*.pp']
     self.github_actions = ENV.key?('GITHUB_ACTION')
+    self.codeclimate_report_file = ENV.fetch('CODECLIMATE_REPORT_FILE', nil)
   end
 end

data/lib/puppet-lint/data.rb

@@ -72,7 +72,7 @@ class PuppetLint::Data
 
       unless formatting_tokens.include?(token.type)
         current_token.next_token.prev_code_token = token unless current_token.next_token.nil?
-        next_nf_idx = tokens[index..-1].index { |r| !formatting_tokens.include?(r.type) }
+        next_nf_idx = tokens[index..].index { |r| !formatting_tokens.include?(r.type) }
         unless next_nf_idx.nil?
           next_nf_token = tokens[index + next_nf_idx]
           token.next_code_token = next_nf_token
@@ -92,9 +92,7 @@ class PuppetLint::Data
       end
 
       current_token.next_token = token
-      unless formatting_tokens.include?(token.type)
-        current_token.next_code_token = token
-      end
+      current_token.next_code_token = token unless formatting_tokens.include?(token.type)
 
       tokens.insert(index, token)
     end
@@ -123,7 +121,7 @@ class PuppetLint::Data
         @fullpath = nil
         @filename = nil
       else
-        @fullpath = File.expand_path(val, ENV['PWD'])
+        @fullpath = File.expand_path(val, ENV.fetch('PWD', nil))
         @filename = File.basename(val)
       end
     end
@@ -155,6 +153,18 @@ class PuppetLint::Data
       end
     end
 
+    # Internal: Determine if the given token contains a CLASSREF in
+    # the token chain..
+    #
+    # Returns a Boolean.
+    def classref?(token)
+      current_token = token
+      while (current_token = current_token.prev_code_token)
+        return true if current_token.type == :CLASSREF
+        return false if current_token.type == :NAME
+      end
+    end
+
     # Internal: Calculate the positions of all resource declarations within the
     # tokenised manifest. These positions only point to the content of the
     # resource declarations, they do not include resource types or titles.
@@ -170,13 +180,16 @@ class PuppetLint::Data
         result = []
         tokens.select { |t| t.type == :COLON }.each do |colon_token|
           next unless colon_token.next_code_token && colon_token.next_code_token.type != :LBRACE
+          next if classref?(colon_token)
 
-          rel_start_idx = tokens[marker..-1].index(colon_token)
+          rel_start_idx = tokens[marker..].index(colon_token)
           break if rel_start_idx.nil?
+
           start_idx = rel_start_idx + marker
           end_token = colon_token.next_token_of([:SEMIC, :RBRACE])
-          rel_end_idx = tokens[start_idx..-1].index(end_token)
+          rel_end_idx = tokens[start_idx..].index(end_token)
           raise PuppetLint::SyntaxError, colon_token if rel_end_idx.nil?
+
           marker = rel_end_idx + start_idx
 
           result << {
@@ -184,7 +197,7 @@ class PuppetLint::Data
             end: marker,
             tokens: tokens[start_idx..marker],
             type: find_resource_type_token(start_idx),
-            param_tokens: find_resource_param_tokens(tokens[start_idx..marker]),
+            param_tokens: find_resource_param_tokens(tokens[start_idx..marker])
           }
         end
         result
@@ -224,9 +237,7 @@ class PuppetLint::Data
 
         break unless resource_tokens.include?(iter_token)
 
-        if iter_token && iter_token.next_code_token.type == :FARROW
-          param_tokens << iter_token
-        end
+        param_tokens << iter_token if iter_token && iter_token.next_code_token.type == :FARROW
       end
 
       param_tokens
@@ -293,7 +304,7 @@ class PuppetLint::Data
         paren_depth = 0
         in_params = false
         inherited_class = nil
-        tokens[i + 1..-1].each_with_index do |definition_token, j|
+        tokens[i + 1..].each_with_index do |definition_token, j|
           case definition_token.type
           when :INHERITS
             inherited_class = definition_token.next_code_token
@@ -307,19 +318,17 @@ class PuppetLint::Data
             brace_depth += 1
           when :RBRACE
             brace_depth -= 1
-            if brace_depth.zero? && !in_params
-              if token.next_code_token.type != :LBRACE
-                result << {
-                  start: i,
-                  end: i + j + 1,
-                  tokens: tokens[i..(i + j + 1)],
-                  param_tokens: param_tokens(tokens[i..(i + j + 1)]),
-                  type: type,
-                  name_token: token.next_code_token,
-                  inherited_token: inherited_class,
-                }
-                break
-              end
+            if brace_depth.zero? && !in_params && (token.next_code_token.type != :LBRACE)
+              result << {
+                start: i,
+                end: i + j + 1,
+                tokens: tokens[i..(i + j + 1)],
+                param_tokens: param_tokens(tokens[i..(i + j + 1)]),
+                type: type,
+                name_token: token.next_code_token,
+                inherited_token: inherited_class
+              }
+              break
             end
           end
         end
@@ -354,7 +363,7 @@ class PuppetLint::Data
           level = 0
           real_idx = 0
           in_paren = false
-          tokens[token_idx + 1..-1].each_with_index do |cur_token, cur_token_idx|
+          tokens[token_idx + 1..].each_with_index do |cur_token, cur_token_idx|
             break if level.zero? && in_paren
             break if level.zero? && cur_token.type == :NEWLINE
 
@@ -369,7 +378,7 @@ class PuppetLint::Data
           functions << {
             start: token_idx,
             end: real_idx,
-            tokens: tokens[token_idx..real_idx],
+            tokens: tokens[token_idx..real_idx]
           }
         end
         functions
@@ -393,7 +402,7 @@ class PuppetLint::Data
           next unless token.type == :LBRACK
 
           real_idx = 0
-          tokens[token_idx + 1..-1].each_with_index do |cur_token, cur_token_idx|
+          tokens[token_idx + 1..].each_with_index do |cur_token, cur_token_idx|
             real_idx = token_idx + 1 + cur_token_idx
             break if cur_token.type == :RBRACK
           end
@@ -405,7 +414,7 @@ class PuppetLint::Data
           arrays << {
             start: token_idx,
             end: real_idx,
-            tokens: tokens[token_idx..real_idx],
+            tokens: tokens[token_idx..real_idx]
           }
         end
         arrays
@@ -432,18 +441,18 @@ class PuppetLint::Data
 
           level = 0
           real_idx = 0
-          tokens[token_idx + 1..-1].each_with_index do |cur_token, cur_token_idx|
+          tokens[token_idx + 1..].each_with_index do |cur_token, cur_token_idx|
             real_idx = token_idx + 1 + cur_token_idx
 
             level += 1 if cur_token.type == :LBRACE
             level -= 1 if cur_token.type == :RBRACE
-            break if level < 0
+            break if level.negative?
           end
 
           hashes << {
             start: token_idx,
             end: real_idx,
-            tokens: tokens[token_idx..real_idx],
+            tokens: tokens[token_idx..real_idx]
           }
         end
         hashes
@@ -469,7 +478,7 @@ class PuppetLint::Data
 
           real_idx = 0
 
-          tokens[token_idx + 1..-1].each_with_index do |cur_token, cur_token_idx|
+          tokens[token_idx + 1..].each_with_index do |cur_token, cur_token_idx|
             real_idx = token_idx + 1 + cur_token_idx
             break if cur_token.type == :RBRACE
           end
@@ -477,7 +486,7 @@ class PuppetLint::Data
           defaults << {
             start: token_idx,
             end: real_idx,
-            tokens: tokens[token_idx..real_idx],
+            tokens: tokens[token_idx..real_idx]
           }
         end
         defaults
@@ -551,7 +560,7 @@ class PuppetLint::Data
         comment_token_types.include?(token.type)
       end
       control_comment_tokens = comment_tokens.select do |token|
-        token.value.strip =~ %r{\Alint\:(ignore\:[\w\d]+|endignore)}
+        token.value.strip =~ %r{\Alint:(ignore:[\w\d]+|endignore)}
       end
 
       stack = []
@@ -561,12 +570,12 @@ class PuppetLint::Data
 
         comment_words = token.value.strip.split(%r{\s+})
         comment_words.each_with_index do |word, i|
-          if %r{\Alint\:(ignore|endignore)}.match?(word)
+          if %r{\Alint:(ignore|endignore)}.match?(word)
             comment_data << word
           else
             # Once we reach the first non-controlcomment word, assume the rest
             # of the words are the reason.
-            reason = comment_words[i..-1]
+            reason = comment_words[i..]
             break
           end
         end
@@ -591,7 +600,7 @@ class PuppetLint::Data
             if top_override.nil?
               # TODO: refactor to provide a way to expose problems from
               # PuppetLint::Data via the normal problem reporting mechanism.
-              $stderr.puts "WARNING: lint:endignore comment with no opening lint:ignore:<check> comment found on line #{token.line}"
+              warn "WARNING: lint:endignore comment with no opening lint:ignore:<check> comment found on line #{token.line}"
             else
               top_override.each do |start|
                 next if start.nil?
@@ -607,7 +616,7 @@ class PuppetLint::Data
       end
 
       stack.each do |control|
-        $stderr.puts "WARNING: lint:ignore:#{control[0][2]} comment on line #{control[0][0]} with no closing lint:endignore comment"
+        warn "WARNING: lint:ignore:#{control[0][2]} comment on line #{control[0][0]} with no closing lint:endignore comment"
       end
     end
   end

data/lib/puppet-lint/lexer/string_slurper.rb

@@ -1,11 +1,10 @@
 require 'strscan'
 
+# rubocop:disable Style/ClassAndModuleChildren
 class PuppetLint::Lexer
   # Internal: A class for slurping strings from a Puppet manifest.
   class StringSlurper
-    attr_accessor :scanner
-    attr_accessor :results
-    attr_accessor :interp_stack
+    attr_accessor :scanner, :results, :interp_stack
 
     START_INTERP_PATTERN = %r{\$\{}.freeze
     END_INTERP_PATTERN = %r{\}}.freeze

data/lib/puppet-lint/lexer/token.rb

@@ -1,3 +1,4 @@
+# rubocop:disable Style/ClassAndModuleChildren
 class PuppetLint::Lexer
   # Public: Stores a fragment of the manifest and the information about its
   # location in the manifest.
@@ -175,12 +176,10 @@ class PuppetLint::Lexer
 
       token_iter = send("#{direction}_token".to_sym)
       until token_iter.nil?
-        if to_find.include?(token_iter.type)
-          return token_iter if opts[:value].nil? || token_iter.value == opts[:value]
-        end
+        return token_iter if to_find.include?(token_iter.type) && (opts[:value].nil? || token_iter.value == opts[:value])
 
-        opening_token = direction == :next ? 'L' : 'R'
-        closing_token = direction == :next ? 'R' : 'L'
+        opening_token = (direction == :next) ? 'L' : 'R'
+        closing_token = (direction == :next) ? 'R' : 'L'
 
         if opts[:skip_blocks]
           case token_iter.type
@@ -194,6 +193,7 @@ class PuppetLint::Lexer
         end
 
         return nil if token_iter.nil?
+
         token_iter = token_iter.send("#{direction}_token".to_sym)
       end
       nil
@@ -202,6 +202,7 @@ class PuppetLint::Lexer
     def interpolated_variable?
       return false if type == :TYPE && value != 'type'
       return true if type == :NAME
+
       PuppetLint::Lexer::KEYWORDS.include?(type.to_s.downcase)
     end
   end