kitchen-dokken 2.23.5 → 2.23.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed64ab202db24ce243e1a4c26083a924b194aec6a3cc448c88de450d6e53e091
-  data.tar.gz: d252f250ec7bc1af41500443d3c2edf295b622d0222467fc9a1bb1edc552b065
+  metadata.gz: c9cac8cad07f229a018567a935e33aaa71edaa04c65dd05a38afbcd10bc839e4
+  data.tar.gz: 971a897b24f4a00f224d995f18ae7177712110ed4048d2a9d02fb03fcd8948a4
 SHA512:
-  metadata.gz: df9c8ca5f29d747dc3e4838338f793e46cc4ea3138db6fbd9f4cd65ce0a94cbf3a2a62a0417fd312b399258d378bd046d6659a55fcc982264a6908587ccee049
-  data.tar.gz: dd0477b6314e4ae2efc3b529b77cad5408493b157bd49471205edfdc5a6eaf464feb51a12928259195c80ce14c65d22e39a13c017e7de0105569e02606e8c858
+  metadata.gz: 578aca5a5d479624c15313d7d6695d8ea42f75e5822ed55f3c083bb9b561b5b0e1378fa0e27964b0444cfd93f1db63eb5d6fc3b124ac977683b792735bfae7d2
+  data.tar.gz: 2bf35be1a50b68a4de9ac5e0d8ac674904165a65f730b472b30c488b9c786890d740586fc7189bf21f22d95fe49cb1bcb2be33456ae37bb43b25d144f3c02854

data/lib/kitchen/driver/dokken.rb

@@ -543,7 +543,8 @@ module Kitchen
         return unless self[:network_mode] == "dokken"
 
         with_file_lock("#{home_dir}/.dokken-network.lock") do
-          with_retries { ::Docker::Network.get("dokken", {}, docker_connection) }
+          network = with_retries { ::Docker::Network.get("dokken", {}, docker_connection) }
+          warn_on_ipv6_mismatch(network)
         rescue ::Docker::Error::NotFoundError
           begin
             with_retries { ::Docker::Network.create("dokken", network_settings) }
@@ -553,6 +554,34 @@ module Kitchen
         end
       end
 
+      # Say something when the shared network cannot honour `ipv6: true`.
+      #
+      # The dokken network is created once and shared by every instance, and
+      # `destroy` deliberately leaves it behind -- so on any workstation that
+      # has run a non-ipv6 suite, it already exists without ipv6. Since the
+      # network is only created when absent, a later `ipv6: true` suite
+      # quietly reuses it, the container gets no ipv6 address, and nothing
+      # anywhere says why.
+      #
+      # Deliberately a warning rather than an error: the network may be in use
+      # by other instances right now, and removing it is the user's call.
+      #
+      # @param network [::Docker::Network] the existing dokken network
+      # @return [void]
+      def warn_on_ipv6_mismatch(network)
+        return unless self[:ipv6]
+
+        # A daemon that does not report the flag must not produce a warning on
+        # every converge.
+        enabled = network.info["EnableIPv6"] if network.respond_to?(:info)
+        return if enabled.nil? || enabled
+
+        warn "The existing dokken network was created without IPv6, so `ipv6: true` " \
+             "will have no effect and this instance will get no IPv6 address. The " \
+             "network is shared and `kitchen destroy` leaves it in place; recreate it " \
+             "with `docker network rm dokken` once no containers are using it."
+      end
+
       # Build the data image, unless it is already present.
       #
       # @return [void]
@@ -776,7 +805,11 @@ module Kitchen
         with_retries { @image = ::Docker::Image.get(name, { "platform" => oci_platform(config[:platform]) }, docker_connection) }
         with_retries { @image.remove(force: true) }
       rescue ::Docker::Error::DockerError
-        puts "Image #{name} not found. Nothing to delete."
+        # `debug`, not `puts`: this is routine during destroy, and writing
+        # straight to stdout puts it outside kitchen's logging entirely --
+        # it bypasses the log level, never reaches `.kitchen/logs`, and
+        # interleaves with kitchen's own output.
+        debug "Image #{name} not found. Nothing to delete."
       end
 
       # Whether the daemon knows about a container.
@@ -850,7 +883,7 @@ module Kitchen
       # @raise [RuntimeError] if the container could not be created
       def create_container(args, platform: nil)
         with_retries { @container = ::Docker::Container.get(args["name"], {}, docker_connection) }
-      rescue
+      rescue ::Docker::Error::NotFoundError
         with_retries do
           # Merge rather than append: start_runner_container passes config[:env]
           # straight through, so mutating args["Env"] would edit the driver's

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.5".freeze
+    DOKKEN_VERSION = "2.23.7".freeze
   end
 end

data/lib/kitchen/helpers.rb

@@ -253,17 +253,30 @@ module Dokken
       "#{home_dir}/.dokken/verifier_sandbox/#{instance_name}"
     end
 
-    # A container-safe, collision-free name for this kitchen instance.
+    # A container-safe, collision-free name for a kitchen instance.
     #
     # The working directory is hashed into the prefix so that the same suite
     # in two checkouts does not fight over one set of containers.
     #
+    # Defined on the module itself because Kitchen's Provisioner and Verifier
+    # base classes need the same answer but do not mix this module in -- they
+    # used to carry their own copies of these two lines, and three copies of
+    # a container-naming rule is three chances for them to drift apart.
+    #
+    # @param instance [Object] the kitchen instance
     # @return [String] the instance name
-    def instance_name
+    def self.instance_name_for(instance)
       prefix = (Digest::SHA2.hexdigest FileUtils.pwd)[0, 10]
       "#{prefix}-#{instance.name}".downcase
     end
 
+    # (see Dokken::Helpers.instance_name_for)
+    #
+    # @return [String] the instance name
+    def instance_name
+      ::Dokken::Helpers.instance_name_for(instance)
+    end
+
     # The `ExposedPorts` value for the runner container.
     #
     # @return [Hash, nil] a Docker API ExposedPorts hash
@@ -453,7 +466,12 @@ module Dokken
     def running_inside_docker_desktop?
       Resolv.getaddress "host.docker.internal."
       true
-    rescue
+    # Deliberately every StandardError, spelled out rather than bare. This is
+    # a probe: "can I resolve host.docker.internal" has exactly two useful
+    # answers, and a DNS timeout or a SocketError must be "no" rather than
+    # something that aborts a converge. Listing Resolv::ResolvError as well
+    # would be redundant -- it is a StandardError already.
+    rescue ::StandardError
       false
     end
 
@@ -521,8 +539,7 @@ module Kitchen
       # @return [String] the instance name
       # @see Dokken::Helpers#instance_name
       def instance_name
-        prefix = (Digest::SHA2.hexdigest FileUtils.pwd)[0, 10]
-        "#{prefix}-#{instance.name}".downcase
+        ::Dokken::Helpers.instance_name_for(instance)
       end
     end
   end
@@ -557,8 +574,7 @@ module Kitchen
       # @return [String] the instance name
       # @see Dokken::Helpers#instance_name
       def instance_name
-        prefix = (Digest::SHA2.hexdigest FileUtils.pwd)[0, 10]
-        "#{prefix}-#{instance.name}".downcase
+        ::Dokken::Helpers.instance_name_for(instance)
       end
 
       # Run the verifier against the instance.

data/lib/kitchen/provisioner/dokken.rb

@@ -79,7 +79,17 @@ module Kitchen
         create_sandbox
         write_run_command(run_command)
         instance.transport.connection(state) do |conn|
-          if remote_docker_host? || running_inside_docker?
+          # Gate on what the driver recorded, not on a fresh probe. The driver
+          # already answered this at create time -- it built a data container
+          # or it did not -- and re-deriving the answer here means the two can
+          # disagree. Point DOCKER_HOST somewhere else between `kitchen
+          # create` and `kitchen converge` and they do: this side decides to
+          # upload, the container it would upload through was never created,
+          # and the transport dies on nil several frames down.
+          #
+          # Kitchen::Verifier::Base#call has always gated on the recorded
+          # state; this is the provisioner agreeing with it.
+          unless state[:data_container].nil?
             info("Transferring files to #{instance.to_str}")
             conn.upload(sandbox_dirs, config[:root_path])
           end
@@ -204,7 +214,7 @@ module Kitchen
       # @return [String] the container name
       # @api private
       def runner_container_name
-        instance.name.to_s
+        instance_name.to_s
       end
 
       # Empty the sandbox after a converge, keeping the directory itself.

data/lib/kitchen/transport/dokken.rb

@@ -121,6 +121,17 @@ module Kitchen
         # @raise [Kitchen::UserError] if docker_host_url is not tcp:// or unix://
         # @raise [Kitchen::Transport::TransportFailed] if the copy fails
         def upload(locals, remote)
+          # Every route through ssh_endpoint reads the data container out of
+          # state, so being handed none is not a transfer that fails -- it is
+          # a caller that should not have asked. Said plainly here rather than
+          # as `undefined method '[]' for nil` from three frames down.
+          if options[:data_container].nil?
+            raise Kitchen::Transport::TransportFailed,
+              "Cannot upload to #{options[:instance_name]}: no data container was created " \
+              "for this instance. Files are only shipped over ssh when the docker daemon " \
+              "cannot read the local filesystem; otherwise the sandbox is bind-mounted."
+          end
+
           ssh_ip, ssh_port = ssh_endpoint
 
           debug "ssh_ip : #{ssh_ip}"
@@ -477,7 +488,11 @@ module Kitchen
       # @return [TrueClass,FalseClass]
       def docker_for_mac_or_win?
         ::Docker.info(::Docker::Connection.new(config[:docker_host_url], {}))["Name"] == "docker-desktop"
-      rescue
+      # `::StandardError`, spelled out. This method lives inside module
+      # Kitchen, where a bare `StandardError` resolves to
+      # Kitchen::StandardError -- which Excon::Error::Socket is not, so an
+      # unreachable daemon would escape instead of answering "no".
+      rescue ::StandardError
         false
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-dokken
 version: !ruby/object:Gem::Version
-  version: 2.23.5
+  version: 2.23.7
 platform: ruby
 authors:
 - Sean OMeara