puppet-lint-legacy_facts-check 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90c39fb6507da85f5d4bcd1d17587a2bdfb210fe0519c614cc2832bd04d5fda4
-  data.tar.gz: 6312725c235f5e05212b5897b47a327557e40d6a674317dacda10c4fdd7c094a
+  metadata.gz: 9a7f2391ddc2702af498700ea0b6d0b8ba497c4a2e4ec5fe1c4435ccbf8bace9
+  data.tar.gz: f8d7e0285d707ff2573c5ab3c192d2ef0091471a00c889a0fa767acd22e4299a
 SHA512:
-  metadata.gz: fb8cecf281e0eb2d27fe46b29de3812c4ad89ef36498cb416ef3c536cd6acaeb4e8d8a7974c3d49e26264d7c610b1d61e735bc848b507251f039780926f94b6a
-  data.tar.gz: 8797b37fef673e69b04d139f2e2fb93d53d80706b60591e41e114091bd41adfc6b8b74989c8c9b05fffe1bcdf87b2ad6b6b3e542ada20f053ed513d6fd6d1427
+  metadata.gz: 20e2f8fe27fb5040a4de485946553c0c40571a3852f0f7b47ca88c7ee0e336a1c1aecf60b13abec13d79cf69d235e21168c0d85f3516a4aee6efa82f77ebd8e7
+  data.tar.gz: e52f2ab36c8181c51abc12adba813e364a13798291226b3c1750d6e4ca2dbd1388848feab44c8d9e96a5ded608b43fe472b43760f8a8f853e5caf5f914e50bfd

data/README.md

@@ -66,6 +66,11 @@ PuppetLint.configuration.send('disable_legacy_facts')
 
 ## Limitations
 
+The linter will only find and work on top scope facts like `$::osfamily`,
+non-top scope facts like `$osfamily` will not be found or fixed. The
+[top_scope_facts-check ](https://github.com/mmckinst/puppet-lint-top_scope_facts-check)
+puppet linter can be used to fix that problem
+
 Some facts have no equivalent in the structured fact list:
 
 ### `memoryfree_mb`
@@ -76,7 +81,7 @@ The closest equivalent is `$facts['memory']['system'][available']` or
 `$facts['memory']['system']['available_bytes']`.
 
 See
-[facter documentation on memory](https://docs.puppet.com/facter/3.4/core_facts.html#memory).
+[facter documentation on memory](https://puppet.com/docs/facter/3.12/core_facts.html#memory).
 
 ### `memorysize_mb`
 
@@ -85,7 +90,7 @@ There is no fact that returns exclusively in MiB.
 The closest equivalent is `$facts['memory']['system']['total']` or
 `$facts['memory']['system']['total_bytes']`.
 
-See [facter documentation on memory](https://docs.puppet.com/facter/3.4/core_facts.html#memory).
+See [facter documentation on memory](https://puppet.com/docs/facter/3.12/core_facts.html#memory).
 
 ### `swapfree_mb`
 
@@ -94,7 +99,7 @@ There is no fact that returns exclusively in MiB.
 The closest equivalent is `$facts['memory']['swap']['available']` or
 `$facts['memory']['swap']['available_bytes']`.
 
-See [facter documentation on memory](https://docs.puppet.com/facter/3.4/core_facts.html#memory).
+See [facter documentation on memory](https://puppet.com/docs/facter/3.12/core_facts.html#memory).
 
 ### `swapsize_mb`
 
@@ -103,7 +108,7 @@ There is no fact that returns exclusively in MiB.
 The closest equivalent is `$facts['memory']['swap']['used']` or
 `$facts['memory']['swap']['used_bytes']`.
 
-See [facter documentation on memory](https://docs.puppet.com/facter/3.4/core_facts.html#memory).
+See [facter documentation on memory](https://puppet.com/docs/facter/3.12/core_facts.html#memory).
 
 ### `blockdevices`
 

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

@@ -1,9 +1,20 @@
 PuppetLint.new_check(:legacy_facts) do
+
+  # These facts that can't be converted to new facts for reasons documented at
+  # https://github.com/mmckinst/puppet-lint-legacy_facts-check#limitations
   UNCONVERTIBLE_FACTS = ['memoryfree_mb', 'memorysize_mb', 'swapfree_mb',
                          'swapsize_mb', 'blockdevices', 'interfaces', 'zones',
                          'sshfp_dsa', 'sshfp_ecdsa', 'sshfp_ed25519',
                          'sshfp_rsa']
 
+  # These facts will depend on how a system is set up and can't just be
+  # enumerated like the EASY_FACTS below.
+  #
+  # For example a sever might have two block devices named 'sda' and 'sdb' so
+  # there would be a $blockdeivce_sda_vendor and $blockdeivce_sdb_vendor fact
+  # for each device. Or it could have 26 block devices going all the way up to
+  # 'sdz'. There is no way to know what the possibilities are so we have to use
+  # a regex to match them.
   REGEX_FACTS = [/^blockdevice_(?<devicename>.*)_(?<attribute>model|size|vendor)$/,
                  /^(?<attribute>ipaddress|ipaddress6|macaddress|mtu|netmask|netmask6|network|network6)_(?<interface>.*)$/,
                  /^processor(?<id>[0-9]+)$/,
@@ -12,6 +23,8 @@ PuppetLint.new_check(:legacy_facts) do
                  /^ldom_(?<name>.*)$/,
                  /^zone_(?<name>.*)_(?<attribute>brand|iptype|name|uuid|id|path|status)$/]
 
+  # These facts have a one to one correlation between a legacy fact and a new
+  # structured fact.
   EASY_FACTS = {
     'architecture'                => "facts['os']['architecture']",
     'augeasversion'               => "facts['augeas']['version']",
@@ -85,11 +98,19 @@ PuppetLint.new_check(:legacy_facts) do
   def check
     tokens.select { |x| x.type == :VARIABLE}.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?('::') then
         fact_name = token.value.sub(/^::/, '')
+
+      # 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
         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',
@@ -105,8 +126,14 @@ PuppetLint.new_check(:legacy_facts) do
     # 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
 
+    # 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(/^::/, '')
+
+    # 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]
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-legacy_facts-check
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Mark McKinstry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-28 00:00:00.000000000 Z
+date: 2019-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint
@@ -141,8 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: A puppet-lint plugin to check you are not using legacy facts like $::operatingsystem