rspec-puppet 4.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 291e38ca7a66506f0137223f196936d5f2f96122edd1f5769d055a98c2370229
-  data.tar.gz: cf627b9874f3aef7ae15b92d5f21283dfe4ceede9d0f6221be73f72d19c6803f
+  metadata.gz: 47a4537abaf6bf6d0c44a12e55802441f69eae576f813424c37da35b622b9f30
+  data.tar.gz: 1ad5e7c658add77b60c124ee49e727dccb3c499325e39ef74f2a9e71f684b1d4
 SHA512:
-  metadata.gz: 7bbdc55d506fec8fdb26d206af5c56ad19a3a50dd4b0438853466513cbd0338087c3ca1dfff99146c530afa5194ac392fc121f2ee1aaccbb9d82b5cf6edf8e53
-  data.tar.gz: 2d7ee94fb1fe726e8a326413bab9b8b08a200023be91693a7a208ade86de1e848e7c443fb2b6c8847ac75fe32cfd99ca2ff27601552543204ce5b4a802dfb86e
+  metadata.gz: 98a74e54868b5ac3711334e96d2b1cf757394a124ae468ae8a00b64b3ac8d16988d05c2cb5a085764235e4882bdbbe092f64f050bf129b06ae247cbb1a75b84f
+  data.tar.gz: 8911211fa08701f599fd47a9492a8ae4c77a0deaf83daef943a1d596baece421fc816b62f57534cf588603865382108af18af0d0db3eadd0b13ef2f77d32260f

data/CHANGELOG.md

@@ -5,11 +5,42 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org).
 
+## [v5.0.0](https://github.com/puppetlabs/rspec-puppet/tree/v5.0.0) - 2024-09-06
+
+[Full Changelog](https://github.com/puppetlabs/rspec-puppet/compare/v4.0.2...v5.0.0)
+
+### Changed
+
+- Unwrap sensitive values in error messages [#42](https://github.com/puppetlabs/rspec-puppet/pull/42) ([smortex](https://github.com/smortex))
+
+### Fixed
+
+- server_facts: Switch from legacy to structured facts [#127](https://github.com/puppetlabs/rspec-puppet/pull/127) ([bastelfreak](https://github.com/bastelfreak))
+- (bug) - Add license file to built gem [#108](https://github.com/puppetlabs/rspec-puppet/pull/108) ([jordanbreen28](https://github.com/jordanbreen28))
+
+## [v4.0.2](https://github.com/puppetlabs/rspec-puppet/tree/v4.0.2) - 2023-12-05
+
+[Full Changelog](https://github.com/puppetlabs/rspec-puppet/compare/v4.0.1...v4.0.2)
+
+### Fixed
+
+- Revert "(maint) - fix rubocop" - Leading argument with delegation syntax not supported with ruby 2.7.0 [#94](https://github.com/puppetlabs/rspec-puppet/pull/94) ([jordanbreen28](https://github.com/jordanbreen28))
+- Revert "(CAT-1235) - Rename to puppetlabs-rspec-puppet" [#92](https://github.com/puppetlabs/rspec-puppet/pull/92) ([jordanbreen28](https://github.com/jordanbreen28))
+
+## [v4.0.1](https://github.com/puppetlabs/rspec-puppet/tree/v4.0.1) - 2023-11-22
+
+[Full Changelog](https://github.com/puppetlabs/rspec-puppet/compare/v4.0.0...v4.0.1)
+
+### Fixed
+
+- (maint) - Add original owners [#90](https://github.com/puppetlabs/rspec-puppet/pull/90) ([jordanbreen28](https://github.com/jordanbreen28))
+
 ## [v4.0.0](https://github.com/puppetlabs/rspec-puppet/tree/v4.0.0) - 2023-10-09
 
 [Full Changelog](https://github.com/puppetlabs/rspec-puppet/compare/v3.0.0...v4.0.0)
 
 ### Changed
+
 - (CAT-1226) - Remove Compatibility for Puppet 7.10 and below [#73](https://github.com/puppetlabs/rspec-puppet/pull/73) ([jordanbreen28](https://github.com/jordanbreen28))
 - Drop RSpec 2 & Ruby 1 compatiblity [#67](https://github.com/puppetlabs/rspec-puppet/pull/67) ([ekohl](https://github.com/ekohl))
 - Remove puppet applications support [#54](https://github.com/puppetlabs/rspec-puppet/pull/54) ([nabertrand](https://github.com/nabertrand))
@@ -27,6 +58,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 [Full Changelog](https://github.com/puppetlabs/rspec-puppet/compare/v2.12.0...v3.0.0.rc.1)
 
 ### Changed
+
 - (CONT-808) Ruby 3 / Puppet 8 Support [#48](https://github.com/puppetlabs/rspec-puppet/pull/48) ([chelnak](https://github.com/chelnak))
 
 ### Added
@@ -80,7 +112,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [v2.8.0](https://github.com/puppetlabs/rspec-puppet/tree/v2.8.0) - 2020-11-05
 
-[Full Changelog](https://github.com/puppetlabs/rspec-puppet/compare/v2.7.9...v2.8.0)
+[Full Changelog](https://github.com/puppetlabs/rspec-puppet/compare/v2.7.10...v2.8.0)
+
+## [v2.7.10](https://github.com/puppetlabs/rspec-puppet/tree/v2.7.10) - 2020-07-15
+
+[Full Changelog](https://github.com/puppetlabs/rspec-puppet/compare/v2.7.9...v2.7.10)
 
 ## [v2.7.9](https://github.com/puppetlabs/rspec-puppet/tree/v2.7.9) - 2020-07-14
 

data/LICENSE

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

data/README.md

@@ -16,6 +16,8 @@
 * [Hiera integration](#hiera-integration)
 * [Producing coverage reports](#producing-coverage-reports)
 * [Related projects](#related-projects)
+* [Development](#development)
+* [License](#license)
 
 ## Installation
 
@@ -93,22 +95,6 @@ Hash | `{}`    | any
 A hash of default trusted facts that should be used for all the tests
 (available in the manifests as the `$trusted` hash).
 
-#### trusted\_node\_data
-Type    | Default | Puppet Version(s)
-------- | ------- | -----------------
-Boolean | `false` | any
-
-Configures rspec-puppet to use the `$trusted` hash when compiling the
-catalogues.
-
-#### trusted\_server\_facts
-Type    | Default | Puppet Version(s)
-------- | ------- | -----------------
-Boolean | `false` | any
-
-Configures rspec-puppet to use the `$server_facts` hash when compiling the
-catalogues.
-
 #### confdir
 Type   | Default         | Puppet Version(s)
 ------ | --------------- | ------------------
@@ -902,66 +888,92 @@ end
 
 ## Hiera integration
 
+At some point, you might want to make use of Hiera to bring in custom parameters for your class tests. In this section, we will
+provide you with basic guidance to setup Hiera implementation within rspec testing. For more information on Hiera, you should
+check our official [documentation](https://www.puppet.com/docs/puppet/latest/hiera.html).
+
 ### Configuration
 
-Set the hiera config symbol properly in your spec files:
+The first step is to create the general hiera configuration file. Since we want this to be exclusive for testing, we recommend creating
+it inside your spec folder. Something along the lines of `spec/fixtures/hiera/hiera-rspec.yaml`. It should look something like this:
 
-```ruby
-let(:hiera_config) { 'spec/fixtures/hiera/hiera.yaml' }
-hiera = Hiera.new(:config => 'spec/fixtures/hiera/hiera.yaml')
+```yaml
+---
+version: 5
+defaults:               # Used for any hierarchy level that omits these keys.
+  datadir: data         # This path is relative to hiera.yaml's directory.
+  data_hash: yaml_data  # Use the built-in YAML backend.
+
+hierarchy:
+  - name: 'rspec'
+    path: 'rspec-data.yaml'
 ```
 
-Create your spec hiera files
+It is often recommended to use dummy data during testing to avoid real values from being entangled. In order to create
+these values, we will need a new file containing this data exclusively, normally existing within a subfolder called `data`, ending up with
+`spec/fixtures/hiera/data/rspec-data.yaml`. Here is an example of its contents:
 
-spec/fixtures/hiera/hiera.yaml
-```ruby
+```yaml
 ---
-:backends:
-  - yaml
-:hierarchy:
-  - test
-:yaml:
-  :datadir: 'spec/fixtures/hiera'
+# We will be using this data in later examples
+message: 'Hello world!'
+dummy:message2: 'foobar' # autoloaded parameter
 ```
 
-spec/fixtures/hiera/test.yaml
+Finally, we make the target class spec file load the Hiera config, at which point we will be able to freely access it:
+
 ```ruby
----
-ntpserver: ['ntp1.domain.com','ntpXX.domain.com']
-user:
-  oneuser:
-    shell: '/bin/bash'
-  twouser:
-    shell: '/sbin/nologin'
+let(:hiera_config) { 'spec/fixtures/hiera/hiera-rspec.yaml' }
 ```
 
-### Use hiera in your tests
+Or alternatively, you could load the hiera configuration in the spec_helper to ensure it is available through all test files:
 
 ```ruby
-  ntpserver = hiera.lookup('ntpserver', nil, nil)
-  let(:params) { 'ntpserver' => ntpserver }
+RSpec.configure do |c|
+  c.hiera_config = 'spec/fixtures/hiera/hiera-rspec.yaml'
+end
 ```
 
-### Enabling hiera lookups
-If you just want to fetch values from hiera (e.g. because
-you're testing code that uses explicit hiera lookups) just specify
-the path to the hiera config in your `spec_helper.rb`
+#### Test usage examples
+
+Unlike with Hiera 3, Hiera 5 comes packaged with our Puppet agent and runs during Puppet runtime. This means that it is not really possible to
+call the lookup function in the same way it previously worked. However, you can still test its functionality via dummy class instantiation:
+
+The following test creates a dummny class that uses the lookup function within it. This should allow you to confirm that the lookup() function
+works correctly (remember that this test uses your custom hiera parameters, and not your real ones).
 
 ```ruby
-RSpec.configure do |c|
-  c.hiera_config = 'spec/fixtures/hiera/hiera.yaml'
-end
+context 'dummy hiera test is implemented' do
+      let(:pre_condition) do
+        "class dummy($message) { }
+         class { 'dummy': message => lookup('message') }"
+      end
+      let(:hiera_config) { 'spec/fixtures/hiera/hiera-rspec.yaml' } # Only needed if the config has not been established in spec_helper
+
+      it { is_expected.to compile }
+
+      it 'loads ntpserver from Hiera' do
+        is_expected.to contain_class('dummy').with_message('Hello world!')
+      end
+    end
 ```
 
-spec/fixtures/hiera/hiera.yaml
-```yaml
----
-:backends:
-  - yaml
-:yaml:
-  :datadir: spec/fixtures/hieradata
-:hierarchy:
-  - common
+The next test ensures that autoloaded parameters work correctly within your classes:
+
+```ruby
+    context 'dummy hiera test is implemented a second time' do
+      let(:pre_condition) do
+        "class dummy($message2) { }
+        include dummy"
+      end
+      let(:hiera_config) { 'spec/fixtures/hiera/hiera-rspec.yaml' } # Only needed if the config has not been established in spec_helper
+
+      it { is_expected.to compile }
+
+      it 'loads ntpserver from Hiera' do
+        is_expected.to contain_class('dummy').with_message2('foobar')
+      end
+    end
 ```
 
 **Please note:** In-module hiera data depends on having a correct metadata.json file. It is
@@ -1016,6 +1028,10 @@ If you run into an issue with this tool or would like to request a feature you c
 
 If you have problems getting this tool up and running, please contact Support.
 
+## License
+
+This codebase is licensed under Apache 2.0. However, the open source dependencies included in this codebase might be subject to other software licenses such as AGPL, GPL2.0, and MIT.
+
 ## Thank you
 
 Many thanks to the original author of rspec-puppet Tim Sharpe (@rodjek).

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

@@ -100,7 +100,7 @@ module RSpec::Puppet
         return func if func.func
 
         if Puppet::Parser::Functions.function(function_name)
-          V3FunctionWrapper.new(function_name, scope.method("function_#{function_name}".intern))
+          V3FunctionWrapper.new(function_name, scope.method(:"function_#{function_name}"))
         end
       end
     end

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

@@ -303,7 +303,7 @@ module RSpec::Puppet
 
         # Add auto* (autorequire etc) if any
         if %i[before notify require subscribe].include?(type)
-          func = "eachauto#{type}".to_sym
+          func = :"eachauto#{type}"
           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|

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

@@ -26,8 +26,8 @@ module RSpec::Puppet
   end
 
   module TypeMatchers
-    def method_missing(method, ...)
-      return RSpec::Puppet::TypeMatchers::CreateGeneric.new(method, ...) if method == :be_valid_type
+    def method_missing(method, *args, &block)
+      return RSpec::Puppet::TypeMatchers::CreateGeneric.new(method, *args, &block) if method == :be_valid_type
 
       super
     end

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

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

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

@@ -123,7 +123,7 @@ module RSpec::Puppet
           param = param.to_sym
           if attr_type == :feature
             baddies.push(param) unless type.provider_feature(param)
-          elsif !type.send("valid#{attr_type}?".to_sym, param)
+          elsif !type.send(:"valid#{attr_type}?", param)
             baddies.push(param)
           end
         end

data/lib/rspec-puppet/sensitive.rb

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

data/lib/rspec-puppet/support.rb

@@ -301,8 +301,7 @@ module RSpec::Puppet
       server_facts['serverversion'] = Puppet.version.to_s
 
       # And then add the server name and IP
-      { 'servername' => 'fqdn',
-        'serverip' => 'ipaddress' }.each do |var, fact|
+      { 'servername' => 'networking.fqdn', 'serverip' => 'networking.ip' }.each do |var, fact|
         if (value = Puppet.runtime[:facter].value(fact))
           server_facts[var] = value
         else
@@ -311,8 +310,8 @@ module RSpec::Puppet
       end
 
       if server_facts['servername'].nil?
-        host = Puppet.runtime[:facter].value(:hostname)
-        server_facts['servername'] = if (domain = Puppet.runtime[:facter].value(:domain))
+        host = Puppet.runtime[:facter].value('networking.hostname')
+        server_facts['servername'] = if (domain = Puppet.runtime[:facter].value('networking.domain'))
                                        [host, domain].join('.')
                                      else
                                        host

data/lib/rspec-puppet/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-puppet
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Tim Sharpe
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-09 00:00:00.000000000 Z
+date: 2024-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -26,10 +26,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: |2
-      RSpec tests for your Puppet manifests.
-      Note: Support for this gem has been moved under a new namespace and as such any future updates from
-      the Puppet team will be released as `puppetlabs-rspec-puppet`.
+description: "    RSpec tests for your Puppet manifests.\n"
 email:
 - tim@sharpe.id.au
 - modules-team@puppet.com
@@ -39,6 +36,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
+- LICENSE
 - README.md
 - bin/rspec-puppet-init
 - lib/rspec-puppet.rb
@@ -83,8 +81,7 @@ files:
 homepage: https://github.com/puppetlabs/rspec-puppet/
 licenses:
 - MIT
-metadata:
-  rubygems_mfa_required: 'true'
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths: