kitchen-docker 2.9.0 → 2.10.0

data/lib/kitchen/docker/container/windows.rb

@@ -0,0 +1,84 @@
+#
+# 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 'securerandom'
+
+require_relative '../container'
+
+module Kitchen
+  module Docker
+    class Container
+      class Windows < Kitchen::Docker::Container
+        def initialize(config)
+          super
+        end
+
+        def create(state)
+          super
+
+          debug('Creating Windows container')
+          state[:username] = @config[:username]
+          state[:image_id] = build_image(state, dockerfile) unless state[:image_id]
+          state[:container_id] = run_container(state) unless state[:container_id]
+        end
+
+        def execute(command)
+          # Create temp script file and upload files to container
+          debug('Executing command on Windows container')
+          filename = "docker-#{::SecureRandom.uuid}.ps1"
+          temp_file = ".\\.kitchen\\temp\\#{filename}"
+          create_temp_file(temp_file, command)
+
+          remote_path = @config[:temp_dir].tr('/', '\\')
+          debug("Creating directory #{remote_path} on container")
+          create_dir_on_container(@config, remote_path)
+
+          debug("Uploading temp file #{temp_file} to #{remote_path} on container")
+          upload(temp_file, remote_path)
+
+          debug('Deleting temp file from local filesystem')
+          ::File.delete(temp_file)
+
+          # Replace any environment variables used in the path and execute script file
+          debug("Executing temp script #{remote_path}\\#{filename} on container")
+          remote_path = replace_env_variables(@config, remote_path)
+          cmd = build_powershell_command("-File #{remote_path}\\#{filename}")
+
+          container_exec(@config, cmd)
+        rescue => e
+          raise "Failed to execute command on Windows container. #{e}"
+        end
+
+        protected
+
+        def dockerfile
+          raise ActionFailed, "Unknown platform '#{@config[:platform]}'" unless @config[:platform] == 'windows'
+          return dockerfile_template if @config[:dockerfile]
+
+          from = "FROM #{@config[:image]}"
+
+          custom = ''
+          Array(@config[:provision_command]).each do |cmd|
+            custom << "RUN #{cmd}\n"
+          end
+
+          output = [from, dockerfile_proxy_config, custom, ''].join("\n")
+          debug('--- Start Dockerfile ---')
+          debug(output.strip)
+          debug('--- End Dockerfile ---')
+          output
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/{driver → docker}/docker_version.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Copyright (C) 2014, Sean Porter
 #
@@ -15,10 +14,8 @@
 # limitations under the License.
 
 module Kitchen
-
-  module Driver
-
+  module Docker
     # Version string for Docker Kitchen driver
-    DOCKER_VERSION = "2.9.0"
+    DOCKER_VERSION = "2.10.0"
   end
 end

data/lib/kitchen/{driver/docker/erb.rb → docker/erb_context.rb}

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Copyright (C) 2014, Sean Porter
 #
@@ -17,10 +16,8 @@
 require 'erb'
 
 module Kitchen
-
-  module Driver
-
-    class DockerERBContext
+  module Docker
+    class ERBContext
       def initialize(config={})
         config.each do |key, value|
           instance_variable_set('@' + key.to_s, value)

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

@@ -0,0 +1,147 @@
+#
+# 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 'kitchen/configurable'
+require 'kitchen/logging'
+require 'kitchen/shell_out'
+
+module Kitchen
+  module Docker
+    module Helpers
+      module CliHelper
+        include Configurable
+        include Logging
+        include ShellOut
+
+        def docker_command(cmd, options={})
+          docker = config[:binary].dup
+          docker << " -H #{config[:socket]}" if config[:socket]
+          docker << ' --tls' if config[:tls]
+          docker << ' --tlsverify' if config[:tls_verify]
+          docker << " --tlscacert=#{config[:tls_cacert]}" if config[:tls_cacert]
+          docker << " --tlscert=#{config[:tls_cert]}" if config[:tls_cert]
+          docker << " --tlskey=#{config[:tls_key]}" if config[:tls_key]
+          logger.debug("docker_command: #{docker} #{cmd} shell_opts: #{docker_shell_opts(options)}")
+          run_command("#{docker} #{cmd}", docker_shell_opts(options))
+        end
+
+        def build_run_command(image_id, transport_port = nil)
+          cmd = 'run -d'
+          cmd << ' -i' if config[:interactive]
+          cmd << ' -t' if config[:tty]
+          cmd << build_env_variable_args(config[:env_variables]) if config[:env_variables]
+          cmd << " -p #{transport_port}" unless transport_port.nil?
+          Array(config[:forward]).each { |port| cmd << " -p #{port}" }
+          Array(config[:dns]).each { |dns| cmd << " --dns #{dns}" }
+          Array(config[:add_host]).each { |host, ip| cmd << " --add-host=#{host}:#{ip}" }
+          Array(config[:volume]).each { |volume| cmd << " -v #{volume}" }
+          Array(config[:volumes_from]).each { |container| cmd << " --volumes-from #{container}" }
+          Array(config[:links]).each { |link| cmd << " --link #{link}" }
+          Array(config[:devices]).each { |device| cmd << " --device #{device}" }
+          cmd << " --name #{config[:instance_name]}" if config[:instance_name]
+          cmd << ' -P' if config[:publish_all]
+          cmd << " -h #{config[:hostname]}" if config[:hostname]
+          cmd << " -m #{config[:memory]}" if config[:memory]
+          cmd << " -c #{config[:cpu]}" if config[:cpu]
+          cmd << " -e http_proxy=#{config[:http_proxy]}" if config[:http_proxy]
+          cmd << " -e https_proxy=#{config[:https_proxy]}" if config[:https_proxy]
+          cmd << ' --privileged' if config[:privileged]
+          Array(config[:cap_add]).each { |cap| cmd << " --cap-add=#{cap}"} if config[:cap_add]
+          Array(config[:cap_drop]).each { |cap| cmd << " --cap-drop=#{cap}"} if config[:cap_drop]
+          Array(config[:security_opt]).each { |opt| cmd << " --security-opt=#{opt}"} if config[:security_opt]
+          extra_run_options = config_to_options(config[:run_options])
+          cmd << " #{extra_run_options}" unless extra_run_options.empty?
+          cmd << " #{image_id} #{config[:run_command]}"
+          logger.debug("build_run_command: #{cmd}")
+          cmd
+        end
+
+        def build_exec_command(state, command)
+          cmd = 'exec'
+          cmd << ' -d' if config[:detach]
+          cmd << build_env_variable_args(config[:env_variables]) if config[:env_variables]
+          cmd << ' --privileged' if config[:privileged]
+          cmd << ' -t' if config[:tty]
+          cmd << ' -i' if config[:interactive]
+          cmd << " -u #{config[:username]}" if config[:username]
+          cmd << " -w #{config[:working_dir]}" if config[:working_dir]
+          cmd << " #{state[:container_id]}"
+          cmd << " #{command}"
+          logger.debug("build_exec_command: #{cmd}")
+          cmd
+        end
+
+        def build_copy_command(local_file, remote_file, opts = {})
+          cmd = 'cp'
+          cmd << ' -a' if opts[:archive]
+          cmd << " #{local_file} #{remote_file}"
+          cmd
+        end
+
+        def build_powershell_command(args)
+          cmd = 'powershell -ExecutionPolicy Bypass -NoLogo '
+          cmd << args
+          logger.debug("build_powershell_command: #{cmd}")
+          cmd
+        end
+
+        def build_env_variable_args(vars)
+          raise ActionFailed, 'Environment variables are not of a Hash type' unless vars.is_a?(Hash)
+
+          args = ''
+          vars.each do |k, v|
+            args << " -e #{k.to_s.strip}=\"#{v.to_s.strip}\""
+          end
+
+          args
+        end
+
+        def dev_null
+          case RbConfig::CONFIG['host_os']
+          when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+            'NUL'
+          else
+            '/dev/null'
+          end
+        end
+
+        def docker_shell_opts(options = {})
+          options[:live_stream] = nil if options[:suppress_output]
+          options.delete(:suppress_output)
+
+          options
+        end
+
+        # Convert the config input for `:build_options` or `:run_options` in to a
+        # command line string for use with Docker.
+        #
+        # @since 2.5.0
+        # @param config [nil, String, Array, Hash] Config data to convert.
+        # @return [String]
+        def config_to_options(config)
+          case config
+          when nil
+            ''
+          when String
+            config
+          when Array
+            config.map { |c| config_to_options(c) }.join(' ')
+          when Hash
+            config.map { |k, v| Array(v).map { |c| "--#{k}=#{Shellwords.escape(c)}" }.join(' ') }.join(' ')
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,172 @@
+#
+# 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

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

@@ -0,0 +1,40 @@
+#
+# 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 'fileutils'
+
+module Kitchen
+  module Docker
+    module Helpers
+      module FileHelper
+        def create_temp_file(file, contents)
+          debug("[Docker] Creating temp file #{file}")
+          debug('[Docker] --- Start Temp File Contents ---')
+          debug(contents)
+          debug('[Docker] --- End Temp File Contents ---')
+
+          begin
+            path = ::File.dirname(file)
+            ::FileUtils.mkdir_p(path) unless ::Dir.exist?(path)
+            file = ::File.open(file, 'w')
+            file.write(contents)
+          rescue IOError => e
+            raise "Failed to write temp file. Error Details: #{e}"
+          ensure
+            file.close unless file.nil?
+          end
+        end
+      end
+    end
+  end
+end