kitchen-pester 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8604ba8a6d0f832c3eeeea3d763051ed16991eb5bac45501b6dc8e734b99c85b
-  data.tar.gz: ee0b7ff38dfce855537e30510bca1f974db227bd0549716f07c6b82ce2574a5b
+  metadata.gz: e16e5c70ac65acec4f9178b9a790eb0679c0bc998eb6a0a140e8ab8c1fd9e40b
+  data.tar.gz: 7b6797461f5f7344b8055e733d66cd7b0b425f13a63c463342a7821412fa9990
 SHA512:
-  metadata.gz: 58e9f72997c8c22a5a66a93b53c522951d738de6a85e056386586b08be4fb235333017be25e421c37a3150b07e651ff686605535b7b5e0a7e7048674dadfcd57
-  data.tar.gz: '08a0a52e8df83182bd7376ff4412080a805ba7d0969be706d97f81f2df2d2e9024482c38a9a7d86a623e885f41dc860d8f1c6af885d1f3c39aa762df73f6d068'
+  metadata.gz: 7f826e3d30c87bfc1727c8812d5780f77318d20faeab508dbe9f18a1e98ba425151f59d73a8638e389d0a9231ac4575a6cec33ab61c5abb6c047131c4e548efa
+  data.tar.gz: f6c8c78499282f19c86b8abab1537650c6d560b7fc1a9bbad47a8768a41763b4d7d51082525f0e75c0e7f452c5bfd5f7ffdbab5c5815a4f675e98b5874f7719a

data/kitchen-pester.gemspec

@@ -12,9 +12,9 @@ Gem::Specification.new do |spec|
   spec.summary       = "Test-Kitchen verifier for Pester."
   spec.description   = "Skip all that Busser stuff and jump right into Pester."
   spec.homepage      = "https://github.com/test-kitchen/kitchen-pester"
-  spec.license       = "Apache 2"
+  spec.license       = "Apache-2.0"
 
-  spec.files         = %w{LICENSE kitchen-pester.gemspec Gemfile Rakefile lib/support/powershell/PesterUtil/PesterUtil.psm1}
+  spec.files         = %w(LICENSE kitchen-pester.gemspec Gemfile Rakefile) + Dir.glob('lib/**/*')
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler"

data/lib/kitchen/verifier/pester.rb

@@ -0,0 +1,335 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Steven Murawski (<steven.murawski@gmail.com>)
+#
+# Copyright (C) 2015, Steven Murawski
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "pathname"
+require "kitchen/verifier/base"
+require "kitchen/verifier/pester_version"
+
+module Kitchen
+
+  module Verifier
+
+    class Pester < Kitchen::Verifier::Base
+
+      kitchen_verifier_api_version 1
+
+      plugin_version Kitchen::Verifier::PESTER_VERSION
+
+      default_config :restart_winrm, false
+      default_config :test_folder
+      default_config :use_local_pester_module, false
+
+      # Creates a new Verifier object using the provided configuration data
+      # which will be merged with any default configuration.
+      #
+      # @param config [Hash] provided verifier configuration
+      def initialize(config = {})
+        init_config(config)
+      end
+
+      # Creates a temporary directory on the local workstation into which
+      # verifier related files and directories can be copied or created. The
+      # contents of this directory will be copied over to the instance before
+      # invoking the verifier's run command. After this method completes, it
+      # is expected that the contents of the sandbox is complete and ready for
+      # copy to the remote instance.
+      #
+      # **Note:** any subclasses would be well advised to call super first when
+      # overriding this method, for example:
+      #
+      # @example overriding `#create_sandbox`
+      #
+      #   class MyVerifier < Kitchen::Verifier::Base
+      #     def create_sandbox
+      #       super
+      #       # any further file copies, preparations, etc.
+      #     end
+      #   end
+      def create_sandbox
+        super
+        prepare_powershell_modules
+        prepare_pester_tests
+        prepare_helpers
+      end
+
+      # Generates a command string which will install and configure the
+      # verifier software on an instance. If no work is required, then `nil`
+      # will be returned.
+      #
+      # @return [String] a command string
+      def install_command
+        return if local_suite_files.empty?
+        return if config[:use_local_pester_module]
+
+        really_wrap_shell_code(install_command_script)
+      end
+
+      # Generates a command string which will perform any data initialization
+      # or configuration required after the verifier software is installed
+      # but before the sandbox has been transferred to the instance. If no work
+      # is required, then `nil` will be returned.
+      #
+      # @return [String] a command string
+      def init_command
+        restart_winrm_service if config[:restart_winrm]
+      end
+
+      # Generates a command string which will perform any commands or
+      # configuration required just before the main verifier run command but
+      # after the sandbox has been transferred to the instance. If no work is
+      # required, then `nil` will be returned.
+      #
+      # @return [String] a command string
+      def prepare_command; end
+
+      # Generates a command string which will invoke the main verifier
+      # command on the prepared instance. If no work is required, then `nil`
+      # will be returned.
+      #
+      # @return [String] a command string
+      def run_command
+        return if local_suite_files.empty?
+
+        really_wrap_shell_code(run_command_script)
+      end
+
+      # private
+      def run_command_script
+        <<-CMD
+          $TestPath = "#{config[:root_path]}";
+          import-module Pester -force;
+          $result = invoke-pester -path $testpath -passthru ;
+          $result |
+            export-clixml (join-path $testpath 'result.xml');
+          $host.setshouldexit($result.failedcount)
+        CMD
+      end
+
+      def really_wrap_shell_code(code)
+        wrap_shell_code(Util.outdent!(use_local_powershell_modules(code)))
+      end
+
+      def use_local_powershell_modules(script)
+        <<-EOH
+          set-executionpolicy unrestricted -force;
+          $global:ProgressPreference = 'SilentlyContinue'
+          $env:psmodulepath += ";$(join-path (resolve-path $env:temp).path 'verifier/modules')";
+          #{script}
+        EOH
+      end
+
+      def install_command_script
+        <<-EOH
+          [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
+          function directory($path){
+            if (test-path $path) {(resolve-path $path).providerpath}
+            else {(resolve-path (mkdir $path)).providerpath}
+          }
+          $VerifierModulePath = directory $env:temp/verifier/modules
+          $VerifierTestsPath = directory $env:temp/verifier/pester
+
+    $env:psmodulepath += ";$VerifierModulePath"
+          function test-module($module){
+            (get-module $module -list) -ne $null
+          }
+          if (-not (test-module pester)) {
+            if (test-module PowerShellGet){
+              import-module PowerShellGet -force
+              import-module PackageManagement -force
+              get-packageprovider -name NuGet -force | out-null
+              install-module Pester -force
+            }
+            else {
+              if (-not (test-module PsGet)){
+              $wc = New-Object -TypeName Net.WebClient
+
+              if($env:http_Proxy){
+                if($env:no_proxy){
+                  Write-Output "Creating WebProxy with 'http_proxy' and 'no_proxy' environment variables.
+                    $webproxy = New-Object System.Net.WebProxy($env:http_Proxy,$true,$env:no_proxy)
+                    }else{
+                  Write-Output "Creating WebProxy with 'http_proxy' environment variable.
+                  $webproxy = New-Object -TypeName System.Net.WebProxy -ArgumentList ($env:http_Proxy)
+                }
+
+                $wc.proxy = $webproxy
+              }
+
+              Invoke-Expression -Command $wc.DownloadString('http://bit.ly/GetPsGet')
+              }
+              try {
+                import-module psget -force -erroraction stop
+                Install-Module Pester
+              }
+              catch {
+                Write-Output "Installing from Github"
+                $zipfile = join-path(resolve-path "$env:temp/verifier") "pester.zip"
+                if (-not (test-path $zipfile)){
+                  $source = 'https://github.com/pester/Pester/archive/3.3.14.zip'
+                  $wc = New-Object -TypeName Net.WebClient
+
+                  if($env:http_Proxy){
+                    if($env:no_proxy){
+                      Write-Output "Creating WebProxy with 'http_proxy' and 'no_proxy' environment variables."
+                      $webproxy = New-Object System.Net.WebProxy($env:http_Proxy,$true,$env:no_proxy)
+                    }else{
+                      Write-Output "Creating WebProxy with 'http_proxy' environment variable."
+                      $webproxy = New-Object -TypeName System.Net.WebProxy -ArgumentList ($env:http_Proxy)
+                    }
+
+                  $wc.proxy = $webproxy
+                  }
+
+                  [byte[]]$bytes = $wc.DownloadData($source)
+                  [IO.File]::WriteAllBytes($zipfile, $bytes)
+                  $bytes = $null
+                  [gc]::collect()
+                  write-output "Downloaded Pester.zip"
+                }
+                write-output "Creating Shell.Application COM object"
+                $shellcom = new-object -com shell.application
+                Write-Output "Creating COM object for zip file."
+                $zipcomobject = $shellcom.namespace($zipfile)
+                Write-Output "Creating COM object for module destination."
+                $destination = $shellcom.namespace($VerifierModulePath)
+                Write-Output "Unpacking zip file."
+                $destination.CopyHere($zipcomobject.Items(), 0x610)
+                rename-item (join-path $VerifierModulePath "Pester-3.3.14") -newname 'Pester' -force
+              }
+            }
+          }
+          if (-not (test-module Pester)) {
+            throw "Unable to install Pester.  Please include Pester in your base image or install during your converge."
+          }
+        EOH
+      end
+
+      def restart_winrm_service
+        cmd = "schtasks /Create /TN restart_winrm /TR " \
+              '"powershell -command restart-service winrm" ' \
+              "/SC ONCE /ST 00:00 "
+        wrap_shell_code(Util.outdent!(<<-CMD
+          #{cmd}
+          schtasks /RUN /TN restart_winrm
+        CMD
+                                     ))
+      end
+
+      # Returns an Array of test suite filenames for the related suite currently
+      # residing on the local workstation. Any special provisioner-specific
+      # directories (such as a Chef roles/ directory) are excluded.
+      #
+      # @return [Array<String>] array of suite files
+      # @api private
+
+      def suite_test_folder
+        @suite_test_folder ||= File.join(test_folder, config[:suite_name])
+      end
+
+      def suite_level_glob
+        Dir.glob(File.join(suite_test_folder, "*"))
+      end
+
+      def suite_verifier_level_glob
+        Dir.glob(File.join(suite_test_folder, "*/**/*"))
+      end
+
+      def local_suite_files
+        suite = suite_level_glob
+        suite_verifier = suite_verifier_level_glob
+        (suite << suite_verifier).flatten!.reject do |f|
+          File.directory?(f)
+        end
+      end
+
+      def sandboxify_path(path)
+        File.join(sandbox_path, path.sub(%r{#{suite_test_folder}/}i, ""))
+      end
+
+      # Returns an Array of common helper filenames currently residing on the
+      # local workstation.
+      #
+      # @return [Array<String>] array of helper files
+      # @api private
+      def helper_files
+        glob = Dir.glob(File.join(test_folder, "helpers", "*/**/*"))
+        glob.reject { |f| File.directory?(f) }
+      end
+
+      # Copies all common testing helper files into the suites directory in
+      # the sandbox.
+      #
+      # @api private
+      def prepare_helpers
+        base = File.join(test_folder, "helpers")
+
+        helper_files.each do |src|
+          dest = File.join(sandbox_path, src.sub("#{base}/", ""))
+          debug("Copying #{src} to #{dest}")
+          FileUtils.mkdir_p(File.dirname(dest))
+          FileUtils.cp(src, dest, preserve: true)
+        end
+      end
+
+      # Copies all test suite files into the suites directory in the sandbox.
+      #
+      # @api private
+      def prepare_pester_tests
+        info("Preparing to copy files from #{suite_test_folder} to the SUT.")
+
+        local_suite_files.each do |src|
+          dest = sandboxify_path(src)
+          debug("Copying #{src} to #{dest}")
+          FileUtils.mkdir_p(File.dirname(dest))
+          FileUtils.cp(src, dest, preserve: true)
+        end
+      end
+
+      def prepare_powershell_module(name)
+        FileUtils.mkdir_p(File.join(sandbox_path, "modules/#{name}"))
+        FileUtils.cp(
+          File.join(File.dirname(__FILE__), "../../support/powershell/#{name}/#{name}.psm1"),
+          File.join(sandbox_path, "modules/#{name}/#{name}.psm1"),
+          preserve: true
+        )
+      end
+
+      def prepare_powershell_modules
+        info("Preparing to copy supporting powershell modules.")
+        %w{PesterUtil}.each do |module_name|
+          prepare_powershell_module module_name
+        end
+      end
+
+      def test_folder
+        return config[:test_base_path] if config[:test_folder].nil?
+
+        absolute_test_folder
+      end
+
+      def absolute_test_folder
+        path = (Pathname.new config[:test_folder]).realpath
+        integration_path = File.join(path, "integration")
+        return path unless Dir.exist?(integration_path)
+
+        integration_path
+      end
+
+    end
+  end
+end

data/lib/kitchen/verifier/pester_version.rb

@@ -0,0 +1,5 @@
+module Kitchen
+  module Verifier
+    PESTER_VERSION = "0.9.1".freeze
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-pester
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Steven Murawski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-16 00:00:00.000000000 Z
+date: 2019-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,10 +103,12 @@ files:
 - LICENSE
 - Rakefile
 - kitchen-pester.gemspec
+- lib/kitchen/verifier/pester.rb
+- lib/kitchen/verifier/pester_version.rb
 - lib/support/powershell/PesterUtil/PesterUtil.psm1
 homepage: https://github.com/test-kitchen/kitchen-pester
 licenses:
-- Apache 2
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []