rspec-puppet-facts 3.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d829fff0e8b5d1ca49d62e80553aeb95658f8b12fd774c92c9f92322a52bbe1
-  data.tar.gz: a00418119004c0fbad99a43362ff35f3e76ee118b2f460c922c3b4d6d51fce49
+  metadata.gz: da12216f356aa371b255a495fa7eb0f3d3eb8b553aac7eed5e17c3098540f8f8
+  data.tar.gz: d774a6780c00fc787131c80f7bcbdb277e8b80b16c9b121be38f1ed4126f7f8e
 SHA512:
-  metadata.gz: 2467fd5253ad8096ac306a162580b4bff64cee7ff0193a67b769ef2d272346781e12b9c07ed69dd33ace30b00dd51f6668bb99c2493d5976be4fbc896f86b9cd
-  data.tar.gz: '092e3f2d3b573d26caf21c953fc8dbc92e5a77599a34b61da190669514f6875a01df1289e6daeec43760c7a591f2491fef5c6decf708bccee4f6ad67a881793d'
+  metadata.gz: 5350e14d6a9c61a6d1f01a7cbf0773048b10d305dd0901199d760106c8aa8e98ab8aa9d506a44f7142dbf6399b6dadb11322bc9682f8145c92a8598d2c2c9511
+  data.tar.gz: 52c83ec12e7926331107efd13642e68232bad5906a92a88c8cdb765247635d02239f9e0f942b40a70cbbb23256d0de8d15486935f1225eb88fa981557ad0110f

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,33 +1,87 @@
 # Changelog
 
+## [5.0.0](https://github.com/voxpupuli/rspec-puppet-facts/tree/5.0.0) (2024-07-04)
+
+[Full Changelog](https://github.com/voxpupuli/rspec-puppet-facts/compare/4.0.0...5.0.0)
+
+**Breaking changes:**
+
+- Switch to FacterDB 3 / drop legacy facts [\#187](https://github.com/voxpupuli/rspec-puppet-facts/pull/187) ([bastelfreak](https://github.com/bastelfreak))
+
+**Implemented enhancements:**
+
+- Deprecate symbolized facts [\#193](https://github.com/voxpupuli/rspec-puppet-facts/pull/193) ([bastelfreak](https://github.com/bastelfreak))
+
+**Fixed bugs:**
+
+- handle stringified facterversion properly [\#191](https://github.com/voxpupuli/rspec-puppet-facts/pull/191) ([bastelfreak](https://github.com/bastelfreak))
+
+**Merged pull requests:**
+
+- Update voxpupuli-rubocop requirement from ~\> 2.7.0 to ~\> 2.8.0 [\#192](https://github.com/voxpupuli/rspec-puppet-facts/pull/192) ([dependabot[bot]](https://github.com/apps/dependabot))
+
+## [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)
 
 **symbolized facts deprecation**
 
-With the release of rspec-puppet-facts 4.0.0 we will remove support for symbolized facts. At the moment people typically use this in their unit files:
+With the release of rspec-puppet-facts 6.0.0 we will remove support for symbolized facts. At the moment people typically use this in their unit files:
 
 ```ruby
-case facts[:os]['name']
-when 'Archlinux'
-  context 'on Archlinux' do
-    it { is_expected.to contain_package('borg') }
+on_supported_os.each do |os, os_facts|
+  case os_facts[:os]['name']
+  when 'Archlinux'
+    context 'on Archlinux' do
+      it { is_expected.to contain_package('borg') }
+    end
+  when 'Ubuntu'
   end
-when 'Ubuntu'
+end
 ```
 
-For history reasons the first level of facts were symbols. You will have to update it to strings with the 4.0.0 release:
+For history reasons the first level of facts were symbols. You will have to update it to strings with the 6.0.0 release:
 
 ```ruby
-case facts['os']['name']
-when 'Archlinux'
-  context 'on Archlinux' do
-    it { is_expected.to contain_package('borg') }
+on_supported_os.each do |os, os_facts|
+  case os_facts['os']['name']
+  when 'Archlinux'
+    context 'on Archlinux' do
+      it { is_expected.to contain_package('borg') }
+    end
+  when 'Ubuntu'
   end
-when 'Ubuntu'
+end
 ```
 
+As an alternative you can configure the old behaviour:
+
+```ruby
+RSpec.configure do |c|
+  c.facterdb_string_keys = false
+end
+```
 
 **Breaking changes:**
 

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

@@ -22,7 +22,7 @@ If you're using Bundler to manage gems in your module repository, install `rspec
 1. Add the following line to your `Gemfile`:
 
 ```ruby
-gem 'rspec-puppet-facts', :require => false
+gem 'rspec-puppet-facts', require: false
 ```
 
 2. Run `bundle install`.
@@ -54,38 +54,18 @@ By default, `rspec-puppet-facts` provides the facts only for `x86_64` architectu
     * `'operatingsystem'`        - The name of the operating system, as a string.
     * `'operatingsystemrelease'` - An array of version numbers, as strings.
 
-This is particularly useful if your module is split into operating system subclasses. For example, if you had a class called `myclass::debian` that you wanted to test against Debian 6 and Debian 7 on both `x86_64` _and_ `i386` architectures, you could write the following test:
+This is particularly useful if your module is split into operating system subclasses. For example, if you had a class called `myclass::debian` that you wanted to test against Debian 12 and Debian 11 on both `x86_64` _and_ `i386` architectures, you could write the following test:
 
 ```ruby
 require 'spec_helper'
 
-describe 'myclass::debian' do
-  test_on = {
-    :hardwaremodels => ['x86_64', 'i386'],
-    :supported_os   => [
-      {
-        'operatingsystem'        => 'Debian',
-        'operatingsystemrelease' => ['6', '7'],
-      },
-    ],
-  }
-
-  on_supported_os(test_on).each do |os, os_facts|
-    let (:facts) { os_facts }
-    it { is_expected.to compile.with_all_deps }
-  end
-end
-```
-Ruby 1.9 and later:
-```ruby
-require 'spec_helper'
-
 describe 'myclass::raspbian' do
   test_on = {
+    hardwaremodels: ['x86_64', 'i386'],
     supported_os: [
       {
         'operatingsystem'        => 'Debian',
-        'operatingsystemrelease' => ['10', '9', '8'],
+        'operatingsystemrelease' => ['12', '11'],
       },
     ],
   }
@@ -98,10 +78,9 @@ end
 
 ## Specifying a default Facter version
 
-By default, `os_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.
+By default, `on_supported_os` will return the facts for the version of Facter that it has loaded. It will check for the loaded Puppet version and maps that to the Facter version that Perforce released in the matching AIO.
+The mapping is stored in `ext/puppet_agent_components.json` (check the [maintenance](#maintenance) section for details) and computated in the `facter_version_for_puppet_version` method.
+This behaviour can be overridden by setting the `default_facter_version` RSpec setting in your `spec/spec_helper.rb` file.
 
 ```ruby
 RSpec.configure do |c|
@@ -109,6 +88,54 @@ RSpec.configure do |c|
 end
 ```
 
+## Symbolized vs stringified facts
+
+For a long long time, the first level of keys in a factsets were symbols.
+This was fine before there were structured facts, but structured facts ended up as nested hashes that always had strings.
+This doesn't make sense and easy to get wrong.
+The original data contains only strings so conversion actually costs performance.
+
+The option to switch between symbolized vs stringified facts was introduced in [25634f4481f20f2fc7444e867928ca607234e33e](https://github.com/voxpupuli/rspec-puppet-facts/commit/25634f4481f20f2fc7444e867928ca607234e33e) (Release [1.9.5](https://github.com/voxpupuli/rspec-puppet-facts/blob/master/CHANGELOG.md#2019-07-29---release-195)), but version 5.0.0 has resolved various implementation bugs.
+
+This can be configured like this:
+
+```ruby
+RSpec.configure do |c|
+  c.facterdb_string_keys = false
+end
+```
+
+In the 5.x release series of rspec-puppet-facts the default `false` is deprecated.
+With the 6.0.0 release we will flip it to `true` (https://github.com/voxpupuli/rspec-puppet-facts/pull/189).
+
+You may have the following rspec-puppet test using deprecated symbolized facts:
+
+```ruby
+on_supported_os.each do |os, os_facts|
+  case os_facts[:os]['name']
+  when 'Archlinux'
+    context 'on Archlinux' do
+      it { is_expected.to contain_package('borg') }
+    end
+  when 'Ubuntu'
+  end
+end
+```
+
+With the string facts, the same test looks like:
+
+```ruby
+on_supported_os.each do |os, os_facts|
+  case os_facts['os']['name']
+  when 'Archlinux'
+    context 'on Archlinux' do
+      it { is_expected.to contain_package('borg') }
+    end
+  when 'Ubuntu'
+  end
+end
+```
+
 ## Usage
 
 Use the `on_supported_os` iterator to loop through all of your module's supported operating systems. This allows you to simplify your tests and remove a lot of duplicate code.
@@ -475,7 +502,7 @@ fact sets that only make sense in your environment or might contain sensitive in
 To supply external facts to facterdb just set the `FACTERDB_SEARCH_PATHS` environment variable with one or more
 paths to your facts.
 
-When separating paths please use the default path separator character supported by your OS.  
+When separating paths please use the default path separator character supported by your OS.
 * Unix/Linux/OSX = `:`
 * Windows = `;`
 

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,12 +54,24 @@ 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
     config.future_release = gem_version
   end
+
+  # Workaround for https://github.com/github-changelog-generator/github-changelog-generator/issues/715
+  require 'rbconfig'
+  if RbConfig::CONFIG['host_os'].include?('linux')
+    task :changelog do
+      puts 'Fixing line endings...'
+      changelog_file = File.join(__dir__, 'CHANGELOG.md')
+      changelog_txt = File.read(changelog_file)
+      new_contents = changelog_txt.gsub("\r\n", "\n")
+      File.open(changelog_file, 'w') { |file| file.puts new_contents }
+    end
+  end
 end
 
 begin

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 = '5.0.0'
   end
 end