puppet-lint 0.0.7 → 0.1.0

data/README.md

@@ -2,7 +2,7 @@
 
 The goal of this project is to implement as many of the recommended Puppet
 style guidelines from the [Puppetlabs style
-guide](http://docs.puppetlabs.com/guides/style_guide.html).
+guide](http://docs.puppetlabs.com/guides/style_guide.html) as practical.
 
 ## Installation
 
@@ -40,15 +40,36 @@ At the moment, the following tests have been implemented:
    quotes.
  * All strings that contain variables must be enclosed in double quotes.
  * All variables should be enclosed in braces when interpolated in a string.
+ * Variables standing by themselves should not be quoted.
 
 ### Resources
 
  * All resource titles should be quoted.
  * If a resource declaration includes an `ensure` attribute, it should be the
    first attribute specified.
+ * Symbolic links should be declared by using an ensure value of `link` and
+   explicitly specifying a value for the `target` attribute.
  * File modes should be represented as a 4 digit string enclosed in single
    quotes.
 
+### Conditionals
+
+ * You should not intermingle conditionals inside resource declarations (i.e.
+   selectors inside resources).
+ * Case statements should have a default case.
+
+### Classes
+
+ * Relationship declarations with the chaining syntax should only be used in
+   the 'left to right' direction.
+ * Classes should not be defined inside a class.
+ * Defines should not be defined inside a class.
+ * Classes should not inherit between namespaces.
+ * Required parameters in class & defined type definitions should be listed
+   before optional parameters.
+ # When using top-scope variables, including facts, Puppet modules should
+   explicitly specify the empty namespace.
+
 ## Reporting bugs or incorrect results
 
 If you find a bug in puppet-lint or its results, please create an issue in the

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

@@ -0,0 +1,119 @@
+class PuppetLint::Plugins::CheckClasses < PuppetLint::CheckPlugin
+  def test(data)
+    lexer = Puppet::Parser::Lexer.new
+    lexer.string = data
+    tokens = lexer.fullscan
+
+    tokens.select { |r| r.first == :OUT_EDGE }.each do |token|
+      warn "right-to-left (<-) relationship on line #{token.last[:line]}"
+    end
+
+    class_indexes = []
+    defined_type_indexes = []
+    tokens.each_index do |token_idx|
+      if [:DEFINE, :CLASS].include? tokens[token_idx].first
+        header_end_idx = tokens[token_idx..-1].index { |r| r.first == :LBRACE }
+        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 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]
+            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]}"
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+
+      if [:CLASS, :DEFINE].include? tokens[token_idx].first
+        if tokens[token_idx].first == :CLASS
+          if tokens[token_idx+2].first == :INHERITS
+            class_name = tokens[token_idx+1].last[:value]
+            inherited_class = tokens[token_idx+3].last[:value]
+
+            unless class_name =~ /^#{inherited_class}::/
+              warn "class inherits across namespaces on line #{tokens[token_idx].last[:line]}"
+            end
+          end
+        end
+
+        lbrace_count = 0
+        tokens[token_idx+1..-1].each_index do |class_token_idx|
+          idx = class_token_idx + token_idx
+          if tokens[idx].first == :LBRACE
+            lbrace_count += 1
+          elsif tokens[idx].first == :RBRACE
+            lbrace_count -= 1
+            if lbrace_count == 0
+              class_indexes << {:start => token_idx, :end => idx} if tokens[token_idx].first == :CLASS
+              defined_type_indexes << {:start => token_idx, :end => idx} if tokens[token_idx].first == :DEFINE
+              break
+            end
+          end
+        end
+      end
+    end
+
+    class_indexes.each do |class_idx|
+      class_tokens = tokens[class_idx[:start]..class_idx[:end]]
+      class_tokens[1..-1].select { |r| r.first == :CLASS }.each do |token|
+        warn "class defined inside a class on line #{token.last[:line]}"
+      end
+      class_tokens[1..-1].select { |r| r.first == :DEFINE }.each do |token|
+        warn "define defined inside a class on line #{token.last[:line]}"
+      end
+    end
+
+    (class_indexes + defined_type_indexes).each do |idx|
+      object_tokens = tokens[idx[:start]..idx[:end]]
+      variables_in_scope = []
+      referenced_variables = []
+      header_end_idx = object_tokens.index { |r| r.first == :LBRACE }
+      lparen_idx = object_tokens[0..header_end_idx].index { |r| r.first == :LPAREN }
+      rparen_idx = object_tokens[0..header_end_idx].rindex { |r| r.first == :RPAREN }
+
+      unless lparen_idx.nil? or rparen_idx.nil?
+        param_tokens = object_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]
+          if this_token.first == :VARIABLE
+            if [:COMMA, :EQUALS, :RPAREN].include? next_token.first
+              variables_in_scope << this_token.last[:value]
+            end
+          end
+        end
+      end
+
+      object_tokens.each_index do |object_token_idx|
+        this_token = object_tokens[object_token_idx]
+        next_token = object_tokens[object_token_idx + 1]
+
+        if this_token.first == :VARIABLE
+          if next_token.first == :EQUALS
+            variables_in_scope << this_token.last[:value]
+          else
+            referenced_variables << this_token
+          end
+        end
+      end
+
+      referenced_variables.each do |token|
+        unless token.last[:value].include? '::'
+          unless variables_in_scope.include? token.last[:value]
+            warn "top-scope variable being used without an explicit namespace on line #{token.last[:line]}"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+class PuppetLint::Plugins::CheckConditionals < PuppetLint::CheckPlugin
+  def test(data)
+    lexer = Puppet::Parser::Lexer.new
+    lexer.string = data
+    tokens = lexer.fullscan
+
+    resource_indexes = []
+    case_indexes = []
+
+    tokens.each_index do |token_idx|
+      if tokens[token_idx].first == :COLON
+        # gather a list of start and end indexes for resource attribute blocks
+        if tokens[token_idx+1].first != :LBRACE
+          resource_indexes << {:start => token_idx+1, :end => tokens[token_idx+1..-1].index { |r| [:SEMIC, :RBRACE].include? r.first }+token_idx}
+        end
+      end
+
+      if tokens[token_idx].first == :CASE
+        lbrace_count = 0
+        tokens[token_idx+1..-1].each_index do |case_token_idx|
+          idx = case_token_idx + token_idx
+          if tokens[idx].first == :LBRACE
+            lbrace_count += 1
+          elsif tokens[idx].first == :RBRACE
+            lbrace_count -= 1
+            if lbrace_count == 0
+              case_indexes << {:start => token_idx, :end => idx}
+              break
+            end
+          end
+        end
+      end
+    end
+
+    resource_indexes.each do |resource|
+      resource_tokens = tokens[resource[:start]..resource[:end]]
+
+      resource_tokens.each_index do |resource_token_idx|
+        if resource_tokens[resource_token_idx].first == :FARROW
+          if resource_tokens[resource_token_idx + 1].first == :VARIABLE
+            unless resource_tokens[resource_token_idx + 2].nil?
+              if resource_tokens[resource_token_idx + 2].first == :QMARK
+                warn "selector inside resource block on line #{resource_tokens[resource_token_idx].last[:line]}"
+              end
+            end
+          end
+        end
+      end
+    end
+
+    case_indexes.each do |kase|
+      case_tokens = tokens[kase[:start]..kase[:end]]
+
+      unless case_tokens.index { |r| r.first == :DEFAULT }
+        warn "case statement without a default case on line #{case_tokens.first.last[:line]}"
+      end
+    end
+  end
+end

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

@@ -16,7 +16,9 @@ class PuppetLint::Plugins::CheckResources < PuppetLint::CheckPlugin
           title_array_tokens = tokens[tokens.rindex { |r| r.first == :LBRACK }+1..token_idx-2]
           title_tokens += title_array_tokens.select { |token| [:STRING, :NAME].include? token.first }
         else
-          title_tokens << tokens[token_idx-1]
+          if tokens[token_idx + 1].first != :LBRACE
+            title_tokens << tokens[token_idx-1]
+          end
         end
 
         # gather a list of start and end indexes for resource attribute blocks
@@ -54,6 +56,11 @@ class PuppetLint::Plugins::CheckResources < PuppetLint::CheckPlugin
             if value_token.last[:value] !~ /\d{4}/
               warn "mode should be represented as a 4 digit octal value on line #{value_token.last[:line]}"
             end
+          elsif attr_token.first == :NAME and attr_token.last[:value] == 'ensure'
+            value_token = resource_tokens[resource_token_idx + 2]
+            if value_token.last[:value].start_with? '/'
+              warn "symlink target specified in ensure attr on line #{value_token.last[:line]}"
+            end
           end
         end
       end

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

@@ -18,6 +18,10 @@ class PuppetLint::Plugins::CheckStrings < PuppetLint::CheckPlugin
           unless variable_found
             warn "double quoted string containing no variables on line #{line_no}"
           end
+          if s =~ /^"\$\{[\w\:]+\}"$/
+            warn "string containing only a variable on line #{line_no}"
+          end
+
           line = line[line.index('"', line.index('"')+1)..-1]
         end
       end

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

@@ -34,6 +34,10 @@ class PuppetLint::Plugins::CheckWhitespace < PuppetLint::CheckPlugin
         line_indent = $1
         if in_resource
           if in_selector
+            if selector_indent_length == 0
+              selector_indent_length = line_indent.length
+            end
+
             unless line_indent.length == selector_indent_length
               warn "=> on line #{line_no} isn't aligned with the previous line"
             end
@@ -45,7 +49,6 @@ class PuppetLint::Plugins::CheckWhitespace < PuppetLint::CheckPlugin
           else
             if line.strip.end_with? "{"
               in_selector = true
-              selector_indent_length = resource_indent_length + 2
             end
             unless line_indent.length == resource_indent_length
               warn "=> on line #{line_no} isn't aligned with the previous line"
@@ -54,6 +57,9 @@ class PuppetLint::Plugins::CheckWhitespace < PuppetLint::CheckPlugin
         else
           resource_indent_length = line_indent.length
           in_resource = true
+          if line.strip.end_with? "{"
+            in_selector = true
+          end
         end
       else
         in_resource = false

data/lib/puppet-lint/plugins.rb

@@ -3,6 +3,8 @@ class PuppetLint
   end
 end
 
+require 'puppet-lint/plugins/check_classes'
+require 'puppet-lint/plugins/check_conditionals'
 require 'puppet-lint/plugins/check_strings'
 require 'puppet-lint/plugins/check_whitespace'
 require 'puppet-lint/plugins/check_resources'

data/lib/puppet-lint.rb

@@ -5,7 +5,7 @@ require 'puppet'
 class PuppetLint::NoCodeError < StandardError; end
 
 class PuppetLint
-  VERSION = '0.0.7'
+  VERSION = '0.1.0'
 
   attr_reader :code, :file
 

data/puppet-lint.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'puppet-lint'
-  s.version = '0.0.7'
+  s.version = '0.1.0'
   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
@@ -10,6 +10,8 @@ Gem::Specification.new do |s|
   s.files = [
     'bin/puppet-lint',
     'lib/puppet-lint/plugin.rb',
+    'lib/puppet-lint/plugins/check_classes.rb',
+    '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_whitespace.rb',
@@ -20,6 +22,8 @@ Gem::Specification.new do |s|
     'puppet-lint.gemspec',
     'Rakefile',
     'README.md',
+    'spec/puppet-lint/check_classes_spec.rb',
+    '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_whitespace_spec.rb',

data/spec/puppet-lint/check_classes_spec.rb

@@ -0,0 +1,163 @@
+require 'spec_helper'
+
+describe PuppetLint::Plugins::CheckClasses do
+  subject do
+    klass = described_class.new
+    klass.test(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 }
+  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 }
+  end
+
+  describe 'class on its own' do
+    let(:code) { "class foo { }" }
+
+    its(:warnings) { should be_empty }
+    its(:errors) { should be_empty }
+  end
+
+  describe 'class inside a class' do
+    let(:code) { "
+      class foo {
+        class bar {
+        }
+      }"
+    }
+
+    its(:warnings) { should include "class defined inside a class on line 3" }
+    its(:errors) { should be_empty }
+  end
+
+  describe 'define inside a class' do
+    let(:code) { "
+      class foo {
+        define bar() {
+        }
+      }"
+    }
+
+    its(:warnings) { should include "define defined inside a class on line 3" }
+    its(:errors) { should be_empty }
+  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 }
+  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 }
+  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 }
+  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 }
+  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 }
+  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 }
+  end
+
+  describe 'class with no variables declared accessing top scope' do
+    let(:code) { "
+      class foo {
+        $bar = $baz
+      }"
+    }
+
+    its(:warnings) { should include "top-scope variable being used without an explicit namespace on line 3" }
+    its(:errors) { should be_empty}
+  end
+
+  describe 'class with no variables declared accessing top scope explicitly' do
+    let(:code) { "
+      class foo {
+        $bar = $::baz
+      }"
+    }
+
+    its(:warnings) { should be_empty }
+    its(:errors) { should be_empty }
+  end
+
+  describe 'class with variables declared accessing local scope' do
+    let(:code) { "
+      class foo {
+        $bar = 1
+        $baz = $bar
+      }"
+    }
+
+    its(:warnings) { should be_empty }
+    its(:errors) { should be_empty }
+  end
+
+  describe 'class with parameters accessing local scope' do
+    let(:code) { "
+      class foo($bar) {
+        $baz = $bar
+      }"
+    }
+
+    its(:warnings) { should be_empty }
+    its(:errors) { should be_empty }
+  end
+
+  describe 'defined type with no variables declared accessing top scope' do
+    let(:code) { "
+      define foo() {
+        $bar = $fqdn
+      }"
+    }
+
+    its(:warnings) { should include "top-scope variable being used without an explicit namespace on line 3" }
+    its(:errors) { should be_empty }
+  end
+
+  describe 'defined type with no variables declared accessing top scope explicitly' do
+    let(:code) { "
+      define foo() {
+        $bar = $::fqdn
+      }"
+    }
+
+    its(:warnings) { should be_empty }
+    its(:errors) { should be_empty }
+  end
+end

data/spec/puppet-lint/check_conditionals_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe PuppetLint::Plugins::CheckConditionals do
+  subject do
+    klass = described_class.new
+    klass.test(code)
+    klass
+  end
+
+  describe 'resource with a selector' do
+    let(:code) { "
+      file { 'foo':
+        ensure => $bar ? {
+          true    => present,
+          default => absent,
+        },
+      }"
+    }
+
+    its(:warnings) { should include "selector inside resource block on line 3" }
+    its(:errors) { should be_empty }
+  end
+
+  describe 'resource with a variable as a attr value' do
+    let(:code) { "
+      file { 'foo',
+        ensure => $bar,
+      }"
+    }
+
+    its(:warnings) { should be_empty }
+    its(:errors) { should be_empty }
+  end
+
+  describe 'case statement with a default case' do
+    let(:code) { "
+      case $foo {
+        bar: { }
+        default: { }
+      }"
+    }
+
+    its(:warnings) { should be_empty }
+    its(:errors) { should be_empty }
+  end
+
+  describe 'case statement without a default case' do
+    let(:code) { "
+      case $foo {
+        bar: { }
+        baz: { }
+      }"
+    }
+
+    its(:warnings) { should include "case statement without a default case on line 2" }
+    its(:errors) { should be_empty }
+  end
+end

data/spec/puppet-lint/check_resources_spec.rb

@@ -142,4 +142,27 @@ describe PuppetLint::Plugins::CheckResources do
     its(:warnings) { should be_empty }
     its(:errors) { should be_empty }
   end
+
+  describe 'file resource creating a symlink with seperate target attr' do
+    let(:code) { "
+      file { 'foo':
+        ensure => link,
+        target => '/foo/bar',
+      }"
+    }
+
+    its(:warnings) { should be_empty }
+    its(:errors) { should be_empty }
+  end
+
+  describe 'file resource creating a symlink with target specified in ensure' do
+    let(:code) { "
+      file { 'foo':
+        ensure => '/foo/bar',
+      }"
+    }
+
+    its(:warnings) { should include "symlink target specified in ensure attr on line 3" }
+    its(:errors) { should be_empty }
+  end
 end

data/spec/puppet-lint/check_strings_spec.rb

@@ -20,4 +20,11 @@ describe PuppetLint::Plugins::CheckStrings do
     its(:warnings) { should include "double quoted string containing no variables on line 1" }
     its(:errors) { should include "single quoted string containing a variable found on line 1" }
   end
+
+  describe 'string containing only a variable' do
+    let(:code) { '"${foo}"' }
+
+    its(:warnings) { should include "string containing only a variable on line 1" }
+    its(:errors) { should be_empty }
+  end
 end

data/spec/puppet-lint/check_whitespace_spec.rb

@@ -22,6 +22,21 @@ describe PuppetLint::Plugins::CheckWhitespace do
     its(:errors) { should be_empty }
   end
 
+  describe 'selectors in the middle of a resource' do
+    let(:code) { "
+      file { 'foo':
+        ensure => $ensure ? {
+          present => directory,
+          absent  => undef,
+        },
+        owner  => 'tomcat6',
+      }"
+    }
+
+    its(:warnings) { should be_empty }
+    its(:errors) { should be_empty }
+  end
+
   describe 'file resource with a source line > 80c' do
     let(:code) { "
       file {

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: puppet-lint
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 27
   prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 7
-  version: 0.0.7
+  version: 0.1.0
 platform: ruby
 authors: 
 - Tim Sharpe
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-21 00:00:00 Z
+date: 2011-08-23 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -44,6 +44,8 @@ extra_rdoc_files: []
 files: 
 - bin/puppet-lint
 - lib/puppet-lint/plugin.rb
+- lib/puppet-lint/plugins/check_classes.rb
+- 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_whitespace.rb
@@ -54,6 +56,8 @@ files:
 - puppet-lint.gemspec
 - Rakefile
 - README.md
+- spec/puppet-lint/check_classes_spec.rb
+- 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_whitespace_spec.rb