kitchen-hyperv 0.5.4 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b55ec98fe0feae9159324c3c4d4aba29d3c765e02ce8119a8018d626c77f033
-  data.tar.gz: 0a97571d04c65942c06a8f20d7efb20088be51b793481dd11ece2c929d56faf8
+  metadata.gz: 9258c479984814c2d9aaf91a3686a9c5d917f190cbc48627e65d69bd911a5b61
+  data.tar.gz: 43a7870274649b11ca8597213fe6ec7c93ed18b16f5c4b90d1bfd80642fb5344
 SHA512:
-  metadata.gz: 4579cd9d4e532a42092d1cf50bf7d6d74c9977f848bcf4ee83871378d82f843d2b13127ad0a0814d5fabd036ac76117a7fc02d478223b80fe92f6aa005ab817f
-  data.tar.gz: 53278bdf748446af609e584df729fde28fe60db46afe6a747b9186f10399d4d1a39d8fee3fdde23d234ee2d988a5eb3081315330c93a84bead84d7e64ebf84c3
+  metadata.gz: ca0012d2cc41220779907a19b573f64ff69893f1cff7d28a68b41c80ab48ee52eb3a7d6ddb30d2c408139f2a4ec327479766ce207d65b64928b4e6dd393a21b0
+  data.tar.gz: 2994a51e52ddde357eacca301732b7ec7af40accd963ae47c0484a3aaeb9c1245e15f352c8ab64ec6aa9661328a052c8213b4400a259fb00c0e24a30c5ae591f

data/Gemfile

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

data/kitchen-hyperv.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   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}
+  spec.files         = %w{LICENSE kitchen-hyperv.gemspec Gemfile Rakefile support/hyperv.ps1} + Dir.glob("lib/**/*")
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler"

data/lib/kitchen/driver/hyperv.rb

@@ -0,0 +1,297 @@
+#
+# 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"
+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}" 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
+        @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

data/lib/kitchen/driver/hyperv_version.rb

@@ -0,0 +1,22 @@
+#
+# Author:: Steven Murawski <smurawski@chef.io>
+# Copyright:: Copyright (c) 2015-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.
+
+module Kitchen
+  module Driver
+    HYPERV_VERSION = "0.5.5".freeze
+  end
+end

data/lib/kitchen/driver/powershell.rb

@@ -0,0 +1,243 @@
+#
+# 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 "mixlib/shellout"
+require "fileutils"
+require "json"
+
+module Kitchen
+  module Driver
+    module PowerShellScripts
+      def encode_command(script)
+        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
+      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
+      end
+
+      def powershell_64_bit
+        if is_64bit? || is_32bit?
+          'c:\windows\system32\windowspowershell\v1.0\powershell.exe'
+        else
+          'c:\windows\sysnative\windowspowershell\v1.0\powershell.exe'
+        end
+      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}")
+        "#{powershell_64_bit} -noprofile -executionpolicy bypass" \
+        " -encodedcommand #{encode_command new_script} -outputformat Text"
+      end
+
+      # Convenience method to run a powershell command locally.
+      #
+      # @param cmd [String] command to run locally
+      # @param options [Hash] options hash
+      # @see Kitchen::ShellOut.run_command
+      # @api private
+      def run_ps(cmd, options = {})
+        cmd = "echo #{cmd}" if config[:dry_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?
+
+        stdout = sanitize_stdout(sh.stdout)
+        JSON.parse(stdout) if stdout.length > 2
+      end
+
+      def sanitize_stdout(stdout)
+        stdout.split("\n").select { |s| !s.start_with?("PS") }.join("\n")
+      end
+
+      def new_differencing_disk_ps
+        <<-DIFF
+
+          New-DifferencingDisk -Path "#{differencing_disk_path}" -ParentPath "#{parent_vhd_path}"
+        DIFF
+      end
+
+      def new_additional_disk_ps(disk_path, disk_size)
+        <<-ADDDISK
+
+          New-VHD -Path "#{disk_path}" -SizeBytes #{disk_size}GB | Out-Null
+        ADDDISK
+      end
+
+      def ensure_vm_running_ps
+        <<-RUNNING
+
+          Assert-VmRunning -ID "#{@state[:id]}" | ConvertTo-Json
+        RUNNING
+      end
+
+      def new_vm_ps
+        <<-NEWVM
+
+          $NewVMParams = @{
+            Generation = #{config[:vm_generation]}
+            DisableSecureBoot = "#{config[:disable_secureboot]}"
+            MemoryStartupBytes = #{config[:memory_startup_bytes]}
+            StaticMacAddress = "#{config[:static_mac_address]}"
+            Name = "#{instance.name}"
+            Path = "#{kitchen_vm_path}"
+            VHDPath = "#{differencing_disk_path}"
+            SwitchName = "#{config[:vm_switch]}"
+            VlanId = #{config[:vm_vlan_id] || "$null"}
+            ProcessorCount = #{config[:processor_count]}
+            UseDynamicMemory = "#{config[:dynamic_memory]}"
+            DynamicMemoryMinBytes = #{config[:dynamic_memory_min_bytes]}
+            DynamicMemoryMaxBytes = #{config[:dynamic_memory_max_bytes]}
+            boot_iso_path = "#{boot_iso_path}"
+            EnableGuestServices = "#{config[:enable_guest_services]}"
+            #{additional_disks}
+          }
+          New-KitchenVM @NewVMParams | ConvertTo-Json
+        NEWVM
+      end
+
+      def additional_disks
+        return if config[:additional_disks].nil?
+
+        <<-EOH
+        AdditionalDisks = @("#{@additional_disk_objects.join('","')}")
+        EOH
+      end
+
+      def vm_details_ps
+        <<-DETAILS
+
+          Get-VmDetail -id "#{@state[:id]}" | ConvertTo-Json
+        DETAILS
+      end
+
+      def delete_vm_ps
+        <<-REMOVE
+
+          $null = Get-VM -ID "#{@state[:id]}" |
+            Stop-VM -Force -TurnOff -PassThru |
+            Remove-VM -Force
+        REMOVE
+      end
+
+      def set_vm_ipaddress_ps
+        <<-VMIP
+
+          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]}" `
+              -gateway "#{config[:gateway]}" `
+              -dnsservers #{ruby_array_to_ps_array(config[:dns_servers])} |
+            ConvertTo-Json
+        VMIP
+      end
+
+      def vm_default_switch_ps
+        <<-VMSWITCH
+          Get-DefaultVMSwitch "#{config[:vm_switch]}" | ConvertTo-Json
+        VMSWITCH
+      end
+
+      def mount_vm_iso
+        <<-MOUNTISO
+          mount-vmiso -id "#{@state[:id]}" -Path #{config[:iso_path]}
+        MOUNTISO
+      end
+
+      def resize_vhd
+        <<-VMNOTE
+          Resize-VHD -Path "#{parent_vhd_path}" -SizeBytes #{config[:resize_vhd]}
+        VMNOTE
+      end
+
+      def set_vm_note
+        <<-VMNOTE
+          Set-VM -Name (Get-VM | Where-Object{ $_.ID -eq "#{@state[:id]}"}).Name -Note "#{config[:vm_note]}"
+        VMNOTE
+      end
+
+      def copy_vm_file_ps(source, dest)
+        <<-FILECOPY
+          Function CopyFile ($VM, [string]$SourcePath, [string]$DestPath) {
+              $p = @{ CreateFullPath = $true ; FileSource = 'Host'; Force = $true }
+              $VM |
+                Copy-VMFile -SourcePath $SourcePath -DestinationPath $DestPath @p
+          }
+
+          $sourceLocation = '#{source}'
+          $destinationLocation = '#{dest}'
+          $vmId = '#{@state[:id]}'
+          If (Test-Path $sourceLocation) {
+              $vm = Get-VM -ID $vmId
+              $service = 'Guest Service Interface'
+
+              If ((Get-VMIntegrationService -Name $service -VM $vm).Enabled -ne $true) {
+                  Enable-VMIntegrationService -Name $service -VM $vm
+                  Start-Sleep -Seconds 3
+              }
+
+              If ((Get-Item $sourceLocation) -is [System.IO.DirectoryInfo]) {
+                  ForEach ($item in (Get-ChildItem -Path $sourceLocation -File)) {
+                      $destFullPath = (Join-Path $destinationLocation $item.Name)
+                      CopyFile $vm $item.FullName $destFullPath
+                  }
+              }
+              Else {
+                CopyFile $vm $sourceLocation $destinationLocation
+              }
+          }
+          else {
+              Write-Error "Source file path does not exist: $sourceLocation"
+          }
+        FILECOPY
+      end
+
+      private
+
+      def ruby_array_to_ps_array(list)
+        return "@()" if list.nil? || list.empty?
+
+        list.to_s.tr("[]", "()").prepend("@")
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-hyperv
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors:
 - Steven Murawski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-06 00:00:00.000000000 Z
+date: 2020-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -117,6 +117,9 @@ files:
 - LICENSE
 - Rakefile
 - kitchen-hyperv.gemspec
+- lib/kitchen/driver/hyperv.rb
+- lib/kitchen/driver/hyperv_version.rb
+- lib/kitchen/driver/powershell.rb
 - support/hyperv.ps1
 homepage: https://github.com/test-kitchen/kitchen-hyperv
 licenses: