kitchen-vcenter 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce5fdad668c4456c0855c02fd42acef15e17c55c2d2f72e517d73c30e398a0a5
-  data.tar.gz: 30f0914834ce79ad2ffc4953687c5ea32fdada3bb998facba74eb2044b1f91a7
+  metadata.gz: 42c7852178bc1dcfc969a8bf7e425bd47dd69cc6bcf912c2e2448b8a98fac78d
+  data.tar.gz: 14f6e34a3f3ad7e9c8fe137b1266124a12af27a13d2527a4f4bebfc8b419bb2b
 SHA512:
-  metadata.gz: 71def8125a412f237cdde9c73d8c1d16da3488a01aa575183b73d0a72242b4785ebc715fd09c57e0d1427926d3636d9ea73eadd817d34b8073e8a6b8946727a5
-  data.tar.gz: 4364e84ce871804e7c88062a44655007be5f8733c68415a577f429b167727c465b7031c234451b565f9fcda2438a53eb0538c1202e855980ca7b020054817498
+  metadata.gz: fd7aa018d79d571d67cb222df22146f12ab1e2c45e259afad4ada7569439adee363ba5972abe991139f3638850a4822bed5ce684d26dc0d22faee1fde426c277
+  data.tar.gz: 4d90cb4b2e62da501b0e047365086921f88001e2b48914f535c0cadff15412c77ab488bcd49bdd596283732c1227bcf44701581da783c3e043851bf711030f3c

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.0.2"
+  VERSION = "2.1.0"
 end

data/lib/kitchen/driver/vcenter.rb

@@ -51,6 +51,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
 
       # The main create method
       #
@@ -64,13 +65,28 @@ module Kitchen
         config[:targethost] = get_host(config[:targethost])
 
         # Use the root resource pool of a specified cluster, if any
-        # @todo This does not allow to specify cluster AND pool yet
-        unless config[:cluster].nil?
-          cluster = get_cluster(config[:cluster])
-          config[:resource_pool] = cluster.resource_pool
-        else
+        if config[:cluster].nil?
           # Find the first resource pool on any cluster
           config[:resource_pool] = get_resource_pool(config[:resource_pool])
+        else
+          cluster = get_cluster(config[:cluster])
+          root_pool = cluster.resource_pool
+
+          if config[:resource_pool].nil?
+            config[:resource_pool] = root_pool
+          else
+            rp_api = VSphereAutomation::VCenter::ResourcePoolApi.new(api_client)
+
+            found_pool = nil
+            pools = rp_api.get(root_pool).value.resource_pools
+            pools.each do |pool|
+              name = rp_api.get(pool).value.name
+              found_pool = pool if name == config[:resource_pool]
+            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
 
         # Check that the datacenter exists
@@ -104,6 +120,7 @@ module Kitchen
           network_name: config[:network_name],
           wait_timeout: config[:vm_wait_timeout],
           wait_interval: config[:vm_wait_interval],
+          customize: config[:customize],
         }
 
         begin
@@ -203,7 +220,10 @@ module Kitchen
           config[:vm_name] = format("%s-%s-%s", instance.suite.name, instance.platform.name, SecureRandom.hex(4))
         end
 
-        raise format("Cannot specify both cluster and resource_pool") if !config[:cluster].nil? && !config[:resource_pool].nil?
+        # See details in function get_resource_pool for more details
+        # if config[:cluster].nil? && config[:resource_pool].nil?
+        #   warn("It is recommended to specify cluster and/or resource_pool to avoid unpredictable machine placement on large deployments")
+        # end
       end
 
       # A helper method to validate the state
@@ -305,6 +325,14 @@ module Kitchen
         # If no name has been set, use the first resource pool that can be found,
         # otherwise try to find by given name
         if name.nil?
+          # Unpredictable results can occur, if neither cluster nor resource_pool are specified,
+          # as this relies on the order in which VMware saves the objects. This does not have large
+          # impact on small environments, but on large deployments with lots of clusters and pools,
+          # provisioned machines are likely to "jump around" available hosts.
+          #
+          # This behaviour is carried on from versions 1.2.1 and lower, but likely to be removed in
+          # a new major version due to these insufficiencies and the confusing code for it
+
           # 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)

data/lib/support/clone_vm.rb

@@ -143,7 +143,7 @@ class Support
         task = src_vm.InstantClone_Task(spec: clone_spec)
       else
         clone_spec = RbVmomi::VIM.VirtualMachineCloneSpec(location: relocate_spec,
-                                                          powerOn: options[:poweron],
+                                                          powerOn: options[:poweron] && options[:customize].nil?,
                                                           template: false)
 
         task = src_vm.CloneVM_Task(spec: clone_spec, folder: dest_folder, name: name)
@@ -155,14 +155,27 @@ class Support
       @path = options[:folder].nil? ? name : format("%s/%s", options[:folder][:name], name)
       @vm = dc.find_vm(path)
 
-      if vm.nil?
-        raise format("Unable to find machine: %s", path)
-      else
-        Kitchen.logger.info format("Waiting for VMware tools/network interfaces to become available (timeout: %d seconds)...", options[:wait_timeout])
+      raise format("Unable to find machine: %s", path) if vm.nil?
+
+      # Pass contents of the customization option/Hash through to allow full customization
+      # https://pubs.vmware.com/vsphere-6-5/index.jsp?topic=%2Fcom.vmware.wssdk.smssdk.doc%2Fvim.vm.ConfigSpec.html
+      unless options[:customize].nil?
+        Kitchen.logger.info "Waiting for reconfiguration to finish"
+
+        config_spec = RbVmomi::VIM.VirtualMachineConfigSpec(options[:customize])
+        task = vm.ReconfigVM_Task(spec: config_spec)
+        task.wait_for_completion
+      end
 
-        wait_for_ip(vm, options[:wait_timeout], options[:wait_interval])
-        Kitchen.logger.info format("Created machine %s with IP %s", name, ip)
+      if options[:poweron] && !options[:customize].nil?
+        task = vm.PowerOnVM_Task
+        task.wait_for_completion
       end
+
+      Kitchen.logger.info format("Waiting for VMware tools/network interfaces to become available (timeout: %d seconds)...", options[:wait_timeout])
+
+      wait_for_ip(vm, options[:wait_timeout], options[:wait_interval])
+      Kitchen.logger.info format("Created machine %s with IP %s", name, ip)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-vcenter
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Chef Software
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-12 00:00:00.000000000 Z
+date: 2019-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbvmomi