kitchen-vagrant 2.4.0 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb41469b88a11508fe064bd6b04389da5cdb617ef027e5a633f47a1c88478be0
-  data.tar.gz: d4e9d511d64c4bff5a21121f2e2e9bcad8cd453efe7981de9a2c87597bb5f758
+  metadata.gz: 6ded9303b651d9e3d46c4d56a805da70902c941946e6f034635e3ccedef10e37
+  data.tar.gz: 721a9bdf7801068039a3e4a446f92866e90601fc86f35cf4e4d6a284b62fb95b
 SHA512:
-  metadata.gz: 8332c2ee9115ff0c69684420767948b5ad620051b4e99b5ac763e4b08636fe81caa4678ba9ccbbb5e662f6495438499c1fdafd9e7c127738c4219980d61f09f2
-  data.tar.gz: 163808d47b023456f260985e2180e7de2f46d0b0201729d828bb328d2f16d89c381b4eb7b43191e42a8d4645c14b2e39d6e630409e0847dd01c0e4497235af73
+  metadata.gz: 67975ca9f88c44ab626a92acdd66ea6fe077da509ac856c76c1b40f0f36391a33d3d9b55332bd8ad84ccce722ad550460f7072338ef7ae27d240cccc3d920827
+  data.tar.gz: 856a7d25b3a15cb4792f07f69b1b20b4c957bf5eaa062f1cfa05a9fe32bd810522072eb46ee88915ebbe4149851b387e8e2b8708df9b66c796daaa7b7c00479c

data/lib/kitchen/driver/helpers.rb

@@ -127,7 +127,7 @@ module Kitchen
       # @param cmd [String] command to run locally
       # @param options [Hash] options hash
       # @return [Hash,nil] the parsed JSON the script emitted, if any
-      # @see Kitchen::ShellOut.run_command
+      # @see Kitchen::ShellOut#run_command
       # @api private
       def run_ps(cmd, options = {})
         cmd = "echo #{cmd}" if config[:dry_run]

data/lib/kitchen/driver/vagrant.rb

@@ -18,13 +18,9 @@
 require "erb" unless defined?(Erb)
 require "fileutils" unless defined?(FileUtils)
 require "rubygems/version"
-# :nocov:
-# Chefstyle's Chef/Ruby/UnlessDefinedRequire wants this guard, but the guard's
-# other branch is unreachable: kitchen has already loaded "time" by here. The
-# repo enforces a branch-coverage floor, so exclude the line rather than let
-# the two rules fight.
+# Chefstyle's Chef/Ruby/UnlessDefinedRequire wants this guard, even though the
+# guard's other branch is unreachable: kitchen has already loaded "time" by here.
 require "time" unless defined?(Time.now.iso8601)
-# :nocov:
 
 require "kitchen"
 require_relative "vagrant_version"
@@ -112,11 +108,17 @@ module Kitchen
         driver.windows_os? ? "/omnibus/cache" : "/tmp/omnibus/cache"
       end
 
-      # for use with vagrant on WSL
-      user_home = ENV["VAGRANT_WSL_WINDOWS_ACCESS_USER_HOME_PATH"].nil? ? "~" : ENV["VAGRANT_WSL_WINDOWS_ACCESS_USER_HOME_PATH"]
-
-      default_config :kitchen_cache_directory,
+      # Resolved per instance rather than when this file is loaded, so that
+      # `VAGRANT_WSL_WINDOWS_ACCESS_USER_HOME_PATH` is read at the moment the
+      # driver needs it -- the same way `:provider` reads
+      # `VAGRANT_DEFAULT_PROVIDER`. Reading it eagerly froze one value into the
+      # class for the life of the process, which is wrong for anything that
+      # sets the variable after the driver has been required, and made the
+      # setting impossible to exercise.
+      default_config(:kitchen_cache_directory) do |_|
+        user_home = ENV["VAGRANT_WSL_WINDOWS_ACCESS_USER_HOME_PATH"] || "~"
         File.expand_path("#{user_home}/.kitchen/cache")
+      end
 
       default_config :cachier, nil
 
@@ -125,6 +127,7 @@ module Kitchen
       # Creates a Vagrant VM instance.
       #
       # @param state [Hash] mutable instance state
+      # @return [void]
       # @raise [ActionFailed] if the action could not be completed
       def create(state)
         create_vagrantfile
@@ -165,6 +168,7 @@ module Kitchen
       # Destroys an instance.
       #
       # @param state [Hash] mutable instance state
+      # @return [void]
       # @raise [ActionFailed] if the action could not be completed
       def destroy(state)
         return if state[:hostname].nil?
@@ -182,6 +186,7 @@ module Kitchen
       # current working directory, then destroys the instance.
       #
       # @param state [Hash] mutable instance state
+      # @return [void]
       # @raise [UserError] if the instance has not been created
       # @raise [ActionFailed] if the action could not be completed
       def package(state)
@@ -246,6 +251,7 @@ module Kitchen
       # checking for the presence of certain directories, software installed,
       # etc.
       #
+      # @return [void]
       # @raise [UserError] if the driver will not be able to perform or if a
       #   documented dependency is missing from the system
       def verify_dependencies
@@ -303,9 +309,20 @@ module Kitchen
       MIN_VER = "2.4.0".freeze
 
       class << self
-        # @return [String] the version of Vagrant installed on the workstation
+        # Memoises `vagrant --version` for the life of the process, so that
+        # every instance in a multi-instance run shells out at most once.
+        #
+        # @return [String,nil] the version of Vagrant installed on the
+        #   workstation, or nil before anything has looked it up
         # @api private
         attr_accessor :vagrant_version
+
+        # @!method self.vagrant_version=(value)
+        #   Records the version of Vagrant found on the workstation.
+        #
+        #   @param value [String] the version string to memoise
+        #   @return [String] the version string just stored
+        #   @api private
       end
 
       # Returns whether or not a platform name could have a corresponding Bento
@@ -425,6 +442,7 @@ module Kitchen
 
       # Replaces any `{{vagrant_root}}` tokens in the pre create command.
       #
+      # @return [void]
       # @api private
       def finalize_pre_create_command!
         return if config[:pre_create_command].nil?
@@ -636,11 +654,14 @@ module Kitchen
         end
       end
 
-      # Convenience method to run a command locally.
+      # Convenience method to run a command locally, from {#vagrant_root}.
       #
       # @param cmd [String] command to run locally
       # @param options [Hash] options hash
-      # @see Kitchen::ShellOut.run_command
+      # @return [String] the standard output of the command
+      # @raise [Kitchen::ShellOut::ShellCommandFailed] if the command exits
+      #   non-zero
+      # @see Kitchen::ShellOut#run_command
       # @api private
       def run(cmd, options = {})
         cmd = "echo #{cmd}" if config[:dry_run]
@@ -662,6 +683,8 @@ module Kitchen
       # @param cmd [String] command to run locally
       # @param options [Hash] options hash
       # @return [String] the standard output of the command
+      # @raise [Kitchen::ShellOut::ShellCommandFailed] if the command exits
+      #   non-zero
       # @see Kitchen::ShellOut#run_command
       # rubocop:disable Metrics/CyclomaticComplexity
       def run_command(cmd, options = {})
@@ -885,7 +908,12 @@ module Kitchen
         state[:rdp_port] = hash["RDPPort"] if hash["RDPPort"]
       end
 
-      # @return [String] full absolute path to the kitchen cache directory
+      # The *host* side of the omnibus package cache: the directory that
+      # {#add_extra_synced_folders!} shares into the guest, where it is
+      # mounted at {#cache_directory}.
+      #
+      # @return [String] full absolute path, on the host, to the kitchen
+      #   cache directory
       # @api private
       def local_kitchen_cache
         @local_kitchen_cache ||= config[:kitchen_cache_directory]
@@ -922,9 +950,15 @@ module Kitchen
         false
       end
 
-      # Converts a Windows path to a WSL path
-      # @param path [String] Windows path (e.g., "C:/Users/...")
-      # @return [String] WSL path (e.g., "/mnt/c/users/...")
+      # Converts a Windows path to a WSL path.
+      #
+      # Anything that does not look like a drive-lettered Windows path is
+      # returned untouched. Note that the conversion downcases the whole
+      # path, not just the drive letter, so a path whose remainder is
+      # case-sensitive does not survive it.
+      #
+      # @param path [String] Windows path (e.g., `"C:/Users/..."`)
+      # @return [String] WSL path (e.g., `"/mnt/c/users/..."`)
       # @api private
       def windows_to_wsl_path(path)
         # Only convert if it looks like a Windows path

data/lib/kitchen/driver/vagrant_version.rb

@@ -21,6 +21,6 @@ module Kitchen
   module Driver
 
     # Version string for Vagrant Kitchen driver
-    VAGRANT_VERSION = "2.4.0".freeze
+    VAGRANT_VERSION = "2.4.1".freeze
   end
 end

data/templates/Vagrantfile.erb

@@ -99,6 +99,8 @@ Vagrant.configure("2") do |c|
     p.name = "kitchen-<%= File.basename(config[:kitchen_root]) %>-<%= instance.name %>-<%= SecureRandom.uuid %>"
 <% when "tart" %>
     p.name = "kitchen-<%= File.basename(config[:kitchen_root]) %>-<%= instance.name %>"
+<% when "libvirt" %>
+    p.default_prefix = "<%="kitchen-#{File.basename(config[:kitchen_root])}-#{instance.name}-#{SecureRandom.uuid}"[0..99].chomp("-") %>"
 <% end %>
 
 <% case config[:provider]
@@ -257,7 +259,9 @@ Vagrant.configure("2") do |c|
   end
 
 <% if config[:env] && !config[:env].empty? %>
-  # Set environment variables
+  # Environment variables for the *guest*, not for the host's Vagrant
+  # process: each entry becomes an export line in /etc/profile.d/kitchen.sh,
+  # so it applies to logins on Linux guests only.
   <% config[:env].each do |env_var| %>
   c.vm.provision "shell", inline: <<-SHELL
     echo 'export <%= env_var.gsub("'", "'\\\\''") %>' >> /etc/profile.d/kitchen.sh

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-vagrant
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.4.1
 platform: ruby
 authors:
 - Fletcher Nichol
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-08-24 00:00:00.000000000 Z
+date: 2026-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64