kitchen-vcenter 2.6.4 → 2.7.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48a7b054f396b0a0074fb6c20096ace9db63ed41ef81468a38eff3a106419d3f
-  data.tar.gz: 6a2c17827fab3cfca5680b9358a42878e47162b9809139adf87ab990db516461
+  metadata.gz: 8386b994051575b7997042ebd3c818de171a8de1ca34a39e13672800b986f216
+  data.tar.gz: 611d99f79e9d90ba850b1b0f04f126f3ca8acbb7c5000861c2d32310602f8f63
 SHA512:
-  metadata.gz: d6fd6e15dd7e011b029cb2d3f470777a44eee7f1bbd207c3748e61899e18caabcfa3d037e5cc7f1f88d87791f7bac9d5e238407615d7673629c9a10e356ca4b7
-  data.tar.gz: 2677d2b44e2856f75f560ae3b78d7e6a3a656477f1686e5747e7f350c56094acd7dec0a9e93480aaf75896a5ecb890466ab47e66ffb9a0c20909b1ea0198a598
+  metadata.gz: 678e749a5da30a917227c6f057836177b0a70a7f2d3b79a5272b76ee1a26aa33191234fd31211a43d31e4137e1c6184c6b2307d7a75658bcd5e944214a4cf523
+  data.tar.gz: adf8a44b1a88c6274e1ee7070c7055b203fb033ebffb6723476fc3db6abfd6a8660fc16693a0cae8f4419bef34e550bc75de5a3c99a903f90e34b81bc252a531

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.6.4"
+  VERSION = "2.7.9"
 end

data/lib/kitchen/driver/vcenter.rb

@@ -18,6 +18,7 @@
 require "kitchen"
 require "vsphere-automation-cis"
 require "vsphere-automation-vcenter"
+require_relative "../../kitchen-vcenter/version"
 require_relative "../../support/clone_vm"
 require "securerandom"
 require "uri"
@@ -50,6 +51,7 @@ module Kitchen
       default_config :vm_wait_interval, 2.0
       default_config :vm_rollback, false
       default_config :customize, nil
+      default_config :guest_customization, nil
       default_config :interface, nil
       default_config :active_discovery, false
       default_config :active_discovery_command, nil
@@ -57,6 +59,7 @@ module Kitchen
       default_config :vm_username, "vagrant"
       default_config :vm_password, "vagrant"
       default_config :vm_win_network, "Ethernet0"
+      default_config :transform_ip, nil
 
       default_config :benchmark, false
       default_config :benchmark_file, "kitchen-vcenter.csv"
@@ -82,6 +85,8 @@ module Kitchen
       #
       # @param [Object] state is the state of the vm
       def create(state)
+        debug format("Starting kitchen-vcenter %s", ::KitchenVcenter::VERSION)
+
         save_and_validate_parameters
         connect
 
@@ -112,10 +117,13 @@ module Kitchen
         end
 
         # Check that the datacenter exists
-        datacenter_exists?(config[:datacenter])
+        dc_folder = File.dirname(config[:datacenter])
+        dc_folder = nil if dc_folder == "."
+        dc_name = File.basename(config[:datacenter])
+        datacenter_exists?(dc_folder, dc_name)
 
         # Get datacenter and cluster information
-        datacenter = get_datacenter(config[:datacenter])
+        datacenter = get_datacenter(dc_folder, dc_name)
         cluster_id = get_cluster_id(config[:cluster])
 
         # Using the clone class, create a machine for TK
@@ -152,12 +160,14 @@ module Kitchen
           wait_timeout: config[:vm_wait_timeout],
           wait_interval: config[:vm_wait_interval],
           customize: config[:customize],
+          guest_customization: config[:guest_customization],
           active_discovery: config[:active_discovery],
           active_discovery_command: config[:active_discovery_command],
           vm_os: config[:vm_os],
           vm_username: config[:vm_username],
           vm_password: config[:vm_password],
           vm_win_network: config[:vm_win_network],
+          transform_ip: config[:transform_ip],
           benchmark: config[:benchmark],
           benchmark_file: config[:benchmark_file],
         }
@@ -283,10 +293,13 @@ module Kitchen
 
       # Sees in the datacenter exists or not
       #
+      # @param [folder] folder is the name of the folder in which the Datacenter is stored in inventory, possibly nil
       # @param [name] name is the name of the datacenter
-      def datacenter_exists?(name)
+      def datacenter_exists?(folder, name)
         dc_api = VSphereAutomation::VCenter::DatacenterApi.new(api_client)
-        dcs = dc_api.list({ filter_names: name }).value
+        opts = { filter_names: name }
+        opts[:filter_folders] = get_folder(folder, "DATACENTER") if folder
+        dcs = dc_api.list(opts).value
 
         raise format("Unable to find data center: %s", name) if dcs.empty?
       end
@@ -321,9 +334,10 @@ module Kitchen
       # Gets the folder you want to create the VM
       #
       # @param [name] name is the name of the folder
-      def get_folder(name)
+      # @param [type] type is the type of the folder, one of VIRTUAL_MACHINE, DATACENTER, possibly other values
+      def get_folder(name, type = "VIRTUAL_MACHINE")
         folder_api = VSphereAutomation::VCenter::FolderApi.new(api_client)
-        folders = folder_api.list({ filter_names: name, filter_type: "VIRTUAL_MACHINE" }).value
+        folders = folder_api.list({ filter_names: name, filter_type: type }).value
 
         raise format("Unable to find folder: %s", name) if folders.empty?
 
@@ -344,10 +358,13 @@ module Kitchen
 
       # Gets the info of the datacenter
       #
+      # @param [folder] folder is the name of the folder in which the Datacenter is stored in inventory, possibly nil
       # @param [name] name is the name of the Datacenter
-      def get_datacenter(name)
+      def get_datacenter(folder, name)
         dc_api = VSphereAutomation::VCenter::DatacenterApi.new(api_client)
-        dcs = dc_api.list({ filter_names: name }).value
+        opts = { filter_names: name }
+        opts[:filter_folders] = get_folder(folder, "DATACENTER") if folder
+        dcs = dc_api.list(opts).value
 
         raise format("Unable to find data center: %s", name) if dcs.empty?
 
@@ -403,14 +420,14 @@ module Kitchen
           # 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
+          # This behavior 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)
+          # Remove default pool for first pass (<= 1.2.1 behavior 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(&:name).to_s)
 
-          # Revert to default pool, if no user-defined pool found (> 1.2.1 behaviour)
+          # Revert to default pool, if no user-defined pool found (> 1.2.1 behavior)
           # (This one might not be found under some circumstances by the statement above)
           return get_resource_pool("Resources") if resource_pools.empty?
         else

data/lib/support/clone_vm.rb

@@ -81,6 +81,17 @@ class Support
       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
 
@@ -210,13 +221,13 @@ class Support
       case options[:vm_os].downcase.to_sym
       when :linux
         # @todo: allow override if no dhclient
-        return [
+        [
           "/sbin/modprobe -r vmxnet3",
           "/sbin/modprobe vmxnet3",
           "/sbin/dhclient",
         ]
       when :windows
-        return [
+        [
           "netsh interface set Interface #{options[:vm_win_network]} disable",
           "netsh interface set Interface #{options[:vm_win_network]} enable",
           "ipconfig /renew",
@@ -251,8 +262,8 @@ class Support
           # "wmic nicconfig get IPAddress",
           # "netsh interface ip show ipaddress #{options[:vm_win_network]}"
         end
-      else  
-        return options[:active_discovery_command]
+      else
+        options[:active_discovery_command]
       end
     end
 
@@ -397,15 +408,107 @@ class Support
       options[:clone_type] == :full
     end
 
+    def root_folder
+      @root_folder ||= vim.serviceInstance.content.rootFolder
+    end
+
+    #
+    # @return [String]
+    #
+    def datacenter
+      options[:datacenter]
+    end
+
+    #
+    # @return [RbVmomi::VIM::Datacenter]
+    #
+    def find_datacenter
+      vim.serviceInstance.find_datacenter(datacenter)
+    rescue RbVmomi::Fault
+      root_folder.childEntity.grep(RbVmomi::VIM::Datacenter).find { |x| x.name == datacenter }
+    end
+
+    def ip?(string)
+      IPAddr.new(string)
+      true
+    rescue IPAddr::InvalidAddressError
+      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
+
+      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]
+        ),
+        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]
+          )
+        )]
+      )
+    end
+
     def clone
       benchmark_start if benchmark?
 
       # set the datacenter name
-      dc = vim.serviceInstance.find_datacenter(options[:datacenter])
+      dc = find_datacenter
+
+      # get guest customization spec
+      guest_customization = customization_spec
 
       # reference template using full inventory path
-      root_folder = vim.serviceInstance.content.rootFolder
-      inventory_path = format("/%s/vm/%s", options[:datacenter], options[:template])
+      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?
 
@@ -522,9 +625,15 @@ class Support
         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?,
-                                                          template: false)
+        clone_spec = RbVmomi::VIM.VirtualMachineCloneSpec(
+          location: relocate_spec,
+          powerOn: options[:poweron] && options[:customize].nil?,
+          template: false
+        )
+
+        if guest_customization
+          clone_spec.customization = guest_customization
+        end
 
         benchmark_checkpoint("initialized") if benchmark?
         task = src_vm.CloneVM_Task(spec: clone_spec, folder: dest_folder, name: name)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-vcenter
 version: !ruby/object:Gem::Version
-  version: 2.6.4
+  version: 2.7.9
 platform: ruby
 authors:
 - Chef Software
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-18 00:00:00.000000000 Z
+date: 2020-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbvmomi
@@ -19,7 +19,7 @@ dependencies:
         version: '1.11'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '1.11'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: test-kitchen
   requirement: !ruby/object:Gem::Requirement
@@ -64,34 +64,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Test Kitchen driver for VMware vCenter using SDK
 email:
 - oss@chef.io
@@ -116,7 +88,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="