kitchen-docker 2.6.0 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ac3e853fa14d2d248cd9f28c81dc1cdfd4e246c8
-  data.tar.gz: 55abcccf7441c4fca218443ffecae6170579fd62
+SHA256:
+  metadata.gz: 5cb2a57e3f7074c1f3b07505f6931d9d742a2ff70d8908b97d9c69d27bb6b34b
+  data.tar.gz: 863c64c9dac8d43c0db30bb5b83cb6eaf3448ae0b988f9809abbd882b8b12ac1
 SHA512:
-  metadata.gz: 3d43e2069a3ebdaef65ec576f7414c53a04f4a75fbdf63d88461d2260a6880e7bbd3d4fbda01e4b96c6eb247885a1aa4bbe1dbbe3c9d73c9b7f37bf41769d8ce
-  data.tar.gz: bde163aebd028bf17af0a75dcbcb42ba5742a9449e340880793d7458ab662c98066cd881834adf5291dc6a908e0078ea4d205373b887062cd177dfc2081753b4
+  metadata.gz: b8639ed71230580894bc7daedd7c7efcaf09458e2e6c1cbf45e0617e16844a28d4c0015c251009e1e0fa0c741daf15715eed2a2bc6f1eada903a04fdb73a620a
+  data.tar.gz: 779683f5e429eff27d8d68c3a19f8d01b1247d9699f283bde06f902ed6a8a0f03330e534568cac05114676f27434ba0aacb443ad57705b0bb6e0c5a77409aba0

data/.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10

data/.gitignore

@@ -17,3 +17,5 @@ test/version_tmp
 tmp
 .kitchen/
 .kitchen.local.yml
+Dockerfile
+.DS_Store

data/.kitchen.windows.yml

@@ -0,0 +1,33 @@
+<% # Make sure the local copy of the driver is loaded %>
+<% lib = File.expand_path('../lib', __FILE__) %>
+<% $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) %>
+---
+driver:
+  name: docker
+  provision_command: 
+    - powershell -ExecutionPolicy Bypass -NoLogo -Command . { iwr -useb https://omnitruck.chef.io/install.ps1 } ^| iex; install
+    - powershell -Command $path=$env:Path + ';c:\opscode\chef\embedded\bin'; Set-ItemProperty -Path 'HKLM:\SYSTEM\CurrentControlSet\Control\Session Manager\Environment\' -Name Path -Value $path
+
+transport:
+  name: docker
+  socket: tcp://localhost:2375
+
+provisioner:
+  name: dummy
+
+platforms:
+- name: windows
+  driver_config:
+    image: mcr.microsoft.com/windows/servercore:1809
+    platform: windows
+
+suites:
+- name: default
+- name: context
+  driver:
+    build_context: false
+- name: inspec
+  driver:
+    provision_command: echo 1
+  verifier:
+    name: inspec

data/.kitchen.yml

@@ -6,23 +6,35 @@ driver:
   name: docker
   provision_command: curl -L https://www.chef.io/chef/install.sh | bash
 
+transport:
+  name: docker
+
 provisioner:
   name: dummy
 
 platforms:
-- name: ubuntu-12.04
-- name: ubuntu-14.04
+- name: amazonlinux-2
 - name: ubuntu-16.04
+- name: ubuntu-18.04
+- name: fedora-latest
+  driver:
+    provision_command:
+    - yum install libxcrypt-compat.x86_64 -y
+    - curl -L https://www.chef.io/chef/install.sh | bash
 - name: centos-6
 - name: centos-7
-- name: debian
-- name: arch
-  driver:
-    image: base/archlinux
-    provision_command: true
+- name: oraclelinux-6
+- name: oraclelinux-7
+- name: debian-8
+- name: debian-9
+# Removing opensuse CI tests temporarily due to an issue with the Chef install script not providing 
+# the correct platform name for opensuse resulting in consistent failures for this platform
+#- name: opensuse-42.3
+#  driver:
+#    image: opensuse/leap:42.3
 - name: unknown
   driver:
-    image: ubuntu:12.04
+    image: ubuntu:16.04
     platform: ubuntu
 - name: dockerfile
   driver:
@@ -39,7 +51,7 @@ suites:
   driver:
     build_context: false
 - name: capabilities
-  excludes: [arch,unknown,centos-7,centos-6,dockerfile]
+  includes: [debian-8,debian-9,ubuntu-16.04,ubuntu-18.04]
   driver:
     provision_command:
     - curl -L https://www.chef.io/chef/install.sh | bash

data/.travis.yml

@@ -1,22 +1,57 @@
-sudo: required
-dist: trusty
-language: ruby
-
-rvm:
-- "2.1.9"
-- "2.2.5"
-- "2.3.1"
+matrix:
+  include:
+    - os: linux
+      rvm: 2.4.9
+      dist: xenial
+      language: ruby
+      cache: bundler
+      script:
+        - bundle exec docker version
+        - bundle exec kitchen --version
+        - bundle exec rake spec
+        - bundle exec kitchen test -d always
+    - os: linux
+      rvm: 2.5.7
+      dist: xenial
+      language: ruby
+      cache: bundler
+      script:
+        - bundle exec docker version
+        - bundle exec kitchen --version
+        - bundle exec rake spec
+        - bundle exec kitchen test -d always
+    - os: linux
+      rvm: 2.6.5
+      dist: xenial
+      language: ruby
+      cache: bundler
+      script:
+        - bundle exec docker version
+        - bundle exec kitchen --version
+        - bundle exec rake spec
+        - bundle exec kitchen test -d always
+    - os: windows
+      language: bash
+      install:
+        - choco uninstall ruby
+        - choco install ruby --version=2.6.5.1
+        - export PATH=$(echo "$PATH" | sed -e 's/:\/c\/tools\/ruby27\/bin//')
+        - export PATH=$PATH:/c/tools/ruby26/bin
+        - choco install mingw
+        - choco install msys2
+        - ridk.cmd exec pacman -S --noconfirm --needed base-devel mingw-w64-x86_64-toolchain mingw-w64-x86_64-libxslt
+      script:
+        - if [[ $(tasklist | grep "gpg-agent") ]]; then taskkill -IM "gpg-agent.exe" -F; else echo "Process gpg-agent not found. Skipping."; fi        
+        - powershell -ExecutionPolicy Bypass -NoLogo -File docker.ps1
+        - export KITCHEN_YAML=.kitchen.windows.yml
+        - ruby -v
+        - gem install bundler
+        - bundle config build.nokogiri --use-system-libraries
+        - bundle install
+        - bundle exec docker version
+        - bundle exec kitchen --version
+        - bundle exec rake spec
+        - bundle exec kitchen test -d always
 
 services:
 - docker
-
-cache:
-  bundler: true
-  directories:
-  - /var/lib/docker
-
-script:
-- bundle exec docker version
-- bundle exec kitchen --version
-- bundle exec rake spec
-- bundle exec kitchen test -d always

data/CHANGELOG.md

@@ -1,5 +1,46 @@
 # Kitchen-Docker Changelog
 
+## 2.11.0 - July 2, 2021
+
+* Update the development dependency on kitchen-inspec to 2.x
+* Retrieve hostname state data after container is launched to avoid failures when `use_internal_docker_network` is set
+* Add a new option for setting container isolation. See the readme for additional details
+* Support GPUs in containers with a new `gpus` option that takes the same arguments that would be passed to `docker run --gpus`
+* suse platform: use system script for ssh key initialization
+* Add support for the `--mount` docker CLI option. See the readme for additional details
+* Use sudo.d files instead of directly editing the sudoers file
+* Allow passing `--tmpfs` entries to the docker run command. See the readme for additional details
+* Use less verbose and quicker setup on Gentoo
+* Lowercase the instance-name to avoid issues since docker does not allow instance with capital cases
+* Fix the error "Could not parse Docker build output for image ID" by improving the output line matching
+* Add support for `almalinux` & `rockylinux`
+
+## 2.10.0 - Mar 28, 2020
+
+* Switched from require to require_relative to slightly improve load time performance
+* Allow for train gem 3.x
+* Refactor driver to include Windows support (includes new transport for all supported platforms)
+
+## 2.9.0 - Mar 15, 2019
+
+* Add automatic OS detection for amazonlinux, opensuse/leap, and opensuse/tumbleweed
+* On Fedora containers uses dnf to setup the OS not yum
+
+## 2.8.0 - Jan 18, 2019
+
+* Add new config option `use_internal_docker_network`, which allows running Docker within Docker. See readme for usage details.
+* Resolve errors while loading libraries on archlinux
+* Fix failures on Ubuntu 18.04
+* Check if image exists before attempting to remove it so we don't fail
+* Add oraclelinux platform support
+* Prevent `uninitialized constant Kitchen::Driver::Docker::Base64` error by requiring `base64`
+
+## 2.7.0
+
+* Support for SUSE-based container images.
+* Improved support for build context shipping.
+* Changed `use_sudo` to default to `false` in keeping with modern Docker usage.
+
 ## 2.6.0
 
 * Set container name with information from the run so you can identify them

data/README.md

@@ -1,12 +1,13 @@
 # Kitchen-Docker
 
-[![Build Status](https://img.shields.io/travis/test-kitchen/kitchen-docker.svg)](https://travis-ci.org/test-kitchen/kitchen-docker)
+[![Build Status](https://travis-ci.org/test-kitchen/kitchen-docker.svg?branch=master)](https://travis-ci.org/test-kitchen/kitchen-docker)
 [![Gem Version](https://img.shields.io/gem/v/kitchen-docker.svg)](https://rubygems.org/gems/kitchen-docker)
 [![Coverage](https://img.shields.io/codecov/c/github/test-kitchen/kitchen-docker.svg)](https://codecov.io/github/test-kitchen/kitchen-docker)
-[![Gemnasium](https://img.shields.io/gemnasium/test-kitchen/kitchen-docker.svg)](https://gemnasium.com/test-kitchen/kitchen-docker)
 [![License](https://img.shields.io/badge/license-Apache_2-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
 
-A Test Kitchen Driver for Docker.
+A Test Kitchen Driver and Transport for Docker.
+
+***MAINTAINERS WANTED***: This Test-Kitchen driver is currently without a maintainer and has many known issues. If you're interested in maintaining this driver for the long run including expanding the CI testing please reach out on [Chef Community Slack: #test-kitchen](https://chefcommunity.slack.com/archives/C2B6G1WCQ). Until such a time that this driver is maintained we highly recommend the [kitchen-dokken](https://github.com/test-kitchen/kitchen-dokken) for Chef Infra testing with Docker containers.
 
 ## Requirements
 
@@ -16,12 +17,14 @@ A Test Kitchen Driver for Docker.
 
 Please read the Test Kitchen [docs][test_kitchen_docs] for more details.
 
-Example `.kitchen.local.yml`:
+Example (Linux) `.kitchen.local.yml`:
 
 ```yaml
 ---
 driver:
   name: docker
+  env_variables:
+    TEST_KEY: TEST_VALUE
 
 platforms:
 - name: ubuntu
@@ -33,6 +36,30 @@ platforms:
     platform: rhel
   run_list:
   - recipe[yum]
+
+transport:
+  name: docker
+```
+
+Example (Windows) `.kitchen.local.yml`:
+
+```yaml
+---
+driver:
+  name: docker
+
+platforms:
+- name: windows
+  driver_config:
+    image: mcr.microsoft.com/windows/servercore:1607
+    platform: windows
+  run_list:
+  - recipe[chef_client]
+
+transport:
+  name: docker
+  env_variables:
+    TEST_KEY: TEST_VALUE
 ```
 
 ## Default Configuration
@@ -45,8 +72,8 @@ Examples:
 ```yaml
 ---
 platforms:
-- name: ubuntu-12.04
-- name: centos-6.4
+- name: ubuntu-18.04
+- name: centos-7
 ```
 
 This will effectively generate a configuration similar to:
@@ -54,13 +81,13 @@ This will effectively generate a configuration similar to:
 ```yaml
 ---
 platforms:
-- name: ubuntu-12.04
+- name: ubuntu-18.04
   driver_config:
-    image: ubuntu:12.04
+    image: ubuntu:18.04
     platform: ubuntu
-- name: centos-6.4
+- name: centos-7
   driver_config:
-    image: centos:6.4
+    image: centos:7
     platform: centos
 ```
 
@@ -84,11 +111,9 @@ Examples:
 
 ### socket
 
-The Docker daemon socket to use. By default, Docker will listen on
-`unix:///var/run/docker.sock`, and no configuration here is required. If
-Docker is binding to another host/port or Unix socket, you will need to set
-this option. If a TCP socket is set, its host will be used for SSH access
-to suite containers.
+The Docker daemon socket to use. By default, Docker will listen on `unix:///var/run/docker.sock` (On Windows, `npipe:////./pipe/docker_engine`),
+and no configuration here is required. If Docker is binding to another host/port or Unix socket, you will need to set this option.
+If a TCP socket is set, its host will be used for SSH access to suite containers.
 
 Examples:
 
@@ -100,6 +125,29 @@ Examples:
   socket: tcp://docker.example.com:4242
 ```
 
+If you are using the InSpec verifier on Windows, using named pipes for the Docker engine will not work with the Docker transport.
+Set the socket option with the TCP socket address of the Docker engine as shown below:
+```yaml
+socket: tcp://localhost:2375
+```
+
+The Docker engine must be configured to listen on a TCP port (default port is 2375). This can be configured by editing the configuration file
+(usually located in `C:\ProgramData\docker\config\daemon.json`) and adding the hosts value:
+```
+"hosts": ["tcp://0.0.0.0:2375"]
+```
+
+Example configuration is shown below:
+```
+{
+  "registry-mirrors": [],
+  "insecure-registries": [],
+  "debug": true,
+  "experimental": false,
+  "hosts": ["tcp://0.0.0.0:2375"]
+}
+```
+
 If you use [Boot2Docker](https://github.com/boot2docker/boot2docker)
 or [docker-machine](https://docs.docker.com/machine/get-started/) set
 your `DOCKER_HOST` environment variable properly with `export
@@ -110,7 +158,6 @@ $MACHINE)"` then use the following:
 socket: tcp://192.168.59.103:2375
 ```
 
-
 ### image
 
 The Docker image to use as the base for the suite containers. You can find
@@ -119,14 +166,30 @@ images using the [Docker Index][docker_index].
 The default will be computed, using the platform name (see the Default
 Configuration section for more details).
 
+### isolation
+
+The isolation technology for the container. This is not set by default and will use the default container isolation settings.
+
+For example, the following driver configuration options can be used to specify the container isolation technology for Windows containers:
+```yaml
+# Hyper-V
+isolation: hyperv
+
+# Process
+isolation: process
+```
+
 ### platform
 
 The platform of the chosen image. This is used to properly bootstrap the
 suite container for Test Kitchen. Kitchen Docker currently supports:
 
+* `arch`
 * `debian` or `ubuntu`
-* `rhel` or `centos`
+* `amazonlinux`, `rhel`, `centos`, `fedora`, `oraclelinux`, `almalinux` or `rockylinux`
 * `gentoo` or `gentoo-paludis`
+* `opensuse/tumbleweed`, `opensuse/leap`, `opensuse` or `sles`
+* `windows`
 
 The default will be computed, using the platform name (see the Default
 Configuration section for more details).
@@ -175,6 +238,17 @@ driver_config:
   provision_command: curl -L https://www.opscode.com/chef/install.sh | bash
   require_chef_omnibus: false
 ```
+### env_variables
+
+Adds environment variables to Docker container
+
+Examples:
+
+```yaml
+  env_variables:
+    TEST_KEY_1: TEST_VALUE
+    SOME_VAR: SOME_VALUE
+```
 
 ### use\_cache
 
@@ -253,6 +327,39 @@ Examples:
   - rvm
 ```
 
+### mount
+
+Attach a filesystem mount to the container (**NOTE:** supported only in docker
+17.05 and newer).
+
+Examples:
+
+```yaml
+  mount: type=volume,source=my-volume,destination=/path/in/container
+```
+
+```yaml
+  mount:
+  - type=volume,source=my-volume,destination=/path/in/container
+  - type=tmpfs,tmpfs-size=512M,destination=/path/to/tmpdir
+```
+
+### tmpfs
+
+Adds a tmpfs volume(s) to the suite container.
+
+Examples:
+
+```yaml
+  tmpfs: /tmp
+```
+
+```yaml
+  tmpfs:
+  - /tmp:exec
+  - /run
+```
+
 ### dns
 
 Adjusts `resolv.conf` to use the dns servers specified. Otherwise use
@@ -476,6 +583,19 @@ Examples:
     net: br3
 ```
 
+### use_internal_docker_network
+
+If you want to use kitchen-docker from within another Docker container you'll
+need to set this to true. When set to true uses port 22 as the SSH port and
+the IP of the container that chef is going to run in as the hostname so that
+you can connect to it over SSH from within another Docker container.
+
+Examples:
+
+```yaml
+  use_internal_docker_network: true
+```
+
 ## Development
 
 * Source hosted at [GitHub][repo]
@@ -515,7 +635,7 @@ limitations under the License.
 [docker_upstart_issue]:   https://github.com/dotcloud/docker/issues/223
 [docker_index]:           https://index.docker.io/
 [docker_default_image]:   https://index.docker.io/_/base/
-[test_kitchen_docs]:      http://kitchen.ci/docs/getting-started/
+[test_kitchen_docs]:      https://kitchen.ci/docs/getting-started/introduction/
 [chef_omnibus_dl]:        https://downloads.chef.io/chef-client/
 [cpu_shares]:             https://docs.fedoraproject.org/en-US/Fedora/17/html/Resource_Management_Guide/sec-cpu.html
 [memory_limit]:           https://docs.fedoraproject.org/en-US/Fedora/17/html/Resource_Management_Guide/sec-memory.html