kitchen-docker 3.2.3 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c9d06e9cc15a17fcaa0658c0cb33719baf0bbe46211269975ae66dbf5bfed4c
-  data.tar.gz: 367a618236ccbcb315dbe8d69cec049f7f26b5bcd35c640f7dea6d5c5528aed5
+  metadata.gz: bffcdd4042f9756abb662c1b2aa0bc19d6a7651687a1872db254f664da282ee2
+  data.tar.gz: fb6c25bcc54d6f8a46dbec8c62066183867a8ebc728c2e55d735313964e29c3a
 SHA512:
-  metadata.gz: b17b6a8042a54d09b0e77ef0955d41d3e7b4574e1c634429b1a8a5c06dfed9d02ad86b03d86588f11f328897ae028e0925fbcf4b30b014d3ad81f0670017b80e
-  data.tar.gz: 4821086d0078af8b2919010e7373646922cb17e2549be27537572004f4c95ff7ac39c7fd39a61e1607bbff50e8090d564f309dd168f11b0d3560b242bbd7e1c9
+  metadata.gz: baa8f6f4df650a981a5cfe265359484f799580d56a23227a3f139240cd83ac1ec5e6a9f705cf9d0aab255481fc94f48660d040b51d1b13656b413718e9df9a62
+  data.tar.gz: 5e53bd5e0418b900412615d0455eb1cdd6746dc18e558a2b13f7300c02d46c9ababb5a93a7bf998ea9c073e3b8687db9fa504ab8ada2595380f33035bfa80a86

data/.gitignore

@@ -20,3 +20,5 @@ tmp
 Dockerfile
 .DS_Store
 vendor/
+bin/*
+.idea/*

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "3.2.3"
+  ".": "3.3.0"
 }

data/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 Future CHANGELOG notes will be in GitHub release notes
 
+## [3.3.0](https://github.com/test-kitchen/kitchen-docker/compare/v3.2.4...v3.3.0) (2026-08-22)
+
+
+### Features
+
+* Support `kitchen login` with the Docker transport ([#462](https://github.com/test-kitchen/kitchen-docker/issues/462)) ([ba9b75e](https://github.com/test-kitchen/kitchen-docker/commit/ba9b75e8187eea72316dc91dbe3aec41221055bf))
+
+## [3.2.4](https://github.com/test-kitchen/kitchen-docker/compare/v3.2.3...v3.2.4) (2026-07-28)
+
+
+### Bug Fixes
+
+* Avoid curl conflict with RHEL ubi in dockerfile helper ([#458](https://github.com/test-kitchen/kitchen-docker/issues/458)) ([028ce4c](https://github.com/test-kitchen/kitchen-docker/commit/028ce4c6ebdde7727f0e8aea7ae1a998f73f6eb8))
+
 ## [3.2.3](https://github.com/test-kitchen/kitchen-docker/compare/v3.2.2...v3.2.3) (2026-06-25)
 
 

data/Gemfile

@@ -1,7 +1,6 @@
 source "https://rubygems.org"
 
-gemspec
-
+gemspec development_group: :test
 group :development do
   # Integration testing gems.
   gem "kitchen-cinc-auditor", git: "https://github.com/test-kitchen/kitchen-cinc-auditor.git"
@@ -11,7 +10,6 @@ group :development do
 end
 
 group :test do
-  gem "bundler"
   gem "rake"
   gem "rspec", "~> 3.2"
   gem "rspec-its", "~> 2.0"

data/README.md

@@ -1,6 +1,5 @@
 # Kitchen-Docker
 
-[![Build Status](https://travis-ci.org/test-kitchen/kitchen-docker.svg?branch=master)](https://travis-ci.org/test-kitchen/kitchen-docker)
 [![Gem Version](https://img.shields.io/gem/v/kitchen-docker.svg)](https://rubygems.org/gems/kitchen-docker)
 [![Coverage](https://img.shields.io/codecov/c/github/test-kitchen/kitchen-docker.svg)](https://codecov.io/github/test-kitchen/kitchen-docker)
 [![License](https://img.shields.io/badge/license-Apache_2-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
@@ -628,6 +627,22 @@ Examples:
   docker_platform: linux/amd64
 ```
 
+## Logging into a container
+
+`kitchen login` opens an interactive shell inside a running container using the
+Docker transport, so you do not need to look up the container ID and run
+`docker exec` by hand:
+
+```bash
+kitchen login default-ubuntu-2404
+```
+
+The session runs `docker exec` against the instance's container. On Linux
+platforms it starts `/bin/bash --login -i`; on Windows platforms it starts
+`powershell`. The transport's `username`, `working_dir`, `env_variables` and
+`privileged` settings are honoured, so the shell matches the environment that
+Test Kitchen uses when it runs the provisioner.
+
 ## Development
 
 * Source hosted at [GitHub][repo]
@@ -667,6 +682,6 @@ limitations under the License.
 [docker_installation]:    https://docs.docker.com/installation/#installation
 [docker_index]:           https://index.docker.io/
 [test_kitchen_docs]:      https://kitchen.ci/docs/getting-started/introduction/
-[chef_omnibus_dl]:        https://downloads.chef.io/chef-client/
+[chef_omnibus_dl]:        https://downloads.chef.io/tools/infra-client
 [cpu_shares]:             https://docs.fedoraproject.org/en-US/Fedora/17/html/Resource_Management_Guide/sec-cpu.html
 [memory_limit]:           https://docs.fedoraproject.org/en-US/Fedora/17/html/Resource_Management_Guide/sec-memory.html

data/kitchen-docker.gemspec

@@ -3,14 +3,15 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "kitchen/docker/docker_version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "kitchen-docker"
+  spec.name = "kitchen-docker"
+  spec.required_ruby_version = ">= 3.1"
   spec.version       = Kitchen::Docker::DOCKER_VERSION
   spec.authors       = ["Sean Porter"]
   spec.email         = ["portertech@gmail.com"]
   spec.description   = %q{A Docker Driver for Test Kitchen}
   spec.summary       = spec.description
   spec.homepage      = "https://github.com/test-kitchen/kitchen-docker"
-  spec.license       = "Apache 2.0"
+  spec.license       = "Apache-2.0"
 
   spec.files         = `git ls-files`.split($/)
   spec.require_paths = ["lib"]

data/lib/kitchen/docker/docker_version.rb

@@ -16,6 +16,6 @@
 module Kitchen
   module Docker
     # Version string for Docker Kitchen driver
-    DOCKER_VERSION = "3.2.3".freeze
+    DOCKER_VERSION = "3.3.0".freeze
   end
 end

data/lib/kitchen/docker/helpers/dockerfile_helper.rb

@@ -111,7 +111,8 @@ module Kitchen
           <<-CODE
             ENV container=docker
             RUN yum clean all
-            RUN yum install -y sudo openssh-server openssh-clients which curl
+            RUN yum install -y sudo openssh-server openssh-clients which
+            RUN which curl || yum install -y curl
             RUN [ -f "/etc/ssh/ssh_host_rsa_key" ] || ssh-keygen -t rsa -f /etc/ssh/ssh_host_rsa_key -N ''
           CODE
         end

data/lib/kitchen/transport/docker.rb

@@ -97,13 +97,62 @@ module Kitchen
         end
 
         def container
-          @container ||= if @options[:platform].include?("windows")
+          @container ||= if windows_container?
                            Kitchen::Docker::Container::Windows.new(@options)
                          else
                            Kitchen::Docker::Container::Linux.new(@options)
                          end
           @container
         end
+
+        # (see Base::Connection#login_command)
+        def login_command
+          argv = build_login_command
+          LoginCommand.new(argv.first, argv.drop(1))
+        end
+
+        private
+
+        def windows_container?
+          @options[:platform].to_s.include?("windows")
+        end
+
+        # Builds the argv array for an interactive `docker exec` session.
+        #
+        # Kitchen hands the result to `Kernel.exec` in its multi-argument form,
+        # which bypasses the shell entirely. Every flag and its value therefore
+        # has to be its own token -- a packed "-H unix:///var/run/docker.sock"
+        # would reach Docker as a single argument -- and values must not be
+        # quoted, since there is no shell to strip the quotes back off.
+        #
+        # @return [Array<String>] the docker command and its arguments
+        def build_login_command
+          docker = [@options[:binary]]
+          docker.push("-H", @options[:socket]) if @options[:socket]
+          docker << "--tls" if @options[:tls]
+          docker << "--tlsverify" if @options[:tls_verify]
+          docker << "--tlscacert=#{@options[:tls_cacert]}" if @options[:tls_cacert]
+          docker << "--tlscert=#{@options[:tls_cert]}" if @options[:tls_cert]
+          docker << "--tlskey=#{@options[:tls_key]}" if @options[:tls_key]
+
+          # Always attached, always a TTY: a detached or non-interactive exec
+          # would hand back a session the user cannot type into.
+          cmd = ["exec"]
+          cmd << "--privileged" if @options[:privileged]
+          cmd.push("-t", "-i")
+          Hash(@options[:env_variables]).each { |key, value| cmd.push("-e", "#{key}=#{value}") }
+          cmd.push("-u", @options[:username]) if @options[:username]
+          cmd.push("-w", @options[:working_dir]) if @options[:working_dir]
+          cmd << @options[:container_id]
+          cmd.concat(login_shell)
+
+          logger.debug("build_login_command: #{(docker + cmd).join(" ")}")
+          docker + cmd
+        end
+
+        def login_shell
+          windows_container? ? ["powershell"] : ["/bin/bash", "--login", "-i"]
+        end
       end
     end
   end

data/spec/dockerfile_helper_spec.rb

@@ -61,9 +61,10 @@ describe Kitchen::Docker::Helpers::DockerfileHelper do
       expect(result).not_to include("--allowerasing")
     end
 
-    it "installs required packages including curl" do
+    it "installs required packages including curl if needed" do
       result = helper.rhel_platform
-      expect(result).to include("sudo openssh-server openssh-clients which curl")
+      expect(result).to include("sudo openssh-server openssh-clients which")
+      expect(result).to include("which curl || yum install -y curl")
     end
   end
 

data/spec/inspec_helper_spec.rb

@@ -7,12 +7,15 @@ RSpec.describe "inspec_helper patches" do
   describe "kitchen-inspec patch" do
     # Test actual post-load state rather than trying to stub Kernel.require,
     # which does not intercept require calls made inside a load'd file in Ruby 3.4.
-    if defined?(Kitchen::Verifier::Inspec)
-      it "adds runner_options_for_docker to Kitchen::Verifier::Inspec" do
+    # The availability check has to happen inside the example: RSpec loads every
+    # spec file before running any example, so a load-time `defined?` would be
+    # decided by whichever spec file happened to require the verifier first.
+    it "patches Kitchen::Verifier::Inspec when the gem is available" do
+      load helper_path
+
+      if defined?(Kitchen::Verifier::Inspec)
         expect(Kitchen::Verifier::Inspec.method_defined?(:runner_options_for_docker)).to be true
-      end
-    else
-      it "Kitchen::Verifier::Inspec not available — patch correctly skipped" do
+      else
         expect(defined?(Kitchen::Verifier::Inspec)).to be_falsy
       end
     end
@@ -32,13 +35,13 @@ RSpec.describe "inspec_helper patches" do
 
   describe "kitchen-cinc-auditor patch" do
     # Test actual post-load state rather than trying to stub Kernel.require.
-    if defined?(Kitchen::Verifier::CincAuditor) &&
-        defined?(Kitchen::Verifier::CincAuditor::TransportOptions)
-      it "adds build_docker to Kitchen::Verifier::CincAuditor::TransportOptions" do
+    # Checked inside the example for the same load-order reason as above.
+    it "patches Kitchen::Verifier::CincAuditor::TransportOptions when the gem is available" do
+      load helper_path
+
+      if defined?(Kitchen::Verifier::CincAuditor::TransportOptions)
         expect(Kitchen::Verifier::CincAuditor::TransportOptions.method_defined?(:build_docker)).to be true
-      end
-    else
-      it "Kitchen::Verifier::CincAuditor not available — patch correctly skipped" do
+      else
         expect(defined?(Kitchen::Verifier::CincAuditor)).to be_falsy
       end
     end

data/spec/spec_helper.rb

@@ -21,7 +21,7 @@ require "rspec/its"
 require "kitchen/driver/docker"
 
 RSpec.configure do |config|
-  # Basic configuraiton
+  # Basic configuration
   config.run_all_when_everything_filtered = true
   config.filter_run(:focus)
 

data/spec/transport_docker_spec.rb

@@ -0,0 +1,123 @@
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require "spec_helper"
+require "kitchen/transport/docker"
+
+describe Kitchen::Transport::Docker::Connection do
+  let(:options) do
+    {
+      binary: "docker",
+      container_id: "abc123",
+      platform: "ubuntu-24.04",
+      socket: "unix:///var/run/docker.sock",
+      username: "kitchen",
+    }
+  end
+
+  subject(:connection) { described_class.new(options) }
+
+  describe "#login_command" do
+    subject(:login_command) { connection.login_command }
+
+    it "returns a Kitchen::LoginCommand" do
+      expect(login_command).to be_a(Kitchen::LoginCommand)
+    end
+
+    it "execs the docker binary" do
+      expect(login_command.command).to eq "docker"
+    end
+
+    it "opens an interactive login shell on a Linux container" do
+      expect(login_command.arguments).to eq %w{
+        -H unix:///var/run/docker.sock
+        exec -t -i -u kitchen abc123 /bin/bash --login -i
+      }
+    end
+
+    it "passes each flag and its value as separate argv tokens" do
+      expect(login_command.arguments).to include("-H", "unix:///var/run/docker.sock")
+      expect(login_command.arguments).not_to include("-H unix:///var/run/docker.sock")
+    end
+
+    context "on a Windows container" do
+      let(:options) do
+        {
+          binary: "docker",
+          container_id: "abc123",
+          platform: "windows-2022",
+          socket: "tcp://localhost:2375",
+          username: nil,
+        }
+      end
+
+      it "opens a PowerShell session instead of bash" do
+        expect(login_command.arguments).to eq %w{
+          -H tcp://localhost:2375
+          exec -t -i abc123 powershell
+        }
+      end
+    end
+
+    context "with TLS configured" do
+      before do
+        options.merge!(
+          tls: true,
+          tls_verify: true,
+          tls_cacert: "/certs/ca.pem",
+          tls_cert: "/certs/cert.pem",
+          tls_key: "/certs/key.pem"
+        )
+      end
+
+      it "includes the TLS flags before the exec subcommand" do
+        expect(login_command.arguments.take(8)).to eq %w{
+          -H unix:///var/run/docker.sock
+          --tls --tlsverify
+          --tlscacert=/certs/ca.pem
+          --tlscert=/certs/cert.pem
+          --tlskey=/certs/key.pem
+          exec
+        }
+      end
+    end
+
+    context "with a working directory and environment variables" do
+      before do
+        options.merge!(working_dir: "/opt/kitchen", env_variables: { FOO: "bar" })
+      end
+
+      it "passes them through to docker exec" do
+        expect(login_command.arguments).to include("-w", "/opt/kitchen")
+        expect(login_command.arguments).to include("-e", "FOO=bar")
+      end
+    end
+
+    context "when the transport is configured to detach" do
+      before { options.merge!(detach: true) }
+
+      it "still runs attached so the session is usable" do
+        expect(login_command.arguments).not_to include("-d")
+      end
+    end
+
+    context "when the transport is configured as privileged" do
+      before { options.merge!(privileged: true) }
+
+      it "keeps the privileged flag" do
+        expect(login_command.arguments).to include("--privileged")
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-docker
 version: !ruby/object:Gem::Version
-  version: 3.2.3
+  version: 3.3.0
 platform: ruby
 authors:
 - Sean Porter
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-06-25 00:00:00.000000000 Z
+date: 2026-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-kitchen
@@ -74,20 +74,18 @@ files:
 - spec/dockerfile_helper_spec.rb
 - spec/inspec_helper_spec.rb
 - spec/spec_helper.rb
+- spec/transport_docker_spec.rb
 - test/Dockerfile
 - test/cookbooks/cinc_test/metadata.rb
 - test/cookbooks/cinc_test/recipes/default.rb
 - test/cookbooks/docker_test/attributes/default.rb
 - test/cookbooks/docker_test/metadata.rb
 - test/cookbooks/docker_test/recipes/default.rb
-- test/integration/capabilities/disabled/capabilities_drop_spec.rb
 - test/integration/cinc/inspec/cinc_spec.rb
-- test/integration/default/disabled/default_spec.rb
-- test/integration/default/disabled/spec_helper.rb
 - test/integration/inspec/inspec_spec.rb
 homepage: https://github.com/test-kitchen/kitchen-docker
 licenses:
-- Apache 2.0
+- Apache-2.0
 metadata: {}
 post_install_message:
 rdoc_options: []
@@ -97,7 +95,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/test/integration/capabilities/disabled/capabilities_drop_spec.rb

@@ -1,24 +0,0 @@
-#
-# Copyright 2016, Noah Kantrowitz
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-# Disable now busser-serever is gone.
-# require 'serverspec'
-# set :backend, :exec
-
-# describe command('/sbin/ifconfig eth0 multicast') do
-#   its(:exit_status) { is_expected.to_not eq 0 }
-#   its(:stderr) { is_expected.to match /Operation not permitted/ }
-# end

data/test/integration/default/disabled/default_spec.rb

@@ -1,24 +0,0 @@
-#
-# Copyright 2016, Noah Kantrowitz
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-# Disable now busser-server is gone.
-# require "serverspec"
-# require "spec_helper"
-#
-# Just make sure the image launched and is reachable.
-# describe command("true") do
-#   its(:exit_status) { is_expected.to eq 0 }
-# end

data/test/integration/default/disabled/spec_helper.rb

@@ -1,21 +0,0 @@
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-# case RbConfig::CONFIG['host_os']
-# when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
-#   set :backend, :cmd
-#   set :os, :family => 'windows'
-# else
-#   set :backend, :exec
-# end