puppet-lint 0.2.0.pre1 → 0.2.0

data/spec/puppet-lint/{check_classes_spec.rb → plugins/check_classes_spec.rb}

@@ -93,21 +93,28 @@ describe PuppetLint::Plugins::CheckClasses do
     }
   end
 
-  describe 'class with attrs in order' do
+  describe 'parameterised class with a default value' do
     let(:code) { "class foo($bar, $baz='gronk') { }" }
 
-    its(:problems) { should be_empty }
+    its(:problems) {
+      should only_have_problem({
+        :kind => :warning,
+        :message => 'parameterised class parameter without a default value',
+        :linenumber => 1,
+        :column     => 11,
+      })
+    }
   end
 
-  describe 'class with attrs out of order' do
-    let(:code) { "class foo($bar='baz', $gronk) { }" }
+  describe 'parameterised class that inherits from a params class' do
+    let(:code) { "class foo($bar = $name) inherits foo::params { }" }
 
     its(:problems) {
       should have_problem({
         :kind       => :warning,
-        :message    => "optional parameter listed before required parameter",
+        :message    => "class inheriting from params class",
         :linenumber => 1,
-        :column     => 23,
+        :column     => 34,
       })
       should_not have_problem :kind => :error
     }
@@ -119,6 +126,12 @@ describe PuppetLint::Plugins::CheckClasses do
     its(:problems) { should be_empty }
   end
 
+  describe 'define with parameter that calls a function' do
+    let(:code) { "define foo($bar=extlookup($name)) {}" }
+
+    its(:problems) { should == [] }
+  end
+
   describe 'define with attrs out of order' do
     let(:code) { "define foo($bar='baz', $gronk) { }" }
 
@@ -174,7 +187,7 @@ describe PuppetLint::Plugins::CheckClasses do
 
   describe 'class with parameters accessing local scope' do
     let(:code) { "
-      class foo($bar) {
+      class foo($bar='UNSET') {
         $baz = $bar
       }"
     }
@@ -320,4 +333,58 @@ describe PuppetLint::Plugins::CheckClasses do
     let(:fullpath) { '/etc/puppet/modules/bar/manifests/init.pp' }
     its(:problems) { should be_empty }
   end
+
+  describe 'issue-101' do
+    let(:code) { "
+      define b (
+        $foo,
+        $bar='',
+        $baz={}
+      ) { }
+    " }
+
+    its(:problems) { should == [] }
+  end
+
+  describe 'module named foo-bar' do
+    let(:code) { 'class foo-bar { }' }
+    let(:fullpath) { '/etc/puppet/modules/foo-bar/manifests/init.pp' }
+
+    its(:problems) do
+      should only_have_problem({
+        :kind       => :warning,
+        :message    => 'class name containing a dash',
+        :linenumber => 1,
+        :column     => 7,
+      })
+    end
+  end
+
+  describe 'define named foo-bar' do
+    let(:code) { 'define foo::foo-bar { }' }
+    let(:fullpath) { '/etc/puppet/modules/foo/manifests/foo-bar.pp' }
+
+    its(:problems) do
+      should only_have_problem({
+        :kind       => :warning,
+        :message    => 'defined type name containing a dash',
+        :linenumber => 1,
+        :column     => 8,
+      })
+    end
+  end
+
+  describe 'class named bar-foo' do
+    let(:code) { 'class foo::bar-foo { }' }
+    let(:fullpath) { '/etc/puppet/modules/foo/manifests/bar-foo.pp' }
+
+    its(:problems) do
+      should only_have_problem({
+        :kind       => :warning,
+        :message    => 'class name containing a dash',
+        :linenumber => 1,
+        :column     => 7,
+      })
+    end
+  end
 end

data/spec/puppet-lint/plugins/check_comments_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe PuppetLint::Plugins::CheckComments do
+  subject do
+    klass = described_class.new
+    fileinfo = {}
+    fileinfo[:fullpath] = defined?(fullpath).nil? ? '' : fullpath
+    klass.run(fileinfo, code)
+    klass
+  end
+
+  describe 'slash comments' do
+    let(:code) { "// foo" }
+
+    its(:problems) do
+      should only_have_problem({
+        :kind       => :warning,
+        :message    => '// comment found',
+        :linenumber => 1,
+        :column     => 1,
+      })
+    end
+  end
+
+  describe 'slash asterisk comment' do
+    let(:code) { "
+      /* foo
+      */
+    "}
+
+    its(:problems) do
+      should only_have_problem({
+        :kind       => :warning,
+        :message    => '/* */ comment found',
+        :linenumber => 2,
+        :column     => 7,
+      })
+    end
+  end
+end

data/spec/puppet-lint/{check_conditionals_spec.rb → plugins/check_conditionals_spec.rb}

@@ -67,4 +67,23 @@ describe PuppetLint::Plugins::CheckConditionals do
       })
     end
   end
+
+  describe 'issue-117' do
+    let(:code) { "
+      $mem = inline_template('<%
+        mem,unit = scope.lookupvar(\'::memorysize\').split
+        mem = mem.to_f
+        # Normalize mem to bytes
+        case unit
+            when nil:  mem *= (1<<0)
+            when \'kB\': mem *= (1<<10)
+            when \'MB\': mem *= (1<<20)
+            when \'GB\': mem *= (1<<30)
+            when \'TB\': mem *= (1<<40)
+        end
+        %><%= mem.to_i %>')
+    "}
+
+    its(:problems) { should == [] }
+  end
 end

data/spec/puppet-lint/plugins/check_documentation_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe PuppetLint::Plugins::CheckDocumentation do
+  subject do
+    klass = described_class.new
+    fileinfo = {}
+    fileinfo[:fullpath] = defined?(fullpath).nil? ? '' : fullpath
+    klass.run(fileinfo, code)
+    klass
+  end
+
+  describe 'undocumented class' do
+    let(:code) { "class test {}" }
+
+    its(:problems) do
+      should only_have_problem({
+        :kind       => :warning,
+        :message    => 'class not documented',
+        :linenumber => 1,
+        :column     => 1,
+      })
+    end
+  end
+
+  describe 'documented class' do
+    let(:code) { "
+      # foo
+      class test {}
+    "}
+
+    its(:problems) { should == [] }
+  end
+
+  describe 'undocumented defined type' do
+    let(:code) { "define test {}" }
+
+    its(:problems) do
+      should only_have_problem({
+        :kind       => :warning,
+        :message    => 'defined type not documented',
+        :linenumber => 1,
+        :column     => 1,
+      })
+    end
+  end
+
+  describe 'documented defined type' do
+    let(:code) { "
+      # foo
+      define test {}
+    "}
+
+    its(:problems) { should == [] }
+  end
+end

data/spec/puppet-lint/{check_resources_spec.rb → plugins/check_resources_spec.rb}

@@ -41,6 +41,20 @@ describe PuppetLint::Plugins::CheckResources do
     its(:problems) { should be_empty }
   end
 
+  describe 'file mode undef unquoted' do
+    let(:code) { "file { 'foo': mode => undef }" }
+
+    its(:problems) { should be_empty }
+  end
+
+  describe 'file mode undef quoted' do
+    let(:code) { "file { 'foo': mode => 'undef' }" }
+
+    its(:problems) {
+      should only_have_problem :kind => :warning, :message => "mode should be represented as a 4 digit octal value or symbolic mode", :linenumber => 1
+    }
+  end
+
   describe 'ensure as only attr in a single line resource' do
     let(:code) { "file { 'foo': ensure => present }" }
 
@@ -181,4 +195,55 @@ describe PuppetLint::Plugins::CheckResources do
       should only_have_problem :kind => :warning, :message => "symlink target specified in ensure attr", :linenumber => 3
     }
   end
+
+  # This should really be a lexer test, but I haven't had time to write that
+  # test suite yet.
+  describe 'issue #116' do
+    let(:code) { "
+      $config_file_init = $::operatingsystem ? {
+        /(?i:Debian|Ubuntu|Mint)/ => '/etc/default/foo',
+        default                   => '/etc/sysconfig/foo',
+      }"
+    }
+
+    its(:problems) { should == [] }
+  end
+
+  describe 'resource with duplicate parameters' do
+    let(:code) { "
+      file { '/tmp/foo':
+        ensure => present,
+        foo => bar,
+        baz => gronk,
+        foo => meh,
+      }"
+    }
+
+    its(:problems) {
+      should only_have_problem({
+        :kind       => :error,
+        :message    => 'duplicate parameter found in resource',
+        :linenumber => 6,
+        :column     => 9,
+      })
+    }
+  end
+
+  describe 'case statement' do
+    let(:code) { %{
+      case $operatingsystem {
+        centos: {
+          $version = '1.2.3'
+        }
+        solaris: {
+          $version = '3.2.1'
+        }
+        default: {
+          fail("Module ${module_name} is not supported on ${operatingsystem}")
+        }
+      }}
+    }
+
+    its(:problems) { should == [] }
+  end
 end

data/spec/puppet-lint/{check_strings_spec.rb → plugins/check_strings_spec.rb}

@@ -87,7 +87,7 @@ describe PuppetLint::Plugins::CheckStrings do
   end
 
   describe 'double quoted string containing newline but no variables' do
-    let(:code) { '"foo\n"' }
+    let(:code) { %{"foo\n"} }
 
     its(:problems) { should be_empty }
   end
@@ -155,4 +155,21 @@ describe PuppetLint::Plugins::CheckStrings do
       })
     }
   end
+
+  describe 'double quoted string with backslash for continuation' do
+    let(:code) { %{
+      class puppet::master::maintenance (
+      ) {
+        cron { 'puppet_master_reports_cleanup':
+          command     => "/usr/bin/find /var/lib/puppet/reports -type f -mtime +15 \
+                         -delete && /usr/bin/find /var/lib/puppet/reports -mindepth 1 \
+                         -empty -type d -delete",
+          minute      => '15',
+          hour        => '5',
+        }
+      }
+    } }
+
+    its(:problems) { should == [] }
+  end
 end

data/spec/puppet-lint/plugins/check_whitespace_spec.rb

@@ -0,0 +1,291 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe PuppetLint::Plugins::CheckWhitespace do
+  subject do
+    klass = described_class.new
+    klass.run(defined?(fullpath).nil? ? {:fullpath => ''} : {:fullpath => fullpath}, code)
+    klass
+  end
+
+  describe 'selectors inside a resource' do
+    let(:code) { "
+      file { 'foo':
+        ensure  => $ensure,
+        require => $ensure ? {
+          present => Class['tomcat::install'],
+          absent  => undef;
+        },
+        foo     => bar,
+      }"
+    }
+
+    its(:problems) { 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(:problems) { should be_empty }
+  end
+
+  describe 'file resource with a source line > 80c' do
+    let(:code) { "
+      file {
+        source  => 'puppet:///modules/certificates/etc/ssl/private/wildcard.example.com.crt',
+      }"
+    }
+
+    its(:problems) { should be_empty }
+  end
+
+  describe 'selector inside a resource' do
+    let(:code) { "
+    ensure => $ensure ? {
+      present => directory,
+      absent  => undef,
+    },
+    owner  => 'foo4',
+    group  => 'foo4',
+    mode   => '0755'," }
+
+    its(:problems) { 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(:problems) { should be_empty }
+  end
+
+
+  describe 'length of lines with UTF-8 characters' do
+    let(:code) { "
+      # ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+      # ┃          Configuration           ┃
+      # ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛"
+    }
+    its(:problems) {
+      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(:problems) { should be_empty }
+  end
+
+  describe 'single resource with a misaligned =>' do
+    let(:code) { "
+      file { '/tmp/foo':
+        foo => 1,
+        bar => 2,
+        gronk => 3,
+        baz  => 4,
+        meh => 5,
+      }"
+    }
+
+    its(:problems) do
+      should have_problem({
+        :kind       => :warning,
+        :message    => '=> is not properly aligned',
+        :linenumber => 5,
+        :column     => 15,
+      })
+      should have_problem({
+        :kind       => :warning,
+        :message    => '=> is not properly aligned',
+        :linenumber => 6,
+        :column     => 14,
+      })
+    end
+  end
+
+  describe 'complex resource with a misaligned =>' do
+    let(:code) { "
+      file { '/tmp/foo':
+        foo => 1,
+        bar  => $baz ? {
+          gronk => 2,
+          meh => 3,
+        },
+        meep => 4,
+        bah => 5,
+      }"
+    }
+
+    its(:problems) do
+      should have_problem({
+        :kind       => :warning,
+        :message    => '=> is not properly aligned',
+        :linenumber => 4,
+        :column     => 14,
+      })
+      should have_problem({
+        :kind       => :warning,
+        :message    => '=> is not properly aligned',
+        :linenumber => 6,
+        :column     => 15,
+      })
+      should have_problem({
+        :kind       => :warning,
+        :message    => '=> is not properly aligned',
+        :linenumber => 8,
+        :column     => 14,
+      })
+    end
+  end
+
+  describe 'multi-resource with a misaligned =>' do
+    let(:code) { "
+      file {
+        '/tmp/foo': ;
+        '/tmp/bar':
+          foo => 'bar';
+        '/tmp/baz':
+          gronk => 'bah',
+          meh => 'no'
+      }"
+    }
+
+    its(:problems) do
+      should only_have_problem({
+        :kind       => :warning,
+        :message    => '=> is not properly aligned',
+        :linenumber => 8,
+        :column     => 15,
+      })
+    end
+  end
+
+  describe 'multiple single line resources' do
+    let(:code) { "
+      file { 'foo': ensure => file }
+      package { 'bar': ensure => present }"
+    }
+
+    its(:problems) { should be_empty }
+  end
+
+  describe 'resource with unaligned => in commented line' do
+    let(:code) { "
+      file { 'foo':
+        ensure => directory,
+        # purge => true,
+      }"
+    }
+
+    its(:problems) { should be_empty }
+  end
+
+  describe 'hard tabs indents' do
+    let(:code) { "\tfoo => bar," }
+
+    its(:problems) {
+      should have_problem({
+        :kind       => :error,
+        :message    => 'tab character found',
+        :linenumber => 1,
+        :column     => 1,
+      })
+    }
+  end
+
+  describe 'line with trailing whitespace' do
+    let(:code) { "foo " }
+
+    its(:problems) {
+      should have_problem({
+        :kind       => :error,
+        :message    => 'trailing whitespace found',
+        :linenumber => 1,
+        :column     => 4,
+      })
+    }
+  end
+
+  describe '81 character line' do
+    let(:code) { 'a' * 81 }
+
+    its(:problems) {
+      should have_problem({
+        :kind       => :warning,
+        :message    => 'line has more than 80 characters',
+        :linenumber => 1,
+        :column     => 80,
+      })
+    }
+  end
+
+  describe 'line indented by 3 spaces' do
+    let(:code) { "
+      file { 'foo':
+         foo => bar,
+      }"
+    }
+
+    its(:problems) {
+      should have_problem({
+        :kind       => :error,
+        :message    => 'two-space soft tabs not used',
+        :linenumber => 3,
+        :column     => 1,
+      })
+    }
+  end
+
+  describe 'single line resource spread out on multiple lines' do
+    let(:code) {"
+      file {
+        'foo': ensure => present,
+      }"
+    }
+
+    its(:problems) { should == [] }
+  end
+end