rspec-puppet 2.10.0 → 2.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5080461a94379bc7c865bed5eaa5584f911379ea08bdf7af878ffd24ff23424c
-  data.tar.gz: eac73ffab8b13a3ded43d3533c4c454a168d61511f8b73bea4fb94227232cb66
+  metadata.gz: c0983cc8fe444bc2035b1e58df39027ab7589cbeae175ace159a384dea8ef2cf
+  data.tar.gz: 8d91008e48102d7053911236a0173daa8daf64e94274a5f6046a45656770c8fa
 SHA512:
-  metadata.gz: 7b5c1d81b22bca79e3b5c7edde653396d7cbc3506c66d60d69be618066fcdbe75782b29adffe35f89046dafcb3b7db2faec5b30a25eb6b57f5d91d1e12631bf8
-  data.tar.gz: 35833aa537d9f12c11131108bd2f664e74e0ea47f8d8c7029efd9a86c2b344c2ea3a9dfe10dca91eb96efe2128ba748320b805ea4778ed72b8578cda7069c634
+  metadata.gz: 5c2a790b3d4e4f7dc14dce67ba3c1e2c635534962acfa8523390aa2b07389c216c7ffb1cbddccd5ebd0e627372267dad4f07c59293e5fd36ce3d659b9d0c35bd
+  data.tar.gz: 7c9d11d0c5047af4ad2dd7a7743c2e5ff341257f9f2036beabd4b23a88294bf22e8d7e282f1a95cef230a66e7b6e5e5f2c429fb95a265116dd341bc38698aaa7

data/CHANGELOG.md

@@ -2,6 +2,22 @@
 All notable changes to this project will be documented in this file. This
 project adheres to [Semantic Versioning](http://semver.org/).
 
+## [2.12.0]
+
+### Added
+* Handle nil autorequire results ([#22](https://github.com/puppetlabs/rspec-puppet/pull/22))
+* Add the ability to use kind_of matchers ([#24](https://github.com/puppetlabs/rspec-puppet/pull/24))
+
+## [2.11.1]
+
+### Fixed
+* Ensure FacterImpl consistency between example groups ([#19](https://github.com/puppetlabs/rspec-puppet/pull/19))
+
+## [2.11.0]
+
+### Added
+* Add setting to use custom Facter implementation ([GH-16](https://github.com/puppetlabs/rspec-puppet/pull/16))
+
 ## [2.10.0]
 The release sees rspec-puppet move into the puppetlabs namespace
 
@@ -560,7 +576,9 @@ Thanks to Adrien Thebo, Alex Harvey, Brian, Dan Bode, Dominic Cleal, Javier Pala
 ## 1.0.1 and earlier
 For changelog of versions 1.0.1 and earlier, see http://rspec-puppet.com/changelog/
 
-[2.x]: https://github.com/puppetlabs/rspec-puppet/compare/v2.10.0...master
+[2.x]: https://github.com/puppetlabs/rspec-puppet/compare/v2.11.1...master
+[2.11.1]: https://github.com/puppetlabs/rspec-puppet/compare/v2.11.0..v2.11.1
+[2.11.0]: https://github.com/puppetlabs/rspec-puppet/compare/v2.10.0...v2.11.0
 [2.10.0]: https://github.com/puppetlabs/rspec-puppet/compare/v2.9.0...v2.10.0
 [2.9.0]: https://github.com/puppetlabs/rspec-puppet/compare/v2.8.0...v2.9.0
 [2.8.0]: https://github.com/puppetlabs/rspec-puppet/compare/v2.7.10...v2.8.0

data/README.md

@@ -230,6 +230,20 @@ In some circumstances (e.g. where your nodename/certname is not the same as
 your FQDN), this behaviour is undesirable and can be disabled by changing this
 setting to `false`.
 
+#### facter\_implementation
+Type    | Default  | Puppet Version(s)
+------- | -------- | -----------------
+String  | `facter` | 6.25+, 7.12+
+
+Configures rspec-puppet to use a specific Facter implementation for running
+unit tests. If the `rspec` implementation is set and Puppet does not support
+it, rspec-puppet will warn and fall back to the `facter` implementation.
+Setting an unsupported option will make rspec-puppet raise an error.
+
+ * `facter` - Use the default implementation, honoring the Facter version specified in the Gemfile
+ * `rspec` - Use a custom hash-based implementation of Facter defined in
+   rspec-puppet (this provides a considerable gain in speed if tests are run with Facter 4)
+
 ## Naming conventions
 
 For clarity and consistency, I recommend that you use the following directory

data/lib/rspec-puppet/adapters.rb

@@ -1,3 +1,5 @@
+require 'rspec-puppet/facter_impl'
+
 module RSpec::Puppet
   module Adapters
 
@@ -108,6 +110,21 @@ module RSpec::Puppet
     end
 
     class Adapter40 < Base
+      #
+      # @api private
+      #
+      # Set the FacterImpl constant to the given Facter implementation or noop
+      # if the constant is already set. If a proc is given, it will only be
+      # called if FacterImpl is not defined.
+      #
+      # @param impl [Object, Proc] An object or a proc that implements the Facter API
+      def set_facter_impl(impl)
+        return if defined?(FacterImpl)
+
+        impl = impl.call if impl.is_a?(Proc)
+        Object.send(:const_set, :FacterImpl, impl)
+      end
+
       def setup_puppet(example_group)
         super
 
@@ -186,6 +203,12 @@ module RSpec::Puppet
     end
 
     class Adapter4X < Adapter40
+      def setup_puppet(example_group)
+        super
+
+        set_facter_impl(Facter)
+      end
+
       def settings_map
         super.concat([
           [:trusted_server_facts, :trusted_server_facts]
@@ -194,6 +217,48 @@ module RSpec::Puppet
     end
 
     class Adapter6X < Adapter40
+      #
+      # @api private
+      #
+      # Check to see if Facter runtime implementations are supported in the
+      # current Puppet version
+      #
+      # @return [Boolean] true if runtime implementations are supported
+      def supports_facter_runtime?
+        unless defined?(@supports_facter_runtime)
+          begin
+            Puppet.runtime[:facter]
+            @supports_facter_runtime = true
+          rescue
+            @supports_facter_runtime = false
+          end
+        end
+
+        @supports_facter_runtime
+      end
+
+      def setup_puppet(example_group)
+        case RSpec.configuration.facter_implementation.to_sym
+        when :rspec
+          if supports_facter_runtime?
+            # Lazily instantiate FacterTestImpl here to optimize memory
+            # allocation, as the proc will only be called if FacterImpl is unset
+            set_facter_impl(proc { RSpec::Puppet::FacterTestImpl.new })
+            Puppet.runtime[:facter] = FacterImpl
+          else
+            warn "Facter runtime implementations are not supported in Puppet #{Puppet.version}, continuing with facter_implementation 'facter'"
+            RSpec.configuration.facter_implementation = :facter
+            set_facter_impl(Facter)
+          end
+        when :facter
+          set_facter_impl(Facter)
+        else
+          raise "Unsupported facter_implementation '#{RSpec.configuration.facter_implementation}'"
+        end
+
+        super
+      end
+
       def settings_map
         super.concat([
           [:basemodulepath, :basemodulepath],

data/lib/rspec-puppet/facter_impl.rb

@@ -0,0 +1,49 @@
+module RSpec::Puppet
+
+  # Implements a simple hash-based version of Facter to be used in module tests
+  # that use rspec-puppet.
+  class FacterTestImpl
+    def initialize
+      @facts = {}
+    end
+
+    def value(fact_name)
+      @facts[fact_name.to_s]
+    end
+
+    def clear
+      @facts.clear
+    end
+
+    def to_hash
+      @facts
+    end
+
+    def add(name, options = {}, &block)
+      raise 'Facter.add expects a block' unless block_given?
+      @facts[name.to_s] = instance_eval(&block)
+    end
+
+    # noop methods
+    def debugging(arg); end
+
+    def reset; end
+
+    def search(*paths); end
+
+    def setup_logging; end
+
+    private
+
+    def setcode(string = nil, &block)
+      if block_given?
+        value = block.call
+      else
+        value = string
+      end
+
+      value
+    end
+  end
+end
+

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

@@ -313,6 +313,8 @@ module RSpec::Puppet
           if resource.resource_type.respond_to?(func)
             resource.resource_type.send(func) do |t, b|
               Array(resource.to_ral.instance_eval(&b)).each do |dep|
+                next if dep.nil?
+
                 res = "#{t.to_s.capitalize}[#{dep}]"
                 if r = relationship_refs(res, type, visited)
                   results << res

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

@@ -35,6 +35,8 @@ module RSpec::Puppet
             case @expected_return
             when Regexp
               return !!(@actual_return =~ @expected_return)
+            when RSpec::Mocks::ArgumentMatchers::KindOf, RSpec::Matchers::AliasedMatcher
+              return @expected_return === @actual_return
             else
               return @actual_return == @expected_return
             end

data/lib/rspec-puppet/support.rb

@@ -337,7 +337,7 @@ module RSpec::Puppet
       {"servername" => "fqdn",
         "serverip" => "ipaddress"
       }.each do |var, fact|
-        if value = Facter.value(fact)
+        if value = FacterImpl.value(fact)
           server_facts[var] = value
         else
           warn "Could not retrieve fact #{fact}"
@@ -345,8 +345,8 @@ module RSpec::Puppet
       end
 
       if server_facts["servername"].nil?
-        host = Facter.value(:hostname)
-        if domain = Facter.value(:domain)
+        host = FacterImpl.value(:hostname)
+        if domain = FacterImpl.value(:domain)
           server_facts["servername"] = [host, domain].join(".")
         else
           server_facts["servername"] = host
@@ -478,8 +478,8 @@ module RSpec::Puppet
 
     def stub_facts!(facts)
       Puppet.settings[:autosign] = false if Puppet.settings.include? :autosign
-      Facter.clear
-      facts.each { |k, v| Facter.add(k, :weight => 999) { setcode { v } } }
+      FacterImpl.clear
+      facts.each { |k, v| FacterImpl.add(k, :weight => 999) { setcode { v } } }
     end
 
     def build_catalog(*args)

data/lib/rspec-puppet.rb

@@ -43,6 +43,7 @@ RSpec.configure do |c|
   c.add_setting :default_node_params, :default => {}
   c.add_setting :default_trusted_facts, :default => {}
   c.add_setting :default_trusted_external_data, :default => {}
+  c.add_setting :facter_implementation, :default => :facter
   c.add_setting :hiera_config, :default => Puppet::Util::Platform.actually_windows? ? 'c:/nul/' : '/dev/null'
   c.add_setting :parser, :default => 'current'
   c.add_setting :trusted_node_data, :default => false

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-puppet
 version: !ruby/object:Gem::Version
-  version: 2.10.0
+  version: 2.12.0
 platform: ruby
 authors:
 - Tim Sharpe
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-02 00:00:00.000000000 Z
+date: 2022-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -53,6 +53,7 @@ files:
 - lib/rspec-puppet/example/provider_example_group.rb
 - lib/rspec-puppet/example/type_alias_example_group.rb
 - lib/rspec-puppet/example/type_example_group.rb
+- lib/rspec-puppet/facter_impl.rb
 - lib/rspec-puppet/matchers.rb
 - lib/rspec-puppet/matchers/allow_value.rb
 - lib/rspec-puppet/matchers/compile.rb
@@ -95,8 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.6.2
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: RSpec tests for your Puppet manifests