cide 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3dd99e04fa0893686988a2e80fc1082d5dcab15
-  data.tar.gz: a2df7f906f19db7e98e47829d3864d05bf75cb0a
+  metadata.gz: cc53228b6d632d1c764d54c902e48d811ab2bc2c
+  data.tar.gz: 0bd7d12a1190e1a2f12c066a53147bb0d62b71a7
 SHA512:
-  metadata.gz: 867b9f04b9ae236496e92bcc6b81eb8f434412de87591e7691ebf2ceb0c24c0e76f93274cda4abe191eee6838ea72598bfe2ed14a2e6db7009058f8581238ce7
-  data.tar.gz: 93b5c43787f8bca0ca068a1fe232fe7bf4891b2a314f09f31cd79b422706aabab9661ff47fa03e1e7408a0807f49a0c04fe60b9db45413a3bf69e84bd034a67e
+  metadata.gz: 93cdf9ff055f8828493f60a29a55fdf21b83b8d77f56390881c79203a484ea767f82fd0eb0cf6dd1f577558a38f7e8206d9d6ee44151cbf4e383f3cc1b39c2d0
+  data.tar.gz: 9e47a1a744c63180b365637087a40721e7abd9ce9508f731b1f5297bf5bdfc60f30f0b9f3e49fde28f76397ba730a1180d64df4df3fd850e5436e199567f2491

data/.rubocop.yml

@@ -0,0 +1,18 @@
+# CIDE::CLI is essentially a big dispatcher, no need to break it
+# in smaller chunks.
+Metrics/ClassLength:
+  Max: 200
+
+# CIDE::CLI methods can be read top to bottom. No need to factor out
+# functionality unless it can be shared.
+Metrics/MethodLength:
+  Max: 60
+
+# 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

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+- 2.1.0
+- 2.0.0
+- 1.9.3

data/CHANGELOG.md

@@ -1,4 +1,17 @@
 
+0.0.4 / 2014-10-03
+==================
+
+  * ADD: forward_env to forward environment variables from the host
+  * ADD: Adds a "prepare" step that allows to cache build dependencies
+  * ADD: `cide init` to bootstrap projects
+  * ADD: `cide clean` to remove old images
+  * ADD: Can set export dir for artifacts
+  * CHANGE: Renames the "image" attribute to "from"
+  * CHANGE: Renames the "commmand" attribute to "run"
+  * Changes the generated Dockerfile quite a bit
+  * Use thor for command-line parsing, modularize
+
 0.0.3 / 2014-09-29
 ==================
 

data/Gemfile

@@ -1,2 +1,2 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 gemspec

data/Gemfile.lock

@@ -1,14 +1,35 @@
 PATH
   remote: .
   specs:
-    cide (0.0.1)
+    cide (0.0.3)
+      thor
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.0.0)
+    astrolabe (1.3.0)
+      parser (>= 2.2.0.pre.3, < 3.0)
+    parser (2.2.0.pre.4)
+      ast (>= 1.1, < 3.0)
+      slop (~> 3.4, >= 3.4.5)
+    powerpack (0.0.9)
+    rainbow (2.0.0)
+    rake (10.1.0)
+    rubocop (0.26.1)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.0.pre.4, < 3.0)
+      powerpack (~> 0.0.6)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.6.0)
+    slop (3.6.0)
+    thor (0.19.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   cide!
+  rake
+  rubocop

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rubocop/rake_task'
+
+task default: [:rubocop]
+
+RuboCop::RakeTask.new

data/bin/cide

@@ -3,140 +3,6 @@
 # cide - Continuous Integration Docker Environment
 #
 
-require "erb"
-require "optparse"
-require "yaml"
-
-DOCKERFILE = 'Dockerfile'
-DOCKERFILE_TEMPLATE = <<EOF
-FROM <%= image %>
-RUN useradd -m -U -d /cide cide
-
-# Install system build dependencies here
-
-<% as_root.each do |cmd| %>
-RUN <%= cmd %>
-<% end %>
-
-# Add project data
-
-ADD . /cide/src
-RUN chown -R cide:cide /cide
-
-# Switch to cide user
-
-USER cide
-
-WORKDIR /cide/src
-ENV HOME /cide
-EOF
-
-module Fmt; extend self
-  def fmt(obj)
-    dump_obj obj
-  end
-
-  protected
-
-  def dump(obj)
-    case obj
-    when Array
-      "[" + obj.map{|v| dump v}.join(' ') + "]"
-    when Hash
-      "{" + dump_obj(obj) + "}"
-    else
-      obj = obj.to_s
-      obj.index(/['"\s\{\}\[\]\=]/) ? obj.inspect : obj
-    end
-  rescue
-    dump $!.to_s
-  end
-
-  def dump_obj(obj)
-    obj.map do |(k, v)|
-      "#{k}=#{dump v}"
-    end.join ' '
-  end
-end
-
-def log(opts={})
-  $stdout.puts "cide: #{Fmt.fmt opts}"
-end
-
-def sh(*args)
-  log cmd: args
-  unless system(*args.map(&:to_s))
-    fail "command failed"
-  end
-end
-
-def docker(*args)
-  sh "docker", *args
-end
-
-def struct(opts={}, &block)
-  Class.new(Struct.new(*opts.keys), &block).new(*opts.values)
-end
-
-config = struct(
-  image: "ubuntu",
-  tag: File.basename(Dir.pwd),
-  as_root: [],
-  command: 'script/ci',
-) do
-  def set(name)
-    method "#{name}="
-  end
-
-  def tag=(str)
-    # Replaces invalid docker tag characters by underscores
-    super "#{str}".downcase.gsub(/[^a-z0-9\-_.]/, '_')
-  end
-
-  def to_dockerfile
-    ERB.new(DOCKERFILE_TEMPLATE).result(binding)
-  end
-
-  def merge!(opts={})
-    opts.each_pair{|k,v| self[k] = v }
-  end
-end
-
-config.merge! YAML.load_file('.cide.yml')
-
-OptionParser.new do |opts|
-  opts.on('-i', '--image IMAGE', "Select the source image (#{config.image})", &config.set(:image))
-  opts.on('-t', '--tag TAG', "Name of the build (#{config.tag})", &config.set(:tag))
-  opts.on('-c', '--command CMD', "CI script to run (#{config.command})", &config.set(:command))
-  opts.on_tail('-h', '--help', 'Shows this help') do
-    puts opts
-    exit
-  end
-end.parse!
-
-log config: config.to_h
-
-if !File.exist?(DOCKERFILE)
-  log msg: "Creating temporary Dockerfile"
-  File.write(DOCKERFILE, config.to_dockerfile)
-  at_exit do
-    File.unlink(DOCKERFILE)
-  end
-else
-  log msg: "Using existing Dockerfile"
-end
-
-if `uname`.strip == "Darwin" && !ENV['DOCKER_HOST']
-  if !system("which boot2docker >/dev/null 2>&1")
-    puts "make sure boot2docker is installed and running"
-    puts
-    puts "> brew install boot2docker"
-    exit 1
-  end
-  ENV['DOCKER_HOST'] = `boot2docker socket 2>/dev/null`.strip
-end
-
-tag = "cide-#{config.tag}"
-
-docker :build, '-t', tag, '.'
-docker :run, '--rm', '-t', tag, "sh", "-c", config.command
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'cide'
+CIDE::CLI.start

data/cide

@@ -0,0 +1,2 @@
+#!/bin/sh
+direnv exec `dirname $0` cide "$@"

data/cide.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name          = 'cide'
-  s.version       = '0.0.3'
+  s.version       = '0.0.4'
   s.authors       = ['zimbatm']
   s.email         = ['zimbatm@zimbatm.com']
   s.summary       = 'CI docker runner'
@@ -14,7 +14,13 @@ DESC
   s.license       = 'MIT'
 
   s.executables  << 'cide'
-  s.files         = `git ls-files`.split($/)
-  s.test_files    = `git ls-files spec`.split($/)
+  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_development_dependency 'rake'
+  s.add_development_dependency 'rubocop'
 end

data/lib/cide.rb

@@ -0,0 +1,223 @@
+require 'erb'
+require 'json'
+require 'optparse'
+require 'shellwords'
+require 'time'
+require 'yaml'
+
+require 'thor'
+
+# CIDE is a Continuous Integration Docker Environment runner
+#
+# The juicy bits are defined in CIDE::CLI
+module CIDE
+  DOCKERFILE = 'Dockerfile'
+  TEMPLATE = File.read(File.expand_path('../cide_template.erb', __FILE__))
+  CONFIG_FILE = '.cide.yml'
+
+  CIDE_DIR = '/cide'
+  CIDE_SRC_DIR = File.join(CIDE_DIR, '/src')
+
+  module_function
+
+  def docker_id(str)
+    # Replaces invalid docker tag characters by underscores
+    "#{str}".downcase.gsub(/[^a-z0-9\-_.]/, '_')
+  end
+
+  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',
+  ) do
+
+    alias_method :image=, :from=
+    alias_method :command=, :run=
+
+    def to_dockerfile
+      ERB.new(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|
+        obj[k.to_s] = self[k]
+      end.to_yaml
+    end
+  end
+
+  # Command-line option-parsing and execution for cide
+  class CLI < Thor
+    include CIDE
+    include Thor::Actions
+
+    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: CIDE.docker_id(File.basename(Dir.pwd))
+
+    method_option 'host_export_dir',
+      desc: 'Output directory on host to put build artefacts in',
+      aliases: ['o'],
+      default: nil
+
+    method_option 'run',
+      desc: 'The script to run',
+      aliases: ['r'],
+      default: DefaultConfig.run
+
+    method_option 'export',
+      desc: 'Are we expecting to export artifacts',
+      type: :boolean,
+      default: false
+
+    def build
+      setup_docker
+
+      config = DefaultConfig.merge(YAML.load_file(CONFIG_FILE)).merge(options)
+      config.host_export_dir ||= config.export_dir
+      tag = "cide/#{docker_id(options[:name])}"
+
+      say_status :config, config.to_h
+
+      if !File.exist?(DOCKERFILE)
+        say_status :Dockerfile, 'Creating temporary Dockerfile'
+        File.write(DOCKERFILE, config.to_dockerfile)
+        at_exit do
+          File.unlink(DOCKERFILE)
+        end
+      else
+        say_status :Dockerfile, 'Using existing Dockerfile'
+      end
+
+      docker :build, '-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
+    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 = run('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 = run("docker inspect #{cide_image_ids.join(' ')}", 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
+
+      run("docker rmi #{old_cide_images.join(' ')}")
+    end
+
+    desc 'init', "Creates a blank #{CONFIG_FILE} into the project"
+    def init
+      if File.exist?(CONFIG_FILE)
+        puts "#{CONFIG_FILE} already exists"
+        return
+      end
+      puts "Creating #{CONFIG_FILE} with default values"
+      create_file CONFIG_FILE, DefaultConfig.to_yaml
+    end
+
+    protected
+
+    def setup_docker
+      @setup_docker ||= (
+        if `uname`.strip == 'Darwin' && !ENV['DOCKER_HOST']
+          unless system('which boot2docker >/dev/null 2>&1')
+            puts 'make sure boot2docker is installed and running'
+            puts
+            puts '> brew install boot2docker'
+            exit 1
+          end
+          ENV['DOCKER_HOST'] = `boot2docker socket 2>/dev/null`.strip
+        end
+        true
+      )
+    end
+
+    def docker(*args)
+      opts = args.last.is_a?(Hash) ? args.pop : {}
+      ret = run Shellwords.join(['docker'] + args), opts
+      fail 'Command failed' if $CHILD_STATUS.exitstatus > 0
+      ret
+    end
+  end
+end

data/lib/cide_template.erb

@@ -0,0 +1,45 @@
+FROM <%= from %>
+USER root
+RUN useradd -m -U -d <%= CIDE_DIR %> cide
+
+# Install system build dependencies here
+
+<% as_root.each do |cmd| -%>
+RUN <%= cmd %>
+<% end -%>
+
+# Common
+
+ENV HOME <%= CIDE_DIR %>
+WORKDIR <%= CIDE_SRC_DIR %>
+
+# Before
+
+<% if before['run'] -%>
+  <% before['forward_env'].to_a.each do |key| -%>
+ENV <%= key %> <%= ENV[key] %>
+  <% end %>
+  <% before['add'].to_a.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'] %>
+USER root
+<% end -%>
+
+# Add project data
+
+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 %>

metadata

@@ -1,15 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: cide
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - zimbatm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-29 00:00:00.000000000 Z
-dependencies: []
+date: 2014-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rubocop
+  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'
 description: |
   cide makes it easy to reproduce CI builds on the developer computer by
   providing the same docker environment.
@@ -21,13 +63,19 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
+- Rakefile
 - bin/cide
+- cide
 - cide.gemspec
+- lib/cide.rb
+- lib/cide_template.erb
 homepage: https://github.com/zimbatm/cide
 licenses:
 - MIT
@@ -40,7 +88,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="