puppet-lint 3.4.0 → 4.0.0.rc.1

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

@@ -6,111 +6,111 @@
 #
 # This plugin was adopted in to puppet-lint from https://github.com/mmckinst/puppet-lint-legacy_facts-check
 # Thanks to @mmckinst, @seanmil, @rodjek, @baurmatt, @bart2 and @joshcooper for the original work.
-PuppetLint.new_check(:legacy_facts) do
-  LEGACY_FACTS_VAR_TYPES = Set[:VARIABLE, :UNENC_VARIABLE]
-
-  # These facts that can't be converted to new facts.
-  UNCONVERTIBLE_FACTS = ['memoryfree_mb', 'memorysize_mb', 'swapfree_mb',
-                         'swapsize_mb', 'blockdevices', 'interfaces', 'zones',
-                         'sshfp_dsa', 'sshfp_ecdsa', 'sshfp_ed25519',
-                         'sshfp_rsa'].freeze
-
-  # 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 server 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 = [%r{^blockdevice_(?<devicename>.*)_(?<attribute>model|size|vendor)$},
-                 %r{^(?<attribute>ipaddress|ipaddress6|macaddress|mtu|netmask|netmask6|network|network6)_(?<interface>.*)$},
-                 %r{^processor(?<id>[0-9]+)$},
-                 %r{^sp_(?<name>.*)$},
-                 %r{^ssh(?<algorithm>dsa|ecdsa|ed25519|rsa)key$},
-                 %r{^ldom_(?<name>.*)$},
-                 %r{^zone_(?<name>.*)_(?<attribute>brand|iptype|name|uuid|id|path|status)$}].freeze
-
-  # 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']",
-    'bios_release_date'           => "facts['dmi']['bios']['release_date']",
-    'bios_vendor'                 => "facts['dmi']['bios']['vendor']",
-    'bios_version'                => "facts['dmi']['bios']['version']",
-    'boardassettag'               => "facts['dmi']['board']['asset_tag']",
-    'boardmanufacturer'           => "facts['dmi']['board']['manufacturer']",
-    'boardproductname'            => "facts['dmi']['board']['product']",
-    'boardserialnumber'           => "facts['dmi']['board']['serial_number']",
-    'chassisassettag'             => "facts['dmi']['chassis']['asset_tag']",
-    'chassistype'                 => "facts['dmi']['chassis']['type']",
-    'domain'                      => "facts['networking']['domain']",
-    'fqdn'                        => "facts['networking']['fqdn']",
-    'gid'                         => "facts['identity']['group']",
-    'hardwareisa'                 => "facts['processors']['isa']",
-    'hardwaremodel'               => "facts['os']['hardware']",
-    'hostname'                    => "facts['networking']['hostname']",
-    'id'                          => "facts['identity']['user']",
-    'ipaddress'                   => "facts['networking']['ip']",
-    'ipaddress6'                  => "facts['networking']['ip6']",
-    'lsbdistcodename'             => "facts['os']['distro']['codename']",
-    'lsbdistdescription'          => "facts['os']['distro']['description']",
-    'lsbdistid'                   => "facts['os']['distro']['id']",
-    'lsbdistrelease'              => "facts['os']['distro']['release']['full']",
-    'lsbmajdistrelease'           => "facts['os']['distro']['release']['major']",
-    'lsbminordistrelease'         => "facts['os']['distro']['release']['minor']",
-    'lsbrelease'                  => "facts['os']['distro']['release']['specification']",
-    'macaddress'                  => "facts['networking']['mac']",
-    'macosx_buildversion'         => "facts['os']['macosx']['build']",
-    'macosx_productname'          => "facts['os']['macosx']['product']",
-    'macosx_productversion'       => "facts['os']['macosx']['version']['full']",
-    'macosx_productversion_major' => "facts['os']['macosx']['version']['major']",
-    'macosx_productversion_minor' => "facts['os']['macosx']['version']['minor']",
-    'manufacturer'                => "facts['dmi']['manufacturer']",
-    'memoryfree'                  => "facts['memory']['system']['available']",
-    'memorysize'                  => "facts['memory']['system']['total']",
-    'netmask'                     => "facts['networking']['netmask']",
-    'netmask6'                    => "facts['networking']['netmask6']",
-    'network'                     => "facts['networking']['network']",
-    'network6'                    => "facts['networking']['network6']",
-    'operatingsystem'             => "facts['os']['name']",
-    'operatingsystemmajrelease'   => "facts['os']['release']['major']",
-    'operatingsystemrelease'      => "facts['os']['release']['full']",
-    'osfamily'                    => "facts['os']['family']",
-    'physicalprocessorcount'      => "facts['processors']['physicalcount']",
-    'processorcount'              => "facts['processors']['count']",
-    'productname'                 => "facts['dmi']['product']['name']",
-    'rubyplatform'                => "facts['ruby']['platform']",
-    'rubysitedir'                 => "facts['ruby']['sitedir']",
-    'rubyversion'                 => "facts['ruby']['version']",
-    'selinux'                     => "facts['os']['selinux']['enabled']",
-    'selinux_config_mode'         => "facts['os']['selinux']['config_mode']",
-    'selinux_config_policy'       => "facts['os']['selinux']['config_policy']",
-    'selinux_current_mode'        => "facts['os']['selinux']['current_mode']",
-    'selinux_enforced'            => "facts['os']['selinux']['enforced']",
-    'selinux_policyversion'       => "facts['os']['selinux']['policy_version']",
-    'serialnumber'                => "facts['dmi']['product']['serial_number']",
-    'swapencrypted'               => "facts['memory']['swap']['encrypted']",
-    'swapfree'                    => "facts['memory']['swap']['available']",
-    'swapsize'                    => "facts['memory']['swap']['total']",
-    'system32'                    => "facts['os']['windows']['system32']",
-    'uptime'                      => "facts['system_uptime']['uptime']",
-    'uptime_days'                 => "facts['system_uptime']['days']",
-    'uptime_hours'                => "facts['system_uptime']['hours']",
-    'uptime_seconds'              => "facts['system_uptime']['seconds']",
-    'uuid'                        => "facts['dmi']['product']['uuid']",
-    'xendomains'                  => "facts['xen']['domains']",
-    'zonename'                    => "facts['solaris_zones']['current']",
-  }.freeze
-
-  # 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
+LEGACY_FACTS_VAR_TYPES = Set[:VARIABLE, :UNENC_VARIABLE]
+
+# These facts that can't be converted to new facts.
+UNCONVERTIBLE_FACTS = ['memoryfree_mb', 'memorysize_mb', 'swapfree_mb',
+                       'swapsize_mb', 'blockdevices', 'interfaces', 'zones',
+                       'sshfp_dsa', 'sshfp_ecdsa', 'sshfp_ed25519',
+                       'sshfp_rsa'].freeze
+
+# 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 server 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 = [%r{^blockdevice_(?<devicename>.*)_(?<attribute>model|size|vendor)$},
+               %r{^(?<attribute>ipaddress|ipaddress6|macaddress|mtu|netmask|netmask6|network|network6)_(?<interface>.*)$},
+               %r{^processor(?<id>[0-9]+)$},
+               %r{^sp_(?<name>.*)$},
+               %r{^ssh(?<algorithm>dsa|ecdsa|ed25519|rsa)key$},
+               %r{^ldom_(?<name>.*)$},
+               %r{^zone_(?<name>.*)_(?<attribute>brand|iptype|name|uuid|id|path|status)$}].freeze
+
+# 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']",
+  'bios_release_date' => "facts['dmi']['bios']['release_date']",
+  'bios_vendor' => "facts['dmi']['bios']['vendor']",
+  'bios_version' => "facts['dmi']['bios']['version']",
+  'boardassettag' => "facts['dmi']['board']['asset_tag']",
+  'boardmanufacturer' => "facts['dmi']['board']['manufacturer']",
+  'boardproductname' => "facts['dmi']['board']['product']",
+  'boardserialnumber' => "facts['dmi']['board']['serial_number']",
+  'chassisassettag' => "facts['dmi']['chassis']['asset_tag']",
+  'chassistype' => "facts['dmi']['chassis']['type']",
+  'domain' => "facts['networking']['domain']",
+  'fqdn' => "facts['networking']['fqdn']",
+  'gid' => "facts['identity']['group']",
+  'hardwareisa' => "facts['processors']['isa']",
+  'hardwaremodel' => "facts['os']['hardware']",
+  'hostname' => "facts['networking']['hostname']",
+  'id' => "facts['identity']['user']",
+  'ipaddress' => "facts['networking']['ip']",
+  'ipaddress6' => "facts['networking']['ip6']",
+  'lsbdistcodename' => "facts['os']['distro']['codename']",
+  'lsbdistdescription' => "facts['os']['distro']['description']",
+  'lsbdistid' => "facts['os']['distro']['id']",
+  'lsbdistrelease' => "facts['os']['distro']['release']['full']",
+  'lsbmajdistrelease' => "facts['os']['distro']['release']['major']",
+  'lsbminordistrelease' => "facts['os']['distro']['release']['minor']",
+  'lsbrelease' => "facts['os']['distro']['release']['specification']",
+  'macaddress' => "facts['networking']['mac']",
+  'macosx_buildversion' => "facts['os']['macosx']['build']",
+  'macosx_productname' => "facts['os']['macosx']['product']",
+  'macosx_productversion' => "facts['os']['macosx']['version']['full']",
+  'macosx_productversion_major' => "facts['os']['macosx']['version']['major']",
+  'macosx_productversion_minor' => "facts['os']['macosx']['version']['minor']",
+  'manufacturer' => "facts['dmi']['manufacturer']",
+  'memoryfree' => "facts['memory']['system']['available']",
+  'memorysize' => "facts['memory']['system']['total']",
+  'netmask' => "facts['networking']['netmask']",
+  'netmask6' => "facts['networking']['netmask6']",
+  'network' => "facts['networking']['network']",
+  'network6' => "facts['networking']['network6']",
+  'operatingsystem' => "facts['os']['name']",
+  'operatingsystemmajrelease' => "facts['os']['release']['major']",
+  'operatingsystemrelease' => "facts['os']['release']['full']",
+  'osfamily' => "facts['os']['family']",
+  'physicalprocessorcount' => "facts['processors']['physicalcount']",
+  'processorcount' => "facts['processors']['count']",
+  'productname' => "facts['dmi']['product']['name']",
+  'rubyplatform' => "facts['ruby']['platform']",
+  'rubysitedir' => "facts['ruby']['sitedir']",
+  'rubyversion' => "facts['ruby']['version']",
+  'selinux' => "facts['os']['selinux']['enabled']",
+  'selinux_config_mode' => "facts['os']['selinux']['config_mode']",
+  'selinux_config_policy' => "facts['os']['selinux']['config_policy']",
+  'selinux_current_mode' => "facts['os']['selinux']['current_mode']",
+  'selinux_enforced' => "facts['os']['selinux']['enforced']",
+  'selinux_policyversion' => "facts['os']['selinux']['policy_version']",
+  'serialnumber' => "facts['dmi']['product']['serial_number']",
+  'swapencrypted' => "facts['memory']['swap']['encrypted']",
+  'swapfree' => "facts['memory']['swap']['available']",
+  'swapsize' => "facts['memory']['swap']['total']",
+  'system32' => "facts['os']['windows']['system32']",
+  'uptime' => "facts['system_uptime']['uptime']",
+  'uptime_days' => "facts['system_uptime']['days']",
+  'uptime_hours' => "facts['system_uptime']['hours']",
+  'uptime_seconds' => "facts['system_uptime']['seconds']",
+  'uuid' => "facts['dmi']['product']['uuid']",
+  'xendomains' => "facts['xen']['domains']",
+  'zonename' => "facts['solaris_zones']['current']"
+}.freeze
+
+# 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
 
+PuppetLint.new_check(:legacy_facts) do
   def check
     tokens.select { |x| LEGACY_FACTS_VAR_TYPES.include?(x.type) }.each do |token|
       fact_name = ''
@@ -137,12 +137,13 @@ PuppetLint.new_check(:legacy_facts) do
       end
 
       next unless EASY_FACTS.include?(fact_name) || UNCONVERTIBLE_FACTS.include?(fact_name) || fact_name.match(Regexp.union(REGEX_FACTS))
+
       notify :warning, {
         message: "legacy fact '#{fact_name}'",
         line: token.line,
         column: token.column,
         token: token,
-        fact_name: fact_name,
+        fact_name: fact_name
       }
     end
   end

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

@@ -13,8 +13,9 @@
 #
 # This plugin was adopted in to puppet-lint from https://github.com/mmckinst/puppet-lint-top_scope_facts-check
 # Thanks to @mmckinst, @seanmil and @alexjfisher for the original work.
+TOP_SCOPE_FACTS_VAR_TYPES = Set[:VARIABLE, :UNENC_VARIABLE]
+
 PuppetLint.new_check(:top_scope_facts) do
-  TOP_SCOPE_FACTS_VAR_TYPES = Set[:VARIABLE, :UNENC_VARIABLE]
   def check
     whitelist = ['trusted', 'facts'] + (PuppetLint.configuration.top_scope_variables || [])
     whitelist = whitelist.join('|')
@@ -27,7 +28,7 @@ PuppetLint.new_check(:top_scope_facts) do
         message: 'top scope fact instead of facts hash',
         line: token.line,
         column: token.column,
-        token: token,
+        token: token
       }
     end
   end

data/lib/puppet-lint/plugins.rb

@@ -55,9 +55,8 @@ class PuppetLint::Plugins
     def load_prerelease_plugins?
       # Load prerelease plugins (which ruby defines as any gem which has a letter in its version number).
       # Can't use puppet-lint configuration object here because this code executes before the command line is parsed.
-      if ENV['PUPPET_LINT_LOAD_PRERELEASE_PLUGINS']
-        return ['true', 'yes'].include?(ENV['PUPPET_LINT_LOAD_PRERELEASE_PLUGINS'].downcase)
-      end
+      return ['true', 'yes'].include?(ENV['PUPPET_LINT_LOAD_PRERELEASE_PLUGINS'].downcase) if ENV['PUPPET_LINT_LOAD_PRERELEASE_PLUGINS']
+
       false
     end
 
@@ -76,7 +75,7 @@ class PuppetLint::Plugins
   end
 end
 
-Dir[File.expand_path('plugins/**/*.rb', File.dirname(__FILE__))].each do |file|
+Dir[File.expand_path('plugins/**/*.rb', File.dirname(__FILE__))].sort.each do |file|
   require file
 end
 

data/lib/puppet-lint/report/codeclimate.rb

@@ -3,6 +3,7 @@
 require 'digest'
 require 'json'
 
+# rubocop:disable Style/ClassAndModuleChildren
 class PuppetLint::Report
   # Formats problems and writes them to a file as a code climate compatible report.
   class CodeClimateReporter
@@ -29,9 +30,9 @@ class PuppetLint::Report
               path: message[:path],
               lines: {
                 begin: message[:line],
-                end: message[:line],
+                end: message[:line]
               }
-            },
+            }
           }
 
           issue[:fingerprint] = Digest::MD5.hexdigest(Marshal.dump(issue))

data/lib/puppet-lint/report/github.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# rubocop:disable Style/ClassAndModuleChildren
 class PuppetLint::Report
   # This formatter formats report data as GitHub Workflow commands resulting
   # in GitHub check annotations when run within GitHub Actions.

data/lib/puppet-lint/tasks/puppet-lint.rb

@@ -12,24 +12,12 @@ require 'puppet-lint/report/codeclimate'
 #
 #   require 'puppet-lint'
 #   PuppetLint::RakeTask.new
-class PuppetLint::RakeTask < ::Rake::TaskLib
+class PuppetLint::RakeTask < Rake::TaskLib
   include ::Rake::DSL if defined?(::Rake::DSL)
 
   DEFAULT_PATTERN = '**/*.pp'.freeze
 
-  attr_accessor :name
-  attr_accessor :pattern
-  attr_accessor :ignore_paths
-  attr_accessor :with_filename
-  attr_accessor :disable_checks
-  attr_accessor :only_checks
-  attr_accessor :fail_on_warnings
-  attr_accessor :error_level
-  attr_accessor :log_format
-  attr_accessor :with_context
-  attr_accessor :fix
-  attr_accessor :show_ignored
-  attr_accessor :relative
+  attr_accessor :name, :pattern, :ignore_paths, :with_filename, :disable_checks, :only_checks, :fail_on_warnings, :error_level, :log_format, :with_context, :fix, :show_ignored, :relative
 
   # Public: Initialise a new PuppetLint::RakeTask.
   #
@@ -80,13 +68,9 @@ class PuppetLint::RakeTask < ::Rake::TaskLib
         PuppetLint.configuration.send("#{config}=".to_sym, value) unless value.nil?
       end
 
-      if PuppetLint.configuration.ignore_paths && @ignore_paths.empty?
-        @ignore_paths = PuppetLint.configuration.ignore_paths
-      end
+      @ignore_paths = PuppetLint.configuration.ignore_paths if PuppetLint.configuration.ignore_paths && @ignore_paths.empty?
 
-      if PuppetLint.configuration.pattern
-        @pattern = PuppetLint.configuration.pattern
-      end
+      @pattern = PuppetLint.configuration.pattern if PuppetLint.configuration.pattern
 
       RakeFileUtils.send(:verbose, true) do
         linter = PuppetLint.new
@@ -97,18 +81,15 @@ class PuppetLint::RakeTask < ::Rake::TaskLib
 
         matched_files.to_a.each do |puppet_file|
           next unless File.file?(puppet_file)
+
           linter.file = puppet_file
           linter.run
           all_problems << linter.print_problems
 
-          if PuppetLint.configuration.fix && linter.problems.none? { |e| e[:check] == :syntax }
-            IO.write(puppet_file, linter.manifest)
-          end
+          File.write(puppet_file, linter.manifest) if PuppetLint.configuration.fix && linter.problems.none? { |e| e[:check] == :syntax }
         end
 
-        if PuppetLint.configuration.codeclimate_report_file
-          PuppetLint::Report::CodeClimateReporter.write_report_file(all_problems, PuppetLint.configuration.codeclimate_report_file)
-        end
+        PuppetLint::Report::CodeClimateReporter.write_report_file(all_problems, PuppetLint.configuration.codeclimate_report_file) if PuppetLint.configuration.codeclimate_report_file
 
         abort if linter.errors? || (
           linter.warnings? && PuppetLint.configuration.fail_on_warnings

data/lib/puppet-lint/tasks/release_test.rb

@@ -27,7 +27,7 @@ def run_cmd(message, *cmd)
   [output.strip, status.success?]
 end
 
-def with_puppet_lint_head
+def with_puppet_lint_head(&block)
   print('  Updating Gemfile to use puppet-lint HEAD... ')
 
   buffer = Parser::Source::Buffer.new('Gemfile')
@@ -49,7 +49,7 @@ def with_puppet_lint_head
 
   puts 'Done'
 
-  Bundler.with_clean_env { yield }
+  Bundler.with_clean_env(&block)
 
   run_cmd('Restoring Gemfile', 'git', 'checkout', '--', 'Gemfile')
 end
@@ -58,9 +58,9 @@ task :release_test do
   branch = if ENV['GITHUB_REF']
              ENV['GITHUB_REF']
            elsif ENV['APPVEYOR']
-             ENV['APPVEYOR_PULL_REQUEST_HEAD_REPO_BRANCH']
+             ENV.fetch('APPVEYOR_PULL_REQUEST_HEAD_REPO_BRANCH', nil)
            elsif ENV['TRAVIS']
-             ENV['TRAVIS_PULL_REQUEST_BRANCH']
+             ENV.fetch('TRAVIS_PULL_REQUEST_BRANCH', nil)
            else
              false
            end

data/lib/puppet-lint/version.rb

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

data/lib/puppet-lint.rb

@@ -95,7 +95,7 @@ class PuppetLint
 
     # Check if the input is an SE Linux policy package file (which also use
     # the .pp extension), which all have the first 4 bytes 0xf97cff8f.
-    @code = '' if @code[0..3].unpack('V').first == 0xf97cff8f
+    @code = '' if @code[0..3].unpack1('V') == 0xf97cff8f
   end
 
   # Internal: Retrieve the format string to be used when writing problems to
@@ -155,8 +155,10 @@ class PuppetLint
   def print_context(message)
     return if message[:check] == 'documentation'
     return if message[:kind] == :fixed
+
     line = message[:context]
     return unless line
+
     offset = line.index(%r{\S}) || 1
     puts "\n  #{line.strip}"
     printf("%#{message[:column] + 2 - offset}s\n\n", '^')
@@ -188,7 +190,7 @@ class PuppetLint
         print_github_annotation(message) if configuration.github_actions
       end
     end
-    $stderr.puts 'Try running `puppet parser validate <file>`' if problems.any? { |p| p[:check] == :syntax }
+    warn 'Try running `puppet parser validate <file>`' if problems.any? { |p| p[:check] == :syntax }
     json
   end
 
@@ -251,7 +253,7 @@ class PuppetLint
   def self.new_check(name, &block)
     class_name = name.to_s.split('_').map(&:capitalize).join
     klass = PuppetLint.const_set("Check#{class_name}", Class.new(PuppetLint::CheckPlugin))
-    klass.const_set('NAME', name)
+    klass.const_set(:NAME, name)
     klass.class_exec(&block)
     PuppetLint.configuration.add_check(name, klass)
     PuppetLint::Data.ignore_overrides[name] ||= {}