construi 0.35.2 → 0.36.0

data/.gitignore

@@ -14,3 +14,5 @@
 mkmf.log
 vendor
 .git-credentials
+target
+.sass-cache

data/Gemfile

@@ -2,4 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in construi.gemspec
 gemspec
-

data/README.md

@@ -2,9 +2,6 @@
 
 [![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&style=plastic)](http://jenkins.mylonelybear.org/job/construi-develop/)
-[![Gemnasium](https://img.shields.io/gemnasium/mathiasbynens/he.svg?style=plastic)](https://gemnasium.com/lstephen/construi)
-[![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
@@ -23,126 +20,7 @@ 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
-```
+## Usage
 
+See the main site at http://lstephen.github.io/construi
 

data/Rakefile

@@ -3,5 +3,4 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
-
+task default: :spec

data/bin/construi

@@ -3,4 +3,3 @@
 require 'construi'
 
 Construi.run ARGV
-

data/construi.gemspec

@@ -4,29 +4,34 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'construi/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "construi"
+  spec.name          = 'construi'
   spec.version       = Construi::VERSION
-  spec.authors       = ["lstephen"]
-  spec.email         = ["levi.stephen@gmail.com"]
-  spec.summary       = %q{Build tool using Docker to specify build environment}
-  spec.description   = %q{Build tool using Docker to specify build environment}
-  spec.homepage      = "https://github.com/lstephen/construi"
-  spec.license       = "MIT"
+  spec.authors       = ['Levi Stephen']
+  spec.email         = ['levi.stephen@gmail.com']
+  spec.summary       = 'Build tool using Docker to specify build environment'
+  spec.description   = 'Build tool using Docker to specify build environment'
+  spec.homepage      = 'https://github.com/lstephen/construi'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   spec.required_ruby_version = '>= 1.9'
 
   spec.add_dependency 'docker-api', '=1.21.4'
   spec.add_dependency 'colorize', '=0.7.7'
 
-  spec.add_development_dependency 'bundler', '~> 1.7'
-  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.4'
-  spec.add_development_dependency 'coveralls', '~> 0.7'
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'execjs', '~> 2.5'
   spec.add_development_dependency 'gem-release', '~> 0.7'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'jekyll', '~> 2.5'
+  spec.add_development_dependency 'rake', '~> 10.4'
+  spec.add_development_dependency 'redcarpet', '~> 3.2'
   spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'rubocop', '~> 0.31'
+  spec.add_development_dependency 'simplecov', '~> 0.10'
+  spec.add_development_dependency 'therubyracer', '~> 0.12'
+  spec.add_development_dependency 'yard', '~> 0.8'
 end

data/construi.yml

@@ -1,16 +1,14 @@
 image: ruby:1.9
 
 environment:
-  - JENKINS_URL
-  - BUILD_NUMBER
-  - CODECLIMATE_REPO_TOKEN
-  - COVERALLS_REPO_TOKEN
+  - COVERAGE
   - GIT_COMMIT
   - GIT_BRANCH
   - GIT_SSH_KEY
   - GIT_AUTHOR_NAME
   - GIT_AUTHOR_EMAIL
   - RUBYGEMS_API_KEY
+  - SITE_DEPLOY
 
 targets:
   build:
@@ -21,6 +19,14 @@ targets:
     - bundle install --path=vendor/bundle
     - bundle exec rake install
 
+  site:
+    build: construi/site
+    files:
+      - $GIT_SSH_KEY:/root/.ssh/id_rsa:0600
+    run:
+      - bundle install --path=vendor/bundle
+      - bash construi/site/run.sh
+
   release:
     files:
       - $GIT_SSH_KEY:/root/.ssh/id_rsa:0600

data/construi/release/script.sh

@@ -7,14 +7,22 @@ set -e
 
 printf "Host github.com\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
 
-git config push.default simple
-git checkout master
-git pull --rebase
-git merge --commit ${GIT_COMMIT}
-git push origin
-git checkout develop
-git pull --rebase
+release_commit=`git rev-parse HEAD`
+
+echo "Release commit ${release_commit}..."
+
+echo "Pushing to master..."
+git push -f origin `git rev-parse HEAD`:master
+
+echo "Push to master done."
+
+echo "Updating development version..."
 bundle install --path vendor/bundle
 bundle exec gem bump --version minor
-git push origin
+
+echo "Pushing to develop..."
+git push origin `get rev-parse HEAD`:develop
+echo "Push to develop done."
+
+echo "Release done."
 

data/construi/site/Dockerfile

@@ -0,0 +1,6 @@
+FROM ruby:1.9
+
+RUN apt-get update && apt-get -y install python python-pip
+
+RUN pip install ghp-import
+

data/construi/site/run.sh

@@ -0,0 +1,35 @@
+#!/bin/bash
+
+set -e
+
+echo "Generating Site..."
+
+bundle exec jekyll build --source site --destination target/site
+
+echo "Generating Reports..."
+
+echo "Yard..."
+bundle exec yard --output-dir target/site/yard
+
+echo "Coverage..."
+COVERAGE=true bundle exec rake spec
+
+echo "Rubocop..."
+bundle exec rubocop --format html -o target/site/rubocop.html || true
+
+echo "Reports done."
+
+if [[ -n "$SITE_DEPLOY" ]]
+then
+  [[ -n "$GIT_AUTHOR_NAME" ]] && git config user.name $GIT_AUTHOR_NAME
+  [[ -n "$GIT_AUTHOR_EMAIL" ]] && git config user.email $GIT_AUTHOR_EMAIL
+
+  printf "Host github.com\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
+
+  echo "Deploying site to gh-pages..."
+  ghp-import -p target/site
+  echo "Deployment done."
+fi
+
+echo "Site done."
+

data/lib/construi.rb

@@ -1,6 +1,7 @@
 
 require 'yaml'
 
+# Entrypoint for the Construi application
 module Construi
   require 'construi/config'
   require 'construi/runner'
@@ -11,4 +12,3 @@ module Construi
     Runner.new(Config.load_file('construi.yml')).run(targets)
   end
 end
-

data/lib/construi/config.rb

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