kitchen-docker_adv 0.0.1

data/.gitignore

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

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,3 @@
+## 0.1.0 / Unreleased
+
+* Initial release

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,16 @@
+Author:: Sean Porter (<portertech@gmail.com>)
+
+Copyright (C) 2014, Sean Porter
+
+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,66 @@
+# <a name="title"></a> Kitchen::DockerAdv
+
+A Test Kitchen Driver for Docker.
+
+## <a name="requirements"></a> Requirements
+
+**TODO:** document any software or library prerequisites that are required to
+use this driver. Implement the `#verify_dependencies` method in your Driver
+class to enforce these requirements in code, if possible.
+
+## <a name="installation"></a> Installation and Setup
+
+Please read the [Driver usage][driver_usage] page for more details.
+
+## <a name="config"></a> Configuration
+
+**TODO:** Write descriptions of all configuration options
+
+### <a name="config-require-chef-omnibus"></a> 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 unset, or `nil`.
+
+## <a name="development"></a> 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
+
+## <a name="authors"></a> Authors
+
+Created by [Sean Porter][original-author]
+
+Maintained by [Gattsu][author]
+
+## <a name="license"></a> License
+
+Apache 2.0 (see [LICENSE][license])
+
+[original-author]:           https://github.com/Sean-Porter
+[author]:           https://github.com/gattsublackswordsman
+[issues]:           https://github.com/gattsublackswordsman/kitchen-docker_adv/issues
+[license]:          https://github.com/gattsublackswordsman/kitchen-docker_adv/blob/master/LICENSE
+[repo]:             https://github.com/gattsublackswordsman/kitchen-docker_adv
+[driver_usage]:     http://docs.kitchen-ci.org/drivers/usage
+[chef_omnibus_dl]:  http://www.getchef.com/chef/install/

data/Rakefile

@@ -0,0 +1,21 @@
+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]

data/kitchen-docker_adv.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kitchen/driver/docker_adv_version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'kitchen-docker_adv'
+  spec.version       = Kitchen::Driver::DOCKER_ADV_VERSION
+  spec.authors       = ['Gattsu']
+  spec.email         = ['gattsu.blackswordsman@gmail.com']
+  spec.description   = %q{A Test Kitchen Driver for Docker}
+  spec.summary       = spec.description
+  spec.homepage      = ''
+  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.2.0.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/erb.rb

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+#
+# Copyright (C) 2014, Sean Porter
+#
+# 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'
+
+module Kitchen
+
+  module Driver
+
+    class DockerERBContext
+      def initialize(config={})
+        config.each do |key, value|
+          instance_variable_set('@' + key.to_s, value)
+        end
+      end
+
+      def get_binding
+        binding
+      end
+    end
+  end
+end

data/lib/kitchen/driver/docker_adv.rb

@@ -0,0 +1,286 @@
+# -*- encoding: utf-8 -*-
+#
+# Copyright (C) 2014, Sean Porter
+#
+# 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 'uri'
+require File.join(File.dirname(__FILE__), 'docker', 'erb')
+
+module Kitchen
+
+  module Driver
+
+    # DockerAdv driver for Kitchen.
+    #
+    # @author Gattsu <Gattsu@gmail.com>
+    class DockerAdv < Kitchen::Driver::SSHBase
+
+      default_config :binary,        'docker'
+      default_config :socket,        'unix:///var/run/docker.sock'
+      default_config :privileged,    true
+      default_config :capadd,        true
+      default_config :module,        '1'
+      default_config :branch,        'trunk'
+      default_config :regression,    'V0.0.0'
+      default_config :environment,   'integration'
+      default_config :use_cache,     true
+      default_config :remove_images, false
+      default_config :run_command,   '/usr/sbin/sshd -D -o UseDNS=no -o UsePAM=no -o UsePrivilegeSeparation=no -o PidFile=/tmp/sshd.pid'
+      default_config :username,      'kitchen'
+      default_config :password,      'kitchen'
+      default_config :tls,           false
+      default_config :tls_verify,    false
+      default_config :tls_cacert,    nil
+      default_config :tls_cert,      nil
+      default_config :tls_key,       nil
+      default_config :svn_base,      'https://svn.domain.com/svn/proj1/'
+      default_config :svn_user,      'svnuser'
+      default_config :svn_pwd,       'svnpwd'
+
+      default_config :use_sudo do |driver|
+        !driver.remote_socket?
+      end
+
+      default_config :image do |driver|
+        driver.default_image
+      end
+
+      default_config :platform do |driver|
+        driver.default_platform
+      end
+
+      default_config :disable_upstart, true
+
+      def verify_dependencies
+        run_command("#{config[:binary]} > /dev/null", :quiet => true)
+        rescue
+          raise UserError,
+          'You must first install the Docker CLI tool http://www.docker.io/gettingstarted/'
+      end
+
+      def default_image
+        platform, release = instance.platform.name.split('-')
+        if platform == "centos" && release
+          release = "centos" + release.split('.').first
+        end
+        release ? [platform, release].join(':') : platform
+      end
+
+      def default_platform
+        instance.platform.name.split('-').first
+      end
+
+      def create(state)
+        state[:image_id] = build_image(state) unless state[:image_id]
+        state[:container_id] = run_container(state) unless state[:container_id]
+        state[:hostname] = remote_socket? ? socket_uri.host : 'localhost'
+        state[:port] = container_ssh_port(state)
+        wait_for_sshd(state[:hostname], nil, :port => state[:port])
+      end
+
+      def destroy(state)
+        rm_container(state) if container_exists?(state)
+        if config[:remove_images] && state[:image_id]
+          rm_image(state)
+        end
+      end
+
+      def remote_socket?
+        config[:socket] ? socket_uri.scheme == 'tcp' : false
+      end
+
+      protected
+
+      def socket_uri
+        URI.parse(config[:socket])
+      end
+
+      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]
+        run_command("#{docker} #{cmd}", options.merge(:quiet => !logger.debug?))
+      end
+
+      def build_dockerfile
+        from = "FROM #{config[:image]}"
+        platform = case config[:platform]
+        when 'debian', 'ubuntu'
+          disable_upstart = <<-eos
+            RUN dpkg-divert --local --rename --add /sbin/initctl
+            RUN ln -sf /bin/true /sbin/initctl
+          eos
+          packages = <<-eos
+            ENV DEBIAN_FRONTEND noninteractive
+            RUN apt-get update
+            RUN apt-get install -y sudo openssh-server curl lsb-release
+          eos
+          config[:disable_upstart] ? disable_upstart + packages : packages
+        when 'rhel', 'centos'
+          <<-eos
+            RUN yum clean all
+            RUN yum install -y sudo openssh-server openssh-clients which curl
+            RUN ssh-keygen -t rsa -f /etc/ssh/ssh_host_rsa_key -N ''
+            RUN ssh-keygen -t dsa -f /etc/ssh/ssh_host_dsa_key -N ''
+          eos
+        when 'arch'
+          <<-eos
+            RUN pacman -Syu --noconfirm
+            RUN pacman -S --noconfirm openssh sudo curl
+            RUN ssh-keygen -A -t rsa -f /etc/ssh/ssh_host_rsa_key
+            RUN ssh-keygen -A -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 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 dockerfile
+        if config[:dockerfile]
+          template = IO.read(File.expand_path(config[:dockerfile]))
+          context = DockerERBContext.new(config.to_hash)
+          ERB.new(template).result(context.get_binding)
+        else
+          build_dockerfile
+        end
+      end
+
+      def parse_image_id(output)
+        output.each_line do |line|
+          if line =~ /image id|build successful|successfully built/i
+            return line.split(/\s+/).last
+          end
+        end
+        raise ActionFailed,
+        'Could not parse Docker build output for image ID'
+      end
+
+      def build_image(state)
+        cmd = "build"
+        cmd << " --no-cache" unless config[:use_cache]
+        cmd << " --build-arg module=#{config[:module]}" if config[:module]
+        cmd << " --build-arg branch=#{config[:branch]}" if config[:branch]
+        cmd << " --build-arg regression=#{config[:regression]}" if config[:regression]
+        cmd << " --build-arg environment=#{config[:environment]}" if config[:environment]
+        cmd << " --build-arg svn_base=#{config[:svn_base]}" if config[:svn_base]
+        cmd << " --build-arg svn_user=#{config[:svn_user]}" if config[:svn_user]
+        cmd << " --build-arg svn_pwd=#{config[:svn_pwd]}" if config[:svn_pwd]
+        cmd << " --build-arg proxy_user=#{config[:proxy_user]}" if config[:proxy_user]
+        cmd << " --build-arg proxy_pwd=#{config[:proxy_pwd]}" if config[:proxy_pwd]
+        output = docker_command("#{cmd} -", :input => dockerfile)
+        parse_image_id(output)
+      end
+
+      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 build_run_command(image_id)
+        cmd = "run -d -p 22"
+        Array(config[:forward]).each {|port| cmd << " -p #{port}"}
+        Array(config[:dns]).each {|dns| cmd << " -dns #{dns}"}
+        Array(config[:volume]).each {|volume| cmd << " -v #{volume}"}
+        Array(config[:volumes_from]).each {|container| cmd << " --volumes-from #{container}"}
+        cmd << " -h #{config[:hostname]}" if config[:hostname]
+        cmd << " -m #{config[:memory]}" if config[:memory]
+        cmd << " -c #{config[:cpu]}" if config[:cpu]
+        cmd << " --privileged"
+        cmd << " --cap-add ALL"
+        cmd << " -e http_proxy='#{config[:http_proxy]}'" if config[:http_proxy]
+        cmd << " -p 3000:3000" if config[:rails]
+        cmd << " -e https_proxy='#{config[:https_proxy]}'" if config[:https_proxy]
+        cmd << " -e module=#{config[:module]}" 
+        cmd << " -e branch=#{config[:branch]}"
+        cmd << " -e regression=#{config[:regression]}"
+        cmd << " -e environment=#{config[:environment]}" 
+        cmd << " -e svn_base=#{config[:svn_base]}"
+        cmd << " -e svn_user=#{config[:svn_user]}"
+        cmd << " -e svn_pwd=#{config[:svn_pwd]}"
+        cmd << " -e proxy_user=#{config[:proxy_user]}"
+        cmd << " -e proxy_pwd=#{config[:proxy_pwd]}"
+        cmd << " #{image_id} #{config[:run_command]}"
+        cmd
+      end
+
+      def run_container(state)
+        cmd = build_run_command(state[:image_id])
+        output = docker_command(cmd)
+        parse_container_id(output)
+      end
+
+      def inspect_container(state)
+        container_id = state[:container_id]
+	if container_id
+          docker_command("inspect #{container_id} " + %q[| awk -F"=" '$1 !~ /svn_user|svn_pwd|proxy_user|proxy_pwd|http_proxy|https_proxy/ {print $0}; $1 ~ /svn_user|svn_pwd|proxy_user|proxy_pwd|http_proxy|https_proxy/ {print $1 "=*****\","}'])
+        end
+      end
+
+      def container_exists?(state)
+        !!inspect_container(state) rescue false
+      end
+
+      def parse_container_ssh_port(output)
+        begin
+          info = Array(::JSON.parse(output)).first
+          ports = info['NetworkSettings']['Ports'] || info['HostConfig']['PortBindings']
+          ssh_port = ports['22/tcp'].detect {|port| port['HostIp'] == '0.0.0.0'}
+          ssh_port['HostPort'].to_i
+        rescue
+          raise ActionFailed,
+          'Could not parse Docker inspect output for container SSH port'
+        end
+      end
+
+      def container_ssh_port(state)
+        output = inspect_container(state)
+        parse_container_ssh_port(output)
+      end
+
+      def rm_container(state)
+        container_id = state[:container_id]
+        docker_command("stop #{container_id}")
+        docker_command("rm -f #{container_id}")
+      end
+
+      def rm_image(state)
+        image_id = state[:image_id]
+        docker_command("rmi #{image_id}")
+      end
+    end
+  end
+end

data/lib/kitchen/driver/docker_adv_version.rb

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+#
+# Copyright (C) 2014, Sean Porter
+#
+# 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 DockerAdv Kitchen driver
+    DOCKER_ADV_VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: kitchen-docker_adv
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Gattsu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-17 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.2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0.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
+email:
+- gattsu.blackswordsman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .cane
+- .gitignore
+- .tailor
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- kitchen-docker_adv.gemspec
+- lib/kitchen/driver/docker/erb.rb
+- lib/kitchen/driver/docker_adv.rb
+- lib/kitchen/driver/docker_adv_version.rb
+homepage: ''
+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
+test_files: []
+has_rdoc: