kitchen-vra 3.3.4 → 3.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fafa7c0d38316e0caed88baf634bd75e30f096bfe9798edcd1a9e3d7a5c994ff
-  data.tar.gz: 7a50b7b1e4189297c2b739f4ea5eac816550b0097129709e2e99d4f53c1d870e
+  metadata.gz: 3077884f3c8f5e434889905e6c4d47e06ecf308fe810948c79d644e5f13086bd
+  data.tar.gz: addc3a87013a8834a75392625e026b5efdf1cfaff8009e0eaa8e690236b0be84
 SHA512:
-  metadata.gz: ad976260af42bb96af58b18b9cd3837f5eda92c0b98b8e86d29676e76862cb1d9c3d4c3dbd604fb09018415622a53f4796d1f79673b357215023dff53854076b
-  data.tar.gz: 0b9fb222821945220304a7d04bffea5b80f98adbf156d43aef3b09aa2d5f75e43619eae90793146984a11e99e07d1f9b9425752aa783f647351d6dca6f0426b1
+  metadata.gz: 2d6521702e1cc486f91d1aa2c0d1c17fdd1feaece55a8b634aaea65950282bde3b327e4bb79e7c256a6683ba8128b36ef5b59852b2c1f0de763d64dc4aa359a2
+  data.tar.gz: 190fa3d7bbfc3fd0db0220934390545f9b28cd4565126648d0503459de10035962f795b69275599409671aa15d2f5d31a018074f7b59d4a092f83437b027d8cd

data/.gitignore

@@ -2,7 +2,6 @@
 /.yardoc
 /Gemfile.lock
 /_yardoc/
-/coverage/
 /doc/
 /pkg/
 /spec/reports/

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "3.3.4"
+  ".": "3.4.1"
 }

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--color

data/.rubocop.yml

@@ -6,4 +6,3 @@ AllCops:
   TargetRubyVersion: 3.1
   Exclude:
     - "vendor/**/*"
-    - "spec/**/*"

data/.yardopts

@@ -8,4 +8,4 @@ lib/**/*.rb
 -
 CHANGELOG.md
 CONTRIBUTING.md
-LICENSE.txt
+LICENSE

data/CHANGELOG.md

@@ -10,6 +10,26 @@
 * Docs: rewrite README for new users and split contributor docs ([#80](https://github.com/test-kitchen/kitchen-vra/pull/80)) ([d9ebc45](https://github.com/test-kitchen/kitchen-vra/commit/d9ebc45))
 * Standardize renovate config and remove dependabot ([#81](https://github.com/test-kitchen/kitchen-vra/pull/81)) ([be552bd](https://github.com/test-kitchen/kitchen-vra/commit/be552bd))
 
+## [3.4.1](https://github.com/test-kitchen/kitchen-vra/compare/v3.4.0...v3.4.1) (2026-08-30)
+
+
+### Bug Fixes
+
+* stop prompting for credentials on every run with cache_credentials ([#91](https://github.com/test-kitchen/kitchen-vra/issues/91)) ([e1c185f](https://github.com/test-kitchen/kitchen-vra/commit/e1c185f8b38700abd98824cae67f01a33d36b710))
+
+## [3.4.0](https://github.com/test-kitchen/kitchen-vra/compare/v3.3.4...v3.4.0) (2026-08-24)
+
+
+### Features
+
+* implement the driver status hook ([#88](https://github.com/test-kitchen/kitchen-vra/issues/88)) ([933e254](https://github.com/test-kitchen/kitchen-vra/commit/933e25445d1a231490ef977cbbfd9644aa16022d))
+
+
+### Bug Fixes
+
+* constrain the test-kitchen dependency ([#86](https://github.com/test-kitchen/kitchen-vra/issues/86)) ([ac5f32d](https://github.com/test-kitchen/kitchen-vra/commit/ac5f32d1dd5eb132c91a3fda58ee41f778148245))
+* drop the unused rack runtime dependency ([#89](https://github.com/test-kitchen/kitchen-vra/issues/89)) ([b68f1fd](https://github.com/test-kitchen/kitchen-vra/commit/b68f1fdd4dfc6d1a0c37320f8b099b5d0ca19c8a))
+
 ## [3.3.4](https://github.com/test-kitchen/kitchen-vra/compare/v3.3.3...v3.3.4) (2026-08-23)
 
 

data/Gemfile

@@ -10,10 +10,6 @@ group :test do
   gem "webmock"
 end
 
-group :debug do
-  gem "pry"
-end
-
 group :docs do
   gem "yard"
 end

data/kitchen-vra.gemspec

@@ -20,9 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 3.1"
 
-  spec.add_dependency "test-kitchen"
+  spec.add_dependency "test-kitchen", ">= 3.0", "< 5"
   spec.add_dependency "vmware-vra", "~> 3.0", ">= 3.2.0" # 3.0 required for vRA 8.x
   spec.add_dependency "highline"
-  spec.add_dependency "rack", ">= 1.6", "< 4.0"
   spec.add_dependency "ffi-yajl", ">= 2.2.3", "< 3.1.0"
 end

data/lib/kitchen/driver/vra.rb

@@ -25,6 +25,7 @@ require "base64" unless defined?(Base64)
 require "digest" unless defined?(Digest)
 require "fileutils" unless defined?(FileUtils)
 require "vra"
+require "time" unless defined?(Time.now.iso8601)
 require_relative "vra_version"
 
 module Kitchen
@@ -46,6 +47,11 @@ module Kitchen
       kitchen_driver_api_version 2
       plugin_version Kitchen::Driver::VRA_VERSION
 
+      # Deployment statuses vRA reports for a deployment that is up.
+      #
+      # @return [Array<String>]
+      LIVE_STATUSES = %w{CREATE_SUCCESSFUL}.freeze
+
       # Location of the credential cache, relative to the working directory.
       CREDENTIALS_CACHE_FILE = ".kitchen/cached_vra"
 
@@ -314,6 +320,41 @@ module Kitchen
         end
       end
 
+      # Reports what vRA currently thinks of the deployment.
+      #
+      # @param state [Hash] instance state naming the deployment
+      # @return [Hash] a Test Kitchen status hash, or the base implementation's
+      #   answer when there is no deployment or vRA does not know it
+      def status(state)
+        return super unless state[:deployment_id]
+
+        deployment = lookup_deployment(state[:deployment_id])
+        return super unless deployment
+
+        deployment_status = deployment.status.to_s
+        {
+          live: LIVE_STATUSES.include?(deployment_status),
+          state: deployment_status,
+          source: "driver",
+          resource_id: state[:deployment_id],
+          message: "vRA reports the deployment as #{deployment_status}",
+          checked_at: Time.now.utc.iso8601,
+        }
+      end
+
+      # Looks a deployment up without turning an unreachable vRA into a
+      # failure. A deployment that has already been destroyed answers with
+      # NotFound, which is a real answer rather than an error.
+      #
+      # @param deployment_id [String] the vRA deployment ID
+      # @return [Vra::Deployment, nil] the deployment, or nil when vRA does not
+      #   know it or cannot be reached
+      def lookup_deployment(deployment_id)
+        vra_client.deployments.by_id(deployment_id)
+      rescue ::StandardError
+        nil
+      end
+
       # Destroys the vRA deployment, if one exists.
       #
       # A deployment that vRA no longer knows about, or that offers no destroy
@@ -342,8 +383,10 @@ module Kitchen
         wait_for_request(destroy_request)
         info("Destroy request complete.")
 
-        File.delete(".kitchen/cached_vra") if File.exist?(".kitchen/cached_vra")
-        info("Removed cached file")
+        return unless File.exist?(CREDENTIALS_CACHE_FILE)
+
+        File.delete(CREDENTIALS_CACHE_FILE)
+        info("Removed the cached credentials in #{CREDENTIALS_CACHE_FILE}.")
       end
 
       # Builds the vRA catalog request for the configured blueprint.
@@ -390,21 +433,43 @@ module Kitchen
 
       # The vRA API client, built from the resolved credentials.
       #
-      # On any failure the credentials are re-prompted, on the assumption that
-      # what failed was authentication.
+      # Credentials are resolved once, when the client is first built. A
+      # failure to build it is assumed to be an authentication problem, so the
+      # credentials are asked for again and the client built a second time. A
+      # second failure is raised rather than swallowed.
       #
       # @return [Vra::Client]
+      # @raise [ArgumentError] if the credentials are still not usable after
+      #   re-prompting
       def vra_client
-        check_config config[:cache_credentials]
-        @client ||= ::Vra::Client.new(
-          base_url:   config[:base_url],
-          username:   config[:username],
-          password:   config[:password],
-          domain:     config[:domain],
-          verify_ssl: config[:verify_ssl]
-        )
-      rescue => _e
-        check_config true
+        @client ||= build_client
+      end
+
+      # Resolves the credentials and builds the client, asking for the
+      # credentials a second time if the first attempt fails.
+      #
+      # @return [Vra::Client]
+      # @raise [ArgumentError] if the second attempt fails as well
+      # @api private
+      def build_client
+        retried = false
+
+        begin
+          check_config(retried)
+          ::Vra::Client.new(
+            base_url:   config[:base_url],
+            username:   config[:username],
+            password:   config[:password],
+            domain:     config[:domain],
+            verify_ssl: config[:verify_ssl]
+          )
+        rescue => e
+          raise if retried
+
+          warn("Unable to build a vRA client: #{e.message}")
+          retried = true
+          retry
+        end
       end
 
       # Polls a vRA request until it completes or times out.
@@ -416,8 +481,6 @@ module Kitchen
       # @return [void]
       # @raise [Timeout::Error] if the request does not complete in time
       def wait_for_request(request)
-        # config = check_config config
-
         last_status = ""
         wait_time   = config[:request_timeout]
         sleep_time  = config[:request_refresh_rate]

data/lib/kitchen/driver/vra_version.rb

@@ -23,6 +23,6 @@ module Kitchen
   # Test Kitchen's driver plugins.
   module Driver
     # The version of the kitchen-vra gem.
-    VRA_VERSION = "3.3.4"
+    VRA_VERSION = "3.4.1"
   end
 end

data/spec/spec_helper.rb

@@ -19,13 +19,51 @@
 #
 
 require "webmock/rspec"
+require "tmpdir"
+require "fileutils"
 
+require "kitchen/driver/vra"
+require "kitchen/provisioner/dummy"
+require "kitchen/transport/dummy"
+require "kitchen/verifier/dummy"
+
+Dir[File.join(__dir__, "support", "**", "*.rb")].sort.each { |file| require file }
+
+# These specs never reach a vRA appliance. Everything the driver does is turn
+# kitchen.yml configuration into a vRA catalog request, and turn vRA's answers
+# back into Test Kitchen state, so an outbound request from a spec is a mistake
+# rather than a slow test.
 WebMock.disable_net_connect!(allow_localhost: true)
 
-if ENV["COVERAGE"]
-  require "simplecov"
-  SimpleCov.profiles.define "gem" do
-    command_name "Specs"
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end
-  SimpleCov.start "gem"
+
+  config.mock_with :rspec do |mocks|
+    # Fail if an example stubs a method the real object does not have. Almost
+    # every driver method is a call into the vmware-vra gem, so without this a
+    # rename there leaves the specs stubbing a method that no longer exists,
+    # passing while the driver is broken.
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # No `describe` on bare objects and no `should` -- the RSpec 2 DSL, kept
+  # alive only by monkey patches on Object and BasicObject.
+  config.disable_monkey_patching!
+
+  # Surface deprecations as failures rather than warnings that scroll past.
+  config.raise_errors_for_deprecations!
+
+  config.include VraApi
+
+  config.filter_run_when_matching :focus
+
+  # Run specs in random order to surface order dependencies. To debug one, fix
+  # the order by passing the seed printed after each run:
+  #     --seed 1234
+  config.order = :random
+  Kernel.srand config.seed
 end

data/spec/support/vra_api.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+#
+# 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.
+#
+
+# Stand-ins for the vmware-vra objects the driver talks to.
+#
+# The driver is a thin layer over the vmware-vra gem: nearly every method
+# either asks a Vra object something or hands it a request. A bare `double`
+# answers whatever it is told to answer, so a suite built on them keeps passing
+# after vmware-vra renames a method -- which is exactly the change most likely
+# to break the driver. Everything here is a verifying double checked against
+# the real class instead, so the specs fail when the gem moves underneath them.
+#
+# Each helper takes a hash of overrides so an example can say only what it
+# cares about:
+#
+#     vra_deployment(status: "CREATE_FAILED", failed?: true)
+module VraApi
+  # A VM inside a deployment, as returned by Vra::Deployment#resources.
+  #
+  # @param overrides [Hash] stubs to replace the defaults with
+  # @return [InstanceDouble<Vra::Resource>]
+  def vra_resource(overrides = {})
+    instance_double(
+      Vra::Resource,
+      {
+        id: "res-1",
+        deployment_id: "dep-1",
+        name: "test-server",
+        ip_address: "1.2.3.4",
+        vm?: true,
+      }.merge(overrides)
+    )
+  end
+
+  # A deployment. This is also what Vra::DeploymentRequest#submit hands back,
+  # which is why the driver waits on it and then asks it for its resources.
+  #
+  # @param overrides [Hash] stubs to replace the defaults with
+  # @return [InstanceDouble<Vra::Deployment>]
+  def vra_deployment(overrides = {})
+    instance_double(
+      Vra::Deployment,
+      {
+        id: "dep-1",
+        name: "test-instance",
+        status: "CREATE_SUCCESSFUL",
+        failed?: false,
+        completed?: true,
+        completion_details: nil,
+        refresh: nil,
+        resources: [vra_resource],
+      }.merge(overrides)
+    )
+  end
+
+  # A request against a deployment, such as the destroy action.
+  #
+  # @param overrides [Hash] stubs to replace the defaults with
+  # @return [InstanceDouble<Vra::Request>]
+  def vra_request(overrides = {})
+    instance_double(
+      Vra::Request,
+      {
+        id: "req-1",
+        status: "SUCCESSFUL",
+        completed?: true,
+        refresh: nil,
+        details: nil,
+      }.merge(overrides)
+    )
+  end
+
+  # A catalog item, as returned by Vra::Catalog#fetch_catalog_items.
+  #
+  # @param overrides [Hash] stubs to replace the defaults with
+  # @return [InstanceDouble<Vra::CatalogItem>]
+  def vra_catalog_item(overrides = {})
+    instance_double(
+      Vra::CatalogItem,
+      { id: "cat-1", name: "Ubuntu Server" }.merge(overrides)
+    )
+  end
+
+  # An unsubmitted catalog request.
+  #
+  # @param overrides [Hash] stubs to replace the defaults with
+  # @return [InstanceDouble<Vra::DeploymentRequest>]
+  def vra_deployment_request(overrides = {})
+    instance_double(
+      Vra::DeploymentRequest,
+      { submit: vra_deployment, set_parameters: nil }.merge(overrides)
+    )
+  end
+
+  # A vRA API client, wired to a catalog and a deployments collection.
+  #
+  # @param catalog [InstanceDouble<Vra::Catalog>, nil]
+  # @param deployments [InstanceDouble<Vra::Deployments>, nil]
+  # @return [InstanceDouble<Vra::Client>]
+  def vra_client(catalog: nil, deployments: nil)
+    instance_double(
+      Vra::Client,
+      catalog:     catalog || instance_double(Vra::Catalog),
+      deployments: deployments || instance_double(Vra::Deployments)
+    )
+  end
+end