puppet-lint 0.2.0.pre1 → 0.2.0

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

@@ -0,0 +1,33 @@
+class PuppetLint::Plugins::CheckComments < PuppetLint::CheckPlugin
+  # Public: Check the manifest tokens for any comments started with slashes
+  # (//) and record a warning for each instance found.
+  #
+  # Returns nothing.
+  check 'slash_comments' do
+    tokens.select { |token|
+      token.type == :SLASH_COMMENT
+    }.each do |token|
+      notify :warning, {
+        :message    => '// comment found',
+        :linenumber => token.line,
+        :column     => token.column,
+      }
+    end
+  end
+
+  # Public: Check the manifest tokens for any comments encapsulated with
+  # slash-asterisks (/* */) and record a warning for each instance found.
+  #
+  # Returns nothing.
+  check 'star_comments' do
+    tokens.select { |token|
+      token.type == :MLCOMMENT
+    }.each do |token|
+      notify :warning, {
+        :message    => '/* */ comment found',
+        :linenumber => token.line,
+        :column     => token.column,
+      }
+    end
+  end
+end

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

@@ -5,19 +5,17 @@ class PuppetLint::Plugins::CheckConditionals < PuppetLint::CheckPlugin
   # Returns nothing.
   check 'selector_inside_resource' 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]]
 
-      resource_tokens.each_index do |resource_token_idx|
-        if resource_tokens[resource_token_idx].type == :FARROW
-          if resource_tokens[resource_token_idx + 1].type == :VARIABLE
-            unless resource_tokens[resource_token_idx + 2].nil?
-              if resource_tokens[resource_token_idx + 2].type == :QMARK
+      resource_tokens.each do |token|
+        if token.type == :FARROW
+          if token.next_code_token.type == :VARIABLE
+            unless token.next_code_token.next_code_token.nil?
+              if token.next_code_token.next_code_token.type == :QMARK
                 notify :warning, {
                   :message    => 'selector inside resource block',
-                  :linenumber => resource_tokens[resource_token_idx].line,
-                  :column     => resource_tokens[resource_token_idx].column,
+                  :linenumber => token.line,
+                  :column     => token.column,
                 }
               end
             end

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

@@ -0,0 +1,41 @@
+class PuppetLint::Plugins::CheckDocumentation < PuppetLint::CheckPlugin
+  def whitespace_tokens
+    @whitespace_tokens ||= {
+      :WHITESPACE => true,
+      :NEWLINE => true,
+      :INDENT => true,
+    }
+  end
+
+  def comment_tokens
+    @comment_tokens ||= {
+      :COMMENT => true,
+      :MLCOMMENT => true,
+      :SLASH_COMMENT => true,
+    }
+  end
+
+  check 'documentation' do
+    (class_indexes + defined_type_indexes).each do |item_idx|
+      prev_token = tokens[item_idx[:start] - 1]
+      while whitespace_tokens.include? prev_token.type
+        prev_token = prev_token.prev_token
+      end
+
+      unless comment_tokens.include? prev_token.type
+        first_token = tokens[item_idx[:start]]
+        if first_token.type == :CLASS
+          type = 'class'
+        else
+          type = 'defined type'
+        end
+
+        notify :warning, {
+          :message    => "#{type} not documented",
+          :linenumber => first_token.line,
+          :column     => first_token.column,
+        }
+      end
+    end
+  end
+end

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

@@ -43,6 +43,31 @@ class PuppetLint::Plugins::CheckResources < PuppetLint::CheckPlugin
     end
   end
 
+  check 'duplicate_params' do
+    resource_indexes.each do |resource|
+      resource_tokens = tokens[resource[:start]..resource[:end]].reject { |r|
+        formatting_tokens.include? r.type
+      }
+
+      seen_params = {}
+      resource_tokens.each_with_index do |token, idx|
+        if token.type == :FARROW
+          prev_token = resource_tokens[idx - 1]
+          next unless prev_token.type == :NAME
+          if seen_params.include? prev_token.value
+            notify :error, {
+              :message    => 'duplicate parameter found in resource',
+              :linenumber => prev_token.line,
+              :column     => prev_token.column,
+            }
+          else
+            seen_params[prev_token.value] = true
+          end
+        end
+      end
+    end
+  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.
@@ -68,7 +93,7 @@ class PuppetLint::Plugins::CheckResources < PuppetLint::CheckPlugin
           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 value_token.type == :NAME
+            if {:NAME => true, :NUMBER => true}.include? value_token.type
               notify :warning, {
                 :message    => 'unquoted file mode',
                 :linenumber => value_token.line,
@@ -110,9 +135,10 @@ class PuppetLint::Plugins::CheckResources < PuppetLint::CheckPlugin
           if attr_token.type == :NAME and attr_token.value == 'mode'
             value_token = resource_tokens[resource_token_idx + 2]
 
-            break if value_token.value =~ /\d{4}/
+            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,

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

@@ -7,8 +7,10 @@ class PuppetLint::Plugins::CheckStrings < PuppetLint::CheckPlugin
   check 'double_quoted_strings' do
     tokens.select { |r|
       r.type == :STRING
-    }.reject { |r|
-      r.value.include?('\t') || r.value.include?('\n')
+    }.each { |r|
+      r.value.gsub!(' '*r.column, "\n")
+    }.select { |r|
+      r.value[/(\t|\\t|\n|\\n)/].nil?
     }.each do |token|
       notify :warning, {
         :message    => 'double quoted string containing no variables',
@@ -27,7 +29,7 @@ class PuppetLint::Plugins::CheckStrings < PuppetLint::CheckPlugin
       token = tokens[token_idx]
 
       if token.type == :DQPRE and token.value == ''
-        if [:VARIABLE, :UNENC_VARIABLE].include? tokens[token_idx + 1].type
+        if {:VARIABLE => true, :UNENC_VARIABLE => true}.include? tokens[token_idx + 1].type
           if tokens[token_idx + 2].type == :DQPOST
             if tokens[token_idx + 2].value == ''
               notify :warning, {
@@ -82,7 +84,7 @@ class PuppetLint::Plugins::CheckStrings < PuppetLint::CheckPlugin
   # Returns nothing.
   check 'quoted_booleans' do
     tokens.select { |r|
-      [:STRING, :SSTRING].include?(r.type) && %w{true false}.include?(r.value)
+      {:STRING => true, :SSTRING => true}.include?(r.type) && %w{true false}.include?(r.value)
     }.each do |token|
       notify :warning, {
         :message    => 'quoted boolean value found',

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

@@ -5,7 +5,7 @@ class PuppetLint::Plugins::CheckVariables < PuppetLint::CheckPlugin
   # Returns nothing.
   check 'variable_contains_dash' do
     tokens.select { |r|
-      [:VARIABLE, :UNENC_VARIABLE].include? r.type
+      {:VARIABLE => true, :UNENC_VARIABLE => true}.include? r.type
     }.each do |token|
       if token.value.match(/-/)
         notify :warning, {

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

@@ -69,64 +69,41 @@ class PuppetLint::Plugins::CheckWhitespace < PuppetLint::CheckPlugin
     end
   end
 
-  # Check the raw manifest strings for any arrows (=>) in a grouping ({}) that
-  # are not aligned with other arrows in that grouping.
+  # Check the manifest tokens for any arrows (=>) in a grouping ({}) that are
+  # not aligned with other arrows in that grouping.
   #
   # Returns nothing.
   check 'arrow_alignment' do
-    in_resource = false
-    selectors = []
-    resource_indent_length = 0
-    manifest_lines.each_with_index do |line, idx|
-      # SHOULD align fat comma arrows (=>) within blocks of attributes
-      if line =~ /^( +.+? +)=>/
-        line_indent = $1
-        if in_resource
-          if selectors.count > 0
-            if selectors.last == 0
-              selectors[-1] = line_indent.length
-            end
+    resource_indexes.each do |res_idx|
+      indent_depth = [nil]
+      resource_tokens = tokens[res_idx[:start]..res_idx[:end]]
+      resource_tokens.reject! do |token|
+        {:COMMENT => true, :SLASH_COMMENT => true, :MLCOMMENT => true}.include? token.type
+      end
 
-            # check for length first
-            unless line_indent.length == selectors.last
-              notify :warning, {
-                :message    => '=> is not properly aligned for selector',
-                :linenumber => idx + 1,
-                :column     => line_indent.length,
-              }
-            end
+      # If this is a single line resource, skip it
+      next if resource_tokens.select { |r| r.type == :NEWLINE }.empty?
 
-            # then for a new selector or selector finish
-            if line.strip.end_with? '{'
-              selectors.push(0)
-            elsif line.strip =~ /\}[,;]?$/
-              selectors.pop
-            end
-          else
-            unless line_indent.length == resource_indent_length
-              notify :warning, {
-                :message    => '=> is not properly aligned for resource',
-                :linenumber => idx + 1,
-                :column     => line_indent.length,
-              }
-            end
+      resource_tokens.each_with_index do |token, idx|
+        if token.type == :FARROW
+          indent_length = token.column
 
-            if line.strip.end_with? '{'
-              selectors.push(0)
-            end
+          if indent_depth.last.nil?
+            indent_depth[-1] = indent_length
           end
-        else
-          resource_indent_length = line_indent.length
-          in_resource = true
-          if line.strip.end_with? '{'
-            selectors.push(0)
+
+          unless indent_depth.last == indent_length
+            notify :warning, {
+              :message    => '=> is not properly aligned',
+              :linenumber => token.line,
+              :column     => token.column,
+            }
           end
+        elsif token.type == :LBRACE
+          indent_depth.push(nil)
+        elsif token.type == :RBRACE
+          indent_depth.pop
         end
-      elsif line.strip =~ /\}[,;]?$/ and selectors.count > 0
-        selectors.pop
-      else
-        in_resource = false
-        resource_indent_length = 0
       end
     end
   end

data/lib/puppet-lint/tasks/puppet-lint.rb

@@ -8,6 +8,8 @@ class PuppetLint
       desc 'Run puppet-lint'
 
       task :lint do
+        PuppetLint.configuration.with_filename = true
+
         RakeFileUtils.send(:verbose, true) do
           linter = PuppetLint.new
           matched_files = FileList['**/*.pp']
@@ -17,7 +19,6 @@ class PuppetLint
           end
 
           matched_files.to_a.each do |puppet_file|
-            puts "Evaluating #{puppet_file}"
             linter.file = puppet_file
             linter.run
           end

data/lib/puppet-lint/version.rb

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

data/puppet-lint.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'rdoc'
+  s.add_development_dependency 'rcov'
 
   s.authors = ['Tim Sharpe']
   s.email = 'tim@sharpe.id.au'

data/spec/fixtures/test/manifests/fail.pp

@@ -0,0 +1,2 @@
+# foo
+class test::foo { }

data/spec/fixtures/test/manifests/init.pp

@@ -0,0 +1,3 @@
+# foo
+class test {
+}

data/spec/fixtures/test/manifests/warning.pp

@@ -0,0 +1,2 @@
+# foo
+define test::warning($foo='bar', $baz) { }

data/spec/puppet-lint/bin_spec.rb

@@ -0,0 +1,266 @@
+require 'spec_helper'
+require 'rspec/mocks'
+require 'optparse'
+
+class CommandRun
+  attr_accessor :stdout, :stderr, :exitstatus
+
+  def initialize(args)
+    out = StringIO.new
+    err = StringIO.new
+
+    $stdout = out
+    $stderr = err
+
+    PuppetLint.configuration.defaults
+    @exitstatus = PuppetLint::Bin.new(args).run
+    PuppetLint.configuration.defaults
+
+    @stdout = out.string.strip
+    @stderr = err.string.strip
+
+    $stdout = STDOUT
+    $stderr = STDERR
+  end
+end
+
+describe PuppetLint::Bin do
+  subject do
+    if args.is_a? Array
+      sane_args = args
+    else
+      sane_args = [args]
+    end
+
+    CommandRun.new(sane_args)
+  end
+
+  context 'when running normally' do
+    let(:args) { 'spec/fixtures/test/manifests/init.pp' }
+
+    its(:exitstatus) { should == 0 }
+  end
+
+  context 'when running without arguments' do
+    let(:args) { [] }
+
+    its(:exitstatus) { should == 1 }
+  end
+
+  context 'when asked to display version' do
+    let(:args) { '--version' }
+
+    its(:exitstatus) { should == 0 }
+    its(:stdout) { should == "Puppet-lint #{PuppetLint::VERSION}" }
+  end
+
+  context 'when passed multiple files' do
+    let(:args) { [
+      'spec/fixtures/test/manifests/warning.pp',
+      'spec/fixtures/test/manifests/fail.pp',
+    ] }
+
+    its(:exitstatus) { should == 1 }
+    its(:stdout) { should == [
+      'WARNING: optional parameter listed before required parameter on line 2',
+      'ERROR: test::foo not in autoload module layout on line 2',
+    ].join("\n") }
+  end
+
+  context 'when limited to errors only' do
+    let(:args) { [
+      '--error-level', 'error',
+      'spec/fixtures/test/manifests/warning.pp',
+      'spec/fixtures/test/manifests/fail.pp',
+    ] }
+
+    its(:exitstatus) { should == 1 }
+    its(:stdout) { should match(/^ERROR/) }
+  end
+
+  context 'when limited to errors only' do
+    let(:args) { [
+      '--error-level', 'warning',
+      'spec/fixtures/test/manifests/warning.pp',
+      'spec/fixtures/test/manifests/fail.pp',
+    ] }
+
+    its(:exitstatus) { should == 1 }
+    its(:stdout) { should match(/^WARNING/) }
+  end
+
+  context 'when asked to display filenames ' do
+    let(:args) { ['--with-filename', 'spec/fixtures/test/manifests/fail.pp'] }
+
+    its(:exitstatus) { should == 1 }
+    its(:stdout) { should match(%r{^spec/fixtures/test/manifests/fail\.pp -}) }
+  end
+
+  context 'when not asked to fail on warnings' do
+    let(:args) { ['spec/fixtures/test/manifests/warning.pp'] }
+
+    its(:exitstatus) { should == 0 }
+    its(:stdout) { should match(/optional parameter/) }
+  end
+
+  context 'when asked to fail on warnings' do
+    let(:args) { [
+      '--fail-on-warnings',
+      'spec/fixtures/test/manifests/warning.pp',
+    ] }
+
+    its(:exitstatus) { should == 1 }
+    its(:stdout) { should match(/optional parameter/) }
+  end
+
+  context 'when used with an invalid option' do
+    let(:args) { '--foo-bar-baz' }
+
+    its(:exitstatus) { should == 1 }
+    its(:stdout) { should match(/invalid option/) }
+  end
+
+  context 'when passed a file that does not exist' do
+    let(:args) { 'spec/fixtures/test/manifests/enoent.pp' }
+
+    its(:exitstatus) { should == 1 }
+    its(:stdout) { should match(/specified file does not exist/) }
+  end
+
+  context 'when passed a directory' do
+    let(:args) { 'spec/fixtures/' }
+
+    its(:exitstatus) { should == 1 }
+    its(:stdout) { should match(/^ERROR/) }
+  end
+
+  context 'when disabling a check' do
+    let(:args) { [
+      '--no-autoloader_layout',
+      'spec/fixtures/test/manifests/fail.pp'
+    ] }
+
+    its(:exitstatus) { should == 0 }
+    its(:stdout) { should == "" }
+  end
+
+  context 'when changing the log format' do
+    context 'to print %{filename}' do
+      let(:args) { [
+        '--log-format', '%{filename}',
+        'spec/fixtures/test/manifests/fail.pp'
+      ] }
+
+      its(:exitstatus) { should == 1 }
+      its(:stdout) { should == 'fail.pp' }
+    end
+
+    context 'to print %{path}' do
+      let(:args) { [
+        '--log-format', '%{path}',
+        'spec/fixtures/test/manifests/fail.pp'
+      ] }
+
+      its(:exitstatus) { should == 1 }
+      its(:stdout) { should == 'spec/fixtures/test/manifests/fail.pp' }
+    end
+
+    context 'to print %{fullpath}' do
+      let(:args) { [
+        '--log-format', '%{fullpath}',
+        'spec/fixtures/test/manifests/fail.pp'
+      ] }
+
+      its(:exitstatus) { should == 1 }
+      its(:stdout) {
+        should match(%r{^/.+/spec/fixtures/test/manifests/fail\.pp$})
+      }
+    end
+
+    context 'to print %{linenumber}' do
+      let(:args) { [
+        '--log-format', '%{linenumber}',
+        'spec/fixtures/test/manifests/fail.pp'
+      ] }
+
+      its(:exitstatus) { should == 1 }
+      its(:stdout) { should == '2' }
+    end
+
+    context 'to print %{kind}' do
+      let(:args) { [
+        '--log-format', '%{kind}',
+        'spec/fixtures/test/manifests/fail.pp'
+      ] }
+
+      its(:exitstatus) { should == 1 }
+      its(:stdout) { should == 'error' }
+    end
+
+    context 'to print %{KIND}' do
+      let(:args) { [
+        '--log-format', '%{KIND}',
+        'spec/fixtures/test/manifests/fail.pp'
+      ] }
+
+      its(:exitstatus) { should == 1 }
+      its(:stdout) { should == 'ERROR' }
+    end
+
+    context 'to print %{check}' do
+      let(:args) { [
+        '--log-format', '%{check}',
+        'spec/fixtures/test/manifests/fail.pp'
+      ] }
+
+      its(:exitstatus) { should == 1 }
+      its(:stdout) { should == 'autoloader_layout' }
+    end
+
+    context 'to print %{message}' do
+      let(:args) { [
+        '--log-format', '%{message}',
+        'spec/fixtures/test/manifests/fail.pp'
+      ] }
+
+      its(:exitstatus) { should == 1 }
+      its(:stdout) { should == 'test::foo not in autoload module layout' }
+    end
+
+    context 'when loading options from a file' do
+      let(:args) { 'spec/fixtures/test/manifests/fail.pp' }
+
+      it 'should have ~/.puppet-lintrc as depreciated' do
+        OptionParser.any_instance.stub(:load).
+          with(File.expand_path('~/.puppet-lintrc')).and_return(true)
+        OptionParser.any_instance.stub(:load).
+          with(File.expand_path('~/.puppet-lint.rc')).and_return(false)
+        OptionParser.any_instance.stub(:load).
+          with('.puppet-lintrc').and_return(false)
+        OptionParser.any_instance.stub(:load).
+          with('.puppet-lint.rc').and_return(false)
+        OptionParser.any_instance.stub(:load).
+          with('/etc/puppet-lint.rc').and_return(false)
+
+        msg = 'Depreciated: Found ~/.puppet-lintrc instead of ~/.puppet-lint.rc'
+        subject.stderr.should == msg
+      end
+
+      it 'should have .puppet-lintrc as depreciated' do
+        OptionParser.any_instance.stub(:load).
+          with(File.expand_path('~/.puppet-lintrc')).and_return(false)
+        OptionParser.any_instance.stub(:load).
+          with(File.expand_path('~/.puppet-lint.rc')).and_return(false)
+        OptionParser.any_instance.stub(:load).
+          with('.puppet-lintrc').and_return(true)
+        OptionParser.any_instance.stub(:load).
+          with('.puppet-lint.rc').and_return(false)
+        OptionParser.any_instance.stub(:load).
+          with('/etc/puppet-lint.rc').and_return(false)
+
+        msg = 'Depreciated: Read .puppet-lintrc instead of .puppet-lint.rc'
+        subject.stderr.should == msg
+      end
+    end
+  end
+end