kitchen-docker 2.15.0 → 3.2.3

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

@@ -1,172 +1,178 @@
-#
-# 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 'erb'
-require 'json'
-require 'shellwords'
-require 'tempfile'
-require 'uri'
-
-require 'kitchen'
-require 'kitchen/configurable'
-require_relative '../erb_context'
-require_relative 'cli_helper'
-
-module Kitchen
-  module Docker
-    module Helpers
-      module ContainerHelper
-        include Configurable
-        include Kitchen::Docker::Helpers::CliHelper
-
-        def parse_container_id(output)
-          container_id = output.chomp
-
-          unless [12, 64].include?(container_id.size)
-            raise ActionFailed, 'Could not parse Docker run output for container ID'
-          end
-
-          container_id
-        end
-
-        def dockerfile_template
-          template = IO.read(File.expand_path(config[:dockerfile]))
-          context = Kitchen::Docker::ERBContext.new(config.to_hash)
-          ERB.new(template).result(context.get_binding)
-        end
-
-        def remote_socket?
-          config[:socket] ? socket_uri.scheme == 'tcp' : false
-        end
-
-        def socket_uri
-          URI.parse(config[:socket])
-        end
-
-        def dockerfile_path(file)
-          config[:build_context] ? Pathname.new(file.path).relative_path_from(Pathname.pwd).to_s : file.path
-        end
-
-        def container_exists?(state)
-          state[:container_id] && !!docker_command("top #{state[:container_id]}") rescue false
-        end
-
-        def container_exec(state, command)
-          cmd = build_exec_command(state, command)
-          docker_command(cmd)
-        rescue => e
-          raise "Failed to execute command on Docker container. #{e}"
-        end
-
-        def create_dir_on_container(state, path)
-          path = replace_env_variables(state, path)
-          cmd = "mkdir -p #{path}"
-
-          if state[:platform].include?('windows')
-            psh = "-Command if(-not (Test-Path \'#{path}\')) { New-Item -Path \'#{path}\' -Force }"
-            cmd = build_powershell_command(psh)
-          end
-
-          cmd = build_exec_command(state, cmd)
-          docker_command(cmd)
-        rescue => e
-          raise "Failed to create directory #{path} on container. #{e}"
-        end
-
-        def copy_file_to_container(state, local_file, remote_file)
-          debug("Copying local file #{local_file} to #{remote_file} on container")
-
-          remote_file = replace_env_variables(state, remote_file)
-
-          remote_file = "#{state[:container_id]}:#{remote_file}"
-          cmd = build_copy_command(local_file, remote_file)
-          docker_command(cmd)
-        rescue => e
-          raise "Failed to copy file #{local_file} to container. #{e}"
-        end
-
-        def container_env_variables(state)
-          # Retrieves all environment variables from inside container
-          vars = {}
-
-          if state[:platform].include?('windows')
-            cmd = build_powershell_command('-Command [System.Environment]::GetEnvironmentVariables() ^| ConvertTo-Json')
-            cmd = build_exec_command(state, cmd)
-            stdout = docker_command(cmd, suppress_output: !logger.debug?).strip
-            vars = ::JSON.parse(stdout)
-          else
-            cmd = build_exec_command(state, 'printenv')
-            stdout = docker_command(cmd, suppress_output: !logger.debug?).strip
-            stdout.split("\n").each { |line| vars[line.split('=')[0]] = line.split('=')[1] }
-          end
-
-          vars
-        end
-
-        def replace_env_variables(state, str)
-          if str.include?('$env:')
-            key = str[/\$env:(.*?)(\\|$)/, 1]
-            value = container_env_variables(state)[key].to_s.strip
-            str = str.gsub("$env:#{key}", value)
-          elsif str.include?('$')
-            key = str[/\$(.*?)(\/|$)/, 1]
-            value = container_env_variables(state)[key].to_s.strip
-            str = str.gsub("$#{key}", value)
-          end
-
-          str
-        end
-
-        def run_container(state, transport_port = nil)
-          cmd = build_run_command(state[:image_id], transport_port)
-          output = docker_command(cmd)
-          parse_container_id(output)
-        end
-
-        def container_ip_address(state)
-          cmd = "inspect --format '{{ .NetworkSettings.IPAddress }}'"
-          cmd << " #{state[:container_id]}"
-          docker_command(cmd).strip
-        rescue
-          raise ActionFailed, 'Error getting internal IP of Docker container'
-        end
-
-        def remove_container(state)
-          container_id = state[:container_id]
-          docker_command("stop -t 0 #{container_id}")
-          docker_command("rm #{container_id}")
-        end
-
-        def dockerfile_proxy_config
-          env_variables = ''
-          if config[:http_proxy]
-            env_variables << "ENV http_proxy #{config[:http_proxy]}\n"
-            env_variables << "ENV HTTP_PROXY #{config[:http_proxy]}\n"
-          end
-
-          if config[:https_proxy]
-            env_variables << "ENV https_proxy #{config[:https_proxy]}\n"
-            env_variables << "ENV HTTPS_PROXY #{config[:https_proxy]}\n"
-          end
-
-          if config[:no_proxy]
-            env_variables << "ENV no_proxy #{config[:no_proxy]}\n"
-            env_variables << "ENV NO_PROXY #{config[:no_proxy]}\n"
-          end
-
-          env_variables
-        end
-      end
-    end
-  end
-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.
+
+require "erb" unless defined?(Erb)
+require "json" unless defined?(JSON)
+require "shellwords" unless defined?(Shellwords)
+require "tempfile" unless defined?(Tempfile)
+require "uri" unless defined?(URI)
+
+require "kitchen"
+require "kitchen/configurable"
+require_relative "../erb_context"
+require_relative "cli_helper"
+
+module Kitchen
+  module Docker
+    module Helpers
+      # rubocop:disable Metrics/ModuleLength, Style/Documentation
+      module ContainerHelper
+        include Configurable
+        include Kitchen::Docker::Helpers::CliHelper
+
+        def parse_container_id(output)
+          container_id = output.chomp
+
+          unless [12, 64].include?(container_id.size)
+            raise ActionFailed, "Could not parse Docker run output for container ID"
+          end
+
+          container_id
+        end
+
+        def dockerfile_template
+          template = IO.read(File.expand_path(config[:dockerfile]))
+          context = Kitchen::Docker::ERBContext.new(config.to_hash)
+          ERB.new(template).result(context.get_binding)
+        end
+
+        def remote_socket?
+          config[:socket] ? socket_uri.scheme == "tcp" : false
+        end
+
+        def socket_uri
+          URI.parse(config[:socket])
+        end
+
+        def dockerfile_path(file)
+          config[:build_context] ? Pathname.new(file.path).relative_path_from(Pathname.pwd).to_s : file.path
+        end
+
+        def container_exists?(state)
+          state[:container_id] && !!docker_command("top #{state[:container_id]}") rescue false
+        end
+
+        def container_exec(state, command)
+          cmd = build_exec_command(state, command)
+          docker_command(cmd)
+        rescue => e
+          raise "Failed to execute command on Docker container. #{e}"
+        end
+
+        def create_dir_on_container(state, path)
+          path = replace_env_variables(state, path)
+          cmd = "mkdir -p #{path}"
+
+          if state[:platform].include?("windows")
+            psh = "-Command if(-not (Test-Path '#{path}')) { New-Item -Path '#{path}' -Force }"
+            cmd = build_powershell_command(psh)
+          end
+
+          cmd = build_exec_command(state, cmd)
+          docker_command(cmd)
+        rescue => e
+          raise "Failed to create directory #{path} on container. #{e}"
+        end
+
+        def copy_file_to_container(state, local_file, remote_file)
+          debug("Copying local file #{local_file} to #{remote_file} on container")
+
+          remote_file = replace_env_variables(state, remote_file)
+
+          remote_file = "#{state[:container_id]}:#{remote_file}"
+          cmd = build_copy_command(local_file, remote_file)
+          docker_command(cmd)
+        rescue => e
+          raise "Failed to copy file #{local_file} to container. #{e}"
+        end
+
+        # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        def container_env_variables(state)
+          # Retrieves all environment variables from inside container
+          vars = {}
+
+          if state[:platform].include?("windows")
+            cmd = build_powershell_command("-Command [System.Environment]::GetEnvironmentVariables() ^| ConvertTo-Json")
+            cmd = build_exec_command(state, cmd)
+            stdout = docker_command(cmd, suppress_output: !logger.debug?).strip
+            vars = ::JSON.parse(stdout)
+          else
+            cmd = build_exec_command(state, "printenv")
+            stdout = docker_command(cmd, suppress_output: !logger.debug?).strip
+            stdout.split("\n").each { |line| vars[line.split("=")[0]] = line.split("=")[1] }
+          end
+
+          vars
+        end
+        # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+        def replace_env_variables(state, str)
+          if str.include?("$env:")
+            key = str[/\$env:(.*?)(\\|$)/, 1]
+            value = container_env_variables(state)[key].to_s.strip
+            str = str.gsub("$env:#{key}", value)
+          elsif str.include?("$")
+            key = str[%r{\$(.*?)(/|$)}, 1]
+            value = container_env_variables(state)[key].to_s.strip
+            str = str.gsub("$#{key}", value)
+          end
+
+          str
+        end
+
+        def run_container(state, transport_port = nil)
+          cmd = build_run_command(state[:image_id], transport_port)
+          output = docker_command(cmd)
+          parse_container_id(output)
+        end
+
+        def container_ip_address(state)
+          cmd = "inspect --format '{{ .NetworkSettings.IPAddress }}'"
+          cmd << " #{state[:container_id]}"
+          docker_command(cmd).strip
+        rescue
+          raise ActionFailed, "Error getting internal IP of Docker container"
+        end
+
+        def remove_container(state)
+          container_id = state[:container_id]
+          docker_command("stop -t 0 #{container_id}")
+          docker_command("rm #{container_id}")
+        end
+
+        # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        def dockerfile_proxy_config
+          env_variables = ""
+          if config[:http_proxy]
+            env_variables << "ENV http_proxy=#{config[:http_proxy]}\n"
+            env_variables << "ENV HTTP_PROXY=#{config[:http_proxy]}\n"
+          end
+
+          if config[:https_proxy]
+            env_variables << "ENV https_proxy=#{config[:https_proxy]}\n"
+            env_variables << "ENV HTTPS_PROXY=#{config[:https_proxy]}\n"
+          end
+
+          if config[:no_proxy]
+            env_variables << "ENV no_proxy=#{config[:no_proxy]}\n"
+            env_variables << "ENV NO_PROXY=#{config[:no_proxy]}\n"
+          end
+
+          env_variables
+        end
+        # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+      end
+      # rubocop:enable Metrics/ModuleLength, Style/Documentation
+    end
+  end
+end

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

@@ -11,38 +11,40 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'kitchen'
-require 'kitchen/configurable'
+require "kitchen"
+require "kitchen/configurable"
 
 module Kitchen
   module Docker
     module Helpers
-      module DockerfileHelper     
+      module DockerfileHelper
         include Configurable
 
         def dockerfile_platform
           case config[:platform]
-          when 'arch'
+          when "arch"
             arch_platform
-          when 'debian', 'ubuntu'
+          when "debian", "ubuntu"
             debian_platform
-          when 'fedora'
+          when "fedora"
             fedora_platform
-          when 'gentoo'
+          when "gentoo"
             gentoo_platform
-          when 'gentoo-paludis'
+          when "gentoo-paludis"
             gentoo_paludis_platform
-          when 'opensuse/tumbleweed', 'opensuse/leap', 'opensuse', 'sles'
+          when "opensuse/tumbleweed", "opensuse/leap", "opensuse", "sles"
             opensuse_platform
-          when 'rhel', 'centos', 'oraclelinux', 'amazonlinux'
+          when "rhel", "centos", "oraclelinux"
             rhel_platform
-          when 'centosstream'
+          when "amazonlinux"
+            amazonlinux_platform
+          when "centosstream"
             centosstream_platform
-          when 'almalinux'
+          when "almalinux"
             almalinux_platform
-          when 'rockylinux'
+          when "rockylinux"
             rockylinux_platform
-          when 'photon'
+          when "photon"
             photonos_platform
           else
             raise ActionFailed, "Unknown platform '#{config[:platform]}'"
@@ -50,15 +52,11 @@ module Kitchen
         end
 
         def arch_platform
-          # See https://bugs.archlinux.org/task/47052 for why we
-          # blank out limits.conf.
           <<-CODE
             RUN pacman --noconfirm -Sy archlinux-keyring
             RUN pacman-db-upgrade
             RUN pacman --noconfirm -Syu openssl openssh sudo curl
             RUN [ -f "/etc/ssh/ssh_host_rsa_key" ] || ssh-keygen -A -t rsa -f /etc/ssh/ssh_host_rsa_key
-            RUN [ -f "/etc/ssh/ssh_host_dsa_key" ] || ssh-keygen -A -t dsa -f /etc/ssh/ssh_host_dsa_key
-            RUN echo >/etc/security/limits.conf
           CODE
         end
 
@@ -68,8 +66,8 @@ module Kitchen
                 && ln -sf /bin/true /sbin/initctl
           CODE
           packages = <<-CODE
-            ENV DEBIAN_FRONTEND noninteractive
-            ENV container docker
+            ENV DEBIAN_FRONTEND=noninteractive
+            ENV container=docker
             RUN apt-get update
             RUN apt-get install -y sudo openssh-server curl lsb-release
           CODE
@@ -78,11 +76,10 @@ module Kitchen
 
         def fedora_platform
           <<-CODE
-            ENV container docker
+            ENV container=docker
             RUN dnf clean all
             RUN dnf install -y sudo openssh-server openssh-clients which curl
             RUN [ -f "/etc/ssh/ssh_host_rsa_key" ] || ssh-keygen -t rsa -f /etc/ssh/ssh_host_rsa_key -N ''
-            RUN [ -f "/etc/ssh/ssh_host_dsa_key" ] || ssh-keygen -t dsa -f /etc/ssh/ssh_host_dsa_key -N ''
           CODE
         end
 
@@ -91,7 +88,6 @@ module Kitchen
             RUN emerge-webrsync
             RUN emerge --quiet --noreplace net-misc/openssh app-admin/sudo
             RUN [ -f "/etc/ssh/ssh_host_rsa_key" ] || ssh-keygen -A -t rsa -f /etc/ssh/ssh_host_rsa_key
-            RUN [ -f "/etc/ssh/ssh_host_dsa_key" ] || ssh-keygen -A -t dsa -f /etc/ssh/ssh_host_dsa_key
           CODE
         end
 
@@ -100,13 +96,12 @@ module Kitchen
             RUN cave sync
             RUN cave resolve -zx net-misc/openssh app-admin/sudo
             RUN [ -f "/etc/ssh/ssh_host_rsa_key" ] || ssh-keygen -A -t rsa -f /etc/ssh/ssh_host_rsa_key
-            RUN [ -f "/etc/ssh/ssh_host_dsa_key" ] || ssh-keygen -A -t dsa -f /etc/ssh/ssh_host_dsa_key
           CODE
         end
 
         def opensuse_platform
           <<-CODE
-            ENV container docker
+            ENV container=docker
             RUN zypper install -y sudo openssh which curl gawk
             RUN /usr/sbin/sshd-gen-keys-start
           CODE
@@ -114,47 +109,52 @@ module Kitchen
 
         def rhel_platform
           <<-CODE
-            ENV container docker
+            ENV container=docker
             RUN yum clean all
             RUN yum install -y sudo openssh-server openssh-clients which curl
             RUN [ -f "/etc/ssh/ssh_host_rsa_key" ] || ssh-keygen -t rsa -f /etc/ssh/ssh_host_rsa_key -N ''
-            RUN [ -f "/etc/ssh/ssh_host_dsa_key" ] || ssh-keygen -t dsa -f /etc/ssh/ssh_host_dsa_key -N ''
+          CODE
+        end
+
+        def amazonlinux_platform
+          <<-CODE
+            ENV container=docker
+            RUN yum clean all
+            RUN yum install -y --allowerasing sudo openssh-server openssh-clients which curl
+            RUN [ -f "/etc/ssh/ssh_host_rsa_key" ] || ssh-keygen -t rsa -f /etc/ssh/ssh_host_rsa_key -N ''
           CODE
         end
 
         def centosstream_platform
           <<-CODE
-            ENV container docker
+            ENV container=docker
             RUN yum clean all
             RUN yum install -y sudo openssh-server openssh-clients which
             RUN [ -f "/etc/ssh/ssh_host_rsa_key" ] || ssh-keygen -t rsa -f /etc/ssh/ssh_host_rsa_key -N ''
-            RUN [ -f "/etc/ssh/ssh_host_dsa_key" ] || ssh-keygen -t dsa -f /etc/ssh/ssh_host_dsa_key -N ''
           CODE
         end
 
         def almalinux_platform
           <<-CODE
-            ENV container docker
+            ENV container=docker
             RUN yum clean all
             RUN yum install -y sudo openssh-server openssh-clients which
             RUN [ -f "/etc/ssh/ssh_host_rsa_key" ] || ssh-keygen -t rsa -f /etc/ssh/ssh_host_rsa_key -N ''
-            RUN [ -f "/etc/ssh/ssh_host_dsa_key" ] || ssh-keygen -t dsa -f /etc/ssh/ssh_host_dsa_key -N ''
           CODE
         end
 
         def rockylinux_platform
           <<-CODE
-            ENV container docker
+            ENV container=docker
             RUN yum clean all
             RUN yum install -y sudo openssh-server openssh-clients which
             RUN [ -f "/etc/ssh/ssh_host_rsa_key" ] || ssh-keygen -t rsa -f /etc/ssh/ssh_host_rsa_key -N ''
-            RUN [ -f "/etc/ssh/ssh_host_dsa_key" ] || ssh-keygen -t dsa -f /etc/ssh/ssh_host_dsa_key -N ''
           CODE
         end
 
         def photonos_platform
           <<-CODE
-            ENV container docker
+            ENV container=docker
             RUN tdnf clean all
             RUN tdnf install -y sudo openssh-server openssh-clients which curl
             RUN [ -f "/etc/ssh/ssh_host_ecdsa_key" ] || ssh-keygen -t ecdsa -f /etc/ssh/ssh_host_ecdsa_key -N ''

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

@@ -11,7 +11,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'fileutils'
+require "fileutils" unless defined?(FileUtils)
 
 module Kitchen
   module Docker
@@ -19,14 +19,14 @@ module Kitchen
       module FileHelper
         def create_temp_file(file, contents)
           debug("[Docker] Creating temp file #{file}")
-          debug('[Docker] --- Start Temp File Contents ---')
+          debug("[Docker] --- Start Temp File Contents ---")
           debug(contents)
-          debug('[Docker] --- End Temp File Contents ---')
+          debug("[Docker] --- End Temp File Contents ---")
 
           begin
             path = ::File.dirname(file)
             ::FileUtils.mkdir_p(path) unless ::Dir.exist?(path)
-            file = ::File.open(file, 'w')
+            file = ::File.open(file, "w")
             file.write(contents)
           rescue IOError => e
             raise "Failed to write temp file. Error Details: #{e}"

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

@@ -11,11 +11,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'kitchen'
-require 'kitchen/configurable'
-require 'pathname'
-require_relative 'cli_helper'
-require_relative 'container_helper'
+require "kitchen"
+require "kitchen/configurable"
+require "pathname" unless defined?(Pathname)
+require_relative "cli_helper"
+require_relative "container_helper"
 
 module Kitchen
   module Docker
@@ -28,38 +28,52 @@ module Kitchen
         def parse_image_id(output)
           output.split("\n").reverse_each do |line|
             if line =~ /writing image (sha256:[[:xdigit:]]{64})(?: \d*\.\ds)? done/i
-              img_id = line[/writing image (sha256:[[:xdigit:]]{64})(?: \d*\.\ds)? done/i,1]
+              img_id = line[/writing image (sha256:[[:xdigit:]]{64})(?: \d*\.\ds)? done/i, 1]
               return img_id
             end
             if line =~ /image id|build successful|successfully built/i
               img_id = line.split(/\s+/).last
               return img_id
             end
+            # Docker ~v4.31 support
+            if line =~ /naming to moby-dangling@(sha256:[[:xdigit:]]{64})(?: \d*\.\ds)? done/i
+              img_id = line[/naming to moby-dangling@(sha256:[[:xdigit:]]{64})(?: \d*\.\ds)? done/i, 1]
+              return img_id
+            end
           end
-          raise ActionFailed, 'Could not parse Docker build output for image ID'
+          raise ActionFailed, "Could not parse Docker build output for image ID"
         end
 
         def remove_image(state)
           image_id = state[:image_id]
-          docker_command("rmi #{image_id}")
+          if image_in_use?(state)
+            info("[Docker] Image ID #{image_id} is in use. Skipping removal")
+          else
+            info("[Docker] Removing image with Image ID #{image_id}.")
+            docker_command("rmi #{image_id}")
+          end
+        end
+
+        def image_in_use?(state)
+          docker_command("ps -a", suppress_output: !logger.debug?).include?(state[:image_id])
         end
 
         def build_image(state, dockerfile)
-          cmd = 'build'
-          cmd << ' --no-cache' unless config[:use_cache]
+          cmd = "build"
+          cmd << " --no-cache" unless config[:use_cache]
           cmd << " --platform=#{config[:docker_platform]}" if config[:docker_platform]
           extra_build_options = config_to_options(config[:build_options])
           cmd << " #{extra_build_options}" unless extra_build_options.empty?
           dockerfile_contents = dockerfile
-          file = Tempfile.new('Dockerfile-kitchen', Pathname.pwd + config[:build_tempdir])
+          file = Tempfile.new("Dockerfile-kitchen", Pathname.pwd + config[:build_tempdir])
           cmd << " -f #{Shellwords.escape(dockerfile_path(file))}" if config[:build_context]
-          build_context = config[:build_context] ? '.' : '-'
+          build_context = config[:build_context] ? "." : "-"
           output = begin
                      file.write(dockerfile)
                      file.close
                      docker_command("#{cmd} #{build_context}",
-                                    input: dockerfile_contents,
-                                    environment: { BUILDKIT_PROGRESS: 'plain' })
+                       input: dockerfile_contents,
+                       environment: { BUILDKIT_PROGRESS: "plain" })
                    ensure
                      file.close unless file.closed?
                      file.unlink