kitchen-vagrant 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf0fbd431e7e5a52a144f6ce2e79edea1d2783c74c0ef212c3674a12e147683e
-  data.tar.gz: fdde8621c74520cf97a5367bfa3098aedc814d8037ad564ef8cada2056237807
+  metadata.gz: eb41469b88a11508fe064bd6b04389da5cdb617ef027e5a633f47a1c88478be0
+  data.tar.gz: d4e9d511d64c4bff5a21121f2e2e9bcad8cd453efe7981de9a2c87597bb5f758
 SHA512:
-  metadata.gz: 1877e0240f40b4d4880ba3032f9801a984252051a88ba2a8fc0bd5af9d314ac5aa701b1116e9df747614b6ca3adacbbf898be6fdfe1d3d104f41f2321d2aceaa
-  data.tar.gz: eef20bc7471c539f0b11cbb31d80337bf7037905e7a1fecc9f7104d9b9335f57bd5d5437e376bb19942d5e80dcffb5193ba5ddab7836d8c3cb315aced9149361
+  metadata.gz: 8332c2ee9115ff0c69684420767948b5ad620051b4e99b5ac763e4b08636fe81caa4678ba9ccbbb5e662f6495438499c1fdafd9e7c127738c4219980d61f09f2
+  data.tar.gz: 163808d47b023456f260985e2180e7de2f46d0b0201729d828bb328d2f16d89c381b4eb7b43191e42a8d4645c14b2e39d6e630409e0847dd01c0e4497235af73

data/lib/kitchen/driver/vagrant.rb

@@ -18,6 +18,13 @@
 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.
+require "time" unless defined?(Time.now.iso8601)
+# :nocov:
 
 require "kitchen"
 require_relative "vagrant_version"
@@ -31,6 +38,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
@@ -188,6 +199,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
@@ -225,6 +257,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
@@ -503,6 +552,90 @@ module Kitchen
         end
       end
 
+      # 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.
       #
       # @param cmd [String] command to run locally

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.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-vagrant
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Fletcher Nichol
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-08-22 00:00:00.000000000 Z
+date: 2026-08-24 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'