puppet-lint 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fce16244bedd61b8ca330f4dd9c2947e8111382830ebd63b22d9f2af8d2a50b
-  data.tar.gz: 727de95b4de5c2c2ee24172eea4f9e2551c816e31f3898bcc20e498e4ee7d614
+  metadata.gz: e8eaced98bf8f51da32089208cd7d628100e532e91d7323b77d04264584efecb
+  data.tar.gz: b4edfa7027559c4ccc1f0f25433558069857e9cbb6ef17ddcad85a9db1ee795f
 SHA512:
-  metadata.gz: cb7870bfd9fd0a5bc5a616c651b0d614e6134761b15149c2db34f8796358b23dee66ae465c47f8361f37c9066286d49a619e764277acd6a49aa9ba7c68e2842c
-  data.tar.gz: fc2ea5694a8dd0660018d2a8cd1fbee55bb813fd68b052c06127a3857ba00b99e6e67970e9fb58ae1681f34cb4ddb8d6fda8c74690b9bf7c403f37ba80cc024e
+  metadata.gz: 3b88dcb4eee4df0475c83764f456a3a9f2721bbee922ca8b7cb981225d07c4be674ffc4f929a45ec6e357b4c7ca702e1c88ffbbe44f4e52dd3f54836233852d4
+  data.tar.gz: dc0278aea71db1cab2c2de6788d58ab51c15a25567c912ec5fd3456c60a2c30eb1e43c2b55015bf242a1da9217c5f4c8c8c409dfb777504730f9ed3ae300520b

data/README.md

@@ -215,6 +215,30 @@ There is a GitHub Actions action available to get linter feedback in workflows:
 
 * [puppet-lint-action](https://github.com/marketplace/actions/puppet-lint-action)
 
+## Integration with GitLab Code Quality
+
+[GitLab](https://gitlab.com/) users can use the `--codeclimate-report-file` configuration option to generate a report for use with the
+[Code Quality](https://docs.gitlab.com/ee/ci/testing/code_quality.html) feature.
+
+The easiest way to set this option, (and without having to modify rake tasks), is with the `CODECLIMATE_REPORT_FILE` environment variable.
+
+For example, the following GitLab job sets the environment variable and
+[archives the report](https://docs.gitlab.com/ee/ci/yaml/artifacts_reports.html#artifactsreportscodequality) produced.
+```yaml
+validate lint check rubocop-Ruby 2.7.2-Puppet ~> 7:
+  stage: syntax
+  image: ruby:2.7.2
+  script:
+    - bundle exec rake validate lint check rubocop
+  variables:
+    PUPPET_GEM_VERSION: '~> 7'
+    CODECLIMATE_REPORT_FILE: 'gl-code-quality-report.json'
+  artifacts:
+    reports:
+      codequality: gl-code-quality-report.json
+    expire_in: 1 week
+```
+
 ## Options
 
 See `puppet-lint --help` for a full list of command line options and checks.

data/lib/puppet-lint/bin.rb

@@ -1,6 +1,7 @@
 require 'pathname'
 require 'uri'
 require 'puppet-lint/optparser'
+require 'puppet-lint/report/codeclimate'
 
 # Internal: The logic of the puppet-lint bin script, contained in a class for
 # ease of testing.
@@ -104,6 +105,10 @@ class PuppetLint::Bin
         puts JSON.pretty_generate(all_problems)
       end
 
+      if PuppetLint.configuration.codeclimate_report_file
+        PuppetLint::Report::CodeClimateReporter.write_report_file(all_problems, PuppetLint.configuration.codeclimate_report_file)
+      end
+
       return_val
     rescue PuppetLint::NoCodeError
       puts 'puppet-lint: no file specified or specified file does not exist'

data/lib/puppet-lint/configuration.rb

@@ -153,5 +153,6 @@ class PuppetLint::Configuration
     self.show_ignored = false
     self.ignore_paths = ['vendor/**/*.pp']
     self.github_actions = ENV.key?('GITHUB_ACTION')
+    self.codeclimate_report_file = ENV['CODECLIMATE_REPORT_FILE']
   end
 end

data/lib/puppet-lint/optparser.rb

@@ -102,6 +102,10 @@ class PuppetLint::OptParser
         PuppetLint.configuration.sarif = true
       end
 
+      opts.on('--codeclimate-report-file FILE', 'Save a code climate compatible report to this file') do |file|
+        PuppetLint.configuration.codeclimate_report_file = file
+      end
+
       opts.on('--list-checks', 'List available check names.') do
         PuppetLint.configuration.list_checks = true
       end

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

@@ -115,10 +115,14 @@ PuppetLint.new_check(:legacy_facts) do
     tokens.select { |x| LEGACY_FACTS_VAR_TYPES.include?(x.type) }.each do |token|
       fact_name = ''
 
-      # Get rid of the top scope before we do our work. We don't need to
-      # preserve it because it won't work with the new structured facts.
-      if token.value.start_with?('::')
-        fact_name = token.value.sub(%r{^::}, '')
+      # This matches legacy facts defined in the fact hash that use the top scope
+      # fact assignment.
+      if token.value.start_with?('::facts[')
+        fact_name = token.value.match(%r{::facts\['(.*)'\]})[1]
+
+      # This matches legacy facts defined in the fact hash.
+      elsif token.value.start_with?("facts['")
+        fact_name = token.value.match(%r{facts\['(.*)'\]})[1]
 
       # This matches using legacy facts in a the new structured fact. For
       # example this would match 'uuid' in $facts['uuid'] so it can be converted
@@ -126,8 +130,10 @@ PuppetLint.new_check(:legacy_facts) do
       elsif token.value == 'facts'
         fact_name = hash_key_for(token)
 
-      elsif token.value.start_with?("facts['")
-        fact_name = token.value.match(%r{facts\['(.*)'\]})[1]
+      # Now we can get rid of top scopes. We don't need to
+      # preserve it because it won't work with the new structured facts.
+      elsif token.value.start_with?('::')
+        fact_name = token.value.sub(%r{^::}, '')
       end
 
       next unless EASY_FACTS.include?(fact_name) || UNCONVERTIBLE_FACTS.include?(fact_name) || fact_name.match(Regexp.union(REGEX_FACTS))

data/lib/puppet-lint/report/codeclimate.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'digest'
+require 'json'
+
+class PuppetLint::Report
+  # Formats problems and writes them to a file as a code climate compatible report.
+  class CodeClimateReporter
+    def self.write_report_file(problems, report_file)
+      report = []
+      problems.each do |messages|
+        messages.each do |message|
+          case message[:kind]
+          when :warning
+            severity = 'minor'
+          when :error
+            severity = 'major'
+          else
+            next
+          end
+
+          issue = {
+            type: :issue,
+            check_name: message[:check],
+            description: message[:message],
+            categories: [:Style],
+            severity: severity,
+            location: {
+              path: message[:path],
+              lines: {
+                begin: message[:line],
+                end: message[:line],
+              }
+            },
+          }
+
+          issue[:fingerprint] = Digest::MD5.hexdigest(Marshal.dump(issue))
+
+          if message.key?(:description) && message.key?(:help_uri)
+            issue[:content] = "#{message[:description].chomp('.')}. See [this page](#{message[:help_uri]}) for more information about the `#{message[:check]}` check."
+          end
+          report << issue
+        end
+      end
+      File.write(report_file, "#{JSON.pretty_generate(report)}\n")
+    end
+  end
+end

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

@@ -4,6 +4,7 @@ require 'puppet-lint'
 require 'puppet-lint/optparser'
 require 'rake'
 require 'rake/tasklib'
+require 'puppet-lint/report/codeclimate'
 
 # Public: A Rake task that can be loaded and used with everything you need.
 #
@@ -90,6 +91,7 @@ class PuppetLint::RakeTask < ::Rake::TaskLib
       RakeFileUtils.send(:verbose, true) do
         linter = PuppetLint.new
         matched_files = FileList[@pattern]
+        all_problems = []
 
         matched_files = matched_files.exclude(*@ignore_paths)
 
@@ -97,12 +99,17 @@ class PuppetLint::RakeTask < ::Rake::TaskLib
           next unless File.file?(puppet_file)
           linter.file = puppet_file
           linter.run
-          linter.print_problems
+          all_problems << linter.print_problems
 
           if PuppetLint.configuration.fix && linter.problems.none? { |e| e[:check] == :syntax }
             IO.write(puppet_file, linter.manifest)
           end
         end
+
+        if PuppetLint.configuration.codeclimate_report_file
+          PuppetLint::Report::CodeClimateReporter.write_report_file(all_problems, PuppetLint.configuration.codeclimate_report_file)
+        end
+
         abort if linter.errors? || (
           linter.warnings? && PuppetLint.configuration.fail_on_warnings
         )

data/lib/puppet-lint/version.rb

@@ -1,3 +1,3 @@
 class PuppetLint
-  VERSION = '3.1.0'.freeze
+  VERSION = '3.2.0'.freeze
 end

data/lib/puppet-lint.rb

@@ -124,6 +124,7 @@ class PuppetLint
     puts format % message
 
     puts "  #{message[:reason]}" if message[:kind] == :ignored && !message[:reason].nil?
+    print_context(message)
   end
 
   # Internal: Format a problem message and print it to STDOUT so GitHub Actions
@@ -154,7 +155,8 @@ class PuppetLint
   def print_context(message)
     return if message[:check] == 'documentation'
     return if message[:kind] == :fixed
-    line = get_context(message)
+    line = message[:context]
+    return unless line
     offset = line.index(%r{\S}) || 1
     puts "\n  #{line.strip}"
     printf("%#{message[:column] + 2 - offset}s\n\n", '^')
@@ -168,6 +170,8 @@ class PuppetLint
   # Returns array of problem.
   def report(problems)
     json = []
+    print_stdout = !(configuration.json || configuration.sarif)
+
     problems.each do |message|
       next if message[:kind] == :ignored && !PuppetLint.configuration.show_ignored
 
@@ -175,12 +179,12 @@ class PuppetLint
 
       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
+      message[:context] = get_context(message) if configuration.with_context
+
+      json << message
+
+      if print_stdout
         format_message(message)
-        print_context(message) if configuration.with_context
         print_github_annotation(message) if configuration.github_actions
       end
     end
@@ -225,7 +229,7 @@ class PuppetLint
 
   # Public: Print any problems that were found out to stdout.
   #
-  # Returns nothing.
+  # Returns an array of problems.
   def print_problems
     report(@problems)
   end

data/spec/fixtures/test/reports/code_climate.json

@@ -0,0 +1,38 @@
+[
+  {
+    "type": "issue",
+    "check_name": "autoloader_layout",
+    "description": "test::foo not in autoload module layout",
+    "categories": [
+      "Style"
+    ],
+    "severity": "major",
+    "location": {
+      "path": "spec/fixtures/test/manifests/fail.pp",
+      "lines": {
+        "begin": 2,
+        "end": 2
+      }
+    },
+    "fingerprint": "f12bce7a776454ab9ffac2d20dcc34ba",
+    "content": "Test the manifest tokens for any classes or defined types that are not in an appropriately named file for the autoloader to detect and record an error of each instance found. See [this page](https://puppet.com/docs/puppet/latest/style_guide.html#separate-files) for more information about the `autoloader_layout` check."
+  },
+  {
+    "type": "issue",
+    "check_name": "parameter_order",
+    "description": "optional parameter listed before required parameter",
+    "categories": [
+      "Style"
+    ],
+    "severity": "minor",
+    "location": {
+      "path": "spec/fixtures/test/manifests/warning.pp",
+      "lines": {
+        "begin": 2,
+        "end": 2
+      }
+    },
+    "fingerprint": "e34cf289e008446b633d1be7cf58120e",
+    "content": "Test the manifest tokens for any parameterised classes or defined types that take parameters and record a warning if there are any optional parameters listed before required parameters. See [this page](https://puppet.com/docs/puppet/latest/style_guide.html#display-order-of-parameters) for more information about the `parameter_order` check."
+  }
+]

data/spec/unit/puppet-lint/bin_spec.rb

@@ -437,6 +437,30 @@ describe PuppetLint::Bin do
     end
   end
 
+  context 'when outputting code climate report' do
+    let(:report_file) do
+      Tempfile.new('report_file.json')
+    end
+
+    let(:args) do
+      [
+        '--codeclimate-report-file',
+        report_file.path,
+        'spec/fixtures/test/manifests/fail.pp',
+        'spec/fixtures/test/manifests/warning.pp',
+      ]
+    end
+
+    after(:each) do
+      report_file.unlink
+    end
+
+    it 'creates a code climate report' do
+      expect(bin.exitstatus).to eq(1)
+      expect(FileUtils.compare_file(report_file.path, 'spec/fixtures/test/reports/code_climate.json')).to be_truthy
+    end
+  end
+
   context 'when hiding ignored problems' do
     let(:args) do
       [

data/spec/unit/puppet-lint/configuration_spec.rb

@@ -55,17 +55,18 @@ describe PuppetLint::Configuration do
     end
 
     expect(config.settings).to eq(
-      'with_filename'    => false,
-      'fail_on_warnings' => false,
-      'error_level'      => :all,
-      'log_format'       => '',
-      'sarif'            => false,
-      'with_context'     => false,
-      'fix'              => false,
-      'github_actions'   => false,
-      'show_ignored'     => false,
-      'json'             => false,
-      'ignore_paths'     => ['vendor/**/*.pp'],
+      'with_filename'           => false,
+      'fail_on_warnings'        => false,
+      'codeclimate_report_file' => nil,
+      'error_level'             => :all,
+      'log_format'              => '',
+      'sarif'                   => false,
+      'with_context'            => false,
+      'fix'                     => false,
+      'github_actions'          => false,
+      'show_ignored'            => false,
+      'json'                    => false,
+      'ignore_paths'            => ['vendor/**/*.pp'],
     )
   end
 
@@ -78,6 +79,15 @@ describe PuppetLint::Configuration do
     expect(config.settings['github_actions']).to be(true)
   end
 
+  it 'defaults codeclimate_report_file to the CODECLIMATE_REPORT_FILE environment variable' do
+    override_env do
+      ENV['CODECLIMATE_REPORT_FILE'] = '/path/to/report.json'
+      config.defaults
+    end
+
+    expect(config.settings['codeclimate_report_file']).to eq('/path/to/report.json')
+  end
+
   def override_env
     old_env = ENV.to_h
     yield

data/spec/unit/puppet-lint/plugins/legacy_facts/legacy_facts_spec.rb

@@ -113,6 +113,14 @@ describe 'legacy_facts' do
         expect(problems).to have(1).problem
       end
     end
+
+    context 'top scoped fact variable using legacy facts hash variable in interpolation' do
+      let(:code) { "$::facts['osfamily']" }
+
+      it 'detects a single problem' do
+        expect(problems).to have(1).problem
+      end
+    end
   end
 
   context 'with fix enabled' do
@@ -165,6 +173,31 @@ describe 'legacy_facts' do
       end
     end
 
+    context 'fact variable using top scope $::facts hash' do
+      let(:code) { "$::facts['os']['family']" }
+
+      it 'does not detect any problems' do
+        expect(problems).to have(0).problem
+      end
+    end
+
+    context "fact variable using legacy top scope $::facts['osfamily']" do
+      let(:code) { "$::facts['osfamily']" }
+      let(:msg) { "legacy fact 'osfamily'" }
+
+      it 'only detects a single problem' do
+        expect(problems).to have(1).problem
+      end
+
+      it 'fixes the problem' do
+        expect(problems).to contain_fixed(msg).on_line(1).in_column(1)
+      end
+
+      it 'uses the facts hash' do
+        expect(manifest).to eq("$facts['os']['family']")
+      end
+    end
+
     context 'fact variable using legacy $::osfamily' do
       let(:code) { '$::osfamily' }
       let(:msg) { "legacy fact 'osfamily'" }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Tim Sharpe
@@ -77,6 +77,7 @@ files:
 - lib/puppet-lint/plugins/check_whitespace/trailing_whitespace.rb
 - lib/puppet-lint/plugins/legacy_facts/legacy_facts.rb
 - lib/puppet-lint/plugins/top_scope_facts/top_scope_facts.rb
+- lib/puppet-lint/report/codeclimate.rb
 - lib/puppet-lint/report/github.rb
 - lib/puppet-lint/report/sarif_template.json
 - lib/puppet-lint/tasks/gemfile_rewrite.rb
@@ -97,6 +98,7 @@ files:
 - spec/fixtures/test/manifests/unterminated_control_comment.pp
 - spec/fixtures/test/manifests/url_interpolation.pp
 - spec/fixtures/test/manifests/warning.pp
+- spec/fixtures/test/reports/code_climate.json
 - spec/spec_helper.rb
 - spec/spec_helper_acceptance.rb
 - spec/spec_helper_acceptance_local.rb