puppet-lint 2.0.2 → 2.1.0

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

@@ -1,5 +1,7 @@
 # Public: Test the manifest tokens for any right-to-left (<-) chaining
 # operators and record a warning for each instance found.
+#
+# https://docs.puppet.com/guides/style_guide.html#chaining-arrow-syntax
 PuppetLint.new_check(:right_to_left_relationship) do
   def check
     tokens.select { |r| r.type == :OUT_EDGE }.each do |token|
@@ -15,6 +17,8 @@ end
 # Public: 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.
+#
+# https://docs.puppet.com/guides/style_guide.html#separate-files
 PuppetLint.new_check(:autoloader_layout) do
   def check
     unless fullpath.nil? || fullpath == ''
@@ -46,6 +50,8 @@ end
 
 # Public: 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.
+#
+# No style guide reference
 PuppetLint.new_check(:names_containing_dash) do
   def check
     (class_indexes + defined_type_indexes).each do |class_idx|
@@ -68,6 +74,8 @@ end
 
 # Public: Check the manifest tokens for any classes that inherit a params
 # subclass and record a warning for each instance found.
+#
+# No style guide reference
 PuppetLint.new_check(:class_inherits_from_params_class) do
   def check
     class_indexes.each do |class_idx|
@@ -88,17 +96,25 @@ PuppetLint.configuration.send('disable_class_inherits_from_params_class')
 # Public: 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.
+#
+# https://docs.puppet.com/guides/style_guide.html#display-order-of-parameters
 PuppetLint.new_check(:parameter_order) do
   def check
     (class_indexes + defined_type_indexes).each do |class_idx|
       unless class_idx[:param_tokens].nil?
         paren_stack = []
+        hash_or_array_stack = []
         class_idx[:param_tokens].each_with_index do |token, i|
           if token.type == :LPAREN
             paren_stack.push(true)
           elsif token.type == :RPAREN
             paren_stack.pop
+          elsif token.type == :LBRACE || token.type == :LBRACK
+            hash_or_array_stack.push(true)
+          elsif token.type == :RBRACE || token.type == :RBRACK
+            hash_or_array_stack.pop
           end
+          next if (! hash_or_array_stack.empty?)
           next unless paren_stack.empty?
 
           if token.type == :VARIABLE
@@ -124,6 +140,8 @@ end
 
 # Public: Test the manifest tokens for any classes that inherit across
 # namespaces and record a warning for each instance found.
+#
+# https://docs.puppet.com/guides/style_guide.html#class-inheritance
 PuppetLint.new_check(:inherits_across_namespaces) do
   def check
     class_indexes.each do |class_idx|
@@ -145,6 +163,8 @@ end
 
 # Public: Test the manifest tokens for any classes or defined types that are
 # defined inside another class.
+#
+# https://docs.puppet.com/guides/style_guide.html#nested-classes-or-defined-types
 PuppetLint.new_check(:nested_classes_or_defines) do
   TOKENS = Set[:CLASS, :DEFINE]
 
@@ -170,11 +190,63 @@ PuppetLint.new_check(:nested_classes_or_defines) do
   end
 end
 
+# Public: Find and warn about module names with illegal uppercase characters.
+#
+# https://docs.puppet.com/puppet/latest/reference/modules_fundamentals.html#allowed-module-names
+# Provides a fix. [puppet-lint #554]
+PuppetLint.new_check(:names_containing_uppercase) do
+  def check
+    (class_indexes + defined_type_indexes).each do |class_idx|
+      if class_idx[:name_token].value =~ /[A-Z]/
+        if class_idx[:type] == :CLASS
+          obj_type = 'class'
+        else
+          obj_type = 'defined type'
+        end
+
+        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],
+        }
+      end
+    end
+  end
+
+  def fix(problem)
+    problem[:token].value.downcase!
+  end
+end
+
+# Public: Test that no code is outside of a class or define scope.
+#
+# No style guide reference
+PuppetLint.new_check(:code_on_top_scope) do
+  def check
+    class_scope = (class_indexes + defined_type_indexes).map { |e| tokens[e[:start]..e[:end]] }.flatten
+    top_scope   = tokens - class_scope
+
+    top_scope.each do |token|
+      unless formatting_tokens.include? token.type
+        notify :warning, {
+          :message => "code outside of class or define block - #{token.value}",
+          :line    => token.line,
+          :column  => token.column
+        }
+      end
+    end
+  end
+end
+PuppetLint.configuration.send("disable_code_on_top_scope")
+
 # Public: 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.
+#
+# https://docs.puppet.com/guides/style_guide.html#namespacing-variables
 PuppetLint.new_check(:variable_scope) do
   DEFAULT_SCOPE_VARS = Set[
     'name',
@@ -287,3 +359,4 @@ PuppetLint.new_check(:variable_scope) do
     end
   end
 end
+

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

@@ -1,5 +1,7 @@
 # Public: Check the manifest tokens for any comments started with slashes
 # (//) and record a warning for each instance found.
+#
+# https://docs.puppet.com/guides/style_guide.html#comments
 PuppetLint.new_check(:slash_comments) do
   def check
     tokens.select { |token|
@@ -21,6 +23,8 @@ end
 
 # Public: Check the manifest tokens for any comments encapsulated with
 # slash-asterisks (/* */) and record a warning for each instance found.
+#
+# https://docs.puppet.com/guides/style_guide.html#comments
 PuppetLint.new_check(:star_comments) do
   def check
     tokens.select { |token|

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

@@ -1,5 +1,7 @@
 # Public: Test the manifest tokens for any selectors embedded within resource
 # declarations and record a warning for each instance found.
+#
+# https://docs.puppet.com/guides/style_guide.html#keep-resource-declarations-simple
 PuppetLint.new_check(:selector_inside_resource) do
   def check
     resource_indexes.each do |resource|
@@ -24,6 +26,8 @@ end
 
 # Public: Test the manifest tokens for any case statements that do not
 # contain a "default" case and record a warning for each instance found.
+#
+# https://docs.puppet.com/guides/style_guide.html#defaults-for-case-statements-and-selectors
 PuppetLint.new_check(:case_without_default) do
   def check
     case_indexes = []

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

@@ -1,6 +1,8 @@
 # Public: 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.
+#
+# https://docs.puppet.com/guides/style_guide.html#public-and-private
 PuppetLint.new_check(:documentation) do
   COMMENT_TOKENS = Set[:COMMENT, :MLCOMMENT, :SLASH_COMMENT]
   WHITESPACE_TOKENS = Set[:WHITESPACE, :NEWLINE, :INDENT]

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

@@ -1,5 +1,7 @@
 # Public: Check the manifest for unquoted node names and record a warning for
 # each instance found.
+#
+# No style guide reference
 PuppetLint.new_check(:unquoted_node_name) do
   def check
     node_tokens = tokens.select { |token| token.type == :NODE }

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

@@ -1,5 +1,7 @@
 # Public: Check the manifest tokens for any resource titles / namevars that
 # are not quoted and record a warning for each instance found.
+#
+# https://docs.puppet.com/guides/style_guide.html#resource-names
 PuppetLint.new_check(:unquoted_resource_title) do
   def check
     title_tokens.each do |token|
@@ -22,6 +24,8 @@ end
 # Public: 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.
+#
+# https://docs.puppet.com/guides/style_guide.html#attribute-ordering
 PuppetLint.new_check(:ensure_first_param) do
   def check
     resource_indexes.each do |resource|
@@ -34,18 +38,85 @@ PuppetLint.new_check(:ensure_first_param) do
         if ensure_attr_index > 0
           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,
+            :message  => "ensure found on line but it's not the first attribute",
+            :line     => ensure_token.line,
+            :column   => ensure_token.column,
+            :resource => resource,
           }
         end
       end
     end
   end
+  def fix(problem)
+    # We find the first and ensure paramss boundaries
+    first_param_name_token = nil
+    first_param_name_idx = nil
+    first_param_comma_token = nil
+    first_param_comma_idx = nil
+    ensure_param_name_token = nil
+    ensure_param_name_idx = nil
+    ensure_param_comma_token = nil
+    ensure_param_comma_idx = nil
+    tokens[(problem[:resource][:start])..(problem[:resource][:end])].each_with_index do |token, token_idx|
+      if first_param_name_token.nil?
+        if token.type == :NAME
+          first_param_name_token = token
+          first_param_name_idx = problem[:resource][:start] + token_idx
+        end
+      elsif first_param_comma_token.nil?
+        if token.type == :COMMA
+          first_param_comma_token = token
+          first_param_comma_idx = problem[:resource][:start] + token_idx
+        end
+      elsif ensure_param_name_token.nil?
+        if token.type == :NAME and token.value == 'ensure'
+          ensure_param_name_token = token
+          ensure_param_name_idx = problem[:resource][:start] + token_idx
+        end
+      elsif ensure_param_comma_token.nil?
+        if token.type == :COMMA or token.type == :SEMIC
+          ensure_param_comma_token = token
+          ensure_param_comma_idx = problem[:resource][:start] + token_idx
+          break
+        end
+      end
+    end
+    if first_param_name_token.nil? or first_param_comma_token.nil? or ensure_param_name_token.nil? or ensure_param_comma_token.nil?
+      raise PuppetLint::NoFix
+    end
+    # Flip params
+    prev_token = first_param_name_token.prev_token
+    first_param_name_token.prev_token = ensure_param_name_token.prev_token
+    ensure_param_name_token.prev_token = prev_token
+
+    prev_code_token = first_param_name_token.prev_code_token
+    first_param_name_token.prev_code_token = ensure_param_name_token.prev_code_token
+    ensure_param_name_token.prev_code_token = prev_code_token
+
+    next_token = first_param_comma_token.next_token
+    first_param_comma_token = ensure_param_comma_token.next_token
+    ensure_param_comma_token.next_token = next_token
+
+    next_code_token = first_param_comma_token.next_code_token
+    first_param_comma_code_token = ensure_param_comma_token.next_code_token
+    ensure_param_comma_token.next_code_token = next_code_token
+
+    # Update index
+    ensure_tmp = tokens.slice!(ensure_param_name_idx..ensure_param_comma_idx-1)
+    first_tmp = tokens.slice!(first_param_name_idx..first_param_comma_idx-1)
+    ensure_tmp.reverse_each do |item|
+      tokens.insert(first_param_name_idx, item)
+    end
+    first_tmp.reverse_each do |item|
+      tokens.insert(ensure_param_name_idx + ensure_tmp.length - first_tmp.length, item)
+    end
+  end
 end
 
 # Public: Check the tokens of each resource instance for any duplicate
 # parameters and record a warning for each instance found.
+#
+# No style guide reference
 PuppetLint.new_check(:duplicate_params) do
   def check
     resource_indexes.each do |resource|
@@ -83,6 +154,8 @@ end
 # Public: 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.
+#
+# https://docs.puppet.com/guides/style_guide.html#file-modes
 PuppetLint.new_check(:unquoted_file_mode) do
   TOKEN_TYPES = Set[:NAME, :NUMBER]
 
@@ -113,6 +186,8 @@ end
 # Public: 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').
+#
+# https://docs.puppet.com/guides/style_guide.html#file-modes
 PuppetLint.new_check(:file_mode) do
   MSG = 'mode should be represented as a 4 digit octal value or symbolic mode'
   SYM_RE = "([ugoa]*[-=+][-=+rstwxXugo]*)(,[ugoa]*[-=+][-=+rstwxXugo]*)*"
@@ -154,6 +229,8 @@ end
 # Public: 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 '/').
+#
+# https://docs.puppet.com/guides/style_guide.html#symbolic-links
 PuppetLint.new_check(:ensure_not_symlink_target) do
   def check
     resource_indexes.each do |resource|

data/lib/puppet-lint/plugins/check_strings.rb

@@ -1,6 +1,8 @@
 # Public: Check the manifest tokens for any double quoted strings that don't
 # contain any variables or common escape characters and record a warning for
 # each instance found.
+#
+# https://docs.puppet.com/guides/style_guide.html#quoting
 PuppetLint.new_check(:double_quoted_strings) do
   def check
     tokens.select { |token|
@@ -26,6 +28,8 @@ end
 
 # Public: Check the manifest tokens for double quoted strings that contain
 # a single variable only and record a warning for each instance found.
+#
+# https://docs.puppet.com/guides/style_guide.html#quoting
 PuppetLint.new_check(:only_variable_string) do
   VAR_TYPES = Set[:VARIABLE, :UNENC_VARIABLE]
 
@@ -89,6 +93,8 @@ end
 # Public: Check the manifest tokens for any variables in a string that have
 # not been enclosed by braces ({}) and record a warning for each instance
 # found.
+#
+# https://docs.puppet.com/guides/style_guide.html#quoting
 PuppetLint.new_check(:variables_not_enclosed) do
   def check
     tokens.select { |r|
@@ -110,10 +116,12 @@ end
 
 # Public: Check the manifest tokens for any single quoted strings containing
 # a enclosed variable and record an error for each instance found.
+#
+# https://docs.puppet.com/guides/style_guide.html#quoting
 PuppetLint.new_check(:single_quote_string_with_variables) do
   def check
     tokens.select { |r|
-      r.type == :SSTRING && r.value.include?('${')
+      r.type == :SSTRING && r.value.include?('${') && (! r.prev_token.prev_token.value.match(%r{inline_(epp|template)}) )
     }.each do |token|
       notify :error, {
         :message => 'single quoted string containing a variable found',
@@ -127,6 +135,8 @@ end
 # Public: Check the manifest tokens for any double or single quoted strings
 # containing only a boolean value and record a warning for each instance
 # found.
+#
+# No style guide reference
 PuppetLint.new_check(:quoted_booleans) do
   STRING_TYPES = Set[:STRING, :SSTRING]
   BOOLEANS = Set['true', 'false']
@@ -152,6 +162,8 @@ end
 # Public: Check the manifest tokens for any puppet:// URL strings where the
 # path section doesn't start with modules/ and record a warning for each
 # instance found.
+#
+# No style guide reference
 PuppetLint.new_check(:puppet_url_without_modules) do
   def check
     tokens.select { |token|

data/lib/puppet-lint/plugins/check_variables.rb

@@ -1,5 +1,7 @@
 # Public: Test the manifest tokens for variables that contain a dash and
 # record a warning for each instance found.
+#
+# No style guide reference
 PuppetLint.new_check(:variable_contains_dash) do
   VARIABLE_DASH_TYPES = Set[:VARIABLE, :UNENC_VARIABLE]
 
@@ -18,6 +20,10 @@ PuppetLint.new_check(:variable_contains_dash) do
   end
 end
 
+# Public: Test the manifest tokens for variables that contain an uppercase
+# letter and record a warning for each instance found.
+#
+# No style guide reference
 PuppetLint.new_check(:variable_is_lowercase) do
   VARIABLE_LOWERCASE_TYPES = Set[:VARIABLE, :UNENC_VARIABLE]
 

data/lib/puppet-lint/plugins/check_whitespace.rb

@@ -1,5 +1,7 @@
 # Public: Check the raw manifest string for lines containing hard tab
 # characters and record an error for each instance found.
+#
+# https://docs.puppet.com/guides/style_guide.html#spacing-indentation-and-whitespace
 PuppetLint.new_check(:hard_tabs) do
   WHITESPACE_TYPES = Set[:INDENT, :WHITESPACE]
 
@@ -23,6 +25,8 @@ end
 
 # Public: Check the manifest tokens for lines ending with whitespace and record
 # an error for each instance found.
+#
+# https://docs.puppet.com/guides/style_guide.html#spacing-indentation-and-whitespace
 PuppetLint.new_check(:trailing_whitespace) do
   def check
     tokens.select { |token|
@@ -52,6 +56,8 @@ end
 # characters and record a warning for each instance found.  The only exceptions
 # to this rule are lines containing URLs and template() calls which would hurt
 # readability if split.
+#
+# https://docs.puppet.com/guides/style_guide.html#spacing-indentation-and-whitespace
 PuppetLint.new_check(:'140chars') do
   def check
     manifest_lines.each_with_index do |line, idx|
@@ -71,6 +77,8 @@ end
 # Public: Test the raw manifest string for lines containing more than 80
 # characters. This is DISABLED by default and behaves like the default
 # 140chars check by excepting URLs and template() calls.
+#
+# https://docs.puppet.com/guides/style_guide.html#spacing-indentation-and-whitespace (older version)
 PuppetLint.new_check(:'80chars') do
   def check
     manifest_lines.each_with_index do |line, idx|
@@ -90,6 +98,8 @@ PuppetLint.configuration.send("disable_80chars")
 
 # Public: Check the manifest tokens for any indentation not using 2 space soft
 # tabs and record an error for each instance found.
+#
+# https://docs.puppet.com/guides/style_guide.html#spacing-indentation-and-whitespace
 PuppetLint.new_check(:'2sp_soft_tabs') do
   def check
     tokens.select { |r|
@@ -108,6 +118,8 @@ end
 
 # Public: Check the manifest tokens for any arrows (=>) in a grouping ({}) that
 # are not aligned with other arrows in that grouping.
+#
+# https://docs.puppet.com/guides/style_guide.html#spacing-indentation-and-whitespace
 PuppetLint.new_check(:arrow_alignment) do
   COMMENT_TYPES = Set[:COMMENT, :SLASH_COMMENT, :MLCOMMENT]