kitchen-docker 2.15.0 → 3.2.3

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

@@ -1,40 +1,62 @@
-#
-# 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.
-
-# This helper should be removed when the kitchen-inspec gem has been updated to include these runner options
-begin
-  require 'kitchen/verifier/inspec'
-
-  # Add runner options for Docker transport for kitchen-inspec gem
-  module Kitchen
-    module Docker
-      module Helpers
-        module InspecHelper
-          Kitchen::Verifier::Inspec.class_eval do
-            def runner_options_for_docker(config_data)
-              opts = {
-                'backend' => 'docker',
-                'logger' => logger,
-                'host' => config_data[:container_id],
-              }
-              logger.debug "Connect to Container: #{opts['host']}"
-              opts
-            end
-          end
-        end
-      end
-    end
-  end
-rescue LoadError => e
-  logger.debug("[Docker] kitchen-inspec gem not found for InSpec verifier. #{e}")
-end
+#
+# 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.
+
+# This helper patches kitchen-inspec and/or kitchen-cinc-auditor to add Docker
+# transport support. Remove once upstream gems include this natively.
+
+# Patch kitchen-inspec if available
+begin
+  require "kitchen/verifier/inspec"
+  Kitchen::Verifier::Inspec.class_eval do
+    def runner_options_for_docker(config_data)
+      opts = {
+        "backend" => "docker",
+        "logger" => logger,
+        "host" => config_data[:container_id],
+      }
+      logger.debug "Connect to Container: #{opts["host"]}"
+      opts
+    end
+  end
+rescue LoadError
+  # kitchen-inspec not available; skipping patch
+end
+
+# Patch kitchen-cinc-auditor if available
+begin
+  require "kitchen/verifier/cinc_auditor"
+  Kitchen::Verifier::CincAuditor::TransportOptions.class_eval do
+    def build_docker(state)
+      options = {
+        "backend" => "docker",
+        "logger" => logger,
+        "host" => state[:container_id],
+      }
+      logger.debug("Connect to Container: #{options["host"]}")
+      options
+    end
+  end
+rescue LoadError
+  # kitchen-cinc-auditor not available; skipping patch
+end
+
+module Kitchen
+  module Docker
+    module Helpers
+      # Marker module included by the Docker transport Connection class.
+      # Actual verifier patches are applied directly to verifier classes above.
+      module InspecHelper
+      end
+    end
+  end
+end

data/lib/kitchen/driver/docker.rb

@@ -13,17 +13,17 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'kitchen'
-require 'json'
-require 'securerandom'
-require 'net/ssh'
+require "kitchen"
+require "json" unless defined?(JSON)
+require "securerandom" unless defined?(SecureRandom)
+require "net/ssh" unless defined?(Net::SSH)
 
-require 'kitchen/driver/base'
+require "kitchen/driver/base"
 
-require_relative '../docker/container/linux'
-require_relative '../docker/container/windows'
-require_relative '../docker/helpers/cli_helper'
-require_relative '../docker/helpers/container_helper'
+require_relative "../docker/container/linux"
+require_relative "../docker/container/windows"
+require_relative "../docker/helpers/cli_helper"
+require_relative "../docker/helpers/container_helper"
 
 module Kitchen
   module Driver
@@ -35,7 +35,7 @@ module Kitchen
       include Kitchen::Docker::Helpers::ContainerHelper
       include ShellOut
 
-      default_config :binary,        'docker'
+      default_config :binary,        "docker"
       default_config :build_options, nil
       default_config :build_tempdir, Dir.pwd
       default_config :cap_add,       nil
@@ -44,9 +44,9 @@ module Kitchen
       default_config :env_variables, nil
       default_config :isolation,     nil
       default_config :interactive,   false
-      default_config :private_key,   File.join(Dir.pwd, '.kitchen', 'docker_id_rsa')
+      default_config :private_key,   File.join(Dir.pwd, ".kitchen", "docker_id_rsa")
       default_config :privileged,    false
-      default_config :public_key,    File.join(Dir.pwd, '.kitchen', 'docker_id_rsa.pub')
+      default_config :public_key,    File.join(Dir.pwd, ".kitchen", "docker_id_rsa.pub")
       default_config :publish_all,   false
       default_config :remove_images, false
       default_config :run_options,   nil
@@ -66,43 +66,39 @@ module Kitchen
         !driver.remote_socket?
       end
 
-      default_config :image do |driver|
-        driver.default_image
-      end
+      default_config :image, &:default_image
 
       default_config :instance_name do |driver|
         # Borrowed from kitchen-rackspace
         [
-          driver.instance.name.gsub(/\W/, ''),
-          (Etc.getlogin || 'nologin').gsub(/\W/, ''),
-          Socket.gethostname.gsub(/\W/, '')[0..20],
-          Array.new(8) { rand(36).to_s(36) }.join
-        ].join('-').downcase
+          driver.instance.name.gsub(/\W/, ""),
+          (Etc.getlogin || "nologin").gsub(/\W/, ""),
+          Socket.gethostname.gsub(/\W/, "")[0..20],
+          Array.new(8) { rand(36).to_s(36) }.join,
+        ].join("-").downcase
       end
 
-      default_config :platform do |driver|
-        driver.default_platform
-      end
+      default_config :platform, &:default_platform
 
       default_config :run_command do |driver|
         if driver.windows_os?
           # Launch arbitrary process to keep the Windows container alive
           # If running in interactive mode, launch powershell.exe instead
           if driver[:interactive]
-            'powershell.exe'
+            "powershell.exe"
           else
-            'ping -t localhost'
+            "ping -t localhost"
           end
         else
-          '/usr/sbin/sshd -D -o UseDNS=no -o UsePAM=no -o PasswordAuthentication=yes '\
-          '-o UsePrivilegeSeparation=no -o PidFile=/tmp/sshd.pid'
+          "/usr/sbin/sshd -D -o UseDNS=no -o UsePAM=no -o PasswordAuthentication=yes " \
+          "-o UsePrivilegeSeparation=no -o PidFile=/tmp/sshd.pid"
         end
       end
 
       default_config :socket do |driver|
-        socket = 'unix:///var/run/docker.sock'
-        socket = 'npipe:////./pipe/docker_engine' if driver.windows_os?
-        ENV['DOCKER_HOST'] || socket
+        socket = "unix:///var/run/docker.sock"
+        socket = "npipe:////./pipe/docker_engine" if Gem.win_platform?
+        ENV["DOCKER_HOST"] || socket
       end
 
       default_config :username do |driver|
@@ -111,14 +107,14 @@ module Kitchen
         if driver.windows_os?
           nil
         else
-          'kitchen'
+          "kitchen"
         end
       end
 
       def verify_dependencies
         run_command("#{config[:binary]} >> #{dev_null} 2>&1", quiet: true, use_sudo: config[:use_sudo])
       rescue
-        raise UserError, 'You must first install the Docker CLI tool https://www.docker.com/get-started'
+        raise UserError, "You must first install the Docker CLI tool https://www.docker.com/get-started"
       end
 
       def create(state)
@@ -133,22 +129,20 @@ module Kitchen
 
       def wait_for_transport(state)
         if config[:wait_for_transport]
-          instance.transport.connection(state) do |conn|
-            conn.wait_until_ready
-          end
+          instance.transport.connection(state, &:wait_until_ready)
         end
       end
 
       def default_image
-        platform, release = instance.platform.name.split('-')
-        if platform == 'centos' && release
-          release = 'centos' + release.split('.').first
+        platform, release = instance.platform.name.split("-")
+        if platform == "centos" && release
+          release = "centos" + release.split(".").first
         end
-        release ? [platform, release].join(':') : platform
+        release ? [platform, release].join(":") : platform
       end
 
       def default_platform
-        instance.platform.name.split('-').first
+        instance.platform.name.split("-").first
       end
 
       protected

data/lib/kitchen/transport/docker.rb

@@ -11,25 +11,24 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'kitchen'
+require "kitchen"
 
-require_relative '../docker/container/linux'
-require_relative '../docker/container/windows'
+require_relative "../docker/container/linux"
+require_relative "../docker/container/windows"
 
-require_relative '../docker/helpers/inspec_helper'
+require_relative "../docker/helpers/inspec_helper"
 
-require_relative '../../docker/version.rb'
-require_relative '../../train/docker.rb'
+# require_relative "../../docker/version"
 
 module Kitchen
   module Transport
     class Docker < Kitchen::Transport::Base
       class DockerFailed < TransportFailed; end
 
-      kitchen_transport_api_version 1
+      # kitchen_transport_api_version 1
       plugin_version Kitchen::VERSION
 
-      default_config :binary,        'docker'
+      default_config :binary,        "docker"
       default_config :env_variables, nil
       default_config :interactive,   false
       default_config :privileged,    false
@@ -42,16 +41,16 @@ module Kitchen
       default_config :working_dir,   nil
 
       default_config :socket do |transport|
-        socket = 'unix:///var/run/docker.sock'
-        socket = 'npipe:////./pipe/docker_engine' if transport.windows_os?
-        ENV['DOCKER_HOST'] || socket
+        socket = "unix:///var/run/docker.sock"
+        socket = "npipe:////./pipe/docker_engine" if Gem.win_platform?
+        ENV["DOCKER_HOST"] || socket
       end
 
       default_config :temp_dir do |transport|
         if transport.windows_os?
-          '$env:TEMP'
+          "$env:TEMP"
         else
-          '/tmp'
+          "/tmp"
         end
       end
 
@@ -61,7 +60,7 @@ module Kitchen
         if transport.windows_os?
           nil
         else
-          'kitchen'
+          "kitchen"
         end
       end
 
@@ -73,7 +72,7 @@ module Kitchen
         # This allows Windows systems to use the TCP socket for the InSpec verifier
         # See the lib/docker.rb file here: https://github.com/swipely/docker-api/blob/master/lib/docker.rb
         # default_socket_url is set to a Unix socket and env_url requires an environment variable to be set
-        ENV['DOCKER_HOST'] = options[:socket] if !options[:socket].nil? && ENV['DOCKER_HOST'].nil?
+        ENV["DOCKER_HOST"] = options[:socket] if !options[:socket].nil? && ENV["DOCKER_HOST"].nil?
 
         Kitchen::Transport::Docker::Connection.new(options, &block)
       end
@@ -98,7 +97,7 @@ module Kitchen
         end
 
         def container
-          @container ||= if @options[:platform].include?('windows')
+          @container ||= if @options[:platform].include?("windows")
                            Kitchen::Docker::Container::Windows.new(@options)
                          else
                            Kitchen::Docker::Container::Linux.new(@options)

data/release-please-config.json

@@ -0,0 +1,12 @@
+{
+  "packages": {
+    ".": {
+      "package-name": "kitchen-docker",
+      "changelog-path": "CHANGELOG.md",
+      "release-type": "ruby",
+      "include-component-in-tag": false,
+      "version-file": "lib/kitchen/docker/docker_version.rb"
+    }
+  },
+  "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"
+}

data/renovate.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:recommended",
+    ":disableDependencyDashboard",
+    "schedule:automergeEarlyMondays"
+  ]
+}

data/spec/docker_spec.rb

@@ -0,0 +1,108 @@
+#
+# 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.
+#
+
+require "spec_helper"
+
+describe Kitchen::Driver::Docker do
+  describe "#config_to_options" do
+    let(:config) {}
+    subject { described_class.new.send(:config_to_options, config) }
+
+    context "with nil" do
+      let(:config) { nil }
+      it { is_expected.to eq "" }
+    end # /context with nil
+
+    context "with a string" do
+      let(:config) { "--foo" }
+      it { is_expected.to eq "--foo" }
+    end # /context with a string
+
+    context "with a string with spaces" do
+      let(:config) { "--foo bar" }
+      it { is_expected.to eq "--foo bar" }
+    end # /context with a string with spaces
+
+    context "with an array of strings" do
+      let(:config) { %w{--foo --bar} }
+      it { is_expected.to eq "--foo --bar" }
+    end # /context with an array of strings
+
+    context "with an array of hashes" do
+      let(:config) { [{ foo: "bar" }, { other: "baz" }] }
+      it { is_expected.to eq "--foo=bar --other=baz" }
+    end # /context with an array of hashes
+
+    context "with a hash of strings" do
+      let(:config) { { foo: "bar", other: "baz" } }
+      it { is_expected.to eq "--foo=bar --other=baz" }
+    end # /context with a hash of strings
+
+    context "with a hash of arrays" do
+      let(:config) { { foo: %w{bar baz} } }
+      it { is_expected.to eq "--foo=bar --foo=baz" }
+    end # /context with a hash of arrays
+
+    context "with a hash of strings with spaces" do
+      let(:config) { { foo: "bar two", other: "baz" } }
+      it { is_expected.to eq '--foo=bar\\ two --other=baz' }
+    end # /context with a hash of strings with spaces
+  end # /describe #config_to_options
+
+  describe "socket default config logic" do
+    def resolve_socket
+      socket = "unix:///var/run/docker.sock"
+      socket = "npipe:////./pipe/docker_engine" if Gem.win_platform?
+      ENV["DOCKER_HOST"] || socket
+    end
+
+    context "on a non-Windows host without DOCKER_HOST set" do
+      before do
+        allow(Gem).to receive(:win_platform?).and_return(false)
+        allow(ENV).to receive(:[]).and_call_original
+        allow(ENV).to receive(:[]).with("DOCKER_HOST").and_return(nil)
+      end
+
+      it "uses the Unix socket" do
+        expect(resolve_socket).to eq("unix:///var/run/docker.sock")
+      end
+    end
+
+    context "on a Windows host without DOCKER_HOST set" do
+      before do
+        allow(Gem).to receive(:win_platform?).and_return(true)
+        allow(ENV).to receive(:[]).and_call_original
+        allow(ENV).to receive(:[]).with("DOCKER_HOST").and_return(nil)
+      end
+
+      it "uses the Windows named pipe" do
+        expect(resolve_socket).to eq("npipe:////./pipe/docker_engine")
+      end
+    end
+
+    context "when DOCKER_HOST env var is set" do
+      before do
+        allow(Gem).to receive(:win_platform?).and_return(false)
+        allow(ENV).to receive(:[]).and_call_original
+        allow(ENV).to receive(:[]).with("DOCKER_HOST").and_return("tcp://192.168.1.1:2375")
+      end
+
+      it "uses DOCKER_HOST over the default socket" do
+        expect(resolve_socket).to eq("tcp://192.168.1.1:2375")
+      end
+    end
+  end
+end

data/spec/dockerfile_helper_spec.rb

@@ -0,0 +1,109 @@
+#
+# 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/docker/helpers/dockerfile_helper"
+
+describe Kitchen::Docker::Helpers::DockerfileHelper do
+  let(:helper_class) do
+    Class.new do
+      include Kitchen::Docker::Helpers::DockerfileHelper
+      attr_accessor :config
+
+      def initialize(config = {})
+        @config = config
+      end
+    end
+  end
+
+  let(:helper) { helper_class.new(platform:) }
+
+  describe "#amazonlinux_platform" do
+    let(:platform) { "amazonlinux" }
+
+    it "includes --allowerasing flag for yum install" do
+      result = helper.amazonlinux_platform
+      expect(result).to include("yum install -y --allowerasing")
+    end
+
+    it "installs required packages including curl" do
+      result = helper.amazonlinux_platform
+      expect(result).to include("sudo openssh-server openssh-clients which curl")
+    end
+
+    it "sets container environment variable" do
+      result = helper.amazonlinux_platform
+      expect(result).to include("ENV container=docker")
+    end
+
+    it "generates SSH host key if missing" do
+      result = helper.amazonlinux_platform
+      expect(result).to include("ssh-keygen -t rsa -f /etc/ssh/ssh_host_rsa_key")
+    end
+  end
+
+  describe "#rhel_platform" do
+    let(:platform) { "rhel" }
+
+    it "does not include --allowerasing flag" do
+      result = helper.rhel_platform
+      expect(result).not_to include("--allowerasing")
+    end
+
+    it "installs required packages including curl" do
+      result = helper.rhel_platform
+      expect(result).to include("sudo openssh-server openssh-clients which curl")
+    end
+  end
+
+  describe "#dockerfile_platform" do
+    context "when platform is amazonlinux" do
+      let(:platform) { "amazonlinux" }
+
+      it "calls amazonlinux_platform method" do
+        expect(helper).to receive(:amazonlinux_platform).and_call_original
+        result = helper.dockerfile_platform
+        expect(result).to include("--allowerasing")
+      end
+    end
+
+    context "when platform is rhel" do
+      let(:platform) { "rhel" }
+
+      it "calls rhel_platform method" do
+        expect(helper).to receive(:rhel_platform).and_call_original
+        result = helper.dockerfile_platform
+        expect(result).not_to include("--allowerasing")
+      end
+    end
+
+    context "when platform is centos" do
+      let(:platform) { "centos" }
+
+      it "calls rhel_platform method" do
+        expect(helper).to receive(:rhel_platform).and_call_original
+        helper.dockerfile_platform
+      end
+    end
+
+    context "when platform is oraclelinux" do
+      let(:platform) { "oraclelinux" }
+
+      it "calls rhel_platform method" do
+        expect(helper).to receive(:rhel_platform).and_call_original
+        helper.dockerfile_platform
+      end
+    end
+  end
+end

data/spec/inspec_helper_spec.rb

@@ -0,0 +1,58 @@
+require "spec_helper"
+require "logger"
+
+RSpec.describe "inspec_helper patches" do
+  let(:helper_path) { File.expand_path("../lib/kitchen/docker/helpers/inspec_helper.rb", __dir__) }
+
+  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
+        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
+        expect(defined?(Kitchen::Verifier::Inspec)).to be_falsy
+      end
+    end
+
+    context "when kitchen-inspec is not available" do
+      before do
+        allow(Kernel).to receive(:require).and_call_original
+        allow(Kernel).to receive(:require).with("kitchen/verifier/inspec").and_raise(LoadError)
+        allow(Kernel).to receive(:require).with("kitchen/verifier/cinc_auditor").and_raise(LoadError)
+      end
+
+      it "does not raise when loading the helper" do
+        expect { load helper_path }.not_to raise_error
+      end
+    end
+  end
+
+  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
+        expect(Kitchen::Verifier::CincAuditor::TransportOptions.method_defined?(:build_docker)).to be true
+      end
+    else
+      it "Kitchen::Verifier::CincAuditor not available — patch correctly skipped" do
+        expect(defined?(Kitchen::Verifier::CincAuditor)).to be_falsy
+      end
+    end
+
+    context "when kitchen-cinc-auditor is not available" do
+      before do
+        allow(Kernel).to receive(:require).and_call_original
+        allow(Kernel).to receive(:require).with("kitchen/verifier/inspec").and_raise(LoadError)
+        allow(Kernel).to receive(:require).with("kitchen/verifier/cinc_auditor").and_raise(LoadError)
+      end
+
+      it "does not raise when loading the helper" do
+        expect { load helper_path }.not_to raise_error
+      end
+    end
+  end
+end