kitchen-vcenter 2.11.8 → 2.11.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50205f05bf2e5fca3977374cccbd79fa2c703dea89fee58336aeb4d4286a9c1b
-  data.tar.gz: 5ce2309de70acd22033ea4871903371c1948f4433d85650aebe15bc629a5897d
+  metadata.gz: '0942877c46827be0844a6e167180e1f34f97112da87a8d5789d3adc16dc95f28'
+  data.tar.gz: f87d1169572ae5b43f70d9d1e324034a982158fd18a1f6910e2baf538927f461
 SHA512:
-  metadata.gz: 4a5103e264c87f170405022b9b2fd0e9873365a7707ab023822276c6d312072ccd7ddb4d3de9ac3fef45f99c0c9c530a94e4627e367c8c5b7dfc2f92929ddcc0
-  data.tar.gz: fcf0c459ebd8805fafe813d5d34e9bc085936c2df84e3679a3564ae27e464757564ae23579c01e18358aa394c2fd013330132ee934d59bc41d668a31cfab109b
+  metadata.gz: ad70d62b377f2afe4938d11ab896b77bb281cdb02e10a602e0d3530d959f874fdc00297d44fd90b8159598515a2b768a346973284bbfb7b1c08e882710fbcfbf
+  data.tar.gz: 55d2274fcff17c6c677401b602ada26deafa6c16faffa388ea21cc1712706f591cd4ee79e66560756902666dd32fb049b896b24677d008c3aedc833e9730f5f1

data/lib/kitchen/driver/vcenter.rb

@@ -56,6 +56,7 @@ module Kitchen
       default_config :clone_type, :full
       default_config :cluster, nil
       default_config :network_name, nil
+      default_config :networks, []
       default_config :tags, nil
       default_config :vm_wait_timeout, 90
       default_config :vm_wait_interval, 2.0
@@ -94,6 +95,11 @@ module Kitchen
         The `customize` setting was renamed to `vm_customization` and will
         be removed in future versions.
       MSG
+      deprecate_config_for :network_name, Util.outdent!(<<-MSG)
+        The `network_name` setting is deprecated and will be removed in the
+        future version. Please use the new settings `networks` and refer
+        documentation for the usage.
+      MSG
 
       # The main create method
       #
@@ -145,7 +151,7 @@ module Kitchen
         config[:targethost] = get_host(config[:targethost], datacenter, cluster_id)
 
         # Check if network exists, if to be changed
-        network_exists?(config[:network_name]) unless config[:network_name].nil?
+        config[:networks].each { |network| network_exists?(network[:name]) }
 
         # Same thing needs to happen with the folder name if it has been set
         unless config[:folder].nil?
@@ -172,7 +178,7 @@ module Kitchen
           folder: config[:folder],
           resource_pool: config[:resource_pool],
           clone_type: config[:clone_type].to_sym,
-          network_name: config[:network_name],
+          networks: config[:networks],
           interface: config[:interface],
           wait_timeout: config[:vm_wait_timeout],
           wait_interval: config[:vm_wait_interval],
@@ -286,6 +292,13 @@ module Kitchen
         config[:vm_username] = config[:aggressive_username] unless config[:aggressive_username].nil?
         config[:vm_password] = config[:aggressive_password] unless config[:aggressive_password].nil?
         config[:vm_customization] = config[:customize] unless config[:customize].nil?
+        validate_network_parameters
+      end
+
+      def validate_network_parameters
+        return if config[:network_name].nil?
+
+        config[:networks] = [{ name: config[:network_name], operation: "edit" }]
       end
 
       # A helper method to validate the state

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.11.8"
+  VERSION = "2.11.13"
 end

data/lib/support/clone_vm.rb

@@ -173,6 +173,39 @@ class Support
       options[:vm_os].downcase.to_sym == :linux
     end
 
+    # Network configured to update the existing one in the template
+    #
+    def networks_to_update
+      options[:networks].select { |n| n[:operation] == "edit" }
+    end
+
+    # New networks that needs to be attached to newly created vm
+    #
+    def networks_to_add
+      options[:networks].select { |n| [nil, "add"].include?(n[:operation]) }
+    end
+
+    # A network should update if there is a network_device available in the template
+    # and the user configured a new network with edit operation.
+    #
+    def update_network?(network_device)
+      networks_to_update.any? && network_device
+    end
+
+    # Checks whether any networks configured for addition
+    def add_network?
+      networks_to_add.any?
+    end
+
+    # TODO: Remove this method and its invocations after the deprecation of `network_name` config
+    # For backward compatibility
+    # If the template doesn't have any NIC and the user use the old
+    # configuration(network_name), then that network should be attached to the vm.
+    #
+    def attach_new_network?(network_device)
+      network_device.nil? && networks_to_update.any?
+    end
+
     def network_device(vm)
       all_network_devices = vm.config.hardware.device.select do |device|
         device.is_a?(RbVmomi::VIM::VirtualEthernetCard)
@@ -463,6 +496,85 @@ class Support
       ))
     end
 
+    # This method will fetch the network which is configured in the kitchen.yml file with
+    # network_name configuration.
+    # If there are multiple networks with the same name, first one will be used.
+    #
+    # @return Network object
+    #
+    def fetch_network(datacenter, network_name)
+      networks = datacenter.network.select { |n| n.name == network_name }
+      raise Support::CloneError, format("Could not find network named %s", network_name) if networks.empty?
+
+      if networks.count > 1
+        Kitchen.logger.warn(
+          format("Found %d networks named %s, picking first one", networks.count, network_name)
+        )
+      end
+      networks.first
+    end
+
+    # This is a helper method that can be used to create the deviceChange spec which can be used
+    # to add a new network device or update the existing network device
+    #
+    # The network_obj will be used as a backing for the network_device.
+    def network_change_spec(network_device, network_obj, network_name, operation: :edit)
+      if network_obj.is_a? RbVmomi::VIM::DistributedVirtualPortgroup
+        Kitchen.logger.info format("Assigning network %s...", network_obj.pretty_path)
+
+        vds_obj = network_obj.config.distributedVirtualSwitch
+        Kitchen.logger.info format("Using vDS '%s' for network connectivity...", vds_obj.name)
+
+        network_device.backing = RbVmomi::VIM.VirtualEthernetCardDistributedVirtualPortBackingInfo(
+          port: RbVmomi::VIM.DistributedVirtualSwitchPortConnection(
+            portgroupKey: network_obj.key,
+            switchUuid: vds_obj.uuid
+          )
+        )
+      elsif network_obj.is_a? RbVmomi::VIM::Network
+        Kitchen.logger.info format("Assigning network %s...", network_name)
+
+        network_device.backing = RbVmomi::VIM.VirtualEthernetCardNetworkBackingInfo(
+          deviceName: network_name
+        )
+      else
+        raise Support::CloneError, format("Unknown network type %s for network name %s", network_obj.class.to_s, network_name)
+      end
+
+      RbVmomi::VIM.VirtualDeviceConfigSpec(
+        operation: RbVmomi::VIM::VirtualDeviceConfigSpecOperation(operation),
+        device: network_device
+      )
+    end
+
+    # This method can be used to add new network device to the target vm
+    # This fill find the network which defined in kitchen.yml in network_name configuration
+    # and attach that to the target vm.
+    def add_new_network_device(datacenter, networks)
+      device_change = []
+      networks.each do |network|
+        network_obj = fetch_network(datacenter, network[:name])
+        network_device = RbVmomi::VIM.VirtualVmxnet3(
+          key: 0,
+          deviceInfo: {
+            label: network[:name],
+            summary: network[:name],
+          }
+        )
+
+        device_change << network_change_spec(network_device, network_obj, network[:name], operation: :add)
+      end
+
+      config_spec = RbVmomi::VIM.VirtualMachineConfigSpec(
+        {
+          deviceChange: device_change,
+        }
+      )
+
+      task = vm.ReconfigVM_Task(spec: config_spec)
+      task.wait_for_completion
+    end
+
     def clone
       benchmark_start if benchmark?
 
@@ -507,47 +619,19 @@ class Support
       network_device = network_device(src_vm)
       Kitchen.logger.warn format("Source VM/template does not have any network device (use VMware IPPools and vsphere-gom transport or govc to access)") unless network_device
 
-      unless network_device.nil? || 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", 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
-
-        if network_obj.is_a? RbVmomi::VIM::DistributedVirtualPortgroup
-          Kitchen.logger.info format("Assigning network %s...", network_obj.pretty_path)
-
-          vds_obj = network_obj.config.distributedVirtualSwitch
-          Kitchen.logger.info format("Using vDS '%s' for network connectivity...", vds_obj.name)
-
-          network_device.backing = RbVmomi::VIM.VirtualEthernetCardDistributedVirtualPortBackingInfo(
-            port: RbVmomi::VIM.DistributedVirtualSwitchPortConnection(
-              portgroupKey: network_obj.key,
-              switchUuid: vds_obj.uuid
-            )
-          )
-        elsif network_obj.is_a? RbVmomi::VIM::Network
-          Kitchen.logger.info format("Assigning network %s...", options[:network_name])
-
-          network_device.backing = RbVmomi::VIM.VirtualEthernetCardNetworkBackingInfo(
-            deviceName: options[:network_name]
-          )
-        else
-          raise Support::CloneError.new(format("Unknown network type %s for network name %s", network_obj.class.to_s, options[:network_name]))
+      if update_network?(network_device)
+        network_spec = []
+        networks_to_update.each do |network|
+          network_obj = fetch_network(dc, network[:name])
+          network_spec << network_change_spec(network_device, network_obj, network[:name])
         end
-
-        relocate_spec.deviceChange = [
-          RbVmomi::VIM.VirtualDeviceConfigSpec(
-            operation: RbVmomi::VIM::VirtualDeviceConfigSpecOperation("edit"),
-            device: network_device
-          ),
-        ]
+        relocate_spec.deviceChange = network_spec
       end
 
       # Set the folder to use
       dest_folder = options[:folder].nil? ? dc.vmFolder : options[:folder][:id]
 
-      Kitchen.logger.info format("Cloning '%s' to create the VM...", options[:template])
+      Kitchen.logger.info format("Cloning '%s' to create the %s VM...", options[:template], vm_name)
       if instant_clone?
         vcenter_data = vim.serviceInstance.content.about
         raise Support::CloneError.new("Instant clones only supported with vCenter 6.7 or higher") unless vcenter_data.version.to_f >= 6.7
@@ -626,6 +710,11 @@ class Support
 
       vm_customization if options[:vm_customization]
 
+      # TODO: Remove this line after the deprecation of `network_name` config
+      add_new_network_device(dc, networks_to_update) if attach_new_network?(network_device)
+
+      add_new_network_device(dc, networks_to_add) if add_network?
+
       # Start only if specified or customizations wanted; no need for instant clones as they start in running state
       if options[:poweron] && !options[:vm_customization].nil? && !instant_clone?
         task = vm.PowerOnVM_Task

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-vcenter
 version: !ruby/object:Gem::Version
-  version: 2.11.8
+  version: 2.11.13
 platform: ruby
 authors:
 - Chef Software
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-28 00:00:00.000000000 Z
+date: 2022-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ping