kitchen-vcenter 2.7.9 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8386b994051575b7997042ebd3c818de171a8de1ca34a39e13672800b986f216
-  data.tar.gz: 611d99f79e9d90ba850b1b0f04f126f3ca8acbb7c5000861c2d32310602f8f63
+  metadata.gz: d91703414f7cc8c9c377a7e1ef6e322b716c90b61c77cfbd671da0053ac4e666
+  data.tar.gz: 42d6e401ffca66e898a98df2d8924243e925a28c34cef635e50885a84e8f1c76
 SHA512:
-  metadata.gz: 678e749a5da30a917227c6f057836177b0a70a7f2d3b79a5272b76ee1a26aa33191234fd31211a43d31e4137e1c6184c6b2307d7a75658bcd5e944214a4cf523
-  data.tar.gz: adf8a44b1a88c6274e1ee7070c7055b203fb033ebffb6723476fc3db6abfd6a8660fc16693a0cae8f4419bef34e550bc75de5a3c99a903f90e34b81bc252a531
+  metadata.gz: e9075327273580d4ff320138e067b5691e551bc79d45728ede0057c4bb0b57b8cbeb6e63d7cf958ef06e69fe11f3e4ff885b37887829b022a764c4e44aa15f60
+  data.tar.gz: 22ae34bfd2071b727b1ea4fec269246080021cac4dec31f83c3687faea5c1d8e650a36a5b1420c3a6e74ac081f4afc2e33e446e2e463c94ef8c462119dfdb057

data/lib/kitchen-vcenter/version.rb

@@ -20,5 +20,5 @@
 # The main kitchen-vcenter module
 module KitchenVcenter
   # The version of this version of test-kitchen we assume enterprises want.
-  VERSION = "2.7.9"
+  VERSION = "2.9.0"
 end

data/lib/kitchen/driver/vcenter.rb

@@ -20,8 +20,8 @@ require "vsphere-automation-cis"
 require "vsphere-automation-vcenter"
 require_relative "../../kitchen-vcenter/version"
 require_relative "../../support/clone_vm"
-require "securerandom"
-require "uri"
+require "securerandom" unless defined?(SecureRandom)
+require "uri" unless defined?(URI)
 
 # The main kitchen module
 module Kitchen
@@ -50,7 +50,7 @@ module Kitchen
       default_config :vm_wait_timeout, 90
       default_config :vm_wait_interval, 2.0
       default_config :vm_rollback, false
-      default_config :customize, nil
+      default_config :vm_customization, nil
       default_config :guest_customization, nil
       default_config :interface, nil
       default_config :active_discovery, false
@@ -80,6 +80,10 @@ module Kitchen
         The 'aggressive_password' setting was renamed to 'vm_password' and will
         be removed in future versions.
       MSG
+      deprecate_config_for :customize, Util.outdent!(<<-MSG)
+        The `customize` setting was renamed to `vm_customization` and will
+        be removed in future versions.
+      MSG
 
       # The main create method
       #
@@ -137,7 +141,7 @@ module Kitchen
         unless config[:folder].nil?
           config[:folder] = {
             name: config[:folder],
-            id: get_folder(config[:folder]),
+            id: get_folder(config[:folder], "VIRTUAL_MACHINE", datacenter),
           }
         end
 
@@ -147,7 +151,7 @@ module Kitchen
 
         # Create a hash of options that the clone requires
         options = {
-          name: config[:vm_name],
+          vm_name: config[:vm_name],
           targethost: config[:targethost],
           poweron: config[:poweron],
           template: config[:template],
@@ -159,7 +163,7 @@ module Kitchen
           interface: config[:interface],
           wait_timeout: config[:vm_wait_timeout],
           wait_interval: config[:vm_wait_interval],
-          customize: config[:customize],
+          vm_customization: config[:vm_customization],
           guest_customization: config[:guest_customization],
           active_discovery: config[:active_discovery],
           active_discovery_command: config[:active_discovery_command],
@@ -178,7 +182,7 @@ module Kitchen
           new_vm.clone
 
           state[:hostname] = new_vm.ip
-          state[:vm_name] = new_vm.name
+          state[:vm_name] = new_vm.vm_name
 
         rescue # Kitchen::ActionFailed => e
           if config[:vm_rollback] == true
@@ -280,6 +284,7 @@ module Kitchen
         config[:vm_os] = config[:aggressive_os] unless config[:aggressive_os].nil?
         config[:vm_username] = config[:aggressive_username] unless config[:aggressive_username].nil?
         config[:vm_password] = config[:aggressive_password] unless config[:aggressive_password].nil?
+        config[:vm_customization] = config[:customize] unless config[:customize].nil?
       end
 
       # A helper method to validate the state
@@ -335,13 +340,19 @@ module Kitchen
       #
       # @param [name] name is the name of the folder
       # @param [type] type is the type of the folder, one of VIRTUAL_MACHINE, DATACENTER, possibly other values
-      def get_folder(name, type = "VIRTUAL_MACHINE")
+      # @param [datacenter] datacenter is the datacenter of the folder
+      def get_folder(name, type = "VIRTUAL_MACHINE", datacenter = nil)
         folder_api = VSphereAutomation::VCenter::FolderApi.new(api_client)
-        folders = folder_api.list({ filter_names: name, filter_type: type }).value
+        parent_path, basename = File.split(name)
+        filter = { filter_names: basename, filter_type: type }
+        filter[:filter_datacenters] = datacenter if datacenter
+        filter[:filter_parent_folders] = get_folder(parent_path, type, datacenter) unless parent_path == "."
+
+        folders = folder_api.list(filter).value
 
-        raise format("Unable to find folder: %s", name) if folders.empty?
+        raise format("Unable to find folder: %s", basename) if folders.empty?
 
-        raise format("%s returned too many folders", name) if folders.length > 1
+        raise format("`%s` returned too many folders", basename) if folders.length > 1
 
         folders.first.folder
       end
@@ -377,7 +388,7 @@ module Kitchen
       #
       # @param [name] name is the name of the Cluster
       def get_cluster_id(name)
-        return nil if name.nil?
+        return if name.nil?
 
         cluster_api = VSphereAutomation::VCenter::ClusterApi.new(api_client)
         clusters = cluster_api.list({ filter_names: name }).value

data/lib/support/clone_vm.rb

@@ -1,20 +1,25 @@
 require "kitchen"
 require "rbvmomi"
+
+require_relative "guest_customization"
 require_relative "guest_operations"
 
 class Support
   class CloneError < RuntimeError; end
 
   class CloneVm
-    attr_reader :vim, :options, :ssl_verify, :vm, :name, :ip, :guest_auth, :username
+    attr_reader :vim, :vem, :options, :ssl_verify, :src_vm, :vm, :vm_name, :ip, :guest_auth, :username
+
+    include GuestCustomization
 
     def initialize(conn_opts, options)
       @options = options
-      @name = options[:name]
+      @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]
@@ -156,8 +161,8 @@ class Support
       Kitchen.logger.debug format("Benchmark: Appended data to file %s", benchmark_file)
     end
 
-    def detect_os
-      vm.config&.guestId&.match(/^win/) ? :windows : :linux
+    def detect_os(vm_or_template)
+      vm_or_template.config&.guestId&.match(/^win/) ? :windows : :linux
     end
 
     def windows?
@@ -318,14 +323,14 @@ class Support
       end
     end
 
-    def reconfigure_guest
-      Kitchen.logger.info "Waiting for reconfiguration to finish"
+    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[:customize].select { |key, _| %i{annotation memoryMB numCPUs}.include? key }
+      config = options[:vm_customization].select { |key, _| %i{annotation memoryMB numCPUs}.include? key }
 
-      add_disks = options[:customize]&.fetch(:add_disks, nil)
+      add_disks = options[:vm_customization]&.fetch(:add_disks, nil)
       unless add_disks.nil?
         config[:deviceChange] = []
 
@@ -365,7 +370,7 @@ class Support
 
           disk_spec.device.controllerKey = controller.key
 
-          highest_id = vm.disks.map(&:unitNumber).sort.last
+          highest_id = vm.disks.map(&:unitNumber).max
           next_id = highest_id + idx + 1
 
           # Avoid the SCSI controller ID
@@ -425,7 +430,10 @@ class Support
     def find_datacenter
       vim.serviceInstance.find_datacenter(datacenter)
     rescue RbVmomi::Fault
-      root_folder.childEntity.grep(RbVmomi::VIM::Datacenter).find { |x| x.name == datacenter }
+      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
 
     def ip?(string)
@@ -435,67 +443,16 @@ class Support
       false
     end
 
-    def customization_spec
-      unless options[:guest_customization]
-        return false
-      end
-
-      unless ip?(options[:guest_customization][:ip_address])
-        raise Support::CloneError.new("Guest customization error: ip_address is required to be formatted as an IPv4 address")
-      end
-
-      unless ip?(options[:guest_customization][:subnet_mask])
-        raise Support::CloneError.new("Guest customization error: subnet_mask is required to be formatted as an IPv4 address")
-      end
-
-      options[:guest_customization][:gateway].each do |v|
-        unless ip?(v)
-          raise Support::CloneError.new("Guest customization error: gateway is required to be formatted as an IPv4 address")
-        end
-      end
-
-      options[:guest_customization][:dns_server_list].each do |v|
-        unless ip?(v)
-          raise Support::CloneError.new("Guest customization error: dns_server_list is required to be formatted as an IPv4 address")
-        end
-      end
-
-      unless %i{dns_domain timezone dns_server_list dns_suffix_list ip_address gateway subnet_mask}.all? { |k| options[:guest_customization].key? k }
-        raise Support::CloneError.new("Guest customization error: currently all options are required to support guest customization")
-      end
-
-      if !options[:guest_customization][:dns_server_list].is_a?(Array)
-        raise Support::CloneError.new("Guest customization error: dns_server_list must be an array")
-      elsif !options[:guest_customization][:dns_suffix_list].is_a?(Array)
-        raise Support::CloneError.new("Guest customization error: dns_suffix_list must be an array")
-      elsif !options[:guest_customization][:gateway].is_a?(Array)
-        raise Support::CloneError.new("Guest customization error: gateway must be an array")
-      end
+    def vm_events(event_types = [])
+      raise Support::CloneError.new("`vm_events` called before VM clone") unless vm
 
-      RbVmomi::VIM::CustomizationSpec.new(
-        identity: RbVmomi::VIM::CustomizationLinuxPrep.new(
-          domain: options[:guest_customization][:dns_domain],
-          hostName: RbVmomi::VIM::CustomizationFixedName.new(
-            name: name
-          ),
-          hwClockUTC: true,
-          timeZone: options[:guest_customization][:timezone]
-        ),
-        globalIPSettings: RbVmomi::VIM::CustomizationGlobalIPSettings.new(
-          dnsServerList: options[:guest_customization][:dns_server_list],
-          dnsSuffixList: options[:guest_customization][:dns_suffix_list]
+      vem.QueryEvents(filter: RbVmomi::VIM::EventFilterSpec(
+        entity: RbVmomi::VIM::EventFilterSpecByEntity(
+          entity: vm,
+          recursion: RbVmomi::VIM::EventFilterSpecRecursionOption(:self)
         ),
-        nicSettingMap: [RbVmomi::VIM::CustomizationAdapterMapping.new(
-          adapter: RbVmomi::VIM::CustomizationIPSettings.new(
-            ip: RbVmomi::VIM::CustomizationFixedIp(
-            ipAddress: options[:guest_customization][:ip_address]
-          ),
-            gateway: options[:guest_customization][:gateway],
-            subnetMask: options[:guest_customization][:subnet_mask],
-            dnsDomain: options[:guest_customization][:dns_domain]
-          )
-        )]
-      )
+        eventTypeId: event_types
+      ))
     end
 
     def clone
@@ -504,12 +461,9 @@ class Support
       # set the datacenter name
       dc = find_datacenter
 
-      # get guest customization spec
-      guest_customization = customization_spec
-
       # reference template using full inventory path
       inventory_path = format("/%s/vm/%s", datacenter, options[:template])
-      src_vm = root_folder.findByInventoryPath(inventory_path)
+      @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?
@@ -522,6 +476,13 @@ class Support
         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
 
@@ -620,23 +581,21 @@ class Support
         ]
 
         clone_spec = RbVmomi::VIM.VirtualMachineInstantCloneSpec(location: relocate_spec,
-                                                                 name: name)
+                                                                 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[:customize].nil?,
+          powerOn: options[:poweron] && options[:vm_customization].nil?,
           template: false
         )
 
-        if guest_customization
-          clone_spec.customization = guest_customization
-        end
+        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: name)
+        task = src_vm.CloneVM_Task(spec: clone_spec, folder: dest_folder, name: vm_name)
       end
       task.wait_for_completion
 
@@ -644,31 +603,28 @@ class Support
 
       # 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? ? name : format("%s/%s", options[:folder][:name], name)
+      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?
 
-      if options[:vm_os].nil?
-        os = detect_os
-        Kitchen.logger.debug format('OS for VM not configured, got "%s" from VMware', os.to_s.capitalize)
-        options[:vm_os] = os
-      end
-
       # Reconnect network device after Instant Clone is ready
       if instant_clone?
         Kitchen.logger.info "Reconnecting network adapter"
         reconnect_network_device(vm)
       end
 
-      reconfigure_guest unless options[:customize].nil?
+      vm_customization if options[:vm_customization]
 
       # Start only if specified or customizations wanted; no need for instant clones as they start in running state
-      if options[:poweron] && !options[:customize].nil? && !instant_clone?
+      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])
 
@@ -676,7 +632,7 @@ class Support
       benchmark_checkpoint("ip_detected") if benchmark?
 
       benchmark_persist if benchmark?
-      Kitchen.logger.info format("Created machine %s with IP %s", name, ip)
+      Kitchen.logger.info format("Created machine %s with IP %s", vm_name, ip)
     end
   end
 end

data/lib/support/guest_customization.rb

@@ -0,0 +1,327 @@
+require "net/ping"
+require "rbvmomi"
+
+class Support
+  class GuestCustomizationError < RuntimeError; end
+  class GuestCustomizationOptionsError < RuntimeError; end
+
+  module GuestCustomization
+    DEFAULT_LINUX_TIMEZONE = "Etc/UTC".freeze
+    DEFAULT_WINDOWS_ORG = "TestKitchen".freeze
+    DEFAULT_WINDOWS_TIMEZONE = 0x80000050 # Etc/UTC
+    DEFAULT_TIMEOUT_TASK = 600
+    DEFAULT_TIMEOUT_IP = 60
+
+    # Generic Volume License Keys for temporary Windows Server setup.
+    #
+    # @see https://docs.microsoft.com/en-us/windows-server/get-started/kmsclientkeys
+    WINDOWS_KMS_KEYS = {
+      "Microsoft Windows Server 2019 (64-bit)" => "N69G4-B89J2-4G8F4-WWYCC-J464C",
+      "Microsoft Windows Server 2016 (64-bit)" => "WC2BQ-8NRM3-FDDYY-2BFGV-KHKQY",
+      "Microsoft Windows Server 2012R2 (64-bit)" => "D2N9P-3P6X9-2R39C-7RTCD-MDVJX",
+      "Microsoft Windows Server 2012 (64-bit)" => "BN3D2-R7TKB-3YPBD-8DRP2-27GG4",
+    }.freeze
+
+    # Configuration values for Guest Customization
+    #
+    # @returns [Hash] Configuration values from file
+    def guest_customization
+      options[:guest_customization]
+    end
+
+    # Build CustomizationSpec for Guest OS Customization
+    #
+    # @returns [RbVmomi::VIM::CustomizationSpec] Customization Spec for guest adjustments
+    def guest_customization_spec
+      return unless guest_customization
+
+      guest_customization_validate_options
+
+      if guest_customization[:ip_address]
+        customized_ip = RbVmomi::VIM::CustomizationIPSettings.new(
+          ip: RbVmomi::VIM::CustomizationFixedIp(ipAddress: guest_customization[:ip_address]),
+          gateway: guest_customization[:gateway],
+          subnetMask: guest_customization[:subnet_mask],
+          dnsDomain: guest_customization[:dns_domain]
+        )
+      else
+        customized_ip = RbVmomi::VIM::CustomizationIPSettings.new(
+          ip: RbVmomi::VIM::CustomizationDhcpIpGenerator.new,
+          dnsDomain: guest_customization[:dns_domain]
+        )
+      end
+
+      RbVmomi::VIM::CustomizationSpec.new(
+        identity: guest_customization_identity,
+        globalIPSettings: RbVmomi::VIM::CustomizationGlobalIPSettings.new(
+          dnsServerList: guest_customization[:dns_server_list],
+          dnsSuffixList: guest_customization[:dns_suffix_list]
+        ),
+        nicSettingMap: [RbVmomi::VIM::CustomizationAdapterMapping.new(
+          adapter: customized_ip
+        )]
+      )
+    end
+
+    # Check options for existance and format
+    #
+    # @raise [Support::GuestCustomizationOptionsError] For any violation
+    def guest_customization_validate_options
+      if guest_customization_ip_change?
+        unless ip?(guest_customization[:ip_address])
+          raise Support::GuestCustomizationOptionsError.new("Parameter `ip_address` is required to be formatted as an IPv4 address")
+        end
+
+        unless guest_customization[:subnet_mask]
+          raise Support::GuestCustomizationOptionsError.new("Parameter `subnet_mask` is required if assigning a fixed IPv4 address")
+        end
+
+        unless ip?(guest_customization[:subnet_mask])
+          raise Support::GuestCustomizationOptionsError.new("Parameter `subnet_mask` is required to be formatted as an IPv4 address")
+        end
+
+        if up?(guest_customization[:ip_address])
+          raise Support::GuestCustomizationOptionsError.new("Parameter `ip_address` points to a host reachable via ICMP") unless guest_customization[:continue_on_ip_conflict]
+
+          Kitchen.logger.warn("Continuing customization despite `ip_address` conflicting with a reachable host per user request")
+        end
+      end
+
+      if guest_customization[:gateway]
+        unless guest_customization[:gateway].is_a?(Array)
+          raise Support::GuestCustomizationOptionsError.new("Parameter `gateway` must be an array")
+        end
+
+        guest_customization[:gateway].each do |v|
+          unless ip?(v)
+            raise Support::GuestCustomizationOptionsError.new("Parameter `gateway` is required to be formatted as an IPv4 address")
+          end
+        end
+      end
+
+      required = %i{dns_domain dns_server_list dns_suffix_list}
+      missing = required - guest_customization.keys
+      unless missing.empty?
+        raise Support::GuestCustomizationOptionsError.new("Parameters `#{missing.join("`, `")}` are required to support guest customization")
+      end
+
+      guest_customization[:dns_server_list].each do |v|
+        unless ip?(v)
+          raise Support::GuestCustomizationOptionsError.new("Parameter `dns_server_list` is required to be formatted as an IPv4 address")
+        end
+      end
+
+      if !guest_customization[:dns_server_list].is_a?(Array)
+        raise Support::GuestCustomizationOptionsError.new("Parameter `dns_server_list` must be an array")
+      elsif !guest_customization[:dns_suffix_list].is_a?(Array)
+        raise Support::GuestCustomizationOptionsError.new("Parameter `dns_suffix_list` must be an array")
+      end
+    end
+
+    # Check if an IP change is requested
+    #
+    # @returns [Boolean] If `ip_address` is to be changed
+    def guest_customization_ip_change?
+      guest_customization[:ip_address]
+    end
+
+    # Return OS-specific CustomizationIdentity object
+    def guest_customization_identity
+      if linux?
+        guest_customization_identity_linux
+      elsif windows?
+        guest_customization_identity_windows
+      else
+        raise Support::GuestCustomizationError.new("Unknown OS, no valid customization found")
+      end
+    end
+
+    # Construct Linux-specific customization information
+    def guest_customization_identity_linux
+      timezone = guest_customization[:timezone]
+      if timezone && !valid_linux_timezone?(timezone)
+        raise Support::GuestCustomizationError.new <<~ERROR
+          Linux customization requires `timezone` in `Area/Location` format.
+          See https://kb.vmware.com/s/article/2145518
+        ERROR
+      end
+
+      Kitchen.logger.warn("Linux guest customization: No timezone passed, assuming UTC") unless timezone
+
+      RbVmomi::VIM::CustomizationLinuxPrep.new(
+        domain: guest_customization[:dns_domain],
+        hostName: guest_hostname,
+        hwClockUTC: true,
+        timeZone: timezone || DEFAULT_LINUX_TIMEZONE
+      )
+    end
+
+    # Construct Windows-specific customization information
+    def guest_customization_identity_windows
+      timezone = guest_customization[:timezone]
+      if timezone && !valid_windows_timezone?(timezone)
+        raise Support::GuestCustomizationOptionsError.new <<~ERROR
+          Windows customization requires `timezone` as decimal number or hex number (0x55).
+          See https://support.microsoft.com/en-us/help/973627/microsoft-time-zone-index-values
+        ERROR
+      end
+
+      Kitchen.logger.warn("Windows guest customization: No timezone passed, assuming UTC") unless timezone
+
+      product_id = guest_customization[:product_id]
+
+      # Try to look up and use a known, documented 120-day trial key
+      unless product_id
+        guest_os = src_vm.guest&.guestFullName
+        product_id = windows_kms_for_guest(guest_os)
+
+        Kitchen.logger.warn format("Windows guest customization:: Using KMS Key `%<key>s` for %<os>s", key: product_id, os: guest_os) if product_id
+      end
+
+      unless valid_windows_key? product_id
+        raise Support::GuestCustomizationOptionsError.new <<~ERROR
+          Windows customization requires `product_id` to work. Add a valid product key or
+          see https://docs.microsoft.com/en-us/windows-server/get-started/kmsclientkeys for KMS trial keys
+        ERROR
+      end
+
+      RbVmomi::VIM::CustomizationSysprep.new(
+        guiUnattended: RbVmomi::VIM::CustomizationGuiUnattended.new(
+          timeZone: timezone.to_i || DEFAULT_WINDOWS_TIMEZONE,
+          autoLogon: false,
+          autoLogonCount: 1
+        ),
+        identification: RbVmomi::VIM::CustomizationIdentification.new,
+        userData: RbVmomi::VIM::CustomizationUserData.new(
+          computerName: guest_hostname,
+          fullName: guest_customization[:org_name] || DEFAULT_WINDOWS_ORG,
+          orgName: guest_customization[:org_name] || DEFAULT_WINDOWS_ORG,
+          productId: product_id
+        )
+      )
+    end
+
+    # Check if a host is reachable
+    def up?(host)
+      check = Net::Ping::External.new(host)
+      check.ping?
+    end
+
+    # Retrieve a GVLK (evaluation key) for the named OS
+    #
+    # @param [String] name Name of the OS as reported by VMware
+    # @returns [String] GVLK key, if any
+    def windows_kms_for_guest(name)
+      WINDOWS_KMS_KEYS.fetch(name, false)
+    end
+
+    # Check format of Linux-specific timezone, according to VMware support
+    #
+    # @param [Integer] input Value to check for validity
+    # @returns [Boolean] if value is valid
+    def valid_linux_timezone?(input)
+      # Specific to VMware: https://kb.vmware.com/s/article/2145518
+      linux_timezone_pattern = %r{^[A-Z][A-Za-z]+\/[A-Z][-_+A-Za-z0-9]+$}
+
+      input.to_s.match? linux_timezone_pattern
+    end
+
+    # Check format of Windows-specific timezone
+    #
+    # @param [Integer] input Value to check for validity
+    # @returns [Boolean] if value is valid
+    def valid_windows_timezone?(input)
+      # Accept decimals and hex
+      # See https://support.microsoft.com/en-us/help/973627/microsoft-time-zone-index-values
+      windows_timezone_pattern = /^([0-9]+|0x[0-9a-fA-F]+)$/
+
+      input.to_s.match? windows_timezone_pattern
+    end
+
+    # Check for format of Windows Product IDs
+    #
+    # @param [String] input String to check
+    # @returns [Boolean] if value is in Windows Key format
+    def valid_windows_key?(input)
+      windows_key_pattern = /^[A-Z0-9]{5}-[A-Z0-9]{5}-[A-Z0-9]{5}-[A-Z0-9]{5}-[A-Z0-9]{5}$/
+
+      input.to_s.match? windows_key_pattern
+    end
+
+    # Return Guest hostname to be configured and check for validity.
+    #
+    # @returns [String] New hostname to assign
+    def guest_hostname
+      hostname = guest_customization[:hostname] || options[:vm_name]
+
+      hostname_pattern = /^([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])$/
+      unless hostname.match?(hostname_pattern)
+        raise Support::GuestCustomizationError.new("Only letters, numbers or hyphens in hostnames allowed")
+      end
+
+      RbVmomi::VIM::CustomizationFixedName.new(name: hostname)
+    end
+
+    # Wait for vSphere task completion and subsequent IP address update (if any).
+    def guest_customization_wait
+      guest_customization_wait_task(guest_customization[:timeout_task] || DEFAULT_TIMEOUT_TASK)
+      guest_customization_wait_ip(guest_customization[:timeout_ip] || DEFAULT_TIMEOUT_IP)
+    end
+
+    # Wait for Guest customization to finish successfully.
+    #
+    # @param [Integer] timeout Timeout in seconds
+    # @param [Integer] sleep_time Time to wait between tries
+    def guest_customization_wait_task(timeout = 600, sleep_time = 10)
+      waited_seconds = 0
+
+      Kitchen.logger.info "Waiting for guest customization (timeout: #{timeout} seconds)..."
+
+      while waited_seconds < timeout
+        events = guest_customization_events
+
+        if events.any? { |event| event.is_a? RbVmomi::VIM::CustomizationSucceeded }
+          return
+        elsif (failed = events.detect { |event| event.is_a? RbVmomi::VIM::CustomizationFailed })
+          # Only matters for Linux, as Windows won't come up at all to report a failure via VMware Tools
+          raise Support::GuestCustomizationError.new("Customization of VM failed: #{failed.fullFormattedMessage}")
+        end
+
+        sleep(sleep_time)
+        waited_seconds += sleep_time
+      end
+
+      raise Support::GuestCustomizationError.new("Customization of VM did not complete within #{timeout} seconds.")
+    end
+
+    # Wait for new IP to be reported, if any.
+    #
+    # @param [Integer] timeout Timeout in seconds. Tools report every 30 seconds, Default: 30 seconds
+    # @param [Integer] sleep_time Time to wait between tries
+    def guest_customization_wait_ip(timeout = 30, sleep_time = 1)
+      return unless guest_customization_ip_change?
+
+      waited_seconds = 0
+
+      Kitchen.logger.info "Waiting for guest customization IP update..."
+
+      while waited_seconds < timeout
+        found_ip = wait_for_ip(timeout, 1.0)
+
+        return if found_ip == guest_customization[:ip_address]
+
+        sleep(sleep_time)
+        waited_seconds += sleep_time
+      end
+
+      raise Support::GuestCustomizationError.new("Customized IP was not reported within #{timeout} seconds.")
+    end
+
+    # Filter Customization events for the current VM
+    #
+    # @returns [Array<RbVmomi::VIM::CustomizationEvent>] All matching events
+    def guest_customization_events
+      vm_events %w{CustomizationSucceeded CustomizationFailed CustomizationStartedEvent}
+    end
+  end
+end

data/lib/support/guest_operations.rb

@@ -1,5 +1,5 @@
 require "rbvmomi"
-require "net/http"
+require "net/http" unless defined?(Net::HTTP)
 
 class Support
   # Encapsulate VMware Tools GOM interaction, inspired by github:dnuffer/raidopt

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-vcenter
 version: !ruby/object:Gem::Version
-  version: 2.7.9
+  version: 2.9.0
 platform: ruby
 authors:
 - Chef Software
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-06 00:00:00.000000000 Z
+date: 2020-10-30 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-ping
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rbvmomi
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +95,7 @@ files:
 - lib/kitchen-vcenter/version.rb
 - lib/kitchen/driver/vcenter.rb
 - lib/support/clone_vm.rb
+- lib/support/guest_customization.rb
 - lib/support/guest_operations.rb
 homepage: https://github.com/chef/kitchen-vcenter
 licenses:
@@ -98,5 +119,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Test Kitchen driver for VMare vCenter
+summary: Test Kitchen driver for VMware vCenter
 test_files: []