puppet-lint 2.5.2 → 3.0.0

data/lib/puppet-lint/monkeypatches.rb

@@ -1,5 +1,5 @@
 begin
-  '%{test}' % { :test => 'replaced' } == 'replaced' # rubocop:disable Style/FormatString
+  '%{test}' % { test: 'replaced' } == 'replaced'
 rescue
   # monkeypatch String#% into Ruby 1.8.7
   class String

data/lib/puppet-lint/optparser.rb

@@ -48,7 +48,7 @@ class PuppetLint::OptParser
       opts.on(
         '--error-level LEVEL',
         [:all, :warning, :error],
-        'The level of error to return (warning, error or all).'
+        'The level of error to return (warning, error or all).',
       ) do |el|
         PuppetLint.configuration.error_level = el
       end
@@ -98,6 +98,10 @@ class PuppetLint::OptParser
         PuppetLint.configuration.json = true
       end
 
+      opts.on('--sarif', 'Log output as SARIF') do
+        PuppetLint.configuration.sarif = true
+      end
+
       opts.on('--list-checks', 'List available check names.') do
         PuppetLint.configuration.list_checks = true
       end

data/lib/puppet-lint/plugins/check_classes/arrow_on_right_operand_line.rb

@@ -9,10 +9,12 @@ PuppetLint.new_check(:arrow_on_right_operand_line) do
 
       notify(
         :warning,
-        :message => "arrow should be on the right operand's line",
-        :line    => token.line,
-        :column  => token.column,
-        :token   => token
+        message: "arrow should be on the right operand's line",
+        line: token.line,
+        column: token.column,
+        token: token,
+        description: 'Test the manifest tokens for chaining arrow that is on the line of the left operand when the right operand is on another line.',
+        help_uri: 'https://puppet.com/docs/puppet/latest/style_guide.html#chaining-arrow-syntax',
       )
     end
   end

data/lib/puppet-lint/plugins/check_classes/autoloader_layout.rb

@@ -25,9 +25,11 @@ PuppetLint.new_check(:autoloader_layout) do
 
       notify(
         :error,
-        :message => "#{title_token.value} not in autoload module layout",
-        :line    => title_token.line,
-        :column  => title_token.column
+        message: "#{title_token.value} not in autoload module layout",
+        line: title_token.line,
+        column: title_token.column,
+        description: 'Test the manifest tokens for any classes or defined types that are not in an appropriately named file for the autoloader to detect and record an error of each instance found.',
+        help_uri: 'https://puppet.com/docs/puppet/latest/style_guide.html#separate-files',
       )
     end
   end

data/lib/puppet-lint/plugins/check_classes/class_inherits_from_params_class.rb

@@ -5,13 +5,15 @@
 PuppetLint.new_check(:class_inherits_from_params_class) do
   def check
     class_indexes.each do |class_idx|
-      next unless class_idx[:inherited_token] && class_idx[:inherited_token].value.end_with?('::params')
+      next unless class_idx[:inherited_token] && class_idx[:inherited_token]&.value&.end_with?('::params')
 
       notify(
         :warning,
-        :message => 'class inheriting from params class',
-        :line    => class_idx[:inherited_token].line,
-        :column  => class_idx[:inherited_token].column
+        message: 'class inheriting from params class',
+        line: class_idx[:inherited_token].line,
+        column: class_idx[:inherited_token].column,
+        description: 'Check the manifest tokens for any classes that inherit a params subclass and record a warning for each instance found.',
+        help_uri: nil,
       )
     end
   end

data/lib/puppet-lint/plugins/check_classes/code_on_top_scope.rb

@@ -11,9 +11,11 @@ PuppetLint.new_check(:code_on_top_scope) do
 
       notify(
         :warning,
-        :message => "code outside of class or define block - #{token.value}",
-        :line    => token.line,
-        :column  => token.column
+        message: "code outside of class or define block - #{token.value}",
+        line: token.line,
+        column: token.column,
+        description: 'Test that no code is outside of a class or define scope.',
+        help_uri: nil,
       )
     end
   end

data/lib/puppet-lint/plugins/check_classes/inherits_across_namespaces.rb

@@ -14,9 +14,11 @@ PuppetLint.new_check(:inherits_across_namespaces) do
 
       notify(
         :warning,
-        :message => 'class inherits across module namespaces',
-        :line    => class_idx[:inherited_token].line,
-        :column  => class_idx[:inherited_token].column
+        message: 'class inherits across module namespaces',
+        line: class_idx[:inherited_token].line,
+        column: class_idx[:inherited_token].column,
+        description: 'Test the manifest tokens for any classes that inherit across namespaces and record a warning for each instance found.',
+        help_uri: 'https://puppet.com/docs/puppet/latest/style_guide.html#class-inheritance',
       )
     end
   end

data/lib/puppet-lint/plugins/check_classes/names_containing_dash.rb

@@ -15,9 +15,11 @@ PuppetLint.new_check(:names_containing_dash) do
 
       notify(
         :error,
-        :message => "#{obj_type} name containing a dash",
-        :line    => class_idx[:name_token].line,
-        :column  => class_idx[:name_token].column
+        message: "#{obj_type} name containing a dash",
+        line: class_idx[:name_token].line,
+        column: class_idx[:name_token].column,
+        description: 'Check the manifest tokens for any classes or defined types that have a dash in their name and record an error for each instance found.',
+        help_uri: nil,
       )
     end
   end

data/lib/puppet-lint/plugins/check_classes/names_containing_uppercase.rb

@@ -5,7 +5,7 @@
 PuppetLint.new_check(:names_containing_uppercase) do
   def check
     (class_indexes + defined_type_indexes).each do |class_idx|
-      next unless class_idx[:name_token].value =~ %r{[A-Z]}
+      next unless %r{[A-Z]}.match?(class_idx[:name_token].value)
 
       obj_type = if class_idx[:type] == :CLASS
                    'class'
@@ -15,10 +15,12 @@ PuppetLint.new_check(:names_containing_uppercase) do
 
       notify(
         :error,
-        :message => "#{obj_type} '#{class_idx[:name_token].value}' contains illegal uppercase",
-        :line    => class_idx[:name_token].line,
-        :column  => class_idx[:name_token].column,
-        :token   => class_idx[:name_token]
+        message: "#{obj_type} '#{class_idx[:name_token].value}' contains illegal uppercase",
+        line: class_idx[:name_token].line,
+        column: class_idx[:name_token].column,
+        token: class_idx[:name_token],
+        description: 'Find and warn about module names with illegal uppercase characters.',
+        help_uri: 'https://puppet.com/docs/puppet/latest/modules_fundamentals.html#allowed-module-names',
       )
     end
   end

data/lib/puppet-lint/plugins/check_classes/nested_classes_or_defines.rb

@@ -17,9 +17,11 @@ PuppetLint.new_check(:nested_classes_or_defines) do
 
         notify(
           :warning,
-          :message => "#{type} defined inside a class",
-          :line    => token.line,
-          :column  => token.column
+          message: "#{type} defined inside a class",
+          line: token.line,
+          column: token.column,
+          description: 'Test the manifest tokens for any classes or defined types that are defined inside another class.',
+          help_uri: 'https://puppet.com/docs/puppet/latest/style_guide.html#nested-classes-or-defined-types',
         )
       end
     end

data/lib/puppet-lint/plugins/check_classes/parameter_order.rb

@@ -31,9 +31,12 @@ PuppetLint.new_check(:parameter_order) do
         msg = 'optional parameter listed before required parameter'
         notify(
           :warning,
-          :message => msg,
-          :line    => token.line,
-          :column  => token.column
+          message: msg,
+          line: token.line,
+          column: token.column,
+          description: 'Test the manifest tokens for any parameterised classes or defined types that take '\
+            'parameters and record a warning if there are any optional parameters listed before required parameters.',
+          help_uri: 'https://puppet.com/docs/puppet/latest/style_guide.html#display-order-of-parameters',
         )
       end
     end
@@ -52,7 +55,7 @@ PuppetLint.new_check(:parameter_order) do
   end
 
   def required_parameter?(token)
-    data_type = token.prev_token_of(:TYPE, :skip_blocks => true)
+    data_type = token.prev_token_of(:TYPE, skip_blocks: true)
     return false if data_type && data_type.value == 'Optional'
 
     if token.next_code_token.nil? || [:COMMA, :RPAREN].include?(token.next_code_token.type)

data/lib/puppet-lint/plugins/check_classes/right_to_left_relationship.rb

@@ -7,9 +7,11 @@ PuppetLint.new_check(:right_to_left_relationship) do
     tokens.select { |r| r.type == :OUT_EDGE }.each do |token|
       notify(
         :warning,
-        :message =>  'right-to-left (<-) relationship',
-        :line    => token.line,
-        :column  => token.column
+        message: 'right-to-left (<-) relationship',
+        line: token.line,
+        column: token.column,
+        description: 'Test the manifest tokens for any right-to-left (<-) chaining operators and record a warning for each instance found.',
+        help_uri: 'https://puppet.com/docs/puppet/latest/style_guide.html#chaining-arrow-syntax',
       )
     end
   end

data/lib/puppet-lint/plugins/check_classes/variable_scope.rb

@@ -41,13 +41,11 @@ PuppetLint.new_check(:variable_scope) do
       referenced_variables = Set[]
       object_tokens = idx[:tokens]
 
-      unless idx[:param_tokens].nil?
-        idx[:param_tokens].each do |token|
-          next unless token.type == :VARIABLE
-          next unless POST_VAR_TOKENS.include?(token.next_code_token.type)
+      idx[:param_tokens]&.each do |token|
+        next unless token.type == :VARIABLE
+        next unless POST_VAR_TOKENS.include?(token.next_code_token.type)
 
-          variables_in_scope << token.value
-        end
+        variables_in_scope << token.value
       end
 
       future_parser_scopes = {}
@@ -63,7 +61,7 @@ PuppetLint.new_check(:variable_scope) do
             temp_token = token
 
             brack_depth = 0
-            while temp_token = temp_token.prev_code_token
+            while (temp_token = temp_token.prev_code_token)
               case temp_token.type
               when :VARIABLE
                 variables_in_scope << temp_token.value
@@ -72,7 +70,7 @@ PuppetLint.new_check(:variable_scope) do
               when :LBRACK
                 brack_depth -= 1
                 break if brack_depth.zero?
-              when :COMMA # rubocop:disable Lint/EmptyWhen
+              when :COMMA
                 # ignore
               else # unexpected
                 break
@@ -124,15 +122,19 @@ PuppetLint.new_check(:variable_scope) do
         end
 
         next if token.value.include?('::')
-        next if token.value =~ %r{^(facts|trusted)\[.+\]}
+        next if %r{^(facts|trusted)\[.+\]}.match?(token.value)
         next if variables_in_scope.include?(token.value.gsub(%r{\[.+\]\Z}, ''))
-        next if token.value =~ %r{\A\d+\Z}
+        next if %r{\A\d+\Z}.match?(token.value)
 
         notify(
           :warning,
-          :message => msg,
-          :line    => token.line,
-          :column  => token.column
+          message: msg,
+          line: token.line,
+          column: token.column,
+          description: 'Test the manifest tokens for any variables that are referenced in the manifest. ' \
+                          'If the variables are not fully qualified or one of the variables automatically created in the scope, ' \
+                          'check that they have been defined in the local scope and record a warning for each variable that has not.',
+          help_uri: 'https://puppet.com/docs/puppet/latest/style_guide.html#namespacing-variables',
         )
       end
     end

data/lib/puppet-lint/plugins/check_comments/slash_comments.rb

@@ -4,15 +4,17 @@
 # https://puppet.com/docs/puppet/latest/style_guide.html#comments
 PuppetLint.new_check(:slash_comments) do
   def check
-    tokens.select { |token|
-      token.type == :SLASH_COMMENT
-    }.each do |token|
+    invalid_tokens = tokens.select { |token| token.type == :SLASH_COMMENT }
+
+    invalid_tokens.each do |token|
       notify(
         :warning,
-        :message => '// comment found',
-        :line    => token.line,
-        :column  => token.column,
-        :token   => token
+        message: '// comment found',
+        line: token.line,
+        column: token.column,
+        token: token,
+        description: 'Check the manifest tokens for any comments started with slashes (//) and record a warning for each instance found.',
+        help_uri: 'https://puppet.com/docs/puppet/latest/style_guide.html#comments',
       )
     end
   end

data/lib/puppet-lint/plugins/check_comments/star_comments.rb

@@ -4,15 +4,17 @@
 # https://puppet.com/docs/puppet/latest/style_guide.html#comments
 PuppetLint.new_check(:star_comments) do
   def check
-    tokens.select { |token|
-      token.type == :MLCOMMENT
-    }.each do |token|
+    invalid_tokens = tokens.select { |token| token.type == :MLCOMMENT }
+
+    invalid_tokens.each do |token|
       notify(
         :warning,
-        :message => '/* */ comment found',
-        :line    => token.line,
-        :column  => token.column,
-        :token   => token
+        message: '/* */ comment found',
+        line: token.line,
+        column: token.column,
+        token: token,
+        description: 'Check the manifest tokens for any comments encapsulated with slash-asterisks (/* */) and record a warning for each instance found.',
+        help_uri: 'https://puppet.com/docs/puppet/latest/style_guide.html#comments',
       )
     end
   end
@@ -25,7 +27,7 @@ PuppetLint.new_check(:star_comments) do
     problem[:token].value = " #{first_line}"
 
     index = tokens.index(problem[:token].next_token) || 1
-    comment_lines.reverse.each do |line|
+    comment_lines.reverse_each do |line|
       indent = problem[:token].prev_token.nil? ? nil : problem[:token].prev_token.value.dup
       add_token(index, PuppetLint::Lexer::Token.new(:COMMENT, " #{line}", 0, 0))
       add_token(index, PuppetLint::Lexer::Token.new(:INDENT, indent, 0, 0)) if indent

data/lib/puppet-lint/plugins/check_conditionals/case_without_default.rb

@@ -17,7 +17,7 @@ PuppetLint.new_check(:case_without_default) do
         elsif tokens[idx].type == :RBRACE
           depth -= 1
           if depth.zero?
-            case_indexes << { :start => token_idx, :end => idx }
+            case_indexes << { start: token_idx, end: idx }
             break
           end
         end
@@ -49,9 +49,11 @@ PuppetLint.new_check(:case_without_default) do
 
       notify(
         :warning,
-        :message => 'case statement without a default case',
-        :line    => case_tokens.first.line,
-        :column  => case_tokens.first.column
+        message: 'case statement without a default case',
+        line: case_tokens.first.line,
+        column: case_tokens.first.column,
+        description: 'Test the manifest tokens for any case statements that do not contain a "default" case and record a warning for each instance found.',
+        help_uri: 'https://puppet.com/docs/puppet/latest/style_guide.html#defaults-for-case-statements-and-selectors',
       )
     end
   end

data/lib/puppet-lint/plugins/check_conditionals/selector_inside_resource.rb

@@ -12,9 +12,11 @@ PuppetLint.new_check(:selector_inside_resource) do
 
         notify(
           :warning,
-          :message => 'selector inside resource block',
-          :line    => token.line,
-          :column  => token.column
+          message: 'selector inside resource block',
+          line: token.line,
+          column: token.column,
+          description: 'Test the manifest tokens for any selectors embedded within resource declarations and record a warning for each instance found.',
+          help_uri: 'https://puppet.com/docs/puppet/latest/style_guide.html#keep-resource-declarations-simple',
         )
       end
     end

data/lib/puppet-lint/plugins/check_documentation/documentation.rb

@@ -22,9 +22,13 @@ PuppetLint.new_check(:documentation) do
 
       notify(
         :warning,
-        :message => "#{type} not documented",
-        :line    => first_token.line,
-        :column  => first_token.column
+        message: "#{type} not documented",
+        line: first_token.line,
+        column: first_token.column,
+        description: 'Check the manifest tokens for any class or defined type that does not '\
+          'have a comment directly above it (hopefully, explaining the usage of it) and record '\
+          'a warning for each instance found.',
+        help_uri: 'https://puppet.com/docs/puppet/latest/style_guide.html#public-and-private',
       )
     end
   end

data/lib/puppet-lint/plugins/check_nodes/unquoted_node_name.rb

@@ -11,25 +11,29 @@ PuppetLint.new_check(:unquoted_node_name) do
       if node_lbrace_tok.nil?
         notify(
           :error,
-          :check    => :syntax,
-          :message  => 'Syntax error (try running `puppet parser validate <file>`)',
-          :line     => node.line,
-          :column   => node.column
+          check: :syntax,
+          message: 'Syntax error (try running `puppet parser validate <file>`)',
+          line: node.line,
+          column: node.column,
+          description: 'Check for any syntax error and record an error of each instance found.',
+          help_uri: nil,
         )
         next
       end
 
       node_lbrace_idx = tokens.index(node_lbrace_tok)
 
-      tokens[node_token_idx..node_lbrace_idx].select { |token|
-        token.type == :NAME && token.value != 'default'
-      }.each do |token|
+      invalid_tokens = tokens[node_token_idx..node_lbrace_idx].select { |token| token.type == :NAME && token.value != 'default' }
+
+      invalid_tokens.each do |token|
         notify(
           :warning,
-          :message => 'unquoted node name found',
-          :line    => token.line,
-          :column  => token.column,
-          :token   => token
+          message: 'unquoted node name found',
+          line: token.line,
+          column: token.column,
+          token: token,
+          description: 'Check the manifest for unquoted node names and record a warning for each instance found.',
+          help_uri: nil,
         )
       end
     end

data/lib/puppet-lint/plugins/check_resources/duplicate_params.rb

@@ -24,9 +24,11 @@ PuppetLint.new_check(:duplicate_params) do
           if (seen_params[level] ||= Set.new).include?(prev_token.value)
             notify(
               :error,
-              :message => 'duplicate parameter found in resource',
-              :line    => prev_token.line,
-              :column  => prev_token.column
+              message: 'duplicate parameter found in resource',
+              line: prev_token.line,
+              column: prev_token.column,
+              description: 'Check the tokens of each resource instance for any duplicate parameters and record a warning for each instance found.',
+              help_uri: nil,
             )
           else
             seen_params[level] << prev_token.value

data/lib/puppet-lint/plugins/check_resources/ensure_first_param.rb

@@ -17,10 +17,13 @@ PuppetLint.new_check(:ensure_first_param) do
       ensure_token = resource[:param_tokens][ensure_attr_index]
       notify(
         :warning,
-        :message  => "ensure found on line but it's not the first attribute",
-        :line     => ensure_token.line,
-        :column   => ensure_token.column,
-        :resource => resource
+        message: "ensure found on line but it's not the first attribute",
+        line: ensure_token.line,
+        column: ensure_token.column,
+        resource: resource,
+        description: 'Check the tokens of each resource instance for an ensure parameter and if '\
+          'found, check that it is the first parameter listed.  If it is not the first parameter, record a warning.',
+        help_uri: 'https://puppet.com/docs/puppet/latest/style_guide.html#attribute-ordering',
       )
     end
   end
@@ -28,7 +31,7 @@ PuppetLint.new_check(:ensure_first_param) do
   def fix(problem)
     first_param_name_token = problem[:resource][:param_tokens].first
     first_param_comma_token = first_param_name_token.next_token_of(:COMMA)
-    ensure_param_name_token = first_param_comma_token.next_token_of(:NAME, :value => 'ensure')
+    ensure_param_name_token = first_param_comma_token.next_token_of(:NAME, value: 'ensure')
 
     raise PuppetLint::NoFix if ensure_param_name_token.nil?
 

data/lib/puppet-lint/plugins/check_resources/ensure_not_symlink_target.rb

@@ -8,19 +8,22 @@ PuppetLint.new_check(:ensure_not_symlink_target) do
     resource_indexes.each do |resource|
       next unless resource[:type].value == 'file'
 
-      resource[:param_tokens].select { |param_token|
-        param_token.value == 'ensure'
-      }.each do |ensure_token|
+      resources = resource[:param_tokens].select { |param_token| param_token.value == 'ensure' }
+
+      resources.each do |ensure_token|
         value_token = ensure_token.next_code_token.next_code_token
         next unless value_token.value.start_with?('/')
 
         notify(
           :warning,
-          :message     => 'symlink target specified in ensure attr',
-          :line        => value_token.line,
-          :column      => value_token.column,
-          :param_token => ensure_token,
-          :value_token => value_token
+          message: 'symlink target specified in ensure attr',
+          line: value_token.line,
+          column: value_token.column,
+          param_token: ensure_token,
+          value_token: value_token,
+          description: 'Check the tokens of each File resource instance for an ensure parameter and '\
+            'record a warning if the value of that parameter looks like a symlink target (starts with a \'/\').',
+          help_uri: 'https://puppet.com/docs/puppet/latest/style_guide.html#symbolic-links',
         )
       end
     end

data/lib/puppet-lint/plugins/check_resources/file_mode.rb

@@ -7,33 +7,38 @@ PuppetLint.new_check(:file_mode) do
   MSG = 'mode should be represented as a 4 digit octal value or symbolic mode'.freeze
   SYM_RE = '([ugoa]*[-=+][-=+rstwxXugo]*)(,[ugoa]*[-=+][-=+rstwxXugo]*)*'.freeze
   IGNORE_TYPES = Set[:VARIABLE, :UNDEF, :FUNCTION_NAME]
-  MODE_RE = %r{\A([0-7]{4}|#{SYM_RE})\Z}
+  MODE_RE = %r{\A([0-7]{4}|#{SYM_RE})\Z}.freeze
 
   def check
     resource_indexes.each do |resource|
       next unless resource[:type].value == 'file' || resource[:type].value == 'concat'
 
-      resource[:param_tokens].select { |param_token|
+      resources = resource[:param_tokens].select do |param_token|
         param_token.value == 'mode'
-      }.each do |param_token|
+      end
+
+      resources.each do |param_token|
         value_token = param_token.next_code_token.next_code_token
 
         break if IGNORE_TYPES.include?(value_token.type)
-        break if value_token.value =~ MODE_RE
+        break if MODE_RE.match?(value_token.value)
 
         notify(
           :warning,
-          :message => MSG,
-          :line    => value_token.line,
-          :column  => value_token.column,
-          :token   => value_token
+          message: MSG,
+          line: value_token.line,
+          column: value_token.column,
+          token: value_token,
+          description: 'Check the tokens of each File resource instance for a mode parameter and if found, ' \
+                          'record a warning if the value of that parameter is not a 4 digit octal value (0755) or a symbolic mode (\'o=rwx,g\+r\').',
+          help_uri: 'https://puppet.com/docs/puppet/latest/style_guide.html#file-modes',
         )
       end
     end
   end
 
   def fix(problem)
-    raise PuppetLint::NoFix unless problem[:token].value =~ %r{\A[0-7]{3}\Z}
+    raise PuppetLint::NoFix unless %r{\A[0-7]{3}\Z}.match?(problem[:token].value)
 
     problem[:token].type = :SSTRING
     problem[:token].value = "0#{problem[:token].value}"

data/lib/puppet-lint/plugins/check_resources/unquoted_file_mode.rb

@@ -10,17 +10,22 @@ PuppetLint.new_check(:unquoted_file_mode) do
     resource_indexes.each do |resource|
       next unless resource[:type].value == 'file' || resource[:type].value == 'concat'
 
-      resource[:param_tokens].select { |param_token|
+      resources = resource[:param_tokens].select do |param_token|
         param_token.value == 'mode' &&
           TOKEN_TYPES.include?(param_token.next_code_token.next_code_token.type)
-      }.each do |param_token|
+      end
+
+      resources.each do |param_token|
         value_token = param_token.next_code_token.next_code_token
         notify(
           :warning,
-          :message => 'unquoted file mode',
-          :line    => value_token.line,
-          :column  => value_token.column,
-          :token   => value_token
+          message: 'unquoted file mode',
+          line: value_token.line,
+          column: value_token.column,
+          token: value_token,
+          description: 'Check the tokens of each File resource instance for a mode parameter '\
+            'and if found, record a warning if the value of that parameter is not a quoted string.',
+          help_uri: 'https://puppet.com/docs/puppet/latest/style_guide.html#file-modes',
         )
       end
     end

data/lib/puppet-lint/plugins/check_resources/unquoted_resource_title.rb

@@ -9,10 +9,12 @@ PuppetLint.new_check(:unquoted_resource_title) do
 
       notify(
         :warning,
-        :message => 'unquoted resource title',
-        :line    => token.line,
-        :column  => token.column,
-        :token   => token
+        message: 'unquoted resource title',
+        line: token.line,
+        column: token.column,
+        token: token,
+        description: 'Check the manifest tokens for any resource titles / namevars that are not quoted and record a warning for each instance found.',
+        help_uri: 'https://puppet.com/docs/puppet/latest/style_guide.html#resource-names',
       )
     end
   end