kitchen-docker-api 0.1.0

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.kitchen/
+.kitchen.local.yml

data/.kitchen.yml

@@ -0,0 +1,14 @@
+---
+driver:
+  name: docker
+
+provisioner:
+  name: dummy
+
+platforms:
+  - name: ubuntu-12.04
+  - name: centos-6.4
+  - name: unknown
+
+suites:
+  - name: default

data/.tailor

@@ -0,0 +1,4 @@
+Tailor.config do |config|
+  config.formatters "text"
+  config.file_set 'lib/**/*.rb'
+end

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+
+rvm:
+- 2.0.0
+- 1.9.3
+- 1.9.2
+- ruby-head
+
+matrix:
+  allow_failures:
+  - rvm: ruby-head

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## 0.8.0 
+
+* Initial fork from kitchen-docker
+* Supports docker version < 0.9

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,15 @@
+Author:: Aaron Nichols <anichols@trumped.org>
+
+Copyright (C) 2014, Aaron Nichols
+
+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.

data/README.md

@@ -0,0 +1,291 @@
+# Kitchen::Docker
+
+A Test Kitchen Driver for Docker. This driver utilizes the
+[docker-api](https://github.com/swipely/docker-api) gem as the docker
+client making a CLI client unnecessary. If you would prefer a docker
+driver which uses the docker CLI you should look at the original
+[kitchen-docker](https://github.com/portertech/kitchen-docker) from
+which this fork originated. 
+
+Substantial credit for this driver goes to Sean Porter for the CLI
+implmentation & his support in developing the docker-api based version.
+We ultimately decided it would be best to have two versions so folks
+could choose to use the CLI or docker-api based client. 
+
+## Requirements
+
+* [Docker][docker_getting_started] 
+
+## Known Issues
+
+* Upstart is neutered due to [this issue][docker_upstart_issue].
+
+## Installation and Setup
+
+Please read the Test Kitchen [docs][test_kitchen_docs] for more details.
+
+Example `.kitchen.local.yml`:
+
+```
+---
+driver_plugin: docker
+
+platforms:
+- name: ubuntu
+  run_list:
+  - recipe[apt]
+- name: centos
+  driver_config:
+    image: centos
+    platform: rhel
+  run_list:
+  - recipe[yum]
+```
+
+## Default Configuration
+
+This driver can determine an image and platform type for a select number of
+platforms. Currently, the following platform names are supported:
+
+```
+---
+platforms:
+- name: ubuntu-12.04
+- name: centos-6.4
+```
+
+This will effectively generate a configuration similar to:
+
+```
+---
+platforms:
+- name: ubuntu-12.04
+  driver_config:
+    image: ubuntu:12.04
+    platform: ubuntu
+- name: centos-6.4
+  driver_config:
+    image: centos:6.4
+    platform: centos
+```
+
+## Configuration
+
+### 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.
+
+Examples:
+
+```
+  socket: unix:///tmp/docker.sock
+```
+
+```
+  socket: tcp://docker.example.com:4242
+```
+
+### image
+
+The Docker image to use as the base for the suite containers. You can find
+images using the [Docker Index][docker_index].
+
+The default will be determined by the Platform name, if a default exists
+(see the Default Configuration section for more details). If a default
+cannot be computed, then the default value is `base`, an official Ubuntu
+[image][docker_default_image].
+
+### platform
+
+The platform of the chosen image. This is used to properly bootstrap the
+suite container for Test Kitchen. Kitchen Docker currently supports:
+
+* `debian` or `ubuntu`
+* `rhel` or `centos`
+
+The default will be determined by the Platform name, if a default exists
+(see the Default Configuration section for more details). If a default
+cannot be computed, then the default value is `ubuntu`.
+
+### require\_chef\_omnibus
+
+Determines whether or not a Chef [Omnibus package][chef_omnibus_dl] will be
+installed. There are several different behaviors available:
+
+* `true` - the latest release will be installed. Subsequent converges
+  will skip re-installing if chef is present.
+* `latest` - the latest release will be installed. Subsequent converges
+  will always re-install even if chef is present.
+* `<VERSION_STRING>` (ex: `10.24.0`) - the desired version string will
+  be passed the the install.sh script. Subsequent converges will skip if
+  the installed version and the desired version match.
+* `false` or `nil` - no chef is installed.
+
+The default value is `true`.
+
+### provision\_command
+
+Custom command(s) to be run when provisioning the base for the suite containers.
+
+Examples:
+
+```
+  provision_command: curl -L https://www.opscode.com/chef/install.sh | bash
+```
+
+```
+  provision_command:
+    - apt-get install dnsutils
+    - apt-get install telnet
+```
+
+```
+driver_config:
+  provision_command: curl -L https://www.opscode.com/chef/install.sh | bash
+  require_chef_omnibus: false
+```
+
+### remove\_images
+
+This determines if images are automatically removed when the suite container is
+destroyed.
+
+The default value is `false`.
+
+### run_command
+
+Sets the command used to run the suite container.
+
+The default value is `/usr/sbin/sshd -D -o UseDNS=no -o UsePAM=no`.
+
+Examples:
+
+```
+  run_command: /sbin/init
+```
+
+### memory
+
+Sets the memory limit for the suite container in bytes. Otherwise use Dockers
+default. You can read more about `memory.limit_in_bytes` [here][memory_limit].
+
+### cpu
+
+Sets the CPU shares (relative weight) for the suite container. Otherwise use
+Dockers defaults. You can read more about cpu.shares [here][cpu_shares].
+
+### volume
+
+Adds a data volume(s) to the suite container.
+
+Examples:
+
+```
+  volume: /ftp
+```
+
+```
+  volume:
+  - /ftp
+  - /srv
+```
+
+## dns
+
+Adjusts `resolv.conf` to use the dns servers specified. Otherwise use
+Dockers defaults.
+
+Examples:
+
+```
+  dns: 8.8.8.8
+```
+
+```
+  dns:
+  - 8.8.8.8
+  - 8.8.4.4
+```
+
+### forward
+
+Set suite container port(s) to forward to the host machine. You may specify
+the host (public) port in the mappings, if not, Docker chooses for you.
+
+Examples:
+
+```
+  forward: 80
+```
+
+```
+  forward:
+  - 22:2222
+  - 80:8080
+```
+
+### hostname
+
+Set the suite container hostname. Otherwise use Dockers default.
+
+Examples:
+
+```
+  hostname: foobar.local
+```
+
+### privileged
+
+Run the suite container in privileged mode. This allows certain functionality
+inside the Docker container which is not otherwise permitted.
+
+The default value is `false`.
+
+Examples:
+
+```
+  privileged: true
+```
+
+## Development
+
+* Source hosted at [GitHub][repo]
+* Report issues/questions/feature requests on [GitHub Issues][issues]
+
+Pull requests are very welcome! Make sure your patches are well tested.
+Ideally create a topic branch for every separate change you make. For
+example:
+
+1. Fork the repo
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Authors
+
+Created and maintained by [Aaron Nichols][author] (<anichols@trumped.org>)
+
+Original kitchen-docker by [Sean Porter](<portertech@gmail.com>)
+
+## License
+
+Apache 2.0 (see [LICENSE][license])
+
+
+[author]:                 https://github.com/adnichols
+[issues]:                 https://github.com/adnichols/kitchen-docker-api/issues
+[license]:                https://github.com/adnichols/kitchen-docker-api/blob/master/LICENSE
+[repo]:                   https://github.com/adnichols/kitchen-docker-api
+[docker_getting_started]: http://www.docker.io/gettingstarted/
+[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/
+[chef_omnibus_dl]:        http://www.opscode.com/chef/install/
+[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

data/Rakefile

@@ -0,0 +1,28 @@
+require "bundler/gem_tasks"
+require 'cane/rake_task'
+require 'tailor/rake_task'
+
+desc "Run cane to check quality metrics"
+Cane::RakeTask.new do |cane|
+  cane.canefile = './.cane'
+end
+
+Tailor::RakeTask.new
+
+desc "Display LOC stats"
+task :stats do
+  puts "\n## Production Code Stats"
+  sh "countloc -r lib"
+end
+
+desc "Run all quality tasks"
+task :quality => [:cane, :tailor, :stats]
+
+task :default => [:quality]
+
+begin
+  require 'kitchen/rake_tasks'
+  Kitchen::RakeTasks.new
+rescue LoadError
+  puts ">>>>> Kitchen gem not loaded, omitting tasks" unless ENV['CI']
+end

data/kitchen-docker-api.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kitchen/driver/docker_version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'kitchen-docker-api'
+  spec.version       = Kitchen::Driver::DOCKER_VERSION
+  spec.authors       = ['Sean Porter', 'Aaron Nichols']
+  spec.email         = ['anichols@trumped.org']
+  spec.description   = %q{A Test Kitchen Driver for Docker - docker-api based}
+  spec.summary       = spec.description
+  spec.homepage      = 'https://github.com/adnichols/kitchen-docker-api'
+  spec.license       = 'Apache 2.0'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = []
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'test-kitchen', '>= 1.0.0'
+  spec.add_dependency 'docker-api', '~> 1.9.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+
+  spec.add_development_dependency 'cane'
+  spec.add_development_dependency 'tailor'
+  spec.add_development_dependency 'countloc'
+end

data/lib/kitchen/driver/docker.rb

@@ -0,0 +1,211 @@
+# -*- encoding: utf-8 -*-
+#
+# Copyright (C) 2014, Aaron Nichols
+#
+# 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 'json'
+require 'docker'
+
+module Kitchen
+
+  module Driver
+
+    # Docker driver
+    class Docker < Kitchen::Driver::SSHBase
+
+      default_config :socket,        'unix:///var/run/docker.sock'
+      default_config :privileged,    false
+      default_config :remove_images, false
+      default_config :run_command,   '/usr/sbin/sshd -D -o UseDNS=no -o UsePAM=no'
+      default_config :username,      'kitchen'
+      default_config :password,      'kitchen'
+      default_config :read_timeout,  300
+
+      default_config :image do |driver|
+        driver.default_image
+      end
+
+      default_config :platform do |driver|
+        driver.default_platform
+      end
+
+      def initialize(*args)
+        super(*args)
+        @docker_connection = ::Docker::Connection.new(config[:socket], :read_timeout => config[:read_timeout])
+        if Kitchen.logger.debug?
+          ::Docker.logger = Kitchen.logger
+        end
+      end
+
+      def default_image
+        platform, release = instance.platform.name.split('-')
+        release ? [platform, release].join(':') : 'base'
+      end
+
+      def default_platform
+        platform, release = instance.platform.name.split('-')
+        release ? platform : 'ubuntu'
+      end
+
+      def create(state)
+        state[:image_id] = create_image(state) unless state[:image_id]
+        state[:container_id] = create_container(state) unless state[:container_id]
+        state[:hostname] = container_ssh_host
+        state[:port] = container_ssh_port(state)
+        wait_for_sshd(state[:hostname], nil, :port => state[:port])
+      end
+
+      def destroy(state)
+        destroy_container(state) if state[:container_id]
+        if config[:remove_images] && state[:image_id]
+          destroy_image(state)
+        end
+      end
+
+      protected
+
+      def socket_uri
+        URI.parse(config[:socket])
+      end
+
+      def remote_socket?
+        config[:socket] ? socket_uri.scheme == 'tcp' : false
+      end
+
+      def dockerfile
+        from = "FROM #{config[:image]}"
+        platform = case config[:platform]
+        when 'debian', 'ubuntu'
+          <<-eos
+            ENV DEBIAN_FRONTEND noninteractive
+            RUN dpkg-divert --local --rename --add /sbin/initctl
+            RUN ln -sf /bin/true /sbin/initctl
+            RUN apt-get update
+            RUN apt-get install -y sudo openssh-server curl lsb-release
+          eos
+        when 'rhel', 'centos'
+          <<-eos
+            RUN yum clean all
+            RUN yum install -y sudo openssh-server openssh-clients curl
+            RUN ssh-keygen -t rsa -f /etc/ssh/ssh_host_rsa_key
+            RUN ssh-keygen -t dsa -f /etc/ssh/ssh_host_dsa_key
+          eos
+        else
+          raise ActionFailed,
+            "Unknown platform '#{config[:platform]}'"
+        end
+        username = config[:username]
+        password = config[:password]
+        base = <<-eos
+          RUN mkdir -p /var/run/sshd
+          RUN useradd -d /home/#{username} -m -s /bin/bash #{username}
+          RUN echo #{username}:#{password} | chpasswd
+          RUN echo '#{username} ALL=(ALL) NOPASSWD:ALL' >> /etc/sudoers
+        eos
+        custom = ''
+        Array(config[:provision_command]).each do |cmd|
+          custom << "RUN #{cmd}\n"
+        end
+        [from, platform, base, custom].join("\n")
+      end
+
+      def container_config(state)
+        data = {
+          :Cmd => config[:run_command].split,
+          :Image => state[:image_id],
+          :AttachStdout => true,
+          :AttachStderr => true,
+          :Privileged => config[:privileged],
+          :PublishAllPorts => false
+        }
+        data[:CpuShares] = config[:cpu] if config[:cpu]
+        data[:Dns] = config[:dns] if config[:dns]
+        data[:Hostname] = config[:hostname] if config[:hostname]
+        data[:Memory] = config[:memory] if config[:memory]
+        forward = ['22'] + Array(config[:forward]).map { |mapping| mapping.to_s }
+        forward.compact!
+        data[:PortSpecs] = forward
+        data[:PortBindings] = forward.inject({}) do |bindings, mapping|
+          guest_port, host_port = mapping.split(':').reverse
+          bindings["#{guest_port}/tcp"] = [{
+            :HostIp => '',
+            :HostPort => host_port || ''
+          }]
+          bindings
+        end
+        data[:Volumes] = Hash[Array(config[:volume]).map { |volume| [volume, {}] }]
+        data
+      end
+
+      def parse_log_chunk(chunk)
+        if ::Kitchen.logger.debug?
+          logger.debug chunk
+        else
+          parsed_chunk = JSON.parse(chunk)
+          parsed_chunk.each do |k, v|
+            if [ "stream", "status" ].include? k
+              logger.info parsed_chunk[k].strip
+            end
+          end
+        end
+      end
+
+      def create_image(state, opts = {})
+        info("Fetching Docker base image '#{config[:image]}' and building...")
+        opts[:rm] = config[:remove_images]
+        image = ::Docker::Image.build(dockerfile, opts, @docker_connection) do |chunk|
+          parse_log_chunk(chunk)
+        end
+        image.id
+      end
+
+      def create_container(state)
+        config_data = container_config(state)
+        container = ::Docker::Container.create(config_data, @docker_connection)
+        container.start(config_data)
+        container.id
+      end
+
+      def docker_image(state)
+        ::Docker::Image.get(state[:image_id], nil, @docker_connection)
+      end
+
+      def docker_container(state)
+        ::Docker::Container.get(state[:container_id], nil, @docker_connection)
+      end
+
+      def container_ssh_host
+        remote_socket? ? socket_uri.host : 'localhost'
+      end
+
+      def container_ssh_port(state)
+        container = docker_container(state)
+        container.json['NetworkSettings']['Ports']['22/tcp'].first['HostPort']
+      end
+
+      def destroy_container(state)
+        container = docker_container(state)
+        container.stop
+        container.wait
+        container.delete
+      end
+
+      def destroy_image(state)
+        image = docker_image(state)
+        image.remove
+      end
+    end
+  end
+end

data/lib/kitchen/driver/docker_version.rb

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+#
+# Copyright (C) 2014, Aaron Nichols
+#
+# 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.
+
+module Kitchen
+
+  module Driver
+
+    # Version string for Docker Kitchen driver
+    DOCKER_VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: kitchen-docker-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Sean Porter
+- Aaron Nichols
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-kitchen
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: docker-api
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cane
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tailor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: countloc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Test Kitchen Driver for Docker - docker-api based
+email:
+- anichols@trumped.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .kitchen.yml
+- .tailor
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- kitchen-docker-api.gemspec
+- lib/kitchen/driver/docker.rb
+- lib/kitchen/driver/docker_version.rb
+homepage: https://github.com/adnichols/kitchen-docker-api
+licenses:
+- Apache 2.0
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A Test Kitchen Driver for Docker - docker-api based
+test_files: []