puppet-lint-legacy_facts-check 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 547155b0b69aa2fe3a40ac14b997b483920dd7f5b0edd4eef7f9b8e7899d550c
-  data.tar.gz: 5eba4749445125868c94ee5b191d22f47da29cd0d5750988c356635860245768
+  metadata.gz: a85f4c87985f4b955287d5befdddc16d76cbbbb1c5918a48b513ec8644d4533a
+  data.tar.gz: 4d2e3991b90db73ed1be5e784d8a736c2a988122f652551e0f201455cf5a71ac
 SHA512:
-  metadata.gz: 936988827ee762d8e9206f0393be011e9dbd1162db5301f65fa06e8621b058f27f3850b313829be32da5a9f2ab4af3530829b84a1d53653d79597f67d3702c41
-  data.tar.gz: 054b6a7e1cc0ef472444a25090ce4f1c5a01d869aa24d1a51b62b216132a7f3657714cd5fb63e0b566a4afa9b6c75a41ed30624061397657a5df111207eca2ca
+  metadata.gz: 5f2eeb87cba88ea5082bbf104cb67b707ecdc6579cb710268f13ab13aa50880961301a80343d370e3f2bedd9da61f86a6b81ba4f4a6fb70eea88074a5c343aa5
+  data.tar.gz: 7b6f11c69c1d72f6713d983590387896b299f7f681206bf1bcaaac855c7f3152e61fdac7669da0d0c952cc308e6162a2e283d3e22fdc38c408a6834ef1e48a79

data/README.md

@@ -79,7 +79,7 @@ PuppetLint.configuration.send('disable_legacy_facts')
 Alternatively, you can disable it directly in your puppet manifest.
 
 ```puppet
-# lint:ignore:lint-legacy_facts
+# lint:ignore:legacy_facts
 $package_name = $facts['operatingsystem'] {
   'CentOS' => 'httpd',
   'Debian' => 'apache2',

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

@@ -96,6 +96,14 @@ PuppetLint.new_check(:legacy_facts) do
     'xendomains'                  => "facts['xen']['domains']",
     'zonename'                    => "facts['solaris_zones']['current']",
   }
+
+  # A list of valid hash key token types
+  HASH_KEY_TYPES = Set[
+    :STRING,  # Double quoted string
+    :SSTRING, # Single quoted string
+    :NAME,    # Unquoted single word
+  ].freeze
+
   def check
     tokens.select { |x| LEGACY_FACTS_VAR_TYPES.include?(x.type) }.each do |token|
       fact_name = ''
@@ -108,36 +116,50 @@ PuppetLint.new_check(:legacy_facts) do
       # 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
       # to facts['dmi']['product']['uuid']"
-      elsif token.value.start_with?("facts['") then
+      elsif token.value == 'facts' then
+        fact_name = hash_key_for(token)
+
+      elsif token.value.start_with?("facts['")
         fact_name = token.value.match(/facts\['(.*)'\]/)[1]
       end
 
       if EASY_FACTS.include?(fact_name) or UNCONVERTIBLE_FACTS.include?(fact_name) or fact_name.match(Regexp.union(REGEX_FACTS)) then
         notify :warning, {
-          :message => 'legacy fact',
-          :line    => token.line,
-          :column  => token.column,
-          :token   => token,
+          :message   => 'legacy fact',
+          :line      => token.line,
+          :column    => token.column,
+          :token     => token,
+          :fact_name => fact_name,
         }
       end
     end
   end
 
-  def fix(problem)
-    # This probably should never occur, but if it does then bail out:
-    raise PuppetLint::NoFix if problem[:token].raw and problem[:token].value != problem[:token].raw
+  # If the variable is using the $facts hash represented internally by multiple
+  # tokens, this helper simplifies accessing the hash key.
+  def hash_key_for(token)
+    lbrack_token = token.next_code_token
+    return '' unless lbrack_token && lbrack_token.type == :LBRACK
+
+    key_token = lbrack_token.next_code_token
+    return '' unless key_token && HASH_KEY_TYPES.include?(key_token.type)
 
-    # 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 problem[:token].value.start_with?('::') then
-      fact_name = problem[:token].value.sub(/^::/, '')
+    key_token.value
+  end
 
-    # 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
-    # to facts['dmi']['product']['uuid']"
-    elsif problem[:token].value.start_with?("facts['") then
-      fact_name = problem[:token].value.match(/facts\['(.*)'\]/)[1]
+  def fix(problem)
+    fact_name = problem[:fact_name]
+
+    # Check if the variable is using the $facts hash represented internally by
+    # multiple tokens and remove the tokens for the old legacy key if so.
+    if problem[:token].value == 'facts'
+      loop do
+        t = problem[:token].next_token
+        remove_token(t)
+        break if t.type == :RBRACK
+      end
     end
+
     if EASY_FACTS.include?(fact_name)
       problem[:token].value = EASY_FACTS[fact_name]
     elsif fact_name.match(Regexp.union(REGEX_FACTS))
@@ -157,7 +179,5 @@ PuppetLint.new_check(:legacy_facts) do
         problem[:token].value = "facts['solaris_zones']['zones']['" << m['name'] << "']['" << m['attribute'] << "']"
       end
     end
-
-    problem[:token].raw = problem[:token].value unless problem[:token].raw.nil?
   end
 end

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

@@ -106,6 +106,14 @@ describe 'legacy_facts' do
         expect(problems).to have(1).problem
       end
     end
+
+    context '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
 
 
@@ -391,5 +399,16 @@ describe 'legacy_facts' do
         expect(manifest).to eq("\"$facts['os']['distro']['release']['specification']\"")
       end
     end
+    context "fact variable using facts hash in double quotes \"$facts['lsbrelease']\"" do
+      let(:code) { "\"${facts['lsbrelease']}\"" }
+
+      it 'should only detect a single problem' do
+        expect(problems).to have(1).problem
+      end
+
+      it 'should use the facts hash' do
+        expect(manifest).to eq("\"${facts['os']['distro']['release']['specification']}\"")
+      end
+    end
   end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-legacy_facts-check
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Mark McKinstry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-27 00:00:00.000000000 Z
+date: 2020-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.6
+        version: '2.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.6
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement