construi 0.30.0 → 0.31.0

data/.rspec

@@ -1,2 +1,3 @@
 --color
 --require spec_helper
+--format documentation

data/README.md

@@ -1,5 +1,147 @@
 # Construi
 
-[![Gem](https://img.shields.io/gem/v/construi.svg?style=plastic)](https://rubygems.org/gems/construi) [![Build Status](http://jenkins.mylonelybear.org/buildStatus/icon?job=construi-develop)](http://jenkins.mylonelybear.org/job/construi-develop/)
-[![Code Climate](https://img.shields.io/codeclimate/github/lstephen/construi.svg?style=plastic)](https://codeclimate.com/github/lstephen/construi) [![Code Climate](https://img.shields.io/codeclimate/coverage/github/lstephen/construi.svg?style=plastic)](https://codeclimate.com/github/lstephen/construi) [![Coveralls](https://img.shields.io/coveralls/lstephen/construi/develop.svg?style=plastic)](https://coveralls.io/r/lstephen/construi)
+[![Gem](https://img.shields.io/gem/v/construi.svg?style=plastic)](https://rubygems.org/gems/construi)
+[![Build Status](http://jenkins.mylonelybear.org/buildStatus/icon?job=construi-develop)](http://jenkins.mylonelybear.org/job/construi-develop/)
+[![Code Climate](https://img.shields.io/codeclimate/github/lstephen/construi.svg?style=plastic)](https://codeclimate.com/github/lstephen/construi)
+[![Coveralls](https://img.shields.io/coveralls/lstephen/construi/origin/develop.svg?style=plastic)](https://coveralls.io/r/lstephen/construi)
+
+Construi allows you to use [Docker](http://www.docker.com) containers as your build environment.
+This allows a consistent and recreatable build environment on any machine running Construi
+and Docker.
+
+This is useful for ensuring consistency between development machines.
+It is also useful in a CI environment where you may need to build projects from many different
+languages and/or versions (e.g., Java 6, Java 8, Ruby).
+
+## Installation
+
+Construi requires [Ruby](http://www.ruby-lang.org) version 1.9 or higher.
+It can be installed as a Gem.
+
+```
+  > gem install construi
+```
+
+## Running
+
+Construi requires that a `construi.yml` file be present in the root directory of your project.
+Targets can then be run by specifying them on the command line. For example:
+
+```
+  > construi build
+  > construi build install
+```
+
+Construi will create a Docker container with the project directory as a volume.
+It will then run the commands configured for the given targets.
+
+## The Construi File
+
+As a minimal `construi.yml` requires an image and a target to be configured.
+For example a simple configuration for a Java 8 project built with Maven could be:
+
+```
+image: maven:3-jdk-8
+
+targets:
+  install: mvn install
+```
+
+Construi is built using itself, so it's
+[`construi.yml`](https://github.com/lstephen/construi/blob/develop/construi.yml)
+can be used as an example also.
+
+### Image
+
+Specifies an image to be pulled that will be used as the build environment.
+It can also be given on a per target basis.
+
+```
+image: maven:3-jdk-7
+
+targets:
+  install: mvn install
+
+  test-java-8:
+    image: maven:3-jdk-8
+    run: mvn verify
+```
+
+### Build
+
+Specifies a directory containing a `Dockerfile`.
+Construi will build a Docker container based on that `Dockerfile` and use it as the build
+environment.
+Can be used as an alternative to providing an image.
+Can also be given on a per target basis.
+
+```
+build: etc/build_environment
+
+targets:
+  build:
+    - mvn install
+    - /usr/local/bin/custom_installed_command.sh
+```
+
+### Environment
+
+Declares environment variables that will be passed through or set in the build environment.
+If no value is provided then the value from the host environment will be used.
+In this example `NEXUS_SERVER_URL` will be set as provided, while `NEXUS_USERNAME` and
+`NEXUS_PASSWORD` will be retrieved from the host.
+
+```
+image: maven:3-jdk-7
+
+environment:
+  - NEXUS_SERVER_URL=http://nexus.example.com
+  - NEXUS_USERNAME
+  - NEXUS_PASSWORD
+targets:
+  build: mvn install
+```
+
+### Files
+
+Declares files to be copied into the build environment before the build is run.
+Also allows setting of permissions.
+Can be used on a per target basis.
+
+```
+image: maven:3-jdk-7
+
+files:
+  - etc/maven-settings.xml:/home/root/.m2/settings.xml
+
+targets:
+  deploy:
+    files:
+      - $GIT_SSH_KEY:/home/root/.ssh/id_rsa:0600
+    run: scripts/construi/deploy.sh
+```
+
+### Targets
+
+Any number of targets can be specified.
+Each must specify at least one command.
+If additional configuration is required for a target then the commands should be provided
+under the `run` key.
+If more than one command is required then a YAML list should be used.
+
+```
+image: maven:3-jdk-7
+
+targets:
+  build: mvn install
+
+  test-java-8:
+    image: maven:3-jdk-8
+    run: mvn verify
+
+  deploy:
+    - mvn deploy
+    - curl http://ci.example.com/deploy/trigger
+```
+
 

data/construi.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'docker-api', '~> 1.20'
+  spec.add_dependency 'colorize', '~> 0.7.5'
 
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'codeclimate-test-reporter'

data/construi.yml

@@ -6,6 +6,7 @@ environment:
   - CODECLIMATE_REPO_TOKEN
   - COVERALLS_REPO_TOKEN
   - GIT_COMMIT
+  - GIT_BRANCH
   - GIT_SSH_KEY
   - RUBYGEMS_API_KEY
 

data/lib/construi.rb

@@ -1,46 +1,13 @@
 require 'construi/config'
-require 'construi/container'
-require 'construi/image'
-require 'construi/version'
+require 'construi/runner'
 
-require 'docker'
 require 'yaml'
 
 module Construi
-
-  class Runner
-    def initialize(config)
-      @config = config
-    end
-
-    def run(targets)
-      puts "Construi version: #{Construi::VERSION}"
-
-      docker_host = ENV['DOCKER_HOST']
-      Docker.url = docker_host unless docker_host.nil?
-
-      puts "Docker url: #{Docker.url}"
-      puts "Current directory: #{Dir.pwd}"
-
-      Docker.validate_version!
-      Docker.options[:read_timeout] = 60
-      Docker.options[:chunk_size] = 8
-
-      initial_image = Image.create(@config.image) { |s| puts s }
-
-      commands = targets.map { |t| @config.target(t).commands }.flatten
-
-      final_image = commands.reduce(IntermediateImage.seed(initial_image)) do |image, command|
-        puts " > #{command}"
-        image.run(command, @config.env)
-      end
-
-      final_image.delete
-    end
-  end
+  String.disable_colorization = false
 
   def self.run(targets)
     Runner.new(Config.load_file('construi.yml')).run(targets)
   end
-
 end
+

data/lib/construi/config.rb

@@ -1,31 +1,82 @@
 
-module Construi
+module Construi::Config
 
-  class Config
-    private_class_method :new
+  module Image
+    def image
+      image_configured :image
+    end
 
-    attr_reader :yaml
+    def build
+      image_configured :build
+    end
 
-    def initialize(yaml)
-      @yaml = yaml
+    def image_configured?
+      yaml.is_a?(Hash) && (yaml.has_key?('build') || yaml.has_key?('image'))
+    end
+
+    def image_configured(what)
+      image_configured? ? yaml[what.to_s] : with_parent(&what)
+    end
+  end
+
+  module Files
+
+    class File
+      attr_reader :container, :permissions
+
+      def initialize(host, container, permissions)
+        @host = host
+        @container = container
+        @permissions = permissions
+      end
+
+      def host
+        @host.gsub(/\$(\w+)/) { ENV[$1] }
+      end
+
+      def self.parse(str)
+        split = str.split(':')
+        File.new split[0], split[1], split[2]
+      end
     end
 
-    def self.load(content)
-      new YAML.load(content)
+    def files_configured?
+      yaml.is_a? Hash and yaml.has_key? 'files'
     end
 
-    def self.load_file(path)
-      new YAML.load_file(path)
+    def files
+      fs = files_configured? ? yaml['files'].map { |str| File.parse(str) } : []
+
+      with_parent([], &:files).concat fs
     end
+  end
 
-    def image
-      @yaml['image']
+  module Environment
+    include Image
+    include Files
+
+    def parent
+      nil
+    end
+
+    def with_parent(or_else = nil)
+      parent ? yield(parent) : or_else
+    end
+  end
+
+  class Global
+    include Environment
+
+    attr_reader :yaml
+
+    def initialize(yaml)
+      @yaml = yaml
     end
 
     def env
-      return [] if @yaml['environment'].nil?
+      return [] if yaml['environment'].nil?
 
-      @yaml['environment'].reduce([]) do |acc, e|
+      yaml['environment'].reduce([]) do |acc, e|
         key = e.partition('=').first
         value = e.partition('=').last
 
@@ -37,18 +88,39 @@ module Construi
     end
 
     def target(target)
-      Target.new(@yaml['targets'][target])
+      targets = yaml['targets']
+
+      return nil if targets.nil?
+
+      return Target.new yaml['targets'][target], self
     end
   end
 
   class Target
-    def initialize(yaml)
+    include Environment
+
+    attr_reader :yaml, :parent
+
+    def initialize(yaml, parent)
       @yaml = yaml
+      @parent = parent
     end
 
     def commands
-      @yaml
+      Array(@yaml.is_a?(Hash) ? @yaml['run'] : @yaml)
     end
+
+    def env
+      parent.env
+    end
+  end
+
+  def self.load(content)
+    Global.new YAML.load(content)
   end
 
+  def self.load_file(path)
+    Global.new YAML.load_file(path)
+  end
 end
+

data/lib/construi/container.rb

@@ -9,14 +9,20 @@ module Construi
       @container = container
     end
 
+    def id
+      @container.id
+    end
+
     def delete
       @container.delete
     end
 
     def attach_stdout
       @container.attach(:stream => true, :logs => true) { |s, c| puts c; $stdout.flush }
+      true
     rescue Docker::Error::TimeoutError
-      puts 'Failed to attached to stdout'
+      puts 'Failed to attach to stdout'.yellow
+      false
     end
 
     def commit
@@ -25,14 +31,20 @@ module Construi
 
     def run
       @container.start
-      attach_stdout
+      attached = attach_stdout
       status_code = @container.wait['StatusCode']
 
-      raise RunError.new 'Cmd returned status code: #{status_code}' unless status_code == 0
+      puts @container.logs(:stdout => true) unless attached
+
+      raise Error, "Cmd returned status code: #{status_code}" unless status_code == 0
 
       commit
     end
 
+    def ==(other)
+      other.is_a? Container and id == other.id
+    end
+
     def self.create(image, cmd, env)
       wrap Docker::Container.create(
         'Cmd' => cmd.split,
@@ -58,12 +70,9 @@ module Construi
       use(image, cmd, env, &:run)
     end
 
-  end
-
-  class ContainerError < StandardError
-  end
+    class Error < StandardError
+    end
 
-  class RunError < ContainerError
   end
 
 end

data/lib/construi/image.rb

@@ -1,5 +1,8 @@
 require 'construi/container'
 
+require 'colorize'
+require 'docker'
+
 module Construi
 
   class Image
@@ -17,40 +20,102 @@ module Construi
       @image.delete
     end
 
+    def docker_image
+      @image
+    end
+
     def tagged?
       @image.info['RepoTags'] != '<none>:<none>'
     end
 
-    def run(cmd, env)
+    def insert_local(file)
+      puts "\nCopying #{file.host} to #{file.container}...".green
+
+      img = IntermediateImage.seed(self)
+
+      img.map do |i|
+        Image.wrap i.docker_image
+          .insert_local 'localPath' => file.host, 'outputPath' => file.container
+      end
+
+      img.map { |i| i.chmod file.container, file.permissions } if file.permissions
+
+      img.run "ls -l #{file.container}"
+
+      img.image
+    end
+
+    def insert_locals(files)
+      IntermediateImage.seed(self).reduce(files) { |i, f| i.insert_local f }.image
+    end
+
+    def chmod(file, permissions)
+        chmod = "chmod -R #{permissions} #{file}"
+
+        puts " > #{chmod}"
+        run chmod
+    end
+
+    def run(cmd, env = [])
       Container.run(self, cmd, env)
     end
 
+    def ==(other)
+      other.is_a? Image and id == other.id
+    end
+
+    def self.from(config)
+      image = create(config.image) unless config.image.nil?
+      image = build(config.build) unless config.build.nil?
+
+      raise Error, "Invalid image configuration: #{config}" unless image
+
+      image.insert_locals config.files
+    end
+
     def self.create(image)
-      wrap Docker::Image.create('fromImage' => image)
+      puts
+      puts "Creating image: '#{image}'...".green
+      wrap Docker::Image.create('fromImage' => image) { |s|
+        status = JSON.parse(s)
+
+        id = status['id']
+        progress = status['progressDetail']
+
+        if progress.nil? or progress.empty?
+          print "#{id}: " unless id.nil?
+          puts "#{status['status']}"
+        end
+      }
+    end
+
+    def self.build(build)
+      puts
+      puts "Building image: '#{build}'...".green
+      wrap Docker::Image.build_from_dir(build, :rm => 0) { |s|
+        puts JSON.parse(s)['stream']
+      }
     end
 
     def self.wrap(image)
       new image
     end
 
-    def self.use(image)
-      begin
-        i = create(image)
-        yield i
-      ensure
-        i.delete unless i.tagged?
-      end
+    class Error < StandardError
     end
   end
 
   class IntermediateImage
     private_class_method :new
 
+    attr_reader :image
+
     def initialize(image)
       @image = image
+      @first = true
     end
 
-    def run(cmd, env)
+    def run(cmd, env = [])
       map { |i| i.run(cmd, env) }
     end
 
@@ -58,9 +123,17 @@ module Construi
       update(yield @image)
     end
 
+    def reduce(iter)
+      iter.reduce(self) do |intermediate_image, item|
+        intermediate_image.map { |i| yield i, item }
+      end
+    end
+
     def update(image)
-      @image.delete unless @image.tagged?
+      delete unless @first
+      @first = false
       @image = image
+      self
     end
 
     def delete