puppet-lint 0.2.1 → 0.3.0

data/Gemfile

@@ -1,10 +1,7 @@
 source :rubygems
 
-puppetversion = ENV.key?('PUPPET_VERSION') ? "= #{ENV['PUPPET_VERSION']}" : ['>= 2.7']
-
 gem 'rake'
 gem 'rspec'
 gem 'rdoc'
 gem 'ruby-prof'
-gem 'puppet', puppetversion
 gem 'rcov', :platform => :ruby_18

data/README.md

@@ -237,10 +237,10 @@ wanted to skip the 80 character check, you would run
 puppet-lint --no-80chars-check /path/to/my/manifest.pp
 ```
 
-puppet-lint will also check for a `.puppet-lintrc` file in the current
+puppet-lint will also check for a `.puppet-lint.rc` file in the current
 directory and your home directory and read in flags from there, so if you
 wanted to always skip the hard tab character check, you could create
-`~./puppet-lintrc` containing
+`~./puppet-lint.rc` containing
 
 ```
 --no-hard_tabs-check

data/bin/puppet-lint

@@ -4,4 +4,4 @@ $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
 
 require 'puppet-lint'
 
-PuppetLint::Bin.new(ARGV).run
+exit PuppetLint::Bin.new(ARGV).run

data/lib/puppet-lint.rb

@@ -114,7 +114,17 @@ class PuppetLint
     puts format % message
   end
 
-  def report(problems)
+  def print_context(message, linter)
+    # XXX: I don't really like the way this has been implemented (passing the
+    # linter object down through layers of functions.  Refactor me!
+    return if message[:check] == 'documentation'
+    line = linter.manifest_lines[message[:linenumber] - 1]
+    offset = line.index(/\S/)
+    puts "\n  #{line.strip}"
+    printf "%#{message[:column] + 2 - offset}s\n\n", '^'
+  end
+
+  def report(problems, linter)
     problems.each do |message|
       @statistics[message[:kind]] += 1
       ## Add some default attributes.
@@ -123,6 +133,7 @@ class PuppetLint
 
       if configuration.error_level == message[:kind] or configuration.error_level == :all
         format_message message
+        print_context(message, linter) if configuration.with_context
       end
     end
   end
@@ -140,7 +151,9 @@ class PuppetLint
       raise PuppetLint::NoCodeError
     end
 
-    report PuppetLint::Checks.new.run(@fileinfo, @data)
+    linter = PuppetLint::Checks.new
+    problems = linter.run(@fileinfo, @data)
+    report problems, linter
   end
 end
 

data/lib/puppet-lint/bin.rb

@@ -25,6 +25,10 @@ class PuppetLint::Bin
         return 0
       end
 
+      opts.on('--with-context', 'Show where in the manifest the problem is') do
+        PuppetLint.configuration.with_context = true
+      end
+
       opts.on("--with-filename", "Display the filename before the warning") do
         PuppetLint.configuration.with_filename = true
       end

data/lib/puppet-lint/configuration.rb

@@ -61,6 +61,7 @@ class PuppetLint
       self.fail_on_warnings = false
       self.error_level = :all
       self.log_format = ''
+      self.with_context = false
     end
   end
 end

data/lib/puppet-lint/lexer.rb

@@ -126,12 +126,12 @@ class PuppetLint
             i += var_name.size + 1
 
           elsif chunk.match(/\A'(.*?)'/m)
-            str_content = StringScanner.new(code[i+1..-1]).scan_until(/(\A|[^\\])'/m)
+            str_content = StringScanner.new(code[i+1..-1]).scan_until(/(\A|\\\\|[^\\])'/m)
             tokens << new_token(:SSTRING, str_content[0..-2], :chunk => code[0..i])
             i += str_content.size + 1
 
           elsif chunk.match(/\A"/)
-            str_contents = StringScanner.new(code[i+1..-1]).scan_until(/(\A|[^\\])"/m)
+            str_contents = StringScanner.new(code[i+1..-1]).scan_until(/(\A|\\\\|[^\\])"/m)
             _ = code[0..i].split("\n")
             interpolate_string(str_contents, _.count, _.last.length)
             i += str_contents.size + 1
@@ -159,7 +159,7 @@ class PuppetLint
             i += mlcomment_size
 
           elsif chunk.match(/\A\/.*?\//) && possible_regex?
-            str_content = StringScanner.new(code[i+1..-1]).scan_until(/(\A|[^\\])\//m)
+            str_content = StringScanner.new(code[i+1..-1]).scan_until(/(\A|\\\\|[^\\])\//m)
             tokens << new_token(:REGEX, str_content[0..-2], :chunk => code[0..i])
             i += str_content.size + 1
 

data/lib/puppet-lint/plugin.rb

@@ -1,5 +1,6 @@
 class PuppetLint::Checks
   attr_reader :problems
+  attr_reader :manifest_lines
 
   def initialize
     @problems = []

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

@@ -67,7 +67,24 @@ class PuppetLint::Plugins::CheckClasses < PuppetLint::CheckPlugin
     end
   end
 
-  check 'parameterised_classes' do
+  check 'class_inherits_from_params_class' do
+    class_indexes.each do |class_idx|
+      class_tokens = tokens[class_idx[:start]..class_idx[:end]]
+      inherits_idx = class_tokens.index { |r| r.type == :INHERITS }
+      unless inherits_idx.nil?
+        inherited_class_token = tokens[inherits_idx].next_code_token
+        if inherited_class_token.value.end_with? '::params'
+          notify :warning, {
+            :message    => 'class inheriting from params class',
+            :linenumber => inherited_class_token.line,
+            :column     => inherited_class_token.column,
+          }
+        end
+      end
+    end
+  end
+
+  check 'class_parameter_defaults' do
     class_indexes.each do |class_idx|
       token_idx = class_idx[:start]
       depth = 0
@@ -91,21 +108,6 @@ class PuppetLint::Plugins::CheckClasses < PuppetLint::CheckPlugin
         end
       end
 
-      class_tokens = tokens[class_idx[:start]..class_idx[:end]].reject { |r|
-        formatting_tokens.include? r.type
-      }
-      inherits_idx = class_tokens.index { |r| r.type == :INHERITS }
-      unless inherits_idx.nil?
-        inherited_class_token = class_tokens[inherits_idx + 1]
-        if inherited_class_token.value.end_with? '::params'
-          notify :warning, {
-            :message    => 'class inheriting from params class',
-            :linenumber => inherited_class_token.line,
-            :column     => inherited_class_token.column,
-          }
-        end
-      end
-
       unless lparen_idx.nil? or rparen_idx.nil?
         param_tokens = tokens[lparen_idx+1..rparen_idx-1].reject { |r|
           formatting_tokens.include? r.type
@@ -137,7 +139,8 @@ class PuppetLint::Plugins::CheckClasses < PuppetLint::CheckPlugin
           end
         end
       end
-    end end
+    end
+  end
 
   # Public: Test the manifest tokens for any parameterised classes or defined
   # types that take parameters and record a warning if there are any optional
@@ -215,10 +218,12 @@ class PuppetLint::Plugins::CheckClasses < PuppetLint::CheckPlugin
 
       if inherits_token.type == :INHERITS
         inherited_class_token = inherits_token.next_code_token
+        inherited_module_name = inherited_class_token.value.split('::').reject { |r| r.empty? }.first
+        class_module_name = class_name_token.value.split('::').reject { |r| r.empty? }.first
 
-        unless class_name_token.value =~ /^#{inherited_class_token.value}::/
+        unless class_module_name == inherited_module_name
           notify :warning, {
-            :message    => "class inherits across namespaces",
+            :message    => "class inherits across module namespaces",
             :linenumber => inherited_class_token.line,
             :column     => inherited_class_token.column,
           }

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

@@ -51,18 +51,30 @@ class PuppetLint::Plugins::CheckResources < PuppetLint::CheckPlugin
       }
 
       seen_params = {}
+      level = 0
       resource_tokens.each_with_index do |token, idx|
+        case token.type
+        when :LBRACE
+          level += 1
+          next
+        when :RBRACE
+          seen_params[level] = {}
+          level -= 1
+          next
+        end
+        seen_params[level] ||= {}
+
         if token.type == :FARROW
           prev_token = resource_tokens[idx - 1]
           next unless prev_token.type == :NAME
-          if seen_params.include? prev_token.value
+          if seen_params[level].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
+            seen_params[level][prev_token.value] = true
           end
         end
       end

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

@@ -94,7 +94,7 @@ class PuppetLint::Plugins::CheckWhitespace < PuppetLint::CheckPlugin
 
           unless indent_depth.last == indent_length
             notify :warning, {
-              :message    => '=> is not properly aligned',
+              :message    => 'indentation of => is not properly aligned',
               :linenumber => token.line,
               :column     => token.column,
             }

data/lib/puppet-lint/version.rb

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

data/spec/puppet-lint/bin_spec.rb

@@ -103,6 +103,22 @@ describe PuppetLint::Bin do
     its(:stdout) { should match(/optional parameter/) }
   end
 
+  context 'when asked to provide context to problems' do
+    let(:args) { [
+      '--with-context',
+      'spec/fixtures/test/manifests/warning.pp',
+    ] }
+
+    its(:exitstatus) { should == 0 }
+    its(:stdout) { should == [
+      'WARNING: optional parameter listed before required parameter on line 2',
+      '',
+      "  define test::warning($foo='bar', $baz) { }",
+      '                                   ^',
+    ].join("\n")
+    }
+  end
+
   context 'when asked to fail on warnings' do
     let(:args) { [
       '--fail-on-warnings',

data/spec/puppet-lint/configuration_spec.rb

@@ -48,6 +48,7 @@ describe PuppetLint::Configuration do
       'fail_on_warnings' => false,
       'error_level' => :all,
       'log_format' => '',
+      'with_context' => false,
     }
   end
 end

data/spec/puppet-lint/lexer_spec.rb

@@ -710,6 +710,12 @@ describe PuppetLint::Lexer do
       token.type.should == :SSTRING
       token.value.should == ''
     end
+
+    it "should match an empty string ending with \\\\" do
+      token = @lexer.tokenise("'foo\\\\'").first
+      token.type.should == :SSTRING
+      token.value.should == %{foo\\\\}
+    end
   end
 
   context ':REGEX' do

data/spec/puppet-lint/plugins/check_classes/{parameterised_classes_spec.rb → class_inherits_from_params_class_spec.rb}

@@ -1,19 +1,6 @@
 require 'spec_helper'
 
-describe 'parameterised_classes' do
-  describe 'parameterised class with a default value' do
-    let(:code) { "class foo($bar, $baz='gronk') { }" }
-
-    its(:problems) {
-      should only_have_problem({
-        :kind => :warning,
-        :message => 'parameterised class parameter without a default value',
-        :linenumber => 1,
-        :column     => 11,
-      })
-    }
-  end
-
+describe 'class_inherits_from_params_class' do
   describe 'parameterised class that inherits from a params class' do
     let(:code) { "class foo($bar = $name) inherits foo::params { }" }
 

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

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe 'class_parameter_defaults' do
+  describe 'parameterised class with a default value' do
+    let(:code) { "class foo($bar, $baz='gronk') { }" }
+
+    its(:problems) {
+      should only_have_problem({
+        :kind => :warning,
+        :message => 'parameterised class parameter without a default value',
+        :linenumber => 1,
+        :column     => 11,
+      })
+    }
+  end
+
+  describe 'class without parameters' do
+    let(:code) {"
+      class myclass {
+
+        if ( $::lsbdistcodename == 'squeeze' ) {
+          #TODO
+        }
+      }
+    "}
+
+    its(:problems) { should == [] }
+  end
+
+  describe 'parameterised class with a function value' do
+    let(:code) { "class foo($bar = baz($gronk)) { }" }
+
+    its(:problems) { should == [] }
+  end
+end

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

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

data/spec/puppet-lint/plugins/check_resources/duplicate_params_spec.rb

@@ -20,4 +20,69 @@ describe 'duplicate_params' do
       })
     }
   end
+  describe 'bug #145: resource with a hash and no duplicate parameters' do
+    let (:code) { "
+      class {'fooname':
+        hashes => [
+          { foo => 'bar01',},
+          { foo => 'bar02', },
+        ],
+      }"
+    }
+    its (:problems) {
+      should be_empty
+    }
+  end
+
+  describe 'bug #145: resource with a hash and duplicate parameters in subhash' do
+    let (:code) { "
+      class {'fooname':
+        hashes => [
+          { foo => 'bar01',
+            foo => 'bar02', },
+        ],
+      }"
+    }
+    its (:problems) {
+      should only_have_problem({
+        :kind       => :error,
+        :message    => 'duplicate parameter found in resource',
+        :linenumber => 5,
+        :column     => 13,
+      })
+    }
+  end
+
+  describe 'bug #145: resource with a hash and duplicate parameters in parent type' do
+    let (:code) { "
+      class {'fooname':
+        hashes    => [
+          { foo     => 'bar01', },
+          { foo     => 'bar02', },
+        ],
+        something => { hash => 'mini', },
+        hashes    => 'dupe',
+      }"
+    }
+    its (:problems) {
+      should only_have_problem({
+        :kind       => :error,
+        :message    => 'duplicate parameter found in resource',
+        :linenumber => 8,
+        :column     => 9,
+      })
+    }
+  end
+  describe 'bug #145: more hash tests and no duplicate parameters' do
+    let (:code) { "
+      class test {
+        $foo = { param => 'value', }
+        $bar = { param => 'bar', }
+      }"
+    }
+    its (:problems) {
+      should be_empty
+    }
+
+  end
 end

data/spec/puppet-lint/plugins/check_whitespace/arrow_alignment_spec.rb

@@ -104,13 +104,13 @@ describe 'arrow_alignment' do
     its(:problems) do
       should have_problem({
         :kind       => :warning,
-        :message    => '=> is not properly aligned',
+        :message    => 'indentation of => is not properly aligned',
         :linenumber => 5,
         :column     => 15,
       })
       should have_problem({
         :kind       => :warning,
-        :message    => '=> is not properly aligned',
+        :message    => 'indentation of => is not properly aligned',
         :linenumber => 6,
         :column     => 14,
       })
@@ -133,19 +133,19 @@ describe 'arrow_alignment' do
     its(:problems) do
       should have_problem({
         :kind       => :warning,
-        :message    => '=> is not properly aligned',
+        :message    => 'indentation of => is not properly aligned',
         :linenumber => 4,
         :column     => 14,
       })
       should have_problem({
         :kind       => :warning,
-        :message    => '=> is not properly aligned',
+        :message    => 'indentation of => is not properly aligned',
         :linenumber => 6,
         :column     => 15,
       })
       should have_problem({
         :kind       => :warning,
-        :message    => '=> is not properly aligned',
+        :message    => 'indentation of => is not properly aligned',
         :linenumber => 8,
         :column     => 14,
       })
@@ -167,7 +167,7 @@ describe 'arrow_alignment' do
     its(:problems) do
       should only_have_problem({
         :kind       => :warning,
-        :message    => '=> is not properly aligned',
+        :message    => 'indentation of => is not properly aligned',
         :linenumber => 8,
         :column     => 15,
       })

metadata

@@ -1,72 +1,76 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: puppet-lint
-version: !ruby/object:Gem::Version
-  version: 0.2.1
+version: !ruby/object:Gem::Version 
+  hash: 19
   prerelease: 
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
-authors:
+authors: 
 - Tim Sharpe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-27 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-09-25 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rdoc
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rcov
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rcov
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-description: ! "Checks your Puppet manifests against the Puppetlabs\n  style guide
-  and alerts you to any discrepancies."
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: |-
+  Checks your Puppet manifests against the Puppetlabs
+    style guide and alerts you to any discrepancies.
 email: tim@sharpe.id.au
-executables:
+executables: 
 - puppet-lint
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .travis.yml
 - Gemfile
@@ -100,11 +104,12 @@ files:
 - spec/puppet-lint/lexer/token_spec.rb
 - spec/puppet-lint/lexer_spec.rb
 - spec/puppet-lint/plugins/check_classes/autoloader_layout_spec.rb
+- spec/puppet-lint/plugins/check_classes/class_inherits_from_params_class_spec.rb
+- spec/puppet-lint/plugins/check_classes/class_parameter_defaults_spec.rb
 - spec/puppet-lint/plugins/check_classes/inherits_across_namespaces_spec.rb
 - spec/puppet-lint/plugins/check_classes/names_containing_dash_spec.rb
 - spec/puppet-lint/plugins/check_classes/nested_classes_or_defines_spec.rb
 - spec/puppet-lint/plugins/check_classes/parameter_order_spec.rb
-- spec/puppet-lint/plugins/check_classes/parameterised_classes_spec.rb
 - spec/puppet-lint/plugins/check_classes/right_to_left_relationship_spec.rb
 - spec/puppet-lint/plugins/check_classes/variable_scope_spec.rb
 - spec/puppet-lint/plugins/check_comments/slash_comments_spec.rb
@@ -131,31 +136,41 @@ files:
 - spec/puppet-lint/plugins/check_whitespace/trailing_whitespace_spec.rb
 - spec/puppet-lint_spec.rb
 - spec/spec_helper.rb
+has_rdoc: true
 homepage: https://github.com/rodjek/puppet-lint/
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Ensure your Puppet manifests conform with the Puppetlabs style guide
-test_files:
+test_files: 
 - spec/fixtures/test/manifests/fail.pp
 - spec/fixtures/test/manifests/init.pp
 - spec/fixtures/test/manifests/warning.pp
@@ -164,11 +179,12 @@ test_files:
 - spec/puppet-lint/lexer/token_spec.rb
 - spec/puppet-lint/lexer_spec.rb
 - spec/puppet-lint/plugins/check_classes/autoloader_layout_spec.rb
+- spec/puppet-lint/plugins/check_classes/class_inherits_from_params_class_spec.rb
+- spec/puppet-lint/plugins/check_classes/class_parameter_defaults_spec.rb
 - spec/puppet-lint/plugins/check_classes/inherits_across_namespaces_spec.rb
 - spec/puppet-lint/plugins/check_classes/names_containing_dash_spec.rb
 - spec/puppet-lint/plugins/check_classes/nested_classes_or_defines_spec.rb
 - spec/puppet-lint/plugins/check_classes/parameter_order_spec.rb
-- spec/puppet-lint/plugins/check_classes/parameterised_classes_spec.rb
 - spec/puppet-lint/plugins/check_classes/right_to_left_relationship_spec.rb
 - spec/puppet-lint/plugins/check_classes/variable_scope_spec.rb
 - spec/puppet-lint/plugins/check_comments/slash_comments_spec.rb