puppet-lint 0.2.0 → 0.2.1

data/lib/puppet-lint.rb

@@ -140,9 +140,7 @@ class PuppetLint
       raise PuppetLint::NoCodeError
     end
 
-    PuppetLint::CheckPlugin.repository.each do |plugin|
-      report plugin.new.run(@fileinfo, @data)
-    end
+    report PuppetLint::Checks.new.run(@fileinfo, @data)
   end
 end
 

data/lib/puppet-lint/configuration.rb

@@ -38,20 +38,21 @@ class PuppetLint
       end
     end
 
-    def add_check(check)
+    def add_check(check, &b)
       self.class.add_check(check)
+      check_method[check] = b
     end
 
     def settings
       @settings ||= {}
     end
 
+    def check_method
+      @check_method ||= {}
+    end
+
     def checks
-      self.public_methods.select { |method|
-        method =~ /^.+_enabled\?$/
-      }.map { |method|
-        method[0..-10]
-      }
+      check_method.keys
     end
 
     def defaults

data/lib/puppet-lint/plugin.rb

@@ -1,29 +1,14 @@
-class PuppetLint
-
-  module Plugin
-    module ClassMethods
-      def repository
-        @repository ||= []
-      end
-
-      def inherited(klass)
-        repository << klass
-      end
-    end
-
-    def self.included(klass)
-      klass.extend ClassMethods
-    end
-  end
-end
-
-class PuppetLint::CheckPlugin
-  include PuppetLint::Plugin
+class PuppetLint::Checks
   attr_reader :problems
 
   def initialize
     @problems = []
     @default_info = {:check => 'unknown', :linenumber => 0}
+
+    PuppetLint.configuration.checks.each do |check|
+      method = PuppetLint.configuration.check_method[check]
+      self.class.send(:define_method, "lint_check_#{check}", &method)
+    end
   end
 
   #     notify(kind, message_hash)    #=> nil
@@ -48,11 +33,15 @@ class PuppetLint::CheckPlugin
     message_hash
   end
 
-  def run(fileinfo, data)
+  def load_data(fileinfo, data)
     lexer = PuppetLint::Lexer.new
     @tokens = lexer.tokenise(data)
     @fileinfo = fileinfo
     @data = data
+  end
+
+  def run(fileinfo, data)
+    load_data(fileinfo, data)
 
     enabled_checks.each do |check|
       @default_info[:check] = check
@@ -230,10 +219,11 @@ class PuppetLint::CheckPlugin
   def manifest_lines
     @manifest_lines ||= @data.split("\n")
   end
+end
 
+class PuppetLint::CheckPlugin
   def self.check(name, &b)
-    PuppetLint.configuration.add_check name
-    define_method("lint_check_#{name}", b)
+    PuppetLint.configuration.add_check(name, &b)
   end
 end
 

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

@@ -73,16 +73,20 @@ class PuppetLint::Plugins::CheckClasses < PuppetLint::CheckPlugin
       depth = 0
       lparen_idx = nil
       rparen_idx = nil
-      tokens[token_idx..-1].each_index do |t|
-        idx = token_idx + t
-        if tokens[idx].type == :LPAREN
-          depth += 1
-          lparen_idx = idx if depth == 1
-        elsif tokens[idx].type == :RPAREN
-          depth -= 1
-          if depth == 0
-            rparen_idx = idx
-            break
+      class_name_token = tokens[class_idx[:start]].next_code_token
+
+      if class_name_token.next_code_token.type == :LPAREN
+        tokens[token_idx..-1].each_index do |t|
+          idx = token_idx + t
+          if tokens[idx].type == :LPAREN
+            depth += 1
+            lparen_idx = idx if depth == 1
+          elsif tokens[idx].type == :RPAREN
+            depth -= 1
+            if depth == 0
+              rparen_idx = idx
+              break
+            end
           end
         end
       end

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

@@ -1,28 +1,24 @@
 class PuppetLint::Plugins::CheckDocumentation < PuppetLint::CheckPlugin
-  def whitespace_tokens
-    @whitespace_tokens ||= {
-      :WHITESPACE => true,
-      :NEWLINE => true,
-      :INDENT => true,
-    }
-  end
-
-  def comment_tokens
-    @comment_tokens ||= {
+  check 'documentation' do
+    comment_tokens = {
       :COMMENT => true,
       :MLCOMMENT => true,
       :SLASH_COMMENT => true,
     }
-  end
 
-  check 'documentation' do
+    whitespace_tokens = {
+      :WHITESPACE => true,
+      :NEWLINE => true,
+      :INDENT => true,
+    }
+
     (class_indexes + defined_type_indexes).each do |item_idx|
       prev_token = tokens[item_idx[:start] - 1]
-      while whitespace_tokens.include? prev_token.type
+      while (!prev_token.nil?) && whitespace_tokens.include?(prev_token.type)
         prev_token = prev_token.prev_token
       end
 
-      unless comment_tokens.include? prev_token.type
+      unless (!prev_token.nil?) && comment_tokens.include?(prev_token.type)
         first_token = tokens[item_idx[:start]]
         if first_token.type == :CLASS
           type = 'class'

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

@@ -22,17 +22,18 @@ class PuppetLint::Plugins::CheckResources < PuppetLint::CheckPlugin
   # Returns nothing.
   check 'ensure_first_param' do
     resource_indexes.each do |resource|
-      resource_tokens = tokens[resource[:start]..resource[:end]].reject { |r|
-        formatting_tokens.include? r.type
-      }
+      resource_tokens = tokens[resource[:start]..resource[:end]]
 
-      ensure_attr_index = resource_tokens.index { |token|
-        token.type == :NAME and token.value == 'ensure'
+      param_tokens = resource_tokens.select { |resource_token|
+        resource_token.type == :NAME && resource_token.next_code_token.type == :FARROW
+      }
+      ensure_attr_index = param_tokens.index { |resource_token|
+        resource_token.value == 'ensure'
       }
 
       unless ensure_attr_index.nil?
-        if ensure_attr_index > 1
-          ensure_token = resource_tokens[ensure_attr_index]
+        if ensure_attr_index > 0
+          ensure_token = param_tokens[ensure_attr_index]
           notify :warning, {
             :message    => "ensure found on line but it's not the first attribute",
             :linenumber => ensure_token.line,
@@ -75,31 +76,25 @@ class PuppetLint::Plugins::CheckResources < PuppetLint::CheckPlugin
   # Returns nothing.
   check 'unquoted_file_mode' do
     resource_indexes.each do |resource|
-      resource_tokens = tokens[resource[:start]..resource[:end]].reject { |r|
-        formatting_tokens.include? r.type
-      }
-
-      stripped_tokens = tokens[0..resource[:start]].reject { |r|
-        formatting_tokens.include? r.type
-      }
+      resource_tokens = tokens[resource[:start]..resource[:end]]
+      prev_tokens = tokens[0..resource[:start]]
 
-      res_type_idx = stripped_tokens.rindex { |r|
+      lbrace_idx = prev_tokens.rindex { |r|
         r.type == :LBRACE
-      } - 1
+      }
 
-      resource_type_token = stripped_tokens[res_type_idx]
+      resource_type_token = tokens[lbrace_idx].prev_code_token
       if resource_type_token.value == "file"
-        resource_tokens.each_index do |resource_token_idx|
-          attr_token = resource_tokens[resource_token_idx]
-          if attr_token.type == :NAME and attr_token.value == 'mode'
-            value_token = resource_tokens[resource_token_idx + 2]
-            if {:NAME => true, :NUMBER => true}.include? value_token.type
-              notify :warning, {
-                :message    => 'unquoted file mode',
-                :linenumber => value_token.line,
-                :column     => value_token.column,
-              }
-            end
+        resource_tokens.select { |resource_token|
+          resource_token.type == :NAME and resource_token.value == 'mode'
+        }.each do |resource_token|
+          value_token = resource_token.next_code_token.next_code_token
+          if {:NAME => true, :NUMBER => true}.include? value_token.type
+            notify :warning, {
+              :message    => 'unquoted file mode',
+              :linenumber => value_token.line,
+              :column     => value_token.column,
+            }
           end
         end
       end
@@ -116,36 +111,30 @@ class PuppetLint::Plugins::CheckResources < PuppetLint::CheckPlugin
     sym_mode = /\A([ugoa]*[-=+][-=+rstwxXugo]*)(,[ugoa]*[-=+][-=+rstwxXugo]*)*\Z/
 
     resource_indexes.each do |resource|
-      resource_tokens = tokens[resource[:start]..resource[:end]].reject { |r|
-        formatting_tokens.include? r.type
-      }
-
-      stripped_tokens = tokens[0..resource[:start]].reject { |r|
-        formatting_tokens.include? r.type
-      }
+      resource_tokens = tokens[resource[:start]..resource[:end]]
+      prev_tokens = tokens[0..resource[:start]]
 
-      res_type_idx = stripped_tokens.rindex { |r|
+      lbrace_idx = prev_tokens.rindex { |r|
         r.type == :LBRACE
-      } - 1
+      }
 
-      resource_type_token = stripped_tokens[res_type_idx]
+      resource_type_token = tokens[lbrace_idx].prev_code_token
       if resource_type_token.value == "file"
-        resource_tokens.each_index do |resource_token_idx|
-          attr_token = resource_tokens[resource_token_idx]
-          if attr_token.type == :NAME and attr_token.value == 'mode'
-            value_token = resource_tokens[resource_token_idx + 2]
+        resource_tokens.select { |resource_token|
+          resource_token.type == :NAME and resource_token.value == 'mode'
+        }.each do |resource_token|
+          value_token = resource_token.next_code_token.next_code_token
 
-            break if value_token.value =~ /\A[0-7]{4}\Z/
-            break if value_token.type == :VARIABLE
-            break if value_token.value =~ sym_mode
-            break if value_token.type == :UNDEF
+          break if value_token.value =~ /\A[0-7]{4}\Z/
+          break if value_token.type == :VARIABLE
+          break if value_token.value =~ sym_mode
+          break if value_token.type == :UNDEF
 
-            notify :warning, {
-              :message    => msg,
-              :linenumber => value_token.line,
-              :column     => value_token.column,
-            }
-          end
+          notify :warning, {
+            :message    => msg,
+            :linenumber => value_token.line,
+            :column     => value_token.column,
+          }
         end
       end
     end
@@ -158,31 +147,25 @@ class PuppetLint::Plugins::CheckResources < PuppetLint::CheckPlugin
   # Returns nothing.
   check 'ensure_not_symlink_target' do
     resource_indexes.each do |resource|
-      resource_tokens = tokens[resource[:start]..resource[:end]].reject { |r|
-        formatting_tokens.include? r.type
-      }
-
-      stripped_tokens = tokens[0..resource[:start]].reject { |r|
-        formatting_tokens.include? r.type
-      }
+      resource_tokens = tokens[resource[:start]..resource[:end]]
+      prev_tokens = tokens[0..resource[:start]]
 
-      res_type_idx = stripped_tokens.rindex { |r|
+      lbrace_idx = prev_tokens.rindex { |r|
         r.type == :LBRACE
-      } - 1
+      }
 
-      resource_type_token = stripped_tokens[res_type_idx]
+      resource_type_token = tokens[lbrace_idx].prev_code_token
       if resource_type_token.value == "file"
-        resource_tokens.each_index do |resource_token_idx|
-          attr_token = resource_tokens[resource_token_idx]
-          if attr_token.type == :NAME and attr_token.value == 'ensure'
-            value_token = resource_tokens[resource_token_idx + 2]
-            if value_token.value.start_with? '/'
-              notify :warning, {
-                :message    => 'symlink target specified in ensure attr',
-                :linenumber => value_token.line,
-                :column     => value_token.column,
-              }
-            end
+        resource_tokens.select { |resource_token|
+          resource_token.type == :NAME and resource_token.value == 'ensure'
+        }.each do |ensure_token|
+          value_token = ensure_token.next_code_token.next_code_token
+          if value_token.value.start_with? '/'
+            notify :warning, {
+              :message    => 'symlink target specified in ensure attr',
+              :linenumber => value_token.line,
+              :column     => value_token.column,
+            }
           end
         end
       end

data/lib/puppet-lint/version.rb

@@ -1,3 +1,3 @@
 class PuppetLint
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/spec/puppet-lint/configuration_spec.rb

@@ -4,7 +4,8 @@ describe PuppetLint::Configuration do
   subject { PuppetLint::Configuration.new }
 
   it 'should create check methods on the fly' do
-    subject.add_check('foo')
+    method = Proc.new { true }
+    subject.add_check('foo', &method)
 
     subject.should respond_to(:foo_enabled?)
     subject.should_not respond_to(:bar_enabled?)
@@ -21,6 +22,8 @@ describe PuppetLint::Configuration do
   end
 
   it 'should know what checks have been added' do
+    method = Proc.new { true }
+    subject.add_check('foo', &method)
     subject.checks.should include('foo')
   end
 

data/spec/puppet-lint/plugins/check_classes/autoloader_layout_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe 'autoloader_layout' do
+  describe 'foo::bar in foo/manifests/bar.pp' do
+    let(:code) { "class foo::bar { }" }
+    let(:fullpath) { '/etc/puppet/modules/foo/manifests/bar.pp' }
+
+    its(:problems) { should be_empty }
+  end
+
+  describe 'foo::bar::baz in foo/manifests/bar/baz.pp' do
+    let(:code) { 'define foo::bar::baz() { }' }
+    let(:fullpath) { '/etc/puppet/modules/foo/manifests/bar/baz.pp' }
+
+    its(:problems) { should be_empty }
+  end
+
+  describe 'foo in foo/manifests/init.pp' do
+    let(:code) { 'class foo { }' }
+    let(:fullpath) { '/etc/puppet/modules/foo/manifests/init.pp' }
+
+    its(:problems) { should be_empty }
+  end
+
+  describe 'foo::bar in foo/manifests/init.pp' do
+    let(:code) { 'class foo::bar { }' }
+    let(:fullpath) { '/etc/puppet/modules/foo/manifests/init.pp' }
+
+    its(:problems) {
+      should only_have_problem({
+        :kind       => :error,
+        :message    => "foo::bar not in autoload module layout",
+        :linenumber => 1,
+        :column     => 7,
+      })
+    }
+  end
+
+  describe 'foo included in bar/manifests/init.pp' do
+    let(:code) { "
+      class bar {
+        class {'foo':
+          someparam => 'somevalue',
+        }
+      }
+      "
+    }
+    let(:fullpath) { '/etc/puppet/modules/bar/manifests/init.pp' }
+    its(:problems) { should be_empty }
+  end
+end

data/spec/puppet-lint/plugins/check_classes/inherits_across_namespaces_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe 'inherits_across_namespaces' do
+  describe 'class inheriting from its namespace' do
+    let(:code) { "class foo::bar inherits foo { }" }
+
+    its(:problems) { should be_empty }
+  end
+
+  describe 'class inheriting from another namespace' do
+    let(:code) { "class foo::bar inherits baz { }" }
+
+    its(:problems) {
+      should have_problem({
+        :kind       => :warning,
+        :message    => "class inherits across namespaces",
+        :linenumber => 1,
+        :column     => 25,
+      })
+      should_not have_problem :kind => :error
+    }
+  end
+end