kitchen-pester 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d308bdccbb4f9795482dcdac1abbe373935c4cb164e0bb1bca3d16c8d7185fe
-  data.tar.gz: 798da4d69f83306722efd7311104e8797611cec975af00d88168c535a2056cc7
+  metadata.gz: 19d804e92d719bc9b7a474f32fb09562e5ca26e56a7d22f2ce432a5b704fd59f
+  data.tar.gz: 85891cc61ec3764ba9d9397958f8610f3a3e9238d53c6b6f9fdc26814ada51b2
 SHA512:
-  metadata.gz: 5bebf6a71183b7c02b3dcce3c8f1769b039dd30266a4da75da95f5c9fefd7da00f42421950e543fa529cfdf3cdbf2eb41756569d13e0a91bce68af881aed3cc3
-  data.tar.gz: 408ac94d07a5b4a544892f325b7c70b85dbf4e9dcc9193d4505ca3307fcbda5b5e0f5a49c1a3f80cda8b8f084490cf52d7ac5169b372419c6a2075abbb21467a
+  metadata.gz: 7da614b278d3fc0f408dc0d913ba9c853bf3997ef669aba45578bb23d65c725bcefcaffb75b8d799f579fca233ae7f84134983cb6147b7bcd91c51041c0dbb2b
+  data.tar.gz: 56af02995deb34e6a6044396096ada3b4fbe371b9d8c2be1a74dbf8109728808110d28e9a9e620951530bc48e5b2ac3bbf49ba07046630f393c67c8d2b83a766

data/Gemfile

@@ -11,7 +11,7 @@ group :integration do
 end
 
 group :changelog do
-  gem "github_changelog_generator", "1.15.2"
+  gem "github_changelog_generator", "1.16.4"
 end
 
 group :debug do

data/Rakefile

@@ -23,7 +23,7 @@ desc "Run all quality tasks"
 task quality: :style
 
 begin
-  require "yard"
+  require "yard" unless defined?(YARD)
   YARD::Rake::YardocTask.new
 rescue LoadError
   puts "yard is not available. (sudo) gem install yard to generate yard documentation."

data/kitchen-pester.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require "kitchen/verifier/pester_version"
@@ -16,10 +16,9 @@ Gem::Specification.new do |spec|
   spec.files         = %w{LICENSE kitchen-pester.gemspec Gemfile Rakefile} + Dir.glob("lib/**/*")
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest",  "~> 5.3", "< 5.15"
+  spec.add_development_dependency "minitest",  "~> 5.3", "< 5.16"
   spec.add_development_dependency "mocha",     "~> 1.1"
 
-  spec.add_dependency "test-kitchen", ">= 1.10", "< 3"
+  spec.add_dependency "test-kitchen", ">= 1.10", "< 4"
 end

data/lib/kitchen/verifier/pester.rb

@@ -14,12 +14,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "fileutils"
-require "pathname"
+require "fileutils" unless defined?(FileUtils)
+require "pathname" unless defined?(Pathname)
 require "kitchen/util"
 require "kitchen/verifier/base"
 require "kitchen/version"
-require "base64"
+require "base64" unless defined?(Base64)
 require_relative "pester_version"
 
 module Kitchen
@@ -47,10 +47,26 @@ module Kitchen
         Force: true,
         ErrorAction: "Stop",
       }
+      default_config :pester_configuration, {
+        run: {
+          path: ".",
+          PassThru: true,
+        },
+        TestResult: {
+          Enabled: true,
+          OutputPath: "PesterTestResults.xml",
+          TestSuiteName: "",
+        },
+        Output: {
+          Verbosity: "Detailed",
+        },
+      }
       default_config :install_modules, []
-      default_config :downloads, ["./PesterTestResults.xml"] => "./testresults"
+      default_config :downloads, { "./PesterTestResults.xml" => "./testresults/" }
       default_config :copy_folders, []
       default_config :sudo, false
+      default_config :shell, nil
+      default_config :environment, {}
 
       # Creates a new Verifier object using the provided configuration data
       # which will be merged with any default configuration.
@@ -58,6 +74,7 @@ module Kitchen
       # @param config [Hash] provided verifier configuration
       def initialize(config = {})
         init_config(config)
+        raise ClientError.new "Environment Variables must be specified as a hash, not a #{config[:environment].class}" unless config[:environment].is_a?(Hash)
       end
 
       # Creates a temporary directory on the local workstation into which
@@ -115,7 +132,7 @@ module Kitchen
           )
 
           if ($modulesToRemove.ModuleBase.Count -eq 0) {
-            # for PS7 on linux  
+            # for PS7 on linux
             return
           }
 
@@ -150,6 +167,7 @@ module Kitchen
       # @return [String] a command string
       def prepare_command
         info("Preparing the SUT and Pester dependencies...")
+        resolve_downloads_paths!
         really_wrap_shell_code(install_command_script)
       end
 
@@ -159,7 +177,39 @@ module Kitchen
       #
       # @return [String] a command string
       def run_command
-        really_wrap_shell_code(run_command_script)
+        really_wrap_shell_code(invoke_pester_scriptblock)
+      end
+
+      # Resolves the remote Downloads path from the verifier root path,
+      # unless they're absolute path (starts with / or C:\)
+      # This updates the config[:downloads], nothing (nil) is returned.
+      #
+      # @return [nil] updates config downloads
+      def resolve_downloads_paths!
+        info("Resolving Downloads path from config.")
+        config[:downloads] = config[:downloads]
+          .map do |source, destination|
+            source = source.to_s
+            destination = destination.gsub("%{instance_name}", instance.name)
+            info("  resolving remote source's absolute path.")
+            unless source.match?('^/|^[a-zA-Z]:[\\/]') # is Absolute?
+              info("  '#{source}' is a relative path, resolving to: #{File.join(config[:root_path], source)}")
+              source = File.join(config[:root_path], source.to_s).to_s
+            end
+
+            if destination.match?('\\$|/$') # is Folder (ends with / or \)
+              destination = File.join(destination, File.basename(source)).to_s
+            end
+            info("  Destination: #{destination}")
+            if !File.directory?(File.dirname(destination))
+              FileUtils.mkdir_p(File.dirname(destination))
+            else
+              info("  Directory #{File.dirname(destination)} seems to exist.")
+            end
+
+            [ source, destination ]
+          end
+        nil # make sure we do not return anything
       end
 
       # Download functionality was added to the base verifier behavior after
@@ -168,7 +218,9 @@ module Kitchen
         def call(state)
           super
         ensure
-          download_test_files(state) unless config[:download].nil?
+          info("Ensure download test files.")
+          download_test_files(state) unless config[:downloads].nil?
+          info("Download complete.")
         end
       else
         def call(state)
@@ -176,25 +228,88 @@ module Kitchen
         rescue
           # If the verifier reports failure, we need to download the files ourselves.
           # Test Kitchen's base verifier doesn't have the download in an `ensure` block.
-          download_test_files(state) unless config[:download].nil?
-
+          info("Rescue to download test files.")
+          download_test_files(state) unless config[:downloads].nil?
           # Rethrow original exception, we still want to register the failure.
           raise
         end
       end
 
       # private
-      def run_command_script
+      def invoke_pester_scriptblock
         <<-PS1
-          Import-Module -Name Pester -Force -ErrorAction Stop
+          $PesterModule = Import-Module -Name Pester -Force -ErrorAction Stop -PassThru
 
           $TestPath = Join-Path "#{config[:root_path]}" -ChildPath "suites"
           $OutputFilePath = Join-Path "#{config[:root_path]}" -ChildPath 'PesterTestResults.xml'
 
-          $options = New-PesterOption -TestSuiteName "Pester - #{instance.to_str}"
+          #{ps_environment(config[:environment])}
+          if ($PesterModule.Version.Major -le 4)
+          {
+            Write-Host -Object "Invoke Pester with v$($PesterModule.Version) Options"
+            $options = New-PesterOption -TestSuiteName "Pester - #{instance.to_str}"
+            $defaultPesterParameters = @{
+                Script        = $TestPath
+                OutputFile    = $OutputFilePath
+                OutputFormat  = 'NUnitXml'
+                PassThru      = $true
+                PesterOption  = $options
+            }
+
+            $pesterCmd = Get-Command -Name 'Invoke-Pester'
+            $pesterConfig = #{ps_hash(config[:pester_configuration])}
+            $invokePesterParams = @{}
+
+            foreach ($paramName in $pesterCmd.Parameters.Keys)
+            {
+                $paramValue = $pesterConfig.($paramName)
+
+                if ($paramValue) {
+                    Write-Host -Object "Using $paramName from Yaml config."
+                    $invokePesterParams[$paramName] = $paramValue
+                }
+                elseif ($defaultPesterParameters.ContainsKey($paramName))
+                {
+                    Write-Host -Object "Using $paramName from Defaults: $($defaultPesterParameters[$paramName])."
+                    $invokePesterParams[$paramName] = $defaultPesterParameters[$paramName]
+                }
+            }
+
+            $result = Invoke-Pester @invokePesterParams
+          }
+          else
+          {
+            Write-Host -Object "Invoke Pester with v$($PesterModule.Version) Configuration."
+            $pesterConfigHash = #{ps_hash(config[:pester_configuration])}
+
+            if (-not $pesterConfigHash.ContainsKey('run')) {
+                $pesterConfigHash['run'] = @{}
+            }
+
+            if (-not $pesterConfigHash.ContainsKey('TestResult')) {
+                $pesterConfigHash['TestResult'] = @{}
+            }
+
+            if (-not $pesterConfigHash.run.path) {
+                $pesterConfigHash['run']['path'] = $TestPath
+            }
+
+            if (-not $pesterConfigHash.TestResult.TestSuiteName) {
+                $pesterConfigHash['TestResult']['TestSuiteName'] = 'Pester - #{instance.to_str}'
+            }
+
+            if (-not $pesterConfigHash.TestResult.OutputPath) {
+                $pesterConfigHash['TestResult']['OutputPath'] = $OutputFilePath
+            }
 
-          $result = Invoke-Pester -Script $TestPath -OutputFile $OutputFilePath -OutputFormat NUnitXml -PesterOption $options -PassThru
-          $result | Export-CliXml -Path (Join-Path -Path $TestPath -ChildPath 'result.xml')
+            $PesterConfig = New-PesterConfiguration -Hashtable $pesterConfigHash
+            $result = Invoke-Pester -Configuration $PesterConfig
+          }
+
+          $resultXmlPath = (Join-Path -Path $TestPath -ChildPath 'result.xml')
+          if (Test-Path -Path $resultXmlPath) {
+            $result | Export-CliXml -Path
+          }
 
           $LASTEXITCODE = $result.FailedCount
           $host.SetShouldExit($LASTEXITCODE)
@@ -216,6 +331,7 @@ module Kitchen
           if powershell_module.is_a? Hash
             <<-PS1
               ${#{powershell_module[:Name]}} = #{ps_hash(powershell_module)}
+
               Install-ModuleFromNuget -Module ${#{powershell_module[:Name]}} #{gallery_url_param}
             PS1
           else
@@ -231,7 +347,7 @@ module Kitchen
       #
       # @return [Array<String>] array of suite files
       # @api private
-      def register_psrepository
+      def register_psrepository_scriptblock
         return if config[:register_repository].nil?
 
         info("Registering a new PowerShellGet Repository")
@@ -302,30 +418,60 @@ module Kitchen
         windows_os? ? really_wrap_windows_shell_code(code) : really_wrap_posix_shell_code(code)
       end
 
+      # Get the defined shell or fall back to pwsh, unless we're on windows where we use powershell
+      # call via sudo if sudo is true.
+      # This allows to use pwsh-preview instead of pwsh, or a full path to a specific binary.
+      def shell_cmd
+        if !config[:shell].nil?
+          config[:sudo] ? "sudo #{config[:shell]}" : "#{config[:shell]}"
+        elsif windows_os?
+          "powershell"
+        else
+          config[:sudo] ? "sudo pwsh" : "pwsh"
+        end
+      end
+
       def really_wrap_windows_shell_code(code)
-        wrap_shell_code(Util.outdent!(use_local_powershell_modules(code)))
+        my_command = <<-PWSH
+          echo "Running as '$(whoami)'..."
+          New-Item -ItemType Directory -Path '#{config[:root_path]}/modules' -Force -ErrorAction SilentlyContinue
+          Set-Location -Path "#{config[:root_path]}"
+          # Send the pwsh here string to the file kitchen_cmd.ps1
+          @'
+          try {
+              if (@('Bypass', 'Unrestricted') -notcontains (Get-ExecutionPolicy)) {
+                  Set-ExecutionPolicy Unrestricted -Force -Scope Process
+              }
+          }
+          catch {
+              $_ | Out-String | Write-Warning
+          }
+          #{Util.outdent!(use_local_powershell_modules(code))}
+          '@ | Set-Content -Path kitchen_cmd.ps1 -Encoding utf8 -Force -ErrorAction 'Stop'
+          # create the modules folder, making sure it's done as current user (not root)
+          #
+          # Invoke the created kitchen_cmd.ps1 file using pwsh
+          #{shell_cmd} ./kitchen_cmd.ps1
+        PWSH
+        wrap_shell_code(Util.outdent!(my_command))
       end
 
       # Writing the command to a ps1 file, adding the pwsh shebang
       # invoke the file
       def really_wrap_posix_shell_code(code)
-        if config[:sudo]
-          pwsh_cmd = "sudo pwsh"
-        else
-          pwsh_cmd = "pwsh"
-        end
-
         my_command = <<-BASH
           echo "Running as '$(whoami)'"
-          # Send the bash heredoc 'EOF' to the file current.ps1 using the tool cat
-          cat << 'EOF' > current.ps1
+          # create the modules folder, making sure it's done as current user (not root)
+          mkdir -p #{config[:root_path]}/modules
+          cd #{config[:root_path]}
+          # Send the bash heredoc 'EOF' to the file kitchen_cmd.ps1 using the tool cat
+          cat << 'EOF' > kitchen_cmd.ps1
           #!/usr/bin/env pwsh
           #{Util.outdent!(use_local_powershell_modules(code))}
           EOF
-          # create the modules folder, making sure it's done as current user (not root)
-          mkdir -p foo #{config[:root_path]}/modules
-          # Invoke the created current.ps1 file using pwsh
-          #{pwsh_cmd} -f current.ps1
+          chmod +x kitchen_cmd.ps1
+          # Invoke the created kitchen_cmd.ps1 file using pwsh
+          #{shell_cmd} ./kitchen_cmd.ps1
         BASH
 
         debug(Util.outdent!(my_command))
@@ -334,23 +480,15 @@ module Kitchen
 
       def use_local_powershell_modules(script)
         <<-PS1
-          try {
-            if (!$IsLinux -and !$IsMacOs) {
-              Set-ExecutionPolicy Unrestricted -force
-            }
-          }
-          catch {
-              $_ | Out-String | Write-Warning
-          }
-
+          Write-Host -Object ("{0} - PowerShell {1}" -f $PSVersionTable.OS,$PSVersionTable.PSVersion)
           $global:ProgressPreference = 'SilentlyContinue'
           $PSModPathToPrepend = Join-Path "#{config[:root_path]}" -ChildPath 'modules'
           Write-Verbose "Adding '$PSModPathToPrepend' to `$Env:PSModulePath."
           if (!$isLinux -and -not (Test-Path -Path $PSModPathToPrepend)) {
-            # if you create this folder now un Linux, it will run as root (via sudo).
+            # if you create this folder now in Linux, it may run as root (via sudo).
             $null = New-Item -Path $PSModPathToPrepend -Force -ItemType Directory
           }
-          
+
           if ($Env:PSModulePath.Split([io.path]::PathSeparator) -notcontains $PSModPathToPrepend) {
             $env:PSModulePath   = @($PSModPathToPrepend, $env:PSModulePath) -Join [io.path]::PathSeparator
           }
@@ -367,7 +505,7 @@ module Kitchen
 
           #{get_powershell_modules_from_nugetapi.join("\n") unless config.dig(:bootstrap, :modules).nil?}
 
-          #{register_psrepository.join("\n") unless config[:register_repository].nil?}
+          #{register_psrepository_scriptblock.join("\n") unless config[:register_repository].nil?}
 
           #{install_pester}
 
@@ -389,12 +527,15 @@ module Kitchen
       end
 
       def download_test_files(state)
-        return if config[:downloads].nil?
+        if config[:downloads].nil?
+          info("Skipped downloading test result file from #{instance.to_str}; 'downloads' hash is empty.")
+          return
+        end
 
         info("Downloading test result files from #{instance.to_str}")
         instance.transport.connection(state) do |conn|
-          config[:downloads].to_h.each do |remotes, local|
-            debug("Downloading #{Array(remotes).join(", ")} to #{local}")
+          config[:downloads].each do |remotes, local|
+            debug("downloading #{Array(remotes).join(", ")} to #{local}")
             conn.download(remotes, local)
           end
         end
@@ -480,6 +621,17 @@ module Kitchen
         end
       end
 
+      # Creates environment variable assignments from a ruby map.
+      #
+      # @api private
+      def ps_environment(obj)
+        commands = obj.map do |k, v|
+          "$env:#{k} = '#{v}'"
+        end
+
+        commands.join("\n")
+      end
+
       # returns the path of the modules subfolder
       # in the sandbox, where PS Modules and folders will be copied to.
       #
@@ -527,7 +679,7 @@ module Kitchen
       end
 
       def prepare_supporting_psmodules
-        debug("Preparing to copy files from '#{support_psmodule_folder}' to the SUT.")
+        info("Preparing to copy files from '#{support_psmodule_folder}' to the SUT.")
         sandbox_module_path = File.join(sandbox_path, "modules")
         copy_if_src_exists(support_psmodule_folder, sandbox_module_path)
       end
@@ -542,7 +694,7 @@ module Kitchen
           return
         end
 
-        debug("Moving #{src_to_validate} to #{destination}")
+        info("Moving #{src_to_validate} to #{destination}")
         unless Dir.exist?(destination)
           FileUtils.mkdir_p(destination)
           debug("Folder '#{destination}' created.")

data/lib/kitchen/verifier/pester_version.rb

@@ -1,5 +1,5 @@
 module Kitchen
   module Verifier
-    PESTER_VERSION = "1.0.0".freeze
+    PESTER_VERSION = "1.2.0".freeze
   end
 end

data/lib/support/modules/PesterUtil/PesterUtil.psm1

@@ -106,8 +106,9 @@ function Set-PSRepo {
         [Parameter(Mandatory)]
         $Repository
     )
+    
     if (-not (Get-Command Get-PSRepository) -and (Get-Command Get-PackageSource)) {
-        # Old version of PSGet do not have a *-PSrepository but have *-PackageSource instead.
+        # Old versions of PSGet do not have a *-PSrepository but have *-PackageSource instead.
         if (Get-PackageSource -Name $Repository.Name)  {
             Set-PackageSource @Repository
         }

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-pester
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Steven Murawski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-19 00:00:00.000000000 Z
+date: 2022-05-14 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -47,7 +33,7 @@ dependencies:
         version: '5.3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.15'
+        version: '5.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -57,7 +43,7 @@ dependencies:
         version: '5.3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.15'
+        version: '5.16'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +67,7 @@ dependencies:
         version: '1.10'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -91,7 +77,7 @@ dependencies:
         version: '1.10'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
 description: Skip all that Busser stuff and jump right into Pester.
 email:
 - steven.murawski@gmail.com
@@ -125,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Test-Kitchen verifier for Pester.