kitchen-dokken 2.19.1 → 2.20.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be2c8c44ba41e769729ee777daf91a2d2392c923b350f8fc359305deb75c8ae6
-  data.tar.gz: fe6adeaea1645fc26ab1117de9af06e2a212483f782d62da01a77634d03c18e3
+  metadata.gz: ac52c253c019253b9fe2cffdbf603ce33647e51aacb8376ae775b2158ed0ca5e
+  data.tar.gz: be18132016e30bae541416a33e88846d2e1a9cb72849fe3fb80d9a0b1c0941a6
 SHA512:
-  metadata.gz: c26fc34a7c0f00c29031300be0d2d4af57fe2b3987fe543d2630588c917c4b1adef8252d737c01adc031a3a2e4329e0d5ae1a0a2291d4714f5146faffe3eb9a9
-  data.tar.gz: 4c7235960fda3df63e8111c6a0e02ee79a3c50de37582c442b525cf61dbb685637378b8804b27075c1989e7a7929131cc922786d5ba4800116ae8e7641d085f4
+  metadata.gz: 01f86365eecc3ad220c0ac09e561b76fd85d47de80447ef60234ab21e0ca00549fc88b13771a1328398953c47a87cab2ee5cfddcca32b0fb1e8186ee34ba1d7e
+  data.tar.gz: dab5b5621092142df080ed34ad3d73449964c067ed65600cc45efed62b527da41e40da3e13c20915d07d0e0cf7c96a4a602b3cfd6efaf2b06e47b100841f67be

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,27 +233,13 @@ module Kitchen
       end
 
       def work_image
-        return "#{image_prefix}/#{instance_name}" unless image_prefix.nil?
-
-        instance_name
-      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 << Array(config[:binds]) unless config[:binds].nil?
-        ret.flatten
+        [image_prefix, instance_name].compact.join("/").downcase
       end
 
       def dokken_tmpfs
         coerce_tmpfs(config[:tmpfs])
       end
 
-      def dokken_volumes
-        coerce_volumes(config[:volumes])
-      end
-
       def coerce_tmpfs(v)
         case v
         when Hash, nil
@@ -265,7 +252,14 @@ module Kitchen
         end
       end
 
-      def coerce_volumes(v)
+      def dokken_volumes_from
+        ret = []
+        ret << chef_container_name
+        ret << data_container_name if remote_docker_host? || running_inside_docker?
+        ret
+      end
+
+      def coerce_volumes(v, binds)
         case v
         when PartialHash, nil
           v
@@ -273,29 +267,38 @@ module Kitchen
           PartialHash[v]
         else
           b = []
-          v = Array(v).to_a # in case v.is_A?(Chef::Node::ImmutableArray)
           v.delete_if do |x|
             parts = x.split(":")
             b << x if parts.length > 1
           end
           b = nil if b.empty?
-          config[:binds].push(b) unless config[:binds].include?(b) || b.nil?
+          binds.push(b) unless binds.include?(b) || b.nil?
           return PartialHash.new if v.empty?
 
           v.each_with_object(PartialHash.new) { |volume, h| h[volume] = {} }
         end
       end
 
-      def dokken_volumes_from
-        ret = []
-        ret << chef_container_name
-        ret << data_container_name if remote_docker_host?
-        ret
+      def calc_volumes_binds
+        volumes = Array.new(Array(config[:volumes]))
+        binds = Array.new(Array(config[:binds]))
+
+        # Binds is mutated in-place, volumes *may* be.
+        volumes = coerce_volumes(volumes, binds)
+
+        binds_ret = []
+        binds_ret << "#{dokken_kitchen_sandbox}:/opt/kitchen" unless dokken_kitchen_sandbox.nil? || remote_docker_host? || running_inside_docker?
+        binds_ret << "#{dokken_verifier_sandbox}:/opt/verifier" unless dokken_verifier_sandbox.nil? || remote_docker_host? || running_inside_docker?
+        binds_ret << binds unless binds.nil?
+
+        [volumes, binds_ret.flatten]
       end
 
       def start_runner_container(state)
         debug "driver - starting #{runner_container_name}"
 
+        volumes, binds = calc_volumes_binds
+
         config = {
           "name" => runner_container_name,
           "Cmd" => Shellwords.shellwords(self[:pid_one_command]),
@@ -304,11 +307,11 @@ module Kitchen
           "Hostname" => self[:hostname],
           "Env" => self[:env],
           "ExposedPorts" => exposed_ports,
-          "Volumes" => dokken_volumes,
+          "Volumes" => volumes,
           "HostConfig" => {
             "Privileged" => self[:privileged],
             "VolumesFrom" => dokken_volumes_from,
-            "Binds" => dokken_binds,
+            "Binds" => binds,
             "Dns" => self[:dns],
             "DnsSearch" => self[:dns_search],
             "Links" => Array(self[:links]),
@@ -320,14 +323,16 @@ module Kitchen
             "Tmpfs" => dokken_tmpfs,
             "Memory" => self[:memory_limit],
           },
-          "NetworkingConfig" => {
+        }
+        unless %w{host bridge}.include?(self[:network_mode])
+          config["NetworkingConfig"] = {
             "EndpointsConfig" => {
               self[:network_mode] => {
                 "Aliases" => Array(self[:hostname]).concat(Array(self[:hostname_aliases])),
               },
             },
-          },
-        }
+          }
+        end
         unless self[:entrypoint].to_s.empty?
           config["Entrypoint"] = self[:entrypoint]
         end
@@ -337,6 +342,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
@@ -352,19 +366,23 @@ module Kitchen
             "PublishAllPorts" => true,
             "NetworkMode" => "bridge",
           },
-          "NetworkingConfig" => {
+        }
+        unless %w{host bridge}.include?(self[:network_mode])
+          config["NetworkingConfig"] = {
             "EndpointsConfig" => {
               self[:network_mode] => {
                 "Aliases" => Array(self[:hostname]),
               },
             },
-          },
-        }
+          }
+        end
         data_container = run_container(config)
         state[:data_container] = data_container.json
       end
 
       def make_dokken_network
+        return unless self[:network_mode] == "dokken"
+
         lockfile = Lockfile.new "#{home_dir}/.dokken-network.lock"
         begin
           lockfile.lock
@@ -441,11 +459,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 +492,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.1".freeze
+    DOKKEN_VERSION = "2.20.1".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

@@ -45,7 +45,13 @@ module Kitchen
       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)
@@ -212,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-dokken
 version: !ruby/object:Gem::Version
-  version: 2.19.1
+  version: 2.20.1
 platform: ruby
 authors:
 - Sean OMeara
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-07 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.3.3
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A Test Kitchen Driver for Docker & Chef Infra optimized for rapid testing