cide 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 879d029028c2a327c2408a454a5f53d5eb62f228
-  data.tar.gz: f08ca0dc63f6b81748ee498cd813f4c4f5e0cf57
+  metadata.gz: c84c09a6870e5146c1a42a86e03e1d01a2dc74aa
+  data.tar.gz: 4a4b246cc68b455bd26c8185c6dde9aaa1a6e8b5
 SHA512:
-  metadata.gz: 50435c37507f74d08ad919a0dd5726d5a492ec14005748cbcd2b532e85e7b720ed524a6b8212e2eb42f2a7f98506f1aaf581a74051b4da717a59faff42ad00da
-  data.tar.gz: 5d168e00d5dc07d2458f6fbb4b42d76d8219aef4ae6ff30b7241c4d45a542e09dd04b0b83c4cd04433a0c3ed707c374383a027761e8e8d5f40a25e46f717a1f6
+  metadata.gz: 8e69cb3488d0a15e18ab4031083aa3c33c720757236d28135de981e0d98ea8dbeb95807d48a236b4617492551880049129cee649a49508288b7d9e22c0662dbf
+  data.tar.gz: 8b0a452b1d6a159f4362dc11674576d9c6ca34c9b6c56a0b1bdab0727b64ee07a6d13dfdcc2df93838d662048cb5817292ed5951e8d95170fe58ccbe6fc51dae

data/.editorconfig

@@ -0,0 +1,13 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+[*.rb]
+indent_style = space
+indent_size = 2

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation -rspec_helper

data/.rubocop.yml

@@ -1,33 +1,50 @@
+AllCops:
+  Exclude:
+    - 'spec/**/*'
+
+# Rubocop is not smart enough
+Metrics/AbcSize:
+  Max: 100
+
 # CIDE::CLI is essentially a big dispatcher, no need to break it
 # in smaller chunks.
 Metrics/ClassLength:
   Max: 200
 
+# Offense count: 28
+Metrics/CyclomaticComplexity:
+  Max: 15
+
 # CIDE::CLI methods can be read top to bottom. No need to factor out
 # functionality unless it can be shared.
 Metrics/MethodLength:
   Max: 60
 
+Metrics/PerceivedComplexity:
+  Max: 20
+
 # Don't align stuff vertically, bad for diffing
 Style/AlignParameters:
   EnforcedStyle: with_fixed_indentation
 
-# Allows for easy diffing
-# Keep them sorted alphabetically unless a meaningful order exists
-Style/TrailingComma:
-  EnforcedStyleForMultiline: comma
+# Don't obsess over missing documentation for now
+Style/Documentation:
+  Enabled: false
 
-# $? is not equivalent to $CHILD_STATUS
-Style/SpecialGlobalVars:
+# Don't agree with rubocop here
+Style/MultilineOperationIndentation:
   Enabled: false
 
 # Prefering the short style
 Style/PerlBackrefs:
   Enabled: false
 
-# Offense count: 28
-Metrics/CyclomaticComplexity:
-  Max: 15
+# $? is not equivalent to $CHILD_STATUS
+Style/SpecialGlobalVars:
+  Enabled: false
+
+# Allows for easy diffing
+# Keep them sorted alphabetically unless a meaningful order exists
+Style/TrailingComma:
+  EnforcedStyleForMultiline: comma
 
-Metrics/PerceivedComplexity:
-  Max: 20

data/CHANGELOG.md

@@ -1,4 +1,14 @@
 
+0.2.0 / 2015-04-15
+==================
+
+  * NEW: .cide.yml schema loader
+  * NEW: Support for linked containers
+  * NEW: Much better build output
+  * CHANGE: Docker version: 1.5.0+ is required
+  * FIX: Avoid name clashes with projects who have a Dockerfile already
+  * FIX: cide --export
+
 0.1.1 / 2015-01-27
 ==================
 

data/Gemfile.lock

@@ -2,34 +2,76 @@ PATH
   remote: .
   specs:
     cide (0.1.1)
-      thor
+      thor (~> 0.19.0)
+      virtus (~> 1.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (4.2.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
     ast (2.0.0)
     astrolabe (1.3.0)
       parser (>= 2.2.0.pre.3, < 3.0)
-    parser (2.2.0.pre.4)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    equalizer (0.0.11)
+    i18n (0.7.0)
+    ice_nine (0.11.1)
+    json (1.8.1)
+    minitest (5.4.3)
+    parser (2.2.0.3)
       ast (>= 1.1, < 3.0)
-      slop (~> 3.4, >= 3.4.5)
-    powerpack (0.0.9)
+    powerpack (0.1.0)
     rainbow (2.0.0)
-    rake (10.1.0)
-    rubocop (0.26.1)
+    rake (10.4.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    rubocop (0.30.0)
       astrolabe (~> 1.3)
-      parser (>= 2.2.0.pre.4, < 3.0)
-      powerpack (~> 0.0.6)
+      parser (>= 2.2.0.1, < 3.0)
+      powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.4)
-    ruby-progressbar (1.6.0)
-    slop (3.6.0)
+    ruby-progressbar (1.7.5)
     thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  activesupport
   cide!
   rake
+  rspec
   rubocop

data/README.md

@@ -20,7 +20,7 @@ Example
 `.cide.yml`
 ```
 ---
-image: "ruby:2.1"
+from: "ruby:2.1"
 as_root:
 - apt-get update -qy && apt-get install -qy libxml2-dev
 command: bundle && bundle exec rspec
@@ -32,35 +32,34 @@ Features
 * straighforward to use, just run `cide` inside of your project
 * works on OSX with boot2docker
 * integrates easily with jenkins or other CI systems
+* can run with linked containers
 
 Limitations
 -----------
 
-A temporary Dockerfile has to be created in the project's root because docker
-doesn't allow referencing files outside of the directory (even with a symlink)
+Docker version 1.5.0+ is required
 
 Installation
 ------------
 
 Install docker: https://docs.docker.com/installation/#installation
 
-```
+```sh
 gem install cide
 ```
 
 OSX docker install:
-```
+```sh
 brew install boot2docker
 boot2docker init
 boot2docker up
 # cide auto-detects boot2docker on OSX
 ```
 
-TODO
-----
+Similar projects
+----------------
+
+* [Docker Compose](https://docs.docker.com/compose/) - Docker development environment
 
-* linked container
-* schema validation
-* find a way to import SSH keys
-* cleaner output. on error is just outputs a backtrace
+Open an issue if a project is missing.
 

data/Rakefile

@@ -1,5 +1,7 @@
 require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
 
-task default: [:rubocop]
+task default: [:spec, :rubocop]
 
 RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new

data/cide.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name          = 'cide'
-  s.version       = '0.1.1'
+  s.version       = '0.2.0'
   s.authors       = ['zimbatm']
   s.email         = ['zimbatm@zimbatm.com']
   s.summary       = 'CI docker runner'
@@ -13,14 +13,17 @@ DESC
   s.homepage      = 'https://github.com/zimbatm/cide'
   s.license       = 'MIT'
 
-  s.executables  << 'cide'
+  s.executables   = ['cide']
   s.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   s.test_files    = `git ls-files spec`.split($INPUT_RECORD_SEPARATOR)
   s.require_paths = ['lib']
 
   s.required_ruby_version = '>= 1.9.3'
 
-  s.add_runtime_dependency 'thor'
+  s.add_runtime_dependency 'thor', '~> 0.19.0'
+  s.add_runtime_dependency 'virtus', '~> 1.0.0'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'activesupport'
 end

data/lib/cide/build/config.rb

@@ -0,0 +1,84 @@
+require 'virtus'
+
+require 'erb'
+require 'yaml'
+
+require 'cide/build/config_loader'
+
+module CIDE
+  module Build
+    class Config
+      DOCKERFILE_TEMPLATE =
+        File.expand_path('../../dockerfile_template.erb', __FILE__)
+
+      module NiceInspect
+        def inspect
+          out = []
+          attributes.each_pair do |key, value|
+            out << "#{key}=#{value.inspect}"
+          end
+          "<#{out.join(' ')}>"
+        end
+      end
+
+      class Step
+        include Virtus.model(strict: true)
+        include NiceInspect
+        attribute :add, Array[String], default: []
+        attribute :forward_env, Array[String], default: []
+        attribute :run, Array[String], default: []
+      end
+
+      class Link
+        include Virtus.model
+        include NiceInspect
+        attribute :name, String
+        attribute :image, String
+        attribute :env, Hash[String, String]
+        attribute :run, String
+        # Container ID added after the fact
+        attr_accessor :id
+      end
+
+      include Virtus.model(strict: true)
+      include NiceInspect
+      attribute :from, String, default: 'ubuntu'
+      attribute :as_root, Array[String], default: []
+      attribute :use_ssh, Boolean, default: false
+      attribute :before, Step, required: false
+      attribute :forward_env, Array[String], default: []
+      attribute :export_dir, String, required: false
+      attribute :links, Array[Link], default: []
+      attribute :run, String, default: 'script/ci'
+
+      attr_reader :warnings, :errors
+
+      def initialize(*)
+        super
+        @warnings = []
+        @errors = []
+      end
+
+      def to_dockerfile
+        ERB.new(File.read(DOCKERFILE_TEMPLATE), nil, '<>-').result(binding)
+      end
+
+      def self.load_file(file_path, output = $stderr)
+        obj = new
+        loader = ConfigLoader.new(obj)
+        loader.load YAML.load_file(file_path)
+
+        obj.warnings.each do |warn|
+          output.puts "WARN: #{warn}"
+        end
+
+        obj.errors.each do |error|
+          output.puts "ERROR: #{error}"
+        end
+
+        return obj if obj.errors.empty?
+        nil
+      end
+    end
+  end
+end

data/lib/cide/build/config_loader.rb

@@ -0,0 +1,227 @@
+module CIDE
+  module Build
+    class ConfigLoader
+      class Path
+        attr_reader :to_s
+        def initialize(str)
+          @to_s = str.to_s
+        end
+
+        def append(value)
+          self.class.new(
+            @to_s + (value.is_a?(Integer) ? "[#{value}]" : ".#{value}"),
+          )
+        end
+      end
+
+      def initialize(config)
+        @config = config
+      end
+
+      def load(data)
+        data.each_pair do |key, value|
+          key = key.to_s
+          path = Path.new(key)
+          case key
+          when 'from', 'image' then
+            wanted_key(path, 'from', key)
+            @config.from = expect_string(path, value)
+          when 'as_root' then
+            @config.as_root = expect_array(path, value)
+          when 'use_ssh' then
+            @config.use_ssh = expect_boolean(path, value)
+          when 'before' then
+            @config.before = maybe_step(path, value)
+          when 'forward_env' then
+            @config.forward_env = expect_array(path, value)
+          when 'export_dir' then
+            @config.export_dir = maybe_string(path, value)
+          when 'link', 'links' then
+            @config.links = expect_links(path, value)
+          when 'run', 'command' then
+            wanted_key(path, 'run', key)
+            @config.run = expect_string(path, value)
+          else
+            unknown_key(path)
+          end
+        end
+        @config
+      end
+
+      protected
+
+      def wanted_key(path, wanted_key, key)
+        return if key == wanted_key
+        @config.warnings <<
+          "#{path} is deprecated. use '#{wanted_key}' instead."
+      end
+
+      def unknown_key(path)
+        @config.warnings << "Unknown key #{path}"
+      end
+
+      def type_error(path, wanted_type, value)
+        @config.errors <<
+          "expected #{path} to be a #{wanted_type} but got a #{value.class}"
+      end
+
+      def expect_string(path, value)
+        case value
+        when String, Symbol, Integer
+          value.to_s
+        else
+          type_error(path, 'string', value)
+          ''
+        end
+      end
+
+      def maybe_string(path, value)
+        case value
+        when String, Symbol
+          value.to_s
+        when nil
+          nil
+        else
+          type_error(path, 'string or nil', value)
+          nil
+        end
+      end
+
+      def maybe_step(path, value)
+        case value
+        when String, Symbol, Array then
+          load_step(path, run: value)
+        when Hash then
+          load_step(path, value)
+        when nil then
+          nil
+        else
+          type_error(path, 'string, array, hash or nil', value)
+          nil
+        end
+      end
+
+      def load_step(path, data)
+        step = Config::Step.new
+        data.each_pair do |key, value|
+          key = key.to_s
+          path_ = path.append(key)
+          case key
+          when 'run' then
+            step.run = expect_array(path_, value)
+          when 'forward_env' then
+            step.forward_env = expect_array(path_, value)
+          when 'add' then
+            step.add = expect_array(path_, value)
+          else
+            unknown_key(path_)
+          end
+        end
+        step
+      end
+
+      def expect_links(path, value)
+        array = []
+        case value
+        when String, Symbol, Hash then
+          array << expect_link(path, value)
+        when Array then
+          value.compact.each_with_index do |value_, i|
+            array << expect_link(path.append(i), value_)
+          end
+        when nil then
+          # nothing to do
+        else
+          type_error(path, 'string, array of links, hash or nil', value)
+        end
+        array.compact
+      end
+
+      def expect_link(path, value)
+        case value
+        when String, Symbol then
+          load_link(path, name: value, image: value)
+        when Hash
+          load_link(path, value)
+        else
+          type_error(path, 'string or hash expected', value)
+        end
+      end
+
+      def load_link(path, data)
+        link = Config::Link.new
+        data.each_pair do |key, value|
+          key = key.to_s
+          path_ = path.append(key)
+          case key
+          when 'name' then
+            link.name = expect_string(path_, value)
+          when 'image', 'from' then
+            wanted_key(path_, 'image', key)
+            link.image = expect_string(path_, value)
+          when 'env' then
+            link.env = expect_env(path_, value)
+          when 'run' then
+            link.run = maybe_string(path_, value)
+          else
+            unknown_key(path_)
+          end
+        end
+        link.name ||= link.image
+        link.image ||= link.name
+        if link.name.nil?
+          type_error(
+            path,
+            'expected hash to either declare the name or image',
+            data,
+          )
+          return nil
+        end
+        link
+      end
+
+      def expect_boolean(path, value)
+        case value
+        when true then
+          true
+        when false then
+          false
+        else
+          type_error(path, 'boolean', value)
+          false
+        end
+      end
+
+      def expect_array(path, value)
+        array = []
+        case value
+        when Array then
+          value.compact.each_with_index do |value_, i|
+            array << expect_string(path.append(i), value_)
+          end
+        when String, Symbol then
+          array << value.to_s
+        when nil then
+          # nothing to do
+        else
+          type_error(path, 'array of string, string or nil', value)
+        end
+        array.compact
+      end
+
+      def expect_env(path, value)
+        case value
+        when Hash then
+          hash = {}
+          value.each_pair do |key, value_|
+            hash[key.to_s] = expect_string(path.append(key.to_s), value_)
+          end
+          hash
+        else
+          type_error(path, 'hash', value)
+          {}
+        end
+      end
+    end
+  end
+end

data/lib/cide/build.rb

@@ -0,0 +1,2 @@
+require 'cide/build/config'
+require 'cide/build/config_loader'

data/lib/cide/cli.rb

@@ -0,0 +1,195 @@
+require 'cide/constants'
+require 'cide/docker'
+require 'cide/build'
+
+require 'thor'
+
+require 'json'
+require 'time'
+
+module CIDE
+  # Command-line option-parsing and execution for cide
+  class CLI < Thor
+    include CIDE::Docker
+    include Thor::Actions
+    add_runtime_options!
+
+    default_command 'build'
+
+    desc 'build', 'Builds an image and executes the run script'
+
+    method_option 'name',
+      desc: 'Name of the build',
+      aliases: %w(n t),
+      default: File.basename(Dir.pwd)
+
+    method_option 'export',
+      desc: 'Whenever to export artifacts',
+      type: :boolean,
+      default: nil
+
+    method_option 'export_dir',
+      desc: 'Change the ouput directory on the host',
+      aliases: %w(o host_export_dir),
+      default: nil
+
+    method_option 'run',
+      desc: 'Override the script to run',
+      aliases: ['r'],
+      default: nil
+
+    method_option 'ssh_key',
+      desc: 'Path to a ssh key to import into the docker image',
+      aliases: ['s'],
+      default: '~/.ssh/id_rsa'
+
+    def build
+      containers = []
+
+      setup_docker
+
+      ## Config ##
+      banner 'Config'
+      build = Build::Config.load_file CONFIG_FILE
+      exit 1 if build.nil?
+      export_dir = options.export_dir || File.dirname(build.export_dir)
+      build.run = options.run if options.run
+      name = CIDE::Docker.id options.name
+      tag = "cide/#{name}"
+      say_status :config, build.inspect
+
+      ## Build ##
+      banner 'Build'
+      if build.use_ssh
+        unless File.exist?(options.ssh_key)
+          fail ArgumentError, "SSH key #{options.ssh_key} not found"
+        end
+
+        create_tmp_file SSH_CONFIG_FILE, File.read(SSH_CONFIG_PATH)
+        create_tmp_file TEMP_SSH_KEY, File.read(build.ssh_key)
+      end
+      create_tmp_file DOCKERFILE, build.to_dockerfile
+      docker :build, '--force-rm', '--pull', '-f', DOCKERFILE, '-t', tag, '.'
+
+      ## CI ##
+      banner 'Run'
+      build.links.each do |link|
+        args = ['--detach']
+        link.env.each_pair do |key, value|
+          args.push('--env', [key, value].join('='))
+        end
+        args << link.image
+        args << link.run if link.run
+        link.id = docker(:run, *args, capture: true).strip
+        containers << link.id
+      end
+
+      run_options = ['--detach']
+
+      build.forward_env.each do |env|
+        run_options.push '--env', [env, ENV[env]].join('=')
+      end
+
+      build.links.each do |link|
+        run_options.push '--link', [link.id, link.name].join(':')
+      end
+
+      run_options.push tag
+      run_options.push build.run
+
+      id = docker(:run, *run_options, capture: true).strip
+      containers << id
+      docker(:attach, id)
+
+      ## Export ##
+      return unless options.export
+      banner 'Export'
+      fail 'export flag set but no export_dir given' if build.export_dir.nil?
+
+      guest_export_dir = File.expand_path(build.export_dir, CIDE_SRC_DIR)
+      host_export_dir  = File.expand_path(export_dir, Dir.pwd)
+      docker :cp, [id, guest_export_dir].join(':'), host_export_dir
+    rescue Docker::Error => ex
+      exit ex.exitstatus
+    ensure
+      # Shutdown old containers
+      unless containers.empty?
+        docker :rm, '--force', *containers.reverse,
+          verbose: false,
+          capture: true
+      end
+    end
+
+    desc 'clean', 'Removes old containers'
+    method_option 'days',
+      desc: 'Number of days to keep the images',
+      default: 7,
+      type: :numeric
+    method_option 'count',
+      desc: 'Maximum number of images to keep',
+      default: 10,
+      type: :numeric
+    def clean
+      setup_docker
+
+      days_to_keep = options[:days]
+      max_images = options[:count]
+
+      x = docker('images', '--no-trunc', capture: true)
+      iter = x.lines.each
+      iter.next
+      cide_image_ids = iter
+        .map { |line| line.split(/\s+/) }
+        .select { |line| line[0] =~ %r{^cide/} || line[0] == '<none>' }
+        .map { |line| line[2] }
+
+      if cide_image_ids.empty?
+        puts 'No images found to be cleaned'
+        return
+      end
+
+      x = docker('inspect', *cide_image_ids, capture: true)
+      cide_images = JSON.parse(x.strip)
+        .each { |image| image['Created'] = Time.iso8601(image['Created']) }
+        .sort { |a, b| a['Created'] <=> b['Created'] }
+
+      if cide_images.size > max_images
+        old_cide_images = cide_images[0..-max_images]
+          .map { |image| image['Id'] }
+      else
+        old_times = Time.now - (days_to_keep * 24 * 60 * 60)
+        old_cide_images = cide_images
+          .select { |image| image['Created'] < old_times }
+          .map { |image| image['Id'] }
+      end
+
+      if old_cide_images.empty?
+        puts 'No images found to be cleaned'
+        return
+      end
+
+      docker('rmi', *old_cide_images)
+    end
+
+    desc 'init', "Creates a blank #{CONFIG_FILE} into the project"
+    def init
+      puts "Creating #{CONFIG_FILE} with default values"
+      create_file CONFIG_FILE, File.read(DEFAULT_CIDEFILE)
+    end
+
+    private
+
+    def create_tmp_file(destination, *args, &block)
+      create_file(destination, *args, &block)
+      at_exit do
+        remove_file(destination, verbose: false)
+      end
+    end
+
+    LINE_SIZE = 78.0
+    def banner(text)
+      pad = (LINE_SIZE - text.size - 4) / 2
+      puts '=' * pad.floor + "[ #{text} ]" + '=' * pad.ceil
+    end
+  end
+end

data/lib/cide/constants.rb

@@ -0,0 +1,12 @@
+module CIDE
+  dir = File.expand_path('..', __FILE__)
+  DOCKERFILE = 'Dockerfile.cide'
+  DEFAULT_CIDEFILE = File.join(dir, 'default_cide.yml')
+  TEMP_SSH_KEY = 'id_rsa.tmp'
+  SSH_CONFIG_FILE = 'ssh_config'
+  SSH_CONFIG_PATH = File.join(dir, SSH_CONFIG_FILE)
+  CONFIG_FILE = '.cide.yml'
+  CIDE_DIR = '/cide'
+  CIDE_SRC_DIR = File.join(CIDE_DIR, 'src')
+  CIDE_SSH_DIR = File.join(CIDE_DIR, '.ssh')
+end

data/lib/cide/default_cide.yml

@@ -0,0 +1,9 @@
+---
+# See https://github.com/zimbatm/cide
+from: ubuntu
+as_root: []
+forward_env: []
+before:
+use_ssh: false
+export_dir:
+run: script/ci

data/lib/cide/docker.rb

@@ -17,6 +17,8 @@ module CIDE
       end
     end
 
+    class VersionError < StandardError; end
+
     def docker(*args, **opts)
       setup_docker
 
@@ -42,6 +44,13 @@ module CIDE
             .lines
             .grep(/export (\w+)=(.*)/) { ENV[$1] = $2.strip }
         end
+
+        # Check docker version
+        unless `docker version 2>/dev/null` =~ /Client version: ([^\s]+)/
+          fail VersionError, 'Unknown docker version'
+        end
+        fail VersionError, "Docker version #{$1} too old" if $1 < '1.5.0'
+
         true
       )
     end

data/lib/{cide_template.erb → cide/dockerfile_template.erb}

@@ -26,16 +26,16 @@ RUN chown -R cide:cide <%= CIDE_DIR %>
 
 # Before
 
-<% if before['run'] -%>
-  <% before['forward_env'].to_a.each do |key| -%>
+<% if before -%>
+  <% before.forward_env.each do |key| -%>
 ENV <%= key %> <%= ENV[key] %>
   <% end %>
-  <% before['add'].to_a.each do |file| -%>
+  <% before.add.each do |file| -%>
 ADD <%= file %> <%= File.expand_path(file, CIDE_SRC_DIR) %>
   <% end %>
 RUN chown -R cide:cide <%= CIDE_DIR %>
 USER cide
-RUN <%= before['run'] %>
+RUN <%= before.run %>
 USER root
 <% end -%>
 
@@ -43,14 +43,3 @@ USER root
 
 ADD . <%= CIDE_SRC_DIR %>
 RUN chown -R cide:cide <%= CIDE_DIR %>
-
-# ENV
-
-<% forward_env.to_a.each do |key| -%>
-ENV <%= key %> <%= ENV[key] %>
-<% end %>
-
-# Test !
-
-USER cide
-RUN <%= run %>

data/lib/cide.rb

@@ -1,229 +1,7 @@
-require 'erb'
-require 'json'
-require 'optparse'
-require 'time'
-require 'yaml'
-
-require 'thor'
-
-require 'cide/docker'
-
 # CIDE is a Continuous Integration Docker Environment runner
 #
 # The juicy bits are defined in CIDE::CLI
 module CIDE
-  DIR = File.expand_path('..', __FILE__)
-  DOCKERFILE = 'Dockerfile'
-  TEMP_SSH_KEY = 'id_rsa.tmp'
-  DOCKERFILE_TEMPLATE = File.join(DIR, 'cide_template.erb')
-  SSH_CONFIG_FILE = 'ssh_config'
-  SSH_CONFIG_PATH = File.join(DIR, SSH_CONFIG_FILE)
-  CONFIG_FILE = '.cide.yml'
-
-  CIDE_DIR = '/cide'
-  CIDE_SRC_DIR = File.join(CIDE_DIR, '/src')
-  CIDE_SSH_DIR = File.join(CIDE_DIR, '/.ssh')
-
-  def self.struct(opts = {}, &block)
-    Class.new(Struct.new(*opts.keys), &block).new(*opts.values)
-  end
-
-  DefaultConfig = struct(
-    name: nil,
-    from: 'ubuntu',
-    as_root: [],
-    forward_env: [],
-    before: {},
-    export: false,
-    export_dir: './artifacts',
-    host_export_dir: nil,
-    run: 'script/ci',
-    use_ssh: false,
-    ssh_key: '~/.ssh/id_rsa',
-  ) do
-
-    alias_method :image=, :from=
-    alias_method :command=, :run=
-
-    def name=(str)
-      super CIDE::Docker.id(str)
-    end
-
-    def ssh_key_path
-      File.expand_path(ssh_key)
-    end
-
-    def to_dockerfile
-      ERB.new(File.read(DOCKERFILE_TEMPLATE), nil, '<>-').result(binding)
-    end
-
-    def merge!(opts = {})
-      opts.each_pair { |k, v| public_send("#{k}=", v) }
-      self
-    end
-
-    def merge(opts = {})
-      dup.merge!(opts)
-    end
-
-    def to_yaml
-      members.each_with_object({}) do |k, obj|
-        v = self[k]
-        obj[k.to_s] = v unless v.nil?
-      end.to_yaml
-    end
-  end
-
-  # Command-line option-parsing and execution for cide
-  class CLI < Thor
-    include CIDE::Docker
-    include Thor::Actions
-    add_runtime_options!
-
-    default_command 'build'
-
-    desc 'build', 'Builds an image and executes the run script'
-
-    method_option 'name',
-      desc: 'Name of the build',
-      aliases: %w(n t),
-      default: nil
-
-    method_option 'host_export_dir',
-      desc: 'Output directory on host to put build artefacts in',
-      aliases: ['o'],
-      default: nil
-
-    method_option 'export',
-      desc: 'Are we expecting to export artifacts',
-      type: :boolean,
-      default: nil
-
-    method_option 'run',
-      desc: 'The script to run',
-      aliases: ['r'],
-      default: nil
-
-    method_option 'ssh_key',
-      desc: 'Path to a ssh key to import into the docker image',
-      aliases: ['s'],
-      default: '~/.ssh/id_rsa'
-
-    def build
-      setup_docker
-
-      config = DefaultConfig.merge YAML.load_file(CONFIG_FILE)
-      options.each_pair do |k, v|
-        config[k] = v unless v.nil?
-      end
-      config.name ||= File.basename(Dir.pwd)
-      config.host_export_dir ||= config.export_dir
-
-      tag = "cide/#{config.name}"
-
-      if config.use_ssh
-        unless File.exist?(config.ssh_key_path)
-          fail MalformattedArgumentError, "SSH key #{config.ssh_key} not found"
-        end
-
-        create_tmp_file SSH_CONFIG_FILE, File.read(SSH_CONFIG_PATH)
-        create_tmp_file TEMP_SSH_KEY, File.read(config.ssh_key_path)
-      end
-
-      say_status :config, config.to_h
-
-      create_tmp_file DOCKERFILE, config.to_dockerfile
-
-      docker :build, '--force-rm', '-t', tag, '.'
-
-      return unless config.export
-
-      unless config.export_dir
-        fail 'Fail: export flag set but no export dir given'
-      end
-
-      id = docker(:run, '-d', tag, true, capture: true).strip
-      begin
-        guest_export_dir = File.expand_path(config.export_dir, CIDE_SRC_DIR)
-
-        host_export_dir = File.expand_path(
-          config.host_export_dir || config.export_dir,
-          Dir.pwd,
-        )
-
-        docker :cp, [id, guest_export_dir].join(':'), host_export_dir
-
-      ensure
-        docker :rm, '-f', id
-      end
-    rescue Docker::Error => ex
-      exit ex.exitstatus
-    end
-
-    desc 'clean', 'Removes old containers'
-    method_option 'days',
-      desc: 'Number of days to keep the images',
-      default: 7,
-      type: :numeric
-    method_option 'count',
-      desc: 'Maximum number of images to keep',
-      default: 10,
-      type: :numeric
-    def clean
-      setup_docker
-
-      days_to_keep = options[:days]
-      max_images = options[:count]
-
-      x = docker('images', '--no-trunc', capture: true)
-      iter = x.lines.each
-      iter.next
-      cide_image_ids = iter
-        .map { |line| line.split(/\s+/) }
-        .select { |line| line[0] =~ /^cide\// || line[0] == '<none>' }
-        .map { |line| line[2] }
-
-      if cide_image_ids.empty?
-        puts 'No images found to be cleaned'
-        return
-      end
-
-      x = docker('inspect', *cide_image_ids, capture: true)
-      cide_images = JSON.parse(x.strip)
-        .each { |image| image['Created'] = Time.iso8601(image['Created']) }
-        .sort { |a, b| a['Created'] <=> b['Created'] }
-
-      if cide_images.size > max_images
-        old_cide_images = cide_images[0..-max_images]
-          .map { |image| image['Id'] }
-      else
-        old_times = Time.now - (days_to_keep * 24 * 60 * 60)
-        old_cide_images = cide_images
-          .select { |image| image['Created'] < old_times }
-          .map { |image| image['Id'] }
-      end
-
-      if old_cide_images.empty?
-        puts 'No images found to be cleaned'
-        return
-      end
-
-      docker('rmi', *old_cide_images)
-    end
-
-    desc 'init', "Creates a blank #{CONFIG_FILE} into the project"
-    def init
-      puts "Creating #{CONFIG_FILE} with default values"
-      create_file CONFIG_FILE, DefaultConfig.to_yaml
-    end
-
-    private
-
-    def create_tmp_file(destination, *args, &block)
-      create_file(destination, *args, &block)
-      at_exit do
-        remove_file(destination, verbose: false)
-      end
-    end
-  end
 end
+
+require 'cide/cli'

data/spec/build_config_loader_spec.rb

@@ -0,0 +1,116 @@
+require "cide/build"
+require "stringio"
+require "ostruct"
+require "active_support/json"
+
+describe "CIDE::Build::Config::Loader" do
+  before do
+    @config = CIDE::Build::Config.new
+    @loader = CIDE::Build::ConfigLoader.new(@config)
+  end
+
+  default_config = {
+    "from" => "ubuntu",
+    "as_root" => [],
+    "use_ssh" => false,
+    "before" => nil,
+    "forward_env" => [],
+    "export_dir" => nil,
+    "links" => [],
+    "run" => "script/ci",
+  }
+
+  it "works - empty config" do
+    @loader.load({})
+    expect(@config.as_json).to eq(default_config)
+    expect(@config.warnings).to eq([])
+    expect(@config.errors).to eq([])
+  end
+
+  it "works2 - full config" do
+    full_config = {
+      "from" => "god",
+      "as_root" => ["one", "two"],
+      "use_ssh" => true,
+      "before" => {
+        "add" => ["zzz", "yyy"],
+        "forward_env" => ["HOME"],
+        "run" => ["a", "b"],
+      },
+      "forward_env" => ["PWD"],
+      "links" => [
+        {"name" => "redis", "image" => "redis2:foo", "env" => {"HOME" => "/"}, "run" => "redis-server"}
+      ],
+      "export_dir" => "./artifacts",
+      "run" => "do/something",
+    }
+
+    @loader.load(full_config)
+
+    expect(@config.as_json).to eq(default_config.merge(full_config))
+    expect(@config.warnings).to eq([])
+    expect(@config.errors).to eq([])
+  end
+
+  it "coerces things around" do
+    @loader.load(
+      as_root: "xxxxx",
+      before: :zzzzz,
+      links: ["mysql", {image: "redis", env: {PATH: "/bin"}}, nil],
+      forward_env: ["HOME", nil, 555]
+    )
+
+    expect(@config.to_h.as_json).to eq(default_config.merge(
+      "as_root" => ["xxxxx"],
+      "before" => {
+        "add" => [],
+        "forward_env" => [],
+        "run" => ["zzzzz"],
+      },
+      "links" => [
+        {"name" => "mysql", "image" => "mysql", "run" => nil, "env" => {}},
+        {"name" => "redis", "image" => "redis", "run" => nil, "env" => {"PATH" => "/bin"}},
+      ],
+      "forward_env" => ["HOME", "555"],
+    ))
+    expect(@config.warnings).to eq([])
+    expect(@config.errors).to eq([])
+  end
+
+  it "notifies deprecations" do
+    @loader.load(
+      image: "foo",
+      command: "lol",
+      zzz: 4,
+    )
+    expect(@config.as_json).to eq(default_config.merge(
+      "from" => "foo",
+      "run" => "lol",
+    ))
+    expect(@config.warnings).to eq([
+      "image is deprecated. use 'from' instead.",
+      "command is deprecated. use 'run' instead.",
+      "Unknown key zzz",
+    ])
+    expect(@config.errors).to eq([])
+  end
+
+  it "reports type errors" do
+    @loader.load(
+      as_root: ["aaa", Time.now],
+      forward_env: {},
+      links: {},
+    )
+
+    expect(@config.to_h.as_json).to eq(default_config.merge(
+      "as_root" => ["aaa", ""],
+    ))
+    expect(@config.warnings).to eq([])
+    expect(@config.errors).to eq([
+      "expected as_root[1] to be a string but got a Time",
+      "expected forward_env to be a array of string, string or nil but got a Hash",
+      "expected links to be a expected hash to either declare the name or image but got a Hash",
+    ])
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+$:.unshift File.expand_path('../../lib', __FILE__)

metadata

@@ -1,23 +1,51 @@
 --- !ruby/object:Gem::Specification
 name: cide
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - zimbatm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-27 00:00:00.000000000 Z
+date: 2015-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -25,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +67,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -63,7 +105,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".cide.yml"
+- ".editorconfig"
 - ".gitignore"
+- ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
@@ -76,9 +120,17 @@ files:
 - cide
 - cide.gemspec
 - lib/cide.rb
+- lib/cide/build.rb
+- lib/cide/build/config.rb
+- lib/cide/build/config_loader.rb
+- lib/cide/cli.rb
+- lib/cide/constants.rb
+- lib/cide/default_cide.yml
 - lib/cide/docker.rb
-- lib/cide_template.erb
-- lib/ssh_config
+- lib/cide/dockerfile_template.erb
+- lib/cide/ssh_config
+- spec/build_config_loader_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/zimbatm/cide
 licenses:
 - MIT
@@ -99,8 +151,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: CI docker runner
-test_files: []
+test_files:
+- spec/build_config_loader_spec.rb
+- spec/spec_helper.rb