Module: Kitchen::Driver::PowerShellScripts

Included in:
Hyperv
Defined in:
lib/kitchen/driver/powershell.rb

Instance Method Summary collapse

Instance Method Details

#additional_disks ⇒ Object 



140
141
142
143
144
145
146
 
# File 'lib/kitchen/driver/powershell.rb', line 140

def additional_disks
  return if config[:additional_disks].nil?

  <<-EOH
  AdditionalDisks = @("#{@additional_disk_objects.join('","')}")
  EOH
end

#copy_vm_file_ps(source, dest) ⇒ Object 



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/kitchen/driver/powershell.rb', line 205

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

#delete_vm_ps ⇒ Object 



156
157
158
159
160
161
162
163
 
# File 'lib/kitchen/driver/powershell.rb', line 156

def delete_vm_ps
  <<-REMOVE

    $null = Get-VM -ID "#{@state[:id]}" |
      Stop-VM -Force -TurnOff -PassThru |
      Remove-VM -Force
  REMOVE
end

#encode_command(script) ⇒ Object 



26
27
28
29
 
# File 'lib/kitchen/driver/powershell.rb', line 26

def encode_command(script)
  encoded_script = script.encode("UTF-16LE", "UTF-8")
  Base64.strict_encode64(encoded_script)
end

#ensure_vm_running_ps ⇒ Object 



108
109
110
111
112
113
 
# File 'lib/kitchen/driver/powershell.rb', line 108

def ensure_vm_running_ps
  <<-RUNNING

    Assert-VmRunning -ID "#{@state[:id]}" | ConvertTo-Json
  RUNNING
end

#execute_command(cmd, options = {}) ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/kitchen/driver/powershell.rb', line 75

def execute_command(cmd, options = {})
  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

#is_32bit? ⇒ Boolean

Returns:

  • (Boolean) 


39
40
41
42
43
 
# File 'lib/kitchen/driver/powershell.rb', line 39

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

#is_64bit? ⇒ Boolean

Returns:

  • (Boolean) 


31
32
33
34
35
36
37
 
# File 'lib/kitchen/driver/powershell.rb', line 31

def is_64bit?
  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

#mount_vm_iso ⇒ Object 



187
188
189
190
191
 
# File 'lib/kitchen/driver/powershell.rb', line 187

def mount_vm_iso
  <<-MOUNTISO
    mount-vmiso -id "#{@state[:id]}" -Path #{config[:iso_path]}
  MOUNTISO
end

#new_additional_disk_ps(disk_path, disk_size) ⇒ Object 



101
102
103
104
105
106
 
# File 'lib/kitchen/driver/powershell.rb', line 101

def new_additional_disk_ps(disk_path, disk_size)
  <<-ADDDISK

    New-VHD -Path "#{disk_path}" -SizeBytes #{disk_size}GB | Out-Null
  ADDDISK
end

#new_differencing_disk_ps ⇒ Object 



94
95
96
97
98
99
 
# File 'lib/kitchen/driver/powershell.rb', line 94

def new_differencing_disk_ps
  <<-DIFF

    New-DifferencingDisk -Path "#{differencing_disk_path}" -ParentPath "#{parent_vhd_path}"
  DIFF
end

#new_vm_ps ⇒ Object 



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/kitchen/driver/powershell.rb', line 115

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

#powershell_64_bit ⇒ Object 



45
46
47
48
49
50
51
 
# File 'lib/kitchen/driver/powershell.rb', line 45

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

#resize_vhd ⇒ Object 



193
194
195
196
197
 
# File 'lib/kitchen/driver/powershell.rb', line 193

def resize_vhd
  <<-VMNOTE
    Resize-VHD -Path "#{parent_vhd_path}" -SizeBytes #{config[:resize_vhd]}
  VMNOTE
end

#run_ps(cmd, options = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Convenience method to run a powershell command locally.

Parameters:

  • cmd (String) —

    command to run locally

  • options (Hash) (defaults to: {}) —

    options hash

See Also:

  • ShellOut.run_command


67
68
69
70
71
72
73
 
# File 'lib/kitchen/driver/powershell.rb', line 67

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

#sanitize_stdout(stdout) ⇒ Object 



90
91
92
 
# File 'lib/kitchen/driver/powershell.rb', line 90

def sanitize_stdout(stdout)
  stdout.split("\n").select { |s| !s.start_with?("PS") }.join("\n")
end

#set_vm_ipaddress_ps ⇒ Object 



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/kitchen/driver/powershell.rb', line 165

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

#set_vm_note ⇒ Object 



199
200
201
202
203
 
# File 'lib/kitchen/driver/powershell.rb', line 199

def set_vm_note
  <<-VMNOTE
    Set-VM -Name (Get-VM | Where-Object{ $_.ID -eq "#{@state[:id]}"}).Name -Note "#{config[:vm_note]}"
  VMNOTE
end

#vm_default_switch_ps ⇒ Object 



181
182
183
184
185
 
# File 'lib/kitchen/driver/powershell.rb', line 181

def vm_default_switch_ps
  <<-VMSWITCH
    Get-DefaultVMSwitch "#{config[:vm_switch]}" | ConvertTo-Json
  VMSWITCH
end

#vm_details_ps ⇒ Object

TODO: Report if VM has no IP address instead of silently waiting forever



149
150
151
152
153
154
 
# File 'lib/kitchen/driver/powershell.rb', line 149

def vm_details_ps
  <<-DETAILS

    Get-VmDetail -id "#{@state[:id]}" | ConvertTo-Json
  DETAILS
end

#wrap_command(script) ⇒ Object 



53
54
55
56
57
58
59
 
# File 'lib/kitchen/driver/powershell.rb', line 53

def wrap_command(script)
  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