kitchen-vcenter 2.6.0 → 2.7.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09fe38f6c02640a964e4018849dd5051de454bf0a9c92d43e5d26958210a68a3'
-  data.tar.gz: e84e03176304cb5d8a9720c47e03e38474d959de33f076b25ef9571d670288e7
+  metadata.gz: 336491e73efecaf915ea3d66abee8ec788a918b5f4f9a6b89a9a186622f1fbc4
+  data.tar.gz: 1c90b4a62e44c40837955a48afde23509c0afccbae563430fc6bfdc3ff7caae0
 SHA512:
-  metadata.gz: 9fc5020968df60fc311e0ad4b6ced4e694201641974d8bae3213a97f03dbf951cb5811f81b516e73962de2e0420eac8019f353252969a2702caf48d76b88898a
-  data.tar.gz: b3ad895ee096db923c9363f2461cad8315ff5cc6130cf2bb00ada31d2a501a46d95d350795e11afe04f5f4f0a1b29ad9f398d293eea00602a76e51974d9a5876
+  metadata.gz: bff63dd4a20821ce5ec1f8a2032ceae2962b4d26345810c23ebf44dc5548afc85b642342f617f54d8be79b8075b815f65c20df48070b718897216102cdeab2fc
+  data.tar.gz: 8384025e3a26ea8a33122f770aecb961a608f96deab7e349d4501676b1ce8628fc4035b65f0428be363fb31d845c677644729f95382de9d017be03d2e15650f6

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.0"
+  VERSION = "2.7.6"
 end

data/lib/kitchen/driver/vcenter.rb

@@ -18,7 +18,8 @@
 require "kitchen"
 require "vsphere-automation-cis"
 require "vsphere-automation-vcenter"
-require "support/clone_vm"
+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?
 

data/lib/support/clone_vm.rb

@@ -1,6 +1,6 @@
 require "kitchen"
 require "rbvmomi"
-require "support/guest_operations"
+require_relative "guest_operations"
 
 class Support
   class CloneError < RuntimeError; end
@@ -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,6 +262,8 @@ class Support
           # "wmic nicconfig get IPAddress",
           # "netsh interface ip show ipaddress #{options[:vm_win_network]}"
         end
+      else
+        options[:active_discovery_command]
       end
     end
 
@@ -395,15 +408,109 @@ 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
+
+      spec = 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]
+          )
+        )]
+      )
+
+      spec
+    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?
 
@@ -432,10 +539,11 @@ class Support
       # Change network, if wanted
       unless options[:network_name].nil?
         networks = dc.network.select { |n| n.name == options[:network_name] }
-        raise Support::CloneError.new(format("Could not find network named %s", option[:network_name])) if networks.empty?
+        raise Support::CloneError.new(format("Could not find network named %s", options[:network_name])) if networks.empty?
 
         Kitchen.logger.warn format("Found %d networks named %s, picking first one", networks.count, options[:network_name]) if networks.count > 1
         network_obj = networks.first
+        network_device = network_device(src_vm)
 
         if network_obj.is_a? RbVmomi::VIM::DistributedVirtualPortgroup
           Kitchen.logger.info format("Assigning network %s...", network_obj.pretty_path)
@@ -443,7 +551,6 @@ class Support
           vds_obj = network_obj.config.distributedVirtualSwitch
           Kitchen.logger.info format("Using vDS '%s' for network connectivity...", vds_obj.name)
 
-          network_device = network_device(src_vm)
           network_device.backing = RbVmomi::VIM.VirtualEthernetCardDistributedVirtualPortBackingInfo(
             port: RbVmomi::VIM.DistributedVirtualSwitchPortConnection(
               portgroupKey: network_obj.key,
@@ -520,9 +627,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.0
+  version: 2.7.6
 platform: ruby
 authors:
 - Chef Software
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-05 00:00:00.000000000 Z
+date: 2020-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbvmomi
@@ -30,20 +30,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: savon
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.11'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.11'
 - !ruby/object:Gem::Dependency
   name: test-kitchen
   requirement: !ruby/object:Gem::Requirement
@@ -78,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
@@ -130,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:
   - - ">="