build_spec_runner 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 35382674855121efe797abd6329e163abe23c3bb
+  data.tar.gz: 6c65f76c371144c0a5f4360f4c237e4cf368685a
+SHA512:
+  metadata.gz: 6b4bc59acb06804758e3d646705ce66839a6ae4940e9e18eeaeb086c50037adcd6bea238c6100573915f626c317e1a331e80cf2af4c0be70c1da4e83a55bf878
+  data.tar.gz: 3a0bba4b3f1253b6da766d6ea5d6699999bb8faaaf671dcf3c36d31fe2edb1fe3bbf5d12cd1cd595ccb8a15982618802fa2f4181899d4807356e21bd08af296a

data/.gitignore

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

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.15.1

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 jzuber4@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 build_spec_runner.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jimmy Zuber
+
+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,98 @@
+# BuildSpecRunner
+
+[![Gem Version](https://img.shields.io/gem/v/build_spec_runner.svg)](https://rubygems.org/gems/build_spec_runner)
+[![Code Climate](https://img.shields.io/codeclimate/github/jzuber4/build_spec_runner.svg)](https://codeclimate.com/github/jzuber4/build_spec_runner)
+[![Gemnasium](https://img.shields.io/gemnasium/jzuber4/build_spec_runner.svg)](https://gemnasium.com/github.com/jzuber4/build_spec_runner/)
+
+BuildSpecRunner is a utility for running [AWS CodeBuild](https://aws.amazon.com/codebuild/) ```build_spec.yml``` files. It does so by running the project locally in a Docker container, trying to mirror the execution semantics of CodeBuild as much as possible. It is primarily useful as a CLI utility but can also be used as a library.
+
+Currently *unsupported* features:
+
+* Build artifact export -- BuildSpecRunner will not export your build artifacts. It essentially ignores the "artifacts" section of the Build Spec file.
+* [Build Environment Variables](http://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-env-vars.html) -- BuildSpecRunner does not specify all the same environment variables as AWS CodeBuild. It does support environment variables declared in the Build Spec file.
+
+## Installation
+
+### Dependencies
+
+BuildSpecRunner requires Docker. See the [Docker installation instructions](https://docs.docker.com/engine/installation/).
+If you wish to be able to execute docker without root, you may want to follow the [Linux Post-Installation Instructions](https://docs.docker.com/engine/installation/linux/linux-postinstall/). Please be aware of the security risks of doing so.
+
+BuildSpecRunner tries to attach [AWS STS](http://docs.aws.amazon.com/STS/latest/APIReference/Welcome.html) credentials to the Docker container by default. It is recommended that you [configure the AWS CLI](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) to enable this functionality. This lets you run any actions in your project that require AWS authentication. You may choose the AWS profile to use, otherwise it falls back to the configured default.
+
+### CLI utility installation
+
+    $ gem install build_spec_runner
+
+### Library installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'build_spec_runner'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install build_spec_runner
+
+## Usage
+
+Execute a project located at a directory, given the default ```buildspec.yml``` Build Spec filename:
+
+    $ build_spec_runner -p /path/to/project/
+
+Specify a different Build Spec filepath with ```--build_spec_path```:
+
+    $ build_spec_runner -p /path/to/project/ --build_spec_path ./my_build_spec_so_unique.yml
+
+Relative and absolute paths are OK:
+
+    $ build_spec_runner -p ../project/ --build_spec_path /path/to/build/spec/bs.yml
+
+You can silence BuildSpecRunner's debug output with ```-q``` or ```--quiet```:
+
+    $ build_spec_runner -p /path/to/project/ --quiet
+
+Specify your own Docker image by its ID with ```--image_id```:
+
+    $ build_spec_runner -p /path/to/project/ --image_id fee13e06bbce
+
+Specify a different AWS CodeBuild vended image with ```--aws_dockerfile_path```. See the official [AWS CodeBuild Docker images repo](https://github.com/aws/aws-codebuild-docker-images) for more information:
+
+    $ build_spec_runner -p /path/to/project/ --aws_dockerfile_path ubuntu/java/openjdk-8
+
+By default BuildSpecRunner will use the configured default AWS profile. Specify a different profile with ```--profile```:
+
+    $ build_spec_runner -p /path/to/project/ --profile MyBuilderBot
+
+By default BuildSpecRunner will attach AWS STS credentials for the current default AWS profile to the project's Docker container.
+You can opt out of this by passing ```--no_credentials```:
+
+    $ build_spec_runner -p /path/to/project/ --no_credentials
+
+You may specify the AWS region provided to the project. This will set the [appropriate env variables](http://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-env-vars.html) to make it look like the project is running in the specified region. Otherwise it uses the default region configured by the current or provided AWS profile.
+
+    $ build_spec_runner -p /path/to/project/ --region us-east-2
+
+## 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/jzuber4/build_spec_runner. 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).
+
+## Code of Conduct
+
+Everyone interacting in the BuildSpecRunner project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jzuber4/build_spec_runner/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+desc "Open a terminal with this gem required"
+task :irb do
+  require 'irb'
+  require 'irb/completion'
+  require 'build_spec_runner'
+  ARGV.clear
+  IRB.start
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "build_spec_runner"
+
+# 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

data/build_spec_runner.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "build_spec_runner/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "build_spec_runner"
+  spec.version       = BuildSpecRunner::VERSION
+  spec.authors       = ["Jimmy Zuber"]
+  spec.email         = ["jzuber4@gmail.com"]
+
+  spec.summary       = %q{A gem to execute AWS CodeBuild build_spec.yml files locally.}
+  spec.description   = %q{A gem to execute AWS CodeBuild build_spec.yml files locally.
+AWS CodeBuild (https://aws.amazon.com/codebuild/) is an AWS product. This gem is a third-party creation not affiliated with AWS.
+}
+  spec.homepage      = "https://github.com/jzuber4/build_spec_runner"
+  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_dependency 'aws-sdk-core', '~> 3'
+  spec.add_dependency 'aws-sdk-ssm', '~> 1.1'
+  spec.add_dependency 'docker-api', '~> 1.33'
+  spec.add_dependency 'git', '~> 1.3'
+  spec.add_dependency 'kwalify', '~> 0.7'
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency 'pry', '~> 0.11'
+  spec.add_development_dependency "rake", "~> 12.1"
+  spec.add_development_dependency "rspec", "~> 3.6"
+  spec.add_development_dependency "yard", "~> 0.9"
+end

data/exe/build_spec_runner

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'build_spec_runner'
+
+BuildSpecRunner::CLI.main

data/lib/build_spec_runner.rb

@@ -0,0 +1,6 @@
+require 'build_spec_runner/build_spec/build_spec'
+require 'build_spec_runner/cli'
+require 'build_spec_runner/default_images'
+require 'build_spec_runner/runner'
+require 'build_spec_runner/source_provider'
+require 'build_spec_runner/version'

data/lib/build_spec_runner/build_spec/build_spec.rb

@@ -0,0 +1,148 @@
+require 'kwalify'
+require 'yaml'
+
+module BuildSpecRunner
+  module BuildSpec
+
+    # Phases of a buildspec file.
+
+    PHASES = ['install', 'pre_build', 'build', 'post_build']
+
+    # Error for communicating issues with buildspec
+
+    class BuildSpecError < StandardError
+
+      # @!attribute [r] filename
+      #   @return [String] the filename of the buildspec that caused the error
+
+      attr_reader :filename
+
+      def initialize(message, filename)
+        @filename = filename
+        super(message)
+      end
+    end
+    
+    # Class for representing a buildspec defined by a buildspec file.
+    # @see http://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html
+
+    class BuildSpec
+
+      # @!attribute [r] env
+      #   @return [Map<String, String>] A mapping of environment variable names to values.
+      # @!attribute [r] paremeter_store
+      #   @return [Map<String, String>] A mapping of parameter store environment variable names to the parameter store key.
+      # @!attribute [r] phases
+      #   @return [Map<String, Array<String>>] A mapping of phase name to a list of commands
+      #   for that phase
+
+      attr_reader :env, :parameter_store, :phases
+
+      # Parse a buildspec file to create a BuildSpec object. Parses the file according to a
+      # buildspec schema.
+
+      def initialize filename
+        @filename = filename
+        parse_file
+      end
+
+      private
+
+      # The filename of the build spec file, used for raising {BuildSpecError}s
+
+      attr_reader :filename
+
+      # Parse a buildspec yaml file to create a BuildSpec object. Uses a Kwalify schema for validation
+
+      def parse_file
+        document = YAML.load_file @filename
+        validate_with_schema document
+
+        validate_version document
+        @env, @parameter_store = validate_env document 
+        @phases          = validate_phases document
+        validate_artifacts document
+      end
+
+      # Validate the buildspec file using a Kwalify schema
+      #
+      # @param document [Hash] a document object representing the build spec
+      # @raise [BuildSpecError] if the build spec doesn't comply with the schema
+
+      def validate_with_schema document
+        schema_filename = File.join(File.dirname(__FILE__), './buildspec_schema.yml')
+        schema = Kwalify::Yaml.load_file(schema_filename)
+
+        errors = Kwalify::Validator.new(schema).validate document
+        if errors && !errors.empty?
+          raise BuildSpecError.new "Encountered errors while validating buildspec according to schema: #{errors}", @filename
+        end
+      end
+
+      # Validate the build spec document's version
+      #
+      # @raise [BuildSpecError] if the version is not supported
+
+      def validate_version document
+        version = document['version']
+        if version != 0.2
+          raise BuildSpecError.new "Unsupported version: #{version}. This only supports 0.2", @filename
+        end
+      end
+
+      # Validate and parse the build spec document's environment variables and parameter-store variables
+      #
+      # @raise [BuildSpecError] if the env variables or paremeter-store variables are invalid
+      # @return [Array<String>, Array<String>] the environment variables and parameter store variables, in that order
+
+      def validate_env document
+        assert_not_nil_key document, 'env', 'Mapping "env" requires at least one of ["variables", "parameter-store"]'
+
+        assert_not_nil_key document['env'], 'variables', 'Mapping "env => variables" requires at least one entry, if it exists'
+        env = document['env']['variables'] if document['env'] and document['env']['variables']
+        env ||= {}
+        env.freeze
+
+        assert_not_nil_key document['env'], 'parameter-store', 'Mapping "env => parameter-store" requires at least one entry, if it exists'
+        parameter_store = document['env']['parameter-store'] if document['env'] and document['env']['parameter-store']
+        parameter_store ||= {}
+        parameter_store.freeze
+
+        return env, parameter_store
+      end
+
+      # Validate and parse the build spec document's phases
+      #
+      # @raise [BuildSpecError] if the phase mappings are  invalid
+      # @return [Hash<String, Array[String]>] a mapping of phase name to a list of commands in that phase
+
+      def validate_phases document
+        phases = {}
+        for phase in PHASES
+          assert_not_nil_key document['phases'], phase, "Mapping \"phases => #{phase}\" requires mapping \"commands\""
+          phases[phase] = document['phases'][phase]['commands'] unless document['phases'][phase].nil?
+          phases[phase] ||= []
+        end
+        phases
+      end
+
+      # Validate the build spec document's artifacts
+      #
+      # @raise [BuildSpecError] if the artifact mapping is invalid
+
+      def validate_artifacts document
+        assert_not_nil_key document, 'artifacts', 'Mapping "artifacts" requires mapping "files"'
+      end
+
+      # Assert that the document does not have the key with a nil value
+      #
+      # @raise [BuildSpecError] If the document has the key but the key's value is nil
+
+      def assert_not_nil_key document, key, message
+        if !document.nil? and document.key? key and document[key].nil?
+          raise BuildSpecError.new message, @filename
+        end
+      end
+    end
+  end
+end