puppet-lint 0.1.7 → 0.1.8

data/README.md

@@ -76,3 +76,5 @@ At the moment, the following tests have been implemented:
 If you find a bug in puppet-lint or its results, please create an issue in the
 [repo issues tracker](https://github.com/rodjek/puppet-lint/issues/).  Bonus
 points will be awarded if you also include a patch that fixes the issue.
+
+## Build status

data/bin/puppet-lint

@@ -17,7 +17,9 @@ require 'optparse'
 require 'rubygems'
 require 'puppet-lint'
 
-options = {}
+options = {
+  :error_level => :all,
+}
 opts = OptionParser.new do |opts|
   opts.banner = help
 
@@ -26,6 +28,14 @@ opts = OptionParser.new do |opts|
     exit 0
   end
 
+  opts.on("--with-filename", "Display the filename before the warning") do
+    options[:with_filename] = true
+  end
+
+  opts.on("--error-level LEVEL", [:all, :warning, :error], "The level of error to return (warning, error, all).") do |el|
+    options[:error_level] = el
+  end
+
   opts.on("--fail-on-warnings", "Return a non-zero exit status for warnings.") do
     options[:fail_on_warnings] = true
   end
@@ -47,8 +57,9 @@ if ARGV[0].nil?
 end
 
 begin
-  l = PuppetLint.new
+  l = PuppetLint.new(options)
   l.file = ARGV[0]
+  l.show_filename = options.has_key?(:with_filename) ? options[:with_filename] : false
   l.run
 
   if l.errors? or (l.warnings? and options[:fail_on_warnings])

data/lib/puppet-lint.rb

@@ -10,21 +10,33 @@ end
 require 'puppet-lint/plugin'
 require 'puppet-lint/plugins'
 
+unless String.respond_to?('prepend')
+  class String
+    def prepend(lead)
+      self.replace "#{lead}#{self}"
+    end
+  end
+end
+
 class PuppetLint::NoCodeError < StandardError; end
 
 class PuppetLint
-  VERSION = '0.1.7'
+  VERSION = '0.1.8'
 
-  attr_reader :code, :file
+  attr_reader :code, :file, :show_filename
 
-  def initialize
+  def initialize(options)
     @data = nil
     @errors = 0
     @warnings = 0
+    @show_filename = 0
+    @path = ''
+    @error_level = options[:error_level]
   end
 
   def file=(path)
     if File.exist? path
+      @path = path
       @data = File.read(path)
     end
   end
@@ -33,14 +45,23 @@ class PuppetLint
     @data = value
   end
 
+  def show_filename=(value)
+    @show_filename = value
+  end
+
   def report(kind, message)
+    #msg = message
     if kind == :warnings
       @warnings += 1
-      puts "WARNING: #{message}"
+      message.prepend('WARNING: ')
     else
       @errors += 1
-      puts "ERROR: #{message}"
+      message.prepend('ERROR: ')
+    end
+    if @show_filename
+      message.prepend("#{@path} - ")
     end
+    puts message
   end
 
   def errors?
@@ -57,9 +78,16 @@ class PuppetLint
     end
 
     PuppetLint::CheckPlugin.repository.each do |plugin|
-      problems = plugin.new.run(@data)
-      problems[:errors].each { |error| report :errors, error }
-      problems[:warnings].each { |warning| report :warnings, warning }
+      problems = plugin.new.run(@path, @data)
+      case @error_level
+      when :warning
+        problems[:warnings].each { |warning| report :warnings, warning }
+      when :error
+        problems[:errors].each { |error| report :errors, error }
+      else
+        problems[:warnings].each { |warning| report :warnings, warning }
+        problems[:errors].each { |error| report :errors, error }
+      end
     end
   end
 end

data/lib/puppet-lint/plugin.rb

@@ -33,8 +33,8 @@ class PuppetLint::CheckPlugin
     @errors << message
   end
 
-  def run(data)
-    test(data)
+  def run(path, data)
+    test(path, data)
 
     {:warnings => @warnings, :errors => @errors}
   end

data/lib/puppet-lint/plugins.rb

@@ -6,5 +6,6 @@ end
 require 'puppet-lint/plugins/check_classes'
 require 'puppet-lint/plugins/check_conditionals'
 require 'puppet-lint/plugins/check_strings'
+require 'puppet-lint/plugins/check_variables'
 require 'puppet-lint/plugins/check_whitespace'
 require 'puppet-lint/plugins/check_resources'

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

@@ -1,5 +1,5 @@
 class PuppetLint::Plugins::CheckClasses < PuppetLint::CheckPlugin
-  def test(data)
+  def test(path, data)
     lexer = Puppet::Parser::Lexer.new
     lexer.string = data
     tokens = lexer.fullscan
@@ -16,16 +16,35 @@ class PuppetLint::Plugins::CheckClasses < PuppetLint::CheckPlugin
         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
+
+            unless path.end_with? expected_path
+              error "#{title_token.last[:value]} not in autoload module layout on line #{title_token.last[:line]}"
+            end
+          end
+        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?
-                    warn "optional parameter listed before required parameter on line #{this_token.last[:line]}"
+                    unless prev_token.nil? or prev_token.first == :EQUALS
+                      warn "optional parameter listed before required parameter on line #{this_token.last[:line]}"
+                    end
                   end
                 end
               end

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

@@ -1,5 +1,5 @@
 class PuppetLint::Plugins::CheckConditionals < PuppetLint::CheckPlugin
-  def test(data)
+  def test(path, data)
     lexer = Puppet::Parser::Lexer.new
     lexer.string = data
     tokens = lexer.fullscan

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

@@ -2,7 +2,7 @@
 # http://docs.puppetlabs.com/guides/style_guide.html#resources
 
 class PuppetLint::Plugins::CheckResources < PuppetLint::CheckPlugin
-  def test(data)
+  def test(path, data)
     lexer = Puppet::Parser::Lexer.new
     lexer.string = data
     tokens = lexer.fullscan

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

@@ -14,7 +14,7 @@ class PuppetLint::Plugins::CheckStrings < PuppetLint::CheckPlugin
     end
   end
 
-  def test(data)
+  def test(path, data)
     l = Puppet::Parser::Lexer.new
     l.string = data
     tokens = l.fullscan
@@ -48,6 +48,15 @@ class PuppetLint::Plugins::CheckStrings < PuppetLint::CheckPlugin
         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
+
       if token.first == :SSTRING
         contents = token.last[:value]
         line_no = token.last[:line]
@@ -55,6 +64,10 @@ class PuppetLint::Plugins::CheckStrings < PuppetLint::CheckPlugin
         if contents.include? '${'
           error "single quoted string containing a variable found on line #{token.last[:line]}"
         end
+
+        if ['true', 'false'].include? contents
+          warn "quoted boolean value found on line #{token.last[:line]}"
+        end
       end
     end
   end

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

@@ -0,0 +1,19 @@
+class PuppetLint::Plugins::CheckVariables < PuppetLint::CheckPlugin
+  def test(path, data)
+    lexer = Puppet::Parser::Lexer.new
+    lexer.string = data
+    tokens = lexer.fullscan
+
+    tokens.each_index do |token_idx|
+      token = tokens[token_idx]
+
+      if token.first == :VARIABLE
+        variable = token.last[:value]
+        line_no = token.last[:line]
+        if variable.match(/-/)
+          warn "Variable contains a dash on line #{line_no}"
+        end
+      end
+    end
+  end
+end

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

@@ -1,13 +1,12 @@
 # Spacing, Identation & Whitespace
-# http://http://docs.puppetlabs.com/guides/style_guide.html#spacing-indentation--whitespace
+# http://docs.puppetlabs.com/guides/style_guide.html#spacing-indentation--whitespace
 
 class PuppetLint::Plugins::CheckWhitespace < PuppetLint::CheckPlugin
-  def test(data)
+  def test(path, data)
     line_no = 0
     in_resource = false
-    in_selector = false
+    selectors = []
     resource_indent_length = 0
-    selector_indent_length = 0
     data.split("\n").each do |line|
       line_no += 1
 
@@ -30,44 +29,43 @@ class PuppetLint::Plugins::CheckWhitespace < PuppetLint::CheckPlugin
       end
 
       # SHOULD align fat comma arrows (=>) within blocks of attributes
-      if in_selector
-        if line.strip =~ /\}[,;]?$/
-          in_selector = false
-          selector_indent_length = 0
-        end
-      end
-
-      if line =~ /^( +\w+ +)=>/
+      if line =~ /^( +.+? +)=>/
         line_indent = $1
         if in_resource
-          if in_selector
-            if selector_indent_length == 0
-              selector_indent_length = line_indent.length
+          if selectors.count > 0
+            if selectors.last == 0
+              selectors[-1] = line_indent.length
             end
 
-            unless line_indent.length == selector_indent_length
-              warn "=> on line #{line_no} isn't aligned with the previous line"
+            # check for length first
+            unless line_indent.length == selectors.last
+              warn "=> on line #{line_no} isn't properly aligned for selector"
             end
 
-            if line.strip =~ /\}[,;]?$/
-              in_selector = false
-              selector_indent_length = 0
-            end
-          else
+            # then for a new selector or selector finish
             if line.strip.end_with? "{"
-              in_selector = true
+              selectors.push(0)
+            elsif line.strip =~ /\}[,;]?$/
+              selectors.pop
             end
+          else
             unless line_indent.length == resource_indent_length
-              warn "=> on line #{line_no} isn't aligned with the previous line"
+              warn "=> on line #{line_no} isn't properly aligned for resource"
+            end
+
+            if line.strip.end_with? "{"
+              selectors.push(0)
             end
           end
         else
           resource_indent_length = line_indent.length
           in_resource = true
           if line.strip.end_with? "{"
-            in_selector = true
+            selectors.push(0)
           end
         end
+      elsif line.strip =~ /\}[,;]?$/ and selectors.count > 0
+        selectors.pop
       else
         in_resource = false
         resource_indent_length = 0

data/puppet-lint.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'puppet-lint'
-  s.version = '0.1.7'
+  s.version = '0.1.8'
   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
@@ -14,6 +14,7 @@ Gem::Specification.new do |s|
     'lib/puppet-lint/plugins/check_conditionals.rb',
     'lib/puppet-lint/plugins/check_resources.rb',
     'lib/puppet-lint/plugins/check_strings.rb',
+    'lib/puppet-lint/plugins/check_variables.rb',
     'lib/puppet-lint/plugins/check_whitespace.rb',
     'lib/puppet-lint/plugins.rb',
     'lib/puppet-lint/tasks/puppet-lint.rb',
@@ -26,6 +27,7 @@ Gem::Specification.new do |s|
     'spec/puppet-lint/check_conditionals_spec.rb',
     'spec/puppet-lint/check_resources_spec.rb',
     'spec/puppet-lint/check_strings_spec.rb',
+    'spec/puppet-lint/check_variables_spec.rb',
     'spec/puppet-lint/check_whitespace_spec.rb',
     'spec/spec_helper.rb',
   ]

data/spec/puppet-lint/check_classes_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe PuppetLint::Plugins::CheckClasses do
   subject do
     klass = described_class.new
-    klass.test(code)
+    klass.test(defined?(path).nil? ? '' : path, code)
     klass
   end
 
@@ -197,4 +197,56 @@ describe PuppetLint::Plugins::CheckClasses do
     its(:warnings) { should be_empty }
     its(:errors) { should be_empty }
   end
+
+  describe 'class/define parameter set to another variable' do
+    let(:code) { "
+      define foo($bar, $baz = $name, $gronk=$::fqdn) {
+      }"
+    }
+
+    its(:warnings) { should be_empty }
+    its(:errors) { should be_empty }
+  end
+
+  describe 'class/define parameter set to another variable with incorrect order' do
+    let(:code) { "
+      define foo($baz = $name, $bar, $gronk=$::fqdn) {
+      }"
+    }
+
+    its(:warnings) { should include "optional parameter listed before required parameter on line 2" }
+    its(:errors) { should be_empty }
+  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 }
+  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 }
+  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 }
+  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" }
+  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(code)
+    klass.test(defined?(path).nil? ? '' : path, code)
     klass
   end
 

data/spec/puppet-lint/check_resources_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe PuppetLint::Plugins::CheckResources do
   subject do
     klass = described_class.new
-    klass.test(code)
+    klass.test(defined?(path).nil? ? '' : path, code)
     klass
   end
 

data/spec/puppet-lint/check_strings_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe PuppetLint::Plugins::CheckStrings do
   subject do
     klass = described_class.new
-    klass.test(code)
+    klass.test(defined?(path).nil? ? '' : path, code)
     klass
   end
 
@@ -35,6 +35,15 @@ describe PuppetLint::Plugins::CheckStrings do
     its(:errors) { should be_empty }
   end
 
+  if Puppet.version.start_with? "2.7"
+    describe 'variable containing a dash' do
+      let(:code) { '" $foo-bar"' }
+
+      its(:warnings) { should include "variable contains a dash on line 1" }
+      its(:errors) { should be_empty }
+    end
+  end
+
   describe 'double quoted string nested in a single quoted string' do
     let(:code) { "'grep \"status=sent\" /var/log/mail.log'" }
 
@@ -55,4 +64,18 @@ describe PuppetLint::Plugins::CheckStrings do
     its(:warnings) { should be_empty }
     its(:errors) { should be_empty }
   end
+
+  describe 'quoted false' do
+    let(:code) { "class { 'foo': boolFlag => 'false' }" }
+
+    its(:warnings) { should include "quoted boolean value found on line 1" }
+    its(:errors) { should be_empty }
+  end
+
+  describe 'quoted true' do
+    let(:code) { "class { 'foo': boolFlag => 'true' }" }
+
+    its(:warnings) { should include "quoted boolean value found on line 1" }
+    its(:errors) { should be_empty }
+  end
 end

data/spec/puppet-lint/check_variables_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe PuppetLint::Plugins::CheckVariables do
+  subject do
+    klass = described_class.new
+    klass.test(defined?(path).nil? ? '' : path, code)
+    klass
+  end
+
+  if Puppet.version.start_with? "2.7"
+    describe 'a variable containing a dash' do
+      let(:code) { "$foo-bar" }
+
+      its(:warnings) { should include "Variable contains a dash on line 1" }
+      its(:errors) { should be_empty }
+    end
+  end
+end

data/spec/puppet-lint/check_whitespace_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe PuppetLint::Plugins::CheckWhitespace do
   subject do
     klass = described_class.new
-    klass.test(code)
+    klass.test(defined?(path).nil? ? '' : path, code)
     klass
   end
 
@@ -61,4 +61,53 @@ describe PuppetLint::Plugins::CheckWhitespace do
     its(:warnings) { should be_empty }
     its(:errors) { should be_empty }
   end
+
+  describe 'selector inside a hash inside a resource' do
+    let(:code) { "
+    server => {
+      ensure => ensure => $ensure ? {
+        present => directory,
+        absent  => undef,
+      },
+      ip     => '192.168.1.1'
+    },
+    owner  => 'foo4',
+    group  => 'foo4',
+    mode   => '0755'," }
+
+    its(:warnings) { should be_empty }
+    its(:errors) { should be_empty }
+  end
+
+  describe 'issue #37' do
+    let(:code) { "
+      class { 'lvs::base':
+        virtualeservers => {
+          '192.168.2.13' => {
+            vport           => '11025',
+            service         => 'smtp',
+            scheduler       => 'wlc',
+            protocol        => 'tcp',
+            checktype       => 'external',
+            checkcommand    => '/path/to/checkscript',
+            real_servers    => {
+              'server01' => {
+                real_server => '192.168.2.14',
+                real_port   => '25',
+                forwarding  => 'masq',
+              },
+              'server02' => {
+                real_server => '192.168.2.15',
+                real_port   => '25',
+                forwarding  => 'masq',
+              }
+            }
+          }
+        }
+      }"
+    }
+
+    its(:warnings) { should be_empty }
+    its(:errors) { should be_empty }
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: puppet-lint
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 11
   prerelease: 
   segments: 
   - 0
   - 1
-  - 7
-  version: 0.1.7
+  - 8
+  version: 0.1.8
 platform: ruby
 authors: 
 - Tim Sharpe
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-18 00:00:00 Z
+date: 2011-12-27 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -48,6 +48,7 @@ files:
 - lib/puppet-lint/plugins/check_conditionals.rb
 - lib/puppet-lint/plugins/check_resources.rb
 - lib/puppet-lint/plugins/check_strings.rb
+- lib/puppet-lint/plugins/check_variables.rb
 - lib/puppet-lint/plugins/check_whitespace.rb
 - lib/puppet-lint/plugins.rb
 - lib/puppet-lint/tasks/puppet-lint.rb
@@ -60,6 +61,7 @@ files:
 - spec/puppet-lint/check_conditionals_spec.rb
 - spec/puppet-lint/check_resources_spec.rb
 - spec/puppet-lint/check_strings_spec.rb
+- spec/puppet-lint/check_variables_spec.rb
 - spec/puppet-lint/check_whitespace_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/rodjek/puppet-lint/