Class: Support::CloneVm

Inherits:
Object
  • Object
show all
Includes:
GuestCustomization
Defined in:
lib/support/clone_vm.rb

Constant Summary

Constants included from GuestCustomization

GuestCustomization::DEFAULT_LINUX_TIMEZONE, GuestCustomization::DEFAULT_TIMEOUT_IP, GuestCustomization::DEFAULT_TIMEOUT_TASK, GuestCustomization::DEFAULT_WINDOWS_ORG, GuestCustomization::DEFAULT_WINDOWS_TIMEZONE, GuestCustomization::WINDOWS_KMS_KEYS

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from GuestCustomization

#guest_customization, #guest_customization_events, #guest_customization_identity, #guest_customization_identity_linux, #guest_customization_identity_windows, #guest_customization_ip_change?, #guest_customization_spec, #guest_customization_validate_options, #guest_customization_wait, #guest_customization_wait_ip, #guest_customization_wait_task, #guest_hostname, #up?, #valid_linux_timezone?, #valid_windows_key?, #valid_windows_timezone?, #windows_kms_for_guest

Constructor Details

#initialize(conn_opts, options) ⇒ CloneVm

Returns a new instance of CloneVm.



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/support/clone_vm.rb', line 15

def initialize(conn_opts, options)
  @options = options
  @vm_name = options[:vm_name]
  @ssl_verify = !conn_opts[:insecure]

  # Connect to vSphere
  @vim ||= RbVmomi::VIM.connect conn_opts
  @vem ||= vim.serviceContent.eventManager

  @username = options[:vm_username]
  password = options[:vm_password]
  @guest_auth = RbVmomi::VIM::NamePasswordAuthentication(interactiveSession: false, username: username, password: password)

  @benchmark_data = {}
end

Instance Attribute Details

#guest_auth ⇒ Object (readonly)

Returns the value of attribute guest_auth.



11
12
13
 
# File 'lib/support/clone_vm.rb', line 11

def guest_auth
  @guest_auth
end

#ip ⇒ Object (readonly)

Returns the value of attribute ip.



11
12
13
 
# File 'lib/support/clone_vm.rb', line 11

def ip
  @ip
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



11
12
13
 
# File 'lib/support/clone_vm.rb', line 11

def options
  @options
end

#src_vm ⇒ Object (readonly)

Returns the value of attribute src_vm.



11
12
13
 
# File 'lib/support/clone_vm.rb', line 11

def src_vm
  @src_vm
end

#ssl_verify ⇒ Object (readonly)

Returns the value of attribute ssl_verify.



11
12
13
 
# File 'lib/support/clone_vm.rb', line 11

def ssl_verify
  @ssl_verify
end

#username ⇒ Object (readonly)

Returns the value of attribute username.



11
12
13
 
# File 'lib/support/clone_vm.rb', line 11

def username
  @username
end

#vem ⇒ Object (readonly)

Returns the value of attribute vem.



11
12
13
 
# File 'lib/support/clone_vm.rb', line 11

def vem
  @vem
end

#vim ⇒ Object (readonly)

Returns the value of attribute vim.



11
12
13
 
# File 'lib/support/clone_vm.rb', line 11

def vim
  @vim
end

#vm ⇒ Object (readonly)

Returns the value of attribute vm.



11
12
13
 
# File 'lib/support/clone_vm.rb', line 11

def vm
  @vm
end

#vm_name ⇒ Object (readonly)

Returns the value of attribute vm_name.



11
12
13
 
# File 'lib/support/clone_vm.rb', line 11

def vm_name
  @vm_name
end

Instance Method Details

#active_discovery? ⇒ Boolean

Returns:

  • (Boolean) 


31
32
33
 
# File 'lib/support/clone_vm.rb', line 31

def active_discovery?
  options[:active_discovery] == true
end

#active_ip_discovery(prefix_commands = []) ⇒ Object 



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/support/clone_vm.rb', line 310

def active_ip_discovery(prefix_commands = [])
  # Instant clone needs this to have synchronous reply on the new IP
  return unless active_discovery? || instant_clone?

  Kitchen.logger.info "Attempting active IP discovery"
  begin
    tools = Support::GuestOperations.new(vim, vm, guest_auth, ssl_verify)

    commands = []
    commands << rescan_commands if instant_clone?
    # commands << trigger_tools # deactivated for now, as benefit is doubtful
    commands << discovery_commands
    script = commands.flatten.join(command_separator)

    stdout = tools.run_shell_capture_output(script, :auto, 20)

    # Windows returns wrongly encoded UTF-8 for some reason
    stdout = stdout.bytes.map { |b| (32..126).cover?(b.ord) ? b.chr : nil }.join unless stdout.ascii_only?
    @ip = stdout.match(/([0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3})/m)&.captures&.first

    Kitchen.logger.debug format("Script output: %s", stdout)
    raise Support::CloneError.new(format("Could not find IP in script output, fallback to standard discovery")) if ip.nil?
    raise Support::CloneError.new(format("Error getting accessible IP address, got %s. Check DHCP server, scope exhaustion or timing issues", ip)) if ip =~ /^169\.254\./
  rescue RbVmomi::Fault => e
    if e.fault.class.wsdl_name == "InvalidGuestLogin"
      message = format('Error authenticating to guest OS as "%s", check configuration of "vm_username"/"vm_password"', username)
    else
      message = e.message
    end

    raise Support::CloneError.new(message)
  rescue ::StandardError => e
    Kitchen.logger.info format("Active discovery failed: %s", e.message)
    return false
  end

  true
end

#add_network? ⇒ Boolean

Checks whether any networks configured for addition

Returns:

  • (Boolean) 


196
197
198
 
# File 'lib/support/clone_vm.rb', line 196

def add_network?
  networks_to_add.any?
end

#add_new_network_device(datacenter, networks) ⇒ Object

This method can be used to add new network device to the target vm This fill find the network which defined in kitchen.yml in network_name configuration and attach that to the target vm.



553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
 
# File 'lib/support/clone_vm.rb', line 553

def add_new_network_device(datacenter, networks)
  device_change = []
  networks.each do |network|
    network_obj = fetch_network(datacenter, network[:name])
    network_device = RbVmomi::VIM.VirtualVmxnet3(
      key: 0,
      deviceInfo: {
        label: network[:name],
        summary: network[:name],
      }
    )

    device_change << network_change_spec(network_device, network_obj, network[:name], operation: :add)
  end

  config_spec = RbVmomi::VIM.VirtualMachineConfigSpec(
    {
      deviceChange: device_change,
    }
  )

  task = vm.ReconfigVM_Task(spec: config_spec)
  task.wait_for_completion
end

#attach_new_network?(network_device) ⇒ Boolean

TODO: Remove this method and its invocations after the deprecation of ‘network_name` config For backward compatibility If the template doesn’t have any NIC and the user use the old configuration(network_name), then that network should be attached to the vm.

Returns:

  • (Boolean) 


205
206
207
 
# File 'lib/support/clone_vm.rb', line 205

def attach_new_network?(network_device)
  network_device.nil? && networks_to_update.any?
end

#benchmark? ⇒ Boolean

Returns:

  • (Boolean) 


103
104
105
 
# File 'lib/support/clone_vm.rb', line 103

def benchmark?
  options[:benchmark] == true
end

#benchmark_checkpoint(title) ⇒ Object 



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/support/clone_vm.rb', line 123

def benchmark_checkpoint(title)
  timestamp = Time.new
  checkpoints = @benchmark_data[:checkpoints]

  total = timestamp - checkpoints.first.fetch(:value)
  Kitchen.logger.debug format(
    'Benchmark: Step "%s" at %d (%.1f since start)',
    title, timestamp, total.to_f
  )

  @benchmark_data[:checkpoints] << {
    title: title.to_sym,
    value: total,
  }
end

#benchmark_file ⇒ Object 



107
108
109
 
# File 'lib/support/clone_vm.rb', line 107

def benchmark_file
  options[:benchmark_file]
end

#benchmark_persist ⇒ Object 



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/support/clone_vm.rb', line 139

def benchmark_persist
  # Add total time spent as well
  checkpoints = @benchmark_data[:checkpoints]
  checkpoints << {
    title: :total,
    value: Time.new - checkpoints.first.fetch(:value),
  }

  # Include CSV headers
  unless File.exist?(benchmark_file)
    header = "template, clonetype, active_discovery, "
    header += checkpoints.map { |entry| entry[:title] }.join(", ") + "\n"
    File.write(benchmark_file, header)
  end

  active_discovery = options[:active_discovery] || instant_clone?
  data = [@benchmark_data[:template], @benchmark_data[:clonetype], active_discovery.to_s]
  data << checkpoints.map { |entry| format("%.1f", entry[:value]) }

  file = File.new(benchmark_file, "a")
  file.puts(data.join(", ") + "\n")

  Kitchen.logger.debug format("Benchmark: Appended data to file %s", benchmark_file)
end

#benchmark_start ⇒ Object 



111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/support/clone_vm.rb', line 111

def benchmark_start
  Kitchen.logger.debug("Starting benchmark data collection.")

  @benchmark_data = {
    template: options[:template],
    clonetype: options[:clone_type],
    checkpoints: [
      { title: "timestamp", value: Time.new.to_f },
    ],
  }
end

#check_add_disk_config(disk_config) ⇒ Object 



349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/support/clone_vm.rb', line 349

def check_add_disk_config(disk_config)
  valid_types = %w{thin flat flat_lazy flat_eager}

  unless valid_types.include? disk_config[:type].to_s
    message = format("Unknown disk type in add_disks: %s. Allowed: %s",
      disk_config[:type].to_s,
      valid_types.join(", "))

    raise Support::CloneError.new(message)
  end
end

#clone ⇒ Object

Raises:



578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
 
# File 'lib/support/clone_vm.rb', line 578

def clone
  benchmark_start if benchmark?

  # set the datacenter name
  dc = find_datacenter

  # reference template using full inventory path
  inventory_path = format("/%s/vm/%s", datacenter, options[:template])
  @src_vm = root_folder.findByInventoryPath(inventory_path)
  raise Support::CloneError.new(format("Unable to find template: %s", options[:template])) if src_vm.nil?

  if src_vm.config.template && !full_clone?
    Kitchen.logger.warn "Source is a template, thus falling back to full clone. Reference a VM for linked/instant clones."
    options[:clone_type] = :full
  end

  if src_vm.snapshot.nil? && !full_clone?
    Kitchen.logger.warn "Source VM has no snapshot available, thus falling back to full clone. Create a snapshot for linked/instant clones."
    options[:clone_type] = :full
  end

  # Autodetect OS, if none given
  if options[:vm_os].nil?
    os = detect_os(src_vm)
    Kitchen.logger.debug format('OS for VM not configured, got "%s" from VMware', os.to_s.capitalize)
    options[:vm_os] = os
  end

  # Specify where the machine is going to be created
  relocate_spec = RbVmomi::VIM.VirtualMachineRelocateSpec

  # Setting the host is not allowed for instant clone due to VM memory sharing
  relocate_spec.host = options[:targethost].host unless instant_clone?

  # Change to delta disks for linked clones
  relocate_spec.diskMoveType = :moveChildMostDiskBacking if linked_clone?

  # Set the resource pool
  relocate_spec.pool = options[:resource_pool]

  # Change network, if wanted
  network_device = network_device(src_vm)
  Kitchen.logger.warn format("Source VM/template does not have any network device (use VMware IPPools and vsphere-gom transport or govc to access)") unless network_device

  if update_network?(network_device)
    network_spec = []
    networks_to_update.each do |network|
      network_obj = fetch_network(dc, network[:name])
      network_spec << network_change_spec(network_device, network_obj, network[:name])
    end
    relocate_spec.deviceChange = network_spec
  end

  # Set the folder to use
  dest_folder = options[:folder].nil? ? dc.vmFolder : options[:folder][:id]

  Kitchen.logger.info format("Cloning '%s' to create the %s VM...", options[:template], vm_name)
  if instant_clone?
    vcenter_data = vim.serviceInstance.content.about
    raise Support::CloneError.new("Instant clones only supported with vCenter 6.7 or higher") unless vcenter_data.version.to_f >= 6.7

    Kitchen.logger.debug format("Detected %s", vcenter_data.fullName)

    resources = dc.hostFolder.children
    hosts = resources.select { |resource| resource.class.to_s =~ /ComputeResource$/ }.map(&:host).flatten
    targethost = hosts.select { |host| host.summary.config.name == options[:targethost].name }.first
    raise Support::CloneError.new("No matching ComputeResource found in host folder") if targethost.nil?

    esx_data = targethost.summary.config.product
    raise Support::CloneError.new("Instant clones only supported with ESX 6.7 or higher") unless esx_data.version.to_f >= 6.7

    Kitchen.logger.debug format("Detected %s", esx_data.fullName)

    # Other tools check for VMWare Tools status, but that will be toolsNotRunning on frozen VMs
    raise Support::CloneError.new("Need a running VM for instant clones") unless src_vm.runtime.powerState == "poweredOn"

    # In first iterations, only support the Frozen Source VM workflow. This is more efficient
    #   but needs preparations (freezing the source VM). Running Source VM support is to be
    #   added later
    raise Support::CloneError.new("Need a frozen VM for instant clones, running source VM not supported yet") unless src_vm.runtime.instantCloneFrozen

    # Swapping NICs not needed anymore (blog posts mention this), instant clones get a new
    # MAC at least with 6.7.0 build 9433931

    # Disconnect network device, so wo don't get IP collisions on start
    if network_device
      network_device.connectable = RbVmomi::VIM.VirtualDeviceConnectInfo(
        allowGuestControl: true,
        startConnected: true,
        connected: false,
        migrateConnect: "disconnect"
      )
      relocate_spec.deviceChange = [
        RbVmomi::VIM.VirtualDeviceConfigSpec(
          operation: RbVmomi::VIM::VirtualDeviceConfigSpecOperation("edit"),
          device: network_device
        ),
      ]
    end

    clone_spec = RbVmomi::VIM.VirtualMachineInstantCloneSpec(location: relocate_spec,
                                                             name: vm_name)

    benchmark_checkpoint("initialized") if benchmark?
    task = src_vm.InstantClone_Task(spec: clone_spec)
  else
    clone_spec = RbVmomi::VIM.VirtualMachineCloneSpec(
      location: relocate_spec,
      powerOn: options[:poweron] && options[:vm_customization].nil?,
      template: false
    )

    clone_spec.customization = guest_customization_spec if options[:guest_customization]

    benchmark_checkpoint("initialized") if benchmark?
    task = src_vm.CloneVM_Task(spec: clone_spec, folder: dest_folder, name: vm_name)
  end
  task.wait_for_completion

  benchmark_checkpoint("cloned") if benchmark?

  # get the IP address of the machine for bootstrapping
  # machine name is based on the path, e.g. that includes the folder
  path = options[:folder].nil? ? vm_name : format("%s/%s", options[:folder][:name], vm_name)
  @vm = dc.find_vm(path)
  raise Support::CloneError.new(format("Unable to find machine: %s", path)) if vm.nil?

  # Reconnect network device after Instant Clone is ready
  if instant_clone?
    Kitchen.logger.info "Reconnecting network adapter"
    reconnect_network_device(vm)
  end

  vm_customization if options[:vm_customization]

  # TODO: Remove this line after the deprecation of `network_name` config
  add_new_network_device(dc, networks_to_update) if attach_new_network?(network_device)

  add_new_network_device(dc, networks_to_add) if add_network?

  # Start only if specified or customizations wanted; no need for instant clones as they start in running state
  if options[:poweron] && !options[:vm_customization].nil? && !instant_clone?
    task = vm.PowerOnVM_Task
    task.wait_for_completion
  end
  benchmark_checkpoint("powered_on") if benchmark?

  # Windows customization takes a while, so check for its completion
  guest_customization_wait if options[:guest_customization]

  Kitchen.logger.info format("Waiting for VMware tools to become available (timeout: %d seconds)...", options[:wait_timeout])
  wait_for_tools(options[:wait_timeout], options[:wait_interval])

  active_ip_discovery || standard_ip_discovery
  benchmark_checkpoint("ip_detected") if benchmark?

  benchmark_persist if benchmark?
  Kitchen.logger.info format("Created machine %s with IP %s", vm_name, ip)
end

#command_separator ⇒ Object 



248
249
250
251
252
253
254
255
 
# File 'lib/support/clone_vm.rb', line 248

def command_separator
  case options[:vm_os].downcase.to_sym
  when :linux
    " && "
  when :windows
    " & "
  end
end

#datacenter ⇒ String

Returns:

  • (String) 


464
465
466
 
# File 'lib/support/clone_vm.rb', line 464

def datacenter
  options[:datacenter]
end

#detect_os(vm_or_template) ⇒ Object 



164
165
166
 
# File 'lib/support/clone_vm.rb', line 164

def detect_os(vm_or_template)
  vm_or_template.config&.guestId&.match(/^win/) ? :windows : :linux
end

#discovery_commands ⇒ Object

Retrieve IP via OS commands



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/support/clone_vm.rb', line 294

def discovery_commands
  if options[:active_discovery_command].nil?
    case options[:vm_os].downcase.to_sym
    when :linux
      "ip address show scope global | grep global | cut -b10- | cut -d/ -f1"
    when :windows
      ["sleep 5", "ipconfig"]
      # "ipconfig /renew"
      # "wmic nicconfig get IPAddress",
      # "netsh interface ip show ipaddress #{options[:vm_win_network]}"
    end
  else
    options[:active_discovery_command]
  end
end

#fetch_network(datacenter, network_name) ⇒ Object

This method will fetch the network which is configured in the kitchen.yml file with network_name configuration. If there are multiple networks with the same name, first one will be used.

Returns:

  • Network object

Raises:



505
506
507
508
509
510
511
512
513
514
515
 
# File 'lib/support/clone_vm.rb', line 505

def fetch_network(datacenter, network_name)
  networks = datacenter.network.select { |n| n.name == network_name }
  raise Support::CloneError, format("Could not find network named %s", network_name) if networks.empty?

  if networks.count > 1
    Kitchen.logger.warn(
      format("Found %d networks named %s, picking first one", networks.count, network_name)
    )
  end
  networks.first
end

#find_datacenter ⇒ RbVmomi::VIM::Datacenter

Returns:

  • (RbVmomi::VIM::Datacenter) 


471
472
473
474
475
476
477
478
 
# File 'lib/support/clone_vm.rb', line 471

def find_datacenter
  vim.serviceInstance.find_datacenter(datacenter)
rescue RbVmomi::Fault
  dc = root_folder.findByInventoryPath(datacenter)
  return dc if dc.is_a?(RbVmomi::VIM::Datacenter)

  raise Support::CloneError.new("Unable to locate datacenter at '#{datacenter}'")
end

#full_clone? ⇒ Boolean

Returns:

  • (Boolean) 


453
454
455
 
# File 'lib/support/clone_vm.rb', line 453

def full_clone?
  options[:clone_type] == :full
end

#instant_clone? ⇒ Boolean

Returns:

  • (Boolean) 


445
446
447
 
# File 'lib/support/clone_vm.rb', line 445

def instant_clone?
  options[:clone_type] == :instant
end

#ip?(string) ⇒ Boolean

Returns:

  • (Boolean) 


480
481
482
483
484
485
 
# File 'lib/support/clone_vm.rb', line 480

def ip?(string)
  IPAddr.new(string)
  true
rescue IPAddr::InvalidAddressError
  false
end

#ip_from_tools ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/support/clone_vm.rb', line 35

def ip_from_tools
  return if vm.guest.net.empty?

  # Don't simply use vm.guest.ipAddress to allow specifying a different interface
  nics = vm.guest.net
  if options[:interface]
    nics.select! { |nic| nic.network == options[:interface] }

    raise Support::CloneError.new(format("No interfaces found on VM which are attached to network '%s'", options[:interface])) if nics.empty?
  end

  vm_ip = nil
  nics.each do |net|
    vm_ip = net.ipConfig.ipAddress.detect { |addr| addr.origin != "linklayer" }
    break unless vm_ip.nil?
  end

  vm_ip&.ipAddress
end

#linked_clone? ⇒ Boolean

Returns:

  • (Boolean) 


449
450
451
 
# File 'lib/support/clone_vm.rb', line 449

def linked_clone?
  options[:clone_type] == :linked
end

#linux? ⇒ Boolean

Returns:

  • (Boolean) 


172
173
174
 
# File 'lib/support/clone_vm.rb', line 172

def linux?
  options[:vm_os].downcase.to_sym == :linux
end

#network_change_spec(network_device, network_obj, network_name, operation: :edit) ⇒ Object

This is a helper method that can be used to create the deviceChange spec which can be used to add a new network device or update the existing network device

The network_obj will be used as a backing for the network_device.



521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
 
# File 'lib/support/clone_vm.rb', line 521

def network_change_spec(network_device, network_obj, network_name, operation: :edit)
  if network_obj.is_a? RbVmomi::VIM::DistributedVirtualPortgroup
    Kitchen.logger.info format("Assigning network %s...", network_obj.pretty_path)

    vds_obj = network_obj.config.distributedVirtualSwitch
    Kitchen.logger.info format("Using vDS '%s' for network connectivity...", vds_obj.name)

    network_device.backing = RbVmomi::VIM.VirtualEthernetCardDistributedVirtualPortBackingInfo(
      port: RbVmomi::VIM.DistributedVirtualSwitchPortConnection(
        portgroupKey: network_obj.key,
        switchUuid: vds_obj.uuid
      )
    )
  elsif network_obj.is_a? RbVmomi::VIM::Network
    Kitchen.logger.info format("Assigning network %s...", network_name)

    network_device.backing = RbVmomi::VIM.VirtualEthernetCardNetworkBackingInfo(
      deviceName: network_name
    )
  else
    raise Support::CloneError, format("Unknown network type %s for network name %s", network_obj.class.to_s, network_name)
  end

  RbVmomi::VIM.VirtualDeviceConfigSpec(
    operation: RbVmomi::VIM::VirtualDeviceConfigSpecOperation(operation),
    device: network_device
  )
end

#network_device(vm) ⇒ Object 



209
210
211
212
213
214
215
216
 
# File 'lib/support/clone_vm.rb', line 209

def network_device(vm)
  all_network_devices = vm.config.hardware.device.select do |device|
    device.is_a?(RbVmomi::VIM::VirtualEthernetCard)
  end

  # Only support for first NIC so far
  all_network_devices.first
end

#networks_to_add ⇒ Object

New networks that needs to be attached to newly created vm



184
185
186
 
# File 'lib/support/clone_vm.rb', line 184

def networks_to_add
  options[:networks].select { |n| [nil, "add"].include?(n[:operation]) }
end

#networks_to_update ⇒ Object

Network configured to update the existing one in the template



178
179
180
 
# File 'lib/support/clone_vm.rb', line 178

def networks_to_update
  options[:networks].select { |n| n[:operation] == "edit" }
end

#reconnect_network_device(vm) ⇒ Object 



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/support/clone_vm.rb', line 218

def reconnect_network_device(vm)
  network_device = network_device(vm)
  return unless network_device

  network_device.connectable = RbVmomi::VIM.VirtualDeviceConnectInfo(
    allowGuestControl: true,
    startConnected: true,
    connected: true
  )

  config_spec = RbVmomi::VIM.VirtualMachineConfigSpec(
    deviceChange: [
      RbVmomi::VIM.VirtualDeviceConfigSpec(
        operation: RbVmomi::VIM::VirtualDeviceConfigSpecOperation("edit"),
        device: network_device
      ),
    ]
  )

  task = vm.ReconfigVM_Task(spec: config_spec)
  task.wait_for_completion

  benchmark_checkpoint("nic_reconfigured") if benchmark?
end

#rescan_commands ⇒ Object

Rescan network adapters for MAC/IP changes



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/support/clone_vm.rb', line 258

def rescan_commands
  Kitchen.logger.info "Refreshing network interfaces in OS"

  case options[:vm_os].downcase.to_sym
  when :linux
    # @todo: allow override if no dhclient
    [
      "/sbin/modprobe -r vmxnet3",
      "/sbin/modprobe vmxnet3",
      "/sbin/dhclient",
    ]
  when :windows
    [
      "netsh interface set Interface #{options[:vm_win_network]} disable",
      "netsh interface set Interface #{options[:vm_win_network]} enable",
      "ipconfig /renew",
    ]
  end
end

#root_folder ⇒ Object 



457
458
459
 
# File 'lib/support/clone_vm.rb', line 457

def root_folder
  @root_folder ||= vim.serviceInstance.content.rootFolder
end

#standard_ip_discovery ⇒ Object 



243
244
245
246
 
# File 'lib/support/clone_vm.rb', line 243

def standard_ip_discovery
  Kitchen.logger.info format("Waiting for IP (timeout: %d seconds)...", options[:wait_timeout])
  wait_for_ip(options[:wait_timeout], options[:wait_interval])
end

#trigger_tools ⇒ Object

Available from VMware Tools 10.1.0 this pushes the IP instead of the standard 30 second poll This will be used to provide a quick fallback, if active discovery fails.



280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/support/clone_vm.rb', line 280

def trigger_tools
  case options[:vm_os].downcase.to_sym
  when :linux
    [
      "/usr/bin/vmware-toolbox-cmd info update network",
    ]
  when :windows
    [
      '"C:\Program Files\VMware\VMware Tools\VMwareToolboxCmd.exe" info update network',
    ]
  end
end

#update_network?(network_device) ⇒ Boolean

A network should update if there is a network_device available in the template and the user configured a new network with edit operation.

Returns:

  • (Boolean) 


191
192
193
 
# File 'lib/support/clone_vm.rb', line 191

def update_network?(network_device)
  networks_to_update.any? && network_device
end

#vm_customization ⇒ Object 



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/support/clone_vm.rb', line 361

def vm_customization
  Kitchen.logger.info "Waiting for VM customization..."

  # Pass some contents right through
  # https://pubs.vmware.com/vsphere-6-5/index.jsp?topic=%2Fcom.vmware.wssdk.smssdk.doc%2Fvim.vm.ConfigSpec.html
  config = options[:vm_customization].select { |key, _| %i{annotation memoryMB numCPUs}.include? key }

  add_disks = options[:vm_customization]&.fetch(:add_disks, nil)
  unless add_disks.nil?
    config[:deviceChange] = []

    # Will create a stem like "default-ubuntu-12345678/default-ubuntu-12345678"
    filename_base = vm.disks.first.backing.fileName.gsub(/(-[0-9]+)?.vmdk/, "")

    # Storage Controller and ID mapping
    controller = vm.config.hardware.device.select { |device| device.is_a? RbVmomi::VIM::VirtualSCSIController }.first

    add_disks.each_with_index do |disk_config, idx|
      # Default to Thin Provisioning and 10GB disk size
      disk_config[:type]    ||= :thin
      disk_config[:size_mb] ||= 10240

      check_add_disk_config(disk_config)

      disk_spec = RbVmomi::VIM.VirtualDeviceConfigSpec(
        fileOperation: "create",
        operation: RbVmomi::VIM::VirtualDeviceConfigSpecOperation("add"),
        device: RbVmomi::VIM.VirtualDisk(
          backing: RbVmomi::VIM.VirtualDiskFlatVer2BackingInfo(
            thinProvisioned: true,
            diskMode: "persistent",
            fileName: format("%s_disk%03d.vmdk", filename_base, idx + 1),
            datastore: vm.disks.first.backing.datastore
          ),
          deviceInfo: RbVmomi::VIM::Description(
            label: format("Additional disk %d", idx + 1),
            summary: format("%d MB", disk_config[:size_mb])
          )
        )
      )

      # capacityInKB is marked a deprecated in 6.7 but still a required parameter
      disk_spec.device.capacityInBytes = disk_config[:size_mb] * 1024**2
      disk_spec.device.capacityInKB = disk_config[:size_mb] * 1024

      disk_spec.device.controllerKey = controller.key

      highest_id = vm.disks.map(&:unitNumber).max
      next_id = highest_id + idx + 1

      # Avoid the SCSI controller ID
      next_id += 1 if next_id == controller.scsiCtlrUnitNumber

      # Theoretically could add another SCSI controller, but there are limits to what kitchen should support
      if next_id > 14
        raise Support::CloneError.new(format("Ran out of SCSI IDs while trying to assign new disk %d", idx + 1))
      end

      disk_spec.device.unitNumber = next_id

      device_keys = vm.config.hardware.device.map(&:key).sort
      disk_spec.device.key = device_keys.last + (idx + 1) * 1000

      disk_spec.device.backing.eagerlyScrub = true if disk_config[:type].to_s == "flat_eager"
      disk_spec.device.backing.thinProvisioned = false if disk_config[:type].to_s =~ /^flat/

      config[:deviceChange] << disk_spec
    end
  end

  guestinfo = options[:vm_customization].select { |key, _| key =~ /^guestinfo\..*/ }
  unless guestinfo.empty?
    gi = guestinfo.map { |k, v| { key: k, value: v } }
    config[:extraConfig] = gi
  end

  config_spec = RbVmomi::VIM.VirtualMachineConfigSpec(config)

  task = vm.ReconfigVM_Task(spec: config_spec)
  task.wait_for_completion

  benchmark_checkpoint("reconfigured") if benchmark?
end

#vm_events(event_types = []) ⇒ Object

Raises:



487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/support/clone_vm.rb', line 487

def vm_events(event_types = [])
  raise Support::CloneError.new("`vm_events` called before VM clone") unless vm

  vem.QueryEvents(filter: RbVmomi::VIM::EventFilterSpec(
    entity: RbVmomi::VIM::EventFilterSpecByEntity(
      entity: vm,
      recursion: RbVmomi::VIM::EventFilterSpecRecursionOption(:self)
    ),
    eventTypeId: event_types
  ))
end

#wait_for_ip(timeout = 60.0, interval = 2.0) ⇒ Object

Raises:



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/support/clone_vm.rb', line 73

def wait_for_ip(timeout = 60.0, interval = 2.0)
  start = Time.new

  ip = nil
  loop do
    ip = ip_from_tools
    if ip || (Time.new - start) >= timeout
      Kitchen.logger.debug format("IP retrieved after %.1f seconds", Time.new - start) if ip
      break
    end
    sleep interval
  end

  raise Support::CloneError.new("Timeout waiting for IP address") if ip.nil?
  raise Support::CloneError.new(format("Error getting accessible IP address, got %s. Check DHCP server and scope exhaustion", ip)) if ip =~ /^169\.254\./

  # Allow IP rewriting (e.g. for 1:1 NAT)
  if options[:transform_ip]
    Kitchen.logger.info format("Received IP: %s", ip)

    # rubocop:disable Security/Eval
    ip = lambda { eval options[:transform_ip] }.call
    # rubocop:enable Security/Eval

    Kitchen.logger.info format("Transformed to IP: %s", ip)
  end

  @ip = ip
end

#wait_for_tools(timeout = 30.0, interval = 2.0) ⇒ Object

Raises:



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/support/clone_vm.rb', line 55

def wait_for_tools(timeout = 30.0, interval = 2.0)
  start = Time.new

  loop do
    if vm.guest.toolsRunningStatus == "guestToolsRunning"
      benchmark_checkpoint("tools_detected") if benchmark?

      Kitchen.logger.debug format("Tools detected after %.1f seconds", Time.new - start)
      return
    end
    break if (Time.new - start) >= timeout

    sleep interval
  end

  raise Support::CloneError.new("Timeout waiting for VMware Tools")
end

#windows? ⇒ Boolean

Returns:

  • (Boolean) 


168
169
170
 
# File 'lib/support/clone_vm.rb', line 168

def windows?
  options[:vm_os].downcase.to_sym == :windows
end