kitchen-hyperv 0.5.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f95a36b67d309f5558ce09e652f1b2e1dae920b3e4f7dd87ef42e874d0d70b89
-  data.tar.gz: d226329f6c724cf74adce0422276f0b4346e57cd7f1964e42f24a7c2a59c88aa
+  metadata.gz: 21905b2f2c54db8a9414e98231c4eaa08c66cfa8aab926bf41248a8159663b29
+  data.tar.gz: 2ae8c16b86ee2933635c59f5e8403c42507d9ea2461c4c581c3468e409967c89
 SHA512:
-  metadata.gz: 3a71c5e7ae19eadf9bdacd4fa616365e162f944c36bc14b3091cdabc71ca845062d900790d79455a1b07fd68b159aacc85b5ab861b798e14f82ad8d230129273
-  data.tar.gz: eac21386957db5983da0411ad14d11c5b7f2bbf38406b57fd78c56ca05c32e137b62be9e7e8ba0638eaeaab633b52a1b323d339d4cad743735a4291172384d4d
+  metadata.gz: 171d1d798fad06869c129086e5b72a093b3457ed4149cfb0ddc971756e70590f5359149a042519bc0d208381b61c9ebffc6b2c5c16f28c63f128ee14edf8815c
+  data.tar.gz: c7ff58b26dda26b67289a8acf66ae3bbdd152862b85e6bb9b2ed592833b0c2e44e980e3c4b8e17d24d1a108fe734820ed1da241778713c6d74819c9cd04ad8e0

data/Gemfile

@@ -0,0 +1,25 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in kitchen-pester.gemspec
+gemspec
+
+group :integration do
+  gem "berkshelf"
+  gem "kitchen-inspec"
+  gem "kitchen-dokken"
+  gem "kitchen-vagrant"
+end
+
+group :debug do
+  gem "pry"
+  gem "pry-byebug"
+  gem "pry-stack_explorer"
+end
+
+group :chefstyle do
+  gem "chefstyle"
+end
+
+group :docs do
+  gem "yard"
+end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2015 Steven Murawski
+Copyright (c) 2020 Steven Murawski
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/Rakefile

@@ -0,0 +1,48 @@
+require "bundler/gem_tasks"
+require "kitchen/driver/hyperv_version"
+
+require "rake/testtask"
+Rake::TestTask.new(:unit) do |t|
+  t.libs.push "lib"
+  t.test_files = FileList["spec/**/*_spec.rb"]
+  t.verbose = true
+end
+
+desc "Run all test suites"
+task test: :unit
+
+begin
+  require "chefstyle"
+  require "rubocop/rake_task"
+  RuboCop::RakeTask.new(:style) do |task|
+    task.options += ["--display-cop-names", "--no-color"]
+  end
+rescue LoadError
+  puts "chefstyle is not available. (sudo) gem install chefstyle to do style checking."
+end
+
+desc "Run all quality tasks"
+task quality: :style
+
+begin
+  require "yard" unless defined?(YARD)
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  puts "yard is not available. (sudo) gem install yard to generate yard documentation."
+end
+
+task default: %i{test quality}
+begin
+  require "github_changelog_generator/task"
+
+  GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+    config.future_release = "v#{Kitchen::Driver::HYPERV_VERSION}"
+    config.issues = false
+    config.pulls = true
+    config.user = "test-kitchen"
+    config.project = "kitchen-hyperv"
+  end
+rescue LoadError
+  puts "github_changelog_generator is not available. " \
+    "gem install github_changelog_generator to generate changelogs"
+end

data/kitchen-hyperv.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "kitchen/driver/hyperv_version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "kitchen-hyperv"
+  spec.version       = Kitchen::Driver::HYPERV_VERSION
+  spec.authors       = ["Steven Murawski"]
+  spec.email         = ["steven.murawski@gmail.com"]
+  spec.summary       = "Hyper-V Driver for Test-Kitchen"
+  spec.description   = "Hyper-V Driver for Test-Kitchen"
+  spec.homepage      = "https://github.com/test-kitchen/kitchen-hyperv"
+  spec.license       = "Apache-2.0"
+
+  spec.files         = %w{LICENSE kitchen-hyperv.gemspec Gemfile Rakefile support/hyperv.ps1} + Dir.glob("lib/**/*")
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", "~> 5.3", "< 5.15"
+  spec.add_development_dependency "minitest-stub-const"
+  spec.add_development_dependency "mocha", "~> 1.1"
+
+  spec.add_dependency "test-kitchen", ">= 1.4", "< 4"
+  spec.add_dependency "train", "~> 3.5"
+  spec.add_dependency "train-winrm", "~> 0.2"
+end

data/lib/kitchen/driver/hyperv.rb

@@ -1,279 +1,354 @@
-#
-# Author:: Steven Murawski <smurawski@chef.io>
-# Copyright:: Copyright (c) 2015 Chef Software, Inc.
-# License:: Apache License, Version 2.0
-#
-# 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 'kitchen'
-require 'kitchen/driver'
-require 'kitchen/driver/hyperv_version'
-require 'kitchen/driver/powershell'
-require 'mixlib/shellout'
-require 'fileutils'
-require 'json'
-
-module Kitchen
-
-  module Driver
-
-    # Driver for Hyper-V
-    class Hyperv < Kitchen::Driver::Base
-
-      kitchen_driver_api_version 2
-      plugin_version Kitchen::Driver::HYPERV_VERSION
-
-      default_config :parent_vhd_folder
-      default_config :parent_vhd_name
-      default_config :memory_startup_bytes, 536_870_912
-      default_config :dynamic_memory_min_bytes, 536_870_912
-      default_config :dynamic_memory_max_bytes, 2_147_483_648
-      default_config :dynamic_memory, false
-      default_config :processor_count, 2
-      default_config :ip_address
-      default_config :gateway
-      default_config :dns_servers
-      default_config :subnet, '255.255.255.0'
-      default_config :vm_switch
-      default_config :vm_vlan_id
-      default_config :iso_path
-      default_config :boot_iso_path
-      default_config :enable_guest_services
-      default_config :vm_note
-      default_config :resize_vhd
-      default_config :additional_disks
-      default_config :vm_generation, 1
-      default_config :disable_secureboot, false
-      default_config :static_mac_address
-      default_config :disk_type do |driver|
-        File.extname(driver[:parent_vhd_name])
-      end
-
-      include Kitchen::Driver::PowerShellScripts
-
-      def create(state)
-        @state = state
-        validate_vm_settings
-        create_new_differencing_disk
-        create_additional_disks
-        create_virtual_machine
-        set_virtual_machine_note
-        update_state
-        mount_virtual_machine_iso
-        instance.transport.connection(@state).wait_until_ready
-        copy_vm_files
-        info("Hyper-V instance #{instance.to_str} created.")
-      end
-
-      def destroy(state)
-        @state = state
-        if differencing_disk_exists && !vm_exists_silent
-          remove_differencing_disk
-        end
-        return unless vm_exists
-        instance.transport.connection(state).close
-        remove_virtual_machine
-        remove_differencing_disk
-        remove_additional_disks
-        info("The Hyper-V instance #{instance.to_str} has been removed.")
-        state.delete(:id)
-      end
-
-      private
-
-      def validate_vm_settings
-        raise "Missing parent_vhd_folder" unless vhd_folder?
-        raise "Missing parent_vhd_name" unless vhd?
-        if config[:dynamic_memory]
-          startup_bytes = config[:memory_startup_bytes]
-          min = config[:dynamic_memory_min_bytes]
-          max = config[:dynamic_memory_max_bytes]
-          memory_valid = startup_bytes.between?(min, max)
-          warning = "memory_startup_bytes (#{startup_bytes}) must" \
-                    " fall within dynamic memory range (#{min}-#{max})"
-          raise warning unless memory_valid
-        end
-        config[:vm_switch] = vm_switch
-        if config[:vm_vlan_id]
-          vm_vlan_id = config[:vm_vlan_id]
-          vm_vlan_id_min = 1
-          vm_vlan_id_max = 4094
-          vm_vlan_id_valid = vm_vlan_id.between?(vm_vlan_id_min, vm_vlan_id_max)
-          vm_vlan_id_warning = "vm_vlan_id (#{vm_vlan_id}) must be a valid 802.1Q" \
-                               " VLAN ID between (#{vm_vlan_id_min}-#{vm_vlan_id_max})"
-          raise vm_vlan_id_warning unless vm_vlan_id_valid
-        end
-      end
-
-      def create_new_differencing_disk
-        info("Creating differencing disk for #{instance.name}.")
-        run_ps new_differencing_disk_ps
-        info("Created differencing disk for #{instance.name}.")
-        set_new_vhd_size
-      end
-
-      def create_additional_disks
-        return if config[:additional_disks].nil?
-        @additional_disk_objects = []
-        config[:additional_disks].each do |additional_disk|
-          raise "Missing name for additional disk" unless additional_disk[:name]
-          disk_type = additional_disk[:type] || config[:disk_type]
-          disk_path = additional_disk_path(additional_disk[:name], disk_type)
-          raise "Additional disk file already exists: #{disk_path}" unless !File.exist?(disk_path)
-          disk_size = additional_disk[:size_gb] || 5
-          info("Creating additional disk #{additional_disk[:name]} for #{instance.name}.")
-          run_ps new_additional_disk_ps(disk_path, disk_size)
-          info("Created additional disk #{additional_disk[:name]} for #{instance.name}.")
-          @additional_disk_objects.push(disk_path)
-        end
-      end
-
-      def vm_switch
-        default_switch_object = run_ps vm_default_switch_ps
-        if default_switch_object.nil? ||
-           !default_switch_object.key?('Name') ||
-           default_switch_object['Name'].empty?
-          raise "Failed to find a default VM Switch."
-        end
-        default_switch_object['Name']
-      end
-
-      def create_virtual_machine
-        return if vm_exists
-        info("Creating virtual machine for #{instance.name}.")
-        new_vm_object = run_ps new_vm_ps
-        @state[:id] = new_vm_object['Id']
-        info("Created virtual machine for #{instance.name}.")
-      end
-
-      def update_state
-        vm_details
-        @state[:id] = @vm['Id']
-        @state[:hostname] = @vm['IpAddress']
-        @state[:vm_name] = @vm['Name']
-      end
-
-      def vm_details
-        run_ps set_vm_ipaddress_ps if config[:ip_address]
-        @vm = run_ps vm_details_ps
-      end
-
-      def mount_virtual_machine_iso
-        return unless config[:iso_path]
-        info("Mounting #{config[:iso_path]}")
-        run_ps mount_vm_iso
-        info("Done mounting #{config[:iso_path]}")
-      end
-
-      def set_new_vhd_size
-        return unless config[:resize_vhd]
-        info("Resizing differencing disk for #{instance.name}.")
-        run_ps resize_vhd
-        info("Resized differencing disk for #{instance.name}.")
-      end
-
-      def set_virtual_machine_note
-        return unless config[:vm_note]
-        info("Adding note to VM: '#{config[:vm_note]}'")
-        run_ps set_vm_note
-      end
-
-      def copy_vm_files
-        return if config[:copy_vm_files].nil?
-        info("Copying files to virtual machine")
-        config[:copy_vm_files].each do |file_info|
-          run_ps copy_vm_file_ps(file_info[:source], file_info[:dest])
-        end
-        info("Copied files to virtual machine")
-      end
-
-      def vm_exists
-        info('Checking for existing virtual machine.')
-        return false unless @state.key?(:id) && !@state[:id].nil?
-        existing_vm = run_ps ensure_vm_running_ps
-        return false if existing_vm.nil? || existing_vm['Id'].nil?
-        info("Found an exising VM with an ID: #{existing_vm['Id']}")
-        true
-      end
-
-      # Used in testing if a stale diff disk exists.  Silent so the output doesn't
-      # appear twice on the kitchen destroy command for the second check for vm_exists
-      def vm_exists_silent
-        return false unless @state.key?(:id) && !@state[:id].nil?
-        existing_vm = run_ps ensure_vm_running_ps
-        return false if existing_vm.nil? || existing_vm['Id'].nil?
-        true
-      end
-
-      def differencing_disk_exists
-        return unless File.exist? differencing_disk_path
-        true
-      end
-
-      def remove_virtual_machine
-        info("Deleting virtual machine for #{instance.name}")
-        run_ps delete_vm_ps
-        info("Deleted virtual machine for #{instance.name}")
-      end
-
-      def remove_differencing_disk
-        info("Removing the differencing disk for #{instance.name}.")
-        FileUtils.rm(differencing_disk_path)
-        info("Removed the differencing disk for #{instance.name}.")
-      end
-
-      def remove_additional_disks
-        return if config[:additional_disks].nil?
-        config[:additional_disks].each do |additional_disk|
-          raise "Missing name for additional disk" unless additional_disk[:name]
-          disk_type = additional_disk[:type] || config[:disk_type]
-          disk_path = additional_disk_path(additional_disk[:name], disk_type)
-          if File.exist?(disk_path)
-            info("Removing additional disk #{additional_disk[:name]} for #{instance.name}.")
-            FileUtils.rm(disk_path)
-            info("Removed additional disk #{additional_disk[:name]} for #{instance.name}.")
-          end
-        end
-      end
-
-      def kitchen_vm_path
-        @kitchen_vm_path ||= File.join(config[:kitchen_root], ".kitchen/#{instance.name}")
-      end
-
-      def boot_iso_path
-        @boot_iso_path ||= config[:boot_iso_path]
-      end
-
-      def differencing_disk_path
-        @differencing_disk_path ||= File.join(kitchen_vm_path, "diff" + "#{config[:disk_type]}")
-      end
-
-      def additional_disk_path(disk_name, disk_type)
-        File.join(kitchen_vm_path, disk_name + disk_type)
-      end
-
-      def parent_vhd_path
-        @parent_vhd_path ||= File.join(config[:parent_vhd_folder], config[:parent_vhd_name])
-      end
-
-      def vhd_folder?
-        config[:parent_vhd_folder] && Dir.exist?(config[:parent_vhd_folder])
-      end
-
-      def vhd?
-        config[:parent_vhd_name] && File.exist?(parent_vhd_path)
-      end
-    end
-  end
-end
+#
+# Author:: Steven Murawski <smurawski@chef.io>
+# Copyright:: Copyright (c) 2020 Chef Software, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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 "kitchen"
+require "kitchen/driver"
+require_relative "hyperv_version"
+require_relative "powershell"
+require "mixlib/shellout" unless defined?(Mixlib::ShellOut)
+require "fileutils" unless defined?(FileUtils)
+require "json" unless defined?(JSON)
+require "train" unless defined?(Train)
+require "train-winrm" unless defined?(TrainPlugins::WinRM)
+
+module Kitchen
+
+  module Driver
+
+    # Driver for Hyper-V
+    class Hyperv < Kitchen::Driver::Base
+
+      kitchen_driver_api_version 2
+      plugin_version Kitchen::Driver::HYPERV_VERSION
+
+      required_config :parent_vhd_folder
+      required_config :parent_vhd_name
+
+      default_config :memory_startup_bytes, 536_870_912
+      default_config :dynamic_memory_min_bytes, 536_870_912
+      default_config :dynamic_memory_max_bytes, 2_147_483_648
+      default_config :dynamic_memory, false
+      default_config :processor_count, 2
+      default_config :ip_address
+      default_config :gateway
+      default_config :dns_servers
+      default_config :subnet, "255.255.255.0"
+      default_config :vm_switch
+      default_config :vm_vlan_id
+      default_config :iso_path
+      default_config :boot_iso_path
+      default_config :enable_guest_services
+      default_config :vm_note
+      default_config :resize_vhd
+      default_config :additional_disks
+      default_config :vm_generation, 1
+      default_config :disable_secureboot, false
+      default_config :static_mac_address
+      default_config :disk_type do |driver|
+        File.extname(driver[:parent_vhd_name])
+      end
+
+      default_config :hyperv_server, nil
+      default_config :hyperv_username, nil
+      default_config :hyperv_password, nil
+      default_config :hyperv_ssl, false
+      default_config :hyperv_insecure, true
+      default_config :remote_vm_path, 'C:\Users\Public\Documents\Hyper-V'
+
+      include Kitchen::Driver::PowerShellScripts
+
+      def create(state)
+        @state = state
+        validate_vm_settings
+        create_new_differencing_disk
+        create_additional_disks
+        create_virtual_machine
+        set_virtual_machine_note
+        update_state
+        mount_virtual_machine_iso
+        instance.transport.connection(@state).wait_until_ready
+        copy_vm_files
+        info("Hyper-V instance #{instance.to_str} created.")
+      end
+
+      def destroy(state)
+        @state = state
+        if differencing_disk_exists && !vm_exists_silent
+          remove_differencing_disk
+        end
+        return unless vm_exists
+
+        instance.transport.connection(state).close
+        remove_virtual_machine
+        remove_differencing_disk
+        remove_additional_disks
+        info("The Hyper-V instance #{instance.to_str} has been removed.")
+        state.delete(:id)
+      end
+
+      private
+
+      def validate_vm_settings
+        raise "Missing parent_vhd_folder" unless vhd_folder? || remote_hyperv
+        raise "Missing parent_vhd_name" unless vhd? || remote_hyperv
+
+        if config[:dynamic_memory]
+          startup_bytes = config[:memory_startup_bytes]
+          min = config[:dynamic_memory_min_bytes]
+          max = config[:dynamic_memory_max_bytes]
+          memory_valid = startup_bytes.between?(min, max)
+          warning = "memory_startup_bytes (#{startup_bytes}) must" \
+                    " fall within dynamic memory range (#{min}-#{max})"
+          raise warning unless memory_valid
+        end
+        config[:vm_switch] = vm_switch
+        if config[:vm_vlan_id]
+          vm_vlan_id = config[:vm_vlan_id]
+          vm_vlan_id_min = 1
+          vm_vlan_id_max = 4094
+          vm_vlan_id_valid = vm_vlan_id.between?(vm_vlan_id_min, vm_vlan_id_max)
+          vm_vlan_id_warning = "vm_vlan_id (#{vm_vlan_id}) must be a valid 802.1Q" \
+                               " VLAN ID between (#{vm_vlan_id_min}-#{vm_vlan_id_max})"
+          raise vm_vlan_id_warning unless vm_vlan_id_valid
+        end
+      end
+
+      def create_new_differencing_disk
+        info("Creating differencing disk for #{instance.name}.")
+        run_ps new_differencing_disk_ps
+        info("Created differencing disk for #{instance.name}.")
+        set_new_vhd_size
+      end
+
+      def create_additional_disks
+        return if config[:additional_disks].nil?
+
+        @additional_disk_objects = []
+        config[:additional_disks].each do |additional_disk|
+          raise "Missing name for additional disk" unless additional_disk[:name]
+
+          disk_type = additional_disk[:type] || config[:disk_type]
+          disk_path = additional_disk_path(additional_disk[:name], disk_type)
+          raise "Additional disk file already exists: #{disk_path}" if File.exist?(disk_path)
+
+          disk_size = additional_disk[:size_gb] || 5
+          info("Creating additional disk #{additional_disk[:name]} for #{instance.name}.")
+          run_ps new_additional_disk_ps(disk_path, disk_size)
+          info("Created additional disk #{additional_disk[:name]} for #{instance.name}.")
+          @additional_disk_objects.push(disk_path)
+        end
+      end
+
+      def vm_switch
+        default_switch_object = run_ps vm_default_switch_ps
+        if default_switch_object.nil? ||
+            !default_switch_object.key?("Name") ||
+            default_switch_object["Name"].empty?
+          raise "Failed to find a default VM Switch."
+        end
+
+        default_switch_object["Name"]
+      end
+
+      def create_virtual_machine
+        return if vm_exists
+
+        info("Creating virtual machine for #{instance.name}.")
+        new_vm_object = run_ps new_vm_ps
+        raise "Unable to create virtual machine for #{instance.name}." if new_vm_object.nil?
+        @state[:id] = new_vm_object["Id"]
+        info("Created virtual machine for #{instance.name}.")
+      end
+
+      def update_state
+        vm_details
+        @state[:id] = @vm["Id"]
+        @state[:hostname] = @vm["IpAddress"]
+        @state[:vm_name] = @vm["Name"]
+      end
+
+      def vm_details
+        run_ps set_vm_ipaddress_ps if config[:ip_address]
+        @vm = run_ps vm_details_ps
+      end
+
+      def mount_virtual_machine_iso
+        return unless config[:iso_path]
+
+        info("Mounting #{config[:iso_path]}")
+        run_ps mount_vm_iso
+        info("Done mounting #{config[:iso_path]}")
+      end
+
+      def set_new_vhd_size
+        return unless config[:resize_vhd]
+
+        info("Resizing differencing disk for #{instance.name}.")
+        run_ps resize_vhd
+        info("Resized differencing disk for #{instance.name}.")
+      end
+
+      def set_virtual_machine_note
+        return unless config[:vm_note]
+
+        info("Adding note to VM: '#{config[:vm_note]}'")
+        run_ps set_vm_note
+      end
+
+      def copy_vm_files
+        return if config[:copy_vm_files].nil?
+
+        info("Copying files to virtual machine")
+        config[:copy_vm_files].each do |file_info|
+          run_ps copy_vm_file_ps(file_info[:source], file_info[:dest])
+        end
+        info("Copied files to virtual machine")
+      end
+
+      def vm_exists
+        info("Checking for existing virtual machine.")
+        return false unless @state.key?(:id) && !@state[:id].nil?
+
+        existing_vm = run_ps ensure_vm_running_ps
+        return false if existing_vm.nil? || existing_vm["Id"].nil?
+
+        info("Found an exising VM with an ID: #{existing_vm["Id"]}")
+        true
+      end
+
+      # Used in testing if a stale diff disk exists.  Silent so the output doesn't
+      # appear twice on the kitchen destroy command for the second check for vm_exists
+      def vm_exists_silent
+        return false unless @state.key?(:id) && !@state[:id].nil?
+
+        existing_vm = run_ps ensure_vm_running_ps
+        return false if existing_vm.nil? || existing_vm["Id"].nil?
+
+        true
+      end
+
+      def differencing_disk_exists
+        return unless File.exist? differencing_disk_path
+
+        true
+      end
+
+      def remove_virtual_machine
+        info("Deleting virtual machine for #{instance.name}")
+        run_ps delete_vm_ps
+        info("Deleted virtual machine for #{instance.name}")
+      end
+
+      def remove_differencing_disk
+        return unless differencing_disk_exists
+
+        info("Removing the differencing disk for #{instance.name}.")
+        FileUtils.rm(differencing_disk_path)
+        info("Removed the differencing disk for #{instance.name}.")
+      end
+
+      def remove_additional_disks
+        return if config[:additional_disks].nil?
+
+        config[:additional_disks].each do |additional_disk|
+          raise "Missing name for additional disk" unless additional_disk[:name]
+
+          disk_type = additional_disk[:type] || config[:disk_type]
+          disk_path = additional_disk_path(additional_disk[:name], disk_type)
+          if File.exist?(disk_path)
+            info("Removing additional disk #{additional_disk[:name]} for #{instance.name}.")
+            FileUtils.rm(disk_path)
+            info("Removed additional disk #{additional_disk[:name]} for #{instance.name}.")
+          end
+        end
+      end
+
+      def kitchen_vm_path
+        @kitchen_vm_path ||= File.join(config[:kitchen_root], ".kitchen/#{instance.name}")
+      end
+
+      def remote_kitchen_vm_path
+        config[:remote_vm_path]
+      end
+
+      def boot_iso_path
+        @boot_iso_path ||= config[:boot_iso_path]
+      end
+
+      def differencing_disk_path
+        kitchen_vm_base = remote_hyperv ? remote_kitchen_vm_path : kitchen_vm_path
+
+        @differencing_disk_path ||= File.join(kitchen_vm_base, "diff" + "#{config[:disk_type]}")
+      end
+
+      def additional_disk_path(disk_name, disk_type)
+        File.join(kitchen_vm_path, disk_name + disk_type)
+      end
+
+      def parent_vhd_path
+        @parent_vhd_path ||= File.join(config[:parent_vhd_folder], config[:parent_vhd_name])
+      end
+
+      def vhd_folder?
+        config[:parent_vhd_folder] && Dir.exist?(config[:parent_vhd_folder])
+      end
+
+      def vhd?
+        config[:parent_vhd_name] && File.exist?(parent_vhd_path)
+      end
+
+      def remote_hyperv
+        !!config[:hyperv_server]
+      end
+
+      def connection
+        return @connection if @connection
+
+        backend = remote_hyperv ? "winrm" : "local"
+
+        train = Train.create(backend, {
+                              host:        config[:hyperv_server],
+                              user:        config[:hyperv_username],
+                              password:    config[:hyperv_password],
+                              ssl:         config[:hyperv_ssl],
+                              self_signed: config[:hyperv_insecure],
+                            })
+        @connection = train.connection
+
+        # Copy support PS1
+        @connection.upload(local_script_path, remote_script_path)
+
+        @connection
+      end
+
+      def base_script_path
+        return remote_script_path if remote_hyperv
+
+        local_script_path
+      end
+
+      def local_script_path
+        File.join(File.dirname(__FILE__), "/../../../support/hyperv.ps1")
+      end
+
+      def remote_script_path
+        File.join(config[:kitchen_root], "kitchen-hyperv", "hyperv.ps1")
+      end
+    end
+  end
+end

data/lib/kitchen/driver/hyperv_version.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Steven Murawski <smurawski@chef.io>
-# Copyright:: Copyright (c) 2015-2018 Chef Software, Inc.
+# Copyright:: Copyright (c) 2015-2020 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -17,6 +17,6 @@
 
 module Kitchen
   module Driver
-    HYPERV_VERSION = '0.5.3'.freeze
+    HYPERV_VERSION = "0.7.0".freeze
   end
 end

data/lib/kitchen/driver/powershell.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Steven Murawski <smurawski@chef.io>
-# Copyright:: Copyright (c) 2015 Chef Software, Inc.
+# Copyright:: Copyright (c) 2020 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,28 +15,31 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'mixlib/shellout'
-require 'fileutils'
-require 'json'
+require "mixlib/shellout" unless defined?(Mixlib::ShellOut)
+require "benchmark" unless defined?(Benchmark)
+require "fileutils" unless defined?(FileUtils)
+require "json" unless defined?(JSON)
 
 module Kitchen
   module Driver
     module PowerShellScripts
       def encode_command(script)
-        encoded_script = script.encode('UTF-16LE', 'UTF-8')
+        encoded_script = script.encode("UTF-16LE", "UTF-8")
         Base64.strict_encode64(encoded_script)
       end
 
       def is_64bit?
-        os_arch = ENV['PROCESSOR_ARCHITEW6432'] || ENV['PROCESSOR_ARCHITECTURE']
-        ruby_arch = ['foo'].pack('p').size == 4 ? 32 : 64
-        os_arch == 'AMD64' && ruby_arch == 64
+        return true if remote_hyperv
+
+        os_arch = ENV["PROCESSOR_ARCHITEW6432"] || ENV["PROCESSOR_ARCHITECTURE"]
+        ruby_arch = ["foo"].pack("p").size == 4 ? 32 : 64
+        os_arch == "AMD64" && ruby_arch == 64
       end
 
       def is_32bit?
-        os_arch = ENV['PROCESSOR_ARCHITEW6432'] || ENV['PROCESSOR_ARCHITECTURE']
-        ruby_arch = ['foo'].pack('p').size == 4 ? 32 : 64
-        os_arch != 'AMD64' && ruby_arch == 32
+        os_arch = ENV["PROCESSOR_ARCHITEW6432"] || ENV["PROCESSOR_ARCHITECTURE"]
+        ruby_arch = ["foo"].pack("p").size == 4 ? 32 : 64
+        os_arch != "AMD64" && ruby_arch == 32
       end
 
       def powershell_64_bit
@@ -48,7 +51,6 @@ module Kitchen
       end
 
       def wrap_command(script)
-        base_script_path = File.join(File.dirname(__FILE__), '/../../../support/hyperv.ps1')
         debug("Loading functions from #{base_script_path}")
         new_script = [ ". #{base_script_path}", "#{script}" ].join(";\n")
         debug("Wrapped script: #{new_script}")
@@ -64,18 +66,23 @@ module Kitchen
       # @api private
       def run_ps(cmd, options = {})
         cmd = "echo #{cmd}" if config[:dry_run]
-        debug('Preparing to run: ')
+        debug("Preparing to run: ")
         debug("  #{cmd}")
         wrapped_command = wrap_command cmd
         execute_command wrapped_command, options
       end
 
       def execute_command(cmd, options = {})
-        debug("#Local Command BEGIN (#{cmd})")
-        sh = Mixlib::ShellOut.new(cmd, options)
-        sh.run_command
-        debug("Local Command END #{Util.duration(sh.execution_time)}")
-        raise "Failed: #{sh.stderr}" if sh.error?
+        debug("#Command BEGIN (#{cmd})")
+
+        sh = nil
+        bm = Benchmark.measure do
+          sh = connection.run_command(cmd, options)
+        end
+
+        debug("Command END #{Util.duration(bm.total)}")
+        raise "Failed: #{sh.stderr}" if sh.exit_status != 0
+
         stdout = sanitize_stdout(sh.stdout)
         JSON.parse(stdout) if stdout.length > 2
       end
@@ -112,12 +119,12 @@ module Kitchen
             Generation = #{config[:vm_generation]}
             DisableSecureBoot = "#{config[:disable_secureboot]}"
             MemoryStartupBytes = #{config[:memory_startup_bytes]}
-            StaticMacAddress = "#{config[:static_mac_address]}"
+            StaticMacAddress = "#{config[:static_mac_address].to_s}"
             Name = "#{instance.name}"
             Path = "#{kitchen_vm_path}"
             VHDPath = "#{differencing_disk_path}"
             SwitchName = "#{config[:vm_switch]}"
-            VlanId = #{config[:vm_vlan_id] || '$null'}
+            VlanId = #{config[:vm_vlan_id] || "$null"}
             ProcessorCount = #{config[:processor_count]}
             UseDynamicMemory = "#{config[:dynamic_memory]}"
             DynamicMemoryMinBytes = #{config[:dynamic_memory_min_bytes]}
@@ -132,11 +139,13 @@ module Kitchen
 
       def additional_disks
         return if config[:additional_disks].nil?
+
         <<-EOH
         AdditionalDisks = @("#{@additional_disk_objects.join('","')}")
         EOH
       end
 
+      # TODO: Report if VM has no IP address instead of silently waiting forever
       def vm_details_ps
         <<-DETAILS
 
@@ -159,7 +168,7 @@ module Kitchen
           while ((Get-VM -id "#{@state[:id]}").NetworkAdapters[0].Status -ne 'Ok'){
             start-sleep 10
           }
-          
+
           (Get-VM -id "#{@state[:id]}").NetworkAdapters |
             Set-VMNetworkConfiguration -ipaddress "#{config[:ip_address]}" `
               -subnet "#{config[:subnet]}" `
@@ -171,7 +180,7 @@ module Kitchen
 
       def vm_default_switch_ps
         <<-VMSWITCH
-          Get-DefaultVMSwitch #{config[:vm_switch]} | ConvertTo-Json
+          Get-DefaultVMSwitch "#{config[:vm_switch]}" | ConvertTo-Json
         VMSWITCH
       end
 
@@ -233,7 +242,8 @@ module Kitchen
 
       def ruby_array_to_ps_array(list)
         return "@()" if list.nil? || list.empty?
-        list.to_s.tr('[]','()').prepend('@')
+
+        list.to_s.tr("[]", "()").prepend("@")
       end
     end
   end

data/support/hyperv.ps1

@@ -18,8 +18,8 @@ function New-DifferencingDisk {
         [parameter(Mandatory)]
         [ValidateNotNullOrEmpty()]
         [string[]]$Path,
-        [parameter(Mandatory)]        
-        [ValidateNotNullOrEmpty()] 
+        [parameter(Mandatory)]
+        [ValidateNotNullOrEmpty()]
         [string]$ParentPath
     )
     if (-not (Test-Path $Path)) {
@@ -73,9 +73,9 @@ function New-KitchenVM {
         $EnableGuestServices,
         $AdditionalDisks
     )
-    $null = $psboundparameters.remove('DisableSecureBoot')    
+    $null = $psboundparameters.remove('DisableSecureBoot')
     $null = $psboundparameters.remove('ProcessorCount')
-    $null = $psboundparameters.remove('StaticMacAddress') 
+    $null = $psboundparameters.remove('StaticMacAddress')
     $null = $psboundparameters.remove('UseDynamicMemory')
     $null = $psboundparameters.remove('DynamicMemoryMinBytes')
     $null = $psboundparameters.remove('DynamicMemoryMaxBytes')
@@ -99,7 +99,7 @@ function New-KitchenVM {
     if (-not [string]::IsNullOrEmpty($boot_iso_path)) {
         Mount-VMISO -Id $vm.Id -Path $boot_iso_path
     }
-    if ($StaticMacAddress -ne $null) {
+    if (-not [string]::IsNullOrEmpty($StaticMacAddress)) {
         Set-VMNetworkAdapter -VMName $vm.VMName -StaticMacAddress $StaticMacAddress
     }
     if ($EnableGuestServices -and (Get-command Enable-VMIntegrationService -ErrorAction SilentlyContinue)) {

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-hyperv
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Steven Murawski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-20 00:00:00.000000000 Z
+date: 2021-08-13 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
@@ -39,49 +25,27 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: minitest
   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: cane
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+        version: '5.3'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: finstyle
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+        version: '5.3'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.15'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: minitest-stub-const
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,81 +59,67 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: countloc
+  name: test-kitchen
   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-stub-const
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+        version: '1.4'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '4'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: train
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '3.5'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
-  name: test-kitchen
+  name: train-winrm
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.4'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '0.2'
 description: Hyper-V Driver for Test-Kitchen
 email:
 - steven.murawski@gmail.com
@@ -177,7 +127,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
 - LICENSE
+- Rakefile
+- kitchen-hyperv.gemspec
 - lib/kitchen/driver/hyperv.rb
 - lib/kitchen/driver/hyperv_version.rb
 - lib/kitchen/driver/powershell.rb
@@ -201,8 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Hyper-V Driver for Test-Kitchen