rspec-puppet 4.0.2 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 426a4ee05db6fe1e2ca9fea2e6bb5867ee07e9a07026c1b88d7f58d5466883e5
-  data.tar.gz: dc491e62b7b7228ae76e292ea5b387b279a8791551f81e689a1fc1c96af3cbb5
+  metadata.gz: 90c80a0c8b7a303f9e8307598572f6501b91668b325b9ddf297a267ee24ef4d2
+  data.tar.gz: f73ec645dd29669a8749e8b8dd12e714109c4e613a4c94acb031524288052ff5
 SHA512:
-  metadata.gz: 3e0ea7226522dc683e27d1beac2337b4d3ec6ad448d5d95608c5879a5175f6e62ada4ee6ee81c8ab1345cd4265cdaa3cd509a80173218a1998d146546caba7e0
-  data.tar.gz: cdfdbf4bfb0551b3f4b8465a1278c93cef7707fd2284a5629dc6fe71f7846bbcec5c12396efb755da2a092521cf71a10b9f51794af7a4d650053913905c3897d
+  metadata.gz: 378d47cb8c9a0c026185218f9925c08c804acf1dd3d417be41d44bc004045d433dcc1b21bc96d36ee16cbebb1508f7033a27aea34e85dc9a7e1e1c0ceb3084f2
+  data.tar.gz: 6a96f0c9a10fe84ba051defd74651c945036b5294aba6e0680a3cd1effc6a34981c8c9219c535607f404cefd1bc1d9a79d2a0d0117f481c8c93d678ce1f0dc94

data/CHANGELOG.md

@@ -5,6 +5,27 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org).
 
+## [v5.0.1](https://github.com/puppetlabs/rspec-puppet/tree/v5.0.1) - 2026-09-03
+
+[Full Changelog](https://github.com/puppetlabs/rspec-puppet/compare/v5.0.0...v5.0.1)
+
+### Changed
+
+- (CAT-2281) Remove puppet 7 infrastructure [#133](https://github.com/puppetlabs/rspec-puppet/pull/133) ([LukasAud](https://github.com/LukasAud))
+
+## [v5.0.0](https://github.com/puppetlabs/rspec-puppet/tree/v5.0.0) - 2024-09-06
+
+[Full Changelog](https://github.com/puppetlabs/rspec-puppet/compare/v4.0.2...v5.0.0)
+
+### Changed
+
+- Unwrap sensitive values in error messages [#42](https://github.com/puppetlabs/rspec-puppet/pull/42) ([smortex](https://github.com/smortex))
+
+### Fixed
+
+- server_facts: Switch from legacy to structured facts [#127](https://github.com/puppetlabs/rspec-puppet/pull/127) ([bastelfreak](https://github.com/bastelfreak))
+- (bug) - Add license file to built gem [#108](https://github.com/puppetlabs/rspec-puppet/pull/108) ([jordanbreen28](https://github.com/jordanbreen28))
+
 ## [v4.0.2](https://github.com/puppetlabs/rspec-puppet/tree/v4.0.2) - 2023-12-05
 
 [Full Changelog](https://github.com/puppetlabs/rspec-puppet/compare/v4.0.1...v4.0.2)
@@ -27,6 +48,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 [Full Changelog](https://github.com/puppetlabs/rspec-puppet/compare/v3.0.0...v4.0.0)
 
 ### Changed
+
 - (CAT-1226) - Remove Compatibility for Puppet 7.10 and below [#73](https://github.com/puppetlabs/rspec-puppet/pull/73) ([jordanbreen28](https://github.com/jordanbreen28))
 - Drop RSpec 2 & Ruby 1 compatiblity [#67](https://github.com/puppetlabs/rspec-puppet/pull/67) ([ekohl](https://github.com/ekohl))
 - Remove puppet applications support [#54](https://github.com/puppetlabs/rspec-puppet/pull/54) ([nabertrand](https://github.com/nabertrand))
@@ -44,6 +66,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 [Full Changelog](https://github.com/puppetlabs/rspec-puppet/compare/v2.12.0...v3.0.0.rc.1)
 
 ### Changed
+
 - (CONT-808) Ruby 3 / Puppet 8 Support [#48](https://github.com/puppetlabs/rspec-puppet/pull/48) ([chelnak](https://github.com/chelnak))
 
 ### Added
@@ -97,7 +120,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [v2.8.0](https://github.com/puppetlabs/rspec-puppet/tree/v2.8.0) - 2020-11-05
 
-[Full Changelog](https://github.com/puppetlabs/rspec-puppet/compare/v2.7.9...v2.8.0)
+[Full Changelog](https://github.com/puppetlabs/rspec-puppet/compare/v2.7.10...v2.8.0)
+
+## [v2.7.10](https://github.com/puppetlabs/rspec-puppet/tree/v2.7.10) - 2020-07-15
+
+[Full Changelog](https://github.com/puppetlabs/rspec-puppet/compare/v2.7.9...v2.7.10)
 
 ## [v2.7.9](https://github.com/puppetlabs/rspec-puppet/tree/v2.7.9) - 2020-07-14
 

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Tim Sharpe
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -888,66 +888,92 @@ end
 
 ## Hiera integration
 
+At some point, you might want to make use of Hiera to bring in custom parameters for your class tests. In this section, we will
+provide you with basic guidance to setup Hiera implementation within rspec testing. For more information on Hiera, you should
+check our official [documentation](https://www.puppet.com/docs/puppet/latest/hiera.html).
+
 ### Configuration
 
-Set the hiera config symbol properly in your spec files:
+The first step is to create the general hiera configuration file. Since we want this to be exclusive for testing, we recommend creating
+it inside your spec folder. Something along the lines of `spec/fixtures/hiera/hiera-rspec.yaml`. It should look something like this:
 
-```ruby
-let(:hiera_config) { 'spec/fixtures/hiera/hiera.yaml' }
-hiera = Hiera.new(:config => 'spec/fixtures/hiera/hiera.yaml')
+```yaml
+---
+version: 5
+defaults:               # Used for any hierarchy level that omits these keys.
+  datadir: data         # This path is relative to hiera.yaml's directory.
+  data_hash: yaml_data  # Use the built-in YAML backend.
+
+hierarchy:
+  - name: 'rspec'
+    path: 'rspec-data.yaml'
 ```
 
-Create your spec hiera files
+It is often recommended to use dummy data during testing to avoid real values from being entangled. In order to create
+these values, we will need a new file containing this data exclusively, normally existing within a subfolder called `data`, ending up with
+`spec/fixtures/hiera/data/rspec-data.yaml`. Here is an example of its contents:
 
-spec/fixtures/hiera/hiera.yaml
-```ruby
+```yaml
 ---
-:backends:
-  - yaml
-:hierarchy:
-  - test
-:yaml:
-  :datadir: 'spec/fixtures/hiera'
+# We will be using this data in later examples
+message: 'Hello world!'
+dummy:message2: 'foobar' # autoloaded parameter
 ```
 
-spec/fixtures/hiera/test.yaml
+Finally, we make the target class spec file load the Hiera config, at which point we will be able to freely access it:
+
 ```ruby
----
-ntpserver: ['ntp1.domain.com','ntpXX.domain.com']
-user:
-  oneuser:
-    shell: '/bin/bash'
-  twouser:
-    shell: '/sbin/nologin'
+let(:hiera_config) { 'spec/fixtures/hiera/hiera-rspec.yaml' }
 ```
 
-### Use hiera in your tests
+Or alternatively, you could load the hiera configuration in the spec_helper to ensure it is available through all test files:
 
 ```ruby
-  ntpserver = hiera.lookup('ntpserver', nil, nil)
-  let(:params) { 'ntpserver' => ntpserver }
+RSpec.configure do |c|
+  c.hiera_config = 'spec/fixtures/hiera/hiera-rspec.yaml'
+end
 ```
 
-### Enabling hiera lookups
-If you just want to fetch values from hiera (e.g. because
-you're testing code that uses explicit hiera lookups) just specify
-the path to the hiera config in your `spec_helper.rb`
+#### Test usage examples
+
+Unlike with Hiera 3, Hiera 5 comes packaged with our Puppet agent and runs during Puppet runtime. This means that it is not really possible to
+call the lookup function in the same way it previously worked. However, you can still test its functionality via dummy class instantiation:
+
+The following test creates a dummny class that uses the lookup function within it. This should allow you to confirm that the lookup() function
+works correctly (remember that this test uses your custom hiera parameters, and not your real ones).
 
 ```ruby
-RSpec.configure do |c|
-  c.hiera_config = 'spec/fixtures/hiera/hiera.yaml'
-end
+context 'dummy hiera test is implemented' do
+      let(:pre_condition) do
+        "class dummy($message) { }
+         class { 'dummy': message => lookup('message') }"
+      end
+      let(:hiera_config) { 'spec/fixtures/hiera/hiera-rspec.yaml' } # Only needed if the config has not been established in spec_helper
+
+      it { is_expected.to compile }
+
+      it 'loads ntpserver from Hiera' do
+        is_expected.to contain_class('dummy').with_message('Hello world!')
+      end
+    end
 ```
 
-spec/fixtures/hiera/hiera.yaml
-```yaml
----
-:backends:
-  - yaml
-:yaml:
-  :datadir: spec/fixtures/hieradata
-:hierarchy:
-  - common
+The next test ensures that autoloaded parameters work correctly within your classes:
+
+```ruby
+    context 'dummy hiera test is implemented a second time' do
+      let(:pre_condition) do
+        "class dummy($message2) { }
+        include dummy"
+      end
+      let(:hiera_config) { 'spec/fixtures/hiera/hiera-rspec.yaml' } # Only needed if the config has not been established in spec_helper
+
+      it { is_expected.to compile }
+
+      it 'loads ntpserver from Hiera' do
+        is_expected.to contain_class('dummy').with_message2('foobar')
+      end
+    end
 ```
 
 **Please note:** In-module hiera data depends on having a correct metadata.json file. It is

data/bin/rspec-puppet-init

@@ -7,7 +7,7 @@ require 'rspec-puppet'
 require 'optparse'
 
 options = {
-  module_name: nil
+  module_name: nil,
 }
 
 OptionParser.new do |opts|

data/lib/rspec-puppet/adapters.rb

@@ -53,13 +53,11 @@ module RSpec::Puppet
           [puppet_setting, get_setting(example_group, rspec_setting)]
         end.flatten
         default_hash = { confdir: '/dev/null', vardir: '/dev/null' }
-        if defined?(Puppet::Test::TestHelper) && Puppet::Test::TestHelper.respond_to?(:app_defaults_for_tests, true)
-          default_hash.merge!(Puppet::Test::TestHelper.send(:app_defaults_for_tests))
-        end
+        default_hash.merge!(Puppet::Test::TestHelper.send(:app_defaults_for_tests)) if defined?(Puppet::Test::TestHelper) && Puppet::Test::TestHelper.respond_to?(:app_defaults_for_tests, true)
         settings_hash = default_hash.merge(Hash[*settings])
         if Gem.win_platform?
           settings_hash.each_with_object(settings_hash) do |(k, v), h|
-            h[k] = v == '/dev/null' ? 'c:/nul/' : v
+            h[k] = (v == '/dev/null') ? 'c:/nul/' : v
           end
         end
 
@@ -101,9 +99,9 @@ module RSpec::Puppet
           {
             environments: loader,
             current_environment: env,
-            loaders: Puppet::Pops::Loaders.new(env)
+            loaders: Puppet::Pops::Loaders.new(env),
           },
-          'Setup rspec-puppet environments'
+          'Setup rspec-puppet environments',
         )
       end
 
@@ -119,9 +117,7 @@ module RSpec::Puppet
         node.environment = current_environment
         # Override $::environment to workaround PUP-5835, where Puppet otherwise
         # stores a symbol for the parameter
-        if node.parameters['environment'] != node.parameters['environment'].to_s
-          node.parameters['environment'] = current_environment.name.to_s
-        end
+        node.parameters['environment'] = current_environment.name.to_s if node.parameters['environment'] != node.parameters['environment'].to_s
 
         catalog = if exported
                     # Use the compiler directly to skip the filtering done by the indirector
@@ -148,7 +144,7 @@ module RSpec::Puppet
           %i[environmentpath environmentpath],
           %i[hiera_config hiera_config],
           %i[strict_variables strict_variables],
-          %i[vendormoduledir vendormoduledir]
+          %i[vendormoduledir vendormoduledir],
         ]
       end
 
@@ -187,7 +183,7 @@ module RSpec::Puppet
 
     def self.get
       [
-        ['7.11', Base]
+        ['7.11', Base],
       ].each do |(version, klass)|
         return klass.new if Puppet::Util::Package.versioncmp(Puppet.version, version) >= 0
       end

data/lib/rspec-puppet/consts.rb

@@ -5,24 +5,24 @@ module RSpec::Puppet::Consts
     posix: {
       'File::PATH_SEPARATOR' => ':',
       'File::ALT_SEPARATOR' => nil,
-      'Pathname::SEPARATOR_PAT' => /#{Regexp.quote('/')}/
+      'Pathname::SEPARATOR_PAT' => /#{Regexp.quote('/')}/,
     },
     windows: {
       'File::PATH_SEPARATOR' => ';',
       'File::ALT_SEPARATOR' => '\\',
-      'Pathname::SEPARATOR_PAT' => /[#{Regexp.quote('\\')}#{Regexp.quote('/')}]/
-    }
+      'Pathname::SEPARATOR_PAT' => /[#{Regexp.quote('\\')}#{Regexp.quote('/')}]/,
+    },
   }.freeze
 
   FEATURES = {
     posix: {
       posix: true,
-      microsoft_windows: false
+      microsoft_windows: false,
     },
     windows: {
       posix: false,
-      microsoft_windows: true
-    }
+      microsoft_windows: true,
+    },
   }.freeze
 
   def self.stub_consts_for(platform)

data/lib/rspec-puppet/coverage.rb

@@ -232,9 +232,7 @@ module RSpec::Puppet
         end
 
         # This is not available on RSpec 2.x
-        if coverage_results.execution_result.respond_to?(:pending_message)
-          coverage_results.execution_result.pending_message = report[:text]
-        end
+        coverage_results.execution_result.pending_message = report[:text] if coverage_results.execution_result.respond_to?(:pending_message)
       else
         puts "The desired coverage must be 0 <= x <= 100, not '#{coverage_desired.inspect}'"
       end
@@ -259,7 +257,7 @@ module RSpec::Puppet
       text = [
         "Total resources:   #{report[:total]}",
         "Touched resources: #{report[:touched]}",
-        "Resource coverage: #{report[:coverage]}%"
+        "Resource coverage: #{report[:coverage]}%",
       ]
 
       if (report[:untouched]).positive?
@@ -341,7 +339,7 @@ module RSpec::Puppet
 
       def to_hash
         {
-          touched: touched?
+          touched: touched?,
         }
       end
 

data/lib/rspec-puppet/example/function_example_group.rb

@@ -86,7 +86,7 @@ module RSpec::Puppet
 
     def find_function(function_name = self.class.top_level_description)
       with_vardir do
-        env = adapter.current_environment
+        adapter.current_environment
 
         context_overrides = compiler.context_overrides
         func = nil
@@ -99,9 +99,7 @@ module RSpec::Puppet
 
         return func if func.func
 
-        if Puppet::Parser::Functions.function(function_name)
-          V3FunctionWrapper.new(function_name, scope.method(:"function_#{function_name}"))
-        end
+        V3FunctionWrapper.new(function_name, scope.method(:"function_#{function_name}")) if Puppet::Parser::Functions.function(function_name)
       end
     end
 
@@ -148,7 +146,7 @@ module RSpec::Puppet
 
       node_options = {
         parameters: fact_values,
-        facts: node_facts
+        facts: node_facts,
       }
 
       stub_facts! fact_values
@@ -157,9 +155,9 @@ module RSpec::Puppet
 
       Puppet.push_context(
         {
-          trusted_information: Puppet::Context::TrustedInformation.new('remote', node_name, trusted_values)
+          trusted_information: Puppet::Context::TrustedInformation.new('remote', node_name, trusted_values),
         },
-        'Context for spec trusted hash'
+        'Context for spec trusted hash',
       )
 
       compiler = Puppet::Parser::Compiler.new(node)
@@ -168,9 +166,9 @@ module RSpec::Puppet
       Puppet.push_context(
         {
           loaders: loaders,
-          global_scope: compiler.context_overrides[:global_scope]
+          global_scope: compiler.context_overrides[:global_scope],
         },
-        'set globals'
+        'set globals',
       )
       compiler
     end

data/lib/rspec-puppet/example/type_example_group.rb

@@ -16,7 +16,7 @@ module RSpec::Puppet
           # to pass all of the bits form the current scope
           # required to create it
           title,
-          my_params
+          my_params,
         ]
       end
     end

data/lib/rspec-puppet/matchers/allow_value.rb

@@ -28,7 +28,7 @@ module RSpec::Puppet
       end
 
       def failure_message
-        "expected that the type alias would #{description} but it raised the #{@error_msgs.length == 1 ? 'error' : 'errors'} #{@error_msgs.join(', ')}"
+        "expected that the type alias would #{description} but it raised the #{(@error_msgs.length == 1) ? 'error' : 'errors'} #{@error_msgs.join(', ')}"
       end
 
       def failure_message_when_negated

data/lib/rspec-puppet/matchers/count_generic.rb

@@ -6,7 +6,7 @@ module RSpec::Puppet
       DEFAULT_RESOURCES = [
         'Class[main]',
         'Class[Settings]',
-        'Stage[main]'
+        'Stage[main]',
       ].freeze
 
       attr_reader :resource_type
@@ -46,10 +46,10 @@ module RSpec::Puppet
 
         desc << "contain exactly #{@expected_number}"
         if @type == 'class'
-          desc << (@expected_number == 1 ? 'class' : 'classes').to_s
+          desc << ((@expected_number == 1) ? 'class' : 'classes').to_s
         else
           desc << @resource_type.to_s unless @type == 'resource'
-          desc << (@expected_number == 1 ? 'resource' : 'resources').to_s
+          desc << ((@expected_number == 1) ? 'resource' : 'resources').to_s
         end
 
         desc.join(' ')

data/lib/rspec-puppet/matchers/create_generic.rb

@@ -30,10 +30,10 @@ module RSpec::Puppet
         self
       end
 
-      def only_with(*args, &block)
+      def only_with(*args, &)
         params = args.shift
         @expected_params_count = (@expected_params_count || 0) + params.compact.size
-        with(params, &block)
+        with(params, &)
       end
 
       def without(*args)
@@ -62,7 +62,7 @@ module RSpec::Puppet
         self
       end
 
-      def method_missing(method, *args, &block)
+      def method_missing(method, *args, &)
         case method.to_s
         when /^with_/
           param = method.to_s.gsub(/^with_/, '')
@@ -83,7 +83,6 @@ module RSpec::Puppet
       end
 
       def matches?(catalogue)
-        ret = true
         @catalogue = catalogue.is_a?(Puppet::Resource::Catalog) ? catalogue : catalogue.call
         resource = @catalogue.resource(@referenced_type, @title)
 
@@ -104,14 +103,9 @@ module RSpec::Puppet
                       'name'
                     end
 
-          if @expected_params.none? { |param| param.first.to_s == namevar } && rsrc_hsh.key?(namevar.to_sym)
-            rsrc_hsh.delete(namevar.to_sym)
-          end
+          rsrc_hsh.delete(namevar.to_sym) if @expected_params.none? { |param| param.first.to_s == namevar } && rsrc_hsh.key?(namevar.to_sym)
 
-          if @expected_params_count && rsrc_hsh.size != @expected_params_count
-            ret = false
-            (@errors ||= []) << "exactly #{@expected_params_count} parameters but the catalogue contains #{rsrc_hsh.size}"
-          end
+          (@errors ||= []) << "exactly #{@expected_params_count} parameters but the catalogue contains #{rsrc_hsh.size}" if @expected_params_count && rsrc_hsh.size != @expected_params_count
 
           check_params(rsrc_hsh, @expected_params, :should) if @expected_params.any?
           check_params(rsrc_hsh, @expected_undef_params, :not) if @expected_undef_params.any?
@@ -207,12 +201,12 @@ module RSpec::Puppet
         output = []
         list.each do |param, value|
           if value.nil?
-            output << "#{param} #{type == :not ? 'un' : ''}defined"
+            output << "#{param} #{(type == :not) ? 'un' : ''}defined"
           else
-            a = type == :not ? '!' : '='
+            a = (type == :not) ? '!' : '='
             b = value.is_a?(Regexp) ? '~' : '>'
             output << if (param.to_s == 'content') && value.is_a?(String)
-                        "#{param} #{type == :not ? 'not ' : ''} supplied string"
+                        "#{param} #{(type == :not) ? 'not ' : ''} supplied string"
                       else
                         "#{param} #{a}#{b} #{value.inspect}"
                       end
@@ -223,33 +217,25 @@ module RSpec::Puppet
 
       def check_befores(_catalogue, resource)
         @befores.each do |ref|
-          unless precedes?(resource, canonicalize_resource(ref))
-            @errors << BeforeRelationshipError.new(resource.to_ref, ref)
-          end
+          @errors << BeforeRelationshipError.new(resource.to_ref, ref) unless precedes?(resource, canonicalize_resource(ref))
         end
       end
 
       def check_requires(_catalogue, resource)
         @requires.each do |ref|
-          unless precedes?(canonicalize_resource(ref), resource)
-            @errors << RequireRelationshipError.new(resource.to_ref, ref)
-          end
+          @errors << RequireRelationshipError.new(resource.to_ref, ref) unless precedes?(canonicalize_resource(ref), resource)
         end
       end
 
       def check_notifies(_catalogue, resource)
         @notifies.each do |ref|
-          unless notifies?(resource, canonicalize_resource(ref))
-            @errors << NotifyRelationshipError.new(resource.to_ref, ref)
-          end
+          @errors << NotifyRelationshipError.new(resource.to_ref, ref) unless notifies?(resource, canonicalize_resource(ref))
         end
       end
 
       def check_subscribes(_catalogue, resource)
         @subscribes.each do |ref|
-          unless notifies?(canonicalize_resource(ref), resource)
-            @errors << SubscribeRelationshipError.new(resource.to_ref, ref)
-          end
+          @errors << SubscribeRelationshipError.new(resource.to_ref, ref) unless notifies?(canonicalize_resource(ref), resource)
         end
       end
 
@@ -334,9 +320,7 @@ module RSpec::Puppet
             before_refs = relationship_refs(u, :before) + relationship_refs(u, :notify)
             require_refs = relationship_refs(v, :require) + relationship_refs(u, :subscribe)
 
-            if before_refs.include?(v.to_ref) || require_refs.include?(u.to_ref) || (before_refs & require_refs).any?
-              return true
-            end
+            return true if before_refs.include?(v.to_ref) || require_refs.include?(u.to_ref) || before_refs.intersect?(require_refs)
           end
         end
 

data/lib/rspec-puppet/matchers/dynamic_matchers.rb

@@ -2,10 +2,10 @@
 
 module RSpec::Puppet
   module ManifestMatchers
-    def method_missing(method, *args, &block)
+    def method_missing(method, *args, &)
       if /^(create|contain)_/.match?(method.to_s)
         return RSpec::Puppet::ManifestMatchers::CreateGeneric.new(method, *args,
-                                                                  &block)
+                                                                  &)
       end
       if /^have_.+_count$/.match?(method.to_s)
         return RSpec::Puppet::ManifestMatchers::CountGeneric.new(nil, args[0],
@@ -18,7 +18,7 @@ module RSpec::Puppet
   end
 
   module FunctionMatchers
-    def method_missing(method, *args, &block)
+    def method_missing(method, *args, &)
       return RSpec::Puppet::FunctionMatchers::Run.new if method == :run
 
       super
@@ -26,8 +26,8 @@ module RSpec::Puppet
   end
 
   module TypeMatchers
-    def method_missing(method, *args, &block)
-      return RSpec::Puppet::TypeMatchers::CreateGeneric.new(method, *args, &block) if method == :be_valid_type
+    def method_missing(method, ...)
+      return RSpec::Puppet::TypeMatchers::CreateGeneric.new(method, ...) if method == :be_valid_type
 
       super
     end

data/lib/rspec-puppet/matchers/parameter_matcher.rb

@@ -28,6 +28,8 @@ module RSpec::Puppet
         actual = resource[@parameter]
         expected = @value
 
+        actual = RSpec::Puppet::Sensitive.new(actual.unwrap) if actual.is_a?(Puppet::Pops::Types::PSensitiveType::Sensitive)
+
         # Puppet flattens an array with a single value into just the value and
         # this can cause confusion when testing as people expect when you put
         # an array in, you'll get an array out.

data/lib/rspec-puppet/matchers/raise_error.rb

@@ -19,9 +19,9 @@ module RSpec::Puppet
     end
 
     def raise_error(
-      error = defined?(RSpec::Matchers::BuiltIn::RaiseError::UndefinedValue) ? RSpec::Matchers::BuiltIn::RaiseError::UndefinedValue : nil, message = nil, &block
+      error = defined?(RSpec::Matchers::BuiltIn::RaiseError::UndefinedValue) ? RSpec::Matchers::BuiltIn::RaiseError::UndefinedValue : nil, message = nil, &
     )
-      RaiseError.new(error, message, &block)
+      RaiseError.new(error, message, &)
     end
   end
 end

data/lib/rspec-puppet/matchers/run.rb

@@ -143,7 +143,7 @@ module RSpec::Puppet
 
       def failure_message_generic(type, _func_obj)
         # message is mutable
-        message = +"expected #{func_name}(#{func_params}) to "
+        message = "expected #{func_name}(#{func_params}) to "
         message << 'not ' if type == :should_not
 
         if @has_expected_return

data/lib/rspec-puppet/monkey_patches/windows/taskschedulerconstants.rb

@@ -5,7 +5,7 @@ module RSpec
     module Windows
       module TaskSchedulerConstants
         SYSTEM_USERS = ['NT AUTHORITY\SYSTEM', 'SYSTEM', 'NT AUTHORITY\LOCALSERVICE', 'NT AUTHORITY\NETWORKSERVICE',
-                        'BUILTIN\USERS', 'USERS'].freeze
+                        'BUILTIN\USERS', 'USERS',].freeze
 
         # Triggers
 
@@ -221,7 +221,7 @@ module RSpec
         CLSCTX_INPROC_SERVER = 0x1
         CLSID_CTask = [0x148BD520, 0xA2AB, 0x11CE, 0xB1, 0x1F, 0x00, 0xAA, 0x00, 0x53, 0x05, 0x03].pack('LSSC8')
         CLSID_CTaskScheduler = [0x148BD52A, 0xA2AB, 0x11CE, 0xB1, 0x1F, 0x00, 0xAA, 0x00, 0x53, 0x05,
-                                0x03].pack('LSSC8')
+                                0x03,].pack('LSSC8')
         IID_ITaskScheduler = [0x148BD527, 0xA2AB, 0x11CE, 0xB1, 0x1F, 0x00, 0xAA, 0x00, 0x53, 0x05, 0x03].pack('LSSC8')
         IID_ITask = [0x148BD524, 0xA2AB, 0x11CE, 0xB1, 0x1F, 0x00, 0xAA, 0x00, 0x53, 0x05, 0x03].pack('LSSC8')
         IID_IPersistFile = [0x0000010b, 0x0000, 0x0000, 0xC0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x46].pack('LSSC8')

data/lib/rspec-puppet/monkey_patches.rb

@@ -175,7 +175,7 @@ module Puppet
       module_function :windows?
 
       def actual_platform
-        @actual_platform ||= !!File::ALT_SEPARATOR ? :windows : :posix
+        @actual_platform ||= (!!File::ALT_SEPARATOR) ? :windows : :posix
       end
       module_function :actual_platform
 
@@ -366,7 +366,7 @@ end
 # defined. This check only makes sense when applying the catalogue to a host
 # and so can be safely stubbed out for unit testing.
 Puppet::Type.type(:file).provide(:windows).class_eval do
-  old_supports_acl = instance_method(:supports_acl?) if respond_to?(:supports_acl?)
+  instance_method(:supports_acl?) if respond_to?(:supports_acl?)
 
   def supports_acl?(_path)
     if RSpec::Puppet.rspec_puppet_example?
@@ -376,7 +376,7 @@ Puppet::Type.type(:file).provide(:windows).class_eval do
     end
   end
 
-  old_manages_symlinks = instance_method(:manages_symlinks?) if respond_to?(:manages_symlinks?)
+  instance_method(:manages_symlinks?) if respond_to?(:manages_symlinks?)
 
   def manages_symlinks?
     if RSpec::Puppet.rspec_puppet_example?
@@ -394,7 +394,7 @@ module Kernel
   alias old_require require
   def require(path)
     return if ['puppet/util/windows',
-               'win32/registry'].include?(path) && RSpec::Puppet.rspec_puppet_example? && Puppet::Util::Platform.pretend_windows?
+               'win32/registry',].include?(path) && RSpec::Puppet.rspec_puppet_example? && Puppet::Util::Platform.pretend_windows?
 
     old_require(path)
   end

data/lib/rspec-puppet/sensitive.rb

@@ -24,6 +24,11 @@ module RSpec::Puppet
       "Sensitive(#{@value.inspect})"
     end
 
+    # @return the unwrapped value (needed to show diff)
+    def to_s
+      inspect
+    end
+
     # Check for equality with another value.
     # If compared to Puppet Sensitive type, it compares the wrapped values.
 

data/lib/rspec-puppet/setup.rb

@@ -55,7 +55,7 @@ module RSpec::Puppet
         File.join('spec', 'hosts'),
         File.join('spec', 'fixtures'),
         File.join('spec', 'fixtures', 'manifests'),
-        File.join('spec', 'fixtures', 'modules')
+        File.join('spec', 'fixtures', 'modules'),
       ].each { |dir| safe_mkdir(dir, verbose) }
 
       target = File.join('spec', 'fixtures', 'modules', module_name)

data/lib/rspec-puppet/support.rb

@@ -102,11 +102,11 @@ module RSpec::Puppet
           trusted_external_data: trusted_external_data_hash,
           ignored_cache_params: {
             hiera_data_value: hiera_data_value,
-            rspec_config_values: rspec_config_values
-          }
+            rspec_config_values: rspec_config_values,
+          },
         )
 
-        test_module = type == :host ? nil : class_name.split('::').first
+        test_module = (type == :host) ? nil : class_name.split('::').first
         if type == :define
           RSpec::Puppet::Coverage.add_filter(class_name, title)
         else
@@ -128,7 +128,7 @@ module RSpec::Puppet
         File.read(path)
       elsif File.directory?(path)
         # Read and concatenate all .pp files.
-        Dir[File.join(path, '*.pp')].sort.map do |f|
+        Dir[File.join(path, '*.pp')].map do |f|
           File.read(f)
         end.join("\n")
       else
@@ -205,14 +205,14 @@ module RSpec::Puppet
     def facts_hash(node)
       base_facts = {
         'clientversion' => Puppet::PUPPETVERSION,
-        'environment' => environment.to_s
+        'environment' => environment.to_s,
       }
 
       node_facts = {
         'hostname' => node.split('.').first,
         'fqdn' => node,
         'domain' => node.split('.', 2).last,
-        'clientcert' => node
+        'clientcert' => node,
       }
 
       # Puppet 6.9.0 started setting a `serverip6` server fact which is set
@@ -220,14 +220,12 @@ module RSpec::Puppet
       # by FacterDB don't have an `ipaddress6` fact set, then the normal Facter
       # fact will be resolved, which can result in Ruby trying to load Windows
       # only gems on Linux. This is only a problem if facter is used.
-      if RSpec.configuration.facter_implementation.to_sym == :facter
-        node_facts['ipaddress6'] = 'FE80:0000:0000:0000:AAAA:AAAA:AAAA'
-      end
+      node_facts['ipaddress6'] = 'FE80:0000:0000:0000:AAAA:AAAA:AAAA' if RSpec.configuration.facter_implementation.to_sym == :facter
 
       networking_facts = {
         'hostname' => node_facts['hostname'],
         'fqdn' => node_facts['fqdn'],
-        'domain' => node_facts['domain']
+        'domain' => node_facts['domain'],
       }
 
       result_facts = if RSpec.configuration.default_facts.any?
@@ -275,9 +273,7 @@ module RSpec::Puppet
     def trusted_facts_hash(_node_name)
       extensions = {}
 
-      if RSpec.configuration.default_trusted_facts.any?
-        extensions.merge!(munge_facts(RSpec.configuration.default_trusted_facts))
-      end
+      extensions.merge!(munge_facts(RSpec.configuration.default_trusted_facts)) if RSpec.configuration.default_trusted_facts.any?
 
       extensions.merge!(munge_facts(trusted_facts)) if respond_to?(:trusted_facts)
       extensions
@@ -286,9 +282,7 @@ module RSpec::Puppet
     def trusted_external_data_hash
       external_data = {}
 
-      if RSpec.configuration.default_trusted_external_data.any?
-        external_data.merge!(munge_facts(RSpec.configuration.default_trusted_external_data))
-      end
+      external_data.merge!(munge_facts(RSpec.configuration.default_trusted_external_data)) if RSpec.configuration.default_trusted_external_data.any?
 
       external_data.merge!(munge_facts(trusted_external_data)) if respond_to?(:trusted_external_data)
       external_data
@@ -301,8 +295,7 @@ module RSpec::Puppet
       server_facts['serverversion'] = Puppet.version.to_s
 
       # And then add the server name and IP
-      { 'servername' => 'fqdn',
-        'serverip' => 'ipaddress' }.each do |var, fact|
+      { 'servername' => 'networking.fqdn', 'serverip' => 'networking.ip' }.each do |var, fact|
         if (value = Puppet.runtime[:facter].value(fact))
           server_facts[var] = value
         else
@@ -311,8 +304,8 @@ module RSpec::Puppet
       end
 
       if server_facts['servername'].nil?
-        host = Puppet.runtime[:facter].value(:hostname)
-        server_facts['servername'] = if (domain = Puppet.runtime[:facter].value(:domain))
+        host = Puppet.runtime[:facter].value('networking.hostname')
+        server_facts['servername'] = if (domain = Puppet.runtime[:facter].value('networking.domain'))
                                        [host, domain].join('.')
                                      else
                                        host
@@ -382,7 +375,7 @@ module RSpec::Puppet
                                        code: code,
                                        exported: exported,
                                        node_params: node_params,
-                                       trusted_external: {}
+                                       trusted_external: {},
                                      })
     end
 
@@ -422,9 +415,9 @@ module RSpec::Puppet
       trusted_info.push(trusted_external_data)
       Puppet.push_context(
         {
-          trusted_information: Puppet::Context::TrustedInformation.new(*trusted_info)
+          trusted_information: Puppet::Context::TrustedInformation.new(*trusted_info),
         },
-        'Context for spec trusted hash'
+        'Context for spec trusted hash',
       )
 
       node_obj.add_server_facts(server_facts_hash)
@@ -477,9 +470,7 @@ module RSpec::Puppet
           Find.prune if %w[modules work-dir].any? do |dir|
             file.relative_path_from(path).to_s.start_with?("spec/fixtures/#{dir}")
           end
-          if file.basename.to_s.eql?(Puppet::Pops::Lookup::HieraConfig::CONFIG_FILE_NAME)
-            return @@fixture_hiera_configs[mod.name] = file.to_s
-          end
+          return @@fixture_hiera_configs[mod.name] = file.to_s if file.basename.to_s.eql?(Puppet::Pops::Lookup::HieraConfig::CONFIG_FILE_NAME)
         end
       end
       @@fixture_hiera_configs[mod.name]

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

@@ -19,7 +19,7 @@ task :release_test do
     'garethr/garethr-docker',
     'sensu/sensu-puppet',
     'jenkinsci/puppet-jenkins',
-    'rnelson0/puppet-local_user'
+    'rnelson0/puppet-local_user',
   ]
 
   Bundler.with_clean_env do

data/lib/rspec-puppet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RSpecPuppet
-  VERSION = '4.0.2'
+  VERSION = '5.0.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-puppet
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 5.0.1
 platform: ruby
 authors:
 - Tim Sharpe
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-05 00:00:00.000000000 Z
+date: 2026-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -26,6 +26,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: voxpupuli-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 description: "    RSpec tests for your Puppet manifests.\n"
 email:
 - tim@sharpe.id.au
@@ -36,6 +50,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
+- LICENSE
 - README.md
 - bin/rspec-puppet-init
 - lib/rspec-puppet.rb
@@ -80,8 +95,7 @@ files:
 homepage: https://github.com/puppetlabs/rspec-puppet/
 licenses:
 - MIT
-metadata:
-  rubygems_mfa_required: 'true'
+metadata: {}
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -90,14 +104,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: RSpec tests for your Puppet manifests