kitchen-dokken 2.19.0 → 2.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: becf7bcb14b565a4e38ef71339232b99d6cb2196918462f66007d77efcc49e62
-  data.tar.gz: e68938ec9d01a83c72456b3fd51c0af5ec0d81e9092695b11df9e487bfde8fc0
+  metadata.gz: 7968068f2971454ab8aae38e6a448c513bb094b908fdbd98272b545ed4eb84ed
+  data.tar.gz: cff7edf63103c4337eddd245b1ee8a247516c1cb67c45d14747e143b652d1522
 SHA512:
-  metadata.gz: fbac5749ab791a90968ccfd9ff5d11667ea8d5ad9801146a451cd8fe979db215460506e4a8810bc7b2a8129213a321665f9c5fc26bc461c0135427eff6648da7
-  data.tar.gz: d26c39d6be05058de8e86ff9c10cf8576fc44ea1999f55c8bc0c1b9b6c013abcda5103233f48a788e2164ed9c5cb49928b3947674adccc26ce500998c6f96e6a
+  metadata.gz: 3b82a6d24f3ceb8619c8ee4ac3b0f72156efa678dead489fbe812ae3bb8114a864a89ed794aa70dd0a5e7d0f94daf7cd7cdabbca69302c8df0f1ef9f9e4af2a3
+  data.tar.gz: be4ebb93a209623830ec4333d82dd82d845ae1e5077c65a60a5bb771665eef897d97d8c84536e21c498a2ef6722357cacd40d0e7691ce9ba852a624a8edd774b

data/Gemfile

@@ -0,0 +1,19 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in kitchen-dokken.gemspec
+gemspec
+
+group :test do
+  gem "berkshelf"
+  gem "kitchen-inspec"
+  gem "rake", ">= 11.0"
+end
+
+group :development do
+  gem "pry"
+  gem "pry-byebug"
+end
+
+group :chefstyle do
+  gem "chefstyle", "2.2.3"
+end

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "chefstyle"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new(:style) do |task|
+  task.options += ["--display-cop-names", "--no-color"]
+end
+
+task default: %i{style}

data/kitchen-dokken.gemspec

@@ -0,0 +1,23 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "kitchen/driver/dokken_version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "kitchen-dokken"
+  spec.version       = Kitchen::Driver::DOKKEN_VERSION
+  spec.authors       = ["Sean OMeara"]
+  spec.email         = ["sean@sean.io"]
+  spec.description   = "A Test Kitchen Driver for Docker & Chef Infra optimized for rapid testing using Chef Infra docker images"
+  spec.summary       = "A Test Kitchen Driver for Docker & Chef Infra optimized for rapid testing using Chef Infra docker images"
+  spec.homepage      = "https://github.com/test-kitchen/kitchen-dokken"
+  spec.license       = "Apache-2.0"
+
+  spec.files         = %w{LICENSE kitchen-dokken.gemspec Gemfile Rakefile} + Dir.glob("lib/**/*")
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.7"
+
+  spec.add_dependency "docker-api", ">= 1.33", "< 3"
+  spec.add_dependency "lockfile", "~> 2.1"
+  spec.add_dependency "test-kitchen", ">= 1.15", "< 4"
+end

data/lib/kitchen/driver/dokken.rb

@@ -69,6 +69,7 @@ module Kitchen
       default_config :userns_host, false
       default_config :volumes, nil
       default_config :write_timeout, 3600
+      default_config :user_ns_mode, nil
       default_config :creds_file, nil
       default_config :docker_config_creds, false
 
@@ -90,7 +91,7 @@ module Kitchen
         # data
         dokken_create_sandbox
 
-        if remote_docker_host?
+        if remote_docker_host? || running_inside_docker?
           make_data_image
           start_data_container state
         end
@@ -106,7 +107,7 @@ module Kitchen
       end
 
       def destroy(_state)
-        if remote_docker_host?
+        if remote_docker_host? || running_inside_docker?
           stop_data_container
           delete_data_container
         end
@@ -232,15 +233,13 @@ module Kitchen
       end
 
       def work_image
-        return "#{image_prefix}/#{instance_name}" unless image_prefix.nil?
-
-        instance_name
+        [image_prefix, instance_name].compact.join("/").downcase
       end
 
       def dokken_binds
         ret = []
-        ret << "#{dokken_kitchen_sandbox}:/opt/kitchen" unless dokken_kitchen_sandbox.nil? || remote_docker_host?
-        ret << "#{dokken_verifier_sandbox}:/opt/verifier" unless dokken_verifier_sandbox.nil? || remote_docker_host?
+        ret << "#{dokken_kitchen_sandbox}:/opt/kitchen" unless dokken_kitchen_sandbox.nil? || remote_docker_host? || running_inside_docker?
+        ret << "#{dokken_verifier_sandbox}:/opt/verifier" unless dokken_verifier_sandbox.nil? || remote_docker_host? || running_inside_docker?
         ret << Array(config[:binds]) unless config[:binds].nil?
         ret.flatten
       end
@@ -289,7 +288,7 @@ module Kitchen
       def dokken_volumes_from
         ret = []
         ret << chef_container_name
-        ret << data_container_name if remote_docker_host?
+        ret << data_container_name if remote_docker_host? || running_inside_docker?
         ret
       end
 
@@ -337,6 +336,15 @@ module Kitchen
         if self[:userns_host]
           config["HostConfig"]["UsernsMode"] = "host"
         end
+
+        if self[:privileged]
+          if self[:user_ns_mode] != "host"
+            debug "driver - privileged mode is not supported with user namespaces enabled"
+            debug "driver - changing UsernsMode from '#{self[:user_ns_mode]}' to 'host'"
+          end
+          config["HostConfig"]["UsernsMode"] = "host"
+        end
+
         runner_container = run_container(config)
         state[:runner_container] = runner_container.json
       end
@@ -441,11 +449,23 @@ module Kitchen
         @docker_config_creds = {}
         config_file = ::File.join(::Dir.home, ".docker", "config.json")
         if ::File.exist?(config_file)
-          JSON.load_file!(config_file)["auths"].each do |k, v|
-            next if v["auth"].nil?
+          config = JSON.load_file!(config_file)
+          if config["auths"]
+            config["auths"].each do |k, v|
+              next if v["auth"].nil?
+
+              username, password = Base64.decode64(v["auth"]).split(":")
+              @docker_config_creds[k] = { serveraddress: k, username: username, password: password }
+            end
+          end
 
-            username, password = Base64.decode64(v["auth"]).split(":")
-            @docker_config_creds[k] = { serveraddress: k, username: username, password: password }
+          if config["credHelpers"]
+            config["credHelpers"].each do |k, v|
+              @docker_config_creds[k] = Proc.new do
+                c = JSON.parse(`echo #{k} | docker-credential-#{v} get`)
+                { serveraddress: c["ServerURL"], username: c["Username"], password: c["Secret"] }
+              end
+            end
           end
         else
           debug("~/.docker/config.json does not exist")
@@ -462,7 +482,8 @@ module Kitchen
         # NOTE: Try to use DockerHub auth if exact registry match isn't found
         default_registry = "https://index.docker.io/v1/"
         if docker_config_creds.key?(image_registry)
-          docker_config_creds[image_registry]
+          c = docker_config_creds[image_registry]
+          c.respond_to?(:call) ? c.call : c
         elsif docker_config_creds.key?(default_registry)
           docker_config_creds[default_registry]
         end

data/lib/kitchen/driver/dokken_version.rb

@@ -18,6 +18,6 @@
 module Kitchen
   module Driver
     # Version string for Dokken Kitchen driver
-    DOKKEN_VERSION = "2.19.0".freeze
+    DOKKEN_VERSION = "2.20.0".freeze
   end
 end

data/lib/kitchen/helpers.rb

@@ -3,6 +3,7 @@ module Dokken
     # https://stackoverflow.com/questions/517219/ruby-see-if-a-port-is-open
     require "socket" unless defined?(Socket)
     require "timeout" unless defined?(Timeout)
+    require "resolv" unless defined?(Resolv)
 
     def port_open?(ip, port)
       begin
@@ -170,7 +171,7 @@ module Dokken
 
     def instance_name
       prefix = (Digest::SHA2.hexdigest FileUtils.pwd)[0, 10]
-      "#{prefix}-#{instance.name}"
+      "#{prefix}-#{instance.name}".downcase
     end
 
     def exposed_ports
@@ -268,6 +269,17 @@ module Dokken
       false
     end
 
+    def running_inside_docker?
+      File.file?("/.dockerenv")
+    end
+
+    def running_inside_docker_desktop?
+      Resolv.getaddress "host.docker.internal."
+      true
+    rescue
+      false
+    end
+
     def sandbox_path
       "#{Dir.home}/.dokken/verifier_sandbox/#{instance_name}"
     end
@@ -300,7 +312,7 @@ module Kitchen
 
       def instance_name
         prefix = (Digest::SHA2.hexdigest FileUtils.pwd)[0, 10]
-        "#{prefix}-#{instance.name}"
+        "#{prefix}-#{instance.name}".downcase
       end
     end
   end
@@ -322,7 +334,7 @@ module Kitchen
 
       def instance_name
         prefix = (Digest::SHA2.hexdigest FileUtils.pwd)[0, 10]
-        "#{prefix}-#{instance.name}"
+        "#{prefix}-#{instance.name}".downcase
       end
 
       def call(state)

data/lib/kitchen/provisioner/dokken.rb

@@ -58,7 +58,7 @@ module Kitchen
         create_sandbox
         write_run_command(run_command)
         instance.transport.connection(state) do |conn|
-          if remote_docker_host?
+          if remote_docker_host? || running_inside_docker?
             info("Transferring files to #{instance.to_str}")
             conn.upload(sandbox_dirs, config[:root_path])
           end

data/lib/kitchen/transport/dokken.rb

@@ -43,8 +43,15 @@ module Kitchen
       default_config :docker_host_url, default_docker_host
       default_config :read_timeout, 3600
       default_config :write_timeout, 3600
+      default_config :login_command, "docker"
       default_config :host_ip_override do |transport|
-        transport.docker_for_mac_or_win? ? "localhost" : false
+        if running_inside_docker_desktop?
+          "host.docker.internal"
+        elsif transport.docker_for_mac_or_win?
+          "localhost"
+        else
+          false
+        end
       end
 
       # (see Base#connection)
@@ -172,7 +179,7 @@ module Kitchen
           cols = `tput cols`
           lines = `tput lines`
           args = ["exec", "-e", "COLUMNS=#{cols}", "-e", "LINES=#{lines}", "-it", @runner, "/bin/bash", "-login", "-i"]
-          LoginCommand.new("docker", args)
+          LoginCommand.new(options[:login_command], args)
         end
 
         private
@@ -211,7 +218,7 @@ module Kitchen
       #
       # @return [TrueClass,FalseClass]
       def docker_for_mac_or_win?
-        ::Docker.info(::Docker::Connection.new(config[:docker_host_url], {}))["Name"] == "moby"
+        ::Docker.info(::Docker::Connection.new(config[:docker_host_url], {}))["Name"] == "docker-desktop"
       rescue
         false
       end
@@ -233,6 +240,7 @@ module Kitchen
         opts[:data_container] = data[:data_container]
         opts[:instance_name] = data[:instance_name]
         opts[:timeout] = data[:write_timeout]
+        opts[:login_command] = data[:login_command]
         opts
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-dokken
 version: !ruby/object:Gem::Version
-  version: 2.19.0
+  version: 2.20.0
 platform: ruby
 authors:
 - Sean OMeara
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-27 00:00:00.000000000 Z
+date: 2023-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docker-api
@@ -72,7 +72,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
 - LICENSE
+- Rakefile
+- kitchen-dokken.gemspec
 - lib/kitchen/driver/dokken.rb
 - lib/kitchen/driver/dokken_version.rb
 - lib/kitchen/helpers.rb
@@ -97,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A Test Kitchen Driver for Docker & Chef Infra optimized for rapid testing