kitchen-vro 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8490c96d7b62dc70c78d8ec753584f9f15b851d4
+  data.tar.gz: 1586d1bc1fd23498c259a11384d2fcdc246f9f00
+SHA512:
+  metadata.gz: 26f14f71b98940f198a7059e124c37b5127991dd6c40585e97e9a0863274b46c243c1baabf3f560f2a9330c487dcd1f6e586845d4152b124d6bac8b7cb8bdc6d
+  data.tar.gz: 585ff5759186e6f087d91b934ae334835cfe384241252265aa254ab0b8cf49efd82cfd384ec4a82a40bdcdcee5c2506856b86ff9724b27afcdb1b9116eedefaf

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kitchen-vro.gemspec
+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,140 @@
+# kitchen-vro
+
+A driver to allow Test Kitchen to consume VMware resources provisioned by
+way of vRealize Orchestrator workflows.
+
+vRO allows you to create any workflow you can imagine, but our plugin needs
+to make some assumptions about the workflows you design in order to properly
+provision and destroy resources.  Therefore, please pay special attention to
+the **Workflow Design** section below and ensure your workflows adhere to
+these design requirements.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kitchen-vro'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kitchen-vro
+
+Or even better, install it via ChefDK:
+
+    $ chef gem install kitchen-vro
+
+## Usage
+
+After installing the gem as described above, edit your .kitchen.yml file to set the driver to 'vro' and supply your login credentials:
+
+```yaml
+driver:
+  name: vro
+  vro_username: user@domain.com
+  vro_password: MyS33kretPassword
+  vro_base_url: https://vra.corp.local:8281
+```
+
+Additionally, the following parameters are required, either globally or per-platform:
+
+ * **create_workflow_name**: The name of the vRO workflow to execute to create a server.
+ * **destroy_workflow_name**: The name of the vRO workflow to execute to destroy a server.
+
+There are a number of optional parameters you can configure as well:
+
+ * **create_workflow_id**: If your create workflow name is not unique within vRO, you can use
+   this parameter to specify the workflow unique ID.
+ * **destroy_workflow_id**: If your destroy workflow name is not unique within vRO, you can use
+   this parameter to specify the workflow unique ID.
+ * **create_workflow_parameters**: A hash of key-value pairs of parameters to pass to your
+   create workflow.
+ * **destroy_workflow_parameters**: A hash of key-value pairs of parameters to pass to your
+   destroy workflow.
+ * **request_timeout**: Number of seconds to wait for a vRO workflow to execute.  Default: 300
+ * **vro_disable_ssl_verify**: Disable SSL validation.  Default: false
+
+An example `.kitchen.yml` that uses a combination of global and per-platform
+settings might look like this:
+
+```yaml
+driver:
+  name: vro
+  vro_username: user@domain.com
+  vro_password: MyS33kretPassword
+  vro_base_url: https://vra.corp.local:8281
+  create_workflow_name: Create TK Server
+  destroy_workflow_name: Destroy TK Server
+
+platforms:
+  - name: centos
+    driver:
+      create_workflow_parameters:
+        os_name: centos
+        os_version: 6.7
+  - name: windows
+    driver:
+      create_workflow_parameters:
+        os_name: windows
+        os_version: server2012
+        cpus: 4
+        memory: 4096
+```
+
+## Workflow Design
+
+There are no limits as to what you can do with your vRO workflows!  However,
+they must meet the following requirements.
+
+### Create Workflow
+
+ * Must contain an output parameter called `ip_address` that Test Kitchen can
+   connect to in order to bootstrap and test your node.
+ * Must contain an output parameter called `server_id` that is a unique ID of
+   the server created.  Test Kitchen will provide this value to the Destroy
+   Workflow in order to request the destruction of the server once testing is
+   complete.
+ * Must end the workflow with a raised exception if the creation did not
+   succeed.  The workflow status must not be 'completed.'
+
+### Destroy Workflow
+
+ * Must contain an input parameter called `server_id` that Test Kitchen will
+   populate with the unique ID returned from the Create Workflow output.
+ * Must end the workflow with a raised exception if the creation did not
+     succeed.  The workflow status must not be 'completed.'
+
+## 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 perform in the manner you expect. Please log a GitHub issue, or even better, submit a Pull Request with a fix!
+
+1. Fork it ( https://github.com/chef-partners/kitchen-vro/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,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/kitchen-vro.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kitchen/driver/vro_version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'kitchen-vro'
+  spec.version       = Kitchen::Driver::VRO_VERSION
+  spec.authors       = ['Chef Partner Engineering']
+  spec.email         = ['partnereng@chef.io']
+  spec.summary       = 'A Test Kitchen driver for VMware vRealize Orchestrator (vRO)'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/chef-partners/kitchen-vro'
+  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 'vcoworkflows', '~> 0.2'
+
+  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 'webmock',   '~> 1.21'
+end

data/lib/kitchen/driver/vro.rb

@@ -0,0 +1,181 @@
+#
+# 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 'vcoworkflows'
+require_relative 'vro_version'
+
+module Kitchen
+  module Driver
+    class Vro < Kitchen::Driver::Base
+      attr_accessor :workflow_name, :workflow_id
+
+      kitchen_driver_api_version 2
+      plugin_version Kitchen::Driver::VRO_VERSION
+
+      required_config :vro_username
+      required_config :vro_password
+      required_config :vro_base_url
+      required_config :create_workflow_name
+      required_config :destroy_workflow_name
+
+      default_config :vro_disable_ssl_verify, false
+      default_config :create_workflow_id, nil
+      default_config :destroy_workflow_id, nil
+      default_config :create_workflow_parameters, {}
+      default_config :destroy_workflow_parameters, {}
+      default_config :request_timeout, 300
+
+      def name
+        'vRO'
+      end
+
+      def create(state)
+        return unless state[:server_id].nil?
+
+        info('Executing the create-server workflow...')
+        execute_create_workflow(state)
+
+        info("Server #{state[:hostname]} (#{state[:server_id]}) created.  Waiting for it to be ready...")
+        wait_for_server(state)
+        info("Server #{state[:hostname]} (#{state[:server_id]}) ready.")
+      end
+
+      def destroy(state)
+        return if state[:server_id].nil?
+
+        info("Executing the destroy-server workflow for #{state[:hostname]} (#{state[:server_id]})...")
+        execute_destroy_workflow(state)
+        info("Server #{state[:hostname]} (#{state[:server_id]}) destroyed.")
+      end
+
+      def vro_config
+        @vro_config ||= VcoWorkflows::Config.new(
+          url: config[:vro_base_url],
+          username: config[:vro_username],
+          password: config[:vro_password],
+          verify_ssl: verify_ssl?
+        )
+      end
+
+      def vro_client
+        @vro_client ||= VcoWorkflows::Workflow.new(
+          workflow_name,
+          id: workflow_id,
+          config: vro_config
+        )
+      end
+
+      def verify_ssl?
+        !config[:vro_disable_ssl_verify]
+      end
+
+      def set_workflow_vars(name, id)
+        @vro_client    = nil
+        @workflow_name = name
+        @workflow_id   = id
+      end
+
+      def execute_create_workflow(state)
+        set_workflow_vars(config[:create_workflow_name], config[:create_workflow_id])
+        set_workflow_parameters(config[:create_workflow_parameters])
+        execute_workflow
+        wait_for_workflow
+
+        raise 'The workflow did not complete successfully. Check the vRO UI for more info.' unless workflow_successful?
+
+        validate_create_output_parameters!
+
+        state[:server_id] = output_parameter_value('server_id')
+        state[:hostname]  = output_parameter_value('ip_address')
+      end
+
+      def execute_destroy_workflow(state)
+        set_workflow_vars(config[:destroy_workflow_name], config[:destroy_workflow_id])
+        set_workflow_parameters(config[:destroy_workflow_parameters])
+        vro_client.parameter('server_id', state[:server_id])
+        execute_workflow
+        wait_for_workflow
+
+        raise 'The workflow did not complete successfully. Check the vRO UI for more info.' unless workflow_successful?
+      end
+
+      def execute_workflow
+        vro_client.execute
+      rescue RestClient::BadRequest => e
+        error("The workflow execution request failed: #{e.response}")
+        raise
+      rescue => e
+        error("The workflow execution request failed: #{e.message}")
+        raise
+      end
+
+      def wait_for_workflow
+        wait_time = config[:request_timeout]
+        Timeout.timeout(wait_time) do
+          loop do
+            token = vro_client.token
+            break unless token.alive?
+
+            sleep 2
+          end
+        end
+      rescue Timeout::Error
+        raise Timeout::Error, "Workflow did not complete in #{wait_time} seconds. Please check the vRO UI for more information."
+      end
+
+      def wait_for_server(state)
+        instance.transport.connection(state).wait_until_ready
+      rescue
+        error("Server #{state[:hostname]} (#{state[:server_id]}) not reachable. Destroying server...")
+        destroy(state)
+        raise
+      end
+
+      def set_workflow_parameters(data) # rubocop:disable Style/AccessorMethodName
+        data.each do |key, value|
+          vro_client.parameter(key.to_s, value)
+        end
+      end
+
+      def output_parameters
+        @output_parameters ||= vro_client.token.output_parameters
+      end
+
+      def output_parameter_value(key)
+        output_parameters[key].value.to_s
+      end
+
+      def output_parameter_empty?(key)
+        output_parameter_value(key).nil? || output_parameter_value(key).empty?
+      end
+
+      def validate_create_output_parameters!
+        raise 'The workflow output did not contain a server_id and ip_address parameter.' unless
+          output_parameters.key?('server_id') && output_parameters.key?('ip_address')
+
+        raise 'The server_id parameter was empty.' if output_parameter_empty?('server_id')
+        raise 'The ip_address parameter was empty.' if output_parameter_empty?('ip_address')
+      end
+
+      def workflow_successful?
+        vro_client.token.state == 'completed'
+      end
+    end
+  end
+end

data/lib/kitchen/driver/vro_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
+    VRO_VERSION = '1.0.0'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+#
+# 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.
+#

data/spec/vro_spec.rb

@@ -0,0 +1,462 @@
+# Encoding: UTF-8
+#
+# Authors:: 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/vro'
+require 'kitchen/provisioner/dummy'
+require 'kitchen/transport/dummy'
+require 'kitchen/verifier/dummy'
+
+shared_examples 'output parameters that are missing a required key' do
+  it 'raises an exception' do
+    allow(driver).to receive(:output_parameters).and_return(output_parameters)
+    expect { driver.validate_create_output_parameters! }.to raise_error(
+      RuntimeError,
+      'The workflow output did not contain a server_id and ip_address parameter.'
+    )
+  end
+end
+
+describe Kitchen::Driver::Vro 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::Vro.new(config) }
+
+  let(:config) do
+    {
+      vro_username:          'myuser',
+      vro_password:          'mypassword',
+      vro_base_url:          'https://vra.corp.local:8281',
+      create_workflow_name:  'Create Workflow',
+      create_workflow_id:    'workflow-1',
+      destroy_workflow_name: 'Destroy Workflow',
+      destroy_workflow_id:   'workflow-2'
+    }
+  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
+
+  describe '#create' do
+    context 'when a server already exists' do
+      let(:state) { { server_id: 'server-12345' } }
+
+      it 'does not create the server' do
+        expect(driver).not_to receive(:execute_create_workflow)
+
+        driver.create(state)
+      end
+    end
+
+    let(:state) { {} }
+
+    it 'calls the expected methods' do
+      expect(driver).to receive(:execute_create_workflow).with(state)
+      expect(driver).to receive(:wait_for_server).with(state)
+
+      driver.create(state)
+    end
+  end
+
+  describe '#destroy' do
+    context 'when a server does not exist' do
+      let(:state) { {} }
+
+      it 'does not destroy the server' do
+        expect(driver).not_to receive(:execute_destroy_workflow)
+
+        driver.destroy(state)
+      end
+    end
+
+    let(:state) { { server_id: 'server-12345' } }
+
+    it 'calls the expected methods' do
+      expect(driver).to receive(:execute_destroy_workflow).with(state)
+      driver.destroy(state)
+    end
+  end
+
+  describe '#vro_config' do
+    it 'creates a VcoWorkflows::Config object' do
+      expect(VcoWorkflows::Config).to receive(:new).with(url: 'https://vra.corp.local:8281',
+                                                         username: 'myuser',
+                                                         password: 'mypassword',
+                                                         verify_ssl: true)
+      driver.vro_config
+    end
+  end
+
+  describe '#vro_client' do
+    let(:vro_config) { double('vro_config') }
+    it 'creates a VcoWorkflows::Workflow object' do
+      allow(driver).to receive(:workflow_name).and_return('workflow name')
+      allow(driver).to receive(:workflow_id).and_return('workflow-12345')
+      allow(driver).to receive(:vro_config).and_return(vro_config)
+
+      expect(VcoWorkflows::Workflow).to receive(:new).with('workflow name',
+                                                           id: 'workflow-12345',
+                                                           config: vro_config)
+
+      driver.vro_client
+    end
+  end
+
+  describe '#verify_ssl?' do
+    context 'when vro_disable_ssl_verify is true' do
+      before do
+        config[:vro_disable_ssl_verify] = true
+      end
+
+      it 'returns false' do
+        expect(driver.verify_ssl?).to eq(false)
+      end
+    end
+
+    context 'when vro_disable_ssl_verify is false' do
+      before do
+        config[:vro_disable_ssl_verify] = true
+      end
+
+      it 'returns true' do
+        expect(driver.verify_ssl?).to eq(false)
+      end
+    end
+  end
+
+  describe '#execute_create_workflow' do
+    let(:state)      { {} }
+    let(:server_id)  { double('server_id', value: 'server-12345') }
+    let(:ip_address) { double('ip_address', value: '1.2.3.4') }
+    let(:output_parameters) do
+      {
+        'server_id'  => server_id,
+        'ip_address' => ip_address
+      }
+    end
+
+    before do
+      allow(driver).to receive(:set_workflow_vars)
+      allow(driver).to receive(:set_workflow_parameters)
+      allow(driver).to receive(:execute_workflow)
+      allow(driver).to receive(:wait_for_workflow)
+      allow(driver).to receive(:workflow_successful?).and_return(true)
+      allow(driver).to receive(:validate_create_output_parameters!)
+      allow(driver).to receive(:output_parameters).and_return(output_parameters)
+    end
+
+    it 'calls the expected methods' do
+      expect(driver).to receive(:set_workflow_vars).with('Create Workflow', 'workflow-1')
+      expect(driver).to receive(:set_workflow_parameters).with({})
+      expect(driver).to receive(:execute_workflow)
+      expect(driver).to receive(:wait_for_workflow)
+      expect(driver).to receive(:workflow_successful?)
+
+      driver.execute_create_workflow(state)
+    end
+
+    it 'raises an error if the workflow did not complete successfully' do
+      allow(driver).to receive(:workflow_successful?).and_return(false)
+      expect { driver.execute_create_workflow(state) }.to raise_error(RuntimeError)
+    end
+
+    it 'sets the state hash with the proper info' do
+      driver.execute_create_workflow(state)
+
+      expect(state[:server_id]).to eq('server-12345')
+      expect(state[:hostname]).to eq('1.2.3.4')
+    end
+  end
+
+  describe '#execute_destroy_workflow' do
+    let(:state)      { { server_id: 'server-12345' } }
+    let(:vro_client) { double('vro_client') }
+
+    before do
+      allow(driver).to receive(:vro_client).and_return(vro_client)
+      allow(vro_client).to receive(:parameter)
+      allow(driver).to receive(:set_workflow_vars)
+      allow(driver).to receive(:set_workflow_parameters)
+      allow(driver).to receive(:execute_workflow)
+      allow(driver).to receive(:wait_for_workflow)
+      allow(driver).to receive(:workflow_successful?).and_return(true)
+    end
+
+    it 'calls the expected methods' do
+      expect(driver).to receive(:set_workflow_vars).with('Destroy Workflow', 'workflow-2')
+      expect(driver).to receive(:set_workflow_parameters).with({})
+      expect(vro_client).to receive(:parameter).with('server_id', 'server-12345')
+      expect(driver).to receive(:execute_workflow)
+      expect(driver).to receive(:wait_for_workflow)
+      expect(driver).to receive(:workflow_successful?)
+
+      driver.execute_destroy_workflow(state)
+    end
+
+    it 'raises an error if the workflow did not complete successfully' do
+      allow(driver).to receive(:workflow_successful?).and_return(false)
+      expect { driver.execute_destroy_workflow(state) }.to raise_error(RuntimeError)
+    end
+  end
+
+  describe '#execute_workflow' do
+    let(:vro_client) { double('vro_client') }
+    before do
+      allow(driver).to receive(:vro_client).and_return(vro_client)
+    end
+
+    it 'executes the workflow' do
+      expect(vro_client).to receive(:execute)
+      driver.execute_workflow
+    end
+
+    context 'when execute fails with a RestClient::BadRequest' do
+      it 'prints an error with the HTTP response' do
+        HTTPResponse = Struct.new(:code, :to_s)
+        response = HTTPResponse.new(400, 'an HTTP error occurred')
+        exception = RestClient::BadRequest.new
+        exception.response = response
+        allow(vro_client).to receive(:execute).and_raise(exception)
+        expect(driver).to receive(:error).with('The workflow execution request failed: an HTTP error occurred')
+        expect { driver.execute_workflow }.to raise_error(RestClient::BadRequest)
+      end
+    end
+
+    context 'when execute fails with any other exception' do
+      it 'prints an error with the exception message' do
+        allow(vro_client).to receive(:execute).and_raise(RuntimeError, 'a non-HTTP error occurred')
+        expect(driver).to receive(:error).with('The workflow execution request failed: a non-HTTP error occurred')
+        expect { driver.execute_workflow }.to raise_error(RuntimeError)
+      end
+    end
+  end
+
+  describe '#wait_for_workflow' do
+    let(:vro_client) { double('vro_client') }
+    let(:token)      { double('token') }
+
+    before do
+      allow(driver).to receive(:vro_client).and_return(vro_client)
+      allow(vro_client).to receive(:token).and_return(token)
+
+      # don't actually sleep
+      allow(driver).to receive(:sleep)
+    end
+
+    context 'when the requests completes normally, 3 loops' do
+      it 'only fetches the token 3 times' do
+        allow(token).to receive(:alive?).exactly(3).times.and_return(true, true, false)
+        expect(vro_client).to receive(:token).exactly(3).times
+
+        driver.wait_for_workflow
+      end
+    end
+
+    context 'when the request is completed on the first loop' do
+      it 'only refreshes the request 1 time' do
+        expect(token).to receive(:alive?).once.and_return(false)
+        driver.wait_for_workflow
+      end
+    end
+
+    context 'when the timeout is exceeded' do
+      it 'raises a Timeout exception' do
+        allow(Timeout).to receive(:timeout).and_raise(Timeout::Error)
+        expect { driver.wait_for_workflow }.to raise_error(
+          Timeout::Error, 'Workflow did not complete in 300 seconds. ' \
+          'Please check the vRO UI for more information.')
+      end
+    end
+
+    context 'when a non-timeout exception is raised' do
+      it 'raises the original exception' do
+        allow(vro_client).to receive(:token).and_raise(RuntimeError, 'an error occurred')
+        expect { driver.wait_for_workflow }.to raise_error(RuntimeError, 'an error occurred')
+      end
+    end
+  end
+
+  describe '#wait_for_server' do
+    let(:connection) { instance.transport.connection(state) }
+    let(:state)      { { hostname: 'host1', server_id: 'server-12345' } }
+
+    before do
+      allow(transport).to receive(:connection).and_return(connection)
+    end
+
+    it 'calls wait_until_ready on the transport connection' do
+      expect(connection).to receive(:wait_until_ready)
+      driver.wait_for_server(state)
+    end
+
+    it 'destroys the server if the server failed to become ready' do
+      allow(connection).to receive(:wait_until_ready).and_raise(RuntimeError)
+      expect(driver).to receive(:destroy).with(state)
+      expect { driver.wait_for_server(state) }.to raise_error(RuntimeError)
+    end
+  end
+
+  describe '#set_workflow_parameters' do
+    let(:vro_client) { double('vro_client') }
+    let(:params)     { { key1: 'value1', key2: 'value2' } }
+
+    it 'sets parameters on the client' do
+      allow(driver).to receive(:vro_client).and_return(vro_client)
+      expect(vro_client).to receive(:parameter).with('key1', 'value1')
+      expect(vro_client).to receive(:parameter).with('key2', 'value2')
+
+      driver.set_workflow_parameters(params)
+    end
+  end
+
+  describe '#output_parameters' do
+    let(:vro_client) { double('vro_client') }
+    let(:token)      { double('token') }
+    let(:output)     { double('output_parameters') }
+
+    it 'returns the output parameters from the workflow token' do
+      allow(driver).to receive(:vro_client).and_return(vro_client)
+      allow(vro_client).to receive(:token).and_return(token)
+      expect(token).to receive(:output_parameters).and_return(output)
+      expect(driver.output_parameters).to eq(output)
+    end
+  end
+
+  describe '#output_parameter_value' do
+    let(:test_key) { double('test_key', value: 'test_value') }
+    let(:output_parameters) { { 'test_key' => test_key } }
+    it 'returns the correct value' do
+      allow(driver).to receive(:output_parameters).and_return(output_parameters)
+      expect(driver.output_parameter_value('test_key')).to eq('test_value')
+    end
+  end
+
+  describe '#output_parameter_empty?' do
+    context 'when the value is not nil or empty' do
+      it 'returns false' do
+        allow(driver).to receive(:output_parameter_value).with('test_key').and_return('test_value')
+        expect(driver.output_parameter_empty?('test_key')).to eq(false)
+      end
+    end
+
+    context 'when the value is nil' do
+      it 'returns true' do
+        allow(driver).to receive(:output_parameter_value).with('test_key').and_return(nil)
+        expect(driver.output_parameter_empty?('test_key')).to eq(true)
+      end
+    end
+
+    context 'when the value is empty' do
+      it 'returns true' do
+        allow(driver).to receive(:output_parameter_value).with('test_key').and_return('')
+        expect(driver.output_parameter_empty?('test_key')).to eq(true)
+      end
+    end
+  end
+
+  describe '#validate_create_output_parameters!' do
+    let(:server_id)   { double('server_id', value: 'server-12345') }
+    let(:ip_address)  { double('ip_address', value: '1.2.3.4') }
+
+    context 'when the output parameters do not include server_id and ip_address' do
+      let(:output_parameters) { {} }
+      it_behaves_like 'output parameters that are missing a required key'
+    end
+
+    context 'when the output parameters do not include server_id' do
+      let(:output_parameters) { { 'ip_address' => ip_address } }
+      it_behaves_like 'output parameters that are missing a required key'
+    end
+
+    context 'when the output parameters do not include ip_address' do
+      let(:output_parameters) { { 'server_id' => server_id } }
+      it_behaves_like 'output parameters that are missing a required key'
+    end
+
+    context 'when server_id is empty' do
+      let(:server_id) { double('server_id', value: '') }
+      let(:output_parameters) do
+        {
+          'server_id'  => server_id,
+          'ip_address' => ip_address
+        }
+      end
+
+      it 'raises an exception' do
+        allow(driver).to receive(:output_parameters).and_return(output_parameters)
+        expect { driver.validate_create_output_parameters! }.to raise_error(
+          RuntimeError,
+          'The server_id parameter was empty.'
+        )
+      end
+    end
+
+    context 'when ip_address is empty' do
+      let(:ip_address) { double('ip_address', value: '') }
+      let(:output_parameters) do
+        {
+          'server_id'  => server_id,
+          'ip_address' => ip_address
+        }
+      end
+
+      it 'raises an exception' do
+        allow(driver).to receive(:output_parameters).and_return(output_parameters)
+        expect { driver.validate_create_output_parameters! }.to raise_error(
+          RuntimeError,
+          'The ip_address parameter was empty.'
+        )
+      end
+    end
+  end
+
+  describe '#workflow_successful?' do
+    let(:vro_client) { double('vro_client') }
+    let(:token)      { double('token') }
+    before do
+      allow(driver).to receive(:vro_client).and_return(vro_client)
+      allow(vro_client).to receive(:token).and_return(token)
+    end
+
+    context 'when the state is completed' do
+      it 'returns true' do
+        allow(token).to receive(:state).and_return('completed')
+        expect(driver.workflow_successful?).to eq(true)
+      end
+    end
+
+    context 'when the state is failed' do
+      it 'returns true' do
+        allow(token).to receive(:state).and_return('failed')
+        expect(driver.workflow_successful?).to eq(false)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: kitchen-vro
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Chef Partner Engineering
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-25 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: vcoworkflows
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !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: 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 Orchestrator (vRO)
+email:
+- partnereng@chef.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- kitchen-vro.gemspec
+- lib/kitchen/driver/vro.rb
+- lib/kitchen/driver/vro_version.rb
+- spec/spec_helper.rb
+- spec/vro_spec.rb
+homepage: https://github.com/chef-partners/kitchen-vro
+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 Orchestrator (vRO)
+test_files:
+- spec/spec_helper.rb
+- spec/vro_spec.rb
+has_rdoc: