kitchen-vcenter 2.7.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da86b6422044114b6f2b89cc85b8dc527fa5b743f2ff733e604c4730773e6fae
-  data.tar.gz: dab5b088008e3344b2d52fca17d97a4fffaf25a4dbf486b4ac7139d82bedbf00
+  metadata.gz: f3fb477d8c5d39ca1340bb9593fbbbfcd54d3fceb477f6aeb996f92bd0c62897
+  data.tar.gz: fe45e70e975a4a26e87f92c3ce46d844993c954bfcd41c9dc9808229aadb1ec2
 SHA512:
-  metadata.gz: 7fe27912e489acea7d4d126ca4ff6db750d24dbb56024ff387816db7b2948522da203a1d01cb728a7f16b10b0e44fb0bd27bfefa54a93849328fde67fe939d07
-  data.tar.gz: daadea97931ae326c43ab040ccd3cd5ebea0d724f76a8c9e3cc86b5e16c2f47b519fb7e66859f3db106b5366f05fd20d6ee5e373ef29d5098756d58845a9d1ee
+  metadata.gz: fe27bc6dc42e1ccfbcb8593281337b8aa5f7c20eae4c7a66a63887daef0d6be6d31ce82ef82e91cc90cf9e297ea3a096999ed00801737919879341e623d489c8
+  data.tar.gz: cf02a3623872e75f65bbe7a106ed616bf50f705fcbf39bdd36d7d5c4c88a2335f872075ce88736df4587536c2dccce09a3feeff3d8431cf9091dc329e829638b

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.7.0"
+  VERSION = "2.8.0"
 end

data/lib/kitchen/driver/vcenter.rb

@@ -20,8 +20,8 @@ require "vsphere-automation-cis"
 require "vsphere-automation-vcenter"
 require_relative "../../kitchen-vcenter/version"
 require_relative "../../support/clone_vm"
-require "securerandom"
-require "uri"
+require "securerandom" unless defined?(SecureRandom)
+require "uri" unless defined?(URI)
 
 # The main kitchen module
 module Kitchen
@@ -51,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
@@ -116,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
@@ -133,7 +137,7 @@ module Kitchen
         unless config[:folder].nil?
           config[:folder] = {
             name: config[:folder],
-            id: get_folder(config[:folder]),
+            id: get_folder(config[:folder], "VIRTUAL_MACHINE", datacenter),
           }
         end
 
@@ -156,6 +160,7 @@ 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],
@@ -288,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
@@ -326,13 +334,20 @@ 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
+      # @param [datacenter] datacenter is the datacenter of the folder
+      def get_folder(name, type = "VIRTUAL_MACHINE", datacenter = nil)
         folder_api = VSphereAutomation::VCenter::FolderApi.new(api_client)
-        folders = folder_api.list({ filter_names: name, filter_type: "VIRTUAL_MACHINE" }).value
+        parent_path, basename = File.split(name)
+        filter = { filter_names: basename, filter_type: type }
+        filter[:filter_datacenters] = datacenter if datacenter
+        filter[:filter_parent_folders] = get_folder(parent_path, type, datacenter) unless parent_path == "."
 
-        raise format("Unable to find folder: %s", name) if folders.empty?
+        folders = folder_api.list(filter).value
 
-        raise format("%s returned too many folders", name) if folders.length > 1
+        raise format("Unable to find folder: %s", basename) if folders.empty?
+
+        raise format("`%s` returned too many folders", basename) if folders.length > 1
 
         folders.first.folder
       end
@@ -349,10 +364,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?
 
@@ -408,14 +426,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

@@ -221,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",
@@ -428,12 +428,104 @@ class Support
       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
+
+      if options[:guest_customization][:ip_address]
+        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 options[:guest_customization][:subnet_mask]
+          raise Support::CloneError.new("Guest customization error: subnet_mask is required if assigning a fixed 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
+      end
+
+      if options[:guest_customization][:gateway]
+        unless options[:guest_customization][:gateway].is_a?(Array)
+          raise Support::CloneError.new("Guest customization error: gateway must be an array")
+        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
+      end
+
+      required = %i{dns_domain timezone dns_server_list dns_suffix_list}
+      missing = required - options[:guest_customization].keys
+      unless missing.empty?
+        raise Support::CloneError.new("Guest customization error: #{missing.join(", ")} are required to support guest customization")
+      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
+
+      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")
+      end
+
+      if options[:guest_customization][:ip_address]
+        customized_ip = 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]
+        )
+      else
+        customized_ip = RbVmomi::VIM::CustomizationIPSettings.new(
+          ip: RbVmomi::VIM::CustomizationDhcpIpGenerator.new,
+          dnsDomain: options[:guest_customization][:dns_domain]
+        )
+      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: customized_ip
+        )]
+      )
+    end
+
     def clone
       benchmark_start if benchmark?
 
       # set the datacenter name
       dc = find_datacenter
 
+      # get guest customization spec
+      guest_customization = customization_spec
+
       # reference template using full inventory path
       inventory_path = format("/%s/vm/%s", datacenter, options[:template])
       src_vm = root_folder.findByInventoryPath(inventory_path)
@@ -552,9 +644,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)

data/lib/support/guest_operations.rb

@@ -1,5 +1,5 @@
 require "rbvmomi"
-require "net/http"
+require "net/http" unless defined?(Net::HTTP)
 
 class Support
   # Encapsulate VMware Tools GOM interaction, inspired by github:dnuffer/raidopt

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-vcenter
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Chef Software
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-14 00:00:00.000000000 Z
+date: 2020-09-09 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:
   - - ">="