puppet-lint 0.1.9 → 0.1.10

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

@@ -1,50 +1,47 @@
 class PuppetLint::Plugins::CheckClasses < PuppetLint::CheckPlugin
-  def test(path, data)
-    lexer = Puppet::Parser::Lexer.new
-    lexer.string = data
-    tokens = lexer.fullscan
-
+  check 'right_to_left_relationship' do
     tokens.select { |r| r.first == :OUT_EDGE }.each do |token|
-      warn "right-to-left (<-) relationship on line #{token.last[:line]}"
+      notify :warning, :message =>  "right-to-left (<-) relationship", :linenumber => token.last[:line]
     end
+  end
 
-    class_indexes = []
-    defined_type_indexes = []
-    tokens.each_index do |token_idx|
-      if [:DEFINE, :CLASS].include? tokens[token_idx].first
-        header_end_idx = tokens[token_idx..-1].index { |r| r.first == :LBRACE }
-        lparen_idx = tokens[token_idx..(header_end_idx + token_idx)].index { |r| r.first == :LPAREN }
-        rparen_idx = tokens[token_idx..(header_end_idx + token_idx)].rindex { |r| r.first == :RPAREN }
-
-        unless path == ""
-          title_token = tokens[token_idx+1]
-          if [:CLASSNAME, :NAME].include? title_token.first
-            split_title = title_token.last[:value].split('::')
-            if split_title.length > 1
-              expected_path = "#{split_title.first}/manifests/#{split_title[1..-1].join('/')}.pp"
-            else
-              expected_path = "#{title_token.last[:value]}/manifests/init.pp"
-            end
+  check 'autoloader_layout' do
+    unless path == ""
+      (class_indexes + defined_type_indexes).each do |class_idx|
+        title_token = tokens[class_idx[:start]+1]
+        split_title = title_token.last[:value].split('::')
+        if split_title.length > 1
+          expected_path = "#{split_title.first}/manifests/#{split_title[1..-1].join('/')}.pp"
+        else
+          expected_path = "#{title_token.last[:value]}/manifests/init.pp"
+        end
 
-            unless path.end_with? expected_path
-              error "#{title_token.last[:value]} not in autoload module layout on line #{title_token.last[:line]}"
-            end
-          end
+        unless path.end_with? expected_path
+          notify :error, :message =>  "#{title_token.last[:value]} not in autoload module layout", :linenumber => title_token.last[:line]
         end
+      end
+    end
+  end
+
+  check 'parameter_order' do
+    (class_indexes + defined_type_indexes).each do |class_idx|
+      token_idx = class_idx[:start]
+      header_end_idx = tokens[token_idx..-1].index { |r| r.first == :LBRACE }
+      lparen_idx = tokens[token_idx..(header_end_idx + token_idx)].index { |r| r.first == :LPAREN }
+      rparen_idx = tokens[token_idx..(header_end_idx + token_idx)].rindex { |r| r.first == :RPAREN }
 
-        unless lparen_idx.nil? or rparen_idx.nil?
-          param_tokens = tokens[lparen_idx..rparen_idx]
-          param_tokens.each_index do |param_tokens_idx|
-            this_token = param_tokens[param_tokens_idx]
-            next_token = param_tokens[param_tokens_idx+1]
-            prev_token = param_tokens[param_tokens_idx-1]
-            if this_token.first == :VARIABLE
-              unless next_token.nil?
-                if next_token.first == :COMMA or next_token.first == :RPAREN
-                  unless param_tokens[0..param_tokens_idx].rindex { |r| r.first == :EQUALS }.nil?
-                    unless prev_token.nil? or prev_token.first == :EQUALS
-                      warn "optional parameter listed before required parameter on line #{this_token.last[:line]}"
-                    end
+      unless lparen_idx.nil? or rparen_idx.nil?
+        param_tokens = tokens[lparen_idx..rparen_idx]
+        param_tokens.each_index do |param_tokens_idx|
+          this_token = param_tokens[param_tokens_idx]
+          next_token = param_tokens[param_tokens_idx+1]
+          prev_token = param_tokens[param_tokens_idx-1]
+          if this_token.first == :VARIABLE
+            unless next_token.nil?
+              if next_token.first == :COMMA or next_token.first == :RPAREN
+                unless param_tokens[0..param_tokens_idx].rindex { |r| r.first == :EQUALS }.nil?
+                  unless prev_token.nil? or prev_token.first == :EQUALS
+                    notify :warning, :message =>  "optional parameter listed before required parameter", :linenumber => this_token.last[:line]
                   end
                 end
               end
@@ -52,36 +49,24 @@ class PuppetLint::Plugins::CheckClasses < PuppetLint::CheckPlugin
           end
         end
       end
+    end
+  end
 
-      if [:CLASS, :DEFINE].include? tokens[token_idx].first
-        if tokens[token_idx].first == :CLASS
-          if tokens[token_idx+2].first == :INHERITS
-            class_name = tokens[token_idx+1].last[:value]
-            inherited_class = tokens[token_idx+3].last[:value]
-
-            unless class_name =~ /^#{inherited_class}::/
-              warn "class inherits across namespaces on line #{tokens[token_idx].last[:line]}"
-            end
-          end
-        end
+  check 'inherits_across_namespaces' do
+    class_indexes.each do |class_idx|
+      token_idx = class_idx[:start]
+      if tokens[token_idx+2].first == :INHERITS
+        class_name = tokens[token_idx+1].last[:value]
+        inherited_class = tokens[token_idx+3].last[:value]
 
-        lbrace_count = 0
-        tokens[token_idx+1..-1].each_index do |class_token_idx|
-          idx = class_token_idx + token_idx
-          if tokens[idx].first == :LBRACE
-            lbrace_count += 1
-          elsif tokens[idx].first == :RBRACE
-            lbrace_count -= 1
-            if lbrace_count == 0
-              class_indexes << {:start => token_idx, :end => idx} if tokens[token_idx].first == :CLASS
-              defined_type_indexes << {:start => token_idx, :end => idx} if tokens[token_idx].first == :DEFINE
-              break
-            end
-          end
+        unless class_name =~ /^#{inherited_class}::/
+          notify :warning, :message =>  "class inherits across namespaces", :linenumber => tokens[token_idx].last[:line]
         end
       end
     end
+  end
 
+  check 'nested_classes_or_defines' do
     class_indexes.each do |class_idx|
       class_tokens = tokens[class_idx[:start]..class_idx[:end]]
       class_tokens[1..-1].each_index do |token_idx|
@@ -90,19 +75,21 @@ class PuppetLint::Plugins::CheckClasses < PuppetLint::CheckPlugin
 
         if token.first == :CLASS
           if next_token.first != :LBRACE
-            warn "class defined inside a class on line #{token.last[:line]}"
+            notify :warning, :message =>  "class defined inside a class", :linenumber => token.last[:line]
           end
         end
 
         if token.first == :DEFINE
-          warn "define defined inside a class on line #{token.last[:line]}"
+          notify :warning, :message =>  "define defined inside a class", :linenumber => token.last[:line]
         end
       end
     end
+  end
 
+  check 'variable_scope' do
     (class_indexes + defined_type_indexes).each do |idx|
       object_tokens = tokens[idx[:start]..idx[:end]]
-      variables_in_scope = ['name']
+      variables_in_scope = ['name', 'title', 'module_name']
       referenced_variables = []
       header_end_idx = object_tokens.index { |r| r.first == :LBRACE }
       lparen_idx = object_tokens[0..header_end_idx].index { |r| r.first == :LPAREN }
@@ -137,7 +124,9 @@ class PuppetLint::Plugins::CheckClasses < PuppetLint::CheckPlugin
       referenced_variables.each do |token|
         unless token.last[:value].include? '::'
           unless variables_in_scope.include? token.last[:value]
-            warn "top-scope variable being used without an explicit namespace on line #{token.last[:line]}"
+            unless token.last[:value] =~ /\d+/
+              notify :warning, :message =>  "top-scope variable being used without an explicit namespace", :linenumber => token.last[:line]
+            end
           end
         end
       end

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

@@ -1,10 +1,23 @@
 class PuppetLint::Plugins::CheckConditionals < PuppetLint::CheckPlugin
-  def test(path, data)
-    lexer = Puppet::Parser::Lexer.new
-    lexer.string = data
-    tokens = lexer.fullscan
+  check 'selector_inside_resource' do
+    resource_indexes.each do |resource|
+      resource_tokens = tokens[resource[:start]..resource[:end]]
+
+      resource_tokens.each_index do |resource_token_idx|
+        if resource_tokens[resource_token_idx].first == :FARROW
+          if resource_tokens[resource_token_idx + 1].first == :VARIABLE
+            unless resource_tokens[resource_token_idx + 2].nil?
+              if resource_tokens[resource_token_idx + 2].first == :QMARK
+                notify :warning, :message =>  "selector inside resource block", :linenumber => resource_tokens[resource_token_idx].last[:line]
+              end
+            end
+          end
+        end
+      end
+    end
+  end
 
-    resource_indexes = []
+  check 'case_without_default' do
     case_indexes = []
 
     tokens.each_index do |token_idx|
@@ -32,27 +45,11 @@ class PuppetLint::Plugins::CheckConditionals < PuppetLint::CheckPlugin
       end
     end
 
-    resource_indexes.each do |resource|
-      resource_tokens = tokens[resource[:start]..resource[:end]]
-
-      resource_tokens.each_index do |resource_token_idx|
-        if resource_tokens[resource_token_idx].first == :FARROW
-          if resource_tokens[resource_token_idx + 1].first == :VARIABLE
-            unless resource_tokens[resource_token_idx + 2].nil?
-              if resource_tokens[resource_token_idx + 2].first == :QMARK
-                warn "selector inside resource block on line #{resource_tokens[resource_token_idx].last[:line]}"
-              end
-            end
-          end
-        end
-      end
-    end
-
     case_indexes.each do |kase|
       case_tokens = tokens[kase[:start]..kase[:end]]
 
       unless case_tokens.index { |r| r.first == :DEFAULT }
-        warn "case statement without a default case on line #{case_tokens.first.last[:line]}"
+        notify :warning, :message =>  "case statement without a default case", :linenumber => case_tokens.first.last[:line]
       end
     end
   end

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

@@ -2,48 +2,30 @@
 # http://docs.puppetlabs.com/guides/style_guide.html#resources
 
 class PuppetLint::Plugins::CheckResources < PuppetLint::CheckPlugin
-  def test(path, data)
-    lexer = Puppet::Parser::Lexer.new
-    lexer.string = data
-    tokens = lexer.fullscan
-
-    title_tokens = []
-    resource_indexes = []
-    tokens.each_index do |token_idx|
-      if tokens[token_idx].first == :COLON
-        # gather a list of tokens that are resource titles
-        if tokens[token_idx-1].first == :RBRACK
-          title_array_tokens = tokens[tokens.rindex { |r| r.first == :LBRACK }+1..token_idx-2]
-          title_tokens += title_array_tokens.select { |token| [:STRING, :NAME].include? token.first }
-        else
-          if tokens[token_idx + 1].first != :LBRACE
-            title_tokens << tokens[token_idx-1]
-          end
-        end
-
-        # gather a list of start and end indexes for resource attribute blocks
-        if tokens[token_idx+1].first != :LBRACE
-          resource_indexes << {:start => token_idx+1, :end => tokens[token_idx+1..-1].index { |r| [:SEMIC, :RBRACE].include? r.first }+token_idx}
-        end
-      end
-    end
-
+  check 'unquoted_resource_title' do
     title_tokens.each do |token|
       if token.first == :NAME
-        warn "unquoted resource title on line #{token.last[:line]}"
+        notify :warning, :message =>  "unquoted resource title", :linenumber => token.last[:line]
       end
     end
+  end
 
+  check 'ensure_first_param' do
     resource_indexes.each do |resource|
       resource_tokens = tokens[resource[:start]..resource[:end]]
       ensure_attr_index = resource_tokens.index { |token| token.first == :NAME and token.last[:value] == 'ensure' }
       unless ensure_attr_index.nil?
         if ensure_attr_index > 1
           ensure_attr_line_no = resource_tokens[ensure_attr_index].last[:line]
-          warn "ensure found on line #{ensure_attr_line_no} but it's not the first attribute"
+          notify :warning, :message =>  "ensure found on line but it's not the first attribute", :linenumber => ensure_attr_line_no
         end
       end
+    end
+  end
 
+  check 'unquoted_file_mode' do
+    resource_indexes.each do |resource|
+      resource_tokens = tokens[resource[:start]..resource[:end]]
       resource_type_token = tokens[tokens[0..resource[:start]].rindex { |r| r.first == :LBRACE } - 1]
       if resource_type_token.last[:value] == "file"
         resource_tokens.each_index do |resource_token_idx|
@@ -51,15 +33,43 @@ class PuppetLint::Plugins::CheckResources < PuppetLint::CheckPlugin
           if attr_token.first == :NAME and attr_token.last[:value] == 'mode'
             value_token = resource_tokens[resource_token_idx + 2]
             if value_token.first == :NAME
-              warn "unquoted file mode on line #{value_token.last[:line]}"
+              notify :warning, :message =>  "unquoted file mode", :linenumber => value_token.last[:line]
             end
+          end
+        end
+      end
+    end
+  end
+
+  check '4digit_file_mode' do
+    resource_indexes.each do |resource|
+      resource_tokens = tokens[resource[:start]..resource[:end]]
+      resource_type_token = tokens[tokens[0..resource[:start]].rindex { |r| r.first == :LBRACE } - 1]
+      if resource_type_token.last[:value] == "file"
+        resource_tokens.each_index do |resource_token_idx|
+          attr_token = resource_tokens[resource_token_idx]
+          if attr_token.first == :NAME and attr_token.last[:value] == 'mode'
+            value_token = resource_tokens[resource_token_idx + 2]
             if value_token.last[:value] !~ /\d{4}/ and value_token.first != :VARIABLE
-              warn "mode should be represented as a 4 digit octal value on line #{value_token.last[:line]}"
+              notify :warning, :message =>  "mode should be represented as a 4 digit octal value", :linenumber => value_token.last[:line]
             end
-          elsif attr_token.first == :NAME and attr_token.last[:value] == 'ensure'
+          end
+        end
+      end
+    end
+  end
+
+  check 'ensure_not_symlink_target' do
+    resource_indexes.each do |resource|
+      resource_tokens = tokens[resource[:start]..resource[:end]]
+      resource_type_token = tokens[tokens[0..resource[:start]].rindex { |r| r.first == :LBRACE } - 1]
+      if resource_type_token.last[:value] == "file"
+        resource_tokens.each_index do |resource_token_idx|
+          attr_token = resource_tokens[resource_token_idx]
+          if attr_token.first == :NAME and attr_token.last[:value] == 'ensure'
             value_token = resource_tokens[resource_token_idx + 2]
             if value_token.last[:value].start_with? '/'
-              warn "symlink target specified in ensure attr on line #{value_token.last[:line]}"
+              notify :warning, :message =>  "symlink target specified in ensure attr", :linenumber => value_token.last[:line]
             end
           end
         end

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

@@ -14,27 +14,35 @@ class PuppetLint::Plugins::CheckStrings < PuppetLint::CheckPlugin
     end
   end
 
-  def test(path, data)
-    l = Puppet::Parser::Lexer.new
-    l.string = data
-    tokens = l.fullscan
-
+  check 'double_quoted_strings' do
     tokens.each_index do |token_idx|
       token = tokens[token_idx]
 
       if token.first == :STRING
         unless token.last[:value].include? "\t" or token.last[:value].include? "\n"
-          warn "double quoted string containing no variables on line #{token.last[:line]}"
+          notify :warning, :message =>  "double quoted string containing no variables", :linenumber => token.last[:line]
         end
       end
+    end
+  end
+
+  check 'only_variable_string' do
+    tokens.each_index do |token_idx|
+      token = tokens[token_idx]
 
       if token.first == :DQPRE and token.last[:value] == ""
         if tokens[token_idx + 1].first == :VARIABLE
           if tokens[token_idx + 2].first == :DQPOST and tokens[token_idx + 2].last[:value] == ""
-            warn "string containing only a variable on line #{tokens[token_idx + 1].last[:line]}"
+            notify :warning, :message =>  "string containing only a variable", :linenumber => tokens[token_idx + 1].last[:line]
           end
         end
       end
+    end
+  end
+
+  check 'variables_not_enclosed' do
+    tokens.each_index do |token_idx|
+      token = tokens[token_idx]
 
       if token.first == :DQPRE
         end_of_string_idx = tokens[token_idx..-1].index { |r| r.first == :DQPOST }
@@ -42,31 +50,39 @@ class PuppetLint::Plugins::CheckStrings < PuppetLint::CheckPlugin
           if t.first == :VARIABLE
             line = data.split("\n")[t.last[:line] - 1]
             if line.is_a? String and line.include? "$#{t.last[:value]}"
-              warn "variable not enclosed in {} on line #{t.last[:line]}"
+              notify :warning, :message =>  "variable not enclosed in {}", :linenumber => t.last[:line]
             end
           end
         end
       end
+    end
+  end
 
-      if token.first == :DQPRE
-        end_of_string_idx = tokens[token_idx..-1].index { |r| r.first == :DQPOST }
-        tokens[token_idx..end_of_string_idx].each do |t|
-          if t.first == :VARIABLE and t.last[:value].match(/-/)
-              warn "variable contains a dash on line #{t.last[:line]}"
-          end
-        end
-      end
+  check 'single_quote_string_with_variables' do
+    tokens.each_index do |token_idx|
+      token = tokens[token_idx]
 
       if token.first == :SSTRING
         contents = token.last[:value]
         line_no = token.last[:line]
 
         if contents.include? '${'
-          error "single quoted string containing a variable found on line #{token.last[:line]}"
+          notify :error, :message =>  "single quoted string containing a variable found", :linenumber => token.last[:line]
         end
+      end
+    end
+  end
+
+  check 'quoted_booleans' do
+    tokens.each_index do |token_idx|
+      token = tokens[token_idx]
+
+      if token.first == :SSTRING
+        contents = token.last[:value]
+        line_no = token.last[:line]
 
         if ['true', 'false'].include? contents
-          warn "quoted boolean value found on line #{token.last[:line]}"
+          notify :warning, :message =>  "quoted boolean value found", :linenumber => token.last[:line]
         end
       end
     end

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

@@ -1,9 +1,5 @@
 class PuppetLint::Plugins::CheckVariables < PuppetLint::CheckPlugin
-  def test(path, data)
-    lexer = Puppet::Parser::Lexer.new
-    lexer.string = data
-    tokens = lexer.fullscan
-
+  check 'variable_contains_dash' do
     tokens.each_index do |token_idx|
       token = tokens[token_idx]
 
@@ -11,7 +7,16 @@ class PuppetLint::Plugins::CheckVariables < PuppetLint::CheckPlugin
         variable = token.last[:value]
         line_no = token.last[:line]
         if variable.match(/-/)
-          warn "Variable contains a dash on line #{line_no}"
+          notify :warning, :message =>  "variable contains a dash", :linenumber => line_no
+        end
+      end
+
+      if token.first == :DQPRE
+        end_of_string_idx = tokens[token_idx..-1].index { |r| r.first == :DQPOST }
+        tokens[token_idx..end_of_string_idx].each do |t|
+          if t.first == :VARIABLE and t.last[:value].match(/-/)
+            notify :warning, :message =>  "variable contains a dash", :linenumber => t.last[:line]
+          end
         end
       end
     end