puppet-lint 4.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7cd6dad7a05e7eefb19f4c9efedc5815b1f83376a77def6fd54b321945c520c
-  data.tar.gz: d82288ffc965a3f001269abdb42efe6bb71041575b1106e3331b4a70f2a0fe84
+  metadata.gz: 1c29efe87a1b5506f4849bf91bb2ebdd9aa76985bbfe0cb9206de80d309a5611
+  data.tar.gz: f17c4c2195f16b27e5595c9e1546ae53ad255913f2ea42203a9eee221e11d809
 SHA512:
-  metadata.gz: b1571f76174d7afaca3da45f692b681aedb4e99a52563c3f3a0171d6db9bbddb9c409f5f21223fbfe249b7254f2d41edb01331b9c154afafb35572f3fdff7e7c
-  data.tar.gz: e594e8917a7ce55bab177449d1a6db41454dbbaacb37eb4a4f1b0ec9a8cf4e82f5ee023d112ca629d83bceceaba413d281d242f45388207a4c707e7380afc3ab
+  metadata.gz: '048132fc797b8f1ac6b31a310db4b4f654f71930847b6839783107381d7d46893d672ad3c879e6792f8f2c5367aa733addb855cd820c2578da63b4222853e13f'
+  data.tar.gz: b9d4f0a474c89731757c336811e910885ce87bd4dca6c4041355f2646e51ad87c38eeaa66ced098aca4146d4c33b03c2bffeb970bd0c91c00d111984cd493718

data/lib/puppet-lint/lexer/token.rb

@@ -30,7 +30,7 @@ class PuppetLint::Lexer
     # etc) in the manifest.
     attr_accessor :next_code_token
 
-    # Public: Gets/sets the previous code tokne (skips whitespace,
+    # Public: Gets/sets the previous code token (skips whitespace,
     # comments, etc) in the manifest.
     attr_accessor :prev_code_token
 

data/lib/puppet-lint/plugins/check_classes/parameter_order.rb

@@ -37,7 +37,7 @@ PuppetLint.new_check(:parameter_order) do
           column: token.column,
           description: '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.',
-          help_uri: 'https://puppet.com/docs/puppet/latest/style_guide.html#display-order-of-parameters',
+          help_uri: 'https://puppet.com/docs/puppet/latest/style_guide.html#params-display-order',
         )
       end
     end
@@ -48,17 +48,15 @@ PuppetLint.new_check(:parameter_order) do
     return false unless token.prev_code_token
 
     [
-      :LPAREN, # First parameter, no type specification
-      :COMMA,  # Subsequent parameter, no type specification
-      :TYPE,   # Parameter with simple type specification
-      :RBRACK, # Parameter with complex type specification
+      :LPAREN,   # First parameter, no type specification
+      :COMMA,    # Subsequent parameter, no type specification
+      :TYPE,     # Parameter with simple type specification
+      :RBRACK,   # Parameter with complex type specification
+      :CLASSREF, # Parameter with custom type specification
     ].include?(token.prev_code_token.type)
   end
 
   def required_parameter?(token)
-    data_type = token.prev_token_of(:TYPE, skip_blocks: true)
-    return false if data_type && data_type.value == 'Optional'
-
     return !(token.prev_code_token && token.prev_code_token.type == :EQUALS) if token.next_code_token.nil? || [:COMMA, :RPAREN].include?(token.next_code_token.type)
 
     false

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

@@ -115,14 +115,9 @@ PuppetLint.new_check(:legacy_facts) do
     tokens.select { |x| LEGACY_FACTS_VAR_TYPES.include?(x.type) }.each do |token|
       fact_name = ''
 
-      # 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]
+      if (match = (token.value.match(%r{(::)?facts\['(.*)'\]}) || token.value.match(%r{(::)?facts\[(.*)\]})))
+        fact_name = match[2]
 
       # 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

@@ -17,7 +17,17 @@ TOP_SCOPE_FACTS_VAR_TYPES = Set[:VARIABLE, :UNENC_VARIABLE]
 
 PuppetLint.new_check(:top_scope_facts) do
   def check
-    whitelist = ['trusted', 'facts'] + (PuppetLint.configuration.top_scope_variables || [])
+    whitelist = ['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',
+                 'macaddress', 'macosx_buildversion', 'macosx_productname', 'macosx_productversion', 'macosx_productversion_major',
+                 'macosx_productversion_minor', 'manufacturer', 'memoryfree', 'memorysize', 'netmask', 'netmask6', 'network', 'network6',
+                 'operatingsystem', 'operatingsystemmajrelease', 'operatingsystemrelease', 'osfamily', 'physicalprocessorcount',
+                 'processorcount', 'productname', 'rubyplatform', 'rubysitedir', 'rubyversion', 'selinux', 'selinux_config_mode',
+                 '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('|')
     tokens.select { |x| TOP_SCOPE_FACTS_VAR_TYPES.include?(x.type) }.each do |token|
       next unless %r{^::}.match?(token.value)

data/lib/puppet-lint/version.rb

@@ -1,3 +1,3 @@
 class PuppetLint
-  VERSION = '4.0.0'.freeze
+  VERSION = '4.0.1'.freeze
 end

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

@@ -33,6 +33,6 @@
       }
     },
     "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."
+    "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#params-display-order) for more information about the `parameter_order` check."
   }
 ]

data/spec/unit/puppet-lint/plugins/check_classes/parameter_order_spec.rb

@@ -135,19 +135,6 @@ describe 'parameter_order' do
       it { expect(problems).to have(0).problem }
     end
 
-    context "#{type} parameter with Optional data type" do
-      let(:code) do
-        <<-END
-          #{type} test(
-            String $test = 'value',
-            Optional[String] $optional,
-          ) { }
-        END
-      end
-
-      it { expect(problems).to have(0).problems }
-    end
-
     context "#{type} parameter with array operation" do
       let(:code) do
         <<-END
@@ -165,5 +152,72 @@ describe 'parameter_order' do
 
       it { expect(problems).to have(0).problems }
     end
+
+    context "#{type} parameters of Optional type are just regular parameters" do
+      let(:code) do
+        <<-END
+          #{type} test (
+            String $param1 = '',
+            Optional[Boolean] $param2,
+          ) { }
+        END
+      end
+
+      it { expect(problems).to have(1).problems }
+    end
+
+    [['Custom::Type1', 'Custom::Type2'], ['Custom::Type1', 'String'], ['String', 'Custom::Type2']].each_with_index do |testtypes, i| # rubocop:disable Performance/CollectionLiteralInLoop
+      context "#{type} parameters of custom type - no values - #{i}" do
+        let(:code) do
+          <<-END
+            #{type} test (
+              #{testtypes[0]} $param1,
+              #{testtypes[0]} $param2,
+            ) { }
+          END
+        end
+
+        it { expect(problems).to have(0).problems }
+      end
+
+      context "#{type} parameters of custom type - two values - #{i}" do
+        let(:code) do
+          <<-END
+            #{type} test (
+              #{testtypes[0]} $param1 = 'foo',
+              #{testtypes[1]} $param2 = 'bar',
+            ) { }
+          END
+        end
+
+        it { expect(problems).to have(0).problems }
+      end
+
+      context "#{type} parameters of custom type - one value, wrong order - #{i}" do
+        let(:code) do
+          <<-END
+            #{type} test (
+              #{testtypes[0]} $param1 = 'foo',
+              #{testtypes[1]} $param2,
+            ) { }
+          END
+        end
+
+        it { expect(problems).to have(1).problems }
+      end
+
+      context "#{type} parameters of custom type - one value, right order - #{i}" do
+        let(:code) do
+          <<-END
+            #{type} test (
+              #{testtypes[0]} $param1,
+              #{testtypes[1]} $param2 = 'bar',
+            ) { }
+          END
+        end
+
+        it { expect(problems).to have(0).problems }
+      end
+    end
   end
 end

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

@@ -121,6 +121,14 @@ describe 'legacy_facts' do
         expect(problems).to have(1).problem
       end
     end
+
+    context 'top scoped fact variable using unquoted 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

data/spec/unit/puppet-lint/plugins/top_scope_facts/top_scope_facts_spec.rb

@@ -37,26 +37,10 @@ describe 'top_scope_facts' do
     end
 
     context 'fact variable using top scope' do
-      let(:code) { '$::operatingsystem' }
+      let(:code) { '$::fqdn' }
 
-      it 'onlies detect a single problem' do
-        expect(problems).to have(1).problem
-      end
-
-      it 'creates a warning' do
-        expect(problems).to contain_warning(msg).on_line(1).in_column(1)
-      end
-    end
-
-    context 'fact variable using top scope with curly braces in double quote' do
-      let(:code) { '"${::operatingsystem}"' }
-
-      it 'onlies detect a single problem' do
-        expect(problems).to have(1).problem
-      end
-
-      it 'creates a warning' do
-        expect(problems).to contain_warning(msg).on_line(1).in_column(4)
+      it 'does not detect a single problem' do
+        expect(problems).to have(0).problem
       end
     end
 
@@ -126,34 +110,6 @@ describe 'top_scope_facts' do
       end
     end
 
-    context 'fact variable using top scope' do
-      let(:code) { '$::operatingsystem' }
-
-      it 'onlies detect 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 'shoulds use the facts hash' do
-        expect(manifest).to eq("$facts['operatingsystem']")
-      end
-    end
-
-    context 'fact variable using top scope with curly braces in double quote' do
-      let(:code) { '"${::operatingsystem}"' }
-
-      it 'fixes the problem' do
-        expect(problems).to contain_fixed(msg).on_line(1).in_column(4)
-      end
-
-      it 'shoulds use the facts hash' do
-        expect(manifest).to eq('"${facts[\'operatingsystem\']}"')
-      end
-    end
-
     context 'with custom top scope fact variables' do
       before(:each) do
         PuppetLint.configuration.top_scope_variables = ['location', 'role']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Tim Sharpe
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-21 00:00:00.000000000 Z
+date: 2023-07-31 00:00:00.000000000 Z
 dependencies: []
 description: "    Checks your Puppet manifests against the Puppetlabs style guide
   and alerts you to any discrepancies.\n"