puppet-lint 0.1.12 → 0.1.13

data/.travis.yml

@@ -0,0 +1,24 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+branches:
+  only:
+    - master
+notifications:
+  email:
+    - tim@github.com
+env:
+  - PUPPET_VERSION=2.6.13
+  - PUPPET_VERSION=2.7.9
+  - PUPPET_VERSION=0.25.4
+matrix:
+  exclude:
+    - rvm: 1.9.2
+      env: PUPPET_VERSION=2.6.13
+    - rvm: 1.9.3
+      env: PUPPET_VERSION=2.6.13
+    - rvm: 1.9.2
+      env: PUPPET_VERSION=0.25.4
+    - rvm: 1.9.3
+      env: PUPPET_VERSION=0.25.4

data/Gemfile

@@ -0,0 +1,8 @@
+source :rubygems
+
+puppetversion = ENV.key?('PUPPET_VERSION') ? "= #{ENV['PUPPET_VERSION']}" : ['>= 2.7']
+
+gem 'rake'
+gem 'rspec'
+gem 'rdoc'
+gem 'puppet', puppetversion

data/README.md

@@ -1,5 +1,10 @@
 # Puppet-lint
 
+[![Build
+Status](https://secure.travis-ci.org/rodjek/puppet-lint.png)](http://travis-ci.org/rodjek/puppet-lint)
+[![Dependency
+Status](https://gemnasium.com/rodjek/puppet-lint.png)](http://gemnasium.com/rodjek/puppet-lint)
+
 The goal of this project is to implement as many of the recommended Puppet
 style guidelines from the [Puppet Labs style
 guide](http://docs.puppetlabs.com/guides/style_guide.html) as practical.
@@ -10,10 +15,14 @@ guide](http://docs.puppetlabs.com/guides/style_guide.html) as practical.
 
 ## Testing your manifests
 
+### By hand
+
 You can test a single manifest file by running
 
     puppet-lint <path to file>
 
+### Rake task
+
 If you want to test your entire Puppet manifest directory, you can add
 `require 'puppet-lint/tasks/puppet-lint'` to your Rakefile and then run
 
@@ -51,7 +60,7 @@ At the moment, the following tests have been implemented:
  * 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.
+   quotes or use symbolic file modes.
 
 ### Conditionals
 
@@ -71,10 +80,224 @@ At the moment, the following tests have been implemented:
  * When using top-scope variables, including facts, Puppet modules should
    explicitly specify the empty namespace.
 
+## Fixing problems
+
+### right_to_left_relationship
+
+```
+WARNING: right-to-left (<-) relationship on line X
+```
+
+While right to left relationships are perfectly valid, it's highly recommended
+that you don't use them as most people think and read from left to right and
+this can lead to confusion.
+
+Bad:
+
+```
+Service['httpd'] <- Package['httpd']
+```
+
+Good:
+
+```
+Package['httpd'] -> Service['httpd']
+```
+
+### autoloader_layout
+
+```
+ERROR: mymodule::myclass not in autoload module layout on line X
+```
+
+Puppet attempts to autoload only the required manifests for the resources and
+classes specified in your manifests.  In order to do this, the autoloader
+expects your manifests to be layed out on disk in a particular format.  For
+example, when you use `mymodule::myclass` in your manifests, Puppet will
+attempt to read `<modulepath>/mymodule/manifests/myclass.pp`.  The only
+exception to this is when you reference `mymodule` itself (without any
+subclass/subtype) in which case it will read
+`<modulepath>/mymodule/manifests/init.pp`.
+
+### parameter_order
+
+```
+WARNING: optional parameter listed before required parameter on line X
+```
+
+In parameterised class and defined type definitions, parameters that are
+required should be listed before optional parameters (those with default
+values).
+
+Bad:
+
+```
+class foo($bar='baz', $gronk) {
+```
+
+Good:
+
+```
+class foo($gronk, $bar='baz') {
+```
+
+### inherits_across_namespaces
+
+Placeholder
+
+### nested_classes_or_defines
+
+Placeholder
+
+### variable_scope
+
+Placeholder
+
+### selector_inside_resource
+
+Placeholder
+
+### case_without_default
+
+Placeholder
+
+### unquoted_resource_title
+
+Placeholder
+
+### ensure_first_param
+
+Placeholder
+
+### unquoted_file_mode
+
+Placeholder
+
+### 4digit_file_mode
+
+Placeholder
+
+### ensure_not_symlink_target
+
+Placeholder
+
+### double_quoted_strings
+
+Placeholder
+
+### only_variable_string
+
+Placeholder
+
+### variables_not_enclosed
+
+Placeholder
+
+### single_quote_string_with_variables
+
+Placeholder
+
+### quoted_booleans
+
+Placeholder
+
+### variable_contains_dash
+
+Placeholder
+
+### hard_tabs
+
+Placeholder
+
+### trailing_whitespace
+
+Placeholder
+
+### 80chars
+
+Placeholder
+
+### 2sp_soft_tabs
+
+Placeholder
+
+### arrow_alignment
+
+Placeholder
+
+## Disabling checks
+
+### puppet-lint
+
+You can disable any of the checks when running the `puppet-lint` command by
+adding a `--disable-<check name>` flag to the command.  For example, if you
+wanted to skip the 80 character check, you would run
+
+```
+puppet-lint --disable-80chars /path/to/my/manifest.pp
+```
+
+puppet-lint will also check for a `.puppet-lintrc` 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
+
+```
+--disable-hard_tabs
+```
+
+### Rake task
+
+You can also disable checks when running puppet-lint through the supplied Rake
+task.  Simply add the following line after the `require` statement in your
+`Rakefile`.
+
+``` ruby
+PuppetLint.configuration.send("disable_<check name")
+```
+
+So, to disable the 80 character check, you would add:
+
+``` ruby
+PuppetLint.configuration.send("disable_80chars")
+```
+
 ## Reporting bugs or incorrect results
 
 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
+## Thank You
+
+Many thanks to the following people for contributing to puppet-lint
+
+ * James Turnbull (@kartar)
+ * Jan Vansteenkiste (@vStone)
+ * Julian Simpson (@simpsonjulian)
+ * S. Zachariah Sprackett (@zsprackett)
+
+As well as the many people who have reported the issues they've had!
+
+## License
+
+Copyright (c) 2011 Tim Sharpe
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/bin/puppet-lint

@@ -80,13 +80,21 @@ if ARGV[0].nil?
 end
 
 begin
-  l = PuppetLint.new
-  l.file = ARGV[0]
-  l.run
+  path = ARGV[0]
+  if File.directory?(path)
+    Dir.chdir(path)
+    path = Dir.glob('**/*.pp')
+  end
 
-  if l.errors? or (l.warnings? and PuppetLint.configuration.fail_on_warnings)
-    exit 1
+  path.each do |f|
+    l = PuppetLint.new
+    l.file = f
+    l.run
+    if l.errors? or (l.warnings? and PuppetLint.configuration.fail_on_warnings)
+      exit 1
+    end
   end
+
 rescue PuppetLint::NoCodeError
   puts "puppet-lint: no file specified or specified file does not exist"
   puts "puppet-lint: try 'puppet-lint --help' for more information"

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

@@ -1,7 +1,9 @@
 class PuppetLint::Plugins::CheckClasses < PuppetLint::CheckPlugin
-  check 'right_to_left_relationship' do
-    tokens.select { |r| r.first == :OUT_EDGE }.each do |token|
-      notify :warning, :message =>  "right-to-left (<-) relationship", :linenumber => token.last[:line]
+  if Puppet::PUPPETVERSION !~ /^0\.2/
+    check 'right_to_left_relationship' do
+      tokens.select { |r| r.first == :OUT_EDGE }.each do |token|
+        notify :warning, :message =>  "right-to-left (<-) relationship", :linenumber => token.last[:line]
+      end
     end
   end
 
@@ -89,7 +91,7 @@ class PuppetLint::Plugins::CheckClasses < PuppetLint::CheckPlugin
   check 'variable_scope' do
     (class_indexes + defined_type_indexes).each do |idx|
       object_tokens = tokens[idx[:start]..idx[:end]]
-      variables_in_scope = ['name', 'title', 'module_name']
+      variables_in_scope = ['name', 'title', 'module_name', 'environment', 'clientcert', 'clientversion', 'servername', 'serverip', 'serverversion', 'caller_module_name']
       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 }

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

@@ -41,7 +41,7 @@ class PuppetLint::Plugins::CheckResources < PuppetLint::CheckPlugin
     end
   end
 
-  check '4digit_file_mode' do
+  check 'file_mode' do
     resource_indexes.each do |resource|
       resource_tokens = tokens[resource[:start]..resource[:end]]
       resource_type_token = tokens[tokens[0..resource[:start]].rindex { |r| r.first == :LBRACE } - 1]
@@ -50,8 +50,8 @@ class PuppetLint::Plugins::CheckResources < PuppetLint::CheckPlugin
           attr_token = resource_tokens[resource_token_idx]
           if attr_token.first == :NAME and attr_token.last[:value] == 'mode'
             value_token = resource_tokens[resource_token_idx + 2]
-            if value_token.last[:value] !~ /\d{4}/ and value_token.first != :VARIABLE
-              notify :warning, :message =>  "mode should be represented as a 4 digit octal value", :linenumber => value_token.last[:line]
+            if value_token.last[:value] !~ /\d{4}/ and value_token.first != :VARIABLE and value_token.last[:value] !~ /^([ugoa]*[-=+][-=+rstwxXugo]*)(,[ugoa]*[-=+][-=+rstwxXugo]*)*$/
+              notify :warning, :message =>  "mode should be represented as a 4 digit octal value or symbolic file mode", :linenumber => value_token.last[:line]
             end
           end
         end

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

@@ -9,8 +9,15 @@ class PuppetLint::Plugins::CheckStrings < PuppetLint::CheckPlugin
     TOKENS.add_tokens("<single quotes string>" => :SSTRING)
     TOKENS.del_token(:SQUOTE)
 
-    TOKENS.add_token :SQUOTE, "'" do |lexer, value|
-      [TOKENS[:SSTRING], lexer.slurpstring(value,["'"],:ignore_invalid_escapes).first ]
+    if Puppet::PUPPETVERSION =~ /^0\.2/
+      TOKENS.add_token :SQUOTE, "'" do |lexer, value|
+        value = lexer.slurpstring(value)
+        [TOKENS[:SSTRING], value]
+      end
+    else
+      TOKENS.add_token :SQUOTE, "'" do |lexer, value|
+        [ TOKENS[:SSTRING], lexer.slurpstring(value,["'"],:ignore_invalid_escapes).first ]
+      end
     end
   end
 
@@ -22,6 +29,10 @@ class PuppetLint::Plugins::CheckStrings < PuppetLint::CheckPlugin
         unless token.last[:value].include? "\t" or token.last[:value].include? "\n"
           notify :warning, :message =>  "double quoted string containing no variables", :linenumber => token.last[:line]
         end
+      elsif token.first == :DQTEXT
+        unless token.last[:value].include? "\\t" or token.last[:value].include? "\\n" or token.last[:value] =~ /[^\\]?\$\{?/
+          notify :warning, :message =>  "double quoted string containing no variables", :linenumber => token.last[:line]
+        end
       end
     end
   end
@@ -37,6 +48,9 @@ class PuppetLint::Plugins::CheckStrings < PuppetLint::CheckPlugin
           end
         end
       end
+      if token.first == :DQTEXT and token.last[:value] =~ /\A\$\{.+\}\Z/
+        notify :warning, :message =>  "string containing only a variable", :linenumber => token.last[:line]
+      end
     end
   end
 
@@ -54,6 +68,8 @@ class PuppetLint::Plugins::CheckStrings < PuppetLint::CheckPlugin
             end
           end
         end
+      elsif token.first == :DQTEXT and token.last[:value] =~ /\$\w+/
+        notify :warning, :message =>  "variable not enclosed in {}", :linenumber => token.last[:line]
       end
     end
   end

data/puppet-lint.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'puppet-lint'
-  s.version = '0.1.12'
+  s.version = '0.1.13'
   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
@@ -8,7 +8,9 @@ Gem::Specification.new do |s|
 
   s.executables = ['puppet-lint']
   s.files = [
+    '.travis.yml',
     'bin/puppet-lint',
+    'Gemfile',
     'lib/puppet-lint/configuration.rb',
     'lib/puppet-lint/plugin.rb',
     'lib/puppet-lint/plugins/check_classes.rb',

data/spec/puppet-lint/check_classes_spec.rb

@@ -7,19 +7,21 @@ describe PuppetLint::Plugins::CheckClasses do
     klass
   end
 
-  describe 'chain 2 resources left to right' do
-    let(:code) { "Class[foo] -> Class[bar]" }
+  if Puppet::PUPPETVERSION !~ /^0\.2/
+    describe 'chain 2 resources left to right' do
+      let(:code) { "Class[foo] -> Class[bar]" }
 
-    its(:problems) { should be_empty }
-  end
+      its(:problems) { should be_empty }
+    end
 
-  describe 'chain 2 resources right to left' do
-    let(:code) { "Class[foo] <- Class[bar]" }
+    describe 'chain 2 resources right to left' do
+      let(:code) { "Class[foo] <- Class[bar]" }
 
-    its(:problems) {
-      should have_problem :kind => :warning, :message => "right-to-left (<-) relationship", :linenumber => 1
-      should_not have_problem :kind => :error
-    }
+      its(:problems) {
+        should have_problem :kind => :warning, :message => "right-to-left (<-) relationship", :linenumber => 1
+        should_not have_problem :kind => :error
+      }
+    end
   end
 
   describe 'class on its own' do

data/spec/puppet-lint/check_resources_spec.rb

@@ -11,7 +11,7 @@ describe PuppetLint::Plugins::CheckResources do
     let(:code) { "file { 'foo': mode => 777 }" }
 
     its(:problems) {
-      should have_problem :kind => :warning, :message => "mode should be represented as a 4 digit octal value", :linenumber => 1
+      should have_problem :kind => :warning, :message => "mode should be represented as a 4 digit octal value or symbolic file mode", :linenumber => 1
       should_not have_problem :kind => :error
     }
   end
@@ -22,12 +22,27 @@ describe PuppetLint::Plugins::CheckResources do
     its(:problems) { should be_empty }
   end
 
+  describe '4 digit unquoted file mode' do
+    let(:code) { "file { 'foo': mode => 0777 }" }
+
+    its(:problems) {
+      should have_problem :kind => :warning, :message => "unquoted file mode"
+      should_not have_problem :kind => :error
+    }
+  end
+
   describe 'file mode as a variable' do
     let(:code) { "file { 'foo': mode => $file_mode }" }
 
     its(:problems) { should be_empty }
   end
 
+  describe 'symbolic file mode' do
+    let(:code) { "file { 'foo': mode => 'u=rw,og=r' }" }
+
+    its(:problems) { should be_empty }
+  end
+
   describe 'ensure as only attr in a single line resource' do
     let(:code) { "file { 'foo': ensure => present }" }
 

data/spec/spec_helper.rb

@@ -86,7 +86,7 @@ RSpec::Matchers.define :only_have_problem do |filter|
   end
 
   failure_message_for_should do |problems|
-    left = problems - filter_problems(actual, filter)
+    left = problems - filter_array_of_hashes(actual, filter)
     message = "There were problems not matching filter."
     message << "
     * filter = #{filter.inspect}

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: puppet-lint
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 1
   prerelease: 
   segments: 
   - 0
   - 1
-  - 12
-  version: 0.1.12
+  - 13
+  version: 0.1.13
 platform: ruby
 authors: 
 - Tim Sharpe
@@ -15,7 +15,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-27 00:00:00 Z
+date: 2012-03-26 00:00:00 +11:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -56,7 +57,9 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .travis.yml
 - bin/puppet-lint
+- Gemfile
 - lib/puppet-lint/configuration.rb
 - lib/puppet-lint/plugin.rb
 - lib/puppet-lint/plugins/check_classes.rb
@@ -79,6 +82,7 @@ files:
 - spec/puppet-lint/check_variables_spec.rb
 - spec/puppet-lint/check_whitespace_spec.rb
 - spec/spec_helper.rb
+has_rdoc: true
 homepage: https://github.com/rodjek/puppet-lint/
 licenses: []
 
@@ -108,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Ensure your Puppet manifests conform with the Puppetlabs style guide