puppet-lint 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6c8e66a832c7a2cb2f29ed9bcba97b1f7807de3
-  data.tar.gz: 480e6c20a669db2668c3366f97c6b1133acf8217
+  metadata.gz: afe0f69ff9db46b574f04cdb2344e600ae0b1e10
+  data.tar.gz: 8c8344befd98f41083fc3e0408e5ae4ba1017245
 SHA512:
-  metadata.gz: ba2e39b0d3cea77c78d46fd33dd7d4bacb17cfcc9780e941bd9f623b981acbcc228e751ee660a8875769e1120696955c232687083054d8cb7bc61438c2901d59
-  data.tar.gz: 5b50d449286742482856f009ee9022c3296a7dd317cb1a2403c7631c9a4c9d084212ebb58442e3d4e92d431f9101205711a59f9624c2dd94daf854885386380f
+  metadata.gz: 41c27ca6ec8948d1c2e654c830cad26806243643f4e0e8c29f2aad9ba7f215a2be1196fb7bed16bec0b541955e9235a43f7ccdfddf519a81505779ef806bc3e1
+  data.tar.gz: 398daafadce6e29e4d97d116166658a76ad9d6fcd3fa2cbac12f7b4a204524eb1333d8b45bb96188129a0828ef8f6bb334cee77eddd9c103f2bc8198776e04b2

data/.gitignore

@@ -7,4 +7,5 @@ vendor/
 coverage/
 *.swp
 /_site/
-.idea
+.idea
+/*.pp

data/.rspec

@@ -1 +1,2 @@
+--format documentation
 --color

data/CHANGELOG.md

@@ -1,5 +1,59 @@
 # Change Log
 
+## [2.1.0](https://github.com/rodjek/puppet-lint/tree/2.1.0) (2016-12-30)
+[Full Changelog](https://github.com/rodjek/puppet-lint/compare/2.0.2...2.1.0)
+
+**Closed issues:**
+
+- No documentation on how to use plugins [\#602](https://github.com/rodjek/puppet-lint/issues/602)
+- Excessive number of warnings from code\_on\_top\_scope [\#579](https://github.com/rodjek/puppet-lint/issues/579)
+- Syntax error for references starting with Regexp [\#566](https://github.com/rodjek/puppet-lint/issues/566)
+- --fix flag discoverability is low [\#556](https://github.com/rodjek/puppet-lint/issues/556)
+- Module names must only contain lowercase letters [\#554](https://github.com/rodjek/puppet-lint/issues/554)
+- incorrect error on inline template [\#545](https://github.com/rodjek/puppet-lint/issues/545)
+- parameter\_order check does not work default hash is added in parameter [\#544](https://github.com/rodjek/puppet-lint/issues/544)
+- Remove formatting with `linenumber` [\#539](https://github.com/rodjek/puppet-lint/issues/539)
+- Incorrect warning of required parameter when using array that includes variable. [\#537](https://github.com/rodjek/puppet-lint/issues/537)
+- names\_containing\_dash is broken and unignorable [\#534](https://github.com/rodjek/puppet-lint/issues/534)
+- Puppet-lint 2.0 fails on unquoted string starting with underscore. [\#531](https://github.com/rodjek/puppet-lint/issues/531)
+- syntax error on valid file when: if /regex/ in array [\#517](https://github.com/rodjek/puppet-lint/issues/517)
+- crashes if there is a \# line:endignore with no begining. [\#509](https://github.com/rodjek/puppet-lint/issues/509)
+- Wrong behaviour of variable\_contains\_dash [\#504](https://github.com/rodjek/puppet-lint/issues/504)
+- puppet-lint reports incorrect line numbers [\#403](https://github.com/rodjek/puppet-lint/issues/403)
+- lint ignore comments feature not documented [\#369](https://github.com/rodjek/puppet-lint/issues/369)
+
+**Merged pull requests:**
+
+- Documentation on plugin usage. [\#611](https://github.com/rodjek/puppet-lint/pull/611) ([rnelson0](https://github.com/rnelson0))
+- Puppet-lint version bump to 2.1.0.pre [\#608](https://github.com/rodjek/puppet-lint/pull/608) ([rnelson0](https://github.com/rnelson0))
+- \(\#369\) Document existence of control comments [\#600](https://github.com/rodjek/puppet-lint/pull/600) ([rnelson0](https://github.com/rnelson0))
+- Ignore \*.pp files at the top level [\#597](https://github.com/rodjek/puppet-lint/pull/597) ([rnelson0](https://github.com/rnelson0))
+- Show logs in rspec tests [\#596](https://github.com/rodjek/puppet-lint/pull/596) ([ghoneycutt](https://github.com/ghoneycutt))
+- \(\#517\) Update the allowed tokens prior to a regex [\#594](https://github.com/rodjek/puppet-lint/pull/594) ([rnelson0](https://github.com/rnelson0))
+- \(\#531\) Treat barewords beginning with an underscore as :NAME tokens [\#593](https://github.com/rodjek/puppet-lint/pull/593) ([rnelson0](https://github.com/rnelson0))
+- \(\#544, \#537\) Skip hash contents when checking optional parameters [\#592](https://github.com/rodjek/puppet-lint/pull/592) ([rnelson0](https://github.com/rnelson0))
+- \(\#545\) Exempt inline\_epp and inline\_template from single quoted strin… [\#591](https://github.com/rodjek/puppet-lint/pull/591) ([rnelson0](https://github.com/rnelson0))
+- Disable code\_on\_top\_scope by default until the noise can be reduced \(… [\#590](https://github.com/rodjek/puppet-lint/pull/590) ([rnelson0](https://github.com/rnelson0))
+- Changelog generator task [\#589](https://github.com/rodjek/puppet-lint/pull/589) ([rnelson0](https://github.com/rnelson0))
+- Count lines in comments and double quoted strings [\#577](https://github.com/rodjek/puppet-lint/pull/577) ([paran1](https://github.com/paran1))
+- Handle mismatched control comments gracefully [\#573](https://github.com/rodjek/puppet-lint/pull/573) ([rodjek](https://github.com/rodjek))
+- Reimplementation of --fix support for unenclosed variables delimited by dashes [\#572](https://github.com/rodjek/puppet-lint/pull/572) ([rodjek](https://github.com/rodjek))
+- Anchor the end of the :TYPE token regexp [\#571](https://github.com/rodjek/puppet-lint/pull/571) ([rodjek](https://github.com/rodjek))
+- Multi line strings [\#570](https://github.com/rodjek/puppet-lint/pull/570) ([jiuka](https://github.com/jiuka))
+- @node\_indexes should be reset too. [\#569](https://github.com/rodjek/puppet-lint/pull/569) ([jiuka](https://github.com/jiuka))
+- True up reserved keywords [\#564](https://github.com/rodjek/puppet-lint/pull/564) ([rnelson0](https://github.com/rnelson0))
+- \[561\] Provide style guide references for each check [\#562](https://github.com/rodjek/puppet-lint/pull/562) ([rnelson0](https://github.com/rnelson0))
+- Add names\_containing\_uppercase docs [\#559](https://github.com/rodjek/puppet-lint/pull/559) ([arrdem](https://github.com/arrdem))
+- Implement a linter for uppercase class names [\#558](https://github.com/rodjek/puppet-lint/pull/558) ([arrdem](https://github.com/arrdem))
+- Include --fix usage instructions [\#557](https://github.com/rodjek/puppet-lint/pull/557) ([QuinnyPig](https://github.com/QuinnyPig))
+- Add puppet-lint plugins from deanwilson to plugins page [\#553](https://github.com/rodjek/puppet-lint/pull/553) ([deanwilson](https://github.com/deanwilson))
+- Updates PR for \#223 [\#552](https://github.com/rodjek/puppet-lint/pull/552) ([binford2k](https://github.com/binford2k))
+- add legacy\_facts [\#543](https://github.com/rodjek/puppet-lint/pull/543) ([mmckinst](https://github.com/mmckinst))
+- Remove formatting with `linenumber` [\#540](https://github.com/rodjek/puppet-lint/pull/540) ([rski](https://github.com/rski))
+- Adding support for logging to STDOUT as JSON [\#487](https://github.com/rodjek/puppet-lint/pull/487) ([binford2k](https://github.com/binford2k))
+- Potential README changes [\#420](https://github.com/rodjek/puppet-lint/pull/420) ([rothsa](https://github.com/rothsa))
+- Add fix to "ensure found on line but it's not the first attribute" [\#375](https://github.com/rodjek/puppet-lint/pull/375) ([sathieu](https://github.com/sathieu))
+
 ## [2.0.2](https://github.com/rodjek/puppet-lint/tree/2.0.2) (2016-08-19)
 [Full Changelog](https://github.com/rodjek/puppet-lint/compare/2.0.1...2.0.2)
 
@@ -12,6 +66,7 @@
 
 **Merged pull requests:**
 
+- Release 2.0.2 [\#536](https://github.com/rodjek/puppet-lint/pull/536) ([rnelson0](https://github.com/rnelson0))
 - Revert "Bugfix: properly handling $gronk-$grouik with --fix \(fix \#442\)" [\#535](https://github.com/rodjek/puppet-lint/pull/535) ([rnelson0](https://github.com/rnelson0))
 
 ## [2.0.1](https://github.com/rodjek/puppet-lint/tree/2.0.1) (2016-08-18)
@@ -311,6 +366,7 @@ If the additional gems you use for checks are pinned to 1.x, you should pin pupp
 
 **Merged pull requests:**
 
+- Checks for code outside class/define block [\#223](https://github.com/rodjek/puppet-lint/pull/223) ([dLobatog](https://github.com/dLobatog))
 - explains in README that puppet-lint is not for checking syntax [\#186](https://github.com/rodjek/puppet-lint/pull/186) ([ghoneycutt](https://github.com/ghoneycutt))
 - Use the current workdir as reference to calculate the expanded\_path of a filename [\#175](https://github.com/rodjek/puppet-lint/pull/175) ([vStone](https://github.com/vStone))
 - Update code documentation [\#298](https://github.com/rodjek/puppet-lint/pull/298) ([rodjek](https://github.com/rodjek))

data/Gemfile

@@ -7,16 +7,27 @@ group :test do
   gem 'rspec', '~> 3.0'
   gem 'rspec-its', '~> 1.0'
   gem 'rspec-collection_matchers', '~> 1.0'
-  gem 'rack', '~> 1.0'
 
   if RUBY_VERSION < '2.0'
     # json 2.x requires ruby 2.0. Lock to 1.8
-    gem 'json', '~> 1.8'
-    # json_pure 2.0.2 requires ruby 2.0. Lock to 2.0.1
-    gem 'json_pure', '= 2.0.1'
+    gem 'json', '= 1.8'
+    # json_pure 2.0.2 requires ruby 2.0, and 2.0.1 requires ruby 1.9. Lock to 1.8.3.
+    gem 'json_pure', '= 1.8.3'
     # addressable 2.4.0 requires ruby 1.9.0. Lock to 2.3.8.
     gem 'addressable', '= 2.3.8'
   else
     gem 'json'
   end
+  
+  if RUBY_VERSION > '1.8'
+    # requires ruby 1.9+, on 1.8 we'll fall back to the old regex parsing
+    gem 'rspec-json_expectations', '~> 1.4'
+  end
+end
+
+group :development do
+  # For Changelog generation
+  gem 'github_changelog_generator',                                 :require => false if RUBY_VERSION >= '2.2.2'
+  gem 'github_changelog_generator', '~> 1.13.0',                    :require => false if RUBY_VERSION < '2.2.2'
+  gem 'rack', '~> 1.0',                                             :require => false if RUBY_VERSION < '2.2.2'
 end

data/README.md

@@ -4,15 +4,15 @@
 Status](https://secure.travis-ci.org/rodjek/puppet-lint.png)](http://travis-ci.org/rodjek/puppet-lint)
 [![Inline docs](http://inch-ci.org/github/rodjek/puppet-lint.png?branch=master)](http://inch-ci.org/github/rodjek/puppet-lint)
 
-The goal of this project is to implement as many of the recommended Puppet
+Puppet Lint will test modules and manifests against the recommended Puppet
 style guidelines from the [Puppet Labs style
-guide](http://docs.puppetlabs.com/guides/style_guide.html) as practical. It is not meant to validate syntax. Please use `puppet parser validate` for that.
+guide](http://docs.puppetlabs.com/guides/style_guide.html) as closely as practical. It is not meant to validate syntax. Please use `puppet parser validate` for that.
 
 ## Installation
 
     gem install puppet-lint
 
-## Testing your manifests
+## Usage
 
 ### By hand
 
@@ -20,7 +20,44 @@ You can test a single manifest file by running
 
     puppet-lint <path to file>
 
-### Rake task
+Puppet Lint has a large number of options to modify which checks should be run.
+
+You can disable any of the checks when running the `puppet-lint` command by
+adding a `--no-<check name>-check` flag to the command.  For example, if you
+wanted to skip the 140 character check, you would run
+```  
+    puppet-lint --no-140chars-check <path to file>
+```
+
+You can also instruct puppet-lint to automatically fix issues it detects with the `--fix` flag.
+```
+    puppet-lint --fix /modules
+```
+
+Note that this can be combined with the `--only-checks` option to help avoid enormous patch sets.
+```
+    puppet-lint --only-checks trailing_whitespace --fix modules/
+```
+
+You can also use [control comments](http://puppet-lint.com/controlcomments/) to disable checks
+within puppet code on a per line or per block basis using `#lint:ignore:<check_name>`:
+```
+    class foo {
+      $bar = 'bar'
+      # This ignores the double_quoted_strings check over multiple lines
+      # lint:ignore:double_quoted_strings
+      $baz = "baz"
+      $gronk = "gronk"
+      # lint:endignore
+
+      # This ignores the 140chars check on a single line
+      $this_line_has_a_really_long_name_and_value_that_is_much_longer_than_the_style_guide_recommends = "I mean, a really, really long line like you can't believe" # lint:ignore:140chars
+    }
+```
+
+See puppet-lint --help for a full list of options.
+
+### Rake
 
 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
@@ -64,7 +101,22 @@ the PuppetLint configuration by defining the task yourself.
       config.relative = true
     end
 
-## Implemented tests
+### Settings
+
+puppet-lint will also check for a `.puppet-lint.rc` 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-lint.rc` containing
+
+```
+--no-hard_tabs-check
+```
+
+## Compatibility Warning
+
+Release 2.1.0 of puppet-lint is the last planned version with support for Puppet 3 and Ruby 1.8.7. Future versions will drop support for these versions.
+
+## Implemented Tests
 
 At the moment, the following tests have been implemented:
 
@@ -88,6 +140,9 @@ At the moment, the following tests have been implemented:
  * All variables should be enclosed in braces when interpolated in a string.
  * Variables standing by themselves should not be quoted.
 
+### Capitalization
+ * All variables should be in lowercase
+
 ### Resources
 
  * All resource titles should be quoted.

data/Rakefile

@@ -1,6 +1,19 @@
 require 'rake'
 require 'rspec/core/rake_task'
+require 'puppet-lint'
 
 task :default => :test
 
 RSpec::Core::RakeTask.new(:test)
+
+begin
+  require 'github_changelog_generator/task'
+  GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+    version = PuppetLint::VERSION
+    config.future_release = "#{version}"
+    config.exclude_labels = %w{duplicate question invalid wontfix}
+  end
+rescue LoadError
+end
+
+# vim: syntax=ruby

data/lib/puppet-lint.rb

@@ -1,4 +1,5 @@
 require 'set'
+require 'json'
 require 'puppet-lint/version'
 require 'puppet-lint/lexer'
 require 'puppet-lint/configuration'
@@ -105,6 +106,16 @@ class PuppetLint
     end
   end
 
+  # Internal: Get the line of the manifest on which the problem was found
+  #
+  # message - A Hash containing all the information about a problem.
+  #
+  # Returns the problematic line as a string.
+  def get_context(message)
+    line = PuppetLint::Data.manifest_lines[message[:line] - 1]
+    return line.strip
+  end
+
   # Internal: Print out the line of the manifest on which the problem was found
   # as well as a marker pointing to the location on the line.
   #
@@ -114,7 +125,7 @@ class PuppetLint
   def print_context(message)
     return if message[:check] == 'documentation'
     return if message[:kind] == :fixed
-    line = PuppetLint::Data.manifest_lines[message[:line] - 1]
+    line = get_context(message)
     offset = line.index(/\S/) || 1
     puts "\n  #{line.strip}"
     printf "%#{message[:column] + 2 - offset}s\n\n", '^'
@@ -127,17 +138,23 @@ class PuppetLint
   #
   # Returns nothing.
   def report(problems)
+    json = []
     problems.each do |message|
       next if message[:kind] == :ignored && !PuppetLint.configuration.show_ignored
 
       message[:KIND] = message[:kind].to_s.upcase
-      message[:linenumber] = message[:line]
 
       if message[:kind] == :fixed || [message[:kind], :all].include?(configuration.error_level)
-        format_message message
-        print_context(message) if configuration.with_context
+        if configuration.json
+          message['context'] = get_context(message) if configuration.with_context
+          json << message
+        else
+          format_message message
+          print_context(message) if configuration.with_context
+        end
       end
     end
+    puts JSON.pretty_generate(json) if configuration.json
   end
 
   # Public: Determine if PuppetLint found any errors in the manifest.

data/lib/puppet-lint/configuration.rb

@@ -147,6 +147,7 @@ class PuppetLint
       self.log_format = ''
       self.with_context = false
       self.fix = false
+      self.json = false
       self.show_ignored = false
     end
   end

data/lib/puppet-lint/data.rb

@@ -25,6 +25,7 @@ class PuppetLint::Data
       @resource_indexes = nil
       @class_indexes = nil
       @defined_type_indexes = nil
+      @node_indexes = nil
       @function_indexes = nil
       @array_indexes = nil
       @hash_indexes = nil
@@ -505,10 +506,17 @@ class PuppetLint::Data
               stack_add << [token.line, reason, check]
             end
           else
-            stack.pop.each do |start|
-              unless start.nil?
-                (start[0]..token.line).each do |i|
-                  (ignore_overrides[start[2]] ||= {})[i] = start[1]
+            top_override = stack.pop
+            if top_override.nil?
+              # TODO: refactor to provide a way to expose problems from
+              # PuppetLint::Data via the normal problem reporting mechanism.
+              puts "WARNING: lint:endignore comment with no opening lint:ignore:<check> comment found on line #{token.line}"
+            else
+              top_override.each do |start|
+                unless start.nil?
+                  (start[0]..token.line).each do |i|
+                    (ignore_overrides[start[2]] ||= {})[i] = start[1]
+                  end
                 end
               end
             end

data/lib/puppet-lint/lexer.rb

@@ -33,24 +33,42 @@ class PuppetLint
 
     # Internal: A Hash whose keys are Strings representing reserved keywords in
     # the Puppet DSL.
+    # From https://github.com/puppetlabs/puppet/blob/master/lib/puppet/pops/parser/lexer2.rb#L116-L137
+    # or thereabouts
     KEYWORDS = {
-      'class'    => true,
       'case'     => true,
+      'class'    => true,
       'default'  => true,
       'define'   => true,
       'import'   => true,
       'if'       => true,
-      'else'     => true,
       'elsif'    => true,
+      'else'     => true,
       'inherits' => true,
       'node'     => true,
       'and'      => true,
       'or'       => true,
       'undef'    => true,
-      'true'     => true,
       'false'    => true,
+      'true'     => true,
       'in'       => true,
       'unless'   => true,
+      'function' => true,
+      'type'     => true,
+      'attr'     => true,
+      'private'  => true,
+    }
+    
+    # Internal: A Hash whose keys are Strings representing reserved keywords in
+    # the Puppet DSL when Application Management is enabled
+    # From https://github.com/puppetlabs/puppet/blob/master/lib/puppet/pops/parser/lexer2.rb#L142-L159
+    # or therabouts
+    # Currently unused
+    APP_MANAGEMENT_TOKENS = {
+      'application' => true,
+      'consumes'    => true,
+      'produces'    => true,
+      'site'        => true,
     }
 
     # Internal: A Hash whose keys are Symbols representing token types which
@@ -63,6 +81,8 @@ class PuppetLint
       :NOMATCH => true,
       :COMMA   => true,
       :LBRACK  => true,
+      :IF      => true,
+      :ELSIF   => true,
     }
 
     # Internal: An Array of Arrays containing tokens that can be described by
@@ -70,10 +90,10 @@ class PuppetLint
     # name of the token as a Symbol and a regular expression describing the
     # value of the token.
     KNOWN_TOKENS = [
-      [:TYPE, /\A(Integer|Float|Boolean|Regexp|String|Array|Hash|Resource|Class|Collection|Scalar|Numeric|CatalogEntry|Data|Tuple|Struct|Optional|NotUndef|Variant|Enum|Pattern|Any|Callable|Type|Runtime|Undef|Default)/],
+      [:TYPE, /\A(Integer|Float|Boolean|Regexp|String|Array|Hash|Resource|Class|Collection|Scalar|Numeric|CatalogEntry|Data|Tuple|Struct|Optional|NotUndef|Variant|Enum|Pattern|Any|Callable|Type|Runtime|Undef|Default)\b/],
       [:CLASSREF, /\A(((::){0,1}[A-Z][-\w]*)+)/],
       [:NUMBER, /\A\b((?:0[xX][0-9A-Fa-f]+|0?\d+(?:\.\d+)?(?:[eE]-?\d+)?))\b/],
-      [:NAME, /\A(((::)?[a-z0-9][-\w]*)(::[a-z0-9][-\w]*)*)/],
+      [:NAME, /\A(((::)?[_a-z0-9][-\w]*)(::[a-z0-9][-\w]*)*)/],
       [:LBRACK, /\A(\[)/],
       [:RBRACK, /\A(\])/],
       [:LBRACE, /\A(\{)/],
@@ -170,7 +190,7 @@ class PuppetLint
         end
 
         unless found
-          if var_name = chunk[/\A\$((::)?([\w-]+::)*[\w-]+(\[.+?\])*)/, 1]
+          if var_name = chunk[/\A\$((::)?(\w+(-\w+)*::)*\w+(-\w+)*(\[.+?\])*)/, 1]
             length = var_name.size + 1
             tokens << new_token(:VARIABLE, var_name, length)
 
@@ -293,6 +313,11 @@ class PuppetLint
         @line_no += 1
         @column = 1
       end
+      if [:MLCOMMENT, :SSTRING, :STRING].include? type and /(?:\r\n|\r|\n)/.match(value)
+        lines = value.split(/(?:\r\n|\r|\n)/, -1)
+        @line_no += lines.length-1
+        @column = lines.last.length
+      end
 
       token
     end
@@ -346,7 +371,7 @@ class PuppetLint
             tokens << new_token(:DQMID, value, value.size, :line => line, :column => token_column)
           end
           if ss.scan(/\{/).nil?
-            var_name = ss.scan(/(::)?([\w-]+::)*[\w-]+/)
+            var_name = ss.scan(/(::)?(\w+(-\w+)*::)*\w+(-\w+)*/)
             if var_name.nil?
               token_column = column + ss.pos - 1
               tokens << new_token(:DQMID, "$", 1, :line => line, :column => token_column)

data/lib/puppet-lint/optparser.rb

@@ -83,12 +83,13 @@ class PuppetLint::OptParser
               '%{check}    - The name of the check.',
               '%{message}  - The message.'
       ) do |format|
-        if format.include?('%{linenumber}')
-          $stderr.puts "DEPRECATION: Please use %{line} instead of %{linenumber}"
-        end
         PuppetLint.configuration.log_format = format
       end
 
+      opts.on('--json', 'Log output as JSON') do
+        PuppetLint.configuration.json = true
+      end
+
       opts.separator ''
       opts.separator '    Checks:'