cide 0.7.0 → 0.8.0

data/lib/cide/runner.rb

@@ -0,0 +1,110 @@
+require 'json'
+
+require 'cide/docker'
+
+module CIDE
+  class Runner
+    include CIDE::Docker
+
+    def initialize(
+      command: [],
+      env: {},
+      links: [],
+      tag: nil,
+      user: nil
+    )
+      fail ArgumentError, 'tag missing' unless tag
+
+      @containers = []
+      @id = SecureRandom.hex
+
+      @tag = tag
+      @env = env
+      @links = links
+      @command = command
+      @user = user
+    end
+
+    # !!!! Don't call run twice !!!!
+    def run!(interactive: false)
+      start_links!
+
+      run_options = ['--detach']
+
+      @env.each_pair do |key, value|
+        run_options.push '--env', [key, value].join('=')
+      end
+
+      @links.each do |link|
+        run_options.push '--link', [link.id, link.name].join(':')
+      end
+
+      run_options.push '--name', @id
+
+      run_options.push '--user', @user if @user
+
+      run_options.push('--interactive', '--tty') if interactive
+
+      run_options.push @tag
+      run_options.push(*@command)
+
+      id = docker(:run, *run_options, capture: true).strip
+      @containers << id
+      docker(:attach, id)
+    end
+
+    def export!(guest_dir: nil, host_dir: nil)
+      fail ArgumentError, 'guest export_dir missing' unless guest_dir
+      fail ArgumentError, 'host export_dir missing' unless host_dir
+
+      # FIXME: strip trailing slashes ?
+      guest_dir = File.expand_path(guest_dir, CIDE_SRC_DIR)
+      host_dir = File.expand_path(host_dir, Dir.pwd)
+
+      FileUtils.mkdir_p(File.dirname(host_dir))
+
+      docker :cp, [@id, guest_dir].join(':'), host_dir
+    end
+
+    def cleanup!(output: $stderr)
+      return if @containers.empty?
+      begin
+        report_containers!(output)
+      ensure
+        # Shutdown old containers
+        docker :rm, '--force', '--volumes', *@containers.reverse, capture: true
+      end
+    end
+
+    protected
+
+    def start_links!
+      @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
+    end
+
+    def report_containers!(output)
+      infos = docker(:inspect, *@containers, capture: true)
+
+      JSON.parse(infos).each do |info|
+        config = info['Config']
+        state = info['State']
+
+        next unless state['Dead'] || state['ExitCode'] > 0
+
+        output.puts "=== Failed container #{info['Id']} ==="
+        output.puts "Image: #{config['Image']}"
+        output.puts "State: #{state.inspect}"
+        docker(:logs, '--tail', 20, info['Id'])
+      end
+    end
+  end
+end

data/man/{cide-build.1.md → cide-exec.1.md}

@@ -1,16 +1,16 @@
-CIDE-BUILD 1 "JUNE 2015" cide-build "Cide Manual"
-=================================================
+CIDE-EXEC 1 "FEBRUARY 2016" cide-exec "Cide Manual"
+===================================================
 
 NAME
 ----
 
-cide-build - Builds an image and executes the run script
+cide-exec - Builds an image and executes the run script
 
 SYNOPSIS
 --------
 
-*cide build* [`-n`|`--name`=<*name*>] [`--export`|`--no-export`]
-             [`-o`|`--export-dir`=<*path*>] [`-r`|`--run`=<*command*>]
+*cide exec*  [`--export`|`--no-export`] [`-o`|`--export-dir`=<*path*>]
+             [`--guest_export_dir`=<*path*>] [`-r`|`--run`=<*command*>]
              [`--pull`|`--no-pull`] [`-s`|`--ssh-key`=<*path*>]
 
 DESCRIPTION
@@ -28,21 +28,29 @@ CI run with isolated dependencies.
 OPTIONS
 -------
 
-`-n`, `--name`=<*name*>
+`-n`, `-t`, `--name`=<*name*>
   Name of the built image. This can be used to differentiate between branches
   or others in a CI environment. By default the name is the basename(1) of the
   current directory.
 
 `--export`, `--no-export`
-  Whenever to export artifacts. If `--export` is passed and the `export:`
-  directive is set in the `cide.yml` file, artifacts from that directory are
-  transfered back outside of the container and into the current directory.
+  Whether to export artifacts. If `--export` is passed and the directory to
+  be exported is set (either with `export_dir:` in the `cide.yml` file, or by
+  specifying `--guest-export-dir` on the command line) artifacts from that
+  directory are transfered back outside of the container (see `--export-dir`
+  and `--guest-export-dir`)
 
 `-o`, `--export-dir`=<*path*>
-  By default the export directory is the same as the one given in the
-  `export:` directive in the `cide.yml` file. It is possible to change that
+  Where the directory extracted from the container should be placed on the
+  host.  By default the export directory is the same as the one given in the
+  `export_dir:` directive in the `cide.yml` file. It is possible to change that
   target folder outside of the container.
 
+`--guest-export-dir`=<*path*>
+  Which directory from the container should be extracted.  By default the
+  export directory is the same as the one specified with `--export-dir` if any,
+  or in the `export_dir:` directive in the `cide.yml` file otherwise.
+
 `-r`, `--run`=<*command*>
   Override the script to run. Usually the `run:` directive in the `cide.yml`
   is defining what to run but this could be used for a quick one-off.

data/man/cide-package.1.md

@@ -0,0 +1,56 @@
+CIDE-PACKAGE "FEBRUARY 2016" cide-package "Cide Manual"
+=======================================================
+
+NAME
+----
+
+cide-package - Builds a package from the run script
+
+SYNOPSIS
+--------
+
+*cide package*  [`-n`|`-t`|`--name`=<*name*>] [`-s`|`--ssh-key`=<*path*>]
+                [`--package`=<*package*>] [`--upload`]
+                [`--set-version`]
+
+DESCRIPTION
+-----------
+
+This tells `cide` to package a built package for you, and possibly upload it to
+s3.
+
+When invoke, cide will retrieve a previously created container (see `--name`),
+perform a `cide` run, and package a given directory. The behavior is the same
+as `exec` but will always export a directory, which it will upload to Amazon
+s3.
+
+OPTIONS
+-------
+
+`-n`, `-t`, `--name`
+  The name (tag) of the container from which to retrieve the build.
+
+`-s`, `--ssh-key`=<*path*>
+  When the `use_ssh:` directive is set to true, where to get the ssh key to
+  inject into the container. Defaults to `~/.ssh/id_rsa`.
+
+`--package`=<*package*>
+  The name of the package. The final archive will have the name
+  `<package>.<timestamp>.<version>.tar.gz`, where timestamp is the time at
+  which the packaging occured (in format `YYYY-mm-dd_HHMMSS`) and `<version>`
+  is the package version (see `--set-version`).
+
+`--upload`
+  Whether the archive should be uploaded to Amazon s3. If the archive should be
+  uploaded to s3 by the packager, the s3 credentials must be provided to
+  `cide`. The s3 credentials must be exported as environment variables.
+
+`--set-version`
+  Sets a package version. Is is solely used when naming the archive (see
+  `--package`). If no version is provided on the command line, a default
+  version name will be extracted from git (short sha).
+
+SEE ALSO
+--------
+
+cide(1)

data/man/cide.1.md

@@ -25,6 +25,9 @@ of the current directory's structure, builds an image with it and then runs a
 container from it that executes the specified tests. See the cide.yml(1) man
 page for the structure of that file.
 
+Cide can also be used to package and upload projects after they have been
+built. See cide-package(1) for more information.
+
 OPTIONS
 -------
 
@@ -45,11 +48,18 @@ These are global options that set the behavior of all commands.
 COMMANDS
 --------
 
-*cide build* [<*options*>]
+*cide exec* [<*options*>]
   Builds an image and executes the run script. This is the default command
   when none is provided.
 
-  See cide-build(1)
+  See cide-package(1)
+
+*cide package* [<*options*>]
+  Packages a directory that resulting from a run script. Can also upload the
+  package to Amazon s3.
+
+  See cide-package(1)
+
 
 *cide clean* [<*options*>]
   Removes old containers.
@@ -91,6 +101,22 @@ https://docs.docker.com/docker/reference/commandline/cli/#environment-variables:
 *DOCKER_TLS_VERIFY*
   When set Docker uses TLS and verifies the remote.
 
+
+The following environment variables are used by the Amazon `s3` SDK to
+authenticate, and should be set by the user. See also
+http://docs.aws.amazon.com/sdkforruby/api/index.html.
+
+*AWS_ACCESS_KEY_ID*
+*AWS_SECRET_ACCESS_KEY*
+  The Amazon key id and access key (see
+  http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSGettingStartedGuide/AWSCredentials.html)
+
+*AWS_REGION*
+  The Amazon region (e.g. `us-east-1`)
+
+*AWS_BUCKET*
+  Your bucket's name
+
 CONTRIBUTE
 ----------
 

data/man/cide.yml.1.md

@@ -4,7 +4,7 @@ CIDE.YML 1 "JUNE 2015" cide.yml "Cide Manual"
 NAME
 ----
 
-cide.yml - file format that directs the `cide build` execution
+cide.yml - file format that directs the `cide exec` execution
 
 DESCRIPTION
 -----------

data/script/build

@@ -0,0 +1,29 @@
+#!/bin/bash -e
+
+if [[ -z $1 ]]; then
+  echo "Missing <TARGET>" >&2
+  exit 1
+fi
+
+packager_bin() {
+	local bin=$1
+	local name=$(basename "$1")
+	mkdir -p .packager/bin
+	cat <<BIN > ".packager/bin/${name}"
+#!/bin/sh -e
+here=\$(dirname "\$(readlink -f "\$0")")
+target=\$(readlink -f "\$here/../../${bin}")
+exec "\$target" "\$@"
+BIN
+	chmod +x ".packager/bin/${name}"
+}
+
+TARGET=$1
+
+cp -r "$PWD" "$TARGET"
+cd "$TARGET"
+bundle install --standalone --binstubs=binstubs --without=development test
+
+rm -rf vendor/bundle/ruby/*/{bin,build_info,cache,doc,extensions,specifications}
+
+packager_bin binstubs/cide

data/script/ci

@@ -0,0 +1,2 @@
+#!/bin/sh -e
+bundle exec rake

data/spec/build_config_loader_spec.rb

@@ -1,12 +1,12 @@
-require "cide/build"
+require "cide/config_file"
 require "stringio"
 require "ostruct"
 require "active_support/json"
 
-describe "CIDE::Build::Config::Loader" do
+describe "CIDE::ConfigFile::Loader" do
   before do
-    @config = CIDE::Build::Config.new
-    @loader = CIDE::Build::ConfigLoader.new(@config)
+    @config = CIDE::ConfigFile.new
+    @loader = CIDE::ConfigFileLoader.new(@config)
     ENV['TEST1'] = 'test1'
     ENV['TEST2'] = 'test2'
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cide
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - zimbatm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-10 00:00:00.000000000 Z
+date: 2016-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -119,6 +119,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".dockerignore"
 - ".editorconfig"
 - ".gitignore"
 - ".nojekyll"
@@ -138,20 +139,24 @@ files:
 - docs/cide.yml.md
 - docs/sidebar.md
 - index.html
-- lib/cide/build.rb
-- lib/cide/build/config.rb
-- lib/cide/build/config_loader.rb
+- lib/cide/builder.rb
 - lib/cide/cli.rb
+- lib/cide/config_file.rb
+- lib/cide/config_file_loader.rb
 - lib/cide/constants.rb
 - lib/cide/default_cide.yml
 - lib/cide/docker.rb
 - lib/cide/dockerfile_template.erb
-- man/cide-build.1.md
+- lib/cide/runner.rb
 - man/cide-clean.1.md
 - man/cide-debug.1.md
+- man/cide-exec.1.md
 - man/cide-init.1.md
+- man/cide-package.1.md
 - man/cide.1.md
 - man/cide.yml.1.md
+- script/build
+- script/ci
 - spec/build_config_loader_spec.rb
 - spec/spec_helper.rb
 homepage: https://zimbatm.github.io/cide

data/lib/cide/build.rb

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

data/lib/cide/build/config.rb

@@ -1,103 +0,0 @@
-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 FileAdd
-        include Virtus.model(strict: true)
-        include NiceInspect
-        attribute :src, Array[String], default: []
-        attribute :dest, String
-      end
-
-      class Step
-        include Virtus.model(strict: true)
-        include NiceInspect
-        attribute :add, Array[FileAdd], default: []
-        attribute :env, Hash[String, 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], default: {}
-        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, Step, required: false
-      attribute :use_ssh, Boolean, default: false
-      attribute :before, Step, required: false
-      attribute :env, Hash[String, String], default: {}
-      attribute :export_dir, String, required: false
-      attribute :links, Array[Link], default: []
-      attribute :run, Array[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(dir = Dir.pwd, output = $stderr)
-        file_path = find_config(dir)
-        load_file(file_path, output)
-      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
-
-      def self.find_config(dir)
-        paths = CONFIG_FILES.map { |name| File.expand_path(name, dir) }
-        paths
-          .find { |path| File.exist?(path) } ||
-          fail("Config not found among these paths: #{paths.inspect}")
-      end
-    end
-  end
-end