rspec-puppet 2.7.10 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38af21b6f0c4e9fcfeb90c063d299c725fd80d63e6d74b44d0a6e6f937f6d955
-  data.tar.gz: 977523988ad9525e31c461040c33894e1cbd79c9180252f9521f8b8172ac111b
+  metadata.gz: 7a8f890c54b412a4d326895c3c3cd0ecae65f915049c69b9cb75c0a5c2811365
+  data.tar.gz: 39407acdeb509d98797e23cdcb7e71c378d89186039538fba4cc25c6c1eb0bf1
 SHA512:
-  metadata.gz: e8145ad0c55a4c52f7032f67ea2f73dc7fb72f162c32214e8b3e5aa5bd69efe1bd0ded6c2e36cff165e2e8f51734e0f94017c74f07ad0ce3b1bbeca90463ad34
-  data.tar.gz: 149c839eb092309b0e3bb1be2c0887aed4dc0ebe8fb9ea2b4b5b562a797df8b39800486e24e181dc7d44abdddbe94bc9938978e0d5862e35fa73581203475545
+  metadata.gz: 1105e0778581b90855d2d43511b1016cd0193fb088c0b4fbe7bf8de4947e3043a6a005bf1894fed0ac9fbdf87b283b9075997f47c2530ba82038db9c23d43e2f
+  data.tar.gz: 719205730a4e0f4bd0b17378872e134de10eedf3e623f9584aaf85577665033ea36d393d5a3619a0b5eb9fd091530bc6071d394291d7d48094aad11d00836585

data/CHANGELOG.md

@@ -2,6 +2,62 @@
 All notable changes to this project will be documented in this file. This
 project adheres to [Semantic Versioning](http://semver.org/).
 
+## [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
+   to wrap the expected value in the new `sensitive` helper:
+
+   ```ruby
+   # Old
+   it { is_expected.to contain_file('/etc/mysecret.conf').with_content("top secret\n") }
+
+   # New
+   it { is_expected.to contain_file('/etc/mysecret.conf').with_content(sensitive("top secret\n")) }
+   ```
+
+### Added
+ * 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.
+   (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
+   [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
+   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.
+ * Resolved compatibility issue with `rspec-expectations` 3.10.0.
+
 ## [2.7.10]
 
 ### Fixed
@@ -509,13 +565,44 @@ 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.0...master
+[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

@@ -2,6 +2,20 @@
 [![Build Status](https://travis-ci.org/rodjek/rspec-puppet.svg?branch=master)](https://travis-ci.org/rodjek/rspec-puppet)
 [![Coverage Status](https://coveralls.io/repos/rodjek/rspec-puppet/badge.svg?branch=master)](https://coveralls.io/r/rodjek/rspec-puppet?branch=master)
 
+#### Table of Contents
+
+* [Installation](#installation)
+* [Starting out with a new module](#starting-out-with-a-new-module)
+* [Configure manifests for Puppet 4](#configure-manifests-for-puppet-4)
+* [Configuration](#configuration)
+* [Naming conventions](#naming-conventions)
+* [Example groups](#example-groups)
+* [Defined Types, Classes & Applications](#defined-types-classes--applications)
+* [Functions](#functions)
+* [Hiera integration](#hiera-integration)
+* [Producing coverage reports](#producing-coverage-reports)
+* [Related projects](#related-projects)
+
 ## Installation
 
     gem install rspec-puppet
@@ -216,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
@@ -759,6 +787,30 @@ RSpec.configure do |c|
 end
 ```
 
+#### Specifying trusted external data
+
+When testing with Puppet >= 6.14, the trusted facts hash will have an additional `external`
+key for trusted external data.
+
+By default, the test environment contains no trusted external data (as usually obtained from
+trusted external commands and found in the `external` key). If you need to test against specific
+trusted external data you can set those with a hash. The hash will then be available in
+`$trusted['external']`
+
+```ruby
+let(:trusted_external_data) { {'foo' => 'bar'} }
+```
+
+You can also create a set of default trusted external data provided to all specs in your spec_helper:
+
+```ruby
+RSpec.configure do |c|
+  c.default_trusted_external_data = {
+    'foo' => 'bar'
+  }
+end
+```
+
 #### Testing Exported Resources
 
 You can test if a resource was exported from the catalogue by using the

data/lib/rspec-puppet/adapters.rb

@@ -1,3 +1,5 @@
+require 'rspec-puppet/facter_impl'
+
 module RSpec::Puppet
   module Adapters
 
@@ -108,6 +110,17 @@ module RSpec::Puppet
     end
 
     class Adapter40 < Base
+      #
+      # @api private
+      #
+      # Set the FacterImpl constant to the given Facter implementation.
+      # The method noops if the constant is already set
+      #
+      # @param impl [Object]
+      def set_facter_impl(impl)
+        Object.send(:const_set, :FacterImpl, impl) unless defined? FacterImpl
+      end
+
       def setup_puppet(example_group)
         super
 
@@ -139,7 +152,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 +199,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 +213,46 @@ 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?
+            Puppet.runtime[:facter] = proc { RSpec::Puppet::FacterTestImpl.new }
+            set_facter_impl(Puppet.runtime[:facter])
+          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/cache.rb

@@ -11,12 +11,17 @@ module RSpec::Puppet
     end
 
     def get(*args, &blk)
-      # decouple the hash key from whatever the blk might do to it
       key = Marshal.load(Marshal.dump(args))
-      if !@cache.has_key? key
-        @cache[key] = (blk || @default_proc).call(*args)
-        @lra << key
+      if @cache.has_key?(key)
+        # Cache hit
+        # move that entry last to make it "most recenty used"
+        @lra.insert(-1, @lra.delete_at(@lra.index(args)))
+      else
+        # Cache miss
+        # Ensure room by evicting least recently used if no space left
         expire!
+        @cache[args] = (blk || @default_proc).call(*args)
+        @lra << args
       end
 
       @cache[key]
@@ -25,8 +30,8 @@ module RSpec::Puppet
     private
 
     def expire!
-      expired = @lra.slice!(0, @lra.size - MAX_ENTRIES)
-      expired.each { |key| @cache.delete(key) } if expired
+      # delete one entry (the oldest) when there is no room in cache
+      @cache.delete(@lra.shift) if @cache.size == MAX_ENTRIES
     end
   end
 end

data/lib/rspec-puppet/coverage.rb

@@ -17,13 +17,25 @@ end
 module RSpec::Puppet
   class Coverage
 
-    attr_accessor :filters
+    attr_accessor :filters, :filters_regex
 
     class << self
       extend Forwardable
-      def_delegators(:instance, :add, :cover!, :report!,
-                     :filters, :add_filter, :add_from_catalog,
-                     :results)
+
+      delegated_methods = [
+        :instance,
+        :add,
+        :cover!,
+        :report!,
+        :filters,
+        :filters_regex,
+        :add_filter,
+        :add_filter_regex,
+        :add_from_catalog,
+        :results,
+      ]
+
+      def_delegators(*delegated_methods)
 
       attr_writer :instance
 
@@ -35,6 +47,7 @@ module RSpec::Puppet
     def initialize
       @collection = {}
       @filters = ['Stage[main]', 'Class[Settings]', 'Class[main]', 'Node[default]']
+      @filters_regex = []
     end
 
     def save_results
@@ -42,6 +55,9 @@ module RSpec::Puppet
       File.open(File.join(Dir.tmpdir, "rspec-puppet-filter-#{slug}"), 'w+') do |f|
         f.puts @filters.to_json
       end
+      File.open(File.join(Dir.tmpdir, "rspec-puppet-filter_regex-#{slug}"), 'w+') do |f|
+        f.puts @filters_regex.to_json
+      end
       File.open(File.join(Dir.tmpdir, "rspec-puppet-coverage-#{slug}"), 'w+') do |f|
         f.puts @collection.to_json
       end
@@ -57,10 +73,17 @@ module RSpec::Puppet
 
     def merge_filters
       pattern = File.join(Dir.tmpdir, "rspec-puppet-filter-#{Digest::MD5.hexdigest(Dir.pwd)}-*")
+      regex_filter_pattern = File.join(Dir.tmpdir, "rspec-puppet-filter_regex-#{Digest::MD5.hexdigest(Dir.pwd)}-*")
+
       Dir[pattern].each do |result_file|
         load_filters(result_file)
         FileUtils.rm(result_file)
       end
+
+      Dir[regex_filter_pattern].each do |result_file|
+        load_filters_regex(result_file)
+        FileUtils.rm(result_file)
+      end
     end
 
     def load_results(path)
@@ -79,6 +102,15 @@ module RSpec::Puppet
       end
     end
 
+    def load_filters_regex(path)
+      saved_regex_filters = JSON.parse(File.read(path))
+      saved_regex_filters.each do |pattern|
+        regex = Regexp.new(pattern)
+        @filters_regex << regex
+        @collection.delete_if { |resource, _| resource =~ regex }
+      end
+    end
+
     def add(resource)
       if !exists?(resource) && !filtered?(resource)
         @collection[resource.to_s] = ResourceWrapper.new(resource)
@@ -86,11 +118,8 @@ module RSpec::Puppet
     end
 
     def add_filter(type, title)
-      def capitalize_name(name)
-        name.split('::').map { |subtitle| subtitle.capitalize }.join('::')
-      end
-
       type = capitalize_name(type)
+
       if type == 'Class'
         title = capitalize_name(title)
       end
@@ -98,6 +127,34 @@ module RSpec::Puppet
       @filters << "#{type}[#{title}]"
     end
 
+    def add_filter_regex(type, pattern)
+      raise ArgumentError.new('pattern argument must be a Regexp') unless pattern.is_a?(Regexp)
+
+      type = capitalize_name(type)
+
+      # avoid recompiling the regular expression during processing
+      src = pattern.source
+
+      # switch from anchors to wildcards since it is embedded into a larger pattern
+      src = if src.start_with?('\\A', '^')
+              src.gsub(/\A(?:\\A|\^)/, '')
+            else
+              # no anchor at the start
+              ".*#{src}"
+            end
+
+      # match an even number of backslashes before the anchor - this indicates that the anchor was not escaped
+      # note the necessity for the negative lookbehind `(?<!)` to assert that there is no backslash before this
+      src = if src.match(/(?<!\\)(\\\\)*(?:\\[zZ]|\$)\z/)
+              src.gsub(/(?:\\[zZ]|\$)\z/, '')
+            else
+              # no anchor at the end
+              "#{src}.*"
+            end
+
+      @filters_regex << /\A#{Regexp.escape(type)}\[#{src}\]\z/
+    end
+
     # add all resources from catalog declared in module test_module
     def add_from_catalog(catalog, test_module)
       coverable_resources = catalog.to_a.reject { |resource| !test_module.nil? && filter_resource?(resource, test_module) }
@@ -107,7 +164,10 @@ module RSpec::Puppet
     end
 
     def filtered?(resource)
-      filters.include?(resource.to_s)
+      return true if filters.include?(resource.to_s)
+      return true if filters_regex.any? { |f| resource.to_s =~ f }
+
+      false
     end
 
     def cover!(resource)
@@ -136,7 +196,7 @@ module RSpec::Puppet
     end
 
     def run_report(coverage_desired = nil)
-      if ENV['TEST_ENV_NUMBER']
+      if parallel_tests?
         merge_filters
         merge_results
       end
@@ -145,7 +205,7 @@ module RSpec::Puppet
 
       coverage_test(coverage_desired, report)
 
-      puts report[:text]
+      puts "\n\nCoverage Report:\n\n#{report[:text]}"
     end
 
     def coverage_test(coverage_desired, report)
@@ -187,7 +247,9 @@ module RSpec::Puppet
       report[:total] = @collection.size
       report[:touched] = @collection.count { |_, resource| resource.touched? }
       report[:untouched] = report[:total] - report[:touched]
-      report[:coverage] = "%5.2f" % ((report[:touched].to_f / report[:total].to_f) * 100)
+
+      coverage = report[:total].to_f > 0 ? ((report[:touched].to_f / report[:total].to_f) * 100) : 100.0
+      report[:coverage] = "%5.2f" % coverage
 
       report[:resources] = Hash[*@collection.map do |name, wrapper|
         [name, wrapper.to_hash]
@@ -226,7 +288,7 @@ module RSpec::Puppet
     # @param test_module [String] The name of the module under test
     # @return [true, false]
     def filter_resource?(resource, test_module)
-      if @filters.include?(resource.to_s)
+      if filtered?(resource)
         return true
       end
 
@@ -267,6 +329,10 @@ module RSpec::Puppet
       !find(resource).nil?
     end
 
+    def capitalize_name(name)
+      name.split('::').map { |subtitle| subtitle.capitalize }.join('::')
+    end
+
     class ResourceWrapper
       attr_reader :resource
 

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

@@ -89,6 +89,11 @@ module RSpec::Puppet
         else
           RSpec::Puppet::Coverage.cover!(resource)
           rsrc_hsh = resource.to_hash
+          if resource.respond_to?(:sensitive_parameters)
+            resource.sensitive_parameters.each do |s_param|
+              rsrc_hsh[s_param] = ::Puppet::Pops::Types::PSensitiveType::Sensitive.new(rsrc_hsh[s_param])
+            end
+          end
 
           if resource.builtin_type?
             namevar = resource.resource_type.key_attributes.first.to_s
@@ -302,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/parameter_matcher.rb

@@ -21,10 +21,7 @@ module RSpec::Puppet
       #
       # @return [true, false]
       def matches?(resource)
-
-        @resource = resource
-
-        actual   = @resource[@parameter]
+        actual = resource[@parameter]
         expected = @value
 
         # Puppet flattens an array with a single value into just the value and
@@ -65,6 +62,8 @@ module RSpec::Puppet
           check_hash(expected, actual)
         when Array
           check_array(expected, actual)
+        when RSpec::Puppet::Sensitive
+          expected == actual
         else
           check_string(expected, actual)
         end

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

@@ -16,8 +16,8 @@ module RSpec::Puppet
       end
     end
 
-    def raise_error(*args, &block)
-      RaiseError.new(*args, &block)
+    def raise_error(error=defined?(RSpec::Matchers::BuiltIn::RaiseError::UndefinedValue) ? RSpec::Matchers::BuiltIn::RaiseError::UndefinedValue : nil, message=nil, &block)
+      RaiseError.new(error, message, &block)
     end
   end
 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/matchers/unique_values.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Puppet
+    module ManifestMatchers
+      extend RSpec::Matchers::DSL
+
+      matcher :have_unique_values_for_all do |type, attribute|
+        match do |catalogue|
+          catalogue.call.resources.select { |rsrc| rsrc.type == type.capitalize }
+                   .group_by { |rsrc| rsrc[attribute.to_sym] }
+                   .all? { |_, group| group.size == 1 }
+        end
+
+        description do
+          "have unique attribute values for #{type.capitalize}[#{attribute.to_sym}]"
+        end
+
+        if RSpec::Version::STRING < '3'
+          failure_message_for_should do |_actual|
+            "expected that the catalogue would have no duplicate values for #{type.capitalize}[#{attribute.to_sym}]"
+          end
+        else
+          failure_message do |_actual|
+            "expected that the catalogue would have no duplicate values for #{type.capitalize}[#{attribute.to_sym}]"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec-puppet/matchers.rb

@@ -7,3 +7,4 @@ require 'rspec-puppet/matchers/dynamic_matchers'
 require 'rspec-puppet/matchers/type_matchers'
 require 'rspec-puppet/matchers/allow_value'
 require 'rspec-puppet/matchers/raise_error'
+require 'rspec-puppet/matchers/unique_values'

data/lib/rspec-puppet/monkey_patches.rb

@@ -268,6 +268,40 @@ module Puppet
       end
     end
   end
+
+  if Puppet::Util::Package.versioncmp(Puppet.version, '4.9.0') >= 0
+    class Module
+      old_hiera_conf_file = instance_method(:hiera_conf_file)
+      define_method(:hiera_conf_file) do
+        if RSpec::Puppet.rspec_puppet_example?
+          if RSpec.configuration.disable_module_hiera
+            return nil
+          elsif RSpec.configuration.fixture_hiera_configs.key?(name)
+            config = RSpec.configuration.fixture_hiera_configs[name]
+            config = File.absolute_path(config, path) unless config.nil?
+            return config
+          elsif RSpec.configuration.use_fixture_spec_hiera
+            config = RSpec::Puppet.current_example.fixture_spec_hiera_conf(self)
+            return config unless config.nil? && RSpec.configuration.fallback_to_default_hiera
+          end
+        end
+        old_hiera_conf_file.bind(self).call
+      end
+    end
+
+    class Pops::Lookup::ModuleDataProvider
+      old_configuration_path = instance_method(:configuration_path)
+      define_method(:configuration_path) do |lookup_invocation|
+        if RSpec::Puppet.rspec_puppet_example?
+          env = lookup_invocation.scope.environment
+          mod = env.module(module_name)
+          raise Puppet::DataBinding::LookupError, _("Environment '%{env}', cannot find module '%{module_name}'") % { :env => env.name, :module_name => module_name } unless mod
+          return Pathname.new(mod.hiera_conf_file)
+        end
+        old_configuration_path.bind(self).call(lookup_invocation)
+      end
+    end
+  end
 end
 
 class Pathname
@@ -302,6 +336,24 @@ class Pathname
   end
 end
 
+# Puppet loads init.pp, then foo.pp, to find class "mod::foo".  If
+# class "mod" has been mocked using pre_condition when testing
+# "mod::foo", this causes duplicate declaration for "mod".
+# This monkey patch only loads "init.pp" if "foo.pp" does not exist.
+class Puppet::Module
+  if [:match_manifests, 'match_manifests'].any? { |r| instance_methods.include?(r) }
+    old_match_manifests = instance_method(:match_manifests)
+
+    define_method(:match_manifests) do |rest|
+      result = old_match_manifests.bind(self).call(rest)
+      if result.length > 1 && File.basename(result[0]) == 'init.pp'
+        result.shift
+      end
+      result
+    end
+  end
+end
+
 # Prevent the File type from munging paths (which uses File.expand_path to
 # normalise paths, which does very bad things to *nix paths on Windows.
 file_path_munge = Puppet::Type.type(:file).paramclass(:path).instance_method(:unsafe_munge)

data/lib/rspec-puppet/sensitive.rb

@@ -0,0 +1,51 @@
+module RSpec::Puppet
+  if defined?(::Puppet::Pops::Types::PSensitiveType::Sensitive)
+    # A wrapper representing Sensitive data type, eg. in class params.
+    class Sensitive < ::Puppet::Pops::Types::PSensitiveType::Sensitive
+      # Create a new Sensitive object
+      # @param [Object] value to wrap
+      def initialize(value)
+        @value = value
+      end
+
+      # @return the wrapped value
+      def unwrap
+        @value
+      end
+
+      # @return true
+      def sensitive?
+        true
+      end
+
+      # @return inspect of the wrapped value, inside Sensitive()
+      def inspect
+        "Sensitive(#{@value.inspect})"
+      end
+
+      # Check for equality with another value.
+      # If compared to Puppet Sensitive type, it compares the wrapped values.
+
+      # @param other [#unwrap, Object] value to compare to
+      def == other
+        if other.respond_to? :unwrap
+          if unwrap.kind_of?(Regexp)
+            return unwrap =~ other.unwrap
+          else
+            return unwrap == other.unwrap
+          end
+        else
+          super
+        end
+      end
+    end
+  else
+    #:nocov:
+    class Sensitive
+      def initialize(value)
+        raise 'The use of the Sensitive data type is not supported by this Puppet version'
+      end
+    end
+    #:nocov:
+  end
+end

data/lib/rspec-puppet/support.rb

@@ -1,12 +1,14 @@
 require 'rspec-puppet/cache'
 require 'rspec-puppet/adapters'
 require 'rspec-puppet/raw_string'
+require 'rspec-puppet/sensitive'
 
 module RSpec::Puppet
   module Support
     include GenericMatchers
 
     @@cache = RSpec::Puppet::Cache.new
+    @@fixture_hiera_configs = Hash.new { |h, k| h[k] = nil }
 
     def subject
       lambda { catalogue }
@@ -86,10 +88,29 @@ module RSpec::Puppet
         hiera_config_value = self.respond_to?(:hiera_config) ? hiera_config : nil
         hiera_data_value = self.respond_to?(:hiera_data) ? hiera_data : nil
 
+        rspec_config_values = [
+            :trusted_server_facts,
+            :disable_module_hiera,
+            :use_fixture_spec_hiera,
+            :fixture_hiera_configs,
+            :fallback_to_default_hiera,
+        ].map { |setting| RSpec.configuration.send(setting) }
+
         build_facts = facts_hash(node_name)
-        catalogue = build_catalog(node_name, build_facts, trusted_facts_hash(node_name), hiera_config_value,
-                                  build_code(type, manifest_opts), exported, node_params_hash, hiera_data_value,
-                                  RSpec.configuration.trusted_server_facts)
+        catalogue = build_catalog(
+          nodename: node_name,
+          facts_val: build_facts,
+          trusted_facts_val: trusted_facts_hash(node_name),
+          hiera_config_val: hiera_config_value,
+          code: build_code(type, manifest_opts),
+          exported: exported,
+          node_params: node_params_hash,
+          trusted_external_data: trusted_external_data_hash,
+          ignored_cache_params: {
+            hiera_data_value: hiera_data_value,
+            rspec_config_values: rspec_config_values,
+          }
+        )
 
         test_module = type == :host ? nil : class_name.split('::').first
         if type == :define
@@ -293,6 +314,19 @@ module RSpec::Puppet
       extensions
     end
 
+    def trusted_external_data_hash
+      return {} unless Puppet::Util::Package.versioncmp(Puppet.version, '6.14.0') >= 0
+
+      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(trusted_external_data)) if self.respond_to?(:trusted_external_data)
+      external_data
+    end
+
     def server_facts_hash
       server_facts = {}
 
@@ -303,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}"
@@ -311,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
@@ -358,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|
@@ -380,6 +414,29 @@ module RSpec::Puppet
     end
 
     def build_catalog_without_cache(nodename, facts_val, trusted_facts_val, hiera_config_val, code, exported, node_params, *_)
+      build_catalog_without_cache_v2({
+        nodename: nodename,
+        facts_val: facts_val,
+        trusted_facts_val: trusted_facts_val,
+        hiera_config_val: hiera_config_val,
+        code: code,
+        exported: exported,
+        node_params: node_params,
+        trusted_external: {},
+      })
+    end
+
+    def build_catalog_without_cache_v2(
+      nodename: nil,
+      facts_val: nil,
+      trusted_facts_val: nil,
+      hiera_config_val: nil,
+      code: nil,
+      exported: nil,
+      node_params: nil,
+      trusted_external_data: nil,
+      ignored_cache_params: {}
+    )
 
       # If we're going to rebuild the catalog, we should clear the cached instance
       # of Hiera that Puppet is using.  This opens the possibility of the catalog
@@ -401,10 +458,14 @@ module RSpec::Puppet
 
       node_obj = Puppet::Node.new(nodename, { :parameters => node_params, :facts => node_facts })
 
+      trusted_info = ['remote', nodename, trusted_facts_val]
+      if Puppet::Util::Package.versioncmp(Puppet.version, '6.14.0') >= 0
+        trusted_info.push(trusted_external_data)
+      end
       if Puppet::Util::Package.versioncmp(Puppet.version, '4.3.0') >= 0
         Puppet.push_context(
           {
-            :trusted_information => Puppet::Context::TrustedInformation.new('remote', nodename, trusted_facts_val)
+            :trusted_information => Puppet::Context::TrustedInformation.new(*trusted_info)
           },
           "Context for spec trusted hash"
         )
@@ -417,13 +478,17 @@ 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|
-        build_catalog_without_cache(*args)
+        if args.length == 1 && args.first.is_a?(Hash)
+          build_catalog_without_cache_v2(**args.first)
+        else
+          build_catalog_without_cache(*args)
+        end
       end
     end
 
@@ -440,8 +505,7 @@ module RSpec::Puppet
     end
 
     def escape_special_chars(string)
-      string.gsub!(/\$/, "\\$")
-      string
+      string.gsub(/\$/, "\\$")
     end
 
     def rspec_compatibility
@@ -452,6 +516,23 @@ module RSpec::Puppet
       end
     end
 
+    def fixture_spec_hiera_conf(mod)
+      return @@fixture_hiera_configs[mod.name] if @@fixture_hiera_configs.key?(mod.name)
+
+      path = Pathname.new(mod.path)
+      if path.join('spec').exist?
+        path.join('spec').find do |file|
+          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
+        end
+      end
+      @@fixture_hiera_configs[mod.name]
+    end
+
     # Helper to return a resource/node reference, so it gets translated in params to a raw string
     # without quotes.
     #
@@ -462,6 +543,14 @@ module RSpec::Puppet
       return RSpec::Puppet::RawString.new("#{type}['#{title}']")
     end
 
+    # Helper to return value wrapped in Sensitive type.
+    #
+    # @param [Object] value to wrap
+    # @return [RSpec::Puppet::Sensitive] a new Sensitive wrapper with the new value
+    def sensitive(value)
+      return RSpec::Puppet::Sensitive.new(value)
+    end
+
     # @!attribute [r] adapter
     #   @api private
     #   @return [Class < RSpec::Puppet::Adapters::Base]

data/lib/rspec-puppet.rb

@@ -42,6 +42,8 @@ RSpec.configure do |c|
   c.add_setting :default_facts, :default => {}
   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
@@ -54,6 +56,10 @@ RSpec.configure do |c|
   c.add_setting :platform, :default => Puppet::Util::Platform.actual_platform
   c.add_setting :vendormoduledir, :default => Puppet::Util::Platform.actually_windows? ? 'c:/nul/' : '/dev/null'
   c.add_setting :basemodulepath, :default => Puppet::Util::Platform.actually_windows? ? 'c:/nul/' : '/dev/null'
+  c.add_setting :disable_module_hiera, :default => false
+  c.add_setting :fixture_hiera_configs, :default => {}
+  c.add_setting :use_fixture_spec_hiera, :default => false
+  c.add_setting :fallback_to_default_hiera, :default => true
 
   c.instance_eval do
     def trusted_server_facts

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: rspec-puppet
 version: !ruby/object:Gem::Version
-  version: 2.7.10
+  version: 2.11.0
 platform: ruby
 authors:
 - Tim Sharpe
-autorequire: 
+- Puppet, Inc.
+- Community Contributors
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-15 00:00:00.000000000 Z
+date: 2021-11-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
@@ -60,21 +65,23 @@ files:
 - lib/rspec-puppet/matchers/raise_error.rb
 - lib/rspec-puppet/matchers/run.rb
 - lib/rspec-puppet/matchers/type_matchers.rb
+- lib/rspec-puppet/matchers/unique_values.rb
 - lib/rspec-puppet/monkey_patches.rb
 - lib/rspec-puppet/monkey_patches/win32/registry.rb
 - lib/rspec-puppet/monkey_patches/win32/taskscheduler.rb
 - lib/rspec-puppet/monkey_patches/windows/taskschedulerconstants.rb
 - lib/rspec-puppet/rake_task.rb
 - lib/rspec-puppet/raw_string.rb
+- lib/rspec-puppet/sensitive.rb
 - lib/rspec-puppet/setup.rb
 - 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
@@ -89,8 +96,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.6.2
+signing_key:
 specification_version: 4
 summary: RSpec tests for your Puppet manifests
 test_files: []