kitchen-hyperv 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c1c78c069680ce6179d290ba250302102bd29da553842ecc3f00e7ddb4114c5
-  data.tar.gz: 05413cbc517eebed2176b0ab9a20f86e742ee2dcf14a58e8babf0a774a64fedd
+  metadata.gz: d5b1645576764131a29498745a319db7a3e3fa166de15481ec0744acb3dbfe42
+  data.tar.gz: d82e688587b75d0156c71f3b79200b76e7f4d6601561d73a7445bd7236cdf005
 SHA512:
-  metadata.gz: 723997d9f09f593d941e7ee46cca5a9ec19577142cb99148e7cebc6f9839395ddb06e6f681ed470522753aff12c088ea903440d186f6cd201d7f41616633331f
-  data.tar.gz: f87621dfb332510fa30f6c8fee49a4fa23186c6bf1ae9597fce4cca8467afa8e1387bc5c4a2a3931ad28a20e15475fb6755f747137688a9bd3263b944b8ac48a
+  metadata.gz: c82372e025d904e35a675987e01a1bd4805d653d090bb35814d9345c3437a854b87c49db795646afe019c536ab6f6696dd07de834ac279dc62aed31a3a85f543
+  data.tar.gz: 16c10a436d35cd4ca05fbad919ad3026f9eabcf403b8ffca5d55573cca445b15583b989d1c42517762151162d7fb5207006d67acd637791f8ad540ac13379064

data/kitchen-hyperv.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   # Required directly by the PowerShell command encoder. base64 is a bundled
   # gem from Ruby 3.4 on, so it has to be declared rather than assumed.
   spec.add_dependency "base64", "~> 0.2"
-  spec.add_dependency "test-kitchen", ">= 1.4", "< 5"
+  spec.add_dependency "test-kitchen", ">= 3.0", "< 5"
   spec.add_dependency "train", ">= 3.5", "< 4.0"
   spec.add_dependency "train-winrm", ">= 0.2", "< 1.0"
 end

data/lib/kitchen/driver/hyperv.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Author:: Steven Murawski <smurawski@chef.io>
 # Copyright:: Copyright (c) 2020 Chef Software, Inc.
@@ -20,11 +22,11 @@ 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)
+require "time" unless defined?(Time.zone_offset)
 
 module Kitchen
 
@@ -77,9 +79,12 @@ module Kitchen
       default_config :disable_secureboot, false
       default_config :static_mac_address
       default_config :disk_type do |driver|
-        File.extname(driver[:parent_vhd_name])
+        File.extname(driver[:parent_vhd_name].to_s)
       end
 
+      default_config :copy_vm_files
+      default_config :dry_run, false
+
       default_config :hyperv_server, nil
       default_config :hyperv_username, nil
       default_config :hyperv_password, nil
@@ -102,6 +107,9 @@ module Kitchen
       # @raise [RuntimeError] if validation fails or Hyper-V cannot create the VM
       def create(state)
         @state = state
+        # Kitchen::Driver::Base#create runs config[:pre_create_command].
+        # Without this the option is silently ignored.
+        super
         validate_vm_settings
         create_new_differencing_disk
         create_additional_disks
@@ -142,8 +150,109 @@ module Kitchen
         state.delete(:id)
       end
 
+      # Report whether Hyper-V still has this instance's virtual machine.
+      #
+      # Backs `kitchen list --probe`. Deliberately read-only: unlike the check
+      # {#create} makes, this never starts a stopped VM.
+      #
+      # @param state [Hash] the instance state hash
+      # @return [Hash] normalized status data for Test Kitchen
+      def status(state)
+        @state = state
+        if state[:id].nil?
+          return status_report(
+            live: false,
+            state: "not_created",
+            message: "No virtual machine id recorded for this instance."
+          )
+        end
+
+        vm = run_ps vm_status_ps
+        if vm.nil? || vm["Id"].nil?
+          status_report(live: false, state: "not_created", resource_id: state[:id],
+            message: "Hyper-V has no virtual machine with id #{state[:id]}.")
+        else
+          running = vm["State"].to_s.casecmp?("running")
+          status_report(live: running, state: running ? "running" : "stopped",
+            resource_id: vm["Id"],
+            message: "Hyper-V reports the virtual machine as #{vm["State"]}.")
+        end
+      rescue => e
+        status_report(live: nil, state: "unknown", resource_id: state[:id], message: e.message)
+      end
+
+      # Check for the common reasons this driver cannot build an instance.
+      #
+      # Backs `kitchen doctor`. Reports every problem it finds rather than
+      # stopping at the first, since they are usually related.
+      #
+      # @param state [Hash] the instance state hash
+      # @return [Boolean] true if at least one problem was found
+      def doctor(state)
+        @state = state
+        problems = hyperv_problems + parent_vhd_problems
+        problems.each { |problem| warn(problem) }
+        !problems.empty?
+      end
+
       private
 
+      # Build the status hash Test Kitchen normalizes.
+      #
+      # @return [Hash]
+      # @api private
+      def status_report(live:, state:, message:, resource_id: nil)
+        {
+          live: live,
+          state: state,
+          source: "driver",
+          resource_id: resource_id,
+          message: message,
+          checked_at: Time.now.utc.iso8601,
+        }
+      end
+
+      # Problems reaching the Hyper-V host itself.
+      #
+      # @return [Array<String>]
+      # @api private
+      def hyperv_problems
+        return [] unless run_ps(hyperv_module_ps).nil?
+
+        ["The Hyper-V PowerShell module is not installed on #{hyperv_host_description}."]
+      rescue => e
+        ["Could not run PowerShell on #{hyperv_host_description}: #{e.message}"]
+      end
+
+      # Problems with the parent VHD the instance is cloned from.
+      #
+      # Only checked locally: the paths refer to the remote host's filesystem
+      # when hyperv_server is set, so this machine cannot see them.
+      #
+      # @return [Array<String>]
+      # @api private
+      def parent_vhd_problems
+        return [] if remote_hyperv
+
+        problems = []
+        unless vhd_folder?
+          problems << "parent_vhd_folder #{config[:parent_vhd_folder].inspect} does not exist."
+        end
+        unless vhd?
+          problems << "parent_vhd_name #{config[:parent_vhd_name].inspect} was not found in " \
+                      "#{config[:parent_vhd_folder].inspect}."
+        end
+        problems
+      end
+
+      # How to refer to the Hyper-V host in a message.
+      #
+      # @return [String]
+      # @api private
+      def hyperv_host_description
+        remote_hyperv ? config[:hyperv_server] : "this machine"
+      end
+
       # Check the configuration before anything is created.
       #
       # Also resolves `vm_switch`, which requires a round trip to the host and

data/lib/kitchen/driver/hyperv_version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Author:: Steven Murawski <smurawski@chef.io>
 # Copyright:: Copyright (c) 2015-2020 Chef Software, Inc.
@@ -24,6 +26,6 @@ module Kitchen
     # driver, and therefore without loading test-kitchen.
     #
     # @return [String] a frozen semantic version
-    HYPERV_VERSION = "0.11.0".freeze
+    HYPERV_VERSION = "0.12.0"
   end
 end

data/lib/kitchen/driver/powershell.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Author:: Steven Murawski <smurawski@chef.io>
 # Copyright:: Copyright (c) 2020 Chef Software, Inc.
@@ -16,8 +18,8 @@
 # limitations under the License.
 
 require "base64" unless defined?(Base64)
-require "mixlib/shellout" unless defined?(Mixlib::ShellOut)
 require "benchmark" unless defined?(Benchmark)
+require "rbconfig/sizeof" unless defined?(RbConfig::SIZEOF)
 require "fileutils" unless defined?(FileUtils)
 require "json" unless defined?(JSON)
 
@@ -41,6 +43,13 @@ module Kitchen
     #
     # @see Kitchen::Driver::Hyperv
     module PowerShellScripts
+      # Values Windows reports in PROCESSOR_ARCHITECTURE for a 64-bit OS.
+      #
+      # ARM64 matters for Windows on ARM devices, which run Hyper-V: matching
+      # only AMD64 there made both width checks false and sent the driver to
+      # the Sysnative path, which does not exist for a native 64-bit process.
+      SIXTY_FOUR_BIT_ARCHITECTURES = %w{AMD64 ARM64 IA64}.freeze
+
       # Encode a script the way `powershell.exe -encodedcommand` expects it:
       # UTF-16LE, then Base64.
       #
@@ -52,6 +61,26 @@ module Kitchen
         Base64.strict_encode64(encoded_script)
       end
 
+      # The OS architecture, seeing through WOW64.
+      #
+      # A 32-bit process on 64-bit Windows reads its own architecture from
+      # PROCESSOR_ARCHITECTURE; PROCESSOR_ARCHITEW6432 is what reveals the real
+      # one, and is only set in that case.
+      #
+      # @return [String, nil]
+      # @api private
+      def os_architecture
+        ENV["PROCESSOR_ARCHITEW6432"] || ENV["PROCESSOR_ARCHITECTURE"]
+      end
+
+      # Pointer width of the running Ruby, in bits.
+      #
+      # @return [Integer] 32 or 64
+      # @api private
+      def ruby_architecture_bits
+        RbConfig::SIZEOF.fetch("void*", 8) * 8
+      end
+
       # Whether a 64-bit PowerShell is directly reachable.
       #
       # Always true for a remote host, where the local architecture is
@@ -59,12 +88,11 @@ module Kitchen
       #
       # @return [Boolean]
       # @api private
-      def is_64bit?
+      def sixty_four_bit?
         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
+        SIXTY_FOUR_BIT_ARCHITECTURES.include?(os_architecture) &&
+          ruby_architecture_bits == 64
       end
 
       # Whether both the OS and Ruby are 32-bit, so no WOW64 redirection is in
@@ -72,10 +100,25 @@ module Kitchen
       #
       # @return [Boolean]
       # @api private
+      def thirty_two_bit?
+        !SIXTY_FOUR_BIT_ARCHITECTURES.include?(os_architecture) &&
+          ruby_architecture_bits == 32
+      end
+
+      # @deprecated Use {#sixty_four_bit?}. Kept because this module is mixed
+      #   into a published driver class.
+      # @return [Boolean]
+      # @api private
+      def is_64bit?
+        sixty_four_bit?
+      end
+
+      # @deprecated Use {#thirty_two_bit?}. Kept because this module is mixed
+      #   into a published driver class.
+      # @return [Boolean]
+      # @api private
       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
+        thirty_two_bit?
       end
 
       # Path to a PowerShell that can see the Hyper-V cmdlets.
@@ -88,7 +131,7 @@ module Kitchen
       # @return [String]
       # @api private
       def powershell_64_bit
-        if is_64bit? || is_32bit?
+        if sixty_four_bit? || thirty_two_bit?
           'c:\windows\system32\windowspowershell\v1.0\powershell.exe'
         else
           'c:\windows\sysnative\windowspowershell\v1.0\powershell.exe'
@@ -256,6 +299,34 @@ module Kitchen
         DETAILS
       end
 
+      # Script that reads the VM's current power state without changing it.
+      #
+      # Unlike {#ensure_vm_running_ps}, this never starts a stopped VM, so it is
+      # safe for `kitchen list --probe`.
+      #
+      # @return [String] PowerShell source
+      # @api private
+      def vm_status_ps
+        <<-STATUS
+
+          Get-VmStatus -Id "#{@state[:id]}" | ConvertTo-Json
+        STATUS
+      end
+
+      # Script that reports whether the Hyper-V PowerShell module is installed.
+      #
+      # @return [String] PowerShell source
+      # @api private
+      def hyperv_module_ps
+        <<-MODULE
+
+          Get-Module -ListAvailable -Name Hyper-V |
+            Select-Object -First 1 |
+            ForEach-Object { [pscustomobject]@{ Name = $_.Name; Version = [string]$_.Version } } |
+            ConvertTo-Json
+        MODULE
+      end
+
       # Script that forces the VM off and removes it.
       #
       # @return [String] PowerShell source

data/support/hyperv.ps1

@@ -1,233 +1,264 @@
-#requires -Version 2 -Modules Hyper-V
-
-#implicitly import hyperv module to avoid powercli cmdlets
-if ((Get-Module -Name 'hyper-v') -ne $null) {
-    Remove-Module -Name hyper-v
-    Import-Module -Name hyper-v
-}
-else {
-    Import-Module -Name hyper-v
-}
-
-$ProgressPreference = 'SilentlyContinue'
-
-
-function New-DifferencingDisk {
-    [cmdletbinding()]
-    param (
-        [parameter(Mandatory)]
-        [ValidateNotNullOrEmpty()]
-        [string[]]$Path,
-        [parameter(Mandatory)]
-        [ValidateNotNullOrEmpty()]
-        [string]$ParentPath
-    )
-    if (-not (Test-Path $Path)) {
-        $null = new-vhd @psboundparameters -Differencing
-    }
-}
-
-function Assert-VmRunning {
-    [cmdletbinding()]
-    param([string]$Id)
-
-    if ([string]::IsNullOrEmpty($Id)) {
-        $Output = [pscustomobject]@{
-            Name = ''
-            State = ''
-        }
-    }
-    else {
-        $Output = Get-VM -Id $Id |
-            ForEach-Object -Process {
-            if ($_.State -notlike 'Running') {
-                $_ |
-                    Start-VM -passthru
-            }
-            else {
-                $_
-            }
-        } |
-            Select-Object -Property Name, Id, State
-    }
-    $Output
-}
-
-function New-KitchenVM {
-    [cmdletbinding()]
-    param (
-        $Generation = 1,
-        $DisableSecureBoot,
-        $MemoryStartupBytes,
-        $StaticMacAddress,
-        $Name,
-        $Path,
-        $VHDPath,
-        $SwitchName,
-        $VlanId,
-        $ProcessorCount,
-        $UseDynamicMemory,
-        $DynamicMemoryMinBytes,
-        $DynamicMemoryMaxBytes,
-        $boot_iso_path,
-        $EnableGuestServices,
-        $AdditionalDisks
-    )
-    $null = $psboundparameters.remove('DisableSecureBoot')
-    $null = $psboundparameters.remove('ProcessorCount')
-    $null = $psboundparameters.remove('StaticMacAddress')
-    $null = $psboundparameters.remove('UseDynamicMemory')
-    $null = $psboundparameters.remove('DynamicMemoryMinBytes')
-    $null = $psboundparameters.remove('DynamicMemoryMaxBytes')
-    $null = $psboundparameters.remove('boot_iso_path')
-    $null = $psboundparameters.remove('EnableGuestServices')
-    $null = $psboundparameters.remove('VlanId')
-    $null = $psboundparameters.remove('AdditionalDisks')
-    $DisableSecureBoot = [Convert]::ToBoolean($DisableSecureBoot)
-    $UseDynamicMemory = [Convert]::ToBoolean($UseDynamicMemory)
-    $null = [bool]::TryParse($EnableGuestServices, [ref]$EnableGuestServices)
-
-    $vm = new-vm @psboundparameters |
-        Set-Vm -ProcessorCount $ProcessorCount -passthru
-
-    if ($UseDynamicMemory) {
-        $vm | Set-VMMemory -DynamicMemoryEnabled $true -MinimumBytes $DynamicMemoryMinBytes -MaximumBytes $DynamicMemoryMaxBytes
-    }
-    else {
-        $vm | Set-VMMemory -DynamicMemoryEnabled $false
-    }
-    if (-not [string]::IsNullOrEmpty($boot_iso_path)) {
-        Mount-VMISO -Id $vm.Id -Path $boot_iso_path
-    }
-    if (-not [string]::IsNullOrEmpty($StaticMacAddress)) {
-        Set-VMNetworkAdapter -VMName $vm.VMName -StaticMacAddress $StaticMacAddress
-    }
-    if ($EnableGuestServices -and (Get-command Enable-VMIntegrationService -ErrorAction SilentlyContinue)) {
-        Enable-VMIntegrationService -VM $vm -Name 'Guest Service Interface'
-    }
-    if (($VlanId -ne $null) -and (Get-command Set-VMNetworkAdapterVlan -ErrorAction SilentlyContinue)) {
-        Set-VMNetworkAdapterVlan -VM $vm -Access -VlanId $VlanId
-    }
-    if ($AdditionalDisks -and (Get-command Add-VMHardDiskDrive -ErrorAction SilentlyContinue)) {
-        foreach ($AdditionalDisk in $AdditionalDisks) {
-            Add-VMHardDiskDrive -VM $vm -Path $AdditionalDisk
-        }
-    }
-    if ($DisableSecureBoot -and ($Generation -eq 2) -and (Get-command Set-VMFirmware -ErrorAction SilentlyContinue)) {
-        Set-VMFirmware -VM $vm -EnableSecureBoot Off
-    }
-    if ((Get-Command -Name Set-Vm).Parameters["AutomaticCheckpointsEnabled"]) {
-        Set-VM -Name $vm.VMName -AutomaticCheckpointsEnabled $false
-    }
-    $vm | Start-Vm -passthru |
-        foreach {
-        $vm = $_
-        do {
-            start-sleep -seconds 2
-        }
-        while ($vm.state -notlike 'Running')
-        $vm
-    } |
-        select Name, Id, State
-}
-
-function Get-VmIP($vm) {
-    start-sleep -seconds 10
-    $vm.networkadapters.ipaddresses |
-        Where-Object {
-        $_ -match '^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$'
-    } |
-        Select-Object -First 1
-}
-
-Function Set-VMNetworkConfiguration {
-    [CmdletBinding()]
-    Param (
-        [parameter(valuefrompipeline)]
-        [object]$NetworkAdapter,
-        [String[]]$IPAddress = @(),
-        [String[]]$Gateway = @(),
-        [String[]]$DNSServers = @(),
-        [String[]]$Subnet = @()
-    )
-
-    $vm = Get-WmiObject -Namespace 'root\virtualization\v2' -Class 'Msvm_ComputerSystem' | Where-Object {
-        $_.ElementName -eq $NetworkAdapter.VMName
-    }
-    $VMSettings = $vm.GetRelated('Msvm_VirtualSystemSettingData') | Where-Object {
-        $_.VirtualSystemType -eq 'Microsoft:Hyper-V:System:Realized'
-    }
-    $VMNetAdapters = $VMSettings.GetRelated('Msvm_SyntheticEthernetPortSettingData')
-
-    $NetworkSettings = @()
-    foreach ($NetAdapter in $VMNetAdapters) {
-        if ($NetAdapter.Address -eq $NetworkAdapter.MacAddress) {
-            $NetworkSettings = $NetworkSettings + $NetAdapter.GetRelated('Msvm_GuestNetworkAdapterConfiguration')
-        }
-    }
-
-    $NetworkSettings[0].IPAddresses = $IPAddress
-    $NetworkSettings[0].DefaultGateways = $Gateway
-    $NetworkSettings[0].DNSServers = $DNSServers
-    $NetworkSettings[0].Subnets = $Subnet
-    $NetworkSettings[0].ProtocolIFType = 4096
-    $NetworkSettings[0].DHCPEnabled = $false
-
-
-    $Service = Get-WmiObject -Class 'Msvm_VirtualSystemManagementService' -Namespace 'root\virtualization\v2'
-    $setIP = $Service.SetGuestNetworkAdapterConfiguration($vm, $NetworkSettings[0].GetText(1))
-
-    if ($setIP.ReturnValue -eq 4096) {
-        $job = [WMI]$setIP.job
-
-        while ($job.JobState -eq 3 -or $job.JobState -eq 4) {
-            Start-Sleep 1
-            $job = [WMI]$setIP.job
-        }
-
-        if ($job.JobState -ne 7) {
-            $job.GetError()
-        }
-    }
-    (Get-VM -Id $NetworkAdapter.VmId).NetworkAdapter | Select-Object Name, IpAddress
-}
-
-function Get-VmDetail {
-    [cmdletbinding()]
-    param($Id)
-
-    Get-VM -Id $Id |
-        ForEach-Object {
-        $vm = $_
-        do {
-            Start-Sleep -Seconds 1
-        }
-        while (-not (Get-VmIP $vm))
-
-        [pscustomobject]@{
-            Name = $vm.name
-            Id = $vm.ID
-            IpAddress = (Get-VmIP $vm)
-        }
-    }
-}
-
-function Get-DefaultVMSwitch {
-    [CmdletBinding()]
-    param ($Name)
-    Get-VMSwitch @PSBoundParameters |
-        Select-Object -First 1 |
-        Select-Object Name, Id
-}
-
-function Mount-VMISO {
-    [cmdletbinding()]
-    param($Id, $Path)
-
-    if ((Get-VM -Id $Id).Generation -eq 2) {
-        Add-VMDvdDrive (Get-VM -Id $Id).Name | Set-VMDvdDrive -VMName (Get-VM -Id $Id).Name -Path $Path
-    }
-
-    Set-VMDvdDrive -VMName (Get-VM -Id $Id).Name -Path $Path
-}
-
+#requires -Version 2 -Modules Hyper-V
+
+#implicitly import hyperv module to avoid powercli cmdlets
+if ((Get-Module -Name 'hyper-v') -ne $null) {
+    Remove-Module -Name hyper-v
+    Import-Module -Name hyper-v
+}
+else {
+    Import-Module -Name hyper-v
+}
+
+$ProgressPreference = 'SilentlyContinue'
+
+
+function New-DifferencingDisk {
+    [cmdletbinding()]
+    param (
+        [parameter(Mandatory)]
+        [ValidateNotNullOrEmpty()]
+        [string[]]$Path,
+        [parameter(Mandatory)]
+        [ValidateNotNullOrEmpty()]
+        [string]$ParentPath
+    )
+    if (-not (Test-Path $Path)) {
+        $null = new-vhd @psboundparameters -Differencing
+    }
+}
+
+function Assert-VmRunning {
+    [cmdletbinding()]
+    param([string]$Id)
+
+    if ([string]::IsNullOrEmpty($Id)) {
+        $Output = [pscustomobject]@{
+            Name = ''
+            State = ''
+        }
+    }
+    else {
+        $Output = Get-VM -Id $Id |
+            ForEach-Object -Process {
+            if ($_.State -notlike 'Running') {
+                $_ |
+                    Start-VM -passthru
+            }
+            else {
+                $_
+            }
+        } |
+            Select-Object -Property Name, Id, State
+    }
+    $Output
+}
+
+function New-KitchenVM {
+    [cmdletbinding()]
+    param (
+        $Generation = 1,
+        $DisableSecureBoot,
+        $MemoryStartupBytes,
+        $StaticMacAddress,
+        $Name,
+        $Path,
+        $VHDPath,
+        $SwitchName,
+        $VlanId,
+        $ProcessorCount,
+        $UseDynamicMemory,
+        $DynamicMemoryMinBytes,
+        $DynamicMemoryMaxBytes,
+        $boot_iso_path,
+        $EnableGuestServices,
+        $AdditionalDisks
+    )
+    $null = $psboundparameters.remove('DisableSecureBoot')
+    $null = $psboundparameters.remove('ProcessorCount')
+    $null = $psboundparameters.remove('StaticMacAddress')
+    $null = $psboundparameters.remove('UseDynamicMemory')
+    $null = $psboundparameters.remove('DynamicMemoryMinBytes')
+    $null = $psboundparameters.remove('DynamicMemoryMaxBytes')
+    $null = $psboundparameters.remove('boot_iso_path')
+    $null = $psboundparameters.remove('EnableGuestServices')
+    $null = $psboundparameters.remove('VlanId')
+    $null = $psboundparameters.remove('AdditionalDisks')
+    $DisableSecureBoot = [Convert]::ToBoolean($DisableSecureBoot)
+    $UseDynamicMemory = [Convert]::ToBoolean($UseDynamicMemory)
+    $null = [bool]::TryParse($EnableGuestServices, [ref]$EnableGuestServices)
+
+    $vm = new-vm @psboundparameters |
+        Set-Vm -ProcessorCount $ProcessorCount -passthru
+
+    if ($UseDynamicMemory) {
+        $vm | Set-VMMemory -DynamicMemoryEnabled $true -MinimumBytes $DynamicMemoryMinBytes -MaximumBytes $DynamicMemoryMaxBytes
+    }
+    else {
+        $vm | Set-VMMemory -DynamicMemoryEnabled $false
+    }
+    if (-not [string]::IsNullOrEmpty($boot_iso_path)) {
+        Mount-VMISO -Id $vm.Id -Path $boot_iso_path
+    }
+    if (-not [string]::IsNullOrEmpty($StaticMacAddress)) {
+        Set-VMNetworkAdapter -VMName $vm.VMName -StaticMacAddress $StaticMacAddress
+    }
+    if ($EnableGuestServices -and (Get-command Enable-VMIntegrationService -ErrorAction SilentlyContinue)) {
+        Enable-VMIntegrationService -VM $vm -Name 'Guest Service Interface'
+    }
+    if (($VlanId -ne $null) -and (Get-command Set-VMNetworkAdapterVlan -ErrorAction SilentlyContinue)) {
+        Set-VMNetworkAdapterVlan -VM $vm -Access -VlanId $VlanId
+    }
+    if ($AdditionalDisks -and (Get-command Add-VMHardDiskDrive -ErrorAction SilentlyContinue)) {
+        foreach ($AdditionalDisk in $AdditionalDisks) {
+            Add-VMHardDiskDrive -VM $vm -Path $AdditionalDisk
+        }
+    }
+    if ($DisableSecureBoot -and ($Generation -eq 2) -and (Get-command Set-VMFirmware -ErrorAction SilentlyContinue)) {
+        Set-VMFirmware -VM $vm -EnableSecureBoot Off
+    }
+    if ((Get-Command -Name Set-Vm).Parameters["AutomaticCheckpointsEnabled"]) {
+        Set-VM -Name $vm.VMName -AutomaticCheckpointsEnabled $false
+    }
+    $vm | Start-Vm -passthru |
+        foreach {
+        $vm = $_
+        do {
+            start-sleep -seconds 2
+        }
+        while ($vm.state -notlike 'Running')
+        $vm
+    } |
+        select Name, Id, State
+}
+
+function Get-VmIP($vm) {
+    start-sleep -seconds 10
+    $vm.networkadapters.ipaddresses |
+        Where-Object {
+        $_ -match '^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$'
+    } |
+        Select-Object -First 1
+}
+
+Function Set-VMNetworkConfiguration {
+    [CmdletBinding()]
+    Param (
+        [parameter(valuefrompipeline)]
+        [object]$NetworkAdapter,
+        [String[]]$IPAddress = @(),
+        [String[]]$Gateway = @(),
+        [String[]]$DNSServers = @(),
+        [String[]]$Subnet = @()
+    )
+
+    $vm = Get-CimInstance -Namespace 'root\virtualization\v2' -ClassName 'Msvm_ComputerSystem' -Filter "ElementName = '$($NetworkAdapter.VMName)'"
+
+    $VMSettings = Get-CimAssociatedInstance -InputObject $vm -ResultClassName 'Msvm_VirtualSystemSettingData' |
+        Where-Object { $_.VirtualSystemType -eq 'Microsoft:Hyper-V:System:Realized' }
+
+    $VMNetAdapters = Get-CimAssociatedInstance -InputObject $VMSettings -ResultClassName 'Msvm_SyntheticEthernetPortSettingData'
+
+    $NetworkSettings = @()
+    foreach ($NetAdapter in $VMNetAdapters) {
+        if ($NetAdapter.Address -eq $NetworkAdapter.MacAddress) {
+            $NetworkSettings += Get-CimAssociatedInstance -InputObject $NetAdapter -ResultClassName 'Msvm_GuestNetworkAdapterConfiguration'
+        }
+    }
+
+    if ($NetworkSettings.Count -eq 0) {
+        throw "No guest network adapter configuration found for MAC address $($NetworkAdapter.MacAddress) on VM $($NetworkAdapter.VMName)."
+    }
+
+    $NetworkSettings[0].IPAddresses = $IPAddress
+    $NetworkSettings[0].DefaultGateways = $Gateway
+    $NetworkSettings[0].DNSServers = $DNSServers
+    $NetworkSettings[0].Subnets = $Subnet
+    $NetworkSettings[0].ProtocolIFType = 4096
+    $NetworkSettings[0].DHCPEnabled = $false
+
+
+    $Service = Get-CimInstance -Namespace 'root\virtualization\v2' -ClassName 'Msvm_VirtualSystemManagementService'
+
+    # NetworkConfiguration is declared string[] of embedded instances; the CIM
+    # layer serializes the CimInstance for us, replacing WMI's GetText(1).
+    $setIP = Invoke-CimMethod -InputObject $Service -MethodName 'SetGuestNetworkAdapterConfiguration' -Arguments @{
+        ComputerSystem       = $vm
+        NetworkConfiguration = @($NetworkSettings[0])
+    }
+
+    # 4096 means the method was accepted and is running as a job.
+    if ($setIP.ReturnValue -eq 4096) {
+        $job = $setIP.Job | Get-CimInstance
+
+        # 3 = Starting, 4 = Running.
+        while ($job.JobState -eq 3 -or $job.JobState -eq 4) {
+            Start-Sleep -Seconds 1
+            $job = $job | Get-CimInstance
+        }
+
+        # 7 = Completed. Anything else previously emitted the error and carried
+        # on, which hid a failed address assignment behind a successful create.
+        if ($job.JobState -ne 7) {
+            throw "Setting the guest network adapter configuration failed: $($job.ErrorDescription)"
+        }
+    }
+    elseif ($setIP.ReturnValue -ne 0) {
+        throw "Setting the guest network adapter configuration failed with return value $($setIP.ReturnValue)."
+    }
+
+    (Get-VM -Id $NetworkAdapter.VmId).NetworkAdapters | Select-Object Name, IPAddresses
+}
+
+function Get-VmDetail {
+    [cmdletbinding()]
+    param($Id)
+
+    Get-VM -Id $Id |
+        ForEach-Object {
+        $vm = $_
+        do {
+            Start-Sleep -Seconds 1
+        }
+        while (-not (Get-VmIP $vm))
+
+        [pscustomobject]@{
+            Name = $vm.name
+            Id = $vm.ID
+            IpAddress = (Get-VmIP $vm)
+        }
+    }
+}
+
+function Get-VmStatus {
+    [cmdletbinding()]
+    param($Id)
+
+    Get-VM -Id $Id -ErrorAction SilentlyContinue |
+        ForEach-Object {
+        [pscustomobject]@{
+            Name  = $_.Name
+            Id    = [string]$_.Id
+            State = [string]$_.State
+        }
+    }
+}
+
+function Get-DefaultVMSwitch {
+    [CmdletBinding()]
+    param ($Name)
+    Get-VMSwitch @PSBoundParameters |
+        Select-Object -First 1 |
+        Select-Object Name, Id
+}
+
+function Mount-VMISO {
+    [cmdletbinding()]
+    param($Id, $Path)
+
+    if ((Get-VM -Id $Id).Generation -eq 2) {
+        Add-VMDvdDrive (Get-VM -Id $Id).Name | Set-VMDvdDrive -VMName (Get-VM -Id $Id).Name -Path $Path
+    }
+
+    Set-VMDvdDrive -VMName (Get-VM -Id $Id).Name -Path $Path
+}
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-hyperv
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Steven Murawski
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-08-22 00:00:00.000000000 Z
+date: 2026-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -30,7 +30,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '5'
@@ -40,7 +40,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '5'