puppet-lint-legacy_fact-check 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 04b65e777123a43554e8788a1b602c1529627f95e0237ab3dd5caae6700bebe4
+  data.tar.gz: 41a3fd9082bf4073d3e48e1e639975b35a9e85784585e0378ec410ae7176a78e
+SHA512:
+  metadata.gz: 464b08bbff526379fd81cae724f9e2e1b512d86ab72f50dbb3bdc050cff75cb63b73d7c06b218e06d0e8e0b2cc438cb48324be6c94296f32908ce89273b0b0f8
+  data.tar.gz: 8350c3fd77953ad91c02c7126300c98d4560335c5e180e5e61a5a645ea531a8d0d569efa0baee717c43f241342eef8c0b1ef0381f817faf28a835c9b2b360f8e

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

@@ -0,0 +1,155 @@
+PuppetLint.new_check(:legacy_fact) do
+  LEGACY_FACTS_STATIC = {
+    'architecture' => "facts['os']['architecture']",
+    'augeasversion' => "",
+    'blockdevices' => "",
+    'bios_release_date' => "",
+    'bios_vendor' => "",
+    'bios_version' => "",
+    'boardassettag' => "",
+    'boardmanufacturer' => "",
+    'boardproductname' => "",
+    'boardserialnumber' => "",
+    'chassisassettag' => "",
+    'chassistype' => "",
+    'dhcp_servers' => "",
+    'domain' => "facts['networking']['domain']",
+    'fqdn' => "facts['networking']['fqdn']",
+    'gid' => "",
+    'hardwareisa' => "facts['os']['hardware']",
+    'hardwaremodel' => "",
+    'hostname' => "",
+    'id' => "",
+    'interfaces' => "",
+    'ipaddress' => "",
+    'ipaddress6' => "",
+    'lsbdistcodename' => "",
+    'lsbdistdescription' => "",
+    'lsbdistid' => "",
+    'lsbdistrelease' => "",
+    'lsbmajdistrelease' => "",
+    'lsbminordistrelease' => "",
+    'lsbrelease' => "",
+    'macaddress' => "",
+    'macosx_buildversion' => "",
+    'macosx_productname' => "",
+    'macosx_productversion' => "",
+    'macosx_productversion_major' => "",
+    'macosx_productversion_minor' => "",
+    'manufacturer' => "",
+    'memoryfree' => "",
+    'memoryfree_mb' => "",
+    'memorysize' => "",
+    'memorysize_mb' => "",
+    'netmask' => "",
+    'netmask6' => "",
+    'network' => "",
+    'network6' => "",
+    'operatingsystem' => "facts['os']['release']",
+    'operatingsystemmajrelease' => "facts['os']['release']['major']",
+    'operatingsystemrelease' => "facts['os']['release']['full']",
+    'osfamily' => "facts['os']['family']",
+    'physicalprocessorcount' => "",
+    'processorcount' => "",
+    'productname' => "",
+    'rubyplatform' => "",
+    'rubysitedir' => "",
+    'rubyversion' => "",
+    'selinux' => "",
+    'selinux_config_mode' => "",
+    'selinux_config_policy' => "",
+    'selinux_current_mode' => "",
+    'selinux_enforced' => "",
+    'selinux_policyversion' => "",
+    'serialnumber' => "",
+    'swapencrypted' => "",
+    'swapfree' => "",
+    'swapfree_mb' => "",
+    'swapsize' => "",
+    'swapsize_mb' => "",
+    'system32' => "",
+    'uptime' => "",
+    'uptime_days' => "",
+    'uptime_hours' => "",
+    'uptime_seconds' => "",
+    'uuid' => "",
+    'xendomains' => "",
+    'zonename' => "",
+    'zones' => "",
+  }
+
+  LEGACY_FACTS_REGEX = {
+    /^blockdevice_(.+)_model$/ => "facts['disks']['%s']['model']",
+    /^blockdevice_(.+)_size$/ => "facts['disks']['%s']['size']",
+    /^blockdevice_(.+)_vendor$/ => "facts['disks']['%s']['vendor']",
+    /^ipaddress6_(.+)$/ => "facts['networking']['%s']['ip6']",
+    /^ipaddress_(.+)$/ => "facts['networking']['%s']['ip']",
+    /^ldom_(.+)$/ => "",
+    /^macaddress_(.+)$/ => "facts['networking']['%s']['mac']",
+    /^mtu_(.+)$/ => "facts['networking']['%s']['mtu']",
+    /^netmask6_(.+)$/ => "facts['networking']['%s']['netmask6']",
+    /^netmask_(.+)$/ => "facts['networking']['%s']['netmask']",
+    /^network6_(.+)$/ => "facts['networking']['%s']['network6']",
+    /^network_(.+)$/ => "facts['networking']['%s']['network']",
+    /^processor(.+)$/ => "facts['processors']['model'][%s]",
+    /^sp_(.+)$/ => "",
+    /^ssh(.+)key$/ => "facts['ssh']['%s']['key']",
+    /^sshfp_(.+)$/ => "", # TODO original is "facts['ssh']['%s']['sha256']" and sha1
+    /^zone_(.+)_brand$/ => "",
+    /^zone_(.+)_id$/ => "",
+    /^zone_(.+)_iptype$/ => "",
+    /^zone_(.+)_name$/ => "",
+    /^zone_(.+)_path$/ => "",
+    /^zone_(.+)_status$/ => "",
+    /^zone_(.+)_uuid$/ => "",
+  }
+
+  def check
+    tokens.select { |r|
+      Set[:VARIABLE, :UNENC_VARIABLE].include? r.type
+    }.each do |token|
+      if is_legacy_fact(normalize_fact(token.value))
+        notify :warning, {
+          :message => 'legacy fact used',
+          :line    => token.line,
+          :column  => token.column,
+          :token   => token,
+        }
+      end
+    end
+  end
+
+  def fix(problem)
+    replacement = replacement_fact(normalize_fact(problem[:token].value))
+    raise PuppetLint::NoFix if replacement.nil? || replacement.empty?
+    problem[:token].value = replacement
+  end
+
+  private
+
+  def normalize_fact(fact)
+    fact.gsub(/^(::)?(.+)$/, '\2').gsub(/^facts\[("|')(.+)\1\]/, '\2')
+  end
+
+  def find_static_fact(fact)
+    LEGACY_FACTS_STATIC[fact]
+  end
+
+  def find_regex_fact(fact)
+    LEGACY_FACTS_REGEX.each do |pattern, replacement|
+      if (md = pattern.match(fact))
+        return replacement % md.captures
+      end
+    end
+
+    nil
+  end
+
+  def is_legacy_fact(fact)
+    !find_static_fact(fact).nil? || !find_regex_fact(fact).nil?
+  end
+
+  def replacement_fact(fact)
+    find_static_fact(fact) || find_regex_fact(fact)
+  end
+end

data/spec/puppet-lint/plugins/legacy_fact/legacy_fact_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+describe 'legacy_fact' do
+  let(:msg) { 'legacy fact used' }
+
+  context 'with fix disabled' do
+    tests = [
+      ['top scoped', '$operatingsystem'],
+      ['absolute scoped', '$::operatingsystem'],
+      ['fact variable with single quotes', "$facts['operatingsystem']"],
+      ['fact variable with double quotes', '$facts["operatingsystem"]'],
+      ['regex-based variable', '$ipaddress_eth0'],
+      #['fact function with single quotes', "fact('operatingsystem')"],
+      #['fact function with double quotes', 'fact("operatingsystem")'],
+    ]
+    tests.each do |ctx, sample|
+      context "using #{ctx}: #{sample}" do
+        let(:code) { sample }
+
+        it 'should detect a single problem' do
+          expect(problems).to have(1).problem
+        end
+
+        it 'should create a warning' do
+          expect(problems).to contain_warning(msg).on_line(1).in_column(1)
+        end
+      end
+    end
+
+    context 'code using modern fact' do
+      let(:code) { "$facts['os']['name']" }
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+    end
+  end
+
+  context 'with fix enabled' do
+    before do
+      PuppetLint.configuration.fix = true
+    end
+
+    after do
+      PuppetLint.configuration.fix = false
+    end
+
+    tests = [
+      ['top scoped', '$operatingsystem', "$facts['os']['release']"],
+      ['absolute scoped', '$::operatingsystem', "$facts['os']['release']"],
+      ['fact variable with single quotes', "$facts['operatingsystem']", "$facts['os']['release']"],
+      ['fact variable with double quotes', '$facts["operatingsystem"]', "$facts['os']['release']"],
+      ['regex-based variable', '$ipaddress_eth0', "$facts['networking']['eth0']['ip']"],
+    ]
+    tests.each do |ctx, sample, replacement|
+      context "using #{ctx}: #{sample}" do
+        let(:code) { sample }
+
+        it 'should detect a single problem' do
+          expect(problems).to have(1).problem
+        end
+
+        it 'should fix the problem' do
+          expect(problems).to contain_fixed(msg).on_line(1).in_column(1)
+        end
+
+        it 'should add a newline to the end of the manifest' do
+          expect(manifest).to eq(replacement)
+        end
+      end
+    end
+
+    context 'code using legacy fact without replacement' do
+      let(:code) { "$macosx_buildversion" }
+
+      it 'should detect a single problem' do
+        expect(problems).to have(1).problem
+      end
+
+        it 'should not fix the problem' do
+          expect(problems).to contain_warning(msg).on_line(1).in_column(1)
+        end
+
+      it 'should not modify the manifest' do
+        expect(manifest).to eq(code)
+      end
+    end
+
+    context 'code using modern fact' do
+      let(:code) { "$facts['os']['name']" }
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+
+      it 'should not modify the manifest' do
+        expect(manifest).to eq(code)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'puppet-lint'
+
+PuppetLint::Plugins.load_spec_helper

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-legacy_fact-check
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ewoud Kohl van Wijngaarden
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-16 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.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "    A puppet-lint plugin to check that manifest files don't use legacy
+  facts.\n"
+email: ewoud+rubygems@kohlvanwijngaarden.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/puppet-lint/plugins/legacy_fact.rb
+- spec/puppet-lint/plugins/legacy_fact/legacy_fact_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ekohl/puppet-lint-legacy_fact-check
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A puppet-lint plugin to check for legacy facts.
+test_files:
+- spec/spec_helper.rb
+- spec/puppet-lint/plugins/legacy_fact/legacy_fact_spec.rb