buildkiq 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 23fac219e9f534bde3ea62ea97d17bfc980a00de
+  data.tar.gz: d96d7dd91329c63cb2bdc43962cb93b8d0433f7c
+SHA512:
+  metadata.gz: 4b9db6e8321d361a32a50f2de18e9ff96e45cb3aa209a7aeb9446c1ab286395909952a2a48ad5e6d9e6aeb288b0674d74deec31ca51e41b219a1fed08d19ca79
+  data.tar.gz: 5fa821eb57026e11af3aeb6f521d41c7601b85c728bd8c47b0771ae0f50f5adc6ce2bcabd74b519b49adb04117c596874b30f5ce79c726f6e1f667aab7e8ccc1

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.5

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in buildkiq.gemspec
+gemspec

data/README.md

@@ -0,0 +1,101 @@
+# Buildkiq
+
+AWS CodeBuild container launcher
+
+- Buildkiq enables you to run UnitTest in a distributed manner.
+- And many more
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'buildkiq'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install buildkiq
+
+## Configuration
+
+You need to configure [AWS SDK](https://github.com/aws/aws-sdk-ruby) credentials
+
+Create configuration file (~/.aws/credentials) or require environments `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` and `AWS_REGION`
+
+## Usage
+
+### :rocket: run by CLI
+
+#### Example: create build 2 containers
+
+```sh
+$ buildkiq run_builds -p your_project_name \
+  -c "ruby -v" \
+  -e "CI=true,NODE_TOTAL=2" \
+  -b "NODE_INDEX=1" "NODE_INDEX=2"
+```
+
+##### build:1
+
+```
+% export CI=true && export NODE_TOTAL=2
+% export NODE_INDEX=1
+% ruby -v
+```
+
+##### build:2
+
+```
+% export CI=true && export NODE_TOTAL=2
+% export NODE_INDEX=2
+% ruby -v
+```
+
+#### CLI Parameters
+
+| name                | alias | desc                                      | required | type   |
+| ------------------- | ----- | ----------------------------------------- | -------- | ------ |
+| project             | -p    | AWS CodeBuild project name                | **Yes**  | String |
+| builds_environments | -b    | builds environments (csv)                 | **Yes**  | Array  |
+| environments        | -e    | common environments (csv)                 | No       | String |
+| source_version      | -s    | git commit hash or github pullrequest     | No       | String |
+| command             | -c    | override buildspec.yml with shell command | No       | String |
+
+### :rocket: run by ruby
+
+#### Example: create build 2 containers
+
+```ruby
+jobs = Buildkiq.run(project:              'your_project_name',
+                    build_cmd:            'ruby -v', # override buildspec.yml
+                    default_environments: [{name: 'CI', value: 'true'}, {name: 'NODE_TOTAL', value: '2'}],
+                    jobs: [
+                            {environments: [{name: 'NODE_INDEX', value: '1'}]},
+                            {environments: [{name: 'NODE_INDEX', value: '2'}]},
+                          ])
+
+puts jobs.size      # 2
+puts jobs[0].status # IN_PROGRESS
+jobs[0].wait_for_job
+puts jobs[0].status # SUCCEEDED
+puts jobs[0].build.class # Aws::CodeBuild::Types::Build
+
+# Download artifacts file from S3
+# json_text = jobs[0].artifact.find_by('path/to/spec.json')
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bluerabbit/buildkiq.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "buildkiq"
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/buildkiq.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "buildkiq/version"
+
+Gem::Specification.new do |spec|
+  spec.name    = "buildkiq"
+  spec.version = Buildkiq::VERSION
+  spec.authors = ["Akira Kusumoto"]
+  spec.email   = ["akirakusumo10@gmail.com"]
+
+  spec.summary     = "AWS CodeBuild container launcher"
+  spec.description = "AWS CodeBuild container launcher"
+  spec.homepage    = "https://github.com/bluerabbit/buildkiq"
+  spec.license     = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "aws-sdk", ">= 3.0.1"
+  spec.add_runtime_dependency "rubyzip"
+  spec.add_runtime_dependency "thor"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/exe/buildkiq

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require "buildkiq/cli"
+
+Buildkiq::Cli.start

data/lib/buildkiq/artifact.rb

@@ -0,0 +1,45 @@
+require "aws-sdk"
+require "buildkiq/zip_reader"
+
+class Artifact
+  def initialize(job)
+    @s3_client = Aws::S3::Client.new
+    @job       = job
+  end
+
+  def upload_success?
+    @job.artifact_upload_success?
+  end
+
+  def find_by(path)
+    io = if packaging_zip?
+           fetch_zip_file.find_by_name(path)
+         else
+           fetch_s3_object("/#{path}")
+         end
+
+    io.read
+  end
+
+  private
+
+  def packaging_zip?
+    @job.project.artifacts.packaging == "ZIP"
+  end
+
+  def fetch_zip_file
+    @zip_reader ||= Buildkiq::ZipReader.new(fetch_s3_object)
+  end
+
+  def fetch_s3_object(path = "")
+    @s3_client.get_object(bucket: bucket_name, key: "#{file_key}#{path}").body
+  end
+
+  def bucket_name
+    @bucket_name ||= @job.build.artifacts.location.split(":::").last.split("/").first
+  end
+
+  def file_key
+    @file_key ||= @job.build.artifacts.location.split(":::").last.split("/")[1..-1].join("/")
+  end
+end

data/lib/buildkiq/cli.rb

@@ -0,0 +1,44 @@
+require "thor"
+require "buildkiq"
+require "logger"
+
+module Buildkiq
+  class Cli < Thor
+    default_command :run_builds
+
+    desc "run_builds", "Run containers"
+    method_option :project,             aliases: "-p", required: true, desc: 'AWS CodeBuild project name'
+    method_option :builds_environments, aliases: "-b", required: true, type: :array, desc: 'builds environments(csv)'
+    method_option :environments,        aliases: "-e", desc: 'common environments(csv)'
+    method_option :source_version,      aliases: "-s", desc: 'git commit hash or github pullrequest'
+    method_option :command,             aliases: "-c", desc: 'override buildspec.yml with shell command'
+
+    def run_builds
+      logger = Logger.new(STDOUT)
+      jobs = Buildkiq.run(project:              options[:project],
+                          jobs:                 options[:builds_environments].map {|job|
+                            {environments: parse_environments_text(job)}
+                          },
+                          default_environments: parse_environments_text(options[:environments]),
+                          source_version:       options[:source_version],
+                          build_cmd:            options[:command],
+                          logger:               logger)
+
+      jobs.each {|job| logger.info(job.build_url) }
+    end
+
+    desc "version", "Show Version"
+
+    def version
+      say "Version: #{Buildkiq::VERSION}"
+    end
+
+    private
+
+    def parse_environments_text(env_csv_text)
+      env_csv_text.to_s.split(/,\s*/).map { |kv| kv.split("=") }.map do |k, v|
+        { name: k, value: v }
+      end
+    end
+  end
+end

data/lib/buildkiq/job.rb

@@ -0,0 +1,87 @@
+require "logger"
+require "aws-sdk"
+
+module Buildkiq
+  class Job
+    attr_reader :logger, :project_name, :environments, :build
+
+    def initialize(project_name:, environments:, logger: Logger.new(STDOUT))
+      @client       = Aws::CodeBuild::Client.new
+      @project_name = project_name
+      @environments = environments
+      @logger       = logger
+    end
+
+    def start(source_version: nil, build_cmd: nil)
+      params = {project_name: project_name, environment_variables_override: environments}
+
+      if source_version && source_type == "S3"
+        raise ArgumentError.new("source_version parameter can not be used, project source type is S3")
+      end
+
+      params[:source_version]     = source_version if source_version
+      params[:buildspec_override] = build_spec(build_cmd) if build_cmd
+      logger.info("build parameter: #{params}")
+
+      @build = @client.start_build(params).build
+    end
+
+    def wait_for_job(timeout_sec: build.timeout_in_minutes * 60, sleep_sec: 5)
+      Timeout.timeout(timeout_sec) do
+        sleep(sleep_sec) until done?
+      end
+
+      self
+    end
+
+    def status
+      fetch_build.build_status
+    end
+
+    def build_url
+      "https://#{@client.config.region}.console.aws.amazon.com/codebuild/home#/builds/#{build[:id]}/view/new"
+    end
+
+    def watch_log_url
+      build.logs.deep_link if build
+    end
+
+    def artifact_upload_success?
+      !fetch_build.phases.select { |v|
+        v.phase_type == "UPLOAD_ARTIFACTS" && v.phase_status == "SUCCEEDED"
+      }.empty?
+    end
+
+    def project
+      @project ||= @client.batch_get_projects(names: [project_name])[0][0]
+    end
+
+    def artifact
+      @artifact ||= Artifact.new(self)
+    end
+
+    private
+
+    def fetch_build
+      @build = @client.batch_get_builds(ids: [build[:id]]).builds[0]
+    end
+
+    def source_type
+      project.source.type
+    end
+
+    def done?
+      fetch_build.build_complete
+    end
+
+    def build_spec(cmd)
+      <<~EOS
+        version: 0.2
+        phases:
+          build:
+            commands:
+               - #{cmd}
+      EOS
+    end
+  end
+end

data/lib/buildkiq/version.rb

@@ -0,0 +1,3 @@
+module Buildkiq
+  VERSION = "0.1.0".freeze
+end

data/lib/buildkiq/zip_reader.rb

@@ -0,0 +1,22 @@
+require "zip"
+
+module Buildkiq
+  class ZipReader
+    def initialize(zip_io)
+      @zip_io = zip_io
+    end
+
+    def find_by_name(filename)
+      entry = find_by { |e| e.name == filename }
+      entry ? entry.get_input_stream : nil
+    end
+
+    def find_by
+      Zip::File.open_buffer(@zip_io) do |zip|
+        zip.each { |e| return e if yield(e) }
+      end
+
+      nil
+    end
+  end
+end

data/lib/buildkiq.rb

@@ -0,0 +1,29 @@
+require "logger"
+require "buildkiq/version"
+require "buildkiq/job"
+require "buildkiq/artifact"
+
+module Buildkiq
+  class << self
+    def run(project:, jobs:, default_environments: [], build_cmd: nil, source_version: nil, logger: Logger.new(STDOUT))
+      jobs.each { |job| merge_environments!(job[:environments], default_environments) }
+
+      jobs.map do |job|
+        job = Buildkiq::Job.new(project_name: project, environments: job[:environments])
+        job.start(source_version: source_version, build_cmd: build_cmd)
+        logger.info("build_id: #{job.build.id}")
+        job
+      end
+    end
+
+    private
+
+    def merge_environments!(job_environments, default_environments)
+      default_environments.each do |env|
+        unless job_environments.any? { |h| h[:name] == env[:name] }
+          job_environments << env
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: buildkiq
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Akira Kusumoto
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  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: 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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: AWS CodeBuild container launcher
+email:
+- akirakusumo10@gmail.com
+executables:
+- buildkiq
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- buildkiq.gemspec
+- exe/buildkiq
+- lib/buildkiq.rb
+- lib/buildkiq/artifact.rb
+- lib/buildkiq/cli.rb
+- lib/buildkiq/job.rb
+- lib/buildkiq/version.rb
+- lib/buildkiq/zip_reader.rb
+homepage: https://github.com/bluerabbit/buildkiq
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: AWS CodeBuild container launcher
+test_files: []