kitchen-vra 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f16b036a56b3f13f8def98498eb1a101c1feb02d
+  data.tar.gz: fabcc430c9d91f4720625af34eef073c295c49d1
+SHA512:
+  metadata.gz: 5bf076a6e0b2f56330977dbb00267d311a382178b89085ad94e2133bcbc7229b4eb500f2669f7e2d7ea559bf17f3fa23fe92565bb56d31522320e5e22790e861
+  data.tar.gz: a6bbb96508c893bc1a022f3141d252a5abe40a54aa9b82abd37f147ff0143e37522abc478a04404fee4ada7bcd0b9cfdc163c5525c3c815927bab63542b340df

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rubocop.yml

@@ -0,0 +1,14 @@
+Metrics/AbcSize:
+  Max: 50
+Metrics/ClassLength:
+  Max: 125
+Metrics/LineLength:
+  Max: 130
+Metrics/MethodLength:
+  Max: 25
+Style/Documentation:
+  Enabled: false
+Style/SignalException:
+  Enabled: false
+Style/SpaceInsideBrackets:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,201 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following
+boilerplate notice, with the fields enclosed by brackets "{}"
+replaced with your own identifying information. (Don't include
+the brackets!)  The text should be enclosed in the appropriate
+comment syntax for the file format. We also recommend that a
+file or class name and description of purpose be included on the
+same "printed page" as the copyright notice for easier
+identification within third-party archives.
+
+Copyright {yyyy} {name of copyright owner}
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,106 @@
+# kitchen-vra
+
+A driver to allow Test Kitchen to consume vRealize Automation (vRA) resources to perform testing.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kitchen-vra'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kitchen-vra
+
+Or even better, install it via ChefDK:
+
+    $ chef gem install kitchen-vra
+
+## Usage
+
+After installing the gem as described above, edit your .kitchen.yml file to set the driver to 'vra' and supply your login credentials:
+
+```yaml
+driver:
+  name: vra
+  username: myuser@corp.local
+  password: mypassword
+  tenant: mytenant
+  base_url: https://vra.corp.local
+  verify_ssl: true
+```
+
+Then configure your platforms. A catalog_id is required for each platform:
+
+```yaml
+platforms:
+  - name: centos6
+    driver:
+      catalog_id: e9db1084-d1c6-4c1f-8e3c-eb8f3dc574f9
+  - name: centos7
+    driver:
+      catalog_id: c4211950-ab07-42b1-ba80-8f5d3f2c8251
+```
+
+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.
+ * **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).
+
+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:
+
+```yaml
+driver:
+  name: vra
+  cpus: 1
+
+platforms:
+  - name: small
+    driver:
+      catalog_id: 8a189191-fea6-43eb-981e-ee0fa40f8f57
+  - name: large
+    driver:
+      catalog_id: 1d7c6122-18fa-4ed6-bd13-8a33b6c6ed50
+      cpus: 2
+```
+
+## License and Authors
+
+Author:: Chef Partner Engineering (<partnereng@chef.io>)
+
+Copyright:: Copyright (c) 2015 Chef Software, Inc.
+
+License:: Apache License, Version 2.0
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+this file except in compliance with the License. You may obtain a copy of the License at
+
+```
+http://www.apache.org/licenses/LICENSE-2.0
+```
+
+Unless required by applicable law or agreed to in writing, software distributed under the
+License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+either express or implied. See the License for the specific language governing permissions
+and limitations under the License.
+
+## Contributing
+
+We'd love to hear from you if this doesn't work in your vRA environment. Please log a GitHub issue, or even better, submit a Pull Request with a fix!
+
+1. Fork it ( https://github.com/chef-partners/kitchen-vra/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/kitchen-vra.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kitchen/driver/vra_version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'kitchen-vra'
+  spec.version       = Kitchen::Driver::VRA_VERSION
+  spec.authors       = ['Chef Partner Engineering']
+  spec.email         = ['partnereng@chef.io']
+  spec.summary       = 'A Test Kitchen driver for VMware vRealize Automation (vRA)'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/chef-partners/kitchen-vra'
+  spec.license       = 'Apache 2.0'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = []
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'test-kitchen', '~> 1.4', '>= 1.4.1'
+  spec.add_dependency 'vmware-vra',   '~> 1.0'
+
+  spec.add_development_dependency 'bundler',   '~> 1.7'
+  spec.add_development_dependency 'rake',      '~> 10.0'
+  spec.add_development_dependency 'rspec',     '~> 3.2'
+  spec.add_development_dependency 'simplecov', '~> 0.10'
+  spec.add_development_dependency 'webmock',   '~> 1.21'
+end

data/lib/kitchen/driver/vra.rb

@@ -0,0 +1,170 @@
+#
+# Author:: Chef Partner Engineering (<partnereng@chef.io>)
+# Copyright:: Copyright (c) 2015 Chef Software, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'kitchen'
+require 'vra'
+require_relative 'vra_version'
+
+module Kitchen
+  module Driver
+    class Vra < Kitchen::Driver::Base
+      kitchen_driver_api_version 2
+      plugin_version Kitchen::Driver::VRA_VERSION
+
+      required_config :username
+      required_config :password
+      required_config :base_url
+      required_config :tenant
+      required_config :catalog_id
+
+      default_config :subtenant, nil
+      default_config :verify_ssl, true
+      default_config :request_timeout, 600
+      default_config :request_refresh_rate, 2
+      default_config :cpus, 1
+      default_config :memory, 1024
+      default_config :requested_for do |driver|
+        driver[:username]
+      end
+      default_config :lease_days, nil
+      default_config :notes, nil
+      default_config :extra_parameters, {}
+      default_config :private_key_path do
+        %w(id_rsa id_dsa).map do |key|
+          file = File.expand_path("~/.ssh/#{key}")
+          file if File.exist?(file)
+        end.compact.first
+      end
+
+      def name
+        'vRA'
+      end
+
+      def create(state)
+        return if state[:resource_id]
+
+        server = request_server
+        state[:resource_id] = server.id
+
+        ip_address = server.ip_addresses.first
+        raise 'No IP address returned for the vRA request' if ip_address.nil?
+        state[:hostname] = server.ip_addresses.first
+        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 request_server
+        info('Building vRA catalog request...')
+        submitted_request = catalog_request.submit
+        info("Catalog request #{submitted_request.id} submitted.")
+
+        wait_for_request(submitted_request)
+        raise "The vRA request failed: #{submitted_request.completion_details}" if submitted_request.failed?
+
+        servers = submitted_request.resources.select(&:vm?)
+        raise 'The vRA request created more than one server. The catalog blueprint should only return one.' if servers.size > 1
+        raise 'the vRA request did not create any servers.' if servers.size == 0
+
+        servers.first
+      end
+
+      def wait_for_server(state, server)
+        info("Server #{server.id} (#{server.name}) created. Waiting until ready...")
+        begin
+          instance.transport.connection(state).wait_until_ready
+        rescue
+          error("Server #{server.id} (#{server.name}) not reachable. Destroying server...")
+          destroy(state)
+          raise
+        end
+      end
+
+      def destroy(state)
+        return if state[:resource_id].nil?
+
+        begin
+          server = vra_client.resources.by_id(state[:resource_id])
+        rescue ::Vra::Exception::NotFound
+          warn("No server found with ID #{state[:resource_id]}, assuming it has been destroyed already.")
+          return
+        end
+
+        begin
+          destroy_request = server.destroy
+        rescue ::Vra::Exception::NotFound
+          info('Server not found, or no destroy action available, perhaps because it is already destroyed.')
+          return
+        end
+        info("Destroy request #{destroy_request.id} submitted.")
+        wait_for_request(destroy_request)
+        info('Destroy request complete.')
+      end
+
+      def catalog_request
+        catalog_request = vra_client.catalog.request(config[:catalog_id])
+
+        catalog_request.cpus          = config[:cpus]
+        catalog_request.memory        = config[:memory]
+        catalog_request.requested_for = config[:requested_for]
+        catalog_request.lease_days    = config[:lease_days]    unless config[:lease_days].nil?
+        catalog_request.notes         = config[:notes]         unless config[:notes].nil?
+        catalog_request.subtenant_id  = config[:subtenant_id]  unless config[:subtenant_id].nil?
+
+        config[:extra_parameters].each do |key, value_data|
+          catalog_request.set_parameter(key, value_data[:type], value_data[:value])
+        end
+
+        catalog_request
+      end
+
+      def vra_client
+        @client ||= ::Vra::Client.new(
+          base_url:   config[:base_url],
+          username:   config[:username],
+          password:   config[:password],
+          tenant:     config[:tenant],
+          verify_ssl: config[:verify_ssl]
+        )
+      end
+
+      def wait_for_request(request)
+        last_status = ''
+        wait_time   = config[:request_timeout]
+        sleep_time  = config[:request_refresh_rate]
+        Timeout.timeout(wait_time) do
+          loop do
+            request.refresh
+            break if request.completed?
+
+            unless last_status == request.status
+              last_status = request.status
+              info("Current request status: #{request.status}")
+            end
+
+            sleep sleep_time
+          end
+        end
+      rescue Timeout::Error
+        error("Request did not complete in #{wait_time} seconds. Check the Requests tab in the vRA UI for more information.")
+        raise
+      end
+    end
+  end
+end

data/lib/kitchen/driver/vra_version.rb

@@ -0,0 +1,23 @@
+#
+# Author:: Chef Partner Engineering (<partnereng@chef.io>)
+# Copyright:: Copyright (c) 2015 Chef Software, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Kitchen
+  module Driver
+    VRA_VERSION = '1.0.0'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+#
+# Author:: Chef Partner Engineering (<partnereng@chef.io>)
+# Copyright:: Copyright (c) 2015 Chef Software, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'webmock/rspec'
+
+WebMock.disable_net_connect!(allow_localhost: true)
+
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.profiles.define 'gem' do
+    command_name 'Specs'
+  end
+  SimpleCov.start 'gem'
+end

data/spec/vra_spec.rb

@@ -0,0 +1,417 @@
+#
+# Author:: Chef Partner Engineering (<partnereng@chef.io>)
+# Copyright:: Copyright (c) 2015 Chef Software, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'spec_helper'
+require 'kitchen/driver/vra'
+require 'kitchen/provisioner/dummy'
+require 'kitchen/transport/dummy'
+require 'kitchen/verifier/dummy'
+
+describe Kitchen::Driver::Vra do
+  let(:logged_output) { StringIO.new }
+  let(:logger)        { Logger.new(logged_output) }
+  let(:platform)      { Kitchen::Platform.new(name: 'fake_platform') }
+  let(:transport)     { Kitchen::Transport::Dummy.new }
+  let(:driver)        { Kitchen::Driver::Vra.new(config) }
+
+  let(:config) do
+    {
+      base_url:      'https://vra.corp.local',
+      username:      'myuser',
+      password:      'mypassword',
+      tenant:        'mytenant',
+      verify_ssl:    true,
+      cpus:          2,
+      memory:        2048,
+      requested_for: 'override_user@corp.local',
+      notes:         'some notes',
+      subtenant_id:  '160b473a-0ec9-473d-8156-28dd96c0b6b7',
+      lease_days:    5
+    }
+  end
+
+  let(:instance) do
+    instance_double(Kitchen::Instance,
+                    logger:    logger,
+                    transport: transport,
+                    platform:  platform,
+                    to_str:    'instance_str'
+                   )
+  end
+
+  before do
+    allow(driver).to receive(:instance).and_return(instance)
+  end
+
+  it 'driver API version is 2' do
+    expect(driver.diagnose_plugin[:api_version]).to eq(2)
+  end
+
+  describe '#name' do
+    it 'has an overridden name' do
+      expect(driver.name).to eq('vRA')
+    end
+  end
+
+  describe '#create' do
+    context 'when the server is already created' do
+      let(:state) { { resource_id: '48959518-6a0d-46e1-8415-3749696b65f4' } }
+
+      it 'does not submit a catalog request' do
+        expect(driver).not_to receive(:request_server)
+        driver.create(state)
+      end
+    end
+
+    let(:state) { {} }
+    let(:resource) do
+      double('server1',
+             id: 'e8706351-cf4c-4c12-acb7-c90cc683b22c',
+             name: 'server1',
+             ip_addresses: [ '1.2.3.4' ],
+             vm?: true)
+    end
+
+    before do
+      allow(driver).to receive(:request_server).and_return(resource)
+      allow(driver).to receive(:wait_for_server)
+    end
+
+    it 'requests the server' do
+      expect(driver).to receive(:request_server).and_return(resource)
+      driver.create(state)
+    end
+
+    it 'sets the server ID in the state hash' do
+      driver.create(state)
+      expect(state[:resource_id]).to eq('e8706351-cf4c-4c12-acb7-c90cc683b22c')
+    end
+
+    describe 'getting the IP address from the server' do
+      context 'when no IP addresses are returned' do
+        it 'raises an exception' do
+          allow(resource).to receive(:ip_addresses).and_return([])
+          expect { driver.create(state) }.to raise_error(RuntimeError)
+        end
+      end
+
+      context 'when IP addresses are returned' do
+        it 'sets the IP address as the hostname in the state hash' do
+          driver.create(state)
+          expect(state[:hostname]).to eq('1.2.3.4')
+        end
+      end
+    end
+
+    it 'waits for the server to be ready' do
+      expect(driver).to receive(:wait_for_server)
+      driver.create(state)
+    end
+  end
+
+  describe '#request_server' do
+    let(:submitted_request) { double('submitted_request') }
+    let(:catalog_request)   { double('catalog_request') }
+    let(:resource1) do
+      double('server1',
+             id: 'e8706351-cf4c-4c12-acb7-c90cc683b22c',
+             name: 'server1',
+             ip_addresses: [ '1.2.3.4' ],
+             vm?: true)
+    end
+    let(:resource2) do
+      double('server2',
+             id: '9e2364cf-7af4-4b85-93fd-1f03ee2ac865',
+             name: 'server2',
+             ip_addresses: [ '4.3.2.1' ],
+             vm?: true)
+    end
+    let(:resources) { [resource1] }
+
+    before do
+      allow(driver).to receive(:catalog_request).and_return(catalog_request)
+      allow(catalog_request).to receive(:submit).and_return(submitted_request)
+      allow(submitted_request).to receive(:id).and_return('74e26af9-2d2f-4889-a472-95dbcedb70b8')
+      allow(submitted_request).to receive(:resources).and_return(resources)
+      allow(submitted_request).to receive(:failed?).and_return(false)
+      allow(driver).to receive(:wait_for_request).with(submitted_request)
+    end
+
+    it 'submits a catalog request' do
+      expect(driver.catalog_request).to receive(:submit).and_return(submitted_request)
+      driver.request_server
+    end
+
+    it 'waits for the request to complete' do
+      expect(driver).to receive(:wait_for_request).with(submitted_request)
+      driver.request_server
+    end
+
+    it 'raises an exception if the request failed' do
+      allow(submitted_request).to receive(:failed?).and_return(true)
+      allow(submitted_request).to receive(:completion_details).and_return('it failed')
+      expect { driver.request_server }.to raise_error(RuntimeError)
+    end
+
+    describe 'getting the server from the request' do
+      context 'when only one server is returned' do
+        it 'does not raise an exception' do
+          expect { driver.request_server }.not_to raise_error
+        end
+      end
+
+      context 'when multiple servers are returned' do
+        it 'raises an exception' do
+          allow(submitted_request).to receive(:resources).and_return([ resource1, resource2 ])
+          expect { driver.request_server }.to raise_error(RuntimeError)
+        end
+      end
+
+      context 'when no servers are returned' do
+        it 'raises an exception' do
+          allow(submitted_request).to receive(:resources).and_return([])
+          expect { driver.request_server }.to raise_error(RuntimeError)
+        end
+      end
+    end
+
+    it 'returns the the single server resource object' do
+      expect(driver.request_server).to eq(resource1)
+    end
+  end
+
+  describe '#wait_for_server_to_be_ready' do
+    let(:connection) { instance.transport.connection(state) }
+    let(:state)      { {} }
+    let(:resource1) do
+      double('server1',
+             id: 'e8706351-cf4c-4c12-acb7-c90cc683b22c',
+             name: 'server1',
+             ip_addresses: [ '1.2.3.4' ],
+             vm?: true)
+    end
+
+    before do
+      allow(transport).to receive(:connection).and_return(connection)
+    end
+
+    it 'waits for the server to be ready' do
+      expect(connection).to receive(:wait_until_ready)
+      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)
+    end
+  end
+
+  describe '#destroy' do
+    let(:resource_id)     { '8c1a833a-5844-4100-b58c-9cab3543c958' }
+    let(:state)           { { resource_id: resource_id } }
+    let(:vra_client)      { double('vra_client') }
+    let(:resources)       { double('resources') }
+    let(:destroy_request) { double('destroy_request') }
+    let(:resource) do
+      double('server1',
+             id: resource_id,
+             name: 'server1',
+             ip_addresses: [ '5.6.7.8' ],
+             vm?: true)
+    end
+
+    before do
+      allow(driver).to receive(:vra_client).and_return(vra_client)
+      allow(driver).to receive(:wait_for_request).with(destroy_request)
+      allow(vra_client).to receive(:resources).and_return(resources)
+      allow(resources).to receive(:by_id).and_return(resource)
+      allow(resource).to receive(:destroy).and_return(destroy_request)
+      allow(destroy_request).to receive(:id).and_return('6da65982-7c33-4e6e-b346-fdf4bcbf01ab')
+    end
+
+    context 'when the resource is not created' do
+      let(:state) { {} }
+      it 'does not look up the resource if no resource ID exists' do
+        expect(vra_client.resources).not_to receive(:by_id)
+        driver.destroy(state)
+      end
+    end
+
+    it 'looks up the resource record' do
+      expect(vra_client.resources).to receive(:by_id).with(resource_id).and_return(resource)
+      driver.destroy(state)
+    end
+
+    context 'when the resource record cannot be found' do
+      it 'does not raise an exception' do
+        allow(vra_client.resources).to receive(:by_id).with(resource_id).and_raise(Vra::Exception::NotFound)
+        expect { driver.destroy(state) }.not_to raise_error
+      end
+    end
+
+    describe 'creating the destroy request' do
+      context 'when the destroy method or server is not found' do
+        it 'does not raise an exception' do
+          allow(resource).to receive(:destroy).and_raise(Vra::Exception::NotFound)
+          expect { driver.destroy(state) }.not_to raise_error
+        end
+      end
+
+      it 'calls #destroy on the server' do
+        expect(resource).to receive(:destroy).and_return(destroy_request)
+        driver.destroy(state)
+      end
+    end
+
+    it 'waits for the destroy request to succeed' do
+      expect(driver).to receive(:wait_for_request).with(destroy_request)
+      driver.destroy(state)
+    end
+  end
+
+  describe '#catalog_request' do
+    let(:catalog_request) { double('catalog_request') }
+    let(:vra_client)      { double('vra_client') }
+    let(:catalog)         { double('catalog') }
+    before do
+      allow(driver).to receive(:vra_client).and_return(vra_client)
+      allow(vra_client).to receive(:catalog).and_return(catalog)
+      allow(catalog).to receive(:request).and_return(catalog_request)
+      [ :cpus=, :memory=, :requested_for=, :lease_days=, :notes=, :subtenant_id=, :set_parameter ].each do |method|
+        allow(catalog_request).to receive(method)
+      end
+    end
+
+    it 'creates a catalog_request' do
+      expect(vra_client.catalog).to receive(:request).and_return(catalog_request)
+      driver.catalog_request
+    end
+
+    it 'sets all the standard parameters on the request' do
+      expect(catalog_request).to receive(:cpus=).with(config[:cpus])
+      expect(catalog_request).to receive(:memory=).with(config[:memory])
+      expect(catalog_request).to receive(:requested_for=).with(config[:requested_for])
+      expect(catalog_request).to receive(:lease_days=).with(config[:lease_days])
+      expect(catalog_request).to receive(:notes=).with(config[:notes])
+      expect(catalog_request).to receive(:subtenant_id=).with(config[:subtenant_id])
+      driver.catalog_request
+    end
+
+    context 'when option parameters are not supplied' do
+      let(:config) do
+        {
+          base_url:      'https://vra.corp.local',
+          username:      'myuser',
+          password:      'mypassword',
+          tenant:        'mytenant',
+          verify_ssl:    true,
+          cpus:          2,
+          memory:        2048,
+          requested_for: 'override_user@corp.local'
+        }
+      end
+
+      it 'does not attempt to set params on the catalog_request' do
+        expect(catalog_request).not_to receive(:lease_days=)
+        expect(catalog_request).not_to receive(:notes=)
+        expect(catalog_request).not_to receive(:subtenant_id=)
+        driver.catalog_request
+      end
+    end
+
+    context 'when extra parameters are set' do
+      let(:config) do
+        {
+          base_url:      'https://vra.corp.local',
+          username:      'myuser',
+          password:      'mypassword',
+          tenant:        'mytenant',
+          verify_ssl:    true,
+          cpus:          2,
+          memory:        2048,
+          extra_parameters: { 'key1' => { type: 'string', value: 'value1' },
+                              'key2' => { type: 'integer', value: 123 }
+                            }
+        }
+      end
+
+      it 'sets extra parmeters' do
+        expect(catalog_request).to receive(:set_parameter).with('key1', 'string', 'value1')
+        expect(catalog_request).to receive(:set_parameter).with('key2', 'integer', 123)
+        driver.catalog_request
+      end
+    end
+  end
+
+  describe '#vra_client' do
+    it 'sets up a client object' do
+      expect(Vra::Client).to receive(:new).with(base_url:   config[:base_url],
+                                                username:   config[:username],
+                                                password:   config[:password],
+                                                tenant:     config[:tenant],
+                                                verify_ssl: config[:verify_ssl])
+      driver.vra_client
+    end
+  end
+
+  describe '#wait_for_request' do
+    before do
+      # don't actually sleep
+      allow(driver).to receive(:sleep)
+    end
+
+    context 'when the requests completes normally, 3 loops' do
+      it 'only refreshes the request 3 times' do
+        request = double('request')
+        allow(request).to receive(:status)
+        allow(request).to receive(:completed?).exactly(3).times.and_return(false, false, true)
+        expect(request).to receive(:refresh).exactly(3).times
+
+        driver.wait_for_request(request)
+      end
+    end
+
+    context 'when the request is completed on the first loop' do
+      it 'only refreshes the request 1 time' do
+        request = double('request')
+        allow(request).to receive(:status)
+        allow(request).to receive(:completed?).once.and_return(true)
+        expect(request).to receive(:refresh).once
+
+        driver.wait_for_request(request)
+      end
+    end
+
+    context 'when the timeout is exceeded' do
+      it 'prints a warning and exits' do
+        request = double('request')
+        allow(Timeout).to receive(:timeout).and_raise(Timeout::Error)
+        expect { driver.wait_for_request(request) }.to raise_error(Timeout::Error)
+      end
+    end
+
+    context 'when a non-timeout exception is raised' do
+      it 'raises the original exception' do
+        request = double('request')
+        allow(request).to receive(:refresh).and_raise(RuntimeError)
+        expect { driver.wait_for_request(request) }.to raise_error(RuntimeError)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: kitchen-vra
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Chef Partner Engineering
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-kitchen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+- !ruby/object:Gem::Dependency
+  name: vmware-vra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+description: A Test Kitchen driver for VMware vRealize Automation (vRA)
+email:
+- partnereng@chef.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- kitchen-vra.gemspec
+- lib/kitchen/driver/vra.rb
+- lib/kitchen/driver/vra_version.rb
+- spec/spec_helper.rb
+- spec/vra_spec.rb
+homepage: https://github.com/chef-partners/kitchen-vra
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.4
+signing_key: 
+specification_version: 4
+summary: A Test Kitchen driver for VMware vRealize Automation (vRA)
+test_files:
+- spec/spec_helper.rb
+- spec/vra_spec.rb
+has_rdoc: