puppet-lint-halyard 1.1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1c66a5c73ddd9227394aef946e8b7e6cf4f1aa4b
+  data.tar.gz: 938f29ee0193abd17d7c5d51a3246dda256f0794
+SHA512:
+  metadata.gz: 01e8bfbc7bcac54e8b2dfe1ccb90a43c8de217e68f59e6dc05f858c8c0973a0fe760213837a1eccd23bfff75e9adaf61dfc37491d26f2b3d4c841c3e04a99799
+  data.tar.gz: d0ff8057db3909321c61d55b7b36381ade0c5f2bf4acc32909e338d5cb1ee670fe5d8810f314e5e248a71806cffdccff3efd46ab69ff912c7b99f7ed4afbb5cd

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+.bundle/
+.rbenv-version
+.ruby-version
+Gemfile.lock
+vendor/gems
+coverage/
+*.swp
+/_site/

data/.travis.yml

@@ -0,0 +1,10 @@
+before_install: gem update --system 2.1.11
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+notifications:
+  email:
+    - tim@github.com

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+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/README.md

@@ -0,0 +1,210 @@
+# 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. It is not meant to validate syntax. Please use `puppet parser validate` for that.
+
+## Changes from upstream
+
+* Released as puppet-lint-halyard
+* Adjust rakefile to simplify publishing
+
+## Installation
+
+    gem install puppet-lint-halyard
+
+## 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
+
+    rake lint
+
+If you want to modify the default behaviour of the rake task, you can modify
+the PuppetLint configuration by defining the task yourself.
+
+    PuppetLint::RakeTask.new :lint do |config|
+      # Pattern of files to check, defaults to `**/*.pp`
+      config.pattern = 'modules'
+
+      # Pattern of files to ignore
+      config.ignore_paths = ['modules/apt', 'modules/stdlib']
+
+      # List of checks to disable
+      config.disable_checks = ['documentation', '80chars']
+
+      # Should puppet-lint prefix it's output with the file being checked,
+      # defaults to true
+      config.with_filename = false
+
+      # Should the task fail if there were any warnings, defaults to false
+      config.fail_on_warnings = true
+
+      # Format string for puppet-lint's output (see the puppet-lint help output
+      # for details
+      config.log_format = '%{filename} - %{message}'
+
+      # Print out the context for the problem, defaults to false
+      config.with_context = true
+
+      # Enable automatic fixing of problems, defaults to false
+      config.fix = true
+
+      # Show ignored problems in the output, defaults to false
+      config.show_ignored = true
+
+      # Compare module layout relative to the module root
+      config.relative = true
+    end
+
+## Implemented tests
+
+At the moment, the following tests have been implemented:
+
+### Spacing, Indentation & Whitespace
+
+ * Must use two-space soft tabs.
+ * Must not use literal tab characters.
+ * Must not contain trailing white space.
+ * Should not exceed an 80 character line width
+   * An exception has been made for `source => 'puppet://...'` lines as
+     splitting these over multiple lines decreases the readability of the
+     manifests.
+ * Should align arrows (`=>`) within blocks of attributes.
+
+### Quoting
+
+ * All strings that do not contain variables should be enclosed in single
+   quotes.
+   * An exception has been made for double quoted strings containing \n or \t.
+ * 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.
+   * An exception has been made for resource titles that consist of only
+     a variable standing by itself.
+ * 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 or use symbolic file modes.
+
+### 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.
+
+## Disabling checks
+
+### puppet-lint
+
+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 80 character check, you would run
+
+```
+puppet-lint --no-80chars-check /path/to/my/manifest.pp
+```
+
+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
+```
+
+For a list of all the flags just type:
+
+```
+puppet-lint --help
+```
+
+### 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")
+```
+
+The Rake task also supports ignoring certain paths
+from being linted:
+
+``` ruby
+PuppetLint.configuration.ignore_paths = ["vendor/**/*.pp"]
+```
+
+## 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.
+
+## 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/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+desc 'Run tests'
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Run Rubocop on the gem'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
+  task.fail_on_error = true
+end
+
+task default: [:spec, :build, :install]

data/bin/puppet-lint

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'puppet-lint'
+
+exit PuppetLint::Bin.new(ARGV).run

data/lib/puppet-lint.rb

@@ -0,0 +1,214 @@
+require 'set'
+require 'puppet-lint/version'
+require 'puppet-lint/lexer'
+require 'puppet-lint/configuration'
+require 'puppet-lint/data'
+require 'puppet-lint/checks'
+require 'puppet-lint/bin'
+require 'puppet-lint/monkeypatches'
+
+class PuppetLint::NoCodeError < StandardError; end
+class PuppetLint::NoFix < StandardError; end
+
+# Public: The public interface to puppet-lint.
+class PuppetLint
+  # Public: Gets/Sets the String manifest code to be checked.
+  attr_accessor :code
+
+  # Public: Gets the String manifest with the errors fixed.
+  attr_reader :manifest
+
+  # Public: Returns an Array of Hashes describing the problems found in the
+  # manifest.
+  #
+  # Each Hash will contain *at least*:
+  #   :check   - The Symbol name of the check that generated the problem.
+  #   :kind    - The Symbol kind of the problem (:error, :warning, or
+  #              :fixed).
+  #   :line    - The Integer line number of the location of the problem in
+  #              the manifest.
+  #   :column  - The Integer column number of the location of the problem in
+  #              the manifest.
+  #   :message - The String message describing the problem that was found.
+  attr_reader :problems
+
+  # Public: Gets/Sets the String path to the manifest to be checked.
+  attr_accessor :path
+
+  # Public: Returns a Hash of linter statistics
+  #
+  #   :error   - An Integer count of errors found in the manifest.
+  #   :warning - An Integer count of warnings found in the manifest.
+  #   :fixed   - An Integer count of problems found in the manifest that were
+  #              automatically fixed.
+  attr_reader :statistics
+
+  # Public: Initialise a new PuppetLint object.
+  def initialize
+    @code = nil
+    @statistics = {:error => 0, :warning => 0, :fixed => 0, :ignored => 0}
+    @manifest = ''
+  end
+
+  # Public: Access PuppetLint's configuration from outside the class.
+  #
+  # Returns a PuppetLint::Configuration object.
+  def self.configuration
+    @configuration ||= PuppetLint::Configuration.new
+  end
+
+  # Public: Access PuppetLint's configuration from inside the class.
+  #
+  # Returns a PuppetLint::Configuration object.
+  def configuration
+    self.class.configuration
+  end
+
+  # Public: Set the path of the manifest file to be tested and read the
+  # contents of the file.
+  #
+  # Returns nothing.
+  def file=(path)
+    if File.exist? path
+      @path = path
+      @code = File.read(path)
+    end
+  end
+
+  # Internal: Retrieve the format string to be used when writing problems to
+  # STDOUT.  If the user has not specified a custom log format, build one for
+  # them.
+  #
+  # Returns a format String to be used with String#%.
+  def log_format
+    if configuration.log_format == ''
+      ## recreate previous old log format as far as thats possible.
+      format = '%{KIND}: %{message} on line %{line}'
+      if configuration.with_filename
+        format.prepend '%{path} - '
+      end
+      configuration.log_format = format
+    end
+    return configuration.log_format
+  end
+
+  # Internal: Format a problem message and print it to STDOUT.
+  #
+  # message - A Hash containing all the information about a problem.
+  #
+  # Returns nothing.
+  def format_message(message)
+    format = log_format
+    puts format % message
+    if message[:kind] == :ignored && !message[:reason].nil?
+      puts "  #{message[:reason]}"
+    end
+  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.
+  #
+  # message - A Hash containing all the information about a problem.
+  #
+  # Returns nothing.
+  def print_context(message)
+    return if message[:check] == 'documentation'
+    return if message[:kind] == :fixed
+    line = PuppetLint::Data.manifest_lines[message[:line] - 1]
+    offset = line.index(/\S/) || 1
+    puts "\n  #{line.strip}"
+    printf "%#{message[:column] + 2 - offset}s\n\n", '^'
+  end
+
+  # Internal: Print the reported problems with a manifest to stdout.
+  #
+  # problems - An Array of problem Hashes as returned by
+  #            PuppetLint::Checks#run.
+  #
+  # Returns nothing.
+  def report(problems)
+    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
+      end
+    end
+  end
+
+  # Public: Determine if PuppetLint found any errors in the manifest.
+  #
+  # Returns true if errors were found, otherwise returns false.
+  def errors?
+    @statistics[:error] != 0
+  end
+
+  # Public: Determine if PuppetLint found any warnings in the manifest.
+  #
+  # Returns true if warnings were found, otherwise returns false.
+  def warnings?
+    @statistics[:warning] != 0
+  end
+
+  # Public: Run the loaded manifest code through the lint checks and print the
+  # results of the checks to stdout.
+  #
+  # Returns nothing.
+  # Raises PuppetLint::NoCodeError if no manifest code has been loaded.
+  def run
+    if @code.nil?
+      raise PuppetLint::NoCodeError
+    end
+
+    if @code.empty?
+      @problems = []
+      @manifest = []
+      return
+    end
+
+    linter = PuppetLint::Checks.new
+    @problems = linter.run(@path, @code)
+    @problems.each { |problem| @statistics[problem[:kind]] += 1 }
+
+    @manifest = linter.manifest if PuppetLint.configuration.fix
+  end
+
+  # Public: Print any problems that were found out to stdout.
+  #
+  # Returns nothing.
+  def print_problems
+    report @problems
+  end
+
+  # Public: Define a new check.
+  #
+  # name  - A unique name for the check as a Symbol.
+  # block - The check logic. This must contain a `check` method and optionally
+  #         a `fix` method.
+  #
+  # Returns nothing.
+  #
+  # Examples
+  #
+  #   PuppetLint.new_check(:foo) do
+  #     def check
+  #     end
+  #   end
+  def self.new_check(name, &block)
+    class_name = name.to_s.split('_').map(&:capitalize).join
+    klass = PuppetLint.const_set("Check#{class_name}", Class.new(PuppetLint::CheckPlugin))
+    klass.const_set('NAME', name)
+    klass.class_exec(&block)
+    PuppetLint.configuration.add_check(name, klass)
+    PuppetLint::Data.ignore_overrides[name] ||= {}
+  end
+end
+
+# Default configuration options
+PuppetLint.configuration.defaults
+
+require 'puppet-lint/plugins'