kitchen-dockerwin 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3b313fb472cf7a3b8990f786fc57ef612119bd3915a760c80eec94d7f1d78c1
-  data.tar.gz: 73eea1c8cec0da5c67991fd808951b6aa8f9a69baacee3d5e87e7d548282f441
+  metadata.gz: 5e16d92ee864f0a22897d63b80edebc3a9599d973305015c42cfd5a4bdf9c499
+  data.tar.gz: ce7831bee20da9da43d039218513ec0dad660686fc5a0b67ef86328bb799388c
 SHA512:
-  metadata.gz: 4e309052f0887c708ac0164ae4fc1810aaea105e819dc1e6ee6b69fc5fd8f279b84504316f5591089bb6c8eecee0283d036141d08c0cd7972f117b8814d6e3e7
-  data.tar.gz: 0fe13ddb456d5cff73bccaaa5fc8db58a3311717c638b394956957017426de351384b789bee5ab98d170bbfe7643a96418c2e3f050452f4463320b7059728b8f
+  metadata.gz: 31da27b932da0714fd1d59aaffcc3e8d0035e3763a4c415065bde6cefcfa9a623bf4d83b5d61c86d14f2495ca215abde454147094ae531e3ec300b16d12c07c7
+  data.tar.gz: 1d24a81b2203221c11ec0f2f8410861e0f6eb103742baafcaaff61e2c3f5b9abd151f450923c59c5982da905001abf9b1e645d78ec3da66de5b399253951eebd

data/README.md

@@ -1,40 +1,49 @@
 # kitchen-dockerwin
 
-An experimental Test Kitchen driver that supports Windows-based via Docker on a Windows workstation
-
-**NOTE: `kitchen verify` is not yet supported when using this tool with InSpec.**
+An experimental Test Kitchen driver that supports Windows Containers via Docker on a Windows workstation.
 
 # Quickstart
 
-You'll need an environment with Docker for Windows installed, running and configured to run Windows Containers, and a working ChefDK installation (alternatively Ruby + Devkit + Test Kitchen gem).
+You'll need a workstation (Windows 10, Windows Server 2016 or higher) with Docker for Windows installed, running and configured to be able to run Windows Containers, and a working ChefDK installation (alternatively Ruby + Devkit + Test Kitchen gem).
+
+## Docker Configuration
 
-## Install the gem
+Edit the configuration file (usually located at `C:\ProgramData\docker\config\daemon.json`) and replace the configuration with the following, (i.e. adding the "hosts" value):
 
 ```
-gem install kitchen-dockerwin
+{
+  "registry-mirrors": [],
+  "insecure-registries": [],
+  "debug": true,
+  "experimental": false,
+  "hosts": ["tcp://0.0.0.0:2375"]
+}
 ```
+Restart Docker. You may wish to remove any previously-running images using `docker rm $(docker ps -a -q)`
+
+Ensure that Docker is running in Windows Container mode (right click the Docker icon in the System Notification area > **Switch to Windows containers** to be sure).
 
-If you are installing inside a Chef Workstation installation:
+## Install the gem (assumes Chef Workstation/Chef DK installation)
 
 ```
 chef gem install kitchen-dockerwin
 ```
 
-## Dockerfile
+## Create base container image
 
-Whilst not necessary, the example shown assumes you have created your own Docker image with Chef Client inside, this will dramatically speed up the testing process because the Chef Client will not need to be installed each time.
+Whilst you can use any compatible Windows Server image for your kernel, converge time will be improved if you can build your own image that adds the Chef Infra Client to the Windows Server Core image.
 
-An example `Dockerfile` follows:
+To build your own image, create a `Dockerfile` as follows:
 
 ```
 FROM mcr.microsoft.com/windows/servercore:ltsc2019
-RUN ["powershell", "-executionpolicy unrestricted", "-noninteractive", "-command", ". { iwr -useb https://omnitruck.chef.io/install.ps1 } | iex; install;"]
+RUN ["powershell.exe", "-executionpolicy unrestricted", "-noninteractive", "-command", ". { iwr -useb https://omnitruck.chef.io/install.ps1 } | iex; install; remove-item $env:TEMP\\*.msi -force"]
 ```
 
-Example command line to build image:
+Example command line to build the Docker image:
 
 ```
-PS> docker build -t stuartpreston/chef-client:15
+PS> docker build . -t stuartpreston/chef-client:latest
 ```
 
 ## Example kitchen.yml
@@ -50,22 +59,34 @@ provisioner:
   install_strategy: skip
   chef_client_path: c:\opscode\chef\bin\chef-client.bat
 
-transport:
-  name: dockercli
-
 verifier:
-  name: dummy
+  name: inspec
 
 platforms:
   - name: windows2019
     driver:
-      image: stuartpreston/chef-client:15
+      image: stuartpreston/chef-client:latest
       skip_pull: true
 
 suites:
   - name: default
 ```
 
+# Troubleshooting
+
+## "No such container"
+```
+>>>>>>     Failed to complete #verify action: [{"message":"No such container: f362e060cdc97feb4ff12ac22d072891558a80c93f207e31e8ccb9d7924fc6b4"}
+] on default-windows2019
+```
+Probable cause: Stale state file. If the container has been killed and removed (check with `docker ps -a`), then remove the .kitchen/*.yml file and retry.
+
+# Known Issues/Limitations
+
+* No support for Linux Containers on Windows (yet!)
+* Some Chef Infra Client features are unsupported when running in Windows Containers, such as resources that are dependent on the WMI stack (including WinRM)
+* `kitchen destroy` (i.e. kill and remove container) can take in excess of 1 minute on Windows.
+
 # License
 
 Apache License 2.0

data/lib/docker/version.rb

@@ -0,0 +1,4 @@
+module Docker
+  VERSION = '0.0.0'
+  API_VERSION = '1.24'
+end

data/lib/kitchen/driver/dockerwin.rb

@@ -1,4 +1,5 @@
 require 'kitchen/shell_out'
+require 'kitchen/transport/dockercli'
 
 module Kitchen
   module Driver
@@ -12,8 +13,8 @@ module Kitchen
 
       def create(state)
         run_command("docker pull #{instance.driver[:image]}") unless config[:skip_pull]
-        mount_options = "--mount type=bind,source=\"c:\/\",target=\"c:\/mnt\/c\""
-        container_id = run_command("docker run -idt #{mount_options} --name #{instance.name} #{instance.driver[:image]}").strip
+        mount_options = config[:mount_options] || "type=bind,source=\"#{ENV['TEMP']}\",target=\"#{ENV['TEMP']},readonly\""
+        container_id = run_command("docker run -idt --mount #{mount_options} --name #{instance.name} #{instance.driver[:image]}").strip
         state[:container_id] = container_id
       end
 
@@ -26,6 +27,13 @@ module Kitchen
         run_command("docker rm #{container_id} > nul")
         state.delete(:container_id)
       end
+
+      # Force the driver to use the Dockercli transport
+      def finalize_config!(instance)
+        super.tap do
+          instance.transport = Kitchen::Transport::Dockercli.new
+        end
+      end
     end
   end
 end

data/lib/kitchen/transport/dockercli.rb

@@ -20,46 +20,35 @@ module Kitchen
       
       class Connection < Kitchen::Transport::Base::Connection
         include ShellOut
-
+        
         def execute(command)
           return if command.nil?
-          tempfile = "#{SecureRandom.hex(4)}.ps1"
-          tempfile_path = File.join(ENV['TEMP'], tempfile)
-          translated_path = translate_path(tempfile_path)          
+          debug command
+          tempfile = File.join(ENV['TEMP'], "#{SecureRandom.hex(4)}.ps1")
           begin
-            File.open((tempfile_path), 'w') { |file| file.write(command) }
-            dockered_command = "docker exec #{options[:container_id]} powershell.exe -noprofile -noninteractive -executionpolicy unrestricted -file #{translated_path}"
+            File.open((tempfile), 'w') { |file| file.write(command) }
+            dockered_command = "docker exec #{options[:container_id]} powershell.exe -noprofile -executionpolicy unrestricted -file #{tempfile}"
             run_command(dockered_command)
           ensure
-            File.unlink(tempfile_path)
+            File.unlink(tempfile)
           end
         end
 
         def upload(locals, remote)
           powershell_commands = Array.new 
           Array(locals).each do |local|
-           powershell_commands << "copy-item #{translate_path(local)} #{remote} -force -recurse;"
+            powershell_commands << "copy-item #{local} #{remote} -force -recurse;"
           end
           execute(powershell_commands.join)
         end
 
         def download(remotes, local)
-          powershell_commands = Array.new 
-          Array(remotes).each do |remote|
-           powershell_commands << "copy-item #{remote} #{translate_path(local)} -force -recurse;"
-          end
-          execute(powershell_commands.join)
+          raise "Download not supported."
         end
 
         def login_command
           LoginCommand.new("docker exec -it #{options[:container_id]} powershell.exe -noprofile -executionpolicy unresticted", nil)
         end
-
-        private
-
-        def translate_path(path)
-          path.downcase.gsub("c:", "\/mnt\/c")
-        end
       end
     end
   end

data/lib/train/transports/docker.rb

@@ -0,0 +1,114 @@
+# encoding: utf-8
+#
+# Author:: Dominik Richter
+# Author:: Christoph Hartmann
+
+require 'docker'
+
+module Train::Transports
+  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 close
+      # nothing to do at the moment
+    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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-dockerwin
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Stuart Preston
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-20 00:00:00.000000000 Z
+date: 2019-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,8 +75,10 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- lib/docker/version.rb
 - lib/kitchen/driver/dockerwin.rb
 - lib/kitchen/transport/dockercli.rb
+- lib/train/transports/docker.rb
 homepage: https://github.com/stuartpreston/kitchen-dockerwin
 licenses:
 - Apache-2.0