puppet-lint 4.1.0 → 4.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3953f32f31f48881c186abdd6a5ce57c2debaf28d24afc4b207a2a84a2065ccf
-  data.tar.gz: 60730e1ecb6cbf54f72f23bbb96769d181b9132a2fb756bdc858949e953d3467
+  metadata.gz: b8fbf6d28ee384ac72918e39f7a578ccbca81041749e612b9d9ead33a72f7e57
+  data.tar.gz: 358cdd9a1c4c1c71986b868897855cd6410a538fdff6f8f625fd60007fe062e2
 SHA512:
-  metadata.gz: 2421fd601c8e371f8bcfa8ffff3f5f9674fa1334d7ced66e1c0bd4a376c8365822f57b11a6d3ad80e134ea2b6faf6c20281e3497715b34c3c22db163e424cb2e
-  data.tar.gz: 5ab8e9650e45521eb84ea8c8f89d0970c90f919bd51e82dc6be73fc5a2b0944875673a16058ad0894288730358772ef82f07540a8ac0230bdb32aa5727abab46
+  metadata.gz: 0073f5e753d913b7d3fc324646bd04fb46eac444ffe6111422f3b2fddbc7008737d4774ce29bfe7b34e946bbcd3301d0d66836ab04ecc88e4f21198eaa4c192e
+  data.tar.gz: 67f83fcafd14cc225c43f64ddb8326f88a37225700058e83bf2d22fc0a5915bb1096b6e46557c7a88c3e0210bd36ed171136eacef0722e1bb2aa20935efa3b8f

data/README.md

@@ -1,13 +1,15 @@
 # Puppet Lint
 
+[![Code Owners](https://img.shields.io/badge/owners-DevX--team-blue)](https://github.com/puppetlabs/puppet-lint/blob/main/CODEOWNERS)
+![ci](https://github.com/puppetlabs/puppet-lint/actions/workflows/ci.yml/badge.svg)
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/puppetlabs/puppet-lint)
+
 Puppet Lint tests Puppet code against the recommended [Puppet language style
 guide](http://puppet.com/docs/puppet/latest/style_guide.html). Puppet Lint validates only code style; it does not validate syntax. To test syntax, use Puppet's `puppet parser validate` command.
 
 ## Compatibility warning
 
-Version 3.0.0 and above will no longer support Puppet 6 environments.
-
-In cases where Puppet Lint is required in an environment with Puppet 6, we recommend pinning to version 2.5.2.
+This tool is only supported on Puppet 7 & 8 environments. In cases where Puppet Lint is required in an environment with Puppet 6, we recommend pinning to version 2.5.2.
 
 ## Installation
 
@@ -112,7 +114,7 @@ Any flag that can be specified on the command line can also be specified in the
 --no-hard_tabs-check
 ```
 
-Or to specify a whitelist of allowed checks, include a line like:
+Or to specify an allowlist of allowed checks, include a line like:
 
 ```
 --only-checks=trailing_whitespace,hard_tabs,duplicate_params,double_quoted_strings,unquoted_file_mode,only_variable_string,variables_not_enclosed,single_quote_string_with_variables,variable_contains_dash,ensure_not_symlink_target,unquoted_resource_title,relative_classname_inclusion,file_mode,resource_reference_without_title_capital,leading_zero,arrow_alignment,variable_is_lowercase,ensure_first_param,resource_reference_without_whitespace,file_ensure,trailing_comma,leading_zero
@@ -293,6 +295,18 @@ If you find a bug in Puppet Lint or its results, please create an issue in the
 [repo issues tracker](https://github.com/puppetlabs/puppet-lint/issues/). Bonus
 points will be awarded if you also include a patch that fixes the issue.
 
+## Development
+
+Acceptance tests for this tool leverage [puppet_litmus](https://github.com/puppetlabs/puppet_litmus).
+To run the acceptance tests follow the instructions [here](https://github.com/puppetlabs/puppet_litmus/wiki/Tutorial:-use-Litmus-to-execute-acceptance-tests-with-a-sample-module-(MoTD)#install-the-necessary-gems-for-the-module).
+You can also find a tutorial and walkthrough of using Litmus and the PDK on [YouTube](https://www.youtube.com/watch?v=FYfR7ZEGHoE).
+
+If you run into an issue with this tool or would like to request a feature you can [raise a PR](https://github.com/puppetlabs/puppet-lint/pulls) with your suggested changes. Alternatively, you can [raise a Github issue](https://github.com/puppetlabs/puppet-lint/issues) with a feature request or to report any bugs.
+Every other Tuesday the DevX team holds [office hours](https://puppet.com/community/office-hours) in the [Puppet Community Slack](http://slack.puppet.com/), where you can ask questions about this and any other supported tools.
+This session runs at 15:00 (GMT) for about an hour.
+
+If you have problems getting this tool up and running, please [contact Support](http://puppetlabs.com/services/customer-support).
+
 ## Thank you
 
 Many thanks to the following people for contributing to puppet-lint

data/lib/puppet-lint/lexer.rb

@@ -50,7 +50,7 @@ class PuppetLint::Lexer
 
   # 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
+  # From https://github.com/puppetlabs/puppet/blob/main/lib/puppet/pops/parser/lexer2.rb#L116-L137
   # or thereabouts
   KEYWORDS = {
     'case' => true,
@@ -78,7 +78,7 @@ class PuppetLint::Lexer
 
   # 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
+  # From https://github.com/puppetlabs/puppet/blob/main/lib/puppet/pops/parser/lexer2.rb#L142-L159
   # or therabouts
   # Currently unused
   APP_MANAGEMENT_TOKENS = {

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

@@ -116,8 +116,8 @@ PuppetLint.new_check(:legacy_facts) do
       fact_name = ''
 
       # This matches legacy facts defined in the fact hash.
-      if (match = (token.value.match(%r{(::)?facts\['(.*)'\]}) || token.value.match(%r{(::)?facts\[(.*)\]})))
-        fact_name = match[2]
+      if (match = token.value.match(%r{^(?:::)?facts\[(?<quote>'?)(?<value>.+)\k<quote>\]$}))
+        fact_name = match[:value]
 
       # 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

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

@@ -7,7 +7,7 @@
 # If you have top scope variables that aren't facts you should configure the
 # linter to ignore them.
 #
-# You can whitelist top scope variables to ignore via the Rake task.
+# You can allowlist top scope variables to ignore via the Rake task.
 # You should insert the following line to your Rakefile.
 # `PuppetLint.configuration.top_scope_variables = ['location', 'role']`
 #
@@ -17,7 +17,7 @@ TOP_SCOPE_FACTS_VAR_TYPES = Set[:VARIABLE, :UNENC_VARIABLE]
 
 PuppetLint.new_check(:top_scope_facts) do
   def check
-    whitelist = ['trusted', 'facts', 'architecture', 'augeasversion', 'bios_release_date', 'bios_vendor', 'bios_version',
+    allowlist = ['trusted', 'facts', 'architecture', 'augeasversion', 'bios_release_date', 'bios_vendor', 'bios_version',
                  'boardassettag', 'boardmanufacturer', 'boardproductname', 'boardserialnumber', 'chassisassettag', 'chassistype', 'domain',
                  'fqdn', 'gid', 'hardwareisa', 'hardwaremodel', 'hostname', 'id', 'ipaddress', 'ipaddress6', 'lsbdistcodename',
                  'lsbdistdescription', 'lsbdistid', 'lsbdistrelease', 'lsbmajdistrelease', 'lsbminordistrelease', 'lsbrelease',
@@ -28,10 +28,10 @@ PuppetLint.new_check(:top_scope_facts) do
                  'selinux_config_policy', 'selinux_current_mode', 'selinux_enforced', 'selinux_policyversion', 'serialnumber',
                  'swapencrypted', 'swapfree', 'swapsize', 'system32', 'uptime', 'uptime_days', 'uptime_hours', 'uptime_seconds',
                  'uuid', 'xendomains', 'zonename'] + (PuppetLint.configuration.top_scope_variables || [])
-    whitelist = whitelist.join('|')
+    allowlist = allowlist.join('|')
     tokens.select { |x| TOP_SCOPE_FACTS_VAR_TYPES.include?(x.type) }.each do |token|
       next unless %r{^::}.match?(token.value)
-      next if %r{^::(#{whitelist})\[?}.match?(token.value)
+      next if %r{^::(#{allowlist})\[?}.match?(token.value)
       next if %r{^::[a-z0-9_][a-zA-Z0-9_]+::}.match?(token.value)
 
       notify :warning, {

data/lib/puppet-lint/version.rb

@@ -1,3 +1,3 @@
 class PuppetLint
-  VERSION = '4.1.0'.freeze
+  VERSION = '4.2.1'.freeze
 end

data/rubocop_baseline.yml

@@ -81,3 +81,10 @@ Style/Documentation:
   - spec/**/*
 Style/WordArray:
   EnforcedStyle: brackets
+####################################################
+# Cops below here due for deprecation
+####################################################
+# ``Rspec/FilePath`` is going to be deprecated in the next major release of rubocop >=3.0.0: see <https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/FilePath>
+# As the new cops are already present, e.g., Rspec/SpecFilePathPathFormat, then disabling this in preparation
+RSpec/FilePath:
+  Enabled: false

data/spec/spec_helper.rb

@@ -12,7 +12,6 @@ end
 
 require 'puppet-lint'
 require 'rspec/its'
-require 'rspec/collection_matchers'
 begin
   require 'rspec/json_expectations'
 rescue LoadError, SyntaxError

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

@@ -31,7 +31,7 @@ describe PuppetLint::Checks do
         end
 
         it 'creates a syntax error problem for the file' do
-          expect(instance.problems).to have(1).problem
+          expect(instance.problems.size).to eq(1)
           expect(instance.problems.first).to include(
             kind: :error,
             check: :syntax,
@@ -53,7 +53,7 @@ describe PuppetLint::Checks do
         end
 
         it 'creates a syntax error problem for the file' do
-          expect(instance.problems).to have(1).problem
+          expect(instance.problems.size).to eq(1)
           expect(instance.problems.first).to include(
             kind: :error,
             check: :syntax,
@@ -148,9 +148,14 @@ describe PuppetLint::Checks do
 
       it 'prints out information about the puppet-lint version and ruby environment' do
         expected_info = [
+          'Whoops! It looks like puppet-lint has encountered an error that it doesn\'t',
+          'know how to handle. Please open an issue at https://github.com/puppetlabs/puppet-lint',
+          'and paste the following output into the issue description.',
+          '---',
           "puppet-lint version: #{PuppetLint::VERSION}",
           "ruby version: #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}",
           "platform: #{RUBY_PLATFORM}",
+          "file path: #{fileinfo}",
         ]
         pattern = expected_info.map { |r| Regexp.escape(r) }.join('\s+')
         expect($stdout).to receive(:puts).with(a_string_matching(%r{#{pattern}}m))

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

@@ -13,7 +13,7 @@ describe 'quoted_booleans', type: :lint do
     end
 
     it 'detects three problems' do
-      expect(problems).to have(3).problems
+      expect(problems.size).to eq(3)
     end
 
     it 'has two warnings' do
@@ -36,7 +36,7 @@ describe 'quoted_booleans', type: :lint do
     end
 
     it 'detects three problems' do
-      expect(problems).to have(3).problems
+      expect(problems.size).to eq(3)
     end
 
     it 'has two warnings' do
@@ -62,7 +62,7 @@ describe 'quoted_booleans', type: :lint do
     end
 
     it 'detects four problems' do
-      expect(problems).to have(4).problems
+      expect(problems.size).to eq(4)
     end
 
     it 'has two warnings' do
@@ -89,7 +89,7 @@ describe 'quoted_booleans', type: :lint do
     end
 
     it 'detects four problems' do
-      expect(problems).to have(4).problems
+      expect(problems.size).to eq(4)
     end
 
     it 'has two warnings' do
@@ -107,7 +107,7 @@ describe 'quoted_booleans', type: :lint do
     let(:code) { '"true" # lint:ignore:quoted_booleans lint:ignore:double_quoted_string a reason' }
 
     it 'detects 1 problems' do
-      expect(problems).to have(1).problems
+      expect(problems.size).to eq(1)
     end
 
     it 'has one ignored problems' do
@@ -129,7 +129,7 @@ describe 'quoted_booleans', type: :lint do
     end
 
     it 'detects 2 problems' do
-      expect(problems).to have(2).problems
+      expect(problems.size).to eq(2)
     end
 
     it 'ignores both problems' do