kitchen-dokken 2.12.0 → 2.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e00103fefe2a49fd2630337f2a8d0bb0932484b770704b69c1fb31d9ddd0b42
-  data.tar.gz: 0acea78f249845712be9d1f97094f190369a1e15707ac559de27be5fc6c29e31
+  metadata.gz: d549607487cae2cf1d58c9fadfed6e5c0649d085b27dc0841abf32d4a23670df
+  data.tar.gz: 4be3556b19ae6795d6c70d196913ed79f7d14971dc386f539a0321683ecdf49b
 SHA512:
-  metadata.gz: 0d84bd393b040ef4bc771a5d5c4448dff1860a9244d0818341f06c834e8133cbd9a77b0b7a4f697c8873be24b567083556f4feb47a57723782fe6575ad7b2a1a
-  data.tar.gz: b628d6bce7009efa94713c5c6032ec81e3258686c84f22ebd430e1710a1817cfaf3cb82420a8109e21f1506ff0e661c08da1e6fb2d5baedd6adbb216a0dedaa8
+  metadata.gz: ee6f97ad4f722b828f9d0508a69224ef7ae4514b39280a3c84ae14351626939e04d7fdae779c4280efcc4d88210a37fad02dab74ad638432d8aa1e929e40e1e7
+  data.tar.gz: 5035e7f732b10ed7f9407555d612441c509985acd6d33d577d23c02c0529cd80be0f93c2c668fc0355135ed765e9844d075adfaf417de441a501858588042e2a

data/lib/kitchen/driver/dokken.rb

@@ -48,7 +48,10 @@ module Kitchen
       default_config :entrypoint, nil
       default_config :env, nil
       default_config :hostname, "dokken"
+      default_config :hostname_aliases, nil
       default_config :image_prefix, nil
+      default_config :ipv6, false
+      default_config :ipv6_subnet, "2001:db8:1::/64" # "2001:db8::/32 Range reserved for documentation"
       default_config :links, nil
       default_config :memory_limit, 0
       default_config :network_mode, "dokken"
@@ -169,8 +172,10 @@ module Kitchen
       end
 
       def work_image_dockerfile
+        from = registry_image_path(platform_image)
+        debug("driver - Building work image from #{from}")
         dockerfile_contents = [
-          "FROM #{platform_image}",
+          "FROM #{from}",
           "LABEL X-Built-By=kitchen-dokken X-Built-From=#{platform_image}",
         ]
         Array(config[:intermediate_instructions]).each do |c|
@@ -287,7 +292,8 @@ module Kitchen
         config = {
           "name" => runner_container_name,
           "Cmd" => Shellwords.shellwords(self[:pid_one_command]),
-          "Image" => "#{repo(work_image)}:#{tag(work_image)}",
+          # locally built image, must use short-name
+          "Image" => short_image_path(work_image),
           "Hostname" => self[:hostname],
           "Env" => self[:env],
           "ExposedPorts" => exposed_ports,
@@ -310,7 +316,7 @@ module Kitchen
           "NetworkingConfig" => {
             "EndpointsConfig" => {
               self[:network_mode] => {
-                "Aliases" => Array(self[:hostname]),
+                "Aliases" => Array(self[:hostname]).concat(Array(self[:hostname_aliases])),
               },
             },
           },
@@ -329,7 +335,8 @@ module Kitchen
         debug "driver - creating #{data_container_name}"
         config = {
           "name" => data_container_name,
-          "Image" => "#{repo(data_image)}:#{tag(data_image)}",
+          # locally built image, must use short-name
+          "Image" => short_image_path(data_image),
           "HostConfig" => {
             "PortBindings" => port_bindings,
             "PublishAllPorts" => true,
@@ -352,9 +359,9 @@ module Kitchen
         begin
           lockfile.lock
           with_retries { ::Docker::Network.get("dokken", {}, docker_connection) }
-        rescue
+        rescue ::Docker::Error::NotFoundError
           begin
-            with_retries { ::Docker::Network.create("dokken", {}) }
+            with_retries { ::Docker::Network.create("dokken", network_settings) }
           rescue ::Docker::Error => e
             debug "driver - error :#{e}:"
           end
@@ -388,14 +395,14 @@ module Kitchen
             config = {
               "name" => chef_container_name,
               "Cmd" => "true",
-              "Image" => "#{repo(chef_image)}:#{tag(chef_image)}",
+              "Image" => registry_image_path(chef_image),
               "HostConfig" => {
                 "NetworkMode" => self[:network_mode],
               },
             }
             chef_container = create_container(config)
             state[:chef_container] = chef_container.json
-          rescue ::Docker::Error => e
+          rescue ::Docker::Error, StandardError => e
             raise "driver - #{chef_container_name} failed to create #{e}"
           end
         ensure
@@ -404,12 +411,12 @@ module Kitchen
       end
 
       def pull_platform_image
-        debug "driver - pulling #{chef_image} #{repo(platform_image)} #{tag(platform_image)}"
+        debug "driver - pulling #{short_image_path(platform_image)}"
         config[:pull_platform_image] ? pull_image(platform_image) : pull_if_missing(platform_image)
       end
 
       def pull_chef_image
-        debug "driver - pulling #{chef_image} #{repo(chef_image)} #{tag(chef_image)}"
+        debug "driver - pulling #{short_image_path(chef_image)}"
         config[:pull_chef_image] ? pull_image(chef_image) : pull_if_missing(chef_image)
       end
 
@@ -422,7 +429,7 @@ module Kitchen
 
       def container_exist?(name)
         return true if ::Docker::Container.get(name, {}, docker_connection)
-      rescue
+      rescue StandardError, ::Docker::Error::NotFoundError
         false
       end
 
@@ -440,10 +447,45 @@ module Kitchen
         [repo, tag]
       end
 
+      # Return the 'repo' half of a docker image path. Agnostic about if a
+      # registry is included, this effectively is just "before the colon"
+      #
+      # @param image [String] the docker image path to parse
+      # @return [String] the repo portion of `image`
       def repo(image)
         parse_image_name(image)[0]
       end
 
+      # Return the 'tag' of a docker image path. Will be `latest` if there
+      # is no explicit tag in the image path.
+      #
+      # @param image [String] the docker image path to parse
+      # @return [String] the tag of `image`
+      def tag(image)
+        parse_image_name(image)[1]
+      end
+
+      # Ensures an explicit tag on an image path.
+      #
+      # @param image [String] the docker image path to parse
+      # @return [String] `repo`:`tag`
+      def short_image_path(image)
+        "#{repo(image)}:#{tag(image)}"
+      end
+
+      # Qualifies the results of `short_image_path` with any registry the
+      # user has requested
+      #
+      # @param image [String] the docker image path to parse
+      # @return [String] The most fully-qualified registry path we cn make
+      def registry_image_path(image)
+        if config[:docker_registry]
+          "#{config[:docker_registry]}/#{short_image_path(image)}"
+        else
+          short_image_path(image)
+        end
+      end
+
       def create_container(args)
         with_retries { @container = ::Docker::Container.get(args["name"], {}, docker_connection) }
       rescue
@@ -511,10 +553,6 @@ module Kitchen
         end
       end
 
-      def tag(image)
-        parse_image_name(image)[1]
-      end
-
       def chef_container_name
         "chef-#{chef_version}"
       end
@@ -547,7 +585,7 @@ module Kitchen
       end
 
       def pull_if_missing(image)
-        return if ::Docker::Image.exist?("#{repo(image)}:#{tag(image)}", {}, docker_connection)
+        return if ::Docker::Image.exist?(registry_image_path(image), {}, docker_connection)
 
         pull_image image
       end
@@ -557,21 +595,14 @@ module Kitchen
         val.sub(%r{https?://}, "").split("/").first
       end
 
-      def image_path(image)
-        fqimage = "#{repo(image)}:#{tag(image)}"
-        if config[:docker_registry]
-          fqimage = "#{config[:docker_registry]}/#{fqimage}"
-        end
-        fqimage
-      end
-
       def pull_image(image)
+        path = registry_image_path(image)
         with_retries do
-          if Docker::Image.exist?(image_path(image), {}, docker_connection)
-            original_image = Docker::Image.get(image_path(image), {}, docker_connection)
+          if Docker::Image.exist?(path, {}, docker_connection)
+            original_image = Docker::Image.get(path, {}, docker_connection)
           end
 
-          new_image = Docker::Image.create({ "fromImage" => "#{repo(image)}:#{tag(image)}" }, docker_connection)
+          new_image = Docker::Image.create({ "fromImage" => path }, {}, docker_connection)
 
           !(original_image && original_image.id.start_with?(new_image.id))
         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.12.0".freeze
+    DOKKEN_VERSION = "2.15.0".freeze
   end
 end

data/lib/kitchen/helpers.rb

@@ -117,6 +117,8 @@ VOLUME /opt/verifier
     end
 
     def docker_info
+      ::Docker.url = default_docker_host
+
       @docker_info ||= ::Docker.info
     rescue Excon::Error::Socket
       puts "kitchen-dokken could not connect to the docker host at #{default_docker_host}. Is docker running?"
@@ -175,6 +177,21 @@ VOLUME /opt/verifier
       coerce_exposed_ports(config[:ports])
     end
 
+    def network_settings
+      if self[:ipv6]
+        {
+          "EnableIPv6" => true,
+          "IPAM" => {
+            "Config" => [{
+              "Subnet" => self[:ipv6_subnet],
+            }],
+          },
+        }
+      else
+        {}
+      end
+    end
+
     def port_bindings
       coerce_port_bindings(config[:ports])
     end
@@ -244,6 +261,7 @@ VOLUME /opt/verifier
     end
 
     def remote_docker_host?
+      return false if config[:docker_info]["OperatingSystem"].include?("Docker Desktop")
       return false if config[:docker_info]["OperatingSystem"].include?("Boot2Docker")
       return true if /^tcp:/.match?(config[:docker_host_url])
 

data/lib/kitchen/provisioner/dokken.rb

@@ -109,12 +109,13 @@ module Kitchen
         cmd << " -c /opt/kitchen/client.rb"
         cmd << " -j /opt/kitchen/dna.json"
         cmd << "--profile-ruby" if config[:profile_ruby]
+        cmd << "--slow-report" if config[:slow_resource_report]
 
         chef_cmd(cmd)
       end
 
       def write_run_command(command)
-        File.write("#{dokken_kitchen_sandbox}/run_command", command)
+        File.write("#{dokken_kitchen_sandbox}/run_command", command, mode: "wb")
       end
 
       def runner_container_name

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-dokken
 version: !ruby/object:Gem::Version
-  version: 2.12.0
+  version: 2.15.0
 platform: ruby
 authors:
 - Sean OMeara
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-24 00:00:00.000000000 Z
+date: 2021-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docker-api
@@ -53,7 +53,7 @@ dependencies:
         version: '1.15'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -63,7 +63,7 @@ dependencies:
         version: '1.15'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
 description: A Test Kitchen Driver for Docker & Chef Infra optimized for rapid testing
   using Chef Infra docker images
 email:
@@ -97,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: A Test Kitchen Driver for Docker & Chef Infra optimized for rapid testing