rspec-puppet-facts 4.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26b5f9acb794f67889cc8d24cb1bc35b73e0c20d1e855f88ac8d65cf1ca8cbbf
-  data.tar.gz: 920bd51e0f0def41e2f7ea8a38aa26b7247d8e311b3cda87b08eaa592fdecda1
+  metadata.gz: da12216f356aa371b255a495fa7eb0f3d3eb8b553aac7eed5e17c3098540f8f8
+  data.tar.gz: d774a6780c00fc787131c80f7bcbdb277e8b80b16c9b121be38f1ed4126f7f8e
 SHA512:
-  metadata.gz: 7290dffe6d55a28fa8fc721c03c394b2715a6fa282a8af544ab5ab7fa6428976592b8cd0e853f88bce10f70bfcd403fb49b77b0ba74ddb37823bdd5b19bdcc03
-  data.tar.gz: 5d23c2f0ae77ecc1a562e0e3aa079ff0c097f48c495d4c39cc17e486f4bbb3d6974a6a3f458d5b05df294c461e209df718ea342b270b9cae6a4d298a9db9e6f4
+  metadata.gz: 5350e14d6a9c61a6d1f01a7cbf0773048b10d305dd0901199d760106c8aa8e98ab8aa9d506a44f7142dbf6399b6dadb11322bc9682f8145c92a8598d2c2c9511
+  data.tar.gz: 52c83ec12e7926331107efd13642e68232bad5906a92a88c8cdb765247635d02239f9e0f942b40a70cbbb23256d0de8d15486935f1225eb88fa981557ad0110f

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # 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)
@@ -27,28 +47,41 @@
 
 **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/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, `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.
+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

@@ -60,6 +60,18 @@ else
     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 = '4.0.0'
+    STRING = '5.0.0'
   end
 end

data/lib/rspec-puppet-facts.rb

@@ -116,9 +116,10 @@ module RspecPuppetFacts
     # 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.
+    facterversion_key = RSpec.configuration.facterdb_string_keys ? 'facterversion' : :facterversion
     filter.each do |filter_spec|
       versions = FacterDB.get_facts(filter_spec, symbolize_keys: !RSpec.configuration.facterdb_string_keys).to_h do |facts|
-        [Gem::Version.new(facts[:facterversion]), facts]
+        [Gem::Version.new(facts[facterversion_key]), facts]
       end
 
       version, facts = versions.select { |v, _f| strict_requirement =~ v }.max_by { |v, _f| v }

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.7.0'
+  s.add_development_dependency 'voxpupuli-rubocop', '~> 2.8.0'
 
   s.add_runtime_dependency 'deep_merge', '~> 1.2'
   s.add_runtime_dependency 'facter', '< 5'
-  s.add_runtime_dependency 'facterdb', '~> 2.1'
+  s.add_runtime_dependency 'facterdb', '~> 3.1'
   s.add_runtime_dependency 'puppet', '>= 7', '< 9'
 end

data/spec/fixtures/metadata.json

@@ -22,7 +22,6 @@
     {
       "operatingsystem": "RedHat",
       "operatingsystemrelease": [
-        "7",
         "8",
         "9"
       ]

data/spec/rspec_puppet_facts_spec.rb

@@ -215,7 +215,6 @@ describe RspecPuppetFacts do
             expect(subject.keys).to contain_exactly(
               'debian-11-x86_64',
               'debian-12-x86_64',
-              'redhat-7-x86_64',
               'redhat-8-x86_64',
               'redhat-9-x86_64',
             )
@@ -224,7 +223,6 @@ describe RspecPuppetFacts do
           it 'is able to filter the received OS facts' do
             allow(described_class).to receive(:spec_facts_os_filter).and_return('redhat')
             expect(subject.keys).to contain_exactly(
-              'redhat-7-x86_64',
               'redhat-8-x86_64',
               'redhat-9-x86_64',
             )
@@ -319,7 +317,7 @@ describe RspecPuppetFacts do
       end
 
       it 'returns a fact set for the specified release' do
-        expect(factsets).to match('redhat-9-x86_64' => include(operatingsystemmajrelease: '9'))
+        expect(factsets).to a_hash_including('redhat-9-x86_64' => hash_including({ os: hash_including({ 'release' => hash_including({ 'major' => '9' }) }) }))
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-puppet-facts
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-10 00:00:00.000000000 Z
+date: 2024-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types
@@ -78,14 +78,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: 2.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: 2.8.0
 - !ruby/object:Gem::Dependency
   name: deep_merge
   requirement: !ruby/object:Gem::Requirement
@@ -120,14 +120,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: puppet
   requirement: !ruby/object:Gem::Requirement
@@ -195,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.11
 signing_key: 
 specification_version: 4
 summary: Standard facts fixtures for Puppet