chef-provisioning-vsphere 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b059db41619a80c83fc1e3a397054aa706a40f9
-  data.tar.gz: f5231f61cf89c339da4140b10641bcb02c79c538
+  metadata.gz: 92dd7232f0e413e7c361d52694f55afaa06ff284
+  data.tar.gz: e2fade153c0e0fc4afa2743fd3fa630cd5edc722
 SHA512:
-  metadata.gz: 66bcd56de9e4a17cd2de6431b982228c19d6dea451b1d915f36d98f2dc7fa0dfa9d43d87e9893e4b945b629683b3d13ab60690fe063d08c3ced7db4f8a2d3e95
-  data.tar.gz: a261f68210ebfed783e07d82085e0d7b86cc4633f83ebe15566db79cab5d2b3c635d93f3bce36b5c5e5cf5f71242cac94dd7caa7968035d085002b1f68e44bbc
+  metadata.gz: 8ec7e70b47e2297b91cba24d7c22e5d95ae67e873a472c269a988c95f3e04a92de2a29ba9dee10de014dd47d78f65e77ec5f2bc4983f4d6f4661a07442ee2288
+  data.tar.gz: 2f6e4e64d1dffeb4880463c6e8d3ee991924068d38aa8f9e159022c727bacda2a1d5c4ebee386f7aed9b03473392904b99529d9e003e282f5214b2ee0d523789

data/CHANGELOG.md

@@ -1,7 +1,14 @@
 # Change Log
 
-## [v2.2.0](https://github.com/chef-partners/chef-provisioning-vsphere/tree/v2.2.0)
+## [v2.2.1](https://github.com/chef-partners/chef-provisioning-vsphere/tree/v2.2.1)
 
+[Full Changelog](https://github.com/chef-partners/chef-provisioning-vsphere/compare/v2.2.0...v2.2.1)
+
+**Merged pull requests:**
+
+- Fixes bug where additional disks added twice [\#84](https://github.com/chef-partners/chef-provisioning-vsphere/pull/84) ([josh-barker](https://github.com/josh-barker))
+
+## [v2.2.0](https://github.com/chef-partners/chef-provisioning-vsphere/tree/v2.2.0) (2018-06-01)
 [Full Changelog](https://github.com/chef-partners/chef-provisioning-vsphere/compare/v2.1.0...v2.2.0)
 
 **Merged pull requests:**

data/lib/chef/provisioning/vsphere_driver/driver.rb

@@ -88,7 +88,7 @@ module ChefProvisioningVsphere
       end
     end
 
-    attr_reader :connect_options, :vm_helper
+    attr_reader :connect_options
 
     # Creates a new vm_helper if not already there
     #
@@ -291,7 +291,7 @@ module ChefProvisioningVsphere
       end
 
       ## Check if true available after added nic
-      @vm_helper.open_port?(machine_spec.location['ipaddress'], @vm_helper.port) unless machine_spec.location['ipaddress'].nil?
+      vm_helper.open_port?(machine_spec.location['ipaddress'], vm_helper.port) unless machine_spec.location['ipaddress'].nil?
       machine
     end
 
@@ -312,7 +312,7 @@ module ChefProvisioningVsphere
         bootstrap_options,
         vm
       )
-      if is_windows?(vm) && !new_nics.nil? && @vm_helper.open_port?(machine_spec.location['ipaddress'], @vm_helper.port)
+      if is_windows?(vm) && !new_nics.nil? && vm_helper.open_port?(machine_spec.location['ipaddress'], vm_helper.port)
         new_nics.each do |nic|
           nic_label = nic.device.deviceInfo.label
           machine.execute_always(
@@ -687,57 +687,9 @@ module ChefProvisioningVsphere
       vm = vsphere_helper.find_vm(vm_folder, machine_name)
       add_machine_spec_location(vm, machine_spec)
 
-      additional_disk_size_gb = Array(bootstrap_options[:additional_disk_size_gb])
-
-
       vsphere_helper.update_main_disk_size_for(vm, bootstrap_options[:main_disk_size_gb])
       vsphere_helper.set_additional_disks_for(vm, bootstrap_options[:datastore], bootstrap_options[:additional_disk_size_gb])
-      if !additional_disk_size_gb.empty? && bootstrap_options[:datastore].to_s.empty?
-        raise ':datastore must be specified when adding a disk to a cloned vm'
-      end
-
-      additional_disk_size_gb.each do |size|
-        size = size.to_i
-        next if size == 0
-        task = vm.ReconfigVM_Task(
-          spec: RbVmomi::VIM.VirtualMachineConfigSpec(
-            deviceChange: [
-              vsphere_helper.virtual_disk_for(
-                vm,
-                bootstrap_options[:datastore],
-                size
-              )
-            ]
-          )
-        )
-        task.wait_for_completion
-      end
-
-
-      if bootstrap_options[:initial_iso_image]
-        d_obj = vm.config.hardware.device.select {|hw| hw.class == RbVmomi::VIM::VirtualCdrom}.first
-        backing = RbVmomi::VIM::VirtualCdromIsoBackingInfo(fileName: bootstrap_options[:initial_iso_image])
-        task = vm.ReconfigVM_Task(
-          spec: RbVmomi::VIM.VirtualMachineConfigSpec(
-            deviceChange: [
-              operation: :edit,
-              device: RbVmomi::VIM::VirtualCdrom(
-                backing: backing,
-                key: d_obj.key,
-                controllerKey: d_obj.controllerKey,
-                connectable: RbVmomi::VIM::VirtualDeviceConnectInfo(
-                  startConnected: true,
-                  connected: true,
-
-                  allowGuestControl: true
-                )
-
-              )
-            ]
-          )
-        )
-        task.wait_for_completion
-      end
+      vsphere_helper.set_initial_iso(vm, bootstrap_options[:initial_iso_file])
 
       vm
     end
@@ -818,7 +770,7 @@ module ChefProvisioningVsphere
     # @param [Object] vm The VM object from Chef-Provisioning
     # @param [Object] action_handler taken from Chef provisioning for TODO.
     def wait_for_transport(action_handler, machine_spec, machine_options, vm)
-      @vm_helper.find_port?(vm, machine_options[:bootstrap_options]) if vm_helper.port.nil?
+      vm_helper.find_port?(vm, machine_options[:bootstrap_options]) if vm_helper.port.nil?
       transport = transport_for(
         machine_spec,
         machine_options[:bootstrap_options][:ssh]
@@ -865,7 +817,7 @@ module ChefProvisioningVsphere
                         else
                           options[:winrm_transport].nil? ? :negotiate : options[:winrm_transport].to_sym
                         end
-      port = options[:port] || @vm_helper.port
+      port = options[:port] || vm_helper.port
       winrm_options = {
         user: (options[:user]).to_s,
         pass: options[:password]
@@ -939,7 +891,7 @@ module ChefProvisioningVsphere
       # Then check that it is reachable
       until Time.now.utc - start_time > timeout
         print '.'
-        return vm_ip.to_s if @vm_helper.open_port?(vm_ip, @vm_helper.port, 1)
+        return vm_ip.to_s if vm_helper.open_port?(vm_ip, vm_helper.port, 1)
         sleep 1
       end
       raise "Timed out (#{timeout}s) waiting for ip #{vm_ip} to be connectable"

data/lib/chef/provisioning/vsphere_driver/version.rb

@@ -3,5 +3,5 @@
 # Provisions machines in vSphere.
 module ChefProvisioningVsphere
   # The version of this awesome Gem. BOOM.
-  VERSION = '2.2.0'.freeze
+  VERSION = '2.2.1'.freeze
 end

data/lib/chef/provisioning/vsphere_driver/vsphere_helpers.rb

@@ -133,7 +133,7 @@ module ChefProvisioningVsphere
       vim # ensure connection is valid
       @datacenter ||= begin
         rootFolder = vim.serviceInstance.content.rootFolder
-        dc = traverse_folders_for_dc(vim.rootFolder, datacenter_name) || abort('vSphere Datacenter not found [#{datacenter_name}]')
+        dc = traverse_folders_for_dc(vim.rootFolder, datacenter_name) || abort("vSphere Datacenter not found [#{datacenter_name}]")
       end
     end
 
@@ -259,12 +259,12 @@ module ChefProvisioningVsphere
     # @param [Subject] datastore the datastore the disk will be created on.
     # @param [Subject] size_gb the size of the disk.
     def set_additional_disks_for(vm, datastore, additional_disk_size_gb)
-      (additional_disk_size_gb.is_a?(Array) ? additional_disk_size_gb : [additional_disk_size_gb]).each do |size|
+      raise ':datastore must be specified when adding a disk to a cloned vm' if datastore.to_s.empty? && additional_disk_size_gb
+
+      Array(additional_disk_size_gb).each do |size|
         size = size.to_i
-        next if size.zero?
-        if datastore.to_s.empty?
-          raise ':datastore must be specified when adding a disk to a cloned vm'
-        end
+        next if size <= 0
+
         task = vm.ReconfigVM_Task(
           spec: RbVmomi::VIM.VirtualMachineConfigSpec(
             deviceChange: [
@@ -280,6 +280,37 @@ module ChefProvisioningVsphere
       end
     end
 
+    # Mounts the an iso on the first virtual CD ROm
+    #
+    # @param [Object] vm the VM object.
+    # @param [Subject] name of the iso file
+    def set_initial_iso(vm, initial_iso_image)
+      return unless initial_iso_image
+
+      d_obj = vm.config.hardware.device.select { |hw| hw.class == RbVmomi::VIM::VirtualCdrom }.first
+      backing = RbVmomi::VIM::VirtualCdromIsoBackingInfo(fileName: initial_iso_image)
+
+      task = vm.ReconfigVM_Task(
+        spec: RbVmomi::VIM.VirtualMachineConfigSpec(
+          deviceChange: [
+            operation: :edit,
+            device: RbVmomi::VIM::VirtualCdrom(
+              backing: backing,
+              key: d_obj.key,
+              controllerKey: d_obj.controllerKey,
+              connectable: RbVmomi::VIM::VirtualDeviceConnectInfo(
+                startConnected: true,
+                connected: true,
+
+                allowGuestControl: true
+              )
+            )
+          ]
+        )
+      )
+      task.wait_for_completion
+    end
+
     # Updates the main virtual disk for the VM
     # This can only add capacity to the main disk, it is not possible to reduce the capacity.
     #

data/spec/unit_tests/clone_spec_builder_spec.rb

@@ -98,7 +98,7 @@ describe ChefProvisioningVsphere::CloneSpecBuilder do
     end
 
     it 'raises an error' do
-      expect { subject }.to raise_error
+      expect { subject }.to raise_error(RuntimeError)
     end
   end
 
@@ -139,7 +139,7 @@ describe ChefProvisioningVsphere::CloneSpecBuilder do
       let(:hostname) { 'my_host' }
 
       it 'raises an error' do
-        expect { subject }.to raise_error
+        expect { subject }.to raise_error(RuntimeError)
       end
     end
 
@@ -147,7 +147,7 @@ describe ChefProvisioningVsphere::CloneSpecBuilder do
       let(:hostname) { '-myhost' }
 
       it 'raises an error' do
-        expect { subject }.to raise_error
+        expect { subject }.to raise_error(RuntimeError)
       end
     end
 
@@ -155,7 +155,7 @@ describe ChefProvisioningVsphere::CloneSpecBuilder do
       let(:hostname) { 'myhost-' }
 
       it 'raises an error' do
-        expect { subject }.to raise_error
+        expect { subject }.to raise_error(RuntimeError)
       end
     end
   end

data/spec/unit_tests/vsphere_helpers_spec.rb

@@ -0,0 +1,183 @@
+require 'chef/provisioning/vsphere_driver'
+
+describe ChefProvisioningVsphere::VsphereHelper do
+  let(:subject) do
+    connection_opts = {
+      host: 'fake.host.com',
+      port: 443
+    }
+    ChefProvisioningVsphere::VsphereHelper.new(connection_opts, 'fake datacenter')
+  end
+  let(:vm) { vm = double('vm') }
+  let(:task) { double('task', wait_for_completion: true) }
+
+  describe '#set_additional_disks_for' do    
+    before do
+      allow(vm).to receive(:disks).and_return(['root_disk'], ['root_disk', 'first_disk'])
+    end
+
+    context 'when datastore is missing' do
+      let(:datastore) { nil }
+      it 'and no extra disks, nothing is raised' do
+        additional_disk_size_gb = nil
+        expect { subject.set_additional_disks_for vm, datastore, additional_disk_size_gb }.not_to raise_error
+      end
+
+      it 'and has 1 disk, error is raised' do
+        additional_disk_size_gb = 1
+        expect { subject.set_additional_disks_for vm, datastore, additional_disk_size_gb }.to raise_error(RuntimeError)
+      end
+
+      it 'and has multiple disks, error is raised' do
+        additional_disk_size_gb = [1, 2]
+        expect { subject.set_additional_disks_for vm, datastore, additional_disk_size_gb }.to raise_error(RuntimeError)
+      end
+    end
+
+    context 'when datastore is present' do
+      let(:datastore) { 'some datastore' }
+      let(:disk_1) do
+        {
+            spec: RbVmomi::VIM.VirtualMachineConfigSpec(
+            deviceChange: [
+              RbVmomi::VIM::VirtualDeviceConfigSpec(
+                operation: :add,
+                fileOperation: :create,
+                device: RbVmomi::VIM.VirtualDisk(
+                  key: 1,
+                  backing: RbVmomi::VIM.VirtualDiskFlatVer2BackingInfo(
+                    fileName: "[#{datastore}]",
+                    diskMode: 'persistent',
+                    thinProvisioned: true
+                  ),
+                  capacityInKB: 1 * 1024 * 1024,
+                  controllerKey: 1000,
+                  unitNumber: 1
+                )
+              )
+            ]
+          )
+        }
+      end
+
+      let(:disk_2) do
+        {
+            spec: RbVmomi::VIM.VirtualMachineConfigSpec(
+            deviceChange: [
+              RbVmomi::VIM::VirtualDeviceConfigSpec(
+                operation: :add,
+                fileOperation: :create,
+                device: RbVmomi::VIM.VirtualDisk(
+                  key: 2,
+                  backing: RbVmomi::VIM.VirtualDiskFlatVer2BackingInfo(
+                    fileName: "[#{datastore}]",
+                    diskMode: 'persistent',
+                    thinProvisioned: true
+                  ),
+                  capacityInKB: 2 * 1024 * 1024,
+                  controllerKey: 1000,
+                  unitNumber: 2
+                )
+              )
+            ]
+          )
+        }
+      end
+
+      it 'and no extra disks, nothing is created' do
+        additional_disk_size_gb = nil
+        expect(vm).not_to receive(:ReconfigVM_Task)
+        subject.set_additional_disks_for vm, datastore, additional_disk_size_gb
+      end
+
+      it 'and disk is a string, nothing is created' do
+        additional_disk_size_gb = ['not a number']
+        expect(vm).not_to receive(:ReconfigVM_Task)
+        subject.set_additional_disks_for vm, datastore, additional_disk_size_gb
+      end
+
+      it 'and has 0 GB, nothing is created' do
+        additional_disk_size_gb = [0]
+        expect(vm).not_to receive(:ReconfigVM_Task)
+        subject.set_additional_disks_for vm, datastore, additional_disk_size_gb
+      end
+
+      it 'and has -1 GB, nothing is created' do
+        additional_disk_size_gb = [-1]
+        expect(vm).not_to receive(:ReconfigVM_Task)
+        subject.set_additional_disks_for vm, datastore, additional_disk_size_gb
+      end
+
+      it 'and has 1 x 1 GB, create disk' do
+        additional_disk_size_gb = 1
+        expect(vm).to receive(:ReconfigVM_Task).with(disk_1).and_return(task)
+        subject.set_additional_disks_for vm, datastore, additional_disk_size_gb
+      end
+
+      it 'and has 2 disks, create 2 disks' do
+        additional_disk_size_gb = [1, 2]
+
+        expect(vm).to receive(:ReconfigVM_Task).with(disk_1).and_return(task)
+        expect(vm).to receive(:ReconfigVM_Task).with(disk_2).and_return(task)
+        subject.set_additional_disks_for vm, datastore, additional_disk_size_gb
+      end
+
+      it 'and has 3 disks, including 1 of 0 size, create 2 disks' do
+        additional_disk_size_gb = [0, 1, 2]
+        expect(vm).to receive(:ReconfigVM_Task).with(disk_1).and_return(task)
+        expect(vm).to receive(:ReconfigVM_Task).with(disk_2).and_return(task)
+
+        subject.set_additional_disks_for vm, datastore, additional_disk_size_gb
+      end
+    end
+  end
+
+  describe '#set_initial_iso' do
+    let(:cd_rom) do
+      double('cd_rom',
+        class: RbVmomi::VIM::VirtualCdrom,
+        key: 'some key',
+        controllerKey: 'some controller key'
+      )
+    end
+
+    let(:fake_backing) do
+      RbVmomi::VIM::VirtualCdromIsoBackingInfo(fileName: 'some_iso.iso')
+    end
+
+    let(:iso_spec) do
+      { 
+        spec: RbVmomi::VIM.VirtualMachineConfigSpec(
+          deviceChange: [
+            operation: :edit,
+            device: RbVmomi::VIM::VirtualCdrom(
+              backing: fake_backing,
+              key: 'some key',
+              controllerKey: 'some controller key',
+              connectable: RbVmomi::VIM::VirtualDeviceConnectInfo(
+                startConnected: true,
+                connected: true,
+                allowGuestControl: true
+              )
+            )
+          ]
+        )
+      }
+    end
+
+    before do
+      allow(vm).to receive_message_chain(:config, :hardware, :device)
+      .and_return([cd_rom])
+    end
+
+    it 'does nothing when no iso' do
+      expect(vm).not_to receive(:ReconfigVM_Task)
+      subject.set_initial_iso vm, nil
+    end
+
+    it 'sets initial iso' do
+      expect(vm).to receive(:ReconfigVM_Task).with(iso_spec).and_return(task)
+      subject.set_initial_iso vm, 'some_iso.iso'
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chef-provisioning-vsphere
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - CenturyLink Cloud
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-01 00:00:00.000000000 Z
+date: 2018-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
@@ -250,6 +250,7 @@ files:
 - spec/unit_tests/clone_spec_builder_spec.rb
 - spec/unit_tests/support/fake_action_handler.rb
 - spec/unit_tests/support/vsphere_helper_stub.rb
+- spec/unit_tests/vsphere_helpers_spec.rb
 homepage: https://github.com/chef-partners/chef-provisioning-vsphere
 licenses:
 - MIT
@@ -283,3 +284,4 @@ test_files:
 - spec/unit_tests/clone_spec_builder_spec.rb
 - spec/unit_tests/support/fake_action_handler.rb
 - spec/unit_tests/support/vsphere_helper_stub.rb
+- spec/unit_tests/vsphere_helpers_spec.rb