halyard-puppet-lint 1.2.0

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

@@ -0,0 +1,19 @@
+# Public: Test the manifest tokens for variables that contain a dash and
+# record a warning for each instance found.
+PuppetLint.new_check(:variable_contains_dash) do
+  VARIABLE_TYPES = Set[:VARIABLE, :UNENC_VARIABLE]
+
+  def check
+    tokens.select { |r|
+      VARIABLE_TYPES.include? r.type
+    }.each do |token|
+      if token.value.gsub(/\[.+?\]/, '').match(/-/)
+        notify :warning, {
+          :message => 'variable contains a dash',
+          :line    => token.line,
+          :column  => token.column,
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,170 @@
+# Public: Check the raw manifest string for lines containing hard tab
+# characters and record an error for each instance found.
+PuppetLint.new_check(:hard_tabs) do
+  WHITESPACE_TYPES = Set[:INDENT, :WHITESPACE]
+
+  def check
+    tokens.select { |r|
+      WHITESPACE_TYPES.include?(r.type) && r.value.include?("\t")
+    }.each do |token|
+      notify :error, {
+        :message => 'tab character found',
+        :line    => token.line,
+        :column  => token.column,
+        :token   => token,
+      }
+    end
+  end
+
+  def fix(problem)
+    problem[:token].value.gsub!("\t", '  ')
+  end
+end
+
+# Public: Check the manifest tokens for lines ending with whitespace and record
+# an error for each instance found.
+PuppetLint.new_check(:trailing_whitespace) do
+  def check
+    tokens.select { |token|
+      [:WHITESPACE, :INDENT].include?(token.type)
+    }.select { |token|
+      token.next_token.nil? || token.next_token.type == :NEWLINE
+    }.each do |token|
+      notify :error, {
+        :message => 'trailing whitespace found',
+        :line    => token.line,
+        :column  => token.column,
+        :token   => token,
+      }
+    end
+  end
+
+  def fix(problem)
+    prev_token = problem[:token].prev_token
+    next_token = problem[:token].next_token
+    prev_token.next_token = next_token
+    next_token.prev_token = prev_token unless next_token.nil?
+    tokens.delete(problem[:token])
+  end
+end
+
+# Public: Test the raw manifest string for lines containing more than 80
+# characters and record a warning for each instance found.  The only exceptions
+# to this rule are lines containing URLs and template() calls which would hurt
+# readability if split.
+PuppetLint.new_check(:'80chars') do
+  def check
+    manifest_lines.each_with_index do |line, idx|
+      unless line =~ /:\/\// || line =~ /template\(/
+        if line.scan(/./mu).size > 80
+          notify :warning, {
+            :message => 'line has more than 80 characters',
+            :line    => idx + 1,
+            :column  => 80,
+          }
+        end
+      end
+    end
+  end
+end
+
+# Public: Check the manifest tokens for any indentation not using 2 space soft
+# tabs and record an error for each instance found.
+PuppetLint.new_check(:'2sp_soft_tabs') do
+  def check
+    tokens.select { |r|
+      r.type == :INDENT
+    }.reject { |r|
+      r.value.length % 2 == 0
+    }.each do |token|
+      notify :error, {
+        :message => 'two-space soft tabs not used',
+        :line    => token.line,
+        :column  => token.column,
+      }
+    end
+  end
+end
+
+# Public: Check the manifest tokens for any arrows (=>) in a grouping ({}) that
+# are not aligned with other arrows in that grouping.
+PuppetLint.new_check(:arrow_alignment) do
+  COMMENT_TYPES = Set[:COMMENT, :SLASH_COMMENT, :MLCOMMENT]
+
+  def check
+    resource_indexes.each do |res_idx|
+      indent_depth = [0]
+      indent_depth_idx = 0
+      level_tokens = []
+      resource_tokens = res_idx[:tokens]
+      resource_tokens.reject! do |token|
+        COMMENT_TYPES.include? token.type
+      end
+
+      # If this is a single line resource, skip it
+      first_arrow = resource_tokens.index { |r| r.type == :FARROW }
+      last_arrow = resource_tokens.rindex { |r| r.type == :FARROW }
+      next if first_arrow.nil?
+      next if last_arrow.nil?
+      next unless resource_tokens[first_arrow..last_arrow].any? { |r| r.type == :NEWLINE }
+
+      resource_tokens.each_with_index do |token, idx|
+        if token.type == :FARROW
+          (level_tokens[indent_depth_idx] ||= []) << token
+          prev_indent_token = resource_tokens[0..idx].rindex { |t| t.type == :INDENT }
+          indent_token_length = prev_indent_token.nil? ? 0 : resource_tokens[prev_indent_token].to_manifest.length
+          indent_length = indent_token_length + token.prev_code_token.to_manifest.length + 2
+
+          if indent_depth[indent_depth_idx] < indent_length
+            indent_depth[indent_depth_idx] = indent_length
+          end
+
+        elsif token.type == :LBRACE
+          indent_depth_idx += 1
+          indent_depth << 0
+          level_tokens[indent_depth_idx] ||= []
+        elsif token.type == :RBRACE
+          level_tokens[indent_depth_idx].each do |arrow_tok|
+            unless arrow_tok.column == indent_depth[indent_depth_idx] || level_tokens[indent_depth_idx].size == 1
+              arrows_on_line = level_tokens[indent_depth_idx].select { |t| t.line == arrow_tok.line }
+              notify :warning, {
+                :message        => 'indentation of => is not properly aligned',
+                :line           => arrow_tok.line,
+                :column         => arrow_tok.column,
+                :token          => arrow_tok,
+                :indent_depth   => indent_depth[indent_depth_idx],
+                :newline        => !(arrows_on_line.index(arrow_tok) == 0),
+                :newline_indent => arrows_on_line.first.prev_code_token.prev_token.value,
+              }
+            end
+          end
+          indent_depth[indent_depth_idx] = 0
+          level_tokens[indent_depth_idx].clear
+          indent_depth_idx -= 1
+        end
+      end
+    end
+  end
+
+  def fix(problem)
+    new_ws_len = (problem[:indent_depth] - (problem[:newline_indent].length + problem[:token].prev_code_token.to_manifest.length + 1))
+    new_ws = ' ' * new_ws_len
+    if problem[:newline]
+      index = tokens.index(problem[:token].prev_code_token.prev_token)
+
+      #insert newline
+      tokens.insert(index, PuppetLint::Lexer::Token.new(:NEWLINE, "\n", 0, 0))
+
+      # indent the parameter to the correct depth
+      problem[:token].prev_code_token.prev_token.type = :INDENT
+      problem[:token].prev_code_token.prev_token.value = problem[:newline_indent].dup
+    end
+
+    if problem[:token].prev_token.type == :WHITESPACE
+      problem[:token].prev_token.value = new_ws
+    else
+      index = tokens.index(problem[:token].prev_token)
+      tokens.insert(index + 1, PuppetLint::Lexer::Token.new(:WHITESPACE, new_ws, 0, 0))
+    end
+  end
+end

data/lib/puppet-lint/tasks/puppet-lint.rb

@@ -0,0 +1,91 @@
+require 'puppet-lint'
+require 'puppet-lint/optparser'
+require 'rake'
+require 'rake/tasklib'
+
+class PuppetLint
+  # Public: A Rake task that can be loaded and used with everything you need.
+  #
+  # Examples
+  #
+  #   require 'puppet-lint'
+  #   PuppetLint::RakeTask.new
+  class RakeTask < ::Rake::TaskLib
+    include ::Rake::DSL if defined?(::Rake::DSL)
+
+    DEFAULT_PATTERN = '**/*.pp'
+
+    attr_accessor :name
+    attr_accessor :pattern
+    attr_accessor :ignore_paths
+    attr_accessor :with_filename
+    attr_accessor :disable_checks
+    attr_accessor :fail_on_warnings
+    attr_accessor :error_level
+    attr_accessor :log_format
+    attr_accessor :with_context
+    attr_accessor :fix
+    attr_accessor :show_ignored
+    attr_accessor :relative
+
+    # Public: Initialise a new PuppetLint::RakeTask.
+    #
+    # args - Not used.
+    #
+    # Example
+    #
+    #   PuppetLint::RakeTask.new
+    def initialize(*args, &task_block)
+      @name = args.shift || :lint
+      @pattern = DEFAULT_PATTERN
+      @with_filename = true
+      @disable_checks = []
+      @ignore_paths = []
+
+      define(args, &task_block)
+    end
+
+    def define(args, &task_block)
+      desc 'Run puppet-lint'
+
+      task_block.call(*[self, args].slice(0, task_block.arity)) if task_block
+
+      # clear any (auto-)pre-existing task
+      Rake::Task[@name].clear if Rake::Task.task_defined?(@name)
+      task @name do
+        PuppetLint::OptParser.build
+
+        Array(@disable_checks).each do |check|
+          PuppetLint.configuration.send("disable_#{check}")
+        end
+
+        %w{with_filename fail_on_warnings error_level log_format with_context fix show_ignored relative}.each do |config|
+          value = instance_variable_get("@#{config}")
+          PuppetLint.configuration.send("#{config}=".to_sym, value) unless value.nil?
+        end
+
+        if PuppetLint.configuration.ignore_paths
+          @ignore_paths = PuppetLint.configuration.ignore_paths
+        end
+
+        RakeFileUtils.send(:verbose, true) do
+          linter = PuppetLint.new
+          matched_files = FileList[@pattern]
+
+          matched_files = matched_files.exclude(*@ignore_paths)
+
+          matched_files.to_a.each do |puppet_file|
+            linter.file = puppet_file
+            linter.run
+            linter.print_problems
+          end
+          abort if linter.errors? || (
+            linter.warnings? && PuppetLint.configuration.fail_on_warnings
+          )
+        end
+      end
+    end
+  end
+end
+
+PuppetLint::RakeTask.new

data/lib/puppet-lint/version.rb

@@ -0,0 +1,3 @@
+class PuppetLint
+  VERSION = '1.2.0'
+end

data/puppet-lint.gemspec

@@ -0,0 +1,24 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'puppet-lint/version'
+
+Gem::Specification.new do |s|
+  s.name = 'halyard-puppet-lint'
+  s.version = PuppetLint::VERSION
+  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
+  style guide and alerts you to any discrepancies.'
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'rspec-its', '~> 1.0'
+  s.add_development_dependency 'rspec-collection_matchers', '~> 1.0'
+
+  s.authors = ['Tim Sharpe']
+  s.email = 'tim@sharpe.id.au'
+end

data/spec/fixtures/test/manifests/fail.pp

@@ -0,0 +1,2 @@
+# foo
+class test::foo { }

data/spec/fixtures/test/manifests/ignore.pp

@@ -0,0 +1 @@
+"test" # lint:ignore:double_quoted_strings

data/spec/fixtures/test/manifests/ignore_multiple_block.pp

@@ -0,0 +1,6 @@
+# lint:ignore:double_quoted_strings lint:ignore:quoted_booleans
+"true"
+"false"
+# lint:endignore
+
+"true"

data/spec/fixtures/test/manifests/ignore_multiple_line.pp

@@ -0,0 +1,2 @@
+"true" # lint:ignore:double_quoted_strings lint:ignore:quoted_booleans
+"false" # lint:ignore:quoted_booleans lint:ignore:double_quoted_strings reason

data/spec/fixtures/test/manifests/ignore_reason.pp

@@ -0,0 +1 @@
+"test" # lint:ignore:double_quoted_strings for a good reason

data/spec/fixtures/test/manifests/init.pp

@@ -0,0 +1,3 @@
+# foo
+class test {
+}

data/spec/fixtures/test/manifests/malformed.pp

@@ -0,0 +1 @@
+class { 'apacheds': master => true' }

data/spec/fixtures/test/manifests/url_interpolation.pp

@@ -0,0 +1,12 @@
+file { 'test1':
+  source => 'puppet:///foo'
+}
+file { 'test2':
+  source => "puppet:///foo/${::fqdn}"
+}
+file { 'test3':
+  source => "puppet:///${::fqdn}/foo"
+}
+file { 'test4':
+  source => "puppet:///foo/${::fqdn}/bar"
+}

data/spec/fixtures/test/manifests/warning.pp

@@ -0,0 +1,2 @@
+# foo
+define test::warning($foo='bar', $baz) { }

data/spec/puppet-lint/bin_spec.rb

@@ -0,0 +1,326 @@
+require 'spec_helper'
+require 'rspec/mocks'
+require 'optparse'
+
+class CommandRun
+  attr_accessor :stdout, :stderr, :exitstatus
+
+  def initialize(args)
+    out = StringIO.new
+    err = StringIO.new
+
+    $stdout = out
+    $stderr = err
+
+    PuppetLint.configuration.defaults
+    @exitstatus = PuppetLint::Bin.new(args).run
+    PuppetLint.configuration.defaults
+
+    @stdout = out.string.strip
+    @stderr = err.string.strip
+
+    $stdout = STDOUT
+    $stderr = STDERR
+  end
+end
+
+describe PuppetLint::Bin do
+  subject do
+    if args.is_a? Array
+      sane_args = args
+    else
+      sane_args = [args]
+    end
+
+    CommandRun.new(sane_args)
+  end
+
+  context 'when running normally' do
+    let(:args) { 'spec/fixtures/test/manifests/init.pp' }
+
+    its(:exitstatus) { is_expected.to eq(0) }
+  end
+
+  context 'when running without arguments' do
+    let(:args) { [] }
+
+    its(:exitstatus) { is_expected.to eq(1) }
+  end
+
+  context 'when asked to display version' do
+    let(:args) { '--version' }
+
+    its(:exitstatus) { is_expected.to eq(0) }
+    its(:stdout) { is_expected.to eq("puppet-lint #{PuppetLint::VERSION}") }
+  end
+
+  context 'when passed multiple files' do
+    let(:args) { [
+      'spec/fixtures/test/manifests/warning.pp',
+      'spec/fixtures/test/manifests/fail.pp',
+    ] }
+
+    its(:exitstatus) { is_expected.to eq(1) }
+    its(:stdout) { is_expected.to eq([
+      "#{args[0]} - WARNING: optional parameter listed before required parameter on line 2",
+      "#{args[1]} - ERROR: test::foo not in autoload module layout on line 2",
+    ].join("\n")) }
+  end
+
+  context 'when passed a malformed file' do
+    let(:args) { 'spec/fixtures/test/manifests/malformed.pp' }
+
+    its(:exitstatus) { is_expected.to eq(1) }
+    its(:stdout) { is_expected.to eq('ERROR: Syntax error (try running `puppet parser validate <file>`) on line 1') }
+  end
+
+  context 'when limited to errors only' do
+    let(:args) { [
+      '--error-level', 'error',
+      'spec/fixtures/test/manifests/warning.pp',
+      'spec/fixtures/test/manifests/fail.pp',
+    ] }
+
+    its(:exitstatus) { is_expected.to eq(1) }
+    its(:stdout) { is_expected.to match(/^#{args.last} - ERROR/) }
+  end
+
+  context 'when limited to warnings only' do
+    let(:args) { [
+      '--error-level', 'warning',
+      'spec/fixtures/test/manifests/warning.pp',
+      'spec/fixtures/test/manifests/fail.pp',
+    ] }
+
+    its(:exitstatus) { is_expected.to eq(1) }
+    its(:stdout) { is_expected.to match(/WARNING/) }
+    its(:stdout) { is_expected.to_not match(/ERROR/) }
+  end
+
+  context 'when specifying a specific check to run' do
+    let(:args) { [
+      '--only-check', 'parameter_order',
+      'spec/fixtures/test/manifests/warning.pp',
+      'spec/fixtures/test/manifests/fail.pp',
+    ] }
+
+    its(:exitstatus) { is_expected.to eq(0) }
+    its(:stdout) { is_expected.to_not match(/ERROR/) }
+    its(:stdout) { is_expected.to match(/WARNING/) }
+  end
+
+  context 'when asked to display filenames ' do
+    let(:args) { ['--with-filename', 'spec/fixtures/test/manifests/fail.pp'] }
+
+    its(:exitstatus) { is_expected.to eq(1) }
+    its(:stdout) { is_expected.to match(%r{^spec/fixtures/test/manifests/fail\.pp -}) }
+  end
+
+  context 'when not asked to fail on warnings' do
+    let(:args) { ['spec/fixtures/test/manifests/warning.pp'] }
+
+    its(:exitstatus) { is_expected.to eq(0) }
+    its(:stdout) { is_expected.to match(/optional parameter/) }
+  end
+
+  context 'when asked to provide context to problems' do
+    let(:args) { [
+      '--with-context',
+      'spec/fixtures/test/manifests/warning.pp',
+    ] }
+
+    its(:exitstatus) { is_expected.to eq(0) }
+    its(:stdout) { is_expected.to eq([
+      'WARNING: optional parameter listed before required parameter on line 2',
+      '',
+      "  define test::warning($foo='bar', $baz) { }",
+      '                                   ^',
+    ].join("\n"))
+    }
+  end
+
+  context 'when asked to fail on warnings' do
+    let(:args) { [
+      '--fail-on-warnings',
+      'spec/fixtures/test/manifests/warning.pp',
+    ] }
+
+    its(:exitstatus) { is_expected.to eq(1) }
+    its(:stdout) { is_expected.to match(/optional parameter/) }
+  end
+
+  context 'when used with an invalid option' do
+    let(:args) { '--foo-bar-baz' }
+
+    its(:exitstatus) { is_expected.to eq(1) }
+    its(:stdout) { is_expected.to match(/invalid option/) }
+  end
+
+  context 'when passed a file that does not exist' do
+    let(:args) { 'spec/fixtures/test/manifests/enoent.pp' }
+
+    its(:exitstatus) { is_expected.to eq(1) }
+    its(:stdout) { is_expected.to match(/specified file does not exist/) }
+  end
+
+  context 'when passed a directory' do
+    let(:args) { 'spec/fixtures/' }
+
+    its(:exitstatus) { is_expected.to eq(1) }
+    its(:stdout) { is_expected.to match(/ERROR/) }
+  end
+
+  context 'when disabling a check' do
+    let(:args) { [
+      '--no-autoloader_layout',
+      'spec/fixtures/test/manifests/fail.pp'
+    ] }
+
+    its(:exitstatus) { is_expected.to eq(0) }
+    its(:stdout) { is_expected.to eq("") }
+  end
+
+  context 'when changing the log format' do
+    context 'to print %{filename}' do
+      let(:args) { [
+        '--log-format', '%{filename}',
+        'spec/fixtures/test/manifests/fail.pp'
+      ] }
+
+      its(:exitstatus) { is_expected.to eq(1) }
+      its(:stdout) { is_expected.to eq('fail.pp') }
+    end
+
+    context 'to print %{path}' do
+      let(:args) { [
+        '--log-format', '%{path}',
+        'spec/fixtures/test/manifests/fail.pp'
+      ] }
+
+      its(:exitstatus) { is_expected.to eq(1) }
+      its(:stdout) { is_expected.to eq('spec/fixtures/test/manifests/fail.pp') }
+    end
+
+    context 'to print %{fullpath}' do
+      let(:args) { [
+        '--log-format', '%{fullpath}',
+        'spec/fixtures/test/manifests/fail.pp'
+      ] }
+
+      its(:exitstatus) { is_expected.to eq(1) }
+      its(:stdout) {
+        is_expected.to match(%r{^/.+/spec/fixtures/test/manifests/fail\.pp$})
+      }
+    end
+
+    context 'to print %{linenumber}' do
+      let(:args) { [
+        '--log-format', '%{linenumber}',
+        'spec/fixtures/test/manifests/fail.pp'
+      ] }
+
+      its(:exitstatus) { is_expected.to eq(1) }
+      its(:stdout) { is_expected.to eq('2') }
+      its(:stderr) { is_expected.to eq('DEPRECATION: Please use %{line} instead of %{linenumber}') }
+    end
+
+    context 'to print %{line}' do
+      let(:args) { [
+        '--log-format', '%{line}',
+        'spec/fixtures/test/manifests/fail.pp'
+      ] }
+
+      its(:exitstatus) { is_expected.to eq(1) }
+      its(:stdout) { is_expected.to eq('2') }
+    end
+
+    context 'to print %{kind}' do
+      let(:args) { [
+        '--log-format', '%{kind}',
+        'spec/fixtures/test/manifests/fail.pp'
+      ] }
+
+      its(:exitstatus) { is_expected.to eq(1) }
+      its(:stdout) { is_expected.to eq('error') }
+    end
+
+    context 'to print %{KIND}' do
+      let(:args) { [
+        '--log-format', '%{KIND}',
+        'spec/fixtures/test/manifests/fail.pp'
+      ] }
+
+      its(:exitstatus) { is_expected.to eq(1) }
+      its(:stdout) { is_expected.to eq('ERROR') }
+    end
+
+    context 'to print %{check}' do
+      let(:args) { [
+        '--log-format', '%{check}',
+        'spec/fixtures/test/manifests/fail.pp'
+      ] }
+
+      its(:exitstatus) { is_expected.to eq(1) }
+      its(:stdout) { is_expected.to eq('autoloader_layout') }
+    end
+
+    context 'to print %{message}' do
+      let(:args) { [
+        '--log-format', '%{message}',
+        'spec/fixtures/test/manifests/fail.pp'
+      ] }
+
+      its(:exitstatus) { is_expected.to eq(1) }
+      its(:stdout) { is_expected.to eq('test::foo not in autoload module layout') }
+    end
+  end
+
+  context 'when hiding ignored problems' do
+    let(:args) { [
+      'spec/fixtures/test/manifests/ignore.pp'
+    ] }
+
+    its(:exitstatus) { is_expected.to eq(0) }
+    its(:stdout) { is_expected.to_not match(/IGNORED/) }
+  end
+
+  context 'when showing ignored problems' do
+    let(:args) { [
+      '--show-ignored',
+      'spec/fixtures/test/manifests/ignore.pp',
+    ] }
+
+    its(:exitstatus) { is_expected.to eq(0) }
+    its(:stdout) { is_expected.to match(/IGNORED/) }
+  end
+
+  context 'when showing ignored problems with a reason' do
+    let(:args) { [
+      '--show-ignored',
+      'spec/fixtures/test/manifests/ignore_reason.pp',
+    ] }
+
+    its(:exitstatus) { is_expected.to eq(0) }
+    its(:stdout) { is_expected.to eq([
+      "IGNORED: double quoted string containing no variables on line 1",
+      "  for a good reason",
+    ].join("\n")) }
+  end
+
+  context 'ignoring multiple checks on a line' do
+    let(:args) { [
+      'spec/fixtures/test/manifests/ignore_multiple_line.pp',
+    ] }
+
+    its(:exitstatus) { is_expected.to eq(0) }
+  end
+
+  context 'ignoring multiple checks in a block' do
+    let(:args) { [
+      'spec/fixtures/test/manifests/ignore_multiple_block.pp',
+    ] }
+
+    its(:exitstatus) { is_expected.to eq(0) }
+    its(:stdout) { is_expected.to match(/^.*line 6$/) }
+  end
+end