kitchen-vcenter 2.4.0 → 2.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45583a32d2c2ccf32d21491735bbe862c1cc85990ea89bc773a06086a117fc17
-  data.tar.gz: 872abb17f6fd2caf8bbe14f05c31fbe9c402bb065a3c6b010bc8136a944dc525
+  metadata.gz: 69eea65c20662c0ec15d88d55d4871d57978427d2b1ebb86977236f5e955f407
+  data.tar.gz: e07a74cb3f693286e7721bf40346fb4f9cd8b6f2cf720292d5c07ced71982956
 SHA512:
-  metadata.gz: d523aa9288f11454ef5bffd91be68132e3ed34028566af46ddbc85daeb707e05245604477234077a836fbce5e108a1f528b89f65d01653ba62e43ddd94b18747
-  data.tar.gz: c5ee31885c9a12eb0cd9d7e28d2dbb99e0257a897912054ca566aad2cef05f52301ebc65a1e61b588fbbcdf0587982aadfc29e1e72addfa29f2ae9c51a589b8d
+  metadata.gz: b576ba091634bb15c78ea248a6aa5bd7c2e69f6c682cf3b03472cf02389d844e9f8c974fe8435f47792f1608db9480f55df5fafe95293e2df98580071187b0d7
+  data.tar.gz: 86d97a406cb9e7ec156baa0af3743aea8ade5591efda376ce7dd58044113a9f4ab1fa9ee2645544a4de6362c55938f795aa6627e131e9f5b92677d4536e460c9

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.4.0"
+  VERSION = "2.5.2"
 end

data/lib/kitchen/driver/vcenter.rb

@@ -85,10 +85,6 @@ module Kitchen
         save_and_validate_parameters
         connect
 
-        # Using the clone class, create a machine for TK
-        # Find the identifier for the targethost to pass to rbvmomi
-        config[:targethost] = get_host(config[:targethost])
-
         # Use the root resource pool of a specified cluster, if any
         if config[:cluster].nil?
           # Find the first resource pool on any cluster
@@ -110,6 +106,7 @@ module Kitchen
             end
 
             raise format("Pool %s not found on cluster %s", config[:resource_pool], config[:cluster]) if found_pool.nil?
+
             config[:resource_pool] = found_pool
           end
         end
@@ -117,6 +114,14 @@ module Kitchen
         # Check that the datacenter exists
         datacenter_exists?(config[:datacenter])
 
+        # Get datacenter and cluster information
+        datacenter = get_datacenter(config[:datacenter])
+        cluster_id = get_cluster_id(config[:cluster])
+
+        # Using the clone class, create a machine for TK
+        # Find the identifier for the targethost to pass to rbvmomi
+        config[:targethost] = get_host(config[:targethost], datacenter, cluster_id)
+
         # Check if network exists, if to be changed
         network_exists?(config[:network_name]) unless config[:network_name].nil?
 
@@ -193,6 +198,7 @@ module Kitchen
           # Error out on undefined tags
           invalid = config[:tags] - valid_tags.keys
           raise format("Specified tag(s) %s not valid", invalid.join(",")) unless invalid.empty?
+
           tag_service = VSphereAutomation::CIS::TaggingTagAssociationApi.new(api_client)
           tag_ids = config[:tags].map { |name| valid_tags[name] }
 
@@ -298,19 +304,18 @@ module Kitchen
       # Validates the host name of the server you can connect to
       #
       # @param [name] name is the name of the host
-      def get_host(name)
+      def get_host(name, datacenter, cluster = nil)
         # create a host object to work with
         host_api = VSphereAutomation::VCenter::HostApi.new(api_client)
 
-        if name.nil?
-          hosts = host_api.list.value
-        else
-          hosts = host_api.list({ filter_names: name }).value
-        end
+        hosts = host_api.list({ filter_names: name,
+                                filter_datacenters: datacenter,
+                                filter_clusters: cluster,
+                                filter_connection_states: ["CONNECTED"] }).value
 
         raise format("Unable to find target host: %s", name) if hosts.empty?
 
-        hosts.first
+        hosts.sample
       end
 
       # Gets the folder you want to create the VM
@@ -318,10 +323,12 @@ module Kitchen
       # @param [name] name is the name of the folder
       def get_folder(name)
         folder_api = VSphereAutomation::VCenter::FolderApi.new(api_client)
-        folders = folder_api.list({ filter_names: name }).value
+        folders = folder_api.list({ filter_names: name, filter_type: "VIRTUAL_MACHINE" }).value
 
         raise format("Unable to find folder: %s", name) if folders.empty?
 
+        raise format("%s returned too many folders", name) if folders.length > 1
+
         folders.first.folder
       end
 
@@ -335,22 +342,48 @@ module Kitchen
         vms.first
       end
 
-      # Gets the info of the cluster
+      # Gets the info of the datacenter
+      #
+      # @param [name] name is the name of the Datacenter
+      def get_datacenter(name)
+        dc_api = VSphereAutomation::VCenter::DatacenterApi.new(api_client)
+        dcs = dc_api.list({ filter_names: name }).value
+
+        raise format("Unable to find data center: %s", name) if dcs.empty?
+
+        raise format("%s returned too many data centers", name) if dcs.length > 1
+
+        dcs.first.datacenter
+      end
+
+      # Gets the ID of the cluster
       #
       # @param [name] name is the name of the Cluster
-      def get_cluster(name)
+      def get_cluster_id(name)
+        return nil if name.nil?
+
         cluster_api = VSphereAutomation::VCenter::ClusterApi.new(api_client)
         clusters = cluster_api.list({ filter_names: name }).value
 
         raise format("Unable to find Cluster: %s", name) if clusters.empty?
 
-        cluster_id = clusters.first.cluster
+        raise format("%s returned too many clusters", name) if clusters.length > 1
+
+        clusters.first.cluster
+      end
+
+      # Gets the info of the cluster
+      #
+      # @param [name] name is the name of the Cluster
+      def get_cluster(name)
+        cluster_id = get_cluster_id(name)
 
         host_api = VSphereAutomation::VCenter::HostApi.new(api_client)
         hosts = host_api.list({ filter_clusters: cluster_id, connection_states: "CONNECTED" }).value
 
         raise format("Unable to find active host in cluster %s", name) if hosts.empty?
 
+        cluster_api = VSphereAutomation::VCenter::ClusterApi.new(api_client)
         cluster_api.get(cluster_id).value
       end
 
@@ -375,14 +408,14 @@ module Kitchen
 
           # Remove default pool for first pass (<= 1.2.1 behaviour to pick first user-defined pool found)
           resource_pools = rp_api.list.value.delete_if { |pool| pool.name == "Resources" }
-          debug("Search of all resource pools found: " + resource_pools.map { |pool| pool.name }.to_s)
+          debug("Search of all resource pools found: " + resource_pools.map(&:name).to_s)
 
           # Revert to default pool, if no user-defined pool found (> 1.2.1 behaviour)
           # (This one might not be found under some circumstances by the statement above)
           return get_resource_pool("Resources") if resource_pools.empty?
         else
           resource_pools = rp_api.list({ filter_names: name }).value
-          debug("Search for resource pools found: " + resource_pools.map { |pool| pool.name }.to_s)
+          debug("Search for resource pools found: " + resource_pools.map(&:name).to_s)
         end
 
         raise format("Unable to find Resource Pool: %s", name) if resource_pools.empty?

data/lib/support/clone_vm.rb

@@ -58,6 +58,7 @@ class Support
           return
         end
         break if (Time.new - start) >= timeout
+
         sleep interval
       end
 
@@ -178,7 +179,7 @@ class Support
           RbVmomi::VIM.VirtualDeviceConfigSpec(
             operation: RbVmomi::VIM::VirtualDeviceConfigSpecOperation("edit"),
             device: network_device
-          )
+          ),
         ]
       )
 
@@ -212,7 +213,7 @@ class Support
         return [
           "/sbin/modprobe -r vmxnet3",
           "/sbin/modprobe vmxnet3",
-          "/sbin/dhclient"
+          "/sbin/dhclient",
         ]
       when :windows
         return [
@@ -229,7 +230,7 @@ class Support
       case options[:vm_os].downcase.to_sym
       when :linux
         [
-          "/usr/bin/vmware-toolbox-cmd info update network"
+          "/usr/bin/vmware-toolbox-cmd info update network",
         ]
       when :windows
         [
@@ -292,12 +293,89 @@ class Support
       true
     end
 
+    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
+
     def reconfigure_guest
       Kitchen.logger.info "Waiting for reconfiguration to finish"
 
-      # Pass contents of the customization option/Hash through to allow full 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_spec = RbVmomi::VIM.VirtualMachineConfigSpec(options[:customize])
+      config = options[:customize].select { |key, _| %i{annotation memoryMB numCPUs}.include? key }
+
+      add_disks = options[:customize]&.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).sort.last
+          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
+
+      config_spec = RbVmomi::VIM.VirtualMachineConfigSpec(config)
 
       task = vm.ReconfigVM_Task(spec: config_spec)
       task.wait_for_completion
@@ -386,7 +464,7 @@ class Support
           RbVmomi::VIM.VirtualDeviceConfigSpec(
             operation: RbVmomi::VIM::VirtualDeviceConfigSpecOperation("edit"),
             device: network_device
-          )
+          ),
         ]
       end
 
@@ -397,15 +475,17 @@ class Support
       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 { |c| c.host }.flatten
+        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
@@ -431,7 +511,7 @@ class Support
           RbVmomi::VIM.VirtualDeviceConfigSpec(
             operation: RbVmomi::VIM::VirtualDeviceConfigSpecOperation("edit"),
             device: network_device
-          )
+          ),
         ]
 
         clone_spec = RbVmomi::VIM.VirtualMachineInstantCloneSpec(location: relocate_spec,

data/lib/support/guest_operations.rb

@@ -47,6 +47,7 @@ class Support
       loop do
         return unless process_is_running(pid)
         break if (Time.new - start) >= timeout
+
         sleep interval
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-vcenter
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.2
 platform: ruby
 authors:
 - Chef Software
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-18 00:00:00.000000000 Z
+date: 2019-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbvmomi