puppet-lint 2.5.2 → 3.0.0

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

@@ -1,110 +1,111 @@
+# rubocop:disable Naming/FileName
+
 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.
+# Public: A Rake task that can be loaded and used with everything you need.
+#
+# Examples
+#
+#   require 'puppet-lint'
+#   PuppetLint::RakeTask.new
+class PuppetLint::RakeTask < ::Rake::TaskLib
+  include ::Rake::DSL if defined?(::Rake::DSL)
+
+  DEFAULT_PATTERN = '**/*.pp'.freeze
+
+  attr_accessor :name
+  attr_accessor :pattern
+  attr_accessor :ignore_paths
+  attr_accessor :with_filename
+  attr_accessor :disable_checks
+  attr_accessor :only_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.
   #
-  # Examples
+  # Example
   #
-  #   require 'puppet-lint'
   #   PuppetLint::RakeTask.new
-  class RakeTask < ::Rake::TaskLib
-    include ::Rake::DSL if defined?(::Rake::DSL)
-
-    DEFAULT_PATTERN = '**/*.pp'.freeze
-
-    attr_accessor :name
-    attr_accessor :pattern
-    attr_accessor :ignore_paths
-    attr_accessor :with_filename
-    attr_accessor :disable_checks
-    attr_accessor :only_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 = []
-      @only_checks = []
-      @ignore_paths = []
-
-      define(args, &task_block)
-    end
+  # rubocop:disable Lint/MissingSuper
+  def initialize(*args, &task_block)
+    @name = args.shift || :lint
+    @pattern = DEFAULT_PATTERN
+    @with_filename = true
+    @disable_checks = []
+    @only_checks = []
+    @ignore_paths = []
+
+    define(args, &task_block)
+  end
 
-    def define(args, &task_block)
-      desc 'Run puppet-lint'
+  def define(args, &task_block)
+    desc 'Run puppet-lint'
 
-      task_block.call(*[self, args].slice(0, task_block.arity)) if task_block
+    yield(*[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
+    # clear any (auto-)pre-existing task
+    Rake::Task[@name].clear if Rake::Task.task_defined?(@name)
+    task @name do
+      PuppetLint::OptParser.build
 
-        if Array(@only_checks).any?
-          enable_checks = Array(@only_checks).map(&:to_sym)
-          PuppetLint.configuration.checks.each do |check|
-            if enable_checks.include?(check)
-              PuppetLint.configuration.send("enable_#{check}")
-            else
-              PuppetLint.configuration.send("disable_#{check}")
-            end
+      if Array(@only_checks).any?
+        enable_checks = Array(@only_checks).map(&:to_sym)
+        PuppetLint.configuration.checks.each do |check|
+          if enable_checks.include?(check)
+            PuppetLint.configuration.send("enable_#{check}")
+          else
+            PuppetLint.configuration.send("disable_#{check}")
           end
         end
+      end
 
-        Array(@disable_checks).each do |check|
-          PuppetLint.configuration.send("disable_#{check}")
-        end
+      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
+      ['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.empty?
-          @ignore_paths = PuppetLint.configuration.ignore_paths
-        end
+      if PuppetLint.configuration.ignore_paths && @ignore_paths.empty?
+        @ignore_paths = PuppetLint.configuration.ignore_paths
+      end
 
-        if PuppetLint.configuration.pattern
-          @pattern = PuppetLint.configuration.pattern
-        end
+      if PuppetLint.configuration.pattern
+        @pattern = PuppetLint.configuration.pattern
+      end
 
-        RakeFileUtils.send(:verbose, true) do
-          linter = PuppetLint.new
-          matched_files = FileList[@pattern]
+      RakeFileUtils.send(:verbose, true) do
+        linter = PuppetLint.new
+        matched_files = FileList[@pattern]
 
-          matched_files = matched_files.exclude(*@ignore_paths)
+        matched_files = matched_files.exclude(*@ignore_paths)
 
-          matched_files.to_a.each do |puppet_file|
-            next unless File.file?(puppet_file)
-            linter.file = puppet_file
-            linter.run
-            linter.print_problems
+        matched_files.to_a.each do |puppet_file|
+          next unless File.file?(puppet_file)
+          linter.file = puppet_file
+          linter.run
+          linter.print_problems
 
-            if PuppetLint.configuration.fix && linter.problems.none? { |e| e[:check] == :syntax }
-              IO.write(puppet_file, linter.manifest)
-            end
+          if PuppetLint.configuration.fix && linter.problems.none? { |e| e[:check] == :syntax }
+            IO.write(puppet_file, linter.manifest)
           end
-          abort if linter.errors? || (
-            linter.warnings? && PuppetLint.configuration.fail_on_warnings
-          )
         end
+        abort if linter.errors? || (
+          linter.warnings? && PuppetLint.configuration.fail_on_warnings
+        )
       end
     end
   end

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

@@ -86,9 +86,12 @@ task :release_test do
     'puppetlabs/puppetlabs-chocolatey',
     'voxpupuli/puppet-archive',
     'voxpupuli/puppet-collectd',
+    'voxpupuli/puppet-prometheus',
+    'voxpupuli/puppet-borg',
+    'voxpupuli/puppet-nginx',
+    'voxpupuli/puppet-jenkins',
     'garethr/garethr-docker',
     'sensu/sensu-puppet',
-    'jenkinsci/puppet-jenkins',
   ]
 
   FileUtils.mkdir_p('tmp')

data/lib/puppet-lint/version.rb

@@ -1,3 +1,3 @@
 class PuppetLint
-  VERSION = '2.5.2'.freeze
+  VERSION = '3.0.0'.freeze
 end

data/lib/puppet-lint.rb

@@ -1,3 +1,5 @@
+# rubocop:disable Naming/FileName
+
 # encoding: utf-8
 
 require 'set'
@@ -7,10 +9,12 @@ require 'puppet-lint/lexer'
 require 'puppet-lint/configuration'
 require 'puppet-lint/data'
 require 'puppet-lint/checks'
+require 'puppet-lint/report/github'
 require 'puppet-lint/bin'
 require 'puppet-lint/monkeypatches'
 
 class PuppetLint::NoCodeError < StandardError; end
+
 class PuppetLint::NoFix < StandardError; end
 
 # Parser Syntax Errors
@@ -19,6 +23,7 @@ class PuppetLint::SyntaxError < StandardError
 
   def initialize(token)
     @token = token
+    super
   end
 end
 
@@ -58,7 +63,7 @@ class PuppetLint
   # Public: Initialise a new PuppetLint object.
   def initialize
     @code = nil
-    @statistics = { :error => 0, :warning => 0, :fixed => 0, :ignored => 0 }
+    @statistics = { error: 0, warning: 0, fixed: 0, ignored: 0 }
     @manifest = ''
   end
 
@@ -121,6 +126,16 @@ class PuppetLint
     puts "  #{message[:reason]}" if message[:kind] == :ignored && !message[:reason].nil?
   end
 
+  # Internal: Format a problem message and print it to STDOUT so GitHub Actions
+  # recognizes it as an annotation.
+  #
+  # message - A Hash containing all the information about a problem.
+  #
+  # Returns nothing.
+  def print_github_annotation(message)
+    puts PuppetLint::Report::GitHubActionsReporter.format_problem(path, message)
+  end
+
   # Internal: Get the line of the manifest on which the problem was found
   #
   # message - A Hash containing all the information about a problem.
@@ -150,7 +165,7 @@ class PuppetLint
   # problems - An Array of problem Hashes as returned by
   #            PuppetLint::Checks#run.
   #
-  # Returns nothing.
+  # Returns array of problem.
   def report(problems)
     json = []
     problems.each do |message|
@@ -158,19 +173,19 @@ class PuppetLint
 
       message[:KIND] = message[:kind].to_s.upcase
 
-      if message[:kind] == :fixed || [message[:kind], :all].include?(configuration.error_level)
-        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
+      next unless message[:kind] == :fixed || [message[:kind], :all].include?(configuration.error_level)
+
+      if configuration.json || configuration.sarif
+        message['context'] = get_context(message) if configuration.with_context
+        json << message
+      else
+        format_message(message)
+        print_context(message) if configuration.with_context
+        print_github_annotation(message) if configuration.github_actions
       end
     end
-    puts JSON.pretty_generate(json) if configuration.json
-
     $stderr.puts 'Try running `puppet parser validate <file>`' if problems.any? { |p| p[:check] == :syntax }
+    json
   end
 
   # Public: Determine if PuppetLint found any errors in the manifest.

data/spec/acceptance/puppet_lint_spec.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'spec_helper_acceptance'
+
+describe 'When executing puppet-lint' do
+  let(:manifest_root) { File.join(File.dirname(__FILE__), '..', 'fixtures', 'test', 'manifests') }
+
+  context 'with no manifest provided' do
+    it 'returns an exit code of 1 with no arguments' do
+      result = puppet_lint
+      expect(result[:exit_code]).to eq(1)
+    end
+
+    it 'returns an exit code of 0 when given a single flag' do
+      result = puppet_lint(['--help'])
+      expect(result[:exit_code]).to eq(0)
+    end
+
+    it 'returns the correct version number with the --version flag' do
+      result = puppet_lint(['--version'])
+      expect(result[:stdout]).to match(PuppetLint::VERSION)
+    end
+  end
+
+  context 'with a manifest provided' do
+    it 'returns one error when there is one problem' do
+      result = puppet_lint([File.join(manifest_root, 'fail.pp')])
+      expect(result[:stdout]).to have_errors(1)
+    end
+
+    it 'returns zero errors when there is an ignore comment present' do
+      result = puppet_lint([File.join(manifest_root, 'ignore.pp')])
+      expect(result[:stdout]).to have_errors(0)
+    end
+
+    it 'returns one warning when there is one problem' do
+      result = puppet_lint([File.join(manifest_root, 'warning.pp')])
+      expect(result[:stdout]).to have_warnings(1)
+    end
+
+    it 'contains two warnings when there are two problems' do
+      result = puppet_lint([File.join(manifest_root, 'two_warnings.pp')])
+      expect(result[:stdout]).to have_warnings(2)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,7 @@
-if ENV['COVERAGE'] == 'yes' && RUBY_VERSION.start_with?('2.6.')
+# Disable GitHub Actions reporting since it breaks the test suite
+ENV.delete('GITHUB_ACTION')
+
+if ENV['COVERAGE'] == 'yes' && RUBY_VERSION.start_with?('2.7.')
   require 'simplecov'
   SimpleCov.start do
     add_filter('/spec/')
@@ -16,115 +19,113 @@ rescue LoadError, SyntaxError
   puts 'rspec/json_expectations is not available'
 end
 
-module RSpec
-  module LintExampleGroup
-    class HaveProblem
-      def initialize(method, message)
-        @expected_problem = {
-          :kind    => method.to_s.gsub(%r{\Acontain_}, '').to_sym,
-          :message => message,
-        }
-        @description = ["contain a #{@expected_problem[:kind]}"]
-      end
+module RSpec::LintExampleGroup
+  class HaveProblem
+    def initialize(method, message)
+      @expected_problem = {
+        kind: method.to_s.gsub(%r{\Acontain_}, '').to_sym,
+        message: message,
+      }
+      @description = ["contain a #{@expected_problem[:kind]}"]
+    end
 
-      def on_line(line)
-        @expected_problem[:line] = line
-        @description << "on line #{line}"
-        self
-      end
+    def on_line(line)
+      @expected_problem[:line] = line
+      @description << "on line #{line}"
+      self
+    end
 
-      def in_column(column)
-        @expected_problem[:column] = column
-        @description << "starting in column #{column}"
-        self
-      end
+    def in_column(column)
+      @expected_problem[:column] = column
+      @description << "starting in column #{column}"
+      self
+    end
 
-      def with_reason(reason)
-        @expected_problem[:reason] = reason
-        @description << "with reason '#{reason}'"
-        self
-      end
+    def with_reason(reason)
+      @expected_problem[:reason] = reason
+      @description << "with reason '#{reason}'"
+      self
+    end
 
-      def matches?(problems)
-        @problems = problems
+    def matches?(problems)
+      @problems = problems
 
-        problems.any? do |problem|
-          @expected_problem.all? do |key, value|
-            problem.key?(key) && problem[key] == value
-          end
+      problems.any? do |problem|
+        @expected_problem.all? do |key, value|
+          problem.key?(key) && problem[key] == value
         end
       end
+    end
 
-      def description
-        @description.join(' ')
-      end
-
-      def check_attr(attr, prefix)
-        return if @expected_problem[attr] == @problems.first[attr]
+    def description
+      @description.join(' ')
+    end
 
-        expected = @expected_problem[attr].inspect
-        actual = @problems.first[attr].inspect
-        "#{prefix} #{expected}, but it was #{actual}"
-      end
+    def check_attr(attr, prefix)
+      return if @expected_problem[attr] == @problems.first[attr]
 
-      def failure_message
-        case @problems.length
-        when 0
-          'expected that the check would create a problem but it did not'
-        when 1
-          messages = ['expected that the problem']
-
-          messages << check_attr(:kind, 'would be of kind')
-          messages << check_attr(:message, 'would have the message')
-          messages << check_attr(:line, 'would be on line')
-          messages << check_attr(:column, 'would start on column')
-          messages << check_attr(:reason, 'would have the reason')
-
-          messages.compact.join("\n  ")
-        else
-          [
-            'expected that the check would create',
-            PP.pp(@expected_problem, '').strip,
-            'but it instead created',
-            PP.pp(@problems, ''),
-          ].join("\n")
-        end
-      end
+      expected = @expected_problem[attr].inspect
+      actual = @problems.first[attr].inspect
+      "#{prefix} #{expected}, but it was #{actual}"
+    end
 
-      def failure_message_when_negated
-        'expected that the check would not create the problem, but it did'
+    def failure_message
+      case @problems.length
+      when 0
+        'expected that the check would create a problem but it did not'
+      when 1
+        messages = ['expected that the problem']
+
+        messages << check_attr(:kind, 'would be of kind')
+        messages << check_attr(:message, 'would have the message')
+        messages << check_attr(:line, 'would be on line')
+        messages << check_attr(:column, 'would start on column')
+        messages << check_attr(:reason, 'would have the reason')
+
+        messages.compact.join("\n  ")
+      else
+        [
+          'expected that the check would create',
+          PP.pp(@expected_problem, '').strip,
+          'but it instead created',
+          PP.pp(@problems, ''),
+        ].join("\n")
       end
     end
 
-    def method_missing(method, *args, &block)
-      return HaveProblem.new(method, args.first) if method.to_s.start_with?('contain_')
-      super
+    def failure_message_when_negated
+      'expected that the check would not create the problem, but it did'
     end
+  end
 
-    def respond_to_missing?(method, *)
-      method.to_s.start_with?('contain_') || super
-    end
+  def method_missing(method, *args, &block)
+    return HaveProblem.new(method, args.first) if method.to_s.start_with?('contain_')
+    super
+  end
 
-    def problems
-      subject.problems
-    end
+  def respond_to_missing?(method, *)
+    method.to_s.start_with?('contain_') || super
+  end
 
-    def manifest
-      subject.manifest
-    end
+  def problems
+    subject.problems
+  end
 
-    def subject
-      klass = PuppetLint::Checks.new
-      filepath = respond_to?(:path) ? path : ''
-      klass.load_data(filepath, code)
-      check_name = self.class.top_level_description.to_sym
-      check = PuppetLint.configuration.check_object[check_name].new
-      klass.problems = check.run
+  def manifest
+    subject.manifest
+  end
 
-      klass.problems = check.fix_problems if PuppetLint.configuration.fix
+  def subject
+    klass = PuppetLint::Checks.new
+    filepath = respond_to?(:path) ? path : ''
+    klass.load_data(filepath, code)
+    check_name = self.class.top_level_description.to_sym
+    check = PuppetLint.configuration.check_object[check_name].new
+    klass.problems = check.run
 
-      klass
-    end
+    klass.problems = check.fix_problems if PuppetLint.configuration.fix
+
+    klass
   end
 end
 
@@ -132,8 +133,8 @@ RSpec.configure do |config|
   config.mock_framework = :rspec
   config.include(
     RSpec::LintExampleGroup,
-    :type      => :lint,
-    :file_path => Regexp.compile(%w[spec puppet-lint plugins].join('[\\\/]'))
+    type: :lint,
+    file_path: Regexp.compile(['spec', 'unit', 'puppet-lint', 'plugins'].join('[\\\/]')),
   )
 
   config.expect_with(:rspec) do |c|

data/spec/spec_helper_acceptance.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'puppet_litmus'
+require 'spec_helper_acceptance_local' if File.file?(File.join(File.dirname(__FILE__), 'spec_helper_acceptance_local.rb'))
+
+PuppetLitmus.configure!

data/spec/spec_helper_acceptance_local.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'shellwords'
+require 'open3'
+require 'rspec/expectations'
+
+def puppet_lint(args = [])
+  raise "Parameter 'args' should an Array but it was of type #{args.class}." unless args.is_a?(Array) || args.empty?
+
+  bin_path = File.join(File.dirname(__FILE__), '..', 'bin', 'puppet-lint')
+
+  command = [bin_path]
+  command.concat(args) unless args.empty?
+
+  stdout, stderr, status = Open3.capture3(*command)
+
+  {
+    stdout: stdout.chomp,
+    stderr: stderr.chomp,
+    exit_code: status.exitstatus,
+  }
+end
+
+RSpec::Matchers.define :have_errors do |expected|
+  match do |actual|
+    actual.split("\n").count { |line| line.include?('ERROR') } == expected
+  end
+
+  diffable
+end
+
+RSpec::Matchers.define :have_warnings do |expected|
+  match do |actual|
+    actual.split("\n").count { |line| line.include?('WARNING') } == expected
+  end
+
+  diffable
+end