rspec-puppet 2.8.0 → 2.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 375cf91b75c36ee1bc0bbade72608205a7b85fce94a49d0fcfafb02fa6f8eddc
-  data.tar.gz: 732ce59e27a5fd9d15052262d21b2de6df85b090fb56152aca88da4480133ac1
+  metadata.gz: 841a21438e7d3927a8f136334b6ad6a189b1efa8e144eac94a55675d1a106cd1
+  data.tar.gz: fa95877eeb75e96db41ffc7025cc316de449884f7c1711d8ea0d5d6ae37d34d3
 SHA512:
-  metadata.gz: 3f1b0bb5c052df4ff70981384ad81bdc2e75ec1f23f9a890f101a933a4f7f50d569acef001524c7c3a9f37f0cfffd2eeaf0a26a7d67f8a3abd80b7147005e758
-  data.tar.gz: 65f0fbe718948c13b1866bb8d71c6b03fe741927ed86e97d6eeefb39526e98671e3ac5ae98e14e939654988fa8c272b3e72f66c5b61e9c6321fac11d5b66e276
+  metadata.gz: 51981b62e91d5fe7be774b715215965216b118c87ef2d6f79e941dcfe961e113e38dec4adc88ddd6e042d7efdb3c333e493dc779c3bea842bd163d1d7f711c76
+  data.tar.gz: f0297af0f3738a0fc0ba1c8f69e18951839f46e70d5f4132c9d414b71f1ead89632a9a0aa8a0ef277cb06ccd530777564bd2cd4e68ab22d21f98bb32ab8b5c15

data/CHANGELOG.md

@@ -2,13 +2,37 @@
 All notable changes to this project will be documented in this file. This
 project adheres to [Semantic Versioning](http://semver.org/).
 
+## [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
+
+### Added
+* Add ruby 3 support ([GH-11](https://github.com/puppetlabs/rspec-puppet/pull/11))
+
+## [2.9.0]
+
+### Added
+ * Allow users to disable app_management for Puppet 4
+ * Added support for regexp arguments to Sensitive
+ * Handle all auto*, not just autorequire
+ * Set up loaders so that 4.x functions resolve properly
+
 ## [2.8.0]
 
 ### Breaking Changes
  * As of the 2.8.0 release, the `rspec-puppet` project no longer guarantees compatibility
    with Puppet 2.x or 3.x (running under Ruby 1.8.7) or Puppet 4.x (running under Ruby 1.9.3).
- * This release adds support for the [`Sensitive`](https://puppet.com/docs/puppet/latest/lang_data_sensitive.html) 
-   data type, however existing tests that were expecting `String` content may need to be updated 
+ * This release adds support for the [`Sensitive`](https://puppet.com/docs/puppet/latest/lang_data_sensitive.html)
+   data type, however existing tests that were expecting `String` content may need to be updated
    to wrap the expected value in the new `sensitive` helper:
 
    ```ruby
@@ -20,20 +44,20 @@ project adheres to [Semantic Versioning](http://semver.org/).
    ```
 
 ### Added
- * Added support for [trusted external fact data](https://github.com/rodjek/rspec-puppet#specifying-trusted-external-data).
- * Added the ability to exclude resources from the coverage report calculations using a regular expression. 
+ * Added support for [trusted external fact data](https://github.com/puppetlabs/rspec-puppet#specifying-trusted-external-data).
+ * Added the ability to exclude resources from the coverage report calculations using a regular expression.
    (See [documentation](https://rspec-puppet.com/documentation/coverage/#excluded-resources) for an example.
- * Added `have_unique_values_for_all` matcher to assert a specific resource parameter value is unique across 
-   the entire catalogue. 
+ * Added `have_unique_values_for_all` matcher to assert a specific resource parameter value is unique across
+   the entire catalogue.
    (See [documentation](https://rspec-puppet.com/documentation/classes/#test-resource-parameter-values-for-uniqueness).)
- * Added ability to customize module-layer Hiera configuration via new settings. See 
+ * Added ability to customize module-layer Hiera configuration via new settings. See
    [documentation](https://rspec-puppet.com/documentation/configuration/#disable_module_hiera) for details.
 
 ### Changed
  * `RSpec::Puppet::Cache` now evicts least recently used entries when it reaches max size.
- * `rspec-puppet`'s implementation of `match_manifests` will no longer look in `init.pp` for class 
+ * `rspec-puppet`'s implementation of `match_manifests` will no longer look in `init.pp` for class
    declarations if a manifest file exactly matching the class name exists.
- 
+
 ### Fixed
  * Resolved compatibility issues with Ruby 2.7.x and added Ruby 2.7.x to the test matrix.
  * Resolved issues calculating coverage and reporting results when there are 0 tested resources.
@@ -546,13 +570,45 @@ 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/rodjek/rspec-puppet/compare/v2.5.0...master
-[2.5.0]: https://github.com/rodjek/rspec-puppet/compare/v2.4.0...v2.5.0
-[2.4.0]: https://github.com/rodjek/rspec-puppet/compare/v2.3.2...v2.4.0
-[2.3.2]: https://github.com/rodjek/rspec-puppet/compare/v2.3.1...v2.3.2
-[2.3.1]: https://github.com/rodjek/rspec-puppet/compare/v2.3.0...v2.3.1
-[2.3.0]: https://github.com/rodjek/rspec-puppet/compare/v2.2.0...v2.3.0
-[2.2.0]: https://github.com/rodjek/rspec-puppet/compare/v2.1.0...v2.2.0
-[2.1.0]: https://github.com/rodjek/rspec-puppet/compare/v2.0.1...v2.1.0
-[2.0.1]: https://github.com/rodjek/rspec-puppet/compare/v2.0.0...v2.0.1
-[2.0.0]: https://github.com/rodjek/rspec-puppet/compare/v1.0.1...v2.0.0
+[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
+[2.7.10]: https://github.com/puppetlabs/rspec-puppet/compare/v2.7.9...v2.7.10
+[2.7.9]: https://github.com/puppetlabs/rspec-puppet/compare/v2.7.8...v2.7.9
+[2.7.8]: https://github.com/puppetlabs/rspec-puppet/compare/v2.7.7...v2.7.8
+[2.7.7]: https://github.com/puppetlabs/rspec-puppet/compare/v2.7.6...v2.7.7
+[2.7.6]: https://github.com/puppetlabs/rspec-puppet/compare/v2.7.5...v2.7.6
+[2.7.5]: https://github.com/puppetlabs/rspec-puppet/compare/v2.7.4...v2.7.5
+[2.7.4]: https://github.com/puppetlabs/rspec-puppet/compare/v2.7.3...v2.7.4
+[2.7.3]: https://github.com/puppetlabs/rspec-puppet/compare/v2.7.2...v2.7.3
+[2.7.2]: https://github.com/puppetlabs/rspec-puppet/compare/v2.7.1...v2.7.2
+[2.7.1]: https://github.com/puppetlabs/rspec-puppet/compare/v2.7.0...v2.7.1
+[2.7.0]: https://github.com/puppetlabs/rspec-puppet/compare/v2.6.15...v2.7.0
+[2.6.15]: https://github.com/puppetlabs/rspec-puppet/compare/v2.6.14...v2.6.15
+[2.6.14]: https://github.com/puppetlabs/rspec-puppet/compare/v2.6.13...v2.6.14
+[2.6.13]: https://github.com/puppetlabs/rspec-puppet/compare/v2.6.12...v2.6.13
+[2.6.12]: https://github.com/puppetlabs/rspec-puppet/compare/v2.6.11...v2.6.12
+[2.6.11]: https://github.com/puppetlabs/rspec-puppet/compare/v2.6.10...v2.6.11
+[2.6.10]: https://github.com/puppetlabs/rspec-puppet/compare/v2.6.9...v2.6.10
+[2.6.9]: https://github.com/puppetlabs/rspec-puppet/compare/v2.6.8...v2.6.9
+[2.6.8]: https://github.com/puppetlabs/rspec-puppet/compare/v2.6.7...v2.6.8
+[2.6.7]: https://github.com/puppetlabs/rspec-puppet/compare/v2.6.6...v2.6.7
+[2.6.6]: https://github.com/puppetlabs/rspec-puppet/compare/v2.6.5...v2.6.6
+[2.6.5]: https://github.com/puppetlabs/rspec-puppet/compare/v2.6.4...v2.6.5
+[2.6.4]: https://github.com/puppetlabs/rspec-puppet/compare/v2.6.3...v2.6.4
+[2.6.3]: https://github.com/puppetlabs/rspec-puppet/compare/v2.6.2...v2.6.3
+[2.6.2]: https://github.com/puppetlabs/rspec-puppet/compare/v2.6.1...v2.6.2
+[2.6.1]: https://github.com/puppetlabs/rspec-puppet/compare/v2.6.0...v2.6.1
+[2.6.0]: https://github.com/puppetlabs/rspec-puppet/compare/2.5.0...v2.6.0
+[2.5.0]: https://github.com/puppetlabs/rspec-puppet/compare/v2.4.0...v2.5.0
+[2.4.0]: https://github.com/puppetlabs/rspec-puppet/compare/v2.3.2...v2.4.0
+[2.3.2]: https://github.com/puppetlabs/rspec-puppet/compare/v2.3.1...v2.3.2
+[2.3.1]: https://github.com/puppetlabs/rspec-puppet/compare/v2.3.0...v2.3.1
+[2.3.0]: https://github.com/puppetlabs/rspec-puppet/compare/v2.2.0...v2.3.0
+[2.2.0]: https://github.com/puppetlabs/rspec-puppet/compare/v2.1.0...v2.2.0
+[2.1.0]: https://github.com/puppetlabs/rspec-puppet/compare/v2.0.1...v2.1.0
+[2.0.1]: https://github.com/puppetlabs/rspec-puppet/compare/v2.0.0...v2.0.1
+[2.0.0]: https://github.com/puppetlabs/rspec-puppet/compare/v1.0.1...v2.0.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
 
@@ -139,7 +156,8 @@ module RSpec::Puppet
         Puppet.push_context(
           {
             :environments => loader,
-            :current_environment => env
+            :current_environment => env,
+            :loaders => (Puppet::Pops::Loaders.new(env) if Gem::Version.new(Puppet.version) >= Gem::Version.new('6.0.0')),
           },
           "Setup rspec-puppet environments"
         )
@@ -185,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]
@@ -193,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/count_generic.rb

@@ -7,13 +7,15 @@ module RSpec::Puppet
         'Stage[main]',
       ].freeze
 
+      attr_reader :resource_type
+
       def initialize(type, count, *method)
         if type.nil?
           @type = method[0].to_s.gsub(/^have_(.+)_resource_count$/, '\1')
         else
           @type = type
         end
-        @referenced_type = referenced_type(@type)
+        @resource_type = referenced_type(@type)
         @expected_number = count.to_i
       end
 
@@ -30,7 +32,7 @@ module RSpec::Puppet
                            end
                          else
                            resources.count do |res|
-                             res.type == @referenced_type
+                             res.type == @resource_type
                            end
                          end
 
@@ -45,7 +47,7 @@ module RSpec::Puppet
           desc << "#{@expected_number == 1 ? "class" : "classes" }"
         else
           unless @type == "resource"
-            desc << "#{@referenced_type}"
+            desc << "#{@resource_type}"
           end
           desc << "#{@expected_number == 1 ? "resource" : "resources" }"
         end

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

@@ -307,14 +307,17 @@ module RSpec::Puppet
           end
         end
 
-        # Add autorequires if any
-        if type == :require and resource.resource_type.respond_to? :eachautorequire
-          resource.resource_type.eachautorequire do |t, b|
-            Array(resource.to_ral.instance_eval(&b)).each do |dep|
-              res = "#{t.to_s.capitalize}[#{dep}]"
-              if r = relationship_refs(res, type, visited)
-                results << res
-                results << r
+        # Add auto* (autorequire etc) if any
+        if [:before, :notify, :require, :subscribe].include?(type)
+          func = "eachauto#{type}".to_sym
+          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|
+                res = "#{t.to_s.capitalize}[#{dep}]"
+                if r = relationship_refs(res, type, visited)
+                  results << res
+                  results << r
+                end
               end
             end
           end

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

@@ -4,7 +4,7 @@ module RSpec::Puppet
 
     matcher :include_class do |expected_class|
       match do |catalogue|
-        RSpec.deprecate(:include_class, :replacement => :contain_class)
+        RSpec.deprecate('include_class()', :replacement => 'contain_class()')
         catalogue.call.classes.include?(expected_class)
       end
 

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

@@ -52,9 +52,6 @@ module RSpec::Puppet
         self
       end
 
-      #def with_autorequires(autorequires))
-      #end
-
       #
       # this is the method that drives all of the validation
       #

data/lib/rspec-puppet/sensitive.rb

@@ -29,7 +29,11 @@ module RSpec::Puppet
       # @param other [#unwrap, Object] value to compare to
       def == other
         if other.respond_to? :unwrap
-          return unwrap == other.unwrap
+          if unwrap.kind_of?(Regexp)
+            return unwrap =~ other.unwrap
+          else
+            return unwrap == other.unwrap
+          end
         else
           super
         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
@@ -392,7 +392,7 @@ module RSpec::Puppet
 
       # Enable app_management by default for Puppet versions that support it
       if Puppet::Util::Package.versioncmp(Puppet.version, '4.3.0') >= 0 && Puppet.version.to_i < 5
-        Puppet[:app_management] = true
+        Puppet[:app_management] = ENV.include?('PUPPET_NOAPP_MANAGMENT') ? false : true
       end
 
       adapter.modulepath.map do |d|
@@ -478,14 +478,14 @@ 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)
       @@cache.get(*args) do |*args|
         if args.length == 1 && args.first.is_a?(Hash)
-          build_catalog_without_cache_v2(args.first)
+          build_catalog_without_cache_v2(**args.first)
         else
           build_catalog_without_cache(*args)
         end

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,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: rspec-puppet
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.11.1
 platform: ruby
 authors:
 - Tim Sharpe
-autorequire: 
+- Puppet, Inc.
+- Community Contributors
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-05 00:00:00.000000000 Z
+date: 2021-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -25,7 +27,9 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: RSpec tests for your Puppet manifests
-email: tim@sharpe.id.au
+email:
+- tim@sharpe.id.au
+- modules-team@puppet.com
 executables:
 - rspec-puppet-init
 extensions: []
@@ -49,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
@@ -72,11 +77,11 @@ files:
 - lib/rspec-puppet/spec_helper.rb
 - lib/rspec-puppet/support.rb
 - lib/rspec-puppet/tasks/release_test.rb
-homepage: https://github.com/rodjek/rspec-puppet/
+homepage: https://github.com/puppetlabs/rspec-puppet/
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -91,8 +96,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: RSpec tests for your Puppet manifests
 test_files: []