drunker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e4f32c3b7e312a8fed15ab1d6181193fb13744b
+  data.tar.gz: b5535975e7b881f411db29139d5ba72afb39d1b3
+SHA512:
+  metadata.gz: 0055dbb90fd76fe7c75b38aa11f77a1ff96d2db1ce17652f9376e7187ae469f04ab056f5a75aef296a33bf1993cbe3be1099a68f22101609976d7e1336149350
+  data.tar.gz: d5d3607e90d875220781900b1bac374cbbbf789034b570715d35a5de699820d1747f0177ffacc83717a65502390a29f4d6c90257da6e35649737a48ac3c50135

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at watassbass@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 wata_mac
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,281 @@
+# Drunker
+
+Distributed CLI runner on [AWS CodeBuild](https://aws.amazon.com/codebuild/). This is a wrapper for handling CodeBuild container more easily.
+
+## Installation
+
+    $ gem install drunker
+
+## Usage
+
+All you need to use Drunker is the Docker image name of the container you want to use and the command you want to execute (Of course, AWS credentials is also necessary). For example, you can run [RSpec](https://github.com/rspec/rspec) on CodeBuild with the following command.
+
+```
+$ bundle install --path=vendor/bundle
+$ drunker run --env=BUNDLE_PATH:vendor/bundle/ruby/2.4.0 --timeout=5 ruby:2.4.1 bundle exec rspec
+```
+
+First, specify the Docker image name, and then the command you want to execute. After that, Drunker archives files under the current directory and uploads it to S3 and creates a CodeBuild project and the required IAM role.
+
+When preparation is completed, run builds, download artifacts from S3, and display it on your terminal. Resources created by Drunker are automatically deleted. Also, in this example, timeout and environment variables used inside containers are specified by options.
+
+You can see execution result (e.g. STDOUT, STDERR and exit status) from output like the following.
+
+```
+-------------------------------------------------------------------------------------------
+BUILD_ID: drunker-executor-1494139943:10c9c785-bae0-4a2d-b5eb-927528943626
+RESULT: SUCCESS
+STDOUT: .....................................................................................................................................
+
+Finished in 5.9 seconds (files took 0.17053 seconds to load)
+133 examples, 0 failures
+
+STDERR:
+EXIT_STATUS: 0
+-------------------------------------------------------------------------------------------
+```
+
+### Parallel Build
+
+The essence of Drunker is parallel build. For example, if you want to run RSpec in parallel, you can do it easily with the following command.
+
+```
+$ drunker run --concurrency=3 --file-pattern="spec/**/*_spec.rb" --env=BUNDLE_PATH:vendor/bundle/ruby/2.4.0 --timeout=5 ruby:2.4.1 bundle exec rspec FILES
+```
+
+`FILES` included in the execution command has a special meaning. This is interpolated into the list of filenames according to the number of parallels. For example, in this case, it will be the following command (filename changes for each build):
+
+```
+$ bundle exec rspec spec/aggregator_spec.rb spec/artifact_spec.rb ...
+```
+
+The target file is all files matching the glob pattern `**/*`. However, you can change this with `--file-pattern` option. You can see the execution result as the following:
+
+```
+-------------------------------------------------------------------------------------------
+BUILD_ID: drunker-executor-1494140968:59c0b89f-099e-482c-8995-659f8b6b8523
+RESULT: SUCCESS
+STDOUT: ................
+
+Finished in 0.12019 seconds (files took 0.14562 seconds to load)
+16 examples, 0 failures
+
+STDERR:
+EXIT_STATUS: 0
+-------------------------------------------------------------------------------------------
+
+
+-------------------------------------------------------------------------------------------
+BUILD_ID: drunker-executor-1494140968:f6cb0396-3005-44ca-8221-33b29cbbd309
+RESULT: SUCCESS
+STDOUT: ..........................................................................
+
+Finished in 0.15774 seconds (files took 0.19026 seconds to load)
+74 examples, 0 failures
+
+STDERR:
+EXIT_STATUS: 0
+-------------------------------------------------------------------------------------------
+
+
+-------------------------------------------------------------------------------------------
+BUILD_ID: drunker-executor-1494140968:620c471e-19e7-48da-95e7-42cd66728455
+RESULT: SUCCESS
+STDOUT: ...........................................
+
+Finished in 5.56 seconds (files took 0.14991 seconds to load)
+43 examples, 0 failures
+
+STDERR:
+EXIT_STATUS: 0
+-------------------------------------------------------------------------------------------
+```
+
+What is surprising is that do not require your local machine specs at all even if you increase the number of parallels. You can increase the number of parallels within the bounds of common sense.
+
+### EC2 Container Registry
+
+Do you want to use private images? You can also specify the image of [EC2 Container Registry](https://aws.amazon.com/ecr/). Following example:
+
+```
+$ drunker run account-ID.dkr.ecr.us-east-1.amazonaws.com/your-Amazon-ECR-repo-name:latest ruby task.rb
+```
+
+For details, please see [Amazon ECR Sample for AWS CodeBuild](http://docs.aws.amazon.com/codebuild/latest/userguide/sample-ecr.html).
+
+## Available Options
+
+Please show `drunker help run`
+
+```
+Usage:
+  drunker run [IMAGE] [COMMAND]
+
+Options:
+  [--config=CONFIG]              # Location of config file
+                                 # Default: .drunker.yml
+  [--concurrency=N]              # Build concurrency
+                                 # Default: 1
+  [--compute-type=COMPUTE_TYPE]  # Container compute type
+                                 # Default: small
+                                 # Possible values: small, medium, large
+  [--timeout=N]                  # Build timeout in minutes, should be between 5 and 480
+                                 # Default: 60
+  [--env=key:value]              # Environment variables in containers
+  [--buildspec=BUILDSPEC]        # Location of custom buildspec
+  [--file-pattern=FILE_PATTERN]  # FILES target file pattern, can use glob to specify, but files beginning with a dot are ignored.
+                                 # Default: **/*
+  [--aggregator=AGGREGATOR]      # Aggregator name. If you want to use custom aggregator, please install that beforehand.
+                                 # Default: pretty
+  [--loglevel=LOGLEVEL]          # Output log level
+                                 # Default: info
+                                 # Possible values: debug, info, warn, error, fatal
+  [--debug], [--no-debug]        # Enable debug mode. This mode does not delete the AWS resources created by Drunker
+  [--access-key=ACCESS_KEY]      # AWS access key token used by Drunker
+  [--secret-key=SECRET_KEY]      # AWS secret key token used by Drunker
+  [--region=REGION]              # AWS region in which resources is created by Drunker
+  [--profile-name=PROFILE_NAME]  # AWS shared credentials profile name used by Drunker
+
+Run a command on CodeBuild
+```
+
+## Configuration
+
+By default, it loads `.drunker.yml`. In the configuration file, many options can be written in advance. Following example:
+
+```yaml
+concurrency: 10
+compute_type: medium
+timeout: 5
+file_pattern: spec/**/*_spec.rb
+environment_variables:
+  RAILS_ENV: test
+  SECRET_KEY_BASE: super secret
+aws_credentials:
+  access_key: AWS_ACCESS_KEY_ID
+  secret_key: AWS_SECRET_ACCESS_KEY
+  region: us-east-1
+```
+
+If you want to create a configuration file with a different name, specify the file name with --config option.
+
+```
+$ drunker run --config=.custom_drunker.yml ruby:2.4.1 bundle exec rspec
+```
+
+### Credentials
+
+Drunker supports various credential providers. It is used with the following priority:
+
+- Specified shared credentials
+- Static credentials
+- Environment credentials
+- Default shared credentials
+
+#### Static Credentials
+
+If you have access key and secret key, you can specify these credentials.
+
+```
+$ drunker run --access-key=AWS_ACCESS_KEY_ID --secret-key=AWS_SECRET_ACCESS_KEY --region=us-east-1 owner_name/image_name ruby task.rb
+```
+
+```yaml
+aws_credentials:
+  access_key: AWS_ACCESS_KEY_ID
+  secret_key: AWS_SECRET_ACCESS_KEY
+  region: us-east-1
+```
+
+#### Shared Credentials
+
+If you have [shared credentials](https://aws.amazon.com/blogs/security/a-new-and-standardized-way-to-manage-credentials-in-the-aws-sdks/), you can specify credentials profile name. However Drunker supports only `~/.aws/credentials` as shared credentials location.
+
+```
+$ drunker run --profile-name=PROFILE_NAME --region=us-east-1 owner_name/image_name ruby task.rb
+```
+
+```yaml
+aws_credentials:
+  profile_name: PROFILE_NAME
+  region: us-east-1
+```
+
+## Customize Build Specification
+
+Do you want to customize the build specification more? You can change the `buildspec.yml` that is used by Drunker. The default `buildspec.yml` is [here](https://github.com/wata727/drunker/tree/master/lib/drunker/executor/buildspec.yml.erb). For example, if you want to run `bundle install` in the install phase, create the `custom_buildspec.yml` like the following.
+
+```yaml
+version: 0.1
+phases:
+  install:
+    commands:
+      - bundle install
+  build:
+    commands:
+      - <%= commands.join(" ") %> 1> <%= stdout %> 2> <%= stderr %>; echo $? > <%= exit_status %>
+artifacts:
+  files:
+    - <%= stdout %>
+    - <%= stderr %>
+    - <%= exit_status %>
+```
+
+Actual commands and output files are interpolated by ERB. Please see [here](http://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html) for how to write `buildspec.yml`. After that, specify the file path with the `--buildspec` option.
+
+```
+$ drunker run --buildspec=custom_buildspec.yml owner_name/image_name ruby task.rb
+```
+
+Also, you can specify it in the configuration file.
+
+```yaml
+buildspec: custom_buildspec.yml
+```
+
+In configuration file, you can also be described inline style.
+
+```yaml
+buildspec:
+  version: 0.1
+  phases:
+    install:
+      commands:
+        - bundle install
+    build:
+      commands:
+        - <%= commands.join(" ") %> 1> <%= stdout %> 2> <%= stderr %>; echo $? > <%= exit_status %>
+  artifacts:
+    files:
+      - <%= stdout %>
+      - <%= stderr %>
+      - <%= exit_status %>
+```
+
+## Customize Output
+
+Do you want to customize the output format? You can customize output format, exit code by creating Gem called aggregator. For example, the default aggregator is implemented as a separate [Gem](https://github.com/wata727/drunker-aggregator-pretty).
+
+The specifications that the aggregator must satisfy are the following three.
+
+- Inherit `Drunker::Aggregator::Base`
+- Implement `run` and `exit_status` methods to receive array of `Drunker::Artifact::Layer`
+- Return a number in `exit_status` method
+
+`Drunker::Artifact::Layer` has outputs and build ID for each build. Please see the [implementation](https://github.com/wata727/drunker/blob/master/lib/drunker/artifact/layer.rb) for details.
+
+## 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/wata727/drunker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "drunker"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

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