chef-provisioning-vsphere 0.10.0 → 1.0.0

data/lib/kitchen/driver/vsphere.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'json'
 require 'kitchen'
 require 'chef/provisioning/vsphere_driver'
@@ -6,26 +7,25 @@ require 'chef/provisioning/machine_spec'
 module Kitchen
   module Driver
     class Vsphere < Kitchen::Driver::Base
-
       @@chef_zero_server = false
 
       default_config :machine_options,
-        :start_timeout => 600,
-        :create_timeout => 600,
-        :stop_timeout => 600,
-        :ready_timeout => 90,
-        :bootstrap_options => {
-          :use_linked_clone => true,
-          :ssh => {
-            :user => 'root',
-            :paranoid => false,
-            :port => 22
-          },
-          :convergence_options => {},
-          :customization_spec => {
-            :domain => 'local'
-          }
-        }
+                     start_timeout: 600,
+                     create_timeout: 600,
+                     stop_timeout: 600,
+                     ready_timeout: 90,
+                     bootstrap_options: {
+                       use_linked_clone: true,
+                       ssh: {
+                         user: 'root',
+                         paranoid: false,
+                         port: 22
+                       },
+                       convergence_options: {},
+                       customization_spec: {
+                         domain: 'local'
+                       }
+                     }
 
       default_config(:vsphere_name) do |driver|
         "#{driver.instance.name}-#{SecureRandom.hex(4)}"
@@ -37,7 +37,7 @@ module Kitchen
         state[:password] = config[:machine_options][:bootstrap_options][:ssh][:password]
         config[:server_name] = state[:vsphere_name]
 
-        machine = with_provisioning_driver(state) do | action_handler, driver, machine_spec|
+        machine = with_provisioning_driver(state) do |action_handler, driver, machine_spec|
           driver.allocate_machine(action_handler, machine_spec, config[:machine_options])
           driver.ready_machine(action_handler, machine_spec, config[:machine_options])
           state[:server_id] = machine_spec.location['server_id']
@@ -49,9 +49,9 @@ module Kitchen
       def destroy(state)
         return if state[:server_id].nil?
 
-        with_provisioning_driver(state) do | action_handler, driver, machine_spec|
+        with_provisioning_driver(state) do |action_handler, driver, machine_spec|
           machine_spec.location = { 'driver_url' => driver.driver_url,
-                        'server_id' => state[:server_id]}
+                                    'server_id' => state[:server_id] }
           driver.destroy_machine(action_handler, machine_spec, config[:machine_options])
         end
 
@@ -60,23 +60,23 @@ module Kitchen
         state.delete(:vsphere_name)
       end
 
-      def with_provisioning_driver(state, &block)
-        config[:machine_options][:convergence_options] = {:chef_server => chef_server}
+      def with_provisioning_driver(state)
+        config[:machine_options][:convergence_options] = { chef_server: chef_server }
         machine_spec = Chef::Provisioning.chef_managed_entry_store(chef_server).get(:machine, state[:vsphere_name])
         if machine_spec.nil?
           machine_spec = Chef::Provisioning.chef_managed_entry_store(chef_server)
-            .new_entry(:machine, state[:vsphere_name])
+                                           .new_entry(:machine, state[:vsphere_name])
         end
         url = URI::VsphereUrl.from_config(@config[:driver_options]).to_s
         driver = Chef::Provisioning.driver_for_url(url, config)
         action_handler = Chef::Provisioning::ActionHandler.new
-        block.call(action_handler, driver, machine_spec)
+        yield(action_handler, driver, machine_spec)
       end
 
       def chef_server
-        if !@@chef_zero_server
+        unless @@chef_zero_server
           vsphere_mutex.synchronize do
-            if !@@chef_zero_server
+            unless @@chef_zero_server
               Chef::Config.local_mode = true
               Chef::Config.chef_repo_path = Chef::Config.find_chef_repo_path(Dir.pwd)
               require 'chef/local_mode'
@@ -92,7 +92,7 @@ module Kitchen
       def vsphere_mutex
         @@vsphere_mutex ||= begin
           Kitchen.mutex.synchronize do
-            instance.class.mutexes ||= Hash.new
+            instance.class.mutexes ||= {}
             instance.class.mutexes[self.class] = Mutex.new
           end
 

data/spec/integration_tests/.gitignore

@@ -1 +1 @@
-config.rb
+config.rb

data/spec/integration_tests/vsphere_driver_spec.rb

@@ -1,37 +1,38 @@
+# frozen_string_literal: true
 require 'chef/provisioning/vsphere_driver'
 require 'chef/provisioning/machine_spec'
 
-  # A file named config.rb in the same directory as this spec file 
-  # must exist containing the driver options to use for the test.
-  # Here is an example:
-  # {
-  #   :driver_options => { 
-  #     :host => '213.45.67.88',
-  #     :user => 'vmapi',
-  #     :password => 'SuperSecureP@ssw0rd',
-  #     :insecure => true
-  #   },
-  #   :machine_options => { 
-  #     :start_timeout => 600, 
- #            :create_timeout => 600,       
- #            :bootstrap_options => {
-  #       :datacenter => 'QA1',
-  #       :template_name => 'UBUNTU-12-64-TEMPLATE',
-  #       :vm_folder => 'DLAB',
-  #       :num_cpus => 2,
-  #       :network_name => 'vlan152_172.21.152',
-  #       :memory_mb => 4096,
-  #       :resource_pool => 'CLSTR02/DLAB',
-  #       :ssh => {
-  #         :user => 'root',
-  #         :password => 'SuperSecureP@ssw0rd',
-  #         :paranoid => false,
-  #         :port => 22
-  #       },
-  #       :convergence_options => {}
-  #     }
-  #   }
-  # }
+# A file named config.rb in the same directory as this spec file
+# must exist containing the driver options to use for the test.
+# Here is an example:
+# {
+#   :driver_options => {
+#     :host => '213.45.67.88',
+#     :user => 'vmapi',
+#     :password => 'SuperSecureP@ssw0rd',
+#     :insecure => true
+#   },
+#   :machine_options => {
+#     :start_timeout => 600,
+#            :create_timeout => 600,
+#            :bootstrap_options => {
+#       :datacenter => 'QA1',
+#       :template_name => 'UBUNTU-12-64-TEMPLATE',
+#       :vm_folder => 'DLAB',
+#       :num_cpus => 2,
+#       :network_name => 'vlan152_172.21.152',
+#       :memory_mb => 4096,
+#       :resource_pool => 'CLSTR02/DLAB',
+#       :ssh => {
+#         :user => 'root',
+#         :password => 'SuperSecureP@ssw0rd',
+#         :paranoid => false,
+#         :port => 22
+#       },
+#       :convergence_options => {}
+#     }
+#   }
+# }
 
 describe 'vsphere_driver' do
   before :all do
@@ -45,7 +46,7 @@ describe 'vsphere_driver' do
       @driver = Chef::Provisioning.driver_for_url(url, @metal_config)
       action_handler = Chef::Provisioning::ActionHandler.new
       @driver.allocate_machine(action_handler, @machine_spec, @metal_config[:machine_options])
-      @metal_config[:machine_options][:convergence_options] = {:chef_server => chef_server}
+      @metal_config[:machine_options][:convergence_options] = { chef_server: chef_server }
       machine = @driver.ready_machine(action_handler, @machine_spec, @metal_config[:machine_options])
       @server_id = @machine_spec.location['server_id']
       @vsphere_helper = ChefProvisioningVsphere::VsphereHelper.new(
@@ -57,7 +58,6 @@ describe 'vsphere_driver' do
   end
 
   context 'when allocating a machine' do
-
     it 'adds machine to the correct folder' do
       expect(@vm.parent.name).to eq(@metal_config[:machine_options][:bootstrap_options][:vm_folder])
     end
@@ -65,13 +65,13 @@ describe 'vsphere_driver' do
       expect(@vm.config.instanceUuid).to eq(@machine_spec.location['server_id'])
     end
     it 'has the correct name' do
-          now = Time.now.utc
-          trimmed_name = @vm.config.guestId.start_with?('win') ? @vm_name.byteslice(0,15) : @vm_name
-          expected_name="#{trimmed_name}.#{@metal_config[:machine_options][:bootstrap_options][:customization_spec][:domain]}"
-          until (Time.now.utc - now) > 30 || (@vm.guest.hostName == expected_name) do
-            print '.'
-            sleep 5
-          end
+      now = Time.now.utc
+      trimmed_name = @vm.config.guestId.start_with?('win') ? @vm_name.byteslice(0, 15) : @vm_name
+      expected_name = "#{trimmed_name}.#{@metal_config[:machine_options][:bootstrap_options][:customization_spec][:domain]}"
+      until (Time.now.utc - now) > 30 || (@vm.guest.hostName == expected_name)
+        print '.'
+        sleep 5
+      end
       expect(@vm.guest.hostName).to eq(expected_name)
     end
     it 'has the correct number of CPUs' do
@@ -81,24 +81,24 @@ describe 'vsphere_driver' do
       expect(@vm.config.hardware.memoryMB).to eq(@metal_config[:machine_options][:bootstrap_options][:memory_mb])
     end
     it 'is on the correct networks' do
-      expect(@vm.network.map {|n| n.name}).to include(@metal_config[:machine_options][:bootstrap_options][:network_name][0])
-      expect(@vm.network.map {|n| n.name}).to include(@metal_config[:machine_options][:bootstrap_options][:network_name][1])
+      expect(@vm.network.map(&:name)).to include(@metal_config[:machine_options][:bootstrap_options][:network_name][0])
+      expect(@vm.network.map(&:name)).to include(@metal_config[:machine_options][:bootstrap_options][:network_name][1])
     end
     it 'is on the correct datastore' do
       expect(@vm.datastore[0].name).to eq(@metal_config[:machine_options][:bootstrap_options][:datastore])
     end
     it 'is in the correct resource pool' do
-      if @metal_config[:machine_options][:bootstrap_options].has_key?(:resource_pool)
+      if @metal_config[:machine_options][:bootstrap_options].key?(:resource_pool)
         expect(@vm.resourcePool.name).to eq(@metal_config[:machine_options][:bootstrap_options][:resource_pool].split('/')[1])
       end
     end
     it 'is in the correct host' do
-      if @metal_config[:machine_options][:bootstrap_options].has_key?(:host)
+      if @metal_config[:machine_options][:bootstrap_options].key?(:host)
         expect(@vm.runtime.host.name).to eq(@metal_config[:machine_options][:bootstrap_options][:host].split('/').last)
       end
     end
     it 'is in the correct cluster' do
-      if @metal_config[:machine_options][:bootstrap_options].has_key?(:resource_pool)
+      if @metal_config[:machine_options][:bootstrap_options].key?(:resource_pool)
         expect(@vm.resourcePool.owner.name).to eq(@metal_config[:machine_options][:bootstrap_options][:resource_pool].split('/')[0])
       end
     end
@@ -107,7 +107,7 @@ describe 'vsphere_driver' do
     end
     it 'has an added disk of the correct size' do
       disk_count = @vm.disks.count
-      expect(@vm.disks[disk_count-1].capacityInKB).to eq(@metal_config[:machine_options][:bootstrap_options][:additional_disk_size_gb][1] * 1024 * 1024)
+      expect(@vm.disks[disk_count - 1].capacityInKB).to eq(@metal_config[:machine_options][:bootstrap_options][:additional_disk_size_gb][1] * 1024 * 1024)
     end
     it 'has the correct number of disks' do
       expect(@vm.disks.count).to eq(3)
@@ -120,19 +120,18 @@ describe 'vsphere_driver' do
     end
     it 'has hot add memory enabled' do
       expect(@vm.config.memoryHotAddEnabled).to eq(true)
-    end   
+    end
     it 'has the correct IP address' do
       now = Time.now.utc
-      until (Time.now.utc - now) > 30 || (@vm.guest.toolsRunningStatus == 'guestToolsRunning' && @vm.guest.net.count == 2 && @vm.guest.net[1].ipAddress[1] == @metal_config[:machine_options][:bootstrap_options][:customization_spec][:ipsettings][:ip]) do
+      until (Time.now.utc - now) > 30 || (@vm.guest.toolsRunningStatus == 'guestToolsRunning' && @vm.guest.net.count == 2 && @vm.guest.net[1].ipAddress[1] == @metal_config[:machine_options][:bootstrap_options][:customization_spec][:ipsettings][:ip])
         print '.'
         sleep 5
       end
-      expect(@vm.guest.net.map { |net| net.ipAddress}.flatten).to include(@metal_config[:machine_options][:bootstrap_options][:customization_spec][:ipsettings][:ip])
+      expect(@vm.guest.net.map(&:ipAddress).flatten).to include(@metal_config[:machine_options][:bootstrap_options][:customization_spec][:ipsettings][:ip])
     end
   end
 
   context 'destroy_machine' do
-
     it 'removes the machine' do
       Cheffish.honor_local_mode do
         chef_server = Cheffish.default_chef_server
@@ -140,7 +139,7 @@ describe 'vsphere_driver' do
         driver = Chef::Provisioning.driver_for_url(url, @metal_config)
         action_handler = Chef::Provisioning::ActionHandler.new
         machine_spec = Chef::Provisioning.chef_managed_entry_store(chef_server)
-          .new_entry(:machine, @vm_name)
+                                         .new_entry(:machine, @vm_name)
         machine_spec.location = {
           'driver_url' => driver.driver_url,
           'server_id' => @server_id

data/spec/unit_tests/VsphereDriver_spec.rb

@@ -1,132 +1,133 @@
-require 'chef/provisioning/vsphere_driver'
-
-describe ChefProvisioningVsphere::VsphereDriver do
-  subject do
-    Chef::Provisioning.driver_for_url(
-      'vsphere://3.3.3.3:999/crazyapi?use_ssl=false&insecure=true',
-      metal_config
-    )
-  end
-
-  context "when config does not include the properties included in the url" do
-    let(:metal_config) do
-      {
-        :driver_options => {
-          :user => 'vmapi',
-          :password => '<password>'
-        },
-        :machine_options => { 
-          :ssh => {
-            :password => '<password>',
-            :paranoid => false
-          },
-          :bootstrap_options => {
-            :datacenter => 'QA1',
-            :template_name => 'UBUNTU-12-64-TEMPLATE',
-            :vm_folder => 'DLAB',
-            :num_cpus => 2,
-            :memory_mb => 4096,
-            :resource_pool => 'CLSTR02/DLAB'
-          }
-        },
-        :log_level => :debug
-      }
-    end
-
-    it "populates the connect options with correct host from the driver url" do
-      expect(subject.connect_options[:host]).to eq('3.3.3.3')
-    end
-    it "populates the connect options with correct port from the driver url" do
-      expect(subject.connect_options[:port]).to eq(999)
-    end
-    it "populates the connect options with correct path from the driver url" do
-      expect(subject.connect_options[:path]).to eq('/crazyapi')
-    end
-    it "populates the connect options with correct use_ssl setting from the driver url" do
-      expect(subject.connect_options[:use_ssl]).to eq(false)
-    end
-    it "populates the connect options with correct insecure setting from the driver url" do
-      expect(subject.connect_options[:insecure]).to eq(true)
-    end
-  end
-
-  context "when config keys are stringified" do
-    let(:metal_config) do
-      {
-        'driver_options' => {
-          'user' => 'vmapi',
-          'password' => '<driver_password>'
-        },
-        'bootstrap_options' => {
-          'machine_options' => {
-            'datacenter' => 'QA1',
-            'ssh' => {
-              'password' => '<machine_password>'
-            }
-          }
-        }
-      }
-    end
-
-    it "will symbolize user" do
-      expect(subject.connect_options[:user]).to eq('vmapi')
-    end
-    it "will symbolize password" do
-      expect(subject.connect_options[:password]).to eq('<driver_password>')
-    end
-    it "will symbolize ssh password" do
-      expect(subject.config[:bootstrap_options][:machine_options][:ssh][:password]).to eq('<machine_password>')
-    end
-    it "will symbolize ssh bootstrap options" do
-      expect(subject.config[:bootstrap_options][:machine_options][:datacenter]).to eq('QA1')
-    end
-  end
-
-  describe 'canonicalize_url' do
-    context "when no url is in the config" do
-      let(:metal_config) do
-        {
-          :user => 'vmapi',
-          :password => '<password>',
-          :host => '4.4.4.4',
-          :port => 888,
-          :path => '/yoda',
-          :use_ssl => false,
-          :insecure => true
-        }
-      end
-
-      subject do
-        ChefProvisioningVsphere::VsphereDriver.canonicalize_url(
-          nil, 
-          metal_config
-        )
-      end
-
-      it "creates the correct driver url from config settings" do
-        expect(subject[0]).to eq('vsphere://4.4.4.4:888/yoda?use_ssl=false&insecure=true')
-      end
-    end
-
-    context "when no url is in the config and config is missing defaulted values" do
-      let(:metal_config) do
-        {
-          :user => 'vmapi',
-          :password => '<password>',
-          :host => '4.4.4.4'
-        }
-      end
-
-      subject do
-        ChefProvisioningVsphere::VsphereDriver.canonicalize_url(
-          nil,
-          metal_config
-        )
-      end
-
-      it "creates the correct driver url from default settings" do
-        expect(subject[0]).to eq('vsphere://4.4.4.4/sdk?use_ssl=true&insecure=false')
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+require 'chef/provisioning/vsphere_driver'
+
+describe ChefProvisioningVsphere::VsphereDriver do
+  subject do
+    Chef::Provisioning.driver_for_url(
+      'vsphere://3.3.3.3:999/crazyapi?use_ssl=false&insecure=true',
+      metal_config
+    )
+  end
+
+  context 'when config does not include the properties included in the url' do
+    let(:metal_config) do
+      {
+        driver_options: {
+          user: 'vmapi',
+          password: '<password>'
+        },
+        machine_options: {
+          ssh: {
+            password: '<password>',
+            paranoid: false
+          },
+          bootstrap_options: {
+            datacenter: 'QA1',
+            template_name: 'UBUNTU-12-64-TEMPLATE',
+            vm_folder: 'DLAB',
+            num_cpus: 2,
+            memory_mb: 4096,
+            resource_pool: 'CLSTR02/DLAB'
+          }
+        },
+        log_level: :debug
+      }
+    end
+
+    it 'populates the connect options with correct host from the driver url' do
+      expect(subject.connect_options[:host]).to eq('3.3.3.3')
+    end
+    it 'populates the connect options with correct port from the driver url' do
+      expect(subject.connect_options[:port]).to eq(999)
+    end
+    it 'populates the connect options with correct path from the driver url' do
+      expect(subject.connect_options[:path]).to eq('/crazyapi')
+    end
+    it 'populates the connect options with correct use_ssl setting from the driver url' do
+      expect(subject.connect_options[:use_ssl]).to eq(false)
+    end
+    it 'populates the connect options with correct insecure setting from the driver url' do
+      expect(subject.connect_options[:insecure]).to eq(true)
+    end
+  end
+
+  context 'when config keys are stringified' do
+    let(:metal_config) do
+      {
+        'driver_options' => {
+          'user' => 'vmapi',
+          'password' => '<driver_password>'
+        },
+        'bootstrap_options' => {
+          'machine_options' => {
+            'datacenter' => 'QA1',
+            'ssh' => {
+              'password' => '<machine_password>'
+            }
+          }
+        }
+      }
+    end
+
+    it 'will symbolize user' do
+      expect(subject.connect_options[:user]).to eq('vmapi')
+    end
+    it 'will symbolize password' do
+      expect(subject.connect_options[:password]).to eq('<driver_password>')
+    end
+    it 'will symbolize ssh password' do
+      expect(subject.config[:bootstrap_options][:machine_options][:ssh][:password]).to eq('<machine_password>')
+    end
+    it 'will symbolize ssh bootstrap options' do
+      expect(subject.config[:bootstrap_options][:machine_options][:datacenter]).to eq('QA1')
+    end
+  end
+
+  describe 'canonicalize_url' do
+    context 'when no url is in the config' do
+      let(:metal_config) do
+        {
+          user: 'vmapi',
+          password: '<password>',
+          host: '4.4.4.4',
+          port: 888,
+          path: '/yoda',
+          use_ssl: false,
+          insecure: true
+        }
+      end
+
+      subject do
+        ChefProvisioningVsphere::VsphereDriver.canonicalize_url(
+          nil,
+          metal_config
+        )
+      end
+
+      it 'creates the correct driver url from config settings' do
+        expect(subject[0]).to eq('vsphere://4.4.4.4:888/yoda?use_ssl=false&insecure=true')
+      end
+    end
+
+    context 'when no url is in the config and config is missing defaulted values' do
+      let(:metal_config) do
+        {
+          user: 'vmapi',
+          password: '<password>',
+          host: '4.4.4.4'
+        }
+      end
+
+      subject do
+        ChefProvisioningVsphere::VsphereDriver.canonicalize_url(
+          nil,
+          metal_config
+        )
+      end
+
+      it 'creates the correct driver url from default settings' do
+        expect(subject[0]).to eq('vsphere://4.4.4.4/sdk?use_ssl=true&insecure=false')
+      end
+    end
+  end
+end