kitchen-docker 2.6.0 → 2.11.0

data/lib/kitchen/transport/docker.rb

@@ -0,0 +1,111 @@
+#
+# 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 'kitchen'
+
+require_relative '../docker/container/linux'
+require_relative '../docker/container/windows'
+
+require_relative '../docker/helpers/inspec_helper'
+
+require_relative '../../docker/version.rb'
+require_relative '../../train/docker.rb'
+
+module Kitchen
+  module Transport
+    class Docker < Kitchen::Transport::Base
+      class DockerFailed < TransportFailed; end
+
+      kitchen_transport_api_version 1
+      plugin_version Kitchen::VERSION
+
+      default_config :binary,        'docker'
+      default_config :env_variables, nil
+      default_config :interactive,   false
+      default_config :privileged,    false
+      default_config :tls,           false
+      default_config :tls_cacert,    nil
+      default_config :tls_cert,      nil
+      default_config :tls_key,       nil
+      default_config :tls_verify,    false
+      default_config :tty,           false
+      default_config :working_dir,   nil
+
+      default_config :socket do |transport|
+        socket = 'unix:///var/run/docker.sock'
+        socket = 'npipe:////./pipe/docker_engine' if transport.windows_os?
+        ENV['DOCKER_HOST'] || socket
+      end
+
+      default_config :temp_dir do |transport|
+        if transport.windows_os?
+          '$env:TEMP'
+        else
+          '/tmp'
+        end
+      end
+
+      default_config :username do |transport|
+        # Return an empty string to prevent username from being added to Docker
+        # command line args for Windows if a username was not specified
+        if transport.windows_os?
+          nil
+        else
+          'kitchen'
+        end
+      end
+
+      def connection(state, &block)
+        options = config.to_hash.merge(state)
+        options[:platform] = instance.platform.name
+
+        # Set value for DOCKER_HOST environment variable for the docker-api gem
+        # This allows Windows systems to use the TCP socket for the InSpec verifier
+        # See the lib/docker.rb file here: https://github.com/swipely/docker-api/blob/master/lib/docker.rb
+        # default_socket_url is set to a Unix socket and env_url requires an environment variable to be set
+        ENV['DOCKER_HOST'] = options[:socket] if !options[:socket].nil? && ENV['DOCKER_HOST'].nil?
+
+        Kitchen::Transport::Docker::Connection.new(options, &block)
+      end
+
+      class Connection < Kitchen::Transport::Docker::Connection
+        # Include the InSpec patches to be able to execute tests on Windows containers
+        include Kitchen::Docker::Helpers::InspecHelper
+
+        def execute(command)
+          return if command.nil?
+
+          debug("[Docker] Executing command: #{command}")
+          info("[Docker] Executing command on container")
+
+          container.execute(command)
+        rescue => e
+          raise DockerFailed, "Docker failed to execute command on container. Error Details: #{e}"
+        end
+
+        def upload(locals, remote)
+          container.upload(locals, remote)
+        end
+
+        def container
+          @container ||= if @options[:platform].include?('windows')
+                           Kitchen::Docker::Container::Windows.new(@options)
+                         else
+                           Kitchen::Docker::Container::Linux.new(@options)
+                         end
+          @container
+        end
+      end
+    end
+  end
+end

data/lib/train/docker.rb

@@ -0,0 +1,125 @@
+#
+# 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.
+
+# Monkey patched Docker train transport to support running the InSpec verifier on Windows
+begin
+  # Requires train gem with a minimum version of 2.1.0
+  require 'train'
+
+  module Train::Transports
+    # Patched train transport with Windows support for InSpec verifier
+    class Docker < Train.plugin(1)
+      name 'docker'
+
+      include_options Train::Extras::CommandWrapper
+      option :host, required: true
+
+      def connection(state = {}, &block)
+        opts = merge_options(options, state || {})
+        validate_options(opts)
+
+        if @connection && @connection_options == opts
+          reuse_connection(&block)
+        else
+          create_new_connection(opts, &block)
+        end
+      end
+
+      private
+
+      # Creates a new Docker connection instance and save it for potential future
+      # reuse.
+      #
+      # @param options [Hash] connection options
+      # @return [Docker::Connection] a Docker connection instance
+      # @api private
+      def create_new_connection(options, &block)
+        if @connection
+          logger.debug("[Docker] shutting previous connection #{@connection}")
+          @connection.close
+        end
+
+        @connection_options = options
+        @connection = Connection.new(options, &block)
+      end
+
+      # Return the last saved Docker connection instance.
+      #
+      # @return [Docker::Connection] a Docker connection instance
+      # @api private
+      def reuse_connection
+        logger.debug("[Docker] reusing existing connection #{@connection}")
+        yield @connection if block_given?
+        @connection
+      end
+    end
+  end
+
+  class Train::Transports::Docker
+    class Connection < BaseConnection
+      def initialize(conf)
+        super(conf)
+        @id = options[:host]
+        @container = ::Docker::Container.get(@id) ||
+                    fail("Can't find Docker container #{@id}")
+        @cmd_wrapper = nil
+        @cmd_wrapper = CommandWrapper.load(self, @options)
+        self
+      end
+
+      def uri
+        if @container.nil?
+          "docker://#{@id}"
+        else
+          "docker://#{@container.id}"
+        end
+      end
+
+      private
+
+      def file_via_connection(path)
+        if os.aix?
+          Train::File::Remote::Aix.new(self, path)
+        elsif os.solaris?
+          Train::File::Remote::Unix.new(self, path)
+        elsif os.windows?
+          Train::File::Remote::Windows.new(self, path)
+        else
+          Train::File::Remote::Linux.new(self, path)
+        end
+      end
+
+      def platform_specific_cmd(cmd)
+        return cmd if @container.info.nil?
+        if @container.info['Platform'] == 'windows'
+          return ['cmd.exe', '/c', cmd]
+        else
+          return ['/bin/sh', '-c', cmd]
+        end
+      end
+
+      def run_command_via_connection(cmd, &_data_handler)
+        cmd = @cmd_wrapper.run(cmd) unless @cmd_wrapper.nil?
+        stdout, stderr, exit_status = @container.exec(platform_specific_cmd(cmd))
+        CommandResult.new(stdout.join, stderr.join, exit_status)
+      rescue ::Docker::Error::DockerError => _
+        raise
+      rescue => _
+        # @TODO: differentiate any other error
+        raise
+      end
+    end
+  end
+rescue LoadError => e
+  logger.debug("[Docker] train gem not found for InSpec verifier. #{e}")
+end

data/test/integration/default/serverspec/default_spec.rb

@@ -15,7 +15,7 @@
 #
 
 require 'serverspec'
-set :backend, :exec
+require 'spec_helper'
 
 # Just make sure the image launched and is reachable.
 describe command('true') do

data/test/integration/default/serverspec/spec_helper.rb

@@ -0,0 +1,21 @@
+#
+# 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.
+#
+
+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/integration/inspec/inspec_spec.rb

@@ -15,6 +15,12 @@
 #
 
 # Just make sure the image launched and is reachable.
-describe command('true') do
-  its(:exit_status) { is_expected.to eq 0 }
+if os[:family] == 'windows'
+  describe command('echo 1') do
+    its(:exit_status) { is_expected.to eq 0 }
+  end
+else
+  describe command('true') do
+    its(:exit_status) { is_expected.to eq 0 }
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-docker
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.11.0
 platform: ruby
 authors:
 - Sean Porter
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-09-19 00:00:00.000000000 Z
+date: 2021-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-kitchen
@@ -176,14 +176,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: train
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 description: A Docker Driver for Test Kitchen
 email:
 - portertech@gmail.com
@@ -192,7 +212,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".cane"
+- ".github/dependabot.yml"
 - ".gitignore"
+- ".kitchen.windows.yml"
 - ".kitchen.yml"
 - ".tailor"
 - ".travis.yml"
@@ -201,21 +223,35 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- docker.ps1
 - kitchen-docker.gemspec
+- lib/docker/version.rb
+- lib/kitchen/docker/container.rb
+- lib/kitchen/docker/container/linux.rb
+- lib/kitchen/docker/container/windows.rb
+- lib/kitchen/docker/docker_version.rb
+- lib/kitchen/docker/erb_context.rb
+- lib/kitchen/docker/helpers/cli_helper.rb
+- lib/kitchen/docker/helpers/container_helper.rb
+- lib/kitchen/docker/helpers/dockerfile_helper.rb
+- lib/kitchen/docker/helpers/file_helper.rb
+- lib/kitchen/docker/helpers/image_helper.rb
+- lib/kitchen/docker/helpers/inspec_helper.rb
 - lib/kitchen/driver/docker.rb
-- lib/kitchen/driver/docker/erb.rb
-- lib/kitchen/driver/docker_version.rb
+- 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/inspec/inspec_spec.rb
 - test/spec/docker_spec.rb
 - test/spec/spec_helper.rb
-homepage: https://github.com/portertech/kitchen-docker
+homepage: https://github.com/test-kitchen/kitchen-docker
 licenses:
 - Apache 2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -230,15 +266,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.4
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 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/inspec/inspec_spec.rb
 - test/spec/docker_spec.rb
 - test/spec/spec_helper.rb