kitchen-pester 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2265777e3844674d88d2c9fee716b53e51931370db862b9ae1ab1e0e146a0d3f
-  data.tar.gz: ea5c52a19e982eb5f762d342a098160723120b4800734b611c1da782a0a49b62
+  metadata.gz: 0b6c13739edbe22f0dedd8c258cf3ba1d65232872a5dbb43831e71af00adff8c
+  data.tar.gz: c8c94343f5e132fd79d1e5a39848a883d10f8506e6408bdd44a2bb645a0f3f1c
 SHA512:
-  metadata.gz: 521b9f823e6e4229dc55753e1a19c809056a70855276a5ab512ebcc4e41f9301396cd05deba5a8fe40528f1df25705f069c73401eeb8d67acd3501d9e7f3e502
-  data.tar.gz: 1294cc1198df01d440000612209d21b23d4904129d0b9fe2092b37a9186030819c87a145b88ea37526f544ce40e2ede8f616d2ea428f57bd878fc01d6b8902cc
+  metadata.gz: 4e40212df8ac8701351185e97429cdfcd8a2c9366c06b2ecd8c198a175b748be682e7a5f2806bf42626ea928940d2383e65d851ca7bb06e860713d92651d70e2
+  data.tar.gz: d2cea264f19135c7c9b0660358a71b627e4ac2c28fe765b03e41572ca0113192c5b4ef15ef3fe2808dcf43fba56f29d8fa6e9aeab0d5c4293f3e175433c696e8

data/README.md

@@ -105,26 +105,46 @@ the instance is the exact script that ran.
 
 ## Pester versions
 
-kitchen-pester supports **Pester 5** (the default) and **Pester 4**.
+kitchen-pester supports **Pester 5 and later** (the default) and **Pester 4**.
 
-It detects the installed version on the instance and adapts: Pester 5 gets a
-`PesterConfiguration` object built from your `pester_configuration`, Pester 4
-gets loose `Invoke-Pester` parameters. You do not need to tell it which one
-you are on.
+It detects the installed version on the instance and adapts: Pester 5 and
+later get a `PesterConfiguration` object built from your
+`pester_configuration`, Pester 4 and earlier get loose `Invoke-Pester`
+parameters. You do not need to tell it which one you are on.
 
-To stay on Pester 4, cap the install:
+To stay on Pester 4, cap the install. `pester_install` is
+[replaced, not merged](#map-options-are-replaced-not-merged), so repeat the
+defaults you still want — without `SkipPublisherCheck` the install fails
+against the Pester that ships with Windows:
 
 ```yaml
 verifier:
   name: pester
   pester_install:
     MaximumVersion: '4.99.999'
+    SkipPublisherCheck: true
+    Force: true
+    ErrorAction: Stop
 ```
 
 ## Configuration
 
 All of these go under `verifier:` in `kitchen.yml`.
 
+### Map options are replaced, not merged
+
+Every option below whose type is **map** — `pester_install`,
+`pester_configuration`, `bootstrap`, `environment`, `downloads` — replaces its
+default outright. A plugin default applies only when the key is absent
+altogether, so setting one key inside one of these maps discards every other
+key the default supplied. (Merging between the top-level, platform and suite
+`verifier:` blocks is unaffected — that part is a deep merge.)
+
+This bites hardest on `pester_install` and `pester_configuration`, where the
+discarded defaults are the ones that produce the results file. Whenever you set
+a map option, write out the whole map, taking the defaults from the tables
+below as your starting point.
+
 ### Common
 
 | Option | Type | Default | What it does |
@@ -207,6 +227,22 @@ Output:
   Verbosity: Detailed
 ```
 
+This map is [replaced, not merged](#map-options-are-replaced-not-merged), and
+the defaults it replaces are load-bearing. `New-PesterConfiguration` defaults
+both `TestResult.Enabled` and `Run.PassThru` to `$false`, so this:
+
+```yaml
+verifier:
+  name: pester
+  pester_configuration:
+    Output:
+      Verbosity: Diagnostic
+```
+
+turns off the NUnit results file — your `downloads` then have nothing to
+fetch — and leaves the run without a result object to count failures from.
+Copy the whole default map and edit the key you came for.
+
 **On Pester 5**, this becomes a `PesterConfiguration` via
 `New-PesterConfiguration -Hashtable`. Three keys are filled in for you if you
 leave them unset:
@@ -276,8 +312,9 @@ verifier:
       - PowerShellGet
 ```
 
-> **Note:** this key is replaced wholesale, not merged. If you set `modules`,
-> set `repository_url` too.
+> **Note:** this key is
+> [replaced, not merged](#map-options-are-replaced-not-merged). If you set
+> `modules`, set `repository_url` too.
 
 ## Examples
 
@@ -362,6 +399,11 @@ Describe 'configuration' {
 died before Pester started; check the `cinc kitchen verify` output for the install
 step.
 
+**I set one `pester_configuration` key and the results file stopped appearing.**
+Map options replace their default rather than merging into it, and the default
+is what enables the results file. See
+[Map options are replaced, not merged](#map-options-are-replaced-not-merged).
+
 **I want to see the script that ran.** Add `kitchen_cmd.ps1` to `downloads`,
 or look for it in `$env:TEMP/verifier` on the instance.
 

data/kitchen-pester.gemspec

@@ -21,10 +21,6 @@ Gem::Specification.new do |spec|
   spec.files         = %w{LICENSE README.md kitchen-pester.gemspec} + Dir.glob("lib/**/*")
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest",  ">= 5.25", "< 7"
-  spec.add_development_dependency "mocha",     ">= 2.0", "< 4"
-  spec.add_development_dependency "yard",      "~> 0.9"
   # 3.6.0 is the first release to require Ruby >= 3.1, which this gem also
   # requires, so anything older cannot be installed alongside it in practice.
   spec.add_dependency "test-kitchen", ">= 3.6", "< 5"

data/lib/kitchen/verifier/pester.rb

@@ -221,7 +221,13 @@ module Kitchen
         config[:downloads] = config[:downloads]
           .map do |source, destination|
             source = source.to_s
-            destination = destination.gsub("%{instance_name}", instance.name)
+            if destination.nil?
+              raise UserError, "The verifier's 'downloads' entry for '#{source}' has no local " \
+                               "destination. Every entry needs one, for example " \
+                               "'#{source}: ./testresults/'."
+            end
+
+            destination = destination.to_s.gsub("%{instance_name}", instance.name)
             info("  resolving remote source's absolute path.")
             unless source.match?(%r{^/|^[a-zA-Z]:[\\/]}) # is Absolute?
               info("  '#{source}' is a relative path, resolving to: #{File.join(config[:root_path], source)}")
@@ -373,12 +379,13 @@ module Kitchen
         gallery_url_param = bootstrap[:repository_url] ? "-GalleryUrl '#{bootstrap[:repository_url]}'" : ""
 
         info("Bootstrapping environment without PowerShellGet Provider...")
-        Array(bootstrap[:modules]).map do |powershell_module|
+        config_list("bootstrap.modules", bootstrap[:modules]).map do |powershell_module|
           if powershell_module.is_a? Hash
+            module_name = module_name!("bootstrap.modules", powershell_module)
             <<-PS1
-              ${#{powershell_module[:Name]}} = #{ps_hash(powershell_module)}
+              ${#{module_name}} = #{ps_hash(powershell_module)}
 
-              Install-ModuleFromNuget -Module ${#{powershell_module[:Name]}} #{gallery_url_param}
+              Install-ModuleFromNuget -Module ${#{module_name}} #{gallery_url_param}
             PS1
           else
             <<-PS1
@@ -397,13 +404,14 @@ module Kitchen
         return if config[:register_repository].nil?
 
         info("Registering a new PowerShellGet Repository")
-        Array(config[:register_repository]).map do |psrepo|
+        config_list("register_repository", config[:register_repository]).map do |psrepo|
+          repo_name = module_name!("register_repository", psrepo)
           # Using Set-PSRepo from ../../*/*/*/PesterUtil.psm1
-          debug("Command to set PSRepo #{psrepo[:Name]}.")
+          debug("Command to set PSRepo #{repo_name}.")
           <<-PS1
-            Write-Host 'Registering psrepo #{psrepo[:Name]}...'
-            ${#{psrepo[:Name]}} = #{ps_hash(psrepo)}
-            Set-PSRepo -Repository ${#{psrepo[:Name]}}
+            Write-Host 'Registering psrepo #{repo_name}...'
+            ${#{repo_name}} = #{ps_hash(psrepo)}
+            Set-PSRepo -Repository ${#{repo_name}}
           PS1
         end
       end
@@ -439,10 +447,10 @@ module Kitchen
       def install_modules_from_gallery
         return if config[:install_modules].nil?
 
-        Array(config[:install_modules]).map do |powershell_module|
+        config_list("install_modules", config[:install_modules]).map do |powershell_module|
           if powershell_module.is_a? Hash
             # Sanitize variable name so that $powershell-yaml becomes $powershell_yaml
-            module_name = powershell_module[:Name].gsub(/[\W]/, "_")
+            module_name = module_name!("install_modules", powershell_module).gsub(/[\W]/, "_")
             # so we can splat that variable to install module
             <<-PS1
               $#{module_name} = #{ps_hash(powershell_module)}
@@ -785,7 +793,7 @@ module Kitchen
 
         info("Preparing to copy specified folders to #{sandbox_module_path}.")
         kitchen_root_path = config[:kitchen_root]
-        config[:copy_folders].each do |folder|
+        config_list("copy_folders", config[:copy_folders]).each do |folder|
           debug("copying #{folder}")
           folder_to_copy = File.join(kitchen_root_path, folder)
           copy_if_src_exists(folder_to_copy, sandbox_module_path)
@@ -867,6 +875,61 @@ module Kitchen
         path = (Pathname.new config[:test_folder]).realpath
         integration_path = File.join(path, "integration")
         Dir.exist?(integration_path) ? integration_path : path.to_s
+      rescue Errno::ENOENT
+        raise UserError, "The verifier's 'test_folder' is set to " \
+                         "'#{config[:test_folder]}', which does not exist. It is resolved " \
+                         "relative to the directory kitchen runs in, so give it a path that " \
+                         "exists there or an absolute one."
+      end
+
+      # Returns the entries of a config option that is documented as a list.
+      #
+      # YAML makes it easy to write a single mapping where a list of mappings
+      # was meant -- leaving off the leading `- ` is enough. `Array()` turns
+      # such a mapping into a list of `[key, value]` pairs, which then renders
+      # as nonsense PowerShell instead of failing, so reject it here where we
+      # can still say which option is at fault.
+      #
+      # @param key [String] the option's name, for the error message
+      # @param value [Object] the configured value
+      # @return [Array] the entries to iterate over
+      # @raise [Kitchen::UserError] when a single mapping was given
+      # @api private
+      def config_list(key, value)
+        if value.is_a?(Hash)
+          raise UserError, "The verifier's '#{key}' must be a list, but a single mapping " \
+                           "was given. Put a '- ' in front of each entry in kitchen.yml."
+        end
+
+        Array(value)
+      end
+
+      # Returns the Name of a mapping-shaped entry in one of the module or
+      # repository lists.
+      #
+      # The name becomes a PowerShell variable that the generated script splats,
+      # so a missing one either blows up here or emits an empty `${}` that fails
+      # on the instance a long way from its cause.
+      #
+      # @param key [String] the option's name, for the error message
+      # @param entry [Hash] the entry to read the name from
+      # @return [String] the entry's Name
+      # @raise [Kitchen::UserError] when the entry is not a mapping, or has no
+      #   usable Name
+      # @api private
+      def module_name!(key, entry)
+        unless entry.is_a?(Hash)
+          raise UserError, "Every entry under the verifier's '#{key}' must be a mapping with " \
+                           "at least a 'Name'; #{entry.inspect} is a #{entry.class}."
+        end
+
+        name = entry[:Name] || entry["Name"]
+        if name.to_s.empty?
+          raise UserError, "Every mapping under the verifier's '#{key}' needs a 'Name'; " \
+                           "#{entry.inspect} has none."
+        end
+
+        name.to_s
       end
 
       # Returns the final segment of a path that lives on the SUT.

data/lib/kitchen/verifier/pester_version.rb

@@ -30,6 +30,6 @@ module Kitchen
     # test-kitchen, which is not yet available when the gemspec is evaluated.
     #
     # @return [String] the gem version
-    PESTER_VERSION = "1.2.1"
+    PESTER_VERSION = "1.2.2"
   end
 end

metadata

@@ -1,83 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-pester
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Steven Murawski
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-08-23 00:00:00.000000000 Z
+date: 2026-08-30 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.25'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.25'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7'
-- !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: test-kitchen
   requirement: !ruby/object:Gem::Requirement