Class: BuildSpecRunner::Runner

Inherits:
Object
  • Object
show all
Defined in:
lib/build_spec_runner/runner.rb

Overview

Module for running projects on a local docker container.

It is expected that you have a SourceProvider object that can yield a path containing a project suitable for AWS Codebuild. The project should have a buildspec file in its root directory. This module lets you use the default Ruby CodeBuild image or specify your own. See Runner.run and Runner.run_default.

See Also:

Constant Summary collapse

DEFAULT_BUILD_SPEC_PATH =

The default path of the buildspec file in a project.

'buildspec.yml'

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.run(image, source_provider, opts = {}) ⇒ Integer

Run a project on the specified image.

Run a project on the specified image, with the source pointed to by the specified source provider. If the buildspec filename is not buildspec.yml or is not located in the project root, specify the option :build_spec_path to choose a different relative path (including filename).

Parameters:

  • image (Docker::Image) —

    A docker image to run the project on.

  • source_provider (BuildSpecRunner::SourceProvider) —

    A source provider that yields the source for the project.

  • opts (Hash) (defaults to: {}) —

    A hash containing several optional values: for redirecting output.

    • :outstream (StringIO) — for redirecting the project’s stdout output

    • :errstream (StringIO) — for redirecting the project’s stderr output

    • :build_spec_path (String) — Path of the buildspec file (including filename ) relative to the project root. Defaults to DEFAULT_BUILD_SPEC_PATH.

    • :quiet (Boolean) — suppress debug output

    • :profile (String) — Profile to use for AWS clients

    • :no_credentials (Boolean) — don’t supply AWS credentials to the container

    • :region (String) — AWS region to provide to the container.

Returns:

  • (Integer) —

    The exit code from running the project.



64
65
66
67
68
 
# File 'lib/build_spec_runner/runner.rb', line 64

def self.run image, source_provider, opts = {}
  runner = Runner.new image, source_provider, opts
  Runner.configure_docker
  runner.execute
end

.run_default(path, opts = {}) ⇒ Integer

Run the project at the specified directory on the default AWS CodeBuild Ruby 2.3.1 image.

Parameters:

  • path (String) —

    The path to the project.

Returns:

  • (Integer) —

    The exit code from running the project.

See Also:



34
35
36
37
38
39
40
 
# File 'lib/build_spec_runner/runner.rb', line 34

def self.run_default path, opts={}
  Runner.run(
    BuildSpecRunner::DefaultImages.build_image,
    BuildSpecRunner::SourceProvider::FolderSourceProvider.new(path),
    opts
  )
end

Instance Method Details

#execute ⇒ Object

Run the project

Parse the build_spec, create the environment from the build_spec and any configured credentials, and build a container. Then execute the build spec’s commands on the container.

This method will close and remove any containers it creates.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/build_spec_runner/runner.rb', line 77

def execute
  build_spec = Runner.make_build_spec(@source_provider, @build_spec_path)
  env = make_env(build_spec)

  container = nil
  begin
    container = Runner.make_container(@image, @source_provider, env)
    run_commands_on_container(container, build_spec)
  ensure
    unless container.nil?
      container.stop
      container.remove
    end
  end
end