kitchen-docker 2.14.0 → 3.0.0

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

@@ -1,172 +1,176 @@
-#
-# 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'
+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
+      # 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[/\$(.*?)(\/|$)/, 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
+      # rubocop:enable Metrics/ModuleLength, Style/Documentation
+    end
+  end
+end

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

@@ -34,12 +34,14 @@ module Kitchen
             gentoo_paludis_platform
           when 'opensuse/tumbleweed', 'opensuse/leap', 'opensuse', 'sles'
             opensuse_platform
-          when 'rhel', 'centos', 'oraclelinux', 'amazonlinux', 'rockylinux'
+          when 'rhel', 'centos', 'oraclelinux', 'amazonlinux'
             rhel_platform
           when 'centosstream'
             centosstream_platform
           when 'almalinux'
             almalinux_platform
+          when 'rockylinux'
+            rockylinux_platform
           when 'photon'
             photonos_platform
           else
@@ -105,7 +107,7 @@ module Kitchen
         def opensuse_platform
           <<-CODE
             ENV container docker
-            RUN zypper install -y sudo openssh which curl
+            RUN zypper install -y sudo openssh which curl gawk
             RUN /usr/sbin/sshd-gen-keys-start
           CODE
         end
@@ -140,6 +142,16 @@ module Kitchen
           CODE
         end
 
+        def rockylinux_platform
+          <<-CODE
+            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

data/test/integration/capabilities/{serverspec → disabled}/capabilities_drop_spec.rb

@@ -14,10 +14,11 @@
 # limitations under the License.
 #
 
-require 'serverspec'
-set :backend, :exec
+# 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
+# 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/{serverspec → disabled}/default_spec.rb

@@ -14,10 +14,11 @@
 # limitations under the License.
 #
 
-require 'serverspec'
-require 'spec_helper'
+# Disable now busser-serever 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
+# # 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/{serverspec → disabled}/spec_helper.rb

@@ -12,10 +12,10 @@
 # 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
+# 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

data/test/spec/spec_helper.rb

@@ -22,7 +22,7 @@ require 'simplecov'
 # Check for coverage stuffs
 formatters = []
 
-if ENV['CODECOV_TOKEN'] || ENV['TRAVIS']
+if ENV['CODECOV_TOKEN'] || ENV['CI']
   require 'codecov'
   formatters << SimpleCov::Formatter::Codecov
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-docker
 version: !ruby/object:Gem::Version
-  version: 2.14.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Sean Porter
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-13 00:00:00.000000000 Z
+date: 2023-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-kitchen
@@ -170,6 +170,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.0.2
+- !ruby/object:Gem::Dependency
+  name: chefstyle
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: kitchen-inspec
   requirement: !ruby/object:Gem::Requirement
@@ -213,11 +227,11 @@ extra_rdoc_files: []
 files:
 - ".cane"
 - ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".kitchen.windows.yml"
-- ".kitchen.yml"
+- ".rubocop.yml"
 - ".tailor"
-- ".travis.yml"
+- ".yamllint"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -225,6 +239,8 @@ files:
 - Rakefile
 - docker.ps1
 - kitchen-docker.gemspec
+- kitchen.windows.yml
+- kitchen.yml
 - lib/docker/version.rb
 - lib/kitchen/docker/container.rb
 - lib/kitchen/docker/container/linux.rb
@@ -241,9 +257,9 @@ files:
 - lib/kitchen/transport/docker.rb
 - lib/train/docker.rb
 - test/Dockerfile
-- test/integration/capabilities/serverspec/capabilities_drop_spec.rb
-- test/integration/default/serverspec/default_spec.rb
-- test/integration/default/serverspec/spec_helper.rb
+- test/integration/capabilities/disabled/capabilities_drop_spec.rb
+- test/integration/default/disabled/default_spec.rb
+- test/integration/default/disabled/spec_helper.rb
 - test/integration/inspec/inspec_spec.rb
 - test/spec/docker_spec.rb
 - test/spec/spec_helper.rb
@@ -272,9 +288,9 @@ specification_version: 4
 summary: A Docker Driver for Test Kitchen
 test_files:
 - test/Dockerfile
-- test/integration/capabilities/serverspec/capabilities_drop_spec.rb
-- test/integration/default/serverspec/default_spec.rb
-- test/integration/default/serverspec/spec_helper.rb
+- test/integration/capabilities/disabled/capabilities_drop_spec.rb
+- test/integration/default/disabled/default_spec.rb
+- test/integration/default/disabled/spec_helper.rb
 - test/integration/inspec/inspec_spec.rb
 - test/spec/docker_spec.rb
 - test/spec/spec_helper.rb

data/.kitchen.windows.yml

@@ -1,33 +0,0 @@
-<% # Make sure the local copy of the driver is loaded %>
-<% lib = File.expand_path('../lib', __FILE__) %>
-<% $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) %>
----
-driver:
-  name: docker
-  provision_command: 
-    - powershell -ExecutionPolicy Bypass -NoLogo -Command . { iwr -useb https://omnitruck.chef.io/install.ps1 } ^| iex; install
-    - powershell -Command $path=$env:Path + ';c:\opscode\chef\embedded\bin'; Set-ItemProperty -Path 'HKLM:\SYSTEM\CurrentControlSet\Control\Session Manager\Environment\' -Name Path -Value $path
-
-transport:
-  name: docker
-  socket: tcp://localhost:2375
-
-provisioner:
-  name: dummy
-
-platforms:
-- name: windows
-  driver_config:
-    image: mcr.microsoft.com/windows/servercore:1809
-    platform: windows
-
-suites:
-- name: default
-- name: context
-  driver:
-    build_context: false
-- name: inspec
-  driver:
-    provision_command: echo 1
-  verifier:
-    name: inspec

data/.kitchen.yml

@@ -1,65 +0,0 @@
-<% # Make sure the local copy of the driver is loaded %>
-<% lib = File.expand_path('../lib', __FILE__) %>
-<% $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) %>
----
-driver:
-  name: docker
-  provision_command: curl -L https://www.chef.io/chef/install.sh | bash
-
-transport:
-  name: docker
-
-provisioner:
-  name: dummy
-
-platforms:
-- name: amazonlinux-2
-- name: ubuntu-18.04
-- name: ubuntu-20.04
-- name: fedora-latest
-  driver:
-    provision_command:
-    - yum install libxcrypt-compat -y
-    - curl -L https://www.chef.io/chef/install.sh | bash
-- name: centos-7
-- name: oraclelinux-7
-- name: rockylinux-8
-- name: debian-9
-- name: debian-10
-- name: opensuse-15
-  driver:
-    image: opensuse/leap:15
-- name: dockerfile
-  driver:
-    username: dockerfile
-    password: dockerfile
-    dockerfile: test/Dockerfile
-    run_command: /sbin/init
-
-suites:
-- name: default
-  excludes: [arch, debian-9]
-- name: context
-  excludes: [arch, debian-9]
-  driver:
-    build_context: false
-- name: capabilities
-  includes: [debian-10,ubuntu-18.04,ubuntu-20.04]
-  driver:
-    provision_command:
-    - curl -L https://www.chef.io/chef/install.sh | bash
-    - apt-get install -y net-tools
-    cap_drop:
-    - NET_ADMIN
-- name: arm64
-  excludes: [debian-9]
-  driver:
-    docker_platform: linux/arm64
-- name: amd64
-  driver:
-    docker_platform: linux/amd64
-- name: inspec
-  driver:
-    provision_command: true
-  verifier:
-    name: inspec