puppet-lint 0.1.9 → 0.1.10

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

@@ -2,31 +2,59 @@
 # http://docs.puppetlabs.com/guides/style_guide.html#spacing-indentation--whitespace
 
 class PuppetLint::Plugins::CheckWhitespace < PuppetLint::CheckPlugin
-  def test(path, data)
+  check 'hard_tabs' do
     line_no = 0
-    in_resource = false
-    selectors = []
-    resource_indent_length = 0
-    data.split("\n").each do |line|
+    manifest_lines.each do |line|
       line_no += 1
 
       # MUST NOT use literal tab characters
-      error "tab character found on line #{line_no}" if line.include? "\t"
+      notify :error, :message =>  "tab character found", :linenumber => line_no if line.include? "\t"
+    end
+  end
+
+  check 'trailing_whitespace' do
+    line_no = 0
+    manifest_lines.each do |line|
+      line_no += 1
 
       # MUST NOT contain trailing white space
-      error "trailing whitespace found on line #{line_no}" if line.end_with? " "
+      notify :error, :message =>  "trailing whitespace found", :linenumber => line_no if line.end_with? " "
+    end
+  end
+
+  check '80chars' do
+    line_no = 0
+    manifest_lines.each do |line|
+      line_no += 1
 
       # SHOULD NOT exceed an 80 character line width
       unless line =~ /puppet:\/\//
-        warn "line #{line_no} has more than 80 characters" if line.length > 80
+        notify :warning, :message =>  "line has more than 80 characters", :linenumber => line_no if line.length > 80
       end
+    end
+  end
+
+  check '2sp_soft_tabs' do
+    line_no = 0
+    manifest_lines.each do |line|
+      line_no += 1
 
       # MUST use two-space soft tabs
       line.scan(/^ +/) do |prefix|
         unless prefix.length % 2 == 0
-          error "two-space soft tabs not used on line #{line_no}"
+          notify :error, :message =>  "two-space soft tabs not used", :linenumber => line_no
         end
       end
+    end
+  end
+
+  check 'arrow_alignment' do
+    line_no = 0
+    in_resource = false
+    selectors = []
+    resource_indent_length = 0
+    manifest_lines.each do |line|
+      line_no += 1
 
       # SHOULD align fat comma arrows (=>) within blocks of attributes
       if line =~ /^( +.+? +)=>/
@@ -39,7 +67,7 @@ class PuppetLint::Plugins::CheckWhitespace < PuppetLint::CheckPlugin
 
             # check for length first
             unless line_indent.length == selectors.last
-              warn "=> on line #{line_no} isn't properly aligned for selector"
+              notify :warning, :message =>  "=> on line isn't properly aligned for selector", :linenumber => line_no
             end
 
             # then for a new selector or selector finish
@@ -50,7 +78,7 @@ class PuppetLint::Plugins::CheckWhitespace < PuppetLint::CheckPlugin
             end
           else
             unless line_indent.length == resource_indent_length
-              warn "=> on line #{line_no} isn't properly aligned for resource"
+              notify :warning, :message =>  "=> on line isn't properly aligned for resource", :linenumber => line_no
             end
 
             if line.strip.end_with? "{"

data/puppet-lint.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'puppet-lint'
-  s.version = '0.1.9'
+  s.version = '0.1.10'
   s.homepage = 'https://github.com/rodjek/puppet-lint/'
   s.summary = 'Ensure your Puppet manifests conform with the Puppetlabs style guide'
   s.description = 'Checks your Puppet manifests against the Puppetlabs
@@ -9,6 +9,7 @@ Gem::Specification.new do |s|
   s.executables = ['puppet-lint']
   s.files = [
     'bin/puppet-lint',
+    'lib/puppet-lint/configuration.rb',
     'lib/puppet-lint/plugin.rb',
     'lib/puppet-lint/plugins/check_classes.rb',
     'lib/puppet-lint/plugins/check_conditionals.rb',
@@ -33,6 +34,7 @@ Gem::Specification.new do |s|
   ]
 
   s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rdoc'
 
   s.authors = ['Tim Sharpe']
   s.email = 'tim@sharpe.id.au'

data/spec/puppet-lint/check_classes_spec.rb

@@ -3,29 +3,29 @@ require 'spec_helper'
 describe PuppetLint::Plugins::CheckClasses do
   subject do
     klass = described_class.new
-    klass.test(defined?(path).nil? ? '' : path, code)
+    klass.run(defined?(path).nil? ? '' : path, code)
     klass
   end
 
   describe 'chain 2 resources left to right' do
     let(:code) { "Class[foo] -> Class[bar]" }
 
-    its(:warnings) { should be_empty }
-    its(:errors) { should be_empty }
+    its(:problems) { should be_empty }
   end
 
   describe 'chain 2 resources right to left' do
     let(:code) { "Class[foo] <- Class[bar]" }
 
-    its(:warnings) { should include "right-to-left (<-) relationship on line 1" }
-    its(:errors) { should be_empty }
+    its(:problems) {
+      should have_problem :kind => :warning, :message => "right-to-left (<-) relationship", :linenumber => 1
+      should_not have_problem :kind => :error
+    }
   end
 
   describe 'class on its own' do
     let(:code) { "class foo { }" }
 
-    its(:warnings) { should be_empty }
-    its(:errors) { should be_empty }
+    its(:problems) { should be_empty }
   end
 
   describe 'class inside a class' do
@@ -36,8 +36,10 @@ describe PuppetLint::Plugins::CheckClasses do
       }"
     }
 
-    its(:warnings) { should include "class defined inside a class on line 3" }
-    its(:errors) { should be_empty }
+    its(:problems) {
+      should have_problem :kind => :warning, :message => "class defined inside a class", :linenumber => 3
+      should_not have_problem :kind => :error
+    }
   end
 
   describe 'define inside a class' do
@@ -48,50 +50,55 @@ describe PuppetLint::Plugins::CheckClasses do
       }"
     }
 
-    its(:warnings) { should include "define defined inside a class on line 3" }
-    its(:errors) { should be_empty }
+  its(:problems) {
+      should have_problem :kind => :warning, :message => "define defined inside a class", :linenumber => 3
+      should_not have_problem :kind => :error
+    }
   end
 
   describe 'class inheriting from its namespace' do
     let(:code) { "class foo::bar inherits foo { }" }
 
-    its(:warnings) { should be_empty }
-    its(:errors) { should be_empty }
+    its(:problems) { should be_empty }
   end
 
   describe 'class inheriting from another namespace' do
     let(:code) { "class foo::bar inherits baz { }" }
 
-    its(:warnings) { should include "class inherits across namespaces on line 1" }
-    its(:errors) { should be_empty }
+    its(:problems) {
+      should have_problem :kind => :warning, :message => "class inherits across namespaces", :linenumber => 1
+      should_not have_problem :kind => :error
+    }
   end
 
   describe 'class with attrs in order' do
     let(:code) { "class foo($bar, $baz='gronk') { }" }
 
-    its(:warnings) { should be_empty }
-    its(:errors) { should be_empty }
+    its(:problems) { should be_empty }
   end
 
   describe 'class with attrs out of order' do
     let(:code) { "class foo($bar='baz', $gronk) { }" }
 
-    its(:warnings) { should include "optional parameter listed before required parameter on line 1" }
-    its(:errors) { should be_empty }
+    its(:problems) {
+      should have_problem :kind => :warning, :message => "optional parameter listed before required parameter", :linenumber => 1
+      should_not have_problem :kind => :error
+    }
   end
 
   describe 'define with attrs in order' do
     let(:code) { "define foo($bar, $baz='gronk') { }" }
 
-    its(:warnings) { should be_empty }
-    its(:errors) { should be_empty }
+    its(:problems) { should be_empty }
   end
 
   describe 'define with attrs out of order' do
     let(:code) { "define foo($bar='baz', $gronk) { }" }
 
-    its(:warnings) { should include "optional parameter listed before required parameter on line 1" }
-    its(:errors) { should be_empty }
+    its(:problems) {
+      should have_problem :kind => :warning, :message => "optional parameter listed before required parameter", :linenumber => 1
+      should_not have_problem :kind => :error
+    }
   end
 
   describe 'class with no variables declared accessing top scope' do
@@ -101,8 +108,10 @@ describe PuppetLint::Plugins::CheckClasses do
       }"
     }
 
-    its(:warnings) { should include "top-scope variable being used without an explicit namespace on line 3" }
-    its(:errors) { should be_empty}
+    its(:problems) {
+      should have_problem :kind => :warning, :message => "top-scope variable being used without an explicit namespace", :linenumber => 3
+      should_not have_problem :kind => :error
+    }
   end
 
   describe 'class with no variables declared accessing top scope explicitly' do
@@ -112,8 +121,7 @@ describe PuppetLint::Plugins::CheckClasses do
       }"
     }
 
-    its(:warnings) { should be_empty }
-    its(:errors) { should be_empty }
+    its(:problems) { should be_empty }
   end
 
   describe 'class with variables declared accessing local scope' do
@@ -124,8 +132,7 @@ describe PuppetLint::Plugins::CheckClasses do
       }"
     }
 
-    its(:warnings) { should be_empty }
-    its(:errors) { should be_empty }
+    its(:problems) { should be_empty }
   end
 
   describe 'class with parameters accessing local scope' do
@@ -135,8 +142,7 @@ describe PuppetLint::Plugins::CheckClasses do
       }"
     }
 
-    its(:warnings) { should be_empty }
-    its(:errors) { should be_empty }
+    its(:problems) { should be_empty }
   end
 
   describe 'defined type with no variables declared accessing top scope' do
@@ -146,8 +152,10 @@ describe PuppetLint::Plugins::CheckClasses do
       }"
     }
 
-    its(:warnings) { should include "top-scope variable being used without an explicit namespace on line 3" }
-    its(:errors) { should be_empty }
+    its(:problems) {
+      should have_problem :kind => :warning, :message => "top-scope variable being used without an explicit namespace", :linenumber => 3
+      should_not have_problem :kind => :error
+    }
   end
 
   describe 'defined type with no variables declared accessing top scope explicitly' do
@@ -157,19 +165,20 @@ describe PuppetLint::Plugins::CheckClasses do
       }"
     }
 
-    its(:warnings) { should be_empty }
-    its(:errors) { should be_empty }
+    its(:problems) { should be_empty }
   end
 
   describe '$name should be auto defined' do
     let(:code) { "
       define foo() {
         $bar = $name
+        $baz = $title
+        $gronk = $module_name
+        $meep = $1
       }"
     }
 
-    its(:warnings) { should be_empty }
-    its(:errors) { should be_empty }
+    its(:problems) { should be_empty }
   end
 
   describe 'instantiating a parametised class inside a class' do
@@ -181,8 +190,7 @@ describe PuppetLint::Plugins::CheckClasses do
       }"
     }
 
-    its(:warnings) { should be_empty }
-    its(:errors) { should be_empty }
+    its(:problems) { should be_empty }
   end
 
   describe 'instantiating a parametised class inside a define' do
@@ -194,8 +202,7 @@ describe PuppetLint::Plugins::CheckClasses do
       }"
     }
 
-    its(:warnings) { should be_empty }
-    its(:errors) { should be_empty }
+    its(:problems) { should be_empty }
   end
 
   describe 'class/define parameter set to another variable' do
@@ -204,8 +211,7 @@ describe PuppetLint::Plugins::CheckClasses do
       }"
     }
 
-    its(:warnings) { should be_empty }
-    its(:errors) { should be_empty }
+    its(:problems) { should be_empty }
   end
 
   describe 'class/define parameter set to another variable with incorrect order' do
@@ -214,39 +220,39 @@ describe PuppetLint::Plugins::CheckClasses do
       }"
     }
 
-    its(:warnings) { should include "optional parameter listed before required parameter on line 2" }
-    its(:errors) { should be_empty }
+    its(:problems) {
+      should have_problem :kind => :warning, :message => "optional parameter listed before required parameter", :linenumber => 2
+      should_not have_problem :kind => :error
+    }
   end
 
   describe 'foo::bar in foo/manifests/bar.pp' do
     let(:code) { "class foo::bar { }" }
     let(:path) { '/etc/puppet/modules/foo/manifests/bar.pp' }
 
-    its(:warnings) { should be_empty }
-    its(:errors) { should be_empty }
+    its(:problems) { should be_empty }
   end
 
   describe 'foo::bar::baz in foo/manifests/bar/baz.pp' do
     let(:code) { 'define foo::bar::baz() { }' }
     let(:path) { '/etc/puppet/modules/foo/manifests/bar/baz.pp' }
 
-    its(:warnings) { should be_empty }
-    its(:errors) { should be_empty }
+    its(:problems) { should be_empty }
   end
 
   describe 'foo in foo/manifests/init.pp' do
     let(:code) { 'class foo { }' }
     let(:path) { '/etc/puppet/modules/foo/manifests/init.pp' }
 
-    its(:warnings) { should be_empty }
-    its(:errors) { should be_empty }
+    its(:problems) { should be_empty }
   end
 
   describe 'foo::bar in foo/manifests/init.pp' do
     let(:code) { 'class foo::bar { }' }
     let(:path) { '/etc/puppet/modules/foo/manifests/init.pp' }
 
-    its(:warnings) { should be_empty }
-    its(:errors) { should include "foo::bar not in autoload module layout on line 1" }
+    its(:problems) {
+      should only_have_problem :kind => :error, :message => "foo::bar not in autoload module layout", :linenumber => 1
+    }
   end
 end

data/spec/puppet-lint/check_conditionals_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe PuppetLint::Plugins::CheckConditionals do
   subject do
     klass = described_class.new
-    klass.test(defined?(path).nil? ? '' : path, code)
+    klass.run(defined?(path).nil? ? '' : path, code)
     klass
   end
 
@@ -17,8 +17,7 @@ describe PuppetLint::Plugins::CheckConditionals do
       }"
     }
 
-    its(:warnings) { should include "selector inside resource block on line 3" }
-    its(:errors) { should be_empty }
+    its(:problems) { should only_have_problem :kind => :warning, :message => "selector inside resource block", :linenumber => 3 }
   end
 
   describe 'resource with a variable as a attr value' do
@@ -28,8 +27,7 @@ describe PuppetLint::Plugins::CheckConditionals do
       }"
     }
 
-    its(:warnings) { should be_empty }
-    its(:errors) { should be_empty }
+    its(:problems) { should be_empty }
   end
 
   describe 'case statement with a default case' do
@@ -40,8 +38,7 @@ describe PuppetLint::Plugins::CheckConditionals do
       }"
     }
 
-    its(:warnings) { should be_empty }
-    its(:errors) { should be_empty }
+    its(:problems) { should be_empty }
   end
 
   describe 'case statement without a default case' do
@@ -52,7 +49,6 @@ describe PuppetLint::Plugins::CheckConditionals do
       }"
     }
 
-    its(:warnings) { should include "case statement without a default case on line 2" }
-    its(:errors) { should be_empty }
+    its(:problems) { should only_have_problem :kind => :warning, :message => "case statement without a default case", :linenumber => 2 }
   end
 end

data/spec/puppet-lint/check_resources_spec.rb

@@ -3,36 +3,35 @@ require 'spec_helper'
 describe PuppetLint::Plugins::CheckResources do
   subject do
     klass = described_class.new
-    klass.test(defined?(path).nil? ? '' : path, code)
+    klass.run(defined?(path).nil? ? '' : path, code)
     klass
   end
 
   describe '3 digit file mode' do
     let(:code) { "file { 'foo': mode => 777 }" }
 
-    its(:warnings) { should include "mode should be represented as a 4 digit octal value on line 1" }
-    its(:errors) { should be_empty }
+    its(:problems) {
+      should have_problem :kind => :warning, :message => "mode should be represented as a 4 digit octal value", :linenumber => 1
+      should_not have_problem :kind => :error
+    }
   end
 
   describe '4 digit file mode' do
     let(:code) { "file { 'foo': mode => '0777' }" }
 
-    its(:warnings) { should be_empty }
-    its(:errors) { should be_empty }
+    its(:problems) { should be_empty }
   end
 
   describe 'file mode as a variable' do
     let(:code) { "file { 'foo': mode => $file_mode }" }
 
-    its(:warnings) { should be_empty }
-    its(:errors) { should be_empty }
+    its(:problems) { should be_empty }
   end
 
   describe 'ensure as only attr in a single line resource' do
     let(:code) { "file { 'foo': ensure => present }" }
 
-    its(:warnings) { should be_empty }
-    its(:errors) { should be_empty }
+    its(:problems) { should be_empty }
   end
 
   describe 'ensure as only attr in a multi line resource' do
@@ -42,8 +41,7 @@ describe PuppetLint::Plugins::CheckResources do
       }"
     }
 
-    its(:warnings) { should be_empty }
-    its(:errors) { should be_empty }
+    its(:problems) { should be_empty }
   end
 
   describe 'ensure as second attr in a multi line resource' do
@@ -54,8 +52,10 @@ describe PuppetLint::Plugins::CheckResources do
       }"
     }
 
-    its(:warnings) { should include "ensure found on line 4 but it's not the first attribute" }
-    its(:errors) { should be_empty }
+    its(:problems) {
+      should have_problem :kind => :warning, :message => "ensure found on line but it's not the first attribute", :linenumber => 4
+      should_not have_problem :kind => :error
+    }
   end
 
   describe 'ensure as first attr in a multi line resource' do
@@ -66,22 +66,22 @@ describe PuppetLint::Plugins::CheckResources do
       }"
     }
 
-    its(:warnings) { should be_empty }
-    its(:errors) { should be_empty }
+    its(:problems) { should be_empty }
   end
 
   describe 'quoted resource title on single line resource' do
     let(:code) { "file { 'foo': }" }
 
-    its(:warnings) { should be_empty }
-    its(:errors) { should be_empty }
+    its(:problems) { should be_empty }
   end
 
   describe 'unquoted resource title on single line resource' do
     let(:code) { "file { foo: }" }
 
-    its(:warnings) { should include "unquoted resource title on line 1" }
-    its(:errors) { should be_empty }
+    its(:problems) {
+      should have_problem :kind => :warning, :message => "unquoted resource title", :linenumber => 1
+      should_not have_problem :kind => :error
+    }
   end
 
   describe 'quoted resource title on multi line resource' do
@@ -90,8 +90,7 @@ describe PuppetLint::Plugins::CheckResources do
       }"
     }
 
-    its(:warnings) { should be_empty }
-    its(:errors) { should be_empty }
+    its(:problems) { should be_empty }
   end
 
   describe 'unquoted resource title on multi line resource' do
@@ -100,8 +99,10 @@ describe PuppetLint::Plugins::CheckResources do
       }"
     }
 
-    its(:warnings) { should include "unquoted resource title on line 2" }
-    its(:errors) { should be_empty }
+    its(:problems) {
+      should have_problem :kind => :warning, :message => "unquoted resource title", :linenumber => 2
+      should_not have_problem :kind => :error
+    }
   end
 
   describe 'condensed resources with quoted titles' do
@@ -112,8 +113,7 @@ describe PuppetLint::Plugins::CheckResources do
       }"
     }
 
-    its(:warnings) { should be_empty }
-    its(:errors) { should be_empty }
+    its(:problems) { should be_empty }
   end
 
   describe 'condensed resources with an unquoted title' do
@@ -124,15 +124,16 @@ describe PuppetLint::Plugins::CheckResources do
       }"
     }
 
-    its(:warnings) { should include "unquoted resource title on line 4" }
-    its(:errors) { should be_empty }
+    its(:problems) {
+      should have_problem :kind => :warning, :message => "unquoted resource title", :linenumber => 4
+      should_not have_problem :kind => :error
+    }
   end
 
   describe 'single line resource with an array of titles (all quoted)' do
     let(:code) { "file { ['foo', 'bar']: }" }
 
-    its(:warnings) { should be_empty }
-    its(:errors) { should be_empty }
+    its(:problems) { should be_empty }
   end
 
   describe 'resource inside a case statement' do
@@ -146,8 +147,7 @@ describe PuppetLint::Plugins::CheckResources do
       }"
     }
 
-    its(:warnings) { should be_empty }
-    its(:errors) { should be_empty }
+    its(:problems) { should be_empty }
   end
 
   describe 'file resource creating a symlink with seperate target attr' do
@@ -158,8 +158,7 @@ describe PuppetLint::Plugins::CheckResources do
       }"
     }
 
-    its(:warnings) { should be_empty }
-    its(:errors) { should be_empty }
+    its(:problems) { should be_empty }
   end
 
   describe 'file resource creating a symlink with target specified in ensure' do
@@ -169,7 +168,9 @@ describe PuppetLint::Plugins::CheckResources do
       }"
     }
 
-    its(:warnings) { should include "symlink target specified in ensure attr on line 3" }
-    its(:errors) { should be_empty }
+    its(:problems) {
+      should have_problem :kind => :warning, :message => "symlink target specified in ensure attr", :linenumber => 3
+      should_not have_problem :kind => :error
+    }
   end
 end