kitchen-vcenter 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58aef4a3a971cd8ec311e63906b3e99a2944e6f7baebfcc8f172f7c7a87afed2
-  data.tar.gz: a96f89b0ee46b5f49539822a5b1b7e5115a1b0aca1a819b9ee9d2582c5a7b1b9
+  metadata.gz: ce5fdad668c4456c0855c02fd42acef15e17c55c2d2f72e517d73c30e398a0a5
+  data.tar.gz: 30f0914834ce79ad2ffc4953687c5ea32fdada3bb998facba74eb2044b1f91a7
 SHA512:
-  metadata.gz: 2c5c46c15b32446531e120a60296ae8c6c00851de50c8176be8efe008dccf0fd82cad68bb541bf0081a668d786ffebb56df1d967c80c3da54d31fdd25b75f42e
-  data.tar.gz: 2aed6ccf7a31d14d0d21f391e28566be717b63c3104cd334b22a3a49e58f93923981b32367cd6a3b5d0f138876cd744aad5da213e9009de6c09c0c7671f180c8
+  metadata.gz: 71def8125a412f237cdde9c73d8c1d16da3488a01aa575183b73d0a72242b4785ebc715fd09c57e0d1427926d3636d9ea73eadd817d34b8073e8a6b8946727a5
+  data.tar.gz: 4364e84ce871804e7c88062a44655007be5f8733c68415a577f429b167727c465b7031c234451b565f9fcda2438a53eb0538c1202e855980ca7b020054817498

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.1"
+  VERSION = "2.0.2"
 end

data/lib/kitchen/driver/vcenter.rb

@@ -48,6 +48,9 @@ module Kitchen
       default_config :cluster, nil
       default_config :network_name, nil
       default_config :tags, nil
+      default_config :vm_wait_timeout, 90
+      default_config :vm_wait_interval, 2.0
+      default_config :vm_rollback, false
 
       # The main create method
       #
@@ -99,14 +102,30 @@ module Kitchen
           resource_pool: config[:resource_pool],
           clone_type: config[:clone_type],
           network_name: config[:network_name],
+          wait_timeout: config[:vm_wait_timeout],
+          wait_interval: config[:vm_wait_interval],
         }
 
-        # Create an object from which the clone operation can be called
-        new_vm = Support::CloneVm.new(connection_options, options)
-        new_vm.clone
+        begin
+          # Create an object from which the clone operation can be called
+          new_vm = Support::CloneVm.new(connection_options, options)
+          new_vm.clone
 
-        state[:hostname] = new_vm.ip
-        state[:vm_name] = new_vm.name
+          state[:hostname] = new_vm.ip
+          state[:vm_name] = new_vm.name
+
+        rescue # Kitchen::ActionFailed => e
+          if config[:vm_rollback] == true
+            error format("Rolling back VM %s after critical error", config[:vm_name])
+
+            # Inject name of failed VM for destroy to work
+            state[:vm_name] = config[:vm_name]
+
+            destroy(state)
+          end
+
+          raise
+        end
 
         unless config[:tags].nil? || config[:tags].empty?
           tag_api = VSphereAutomation::CIS::TaggingTagApi.new(api_client)
@@ -143,6 +162,10 @@ module Kitchen
       def destroy(state)
         return if state[:vm_name].nil?
 
+        # Reset resource pool, as it's not needed for the destroy action but might be a remnant of earlier calls to "connect"
+        # Temporary fix until setting cluster + resource_pool at the same time is implemented (lines #64/#187)
+        config[:resource_pool] = nil
+
         save_and_validate_parameters
         connect
 

data/lib/support/clone_vm.rb

@@ -1,8 +1,9 @@
+require "kitchen"
 require "rbvmomi"
 
 class Support
   class CloneVm
-    attr_reader :vim, :options, :vm, :name, :path
+    attr_reader :vim, :options, :vm, :name, :path, :ip
 
     def initialize(conn_opts, options)
       @options = options
@@ -12,6 +13,32 @@ class Support
       @vim ||= RbVmomi::VIM.connect conn_opts
     end
 
+    def get_ip(vm)
+      @ip = nil
+
+      unless vm.guest.net.empty? || !vm.guest.ipAddress
+        @ip = vm.guest.net[0].ipConfig.ipAddress.detect do |addr|
+          addr.origin != "linklayer"
+        end.ipAddress
+      end
+
+      ip
+    end
+
+    def wait_for_ip(vm, timeout = 30.0, interval = 2.0)
+      start = Time.new
+
+      ip = nil
+      loop do
+        ip = get_ip(vm)
+        break if ip || (Time.new - start) >= timeout
+        sleep interval
+      end
+
+      raise "Timeout waiting for IP address or no VMware Tools installed on guest" if ip.nil?
+      raise format("Error getting accessible IP address, got %s. Check DHCP server and scope exhaustion", ip) if ip =~ /^169\.254\./
+    end
+
     def clone
       # set the datacenter name
       dc = vim.serviceInstance.find_datacenter(options[:datacenter])
@@ -82,18 +109,20 @@ class Support
       # Set the folder to use
       dest_folder = options[:folder].nil? ? dc.vmFolder : options[:folder][:id]
 
-      puts "Cloning '#{options[:template]}' to create the VM..."
+      Kitchen.logger.info format("Cloning '%s' to create the VM...", options[:template])
       if options[:clone_type] == :instant
         vcenter_data = vim.serviceInstance.content.about
         raise "Instant clones only supported with vCenter 6.7 or higher" unless vcenter_data.version.to_f >= 6.7
-        puts "- Detected #{vcenter_data.fullName}"
+        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 { |c| c.host }.flatten
         targethost = hosts.select { |host| host.summary.config.name == options[:targethost].name }.first
+        raise "No matching ComputeResource found in host folder" if targethost.nil?
+
         esx_data = targethost.summary.config.product
         raise "Instant clones only supported with ESX 6.7 or higher" unless esx_data.version.to_f >= 6.7
-        puts "- Detected #{esx_data.fullName}"
+        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 "Need a running VM for instant clones" unless src_vm.runtime.powerState == "poweredOn"
@@ -127,17 +156,13 @@ class Support
       @vm = dc.find_vm(path)
 
       if vm.nil?
-        puts format("Unable to find machine: %s", path)
+        raise format("Unable to find machine: %s", path)
       else
-        puts "Waiting for network interfaces to become available..."
-        sleep 2 while vm.guest.net.empty? || !vm.guest.ipAddress
-      end
-    end
+        Kitchen.logger.info format("Waiting for VMware tools/network interfaces to become available (timeout: %d seconds)...", options[:wait_timeout])
 
-    def ip
-      vm.guest.net[0].ipConfig.ipAddress.detect do |addr|
-        addr.origin != "linklayer"
-      end.ipAddress
+        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
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-vcenter
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Chef Software