kitchen-vagrant 2.3.0 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf0fbd431e7e5a52a144f6ce2e79edea1d2783c74c0ef212c3674a12e147683e
-  data.tar.gz: fdde8621c74520cf97a5367bfa3098aedc814d8037ad564ef8cada2056237807
+  metadata.gz: 6ded9303b651d9e3d46c4d56a805da70902c941946e6f034635e3ccedef10e37
+  data.tar.gz: 721a9bdf7801068039a3e4a446f92866e90601fc86f35cf4e4d6a284b62fb95b
 SHA512:
-  metadata.gz: 1877e0240f40b4d4880ba3032f9801a984252051a88ba2a8fc0bd5af9d314ac5aa701b1116e9df747614b6ca3adacbbf898be6fdfe1d3d104f41f2321d2aceaa
-  data.tar.gz: eef20bc7471c539f0b11cbb31d80337bf7037905e7a1fecc9f7104d9b9335f57bd5d5437e376bb19942d5e80dcffb5193ba5ddab7836d8c3cb315aced9149361
+  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,6 +18,9 @@
 require "erb" unless defined?(Erb)
 require "fileutils" unless defined?(FileUtils)
 require "rubygems/version"
+# 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)
 
 require "kitchen"
 require_relative "vagrant_version"
@@ -31,6 +34,10 @@ module Kitchen
     #
     # @author Fletcher Nichol <fnichol@nichol.ca>
     class Vagrant < Kitchen::Driver::Base
+      # Machine states Vagrant reports for a box that is up and reachable.
+      #
+      # @return [Array<String>]
+      LIVE_STATES = %w{running}.freeze
 
       include ShellOut
       include Kitchen::Driver::HypervHelpers
@@ -101,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
 
@@ -114,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
@@ -154,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?
@@ -171,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)
@@ -188,6 +204,27 @@ module Kitchen
         destroy(state)
       end
 
+      # Reports what Vagrant currently thinks of the machine.
+      #
+      # @param state [Hash] instance state naming the machine
+      # @return [Hash] a Test Kitchen status hash, or the base implementation's
+      #   answer when there is nothing to ask Vagrant about
+      def status(state)
+        return super unless state[:hostname]
+
+        machine_state = vagrant_machine_state
+        return super unless machine_state
+
+        {
+          live: LIVE_STATES.include?(machine_state),
+          state: machine_state,
+          source: "driver",
+          resource_id: instance.name,
+          message: "Vagrant reports the machine as #{machine_state}",
+          checked_at: Time.now.utc.iso8601,
+        }
+      end
+
       # A lifecycle method that should be invoked when the object is about
       # ready to be used. A reference to an Instance is required as
       # configuration dependant data may be access through an Instance. This
@@ -214,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
@@ -225,6 +263,23 @@ module Kitchen
         end
       end
 
+      # Checks the host-side things a Vagrant run needs, reporting rather than
+      # raising so `kitchen doctor` can list every problem at once.
+      #
+      # {#verify_dependencies} already raises on an old or absent Vagrant, but
+      # it only runs on the actions that need it. This repeats the version rule
+      # as a report and adds the file and folder checks that nothing validates
+      # today.
+      #
+      # @param state [Hash] mutable instance and driver state
+      # @return [Boolean] true when a problem was reported
+      def doctor(state) # rubocop:disable Lint/UnusedMethodArgument
+        problems = vagrant_problems + template_problems + synced_folder_problems
+
+        problems.each { |problem| warn(problem) }
+        !problems.empty?
+      end
+
       # @return [TrueClass,FalseClass] whether or not the transport's name
       #   implies a WinRM-based transport
       # @api private
@@ -254,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
@@ -376,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?
@@ -503,11 +570,98 @@ module Kitchen
         end
       end
 
-      # Convenience method to run a command locally.
+      # Asks Vagrant for the machine state.
+      #
+      # `--machine-readable` is parsed rather than the human output because the
+      # human wording is localised and reworded between Vagrant releases, while
+      # the machine format is a stable comma-separated
+      # `timestamp,target,type,data` and the `state` row carries the raw value
+      # (`running`, `poweroff`, `not_created`, ...).
+      #
+      # @return [String, nil] the machine state, or nil when there is no
+      #   Vagrantfile to ask about, the command fails, or no state row is found
+      # @api private
+      def vagrant_machine_state
+        return nil unless File.exist?(File.join(vagrant_root, "Vagrantfile"))
+
+        output = run("#{config[:vagrant_binary]} status --machine-readable")
+        parse_machine_state(output)
+      rescue ::StandardError => e
+        debug("Could not read the Vagrant machine state: #{e.message}")
+        nil
+      end
+
+      # Pulls the `state` row out of Vagrant's machine-readable output.
+      #
+      # @param output [String] the raw `--machine-readable` output
+      # @return [String, nil] the state value, or nil when no state row is present
+      # @api private
+      def parse_machine_state(output)
+        output.to_s.each_line do |line|
+          fields = line.strip.split(",")
+          return fields[3] if fields[2] == "state" && fields[3]
+        end
+        nil
+      end
+
+      # Vagrant itself: present, and new enough.
+      #
+      # @return [Array<String>] a problem, or an empty array
+      def vagrant_problems
+        found = vagrant_version
+        if Gem::Version.new(found) < Gem::Version.new(MIN_VER.dup)
+          return ["Vagrant #{found} is older than the #{MIN_VER} this driver " \
+                  "needs. Upgrade from #{WEBSITE}."]
+        end
+
+        info("vagrant #{found} found at #{config[:vagrant_binary]}")
+        []
+      rescue UserError => e
+        [e.message]
+      rescue ::StandardError => e
+        ["Could not run #{config[:vagrant_binary]} --version: #{e.message}"]
+      end
+
+      # The Vagrantfile template, and any extra Vagrantfiles spliced into it.
+      # Both are `expand_path_for` settings, so a wrong relative path becomes
+      # an absolute path that simply is not there.
+      #
+      # @return [Array<String>] one problem per missing file
+      def template_problems
+        problems = []
+
+        unless File.exist?(config[:vagrantfile_erb].to_s)
+          problems << "vagrantfile_erb #{config[:vagrantfile_erb]} does not exist."
+        end
+
+        Array(config[:vagrantfiles]).each do |path|
+          problems << "vagrantfiles entry #{path} does not exist." unless File.exist?(path.to_s)
+        end
+
+        problems
+      end
+
+      # Host paths in `synced_folders`. Vagrant creates a missing host path
+      # silently for some providers and fails for others, so an absent source
+      # is worth naming either way.
+      #
+      # @return [Array<String>] one problem per missing host path
+      def synced_folder_problems
+        Array(config[:synced_folders]).filter_map do |source, destination, _options|
+          next if source.nil? || File.exist?(source.to_s)
+
+          "synced_folders source #{source} (mounted at #{destination}) does not exist."
+        end
+      end
+
+      # 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]
@@ -529,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 = {})
@@ -752,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]
@@ -789,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.3.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.3.0
+  version: 2.4.1
 platform: ruby
 authors:
 - Fletcher Nichol
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-08-22 00:00:00.000000000 Z
+date: 2026-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -30,7 +30,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '5'
@@ -40,7 +40,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '5'