kitchen-dokken 2.23.8 → 2.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0dffedb0556f642eb7b9011de7ce16d3002b7fc94fc4f99e1f0350a3e593865
-  data.tar.gz: 0542043deb31d066f65640e32faaf45f66c62d6c5e77b8efa569d30dbbfa0ecf
+  metadata.gz: c712b6533f76b28643283d228dad566b0cecc7ad856b0b2e8c0a37a7577f28ee
+  data.tar.gz: 7c84488e75a2d2c05029eea1d2d935d235d266742a0539456a28590bdd512a4b
 SHA512:
-  metadata.gz: f0717edbd835bdba7ba34d86f051b19427506871cde23003d7cd11c9ccf2fdc32a876d02b32c66fb0b370382648863053b671046d921e04318d5ebf13af0a580
-  data.tar.gz: 7d99975e0a3532d9c62acd42cf84cc258514bb591621d63de40f53f1b814b090cc8d7eac777b7fbd179d7a6b81e1a38ae461e957db6a551bb91fd7a53c98491a
+  metadata.gz: f0ee27961e74995e48eff9725effcc2c47405bd02136a2adf1d58ab69cce9bf2109cecd12ecef71889a59db6a59845427ee2bc4b5c8d289cde5cf78a81bb9461
+  data.tar.gz: 767e8b79c3e2431605faa15a801a7e14d2507573b80483be4c46283bb29cd7818a80ca9c534acd8208d1ce1a0b0bcab5fe44c04df615de5d8bcda673b3ed3147

data/Gemfile

@@ -21,10 +21,9 @@ group :test do
 end
 
 group :development do
-  gem "pry"
   gem "yard" # `rake doc` -- documentation is not gated in CI
 end
 
 group :cookstyle do
-  gem "cookstyle", "~> 8.4"
+  gem "cookstyle", "~> 9.0"
 end

data/kitchen-dokken.gemspec

@@ -19,5 +19,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "docker-api", ">= 1.33", "< 3"
   spec.add_dependency "kitchen-omnibus-chef", ">= 1.0"
-  spec.add_dependency "test-kitchen", ">= 1.15", "< 5"
+  spec.add_dependency "test-kitchen", ">= 3.0", "< 5"
 end

data/lib/kitchen/driver/dokken.rb

@@ -23,6 +23,7 @@ require "docker"
 require "shellwords" unless defined?(Shellwords)
 require "base64" unless defined?(Base64)
 require_relative "../helpers"
+require_relative "dokken_version"
 
 include Dokken::Helpers
 
@@ -42,6 +43,14 @@ module Kitchen
     #
     # @author Sean OMeara <sean@sean.io>
     class Dokken < Kitchen::Driver::Base
+      kitchen_driver_api_version 2
+
+      # kitchen-dokken's own version, not test-kitchen's. `kitchen diagnose`
+      # is the first thing a bug report carries, and it used to report the
+      # test-kitchen version here -- which says nothing about the plugin the
+      # report is actually about.
+      plugin_version Kitchen::Driver::DOKKEN_VERSION
+
       default_config :api_retries, 20
       default_config :binds, []
       default_config :cap_add, nil
@@ -143,8 +152,111 @@ module Kitchen
         dokken_delete_sandbox
       end
 
+      # (see Base#status)
+      #
+      # `kitchen list --live` asks the driver whether the instance is really
+      # there rather than trusting the last recorded action, which is exactly
+      # the question a docker daemon can answer precisely. Without this the
+      # driver inherited Base's "unknown", so a container that was plainly
+      # `Up` still listed as `unknown`.
+      #
+      # The runner *is* the instance. The chef container is a shared volume
+      # and the data container only exists on the remote-daemon path, so
+      # neither says anything about whether this instance is up.
+      #
+      # Deliberately not wrapped in {#with_retries}: this backs a listing, and
+      # a slow answer is worse than an honest "unknown".
+      #
+      # @param _state [Hash] mutable instance state
+      # @return [Hash] normalized status data
+      def status(_state)
+        container_status(::Docker::Container.get(runner_container_name, {}, docker_connection))
+      rescue ::Docker::Error::NotFoundError
+        { live: false, state: "not created", source: "driver" }
+      # Every other failure -- an unreachable daemon most of all -- is an
+      # unknown rather than an exception. Kitchen would catch it either way,
+      # but it would then report the exception class instead of the daemon
+      # url that could not be reached.
+      rescue ::StandardError => e
+        {
+          live: nil,
+          state: "unknown",
+          source: "driver",
+          message: "could not ask the docker daemon at #{config[:docker_host_url]}: #{e.message}",
+        }
+      end
+
+      # Checks the two things that stop a dokken run before it starts.
+      #
+      # @param state [Hash] mutable instance and driver state
+      # @return [Boolean] true when a problem was reported
+      def doctor(state) # rubocop:disable Lint/UnusedMethodArgument
+        problems = daemon_problems + creds_file_problems
+
+        problems.each { |problem| warn(problem) }
+        !problems.empty?
+      end
+
       private
 
+      # Confirms the docker daemon is actually reachable, which is the single
+      # most common reason a dokken run fails, and reports the version when it
+      # is so the answer is useful rather than merely green.
+      #
+      # @return [Array<String>] a connectivity problem, or an empty array
+      def daemon_problems
+        version = ::Docker.version(docker_connection)
+        info("docker daemon at #{config[:docker_host_url]} is reachable " \
+             "(version #{version["Version"]}, API #{version["ApiVersion"]})")
+        []
+      rescue ::StandardError => e
+        ["Could not reach the docker daemon at #{config[:docker_host_url]}: " \
+         "#{e.message}"]
+      end
+
+      # A configured creds_file that cannot be read or parsed fails inside
+      # +authenticate!+ on the first line of +create+, before anything is
+      # built, so it is worth catching here.
+      #
+      # @return [Array<String>] a credentials problem, or an empty array
+      def creds_file_problems
+        return [] if config[:creds_file].nil?
+
+        unless File.exist?(config[:creds_file])
+          return ["creds_file #{config[:creds_file]} does not exist."]
+        end
+
+        JSON.parse(IO.read(config[:creds_file]))
+        []
+      rescue JSON::ParserError => e
+        ["creds_file #{config[:creds_file]} is not valid JSON: #{e.message}"]
+      rescue ::StandardError => e
+        ["creds_file #{config[:creds_file]} could not be read: #{e.message}"]
+      end
+
+      # Translate a container's `State` into kitchen's status shape.
+      #
+      # @param container [::Docker::Container] the runner container
+      # @return [Hash] normalized status data
+      def container_status(container)
+        state = container.info["State"] || {}
+        running = state["Running"] == true
+
+        status = {
+          # Docker's own vocabulary -- created, running, paused, exited,
+          # restarting, dead -- says more than a boolean, and `kitchen list`
+          # prints it verbatim.
+          live: running,
+          state: state["Status"] || (running ? "running" : "stopped"),
+          source: "driver",
+          resource_id: container.info["Id"],
+        }
+
+        error = state["Error"].to_s
+        status[:message] = error unless error.empty?
+        status
+      end
+
       # Attach DNS settings to a network endpoint configuration, in place.
       #
       # @param endpoint_config [Hash] the EndpointsConfig entry to extend

data/lib/kitchen/driver/dokken_version.rb

@@ -18,6 +18,6 @@
 module Kitchen
   module Driver
     # Version string for Dokken Kitchen driver
-    DOKKEN_VERSION = "2.23.8".freeze
+    DOKKEN_VERSION = "2.25.0".freeze
   end
 end

data/lib/kitchen/helpers.rb

@@ -629,8 +629,39 @@ module Kitchen
 
       # Run the verifier against the instance.
       #
-      # Files are only uploaded when the driver built a data container, which
-      # it does exactly when the daemon cannot read the host filesystem.
+      # This replaces Kitchen::Verifier::Base#call outright, so it has to be
+      # read against the upstream version it stands in for. It diverges in
+      # three places, and each divergence is deliberate:
+      #
+      # 1. *The upload is gated on the data container.* Files are only shipped
+      #    when the driver built one, which it does exactly when the daemon
+      #    cannot read the host filesystem. Otherwise the sandboxes are
+      #    bind-mounted and are already in place. `init_command` is gated with
+      #    it because for Busser it clears the verifier root, which in
+      #    bind-mount mode is the host sandbox that was just populated.
+      #
+      # 2. *`cleanup_sandbox` is not called*, and must not be. Upstream can
+      #    `rmtree` its sandbox because a stock one is a throwaway
+      #    `Dir.mktmpdir`. Dokken's is a stable per-instance directory that
+      #    the driver bind-mounts into a long-lived container, and a bind
+      #    mount is bound to an inode rather than to a path: removing the
+      #    directory severs it permanently, and the `mkdir_p` in the next
+      #    `create_sandbox` does not restore it. Verified against Docker --
+      #    after an rmtree and a recreate, the host has the file and the
+      #    container cannot see it, until the container itself is replaced.
+      #    Kitchen::Provisioner::Dokken#cleanup_dokken_sandbox is the shape
+      #    that is safe here: empty the directory, keep the inode.
+      #
+      # 3. *`config[:downloads]` is not honoured.* Upstream downloads files
+      #    off the instance after the run command. That cannot work here yet
+      #    for a second reason as well: Transport::Dokken::Connection does not
+      #    implement `download`, so the base class would raise. Wiring both up
+      #    is worth doing, and is the one divergence here that is a gap rather
+      #    than a decision.
+      #
+      # spec/kitchen/verifier_override_contract_spec.rb pins the upstream
+      # facts this reasoning rests on, so that a test-kitchen release which
+      # invalidates any of them fails loudly rather than silently.
       #
       # @param state [Hash] mutable instance state
       # @return [void]

data/lib/kitchen/provisioner/dokken.rb

@@ -18,6 +18,7 @@
 require "kitchen"
 require "kitchen/provisioner/chef_infra"
 require_relative "../helpers"
+require_relative "../driver/dokken_version"
 
 include Dokken::Helpers
 
@@ -35,7 +36,10 @@ module Kitchen
     class Dokken < Kitchen::Provisioner::ChefInfra
       kitchen_provisioner_api_version 2
 
-      plugin_version Kitchen::VERSION
+      # kitchen-dokken's own version. Kitchen::VERSION is test-kitchen's,
+      # so `kitchen diagnose` reported the framework version as the
+      # plugin version for every dokken plugin.
+      plugin_version Kitchen::Driver::DOKKEN_VERSION
 
       default_config :root_path, "/opt/kitchen"
       default_config :chef_binary do |provisioner|

data/lib/kitchen/transport/dokken.rb

@@ -22,6 +22,7 @@ require "digest/sha1" unless defined?(Digest::SHA1)
 require "open3" unless defined?(Open3)
 require "shellwords" unless defined?(Shellwords)
 require_relative "../helpers"
+require_relative "../driver/dokken_version"
 
 include Dokken::Helpers
 
@@ -45,7 +46,10 @@ module Kitchen
     class Dokken < Kitchen::Transport::Base
       kitchen_transport_api_version 2
 
-      plugin_version Kitchen::VERSION
+      # kitchen-dokken's own version. Kitchen::VERSION is test-kitchen's,
+      # so `kitchen diagnose` reported the framework version as the
+      # plugin version for every dokken plugin.
+      plugin_version Kitchen::Driver::DOKKEN_VERSION
 
       default_config :docker_info do |transport|
         docker_info(transport[:docker_host_url])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-dokken
 version: !ruby/object:Gem::Version
-  version: 2.23.8
+  version: 2.25.0
 platform: ruby
 authors:
 - Sean OMeara
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-08-23 00:00:00.000000000 Z
+date: 2026-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docker-api
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '5'
@@ -60,7 +60,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '5'