rspec-puppet-facts 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d829fff0e8b5d1ca49d62e80553aeb95658f8b12fd774c92c9f92322a52bbe1
-  data.tar.gz: a00418119004c0fbad99a43362ff35f3e76ee118b2f460c922c3b4d6d51fce49
+  metadata.gz: 26b5f9acb794f67889cc8d24cb1bc35b73e0c20d1e855f88ac8d65cf1ca8cbbf
+  data.tar.gz: 920bd51e0f0def41e2f7ea8a38aa26b7247d8e311b3cda87b08eaa592fdecda1
 SHA512:
-  metadata.gz: 2467fd5253ad8096ac306a162580b4bff64cee7ff0193a67b769ef2d272346781e12b9c07ed69dd33ace30b00dd51f6668bb99c2493d5976be4fbc896f86b9cd
-  data.tar.gz: '092e3f2d3b573d26caf21c953fc8dbc92e5a77599a34b61da190669514f6875a01df1289e6daeec43760c7a591f2491fef5c6decf708bccee4f6ad67a881793d'
+  metadata.gz: 7290dffe6d55a28fa8fc721c03c394b2715a6fa282a8af544ab5ab7fa6428976592b8cd0e853f88bce10f70bfcd403fb49b77b0ba74ddb37823bdd5b19bdcc03
+  data.tar.gz: 5d23c2f0ae77ecc1a562e0e3aa079ff0c097f48c495d4c39cc17e486f4bbb3d6974a6a3f458d5b05df294c461e209df718ea342b270b9cae6a4d298a9db9e6f4

data/.rubocop.yml

@@ -4,10 +4,10 @@ inherit_from: .rubocop_todo.yml
 inherit_gem:
   voxpupuli-rubocop: rubocop.yml
 
-Style:
+Layout/LineLength:
   Enabled: false
 
-Layout:
+Style/IfUnlessModifier:
   Enabled: false
 
 # To match the gem name

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2023-07-06 14:12:32 UTC using RuboCop version 1.50.2.
+# on 2024-06-09 17:48:43 UTC using RuboCop version 1.63.5.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -12,7 +12,7 @@ Performance/MapCompact:
   Exclude:
     - 'lib/rspec-puppet-facts.rb'
 
-# Offense count: 32
+# Offense count: 29
 # Configuration parameters: Prefixes, AllowedPatterns.
 # Prefixes: when, with, without
 RSpec/ContextWording:
@@ -29,7 +29,7 @@ RSpec/ExpectInHook:
   Exclude:
     - 'spec/rspec_puppet_facts_spec.rb'
 
-# Offense count: 20
+# Offense count: 8
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: single_line_only, single_statement_only, disallow, require_implicit
@@ -52,14 +52,14 @@ RSpec/MessageSpies:
 RSpec/MultipleExpectations:
   Max: 2
 
-# Offense count: 46
+# Offense count: 40
 # Configuration parameters: EnforcedStyle, IgnoreSharedExamples.
 # SupportedStyles: always, named_only
 RSpec/NamedSubject:
   Exclude:
     - 'spec/rspec_puppet_facts_spec.rb'
 
-# Offense count: 14
+# Offense count: 13
 # Configuration parameters: AllowedGroups.
 RSpec/NestedGroups:
   Max: 6
@@ -74,3 +74,60 @@ RSpec/StubbedMock:
 Rake/Desc:
   Exclude:
     - 'Rakefile'
+
+# Offense count: 6
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - 'Gemfile'
+    - 'Rakefile'
+    - 'lib/rspec-puppet-facts.rb'
+    - 'lib/rspec-puppet-facts/version.rb'
+    - 'spec/rspec_puppet_facts_spec.rb'
+    - 'spec/spec_helper.rb'
+
+# Offense count: 1
+Style/MixinUsage:
+  Exclude:
+    - 'spec/spec_helper.rb'
+
+# Offense count: 3
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: literals, strict
+Style/MutableConstant:
+  Exclude:
+    - 'lib/rspec-puppet-facts.rb'
+    - 'lib/rspec-puppet-facts/version.rb'
+    - 'spec/rspec_puppet_facts_spec.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: Methods.
+Style/RedundantArgument:
+  Exclude:
+    - 'lib/rspec-puppet-facts.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/RedundantSort:
+  Exclude:
+    - 'lib/rspec-puppet-facts.rb'
+
+# Offense count: 2
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: ConvertCodeThatCanStartToReturnNil, AllowedMethods, MaxChainLength.
+# AllowedMethods: present?, blank?, presence, try, try!
+Style/SafeNavigation:
+  Exclude:
+    - 'lib/rspec-puppet-facts.rb'
+
+# Offense count: 2
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: RequireEnglish, EnforcedStyle.
+# SupportedStyles: use_perl_names, use_english_names, use_builtin_english_names
+Style/SpecialGlobalVars:
+  Exclude:
+    - 'lib/rspec-puppet-facts.rb'

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## [4.0.0](https://github.com/voxpupuli/rspec-puppet-facts/tree/4.0.0) (2024-06-10)
+
+[Full Changelog](https://github.com/voxpupuli/rspec-puppet-facts/compare/3.0.0...4.0.0)
+
+**Breaking changes:**
+
+- Rely on modern facts [\#178](https://github.com/voxpupuli/rspec-puppet-facts/pull/178) ([ekohl](https://github.com/ekohl))
+- Require FacterDB 2.x [\#176](https://github.com/voxpupuli/rspec-puppet-facts/pull/176) ([bastelfreak](https://github.com/bastelfreak))
+
+**Implemented enhancements:**
+
+- work with symbolized strings [\#175](https://github.com/voxpupuli/rspec-puppet-facts/pull/175) ([bastelfreak](https://github.com/bastelfreak))
+
+**Merged pull requests:**
+
+- rubocop: Fix Layout cops [\#182](https://github.com/voxpupuli/rspec-puppet-facts/pull/182) ([bastelfreak](https://github.com/bastelfreak))
+- Use max\_by to determine the maximum value [\#181](https://github.com/voxpupuli/rspec-puppet-facts/pull/181) ([ekohl](https://github.com/ekohl))
+- rubocop: Fix Style cops [\#180](https://github.com/voxpupuli/rspec-puppet-facts/pull/180) ([bastelfreak](https://github.com/bastelfreak))
+- Use more native rspec matchers in tests [\#179](https://github.com/voxpupuli/rspec-puppet-facts/pull/179) ([ekohl](https://github.com/ekohl))
+- Update voxpupuli-rubocop requirement from ~\> 2.6.0 to ~\> 2.7.0 [\#171](https://github.com/voxpupuli/rspec-puppet-facts/pull/171) ([dependabot[bot]](https://github.com/apps/dependabot))
+
 ## [3.0.0](https://github.com/voxpupuli/rspec-puppet-facts/tree/3.0.0) (2024-03-23)
 
 [Full Changelog](https://github.com/voxpupuli/rspec-puppet-facts/compare/2.0.5...3.0.0)

data/Gemfile

@@ -2,14 +2,14 @@ source ENV['GEM_SOURCE'] || 'https://rubygems.org'
 
 gemspec
 
-gem 'facter', ENV['FACTER_GEM_VERSION'], :require => false
+gem 'facter', ENV.fetch('FACTER_GEM_VERSION', nil), require: false
 
 group :release do
   gem 'faraday-retry', '~> 2.1', require: false
   gem 'github_changelog_generator', '~> 1.16.4', require: false
 end
 
-group :coverage, optional: ENV['COVERAGE']!='yes' do
-  gem 'codecov', :require => false
-  gem 'simplecov-console', :require => false
+group :coverage, optional: ENV['COVERAGE'] != 'yes' do
+  gem 'codecov', require: false
+  gem 'simplecov-console', require: false
 end

data/README.md

@@ -98,7 +98,7 @@ end
 
 ## Specifying a default Facter version
 
-By default, `os_supported_os` will return the facts for the version of Facter
+By default, `on_supported_os` will return the facts for the version of Facter
 that it has loaded (usually this is Facter 2.5.1). This behaviour can be
 overridden by setting the `default_facter_version` RSpec setting in your
 `spec/spec_helper.rb` file.

data/Rakefile

@@ -1,10 +1,10 @@
 PUPPET_VERSIONS_PATH = File.join(__dir__, 'ext', 'puppet_agent_components.json')
 
 begin
-    require 'rspec/core/rake_task'
-    require 'yard'
-    RSpec::Core::RakeTask.new(:spec)
-    YARD::Rake::YardocTask.new
+  require 'rspec/core/rake_task'
+  require 'yard'
+  RSpec::Core::RakeTask.new(:spec)
+  YARD::Rake::YardocTask.new
 rescue LoadError
   # yard is optional
 end
@@ -40,8 +40,8 @@ namespace :puppet_versions do
 
     output = `git status --porcelain #{PUPPET_VERSIONS_PATH}`
     unless output.strip.empty?
-      $stderr.puts "#{PUPPET_VERSIONS_PATH} is out of date."
-      $stderr.puts 'Run the puppet_versions:update task to update it and commit the changes.'
+      warn "#{PUPPET_VERSIONS_PATH} is out of date."
+      warn 'Run the puppet_versions:update task to update it and commit the changes.'
       raise
     end
   end
@@ -54,7 +54,7 @@ rescue LoadError
 else
   require 'rubygems'
   GitHubChangelogGenerator::RakeTask.new :changelog do |config|
-    config.exclude_labels = %w{duplicate question invalid wontfix wont-fix skip-changelog github_actions}
+    config.exclude_labels = %w[duplicate question invalid wontfix wont-fix skip-changelog github_actions]
     config.user = 'voxpupuli'
     config.project = 'rspec-puppet-facts'
     gem_version = Gem::Specification.load("#{config.project}.gemspec").version

data/lib/rspec-puppet-facts/version.rb

@@ -2,6 +2,6 @@ module RspecPuppetFacts
   # This module contains the current version constant
   module Version
     # The current version of this gem
-    STRING = '3.0.0'
+    STRING = '4.0.0'
   end
 end

data/lib/rspec-puppet-facts.rb

@@ -58,8 +58,7 @@ module RspecPuppetFacts
   # @api private
   def on_supported_os_implementation(opts = {})
     unless /\A\d+\.\d+(?:\.\d+)*\z/.match?((facterversion = opts[:facterversion]))
-      raise ArgumentError, ":facterversion must be in the format 'n.n' or " \
-        "'n.n.n' (n is numeric), not '#{facterversion}'"
+      raise ArgumentError, ":facterversion must be in the format 'n.n' or 'n.n.n' (n is numeric), not '#{facterversion}'"
     end
 
     filter = []
@@ -67,7 +66,6 @@ module RspecPuppetFacts
       if os_sup['operatingsystemrelease']
         Array(os_sup['operatingsystemrelease']).map do |operatingsystemmajrelease|
           opts[:hardwaremodels].each do |hardwaremodel|
-
             os_release_filter = "/^#{Regexp.escape(operatingsystemmajrelease.split(' ')[0])}/"
             case os_sup['operatingsystem']
             when /BSD/i
@@ -82,48 +80,46 @@ module RspecPuppetFacts
                                     "/^#{operatingsystemmajrelease}-/"
                                   end
             when /Windows/i
-              hardwaremodel = /^[12]\./.match?(facterversion) ? 'x64' : 'x86_64'
+              hardwaremodel = 'x86_64'
               os_sup['operatingsystem'] = os_sup['operatingsystem'].downcase
               operatingsystemmajrelease = operatingsystemmajrelease[/\A(?:Server )?(.+)/i, 1]
 
               # force quoting because windows releases can contain spaces
               os_release_filter = "\"#{operatingsystemmajrelease}\""
-
-              if operatingsystemmajrelease == '2016' && Puppet::Util::Package.versioncmp(facterversion, '3.4') < 0
-                os_release_filter = '/^10\\.0\\./'
-              end
             when /Amazon/i
               # Tighten the regex for Amazon Linux 2 so that we don't pick up Amazon Linux 2016 or 2017 facts
-              os_release_filter = "/^2$/" if operatingsystemmajrelease == '2'
+              os_release_filter = '/^2$/' if operatingsystemmajrelease == '2'
             end
 
             filter << {
-                :operatingsystem        => os_sup['operatingsystem'],
-                :operatingsystemrelease => os_release_filter,
-                :hardwaremodel          => hardwaremodel,
+              'os.name' => os_sup['operatingsystem'],
+              'os.release.full' => os_release_filter,
+              'os.hardware' => hardwaremodel,
             }
           end
         end
       else
         opts[:hardwaremodels].each do |hardwaremodel|
           filter << {
-              :operatingsystem => os_sup['operatingsystem'],
-              :hardwaremodel   => hardwaremodel,
+            'os.name' => os_sup['operatingsystem'],
+            'os.hardware' => hardwaremodel,
           }
         end
       end
     end
 
-    strict_requirement = RspecPuppetFacts::facter_version_to_strict_requirement(facterversion)
+    strict_requirement = RspecPuppetFacts.facter_version_to_strict_requirement(facterversion)
 
-    loose_requirement = RspecPuppetFacts::facter_version_to_loose_requirement(facterversion)
+    loose_requirement = RspecPuppetFacts.facter_version_to_loose_requirement(facterversion)
     received_facts = []
 
     # FacterDB may have newer versions of facter data for which it contains a subset of all possible
     # facter data (see FacterDB 0.5.2 for Facter releases 3.8 and 3.9). In this situation we need to
     # cycle through and downgrade Facter versions per platform type until we find matching Facter data.
     filter.each do |filter_spec|
-      versions = FacterDB.get_facts(filter_spec).to_h { |facts| [Gem::Version.new(facts[:facterversion]), facts] }
+      versions = FacterDB.get_facts(filter_spec, symbolize_keys: !RSpec.configuration.facterdb_string_keys).to_h do |facts|
+        [Gem::Version.new(facts[:facterversion]), facts]
+      end
 
       version, facts = versions.select { |v, _f| strict_requirement =~ v }.max_by { |v, _f| v }
 
@@ -131,9 +127,7 @@ module RspecPuppetFacts
         version, facts = versions.select { |v, _f| loose_requirement =~ v }.max_by { |v, _f| v } if loose_requirement
         next unless version
 
-        if RspecPuppetFacts.spec_facts_strict?
-          raise ArgumentError, "No facts were found in the FacterDB for Facter v#{facterversion} on #{filter_spec}, aborting"
-        end
+        raise ArgumentError, "No facts were found in the FacterDB for Facter v#{facterversion} on #{filter_spec}, aborting" if RspecPuppetFacts.spec_facts_strict?
 
         RspecPuppetFacts.warning "No facts were found in the FacterDB for Facter v#{facterversion} on #{filter_spec}, using v#{version} instead"
       end
@@ -148,33 +142,19 @@ module RspecPuppetFacts
 
     os_facts_hash = {}
     received_facts.map do |facts|
-      # Fix facter bug
-      # Todo: refactor the whole block to rely on structured facts and use legacy facts as fallback
-      if facts[:operatingsystem] == 'Ubuntu'
-        operatingsystemmajrelease = facts[:operatingsystemrelease].split('.')[0..1].join('.')
-      elsif facts[:operatingsystem] == 'OpenBSD'
-        operatingsystemmajrelease = facts[:operatingsystemrelease]
-      elsif facts[:operatingsystem] == 'windows' && facts[:operatingsystemrelease].start_with?('10.0.')
-        operatingsystemmajrelease = '2016'
-      elsif facts.dig(:os, 'release', 'major')
-        operatingsystemmajrelease = facts[:os]['release']['major']
-      elsif facts.dig(:os, 'distro', 'release', 'major')
-        operatingsystemmajrelease = facts[:os]['distro']['release']['major']
-      else
-        if facts[:operatingsystemmajrelease].nil?
-          operatingsystemmajrelease = facts[:operatingsystemrelease].split('.')[0]
-        else
-          operatingsystemmajrelease = facts[:operatingsystemmajrelease]
-        end
+      os_fact = RSpec.configuration.facterdb_string_keys ? facts['os'] : facts[:os]
+      unless os_fact
+        RspecPuppetFacts.warning "No os fact was found in FacterDB for: #{facts}"
+        next
       end
-      os = "#{facts[:operatingsystem].downcase}-#{operatingsystemmajrelease}-#{facts[:hardwaremodel]}"
-      next unless os.start_with? RspecPuppetFacts.spec_facts_os_filter if RspecPuppetFacts.spec_facts_os_filter
+
+      os = "#{os_fact['name'].downcase}-#{os_fact['release']['major']}-#{os_fact['hardware']}"
+      next if RspecPuppetFacts.spec_facts_os_filter && !os.start_with?(RspecPuppetFacts.spec_facts_os_filter)
+
       facts.merge! RspecPuppetFacts.common_facts
       os_facts_hash[os] = RspecPuppetFacts.with_custom_facts(os, facts)
     end
 
-    return stringify_keys(os_facts_hash) if RSpec.configuration.facterdb_string_keys
-
     os_facts_hash
   end
 
@@ -212,7 +192,7 @@ module RspecPuppetFacts
   def self.register_custom_fact(name, value, options)
     @custom_facts ||= {}
     name = RSpec.configuration.facterdb_string_keys ? name.to_s : name.to_sym
-    @custom_facts[name] = {:options => options, :value => value}
+    @custom_facts[name] = { options: options, value: value }
   end
 
   # Adds any custom facts according to the rules defined for the operating
@@ -231,7 +211,7 @@ module RspecPuppetFacts
       value = fact[:value].respond_to?(:call) ? fact[:value].call(os, facts) : fact[:value]
       # if merge_facts passed, merge supplied facts into facts hash
       if fact[:options][:merge_facts]
-        facts.deep_merge!({name => value})
+        facts.deep_merge!({ name => value })
       else
         facts[name] = value
       end
@@ -254,7 +234,7 @@ module RspecPuppetFacts
   # @return [nil,String]
   # @api private
   def self.spec_facts_os_filter
-    ENV['SPEC_FACTS_OS']
+    ENV.fetch('SPEC_FACTS_OS', nil)
   end
 
   # If SPEC_FACTS_STRICT is set to `yes`, RspecPuppetFacts will error on missing FacterDB entries, instead of warning & skipping the tests, or using an older facter version.
@@ -270,10 +250,11 @@ module RspecPuppetFacts
   # @return [Hash <Symbol => String>]
   def self.common_facts
     return @common_facts if @common_facts
+
     @common_facts = {
-      :puppetversion => Puppet.version,
-      :rubysitedir   => RbConfig::CONFIG['sitelibdir'],
-      :rubyversion   => RUBY_VERSION,
+      puppetversion: Puppet.version,
+      rubysitedir: RbConfig::CONFIG['sitelibdir'],
+      rubyversion: RUBY_VERSION,
     }
 
     @common_facts[:mco_version] = MCollective::VERSION if mcollective?
@@ -281,6 +262,7 @@ module RspecPuppetFacts
     if augeas?
       @common_facts[:augeasversion] = Augeas.open(nil, nil, Augeas::NO_MODL_AUTOLOAD).get('/augeas/version')
     end
+    @common_facts = stringify_keys(@common_facts) if RSpec.configuration.facterdb_string_keys
 
     @common_facts
   end
@@ -317,8 +299,9 @@ module RspecPuppetFacts
   # @api private
   def self.meta_supported_os
     unless metadata['operatingsystem_support'].is_a? Array
-      fail StandardError, 'Unknown operatingsystem support in the metadata file!'
+      raise StandardError, 'Unknown operatingsystem support in the metadata file!'
     end
+
     metadata['operatingsystem_support']
   end
 
@@ -330,8 +313,9 @@ module RspecPuppetFacts
   def self.metadata
     return @metadata if @metadata
     unless File.file? metadata_file
-      fail StandardError, "Can't find metadata.json... dunno why"
+      raise StandardError, "Can't find metadata.json... dunno why"
     end
+
     content = File.read metadata_file
     @metadata = JSON.parse content
   end
@@ -347,7 +331,7 @@ module RspecPuppetFacts
   # @param message [String]
   # @api private
   def self.warning(message)
-    STDERR.puts message
+    warn message
   end
 
   # Reset the memoization
@@ -397,7 +381,7 @@ module RspecPuppetFacts
     elsif /\A[0-9]+\Z/.match?(version)
       # Interpret 3 as < 4
       "< #{version.to_i + 1}"
-    else
+    else # rubocop:disable Style/EmptyElse
       # This would be the same as the strict requirement
       nil
     end
@@ -415,13 +399,13 @@ module RspecPuppetFacts
     fd = File.open(json_path, 'rb:UTF-8')
     data = JSON.parse(fd.read)
 
-    version_map = data.map { |_, versions|
+    version_map = data.map do |_, versions|
       if versions['puppet'].nil? || versions['facter'].nil?
         nil
       else
         [Gem::Version.new(versions['puppet']), versions['facter']]
       end
-    }.compact
+    end.compact
 
     puppet_gem_version = Gem::Version.new(puppet_version)
     applicable_versions = version_map.select { |p, _| puppet_gem_version >= p }
@@ -430,7 +414,7 @@ module RspecPuppetFacts
       return Facter.version
     end
 
-    applicable_versions.sort { |a, b| b.first <=> a.first }.first.last
+    applicable_versions.max_by { |p, _| p }.last
   rescue JSON::ParserError
     warning "#{json_path} contains invalid JSON, defaulting to Facter #{Facter.version}"
     Facter.version
@@ -440,7 +424,6 @@ module RspecPuppetFacts
 end
 
 RSpec.configure do |c|
-  c.add_setting :default_facter_version,
-    :default => RspecPuppetFacts.facter_version_for_puppet_version(Puppet.version)
-  c.add_setting :facterdb_string_keys, :default => false
+  c.add_setting :default_facter_version, default: RspecPuppetFacts.facter_version_for_puppet_version(Puppet.version)
+  c.add_setting :facterdb_string_keys, default: false
 end

data/rspec-puppet-facts.gemspec

@@ -23,10 +23,10 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec', '~> 3.12'
   s.add_development_dependency 'yard', '~> 0.9.34'
 
-  s.add_development_dependency 'voxpupuli-rubocop', '~> 2.6.0'
+  s.add_development_dependency 'voxpupuli-rubocop', '~> 2.7.0'
 
   s.add_runtime_dependency 'deep_merge', '~> 1.2'
   s.add_runtime_dependency 'facter', '< 5'
-  s.add_runtime_dependency 'facterdb', '>= 0.5.0', '< 2'
+  s.add_runtime_dependency 'facterdb', '~> 2.1'
   s.add_runtime_dependency 'puppet', '>= 7', '< 9'
 end

data/spec/fixtures/metadata.json

@@ -15,16 +15,16 @@
     {
       "operatingsystem": "Debian",
       "operatingsystemrelease": [
-        "7",
-        "8"
+        "11",
+        "12"
       ]
     },
     {
       "operatingsystem": "RedHat",
       "operatingsystemrelease": [
-        "5",
-        "6",
-        "7"
+        "7",
+        "8",
+        "9"
       ]
     }
   ],