kitchen-vra 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 809c8cf566e76098fd34ca3428983d631d4e4170
-  data.tar.gz: f4863346038f89134bd1d9de0c60184abfeebed5
+  metadata.gz: 5c7f119529c9a3562d45db721bf394fd9742d3a5
+  data.tar.gz: 7b2578c10fe9bfe7ed5d736c5b0ff0bd4de5cf7b
 SHA512:
-  metadata.gz: dd0290ce381d0adfda2ea38de3d34afcf346e4a28c6692a7ad0f1c29e05ea84323e454ad55d26669f4378284c19d59e4c8f83e2266596f6bba5fd9f0691a8245
-  data.tar.gz: 97e02008a31a9a84e0e109b2bc873e18abf9f4bfe791d43f9beec8f563d74ded8c263f6e46e1ff11a645adc11dd986944a84432ed3617d5589b9ec2c44f23b2e
+  metadata.gz: 073bbc3ed64031fb0e99fed859c4211362c354db494d0d21dec266f5039146c911d7fd72d33fb95dab34afaf0860ba9bd8b570ef55046077981e463fa0759dff
+  data.tar.gz: f8d23dbce4ad8a4c92b9ae42314063237c7149fce5f27c59db918a8d7046aa0baa8a0b470c956f1f87d30fe911fecd6d1b934946625ef7fd4c6b0a8516a3e235

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # kitchen-vra Changelog
 
+## v1.2.0 (2015-11-25)
+* [pr#7](https://github.com/chef-partners/kitchen-vra/pull/7) Added retry logic for wait_until_ready in cases where Test Kitchen would unwind (such as DNS issues). Added fallback logic for when a host has no IP address, complimenting the `use_dns` parameter.
+
 ## v1.1.0 (2015-10-13)
 * New `use_dns` option (defaults to false) for the driver to use the server name instead of the IP address - thanks to @stevehedrick in PR [#3](https://github.com/chef-partners/kitchen-vra/pull/3)
 

data/README.md

@@ -52,12 +52,14 @@ Other options that you can set include:
 
  * **lease_days**: number of days to request for a lease, if your catalog item / blueprint requires it
  * **request_timeout**: amount of time, in seconds, to wait for a vRA request to complete. Default is 600 seconds.
+ * **server_ready_retries**: Number of times to retry the "waiting for server to be ready" check. In some cases, this will error out immediately due to DNS propagation issues, etc. Setting this to a number greater than 0 will retry the `wait_until_ready` method with a growing sleep in between each attempt. Defaults to 1. Set to 0 to disable any retrying of the `wait_until_ready` method.
  * **cpus**: number of CPUs the host should have
  * **memory**: amount of RAM, in MB, the host should have
  * **requested_for**: the vRA login ID to list as the owner of this resource. Defaults to the vRA username configured in the `driver` section.
  * **subtenant_id**: the Business Group ID to list as the owner. This is required if the catalog item is a shared/global item; we are unable to determine the subtenant_id from the catalog, and vRA requires it to be set on every request.
- * **private_key_path**: path to the SSH private key to use when logging in. Defaults to '~/.ssh/id_rsa' or '~/.ssh/id_dsa', preferring the RSA key. Only applies to instances where SSH transport is used (i.e. does not apply to Windows hosts with the WinRM transport configured).
+ * **private_key_path**: path to the SSH private key to use when logging in. Defaults to '~/.ssh/id_rsa' or '~/.ssh/id_dsa', preferring the RSA key. Only applies to instances where SSH transport is used; i.e., does not apply to Windows hosts with the WinRM transport configured.
  * **use_dns**: Defaults to `false`.  Set to `true` if vRA doesn't manage vm ip addresses.  This will cause kitchen to attempt to connect via hostname.
+ * **extra_parameters**: a hash of other data to set on a catalog request, most notably custom properties. Allows updates to existing properties on the blueprint as well as the addition of new properties. The vRA REST API expects 'provider-' appended to the front of a property name; each key in the hash is the property name, and the value is a another hash containing the value data type and the value itself.
 
 These settings can be set globally under the top-level `driver` section, or they can be set on each platform, which allows you to set globals and then override them. For example, this configuration would set the CPU count to 1 except on the "large" platform:
 
@@ -70,10 +72,24 @@ platforms:
   - name: small
     driver:
       catalog_id: 8a189191-fea6-43eb-981e-ee0fa40f8f57
+      extra_parameters:
+        provider-mycustompropname:
+          type: string
+          value: smallvalue
+        provider-Vrm.DataCenter.Location:
+          type: string
+          value: Non-Prod
   - name: large
     driver:
       catalog_id: 1d7c6122-18fa-4ed6-bd13-8a33b6c6ed50
       cpus: 2
+      extra_parameters:
+        provider-mycustompropname:
+          type: string
+          value: largevalue
+        provider-Vrm.DataCenter.Location:
+          type: string
+          value: Prod
 ```
 
 ## License and Authors

data/lib/kitchen/driver/vra.rb

@@ -22,7 +22,7 @@ require_relative 'vra_version'
 
 module Kitchen
   module Driver
-    class Vra < Kitchen::Driver::Base
+    class Vra < Kitchen::Driver::Base # rubocop:disable Metrics/ClassLength
       kitchen_driver_api_version 2
       plugin_version Kitchen::Driver::VRA_VERSION
 
@@ -36,6 +36,7 @@ module Kitchen
       default_config :verify_ssl, true
       default_config :request_timeout, 600
       default_config :request_refresh_rate, 2
+      default_config :server_ready_retries, 1
       default_config :cpus, 1
       default_config :memory, 1024
       default_config :requested_for do |driver|
@@ -61,17 +62,26 @@ module Kitchen
 
         server = request_server
         state[:resource_id] = server.id
+        state[:hostname]    = hostname_for(server)
+        state[:ssh_key]     = config[:private_key_path] unless config[:private_key_path].nil?
+
+        wait_for_server(state, server)
+        info("Server #{server.id} (#{server.name}) ready.")
+      end
+
+      def hostname_for(server)
         if config[:use_dns]
           raise 'No server name returned for the vRA request' if server.name.nil?
-          state[:hostname] = server.name
-        else
-          raise 'No IP address returned for the vRA request' if server.ip_addresses.first.nil?
-          state[:hostname] = server.ip_addresses.first
+          return server.name
         end
-        state[:ssh_key] = config[:private_key_path] unless config[:private_key_path].nil?
 
-        wait_for_server(state, server)
-        info("Server #{server.id} (#{server.name}) ready.")
+        ip_address = server.ip_addresses.first
+        if ip_address.nil?
+          warn("Server #{server.id} has no IP address. Falling back to server name (#{server.name})...")
+          server.name
+        else
+          ip_address
+        end
       end
 
       def request_server
@@ -91,12 +101,27 @@ module Kitchen
 
       def wait_for_server(state, server)
         info("Server #{server.id} (#{server.name}) created. Waiting until ready...")
+
+        try = 0
+        sleep_time = 1
+
         begin
           instance.transport.connection(state).wait_until_ready
-        rescue
-          error("Server #{server.id} (#{server.name}) not reachable. Destroying server...")
-          destroy(state)
-          raise
+        rescue => e
+          warn("Server #{server.id} (#{server.name}) not reachable: #{e.class} -- #{e.message}")
+
+          try += 1
+          sleep_time *= 2
+
+          if try > config[:server_ready_retries]
+            error('Retries exceeded. Destroying server...')
+            destroy(state)
+            raise
+          else
+            warn("Sleeping #{sleep_time} seconds and retrying...")
+            sleep sleep_time
+            retry
+          end
         end
       end
 

data/lib/kitchen/driver/vra_version.rb

@@ -18,6 +18,6 @@
 
 module Kitchen
   module Driver
-    VRA_VERSION = '1.1.0'
+    VRA_VERSION = '1.2.0'
   end
 end

data/spec/vra_spec.rb

@@ -103,28 +103,10 @@ describe Kitchen::Driver::Vra do
       expect(state[:resource_id]).to eq('e8706351-cf4c-4c12-acb7-c90cc683b22c')
     end
 
-    describe 'setting the hostname in the state hash' do
-      context 'when use_dns is true' do
-        let(:config) { { use_dns: true } }
-        it 'raises an exception if the server name is nil' do
-          allow(resource).to receive(:name).and_return(nil)
-          expect { driver.create(state) }.to raise_error(RuntimeError)
-        end
-        it 'uses the server name as the hostname' do
-          driver.create(state)
-          expect(state[:hostname]).to eq('server1')
-        end
-      end
-      context 'when use_dns is false' do
-        it 'raises an exception if no IP address is available' do
-          allow(resource).to receive(:ip_addresses).and_return([])
-          expect { driver.create(state) }.to raise_error(RuntimeError)
-        end
-        it 'uses the IP address as the hostname' do
-          driver.create(state)
-          expect(state[:hostname]).to eq('1.2.3.4')
-        end
-      end
+    it 'sets the hostname in the state hash' do
+      allow(driver).to receive(:hostname_for).and_return('test_hostname')
+      driver.create(state)
+      expect(state[:hostname]).to eq('test_hostname')
     end
 
     it 'waits for the server to be ready' do
@@ -133,6 +115,41 @@ describe Kitchen::Driver::Vra do
     end
   end
 
+  describe '#hostname_for' do
+    let(:server) do
+      double('server',
+             id: 'test_id',
+             name: 'test_hostname',
+             ip_addresses: [ '1.2.3.4' ],
+             vm?: true)
+    end
+
+    context 'when use_dns is true' do
+      let(:config) { { use_dns: true } }
+
+      it 'raises an exception if the server name is nil' do
+        allow(server).to receive(:name).and_return(nil)
+        expect { driver.hostname_for(server) }.to raise_error(RuntimeError)
+      end
+
+      it 'returns the server name' do
+        expect(driver.hostname_for(server)).to eq('test_hostname')
+      end
+    end
+
+    context 'when use_dns is false' do
+      it 'falls back to the server name if no IP address exists' do
+        allow(server).to receive(:ip_addresses).and_return([])
+        expect(driver).to receive(:warn)
+        expect(driver.hostname_for(server)).to eq('test_hostname')
+      end
+
+      it 'returns the IP address if it exists' do
+        expect(driver.hostname_for(server)).to eq('1.2.3.4')
+      end
+    end
+  end
+
   describe '#request_server' do
     let(:submitted_request) { double('submitted_request') }
     let(:catalog_request)   { double('catalog_request') }
@@ -204,12 +221,12 @@ describe Kitchen::Driver::Vra do
     end
   end
 
-  describe '#wait_for_server_to_be_ready' do
+  describe '#wait_for_server' do
     let(:connection) { instance.transport.connection(state) }
     let(:state)      { {} }
     let(:resource1) do
       double('server1',
-             id: 'e8706351-cf4c-4c12-acb7-c90cc683b22c',
+             id: 'test_id',
              name: 'server1',
              ip_addresses: [ '1.2.3.4' ],
              vm?: true)
@@ -217,6 +234,9 @@ describe Kitchen::Driver::Vra do
 
     before do
       allow(transport).to receive(:connection).and_return(connection)
+      allow(driver).to receive(:sleep)
+      allow(driver).to receive(:warn)
+      allow(driver).to receive(:error)
     end
 
     it 'waits for the server to be ready' do
@@ -224,10 +244,59 @@ describe Kitchen::Driver::Vra do
       driver.wait_for_server(state, resource1)
     end
 
-    it 'destroys the server and raises an exception if it fails to become ready' do
-      allow(connection).to receive(:wait_until_ready).and_raise(Timeout::Error)
-      expect(driver).to receive(:destroy).with(state)
-      expect { driver.wait_for_server(state, resource1) }.to raise_error(Timeout::Error)
+    context 'when an exception is caught and retries is 0' do
+      let(:config) { { server_ready_retries: 0 } }
+
+      it 'does not sleep and raises an exception' do
+        allow(connection).to receive(:wait_until_ready).and_raise(Timeout::Error)
+        expect(driver).not_to receive(:sleep)
+        expect(driver).to receive(:error).with('Retries exceeded. Destroying server...')
+        expect { driver.wait_for_server(state, resource1) }.to raise_error(Timeout::Error)
+      end
+    end
+
+    context 'when retries is 1 and it errors out twice' do
+      let(:config) { { server_ready_retries: 1 } }
+
+      it 'displays a warning, sleeps once, retries, errors, destroys, and raises' do
+        expect(connection).to receive(:wait_until_ready).twice.and_raise(Timeout::Error)
+        expect(driver).to receive(:warn).once.with('Sleeping 2 seconds and retrying...')
+        expect(driver).to receive(:sleep).once.with(2)
+        expect(driver).to receive(:error).with('Retries exceeded. Destroying server...')
+        expect(driver).to receive(:destroy).with(state)
+        expect { driver.wait_for_server(state, resource1) }.to raise_error(Timeout::Error)
+      end
+    end
+
+    context 'when retries is 2 and it errors out all 3 times' do
+      let(:config) { { server_ready_retries: 2 } }
+
+      it 'displays 2 warnings, sleeps twice, retries, errors, destroys, and raises' do
+        expect(connection).to receive(:wait_until_ready).exactly(3).times.and_raise(Timeout::Error)
+        expect(driver).to receive(:warn).once.with('Sleeping 2 seconds and retrying...')
+        expect(driver).to receive(:warn).once.with('Sleeping 4 seconds and retrying...')
+        expect(driver).to receive(:sleep).once.with(2)
+        expect(driver).to receive(:sleep).once.with(4)
+        expect(driver).to receive(:error).with('Retries exceeded. Destroying server...')
+        expect(driver).to receive(:destroy).with(state)
+        expect { driver.wait_for_server(state, resource1) }.to raise_error(Timeout::Error)
+      end
+    end
+
+    context 'when retries is 5, it errors out the first 2 tries, but works on the 3rd' do
+      let(:config) { { server_ready_retries: 5 } }
+
+      it 'displays 2 warnings, sleeps twice, retries, but does not destroy or raise' do
+        expect(connection).to receive(:wait_until_ready).twice.and_raise(Timeout::Error)
+        expect(connection).to receive(:wait_until_ready).once.and_return(true)
+        expect(driver).to receive(:warn).once.with('Sleeping 2 seconds and retrying...')
+        expect(driver).to receive(:warn).once.with('Sleeping 4 seconds and retrying...')
+        expect(driver).to receive(:sleep).once.with(2)
+        expect(driver).to receive(:sleep).once.with(4)
+        expect(driver).not_to receive(:error)
+        expect(driver).not_to receive(:destroy)
+        expect { driver.wait_for_server(state, resource1) }.not_to raise_error
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-vra
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Chef Partner Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-13 00:00:00.000000000 Z
+date: 2015-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-kitchen