rspec-puppet 2.7.5 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e33fa5eda2bf9349af429c677c62cd0c3456bbb81c77cf8ecaf03a1a4af31a14
-  data.tar.gz: b7693cd9f85ba31b5c952d75c0afd04fdfe1f9670221d9379eadcb16870b4bc3
+  metadata.gz: 375cf91b75c36ee1bc0bbade72608205a7b85fce94a49d0fcfafb02fa6f8eddc
+  data.tar.gz: 732ce59e27a5fd9d15052262d21b2de6df85b090fb56152aca88da4480133ac1
 SHA512:
-  metadata.gz: c277a6e3f6c6271e0d7e301a8dc973d77d7c8805101f64487e875bbb60e47ce791948c567a72dd57fc837ef8467fc9c043d14980f848a7d561772ece677c1115
-  data.tar.gz: 386013fdab15bb3299e83d0a22504cf3d80c7dc5c0c1bc74233a5e8b3973f8f70f60d7f813405fb2013d1077297cb10cf4f23bdfd632f503e8b9380fb4144b2b
+  metadata.gz: 3f1b0bb5c052df4ff70981384ad81bdc2e75ec1f23f9a890f101a933a4f7f50d569acef001524c7c3a9f37f0cfffd2eeaf0a26a7d67f8a3abd80b7147005e758
+  data.tar.gz: 65f0fbe718948c13b1866bb8d71c6b03fe741927ed86e97d6eeefb39526e98671e3ac5ae98e14e939654988fa8c272b3e72f66c5b61e9c6321fac11d5b66e276

data/CHANGELOG.md

@@ -2,6 +2,72 @@
 All notable changes to this project will be documented in this file. This
 project adheres to [Semantic Versioning](http://semver.org/).
 
+## [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/rodjek/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
+ * Fix issues with removal of `default_env` method in Puppet 6.17.0.
+
+## [2.7.9]
+
+This release had unintended breaking changes and was withdrawn.
+
+## [2.7.8]
+
+### Fixed
+ * Fix cross-platform testing for Puppet >= 6.9.0 when there is no `ipaddress6`
+   fact defined.
+
+## [2.7.7]
+
+### Fixed
+ * Fix the support for rspec-expectations >= 3.8.5.
+
+### Changed
+ * Remove the rspec-expectations dependency limit introduced in 2.7.6.
+
+## [2.7.6]
+
+### Changed
+ * Limit rspec-expectations dependency to < 3.8.5 due to an incompatible
+   change.
+
 ## [2.7.5]
 
 ### Fixed

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
@@ -759,6 +773,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.rb

@@ -42,6 +42,7 @@ 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 :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 +55,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

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/matchers.rb

@@ -6,3 +6,5 @@ require 'rspec-puppet/matchers/count_generic'
 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/matchers/allow_value.rb

@@ -34,6 +34,14 @@ module RSpec::Puppet
       def failure_message_when_negated
         "expected that the type alias would not " + description + " but it does"
       end
+
+      def supports_block_expectations
+        true
+      end
+
+      def supports_value_expectations
+        true
+      end
     end
 
     def allow_value(*values)

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

@@ -78,6 +78,14 @@ module RSpec::Puppet
         end
       end
 
+      def supports_block_expectations
+        true
+      end
+
+      def supports_value_expectations
+        true
+      end
+
       private
       def missing_dependencies?
         retval = false

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

@@ -61,6 +61,14 @@ module RSpec::Puppet
         "expected that the catalogue would not " + description + " but it does"
       end
 
+      def supports_block_expectations
+        true
+      end
+
+      def supports_value_expectations
+        true
+      end
+
     private
 
       def referenced_type(type)

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
@@ -177,6 +182,14 @@ module RSpec::Puppet
         true
       end
 
+      def supports_block_expectations
+        true
+      end
+
+      def supports_value_expectations
+        true
+      end
+
       def expected
         @errors.map {|e| e.expected if e.respond_to?(:expected)}.compact.join("\n\n")
       end

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

@@ -22,6 +22,13 @@ module RSpec::Puppet
         end
       end
 
+      def supports_block_expectations
+        true
+      end
+
+      def supports_value_expectations
+        true
+      end
     end
 
   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

@@ -0,0 +1,23 @@
+module RSpec::Puppet
+  module GenericMatchers
+    # Due to significant code base depending on the
+    #
+    #     is_expected.to raise_error Puppet::Error
+    #
+    # syntax, and removal of this syntax from RSpec, extend RSpec's built-in
+    # `raise_error` matcher to accept a value target, e.g. a subject defined
+    # as a lambda, e.g.:
+    #
+    #     subject(:catalogue) { lambda { load_catalogue } }
+    #
+    class RaiseError < RSpec::Matchers::BuiltIn::RaiseError
+      def supports_value_expectations?
+        true
+      end
+    end
+
+    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/run.rb

@@ -104,6 +104,14 @@ module RSpec::Puppet
         end
       end
 
+      def supports_block_expectations
+        true
+      end
+
+      def supports_value_expectations
+        true
+      end
+
       private
       def func_name
         @func_obj.func_name

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/monkey_patches.rb

@@ -132,6 +132,16 @@ module Puppet
   end
 
   module Util
+    # Fix for removal of default_env function
+    # Bug: https://github.com/rodjek/rspec-puppet/issues/796
+    # Upstream: https://github.com/puppetlabs/puppet/commit/94df3c1a3992d89b2d7d5db8a70373c135bdd86b
+    if !respond_to?(:default_env)
+      def default_env()
+        DEFAULT_ENV
+      end
+      module_function :default_env
+    end
+
     if respond_to?(:get_env)
       alias :old_get_env :get_env
       module_function :old_get_env
@@ -258,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
@@ -292,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,47 @@
+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
+          return unwrap == other.unwrap
+        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,10 +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 }
@@ -84,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
@@ -224,10 +247,11 @@ module RSpec::Puppet
       }
 
       node_facts = {
-        'hostname'      => node.split('.').first,
-        'fqdn'          => node,
-        'domain'        => node.split('.', 2).last,
-        'clientcert'    => node,
+        'hostname'   => node.split('.').first,
+        'fqdn'       => node,
+        'domain'     => node.split('.', 2).last,
+        'clientcert' => node,
+        'ipaddress6' => 'FE80:0000:0000:0000:AAAA:AAAA:AAAA',
       }
 
       networking_facts = {
@@ -290,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 = {}
 
@@ -377,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
@@ -398,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"
         )
@@ -420,7 +484,11 @@ module RSpec::Puppet
 
     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
 
@@ -437,8 +505,7 @@ module RSpec::Puppet
     end
 
     def escape_special_chars(string)
-      string.gsub!(/\$/, "\\$")
-      string
+      string.gsub(/\$/, "\\$")
     end
 
     def rspec_compatibility
@@ -449,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.
     #
@@ -459,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]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-puppet
 version: !ruby/object:Gem::Version
-  version: 2.7.5
+  version: 2.8.0
 platform: ruby
 authors:
 - Tim Sharpe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-06 00:00:00.000000000 Z
+date: 2020-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -57,14 +57,17 @@ files:
 - lib/rspec-puppet/matchers/dynamic_matchers.rb
 - lib/rspec-puppet/matchers/include_class.rb
 - lib/rspec-puppet/matchers/parameter_matcher.rb
+- 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
@@ -88,8 +91,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.0.8
 signing_key: 
 specification_version: 4
 summary: RSpec tests for your Puppet manifests