leeroy_app 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a33c630bfff44d8f1fbaff8694c65891aef0f8c5
+  data.tar.gz: ad0999e31aec974b08fb8f1e10c268b62a653004
+SHA512:
+  metadata.gz: faf7735d2cdcd8f9cf9cb0e834210f465802fb614845bdca5c8ccd7bb1f3bd8da3d81cda343c036bfe2cf1488d32196c7b28ee6eb5d2c7dab40fc96aa2eedf0e
+  data.tar.gz: a5c965a55dc5be2683f0f27e98405e7c200ef6f0566ef000b62e760d8150e3e58b57c2e4b74193fd697abfb35949e3c1dfc853adb932fc423ed4109a0065dddf

data/.gitignore

@@ -0,0 +1,40 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+## Application configuration
+.env
+.env*
+*.log
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p645

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,103 @@
+PATH
+  remote: .
+  specs:
+    leeroy_app (0.1.0)
+      awesome_print (~> 1.6)
+      aws-sdk (~> 2)
+      chronic (~> 0.10)
+      dotenv (~> 2.1)
+      gli (~> 2.13)
+      hashie (~> 3.4)
+      multi_json (~> 1.11)
+      rugged (~> 0.23)
+      smart_polling (~> 1.0)
+      yell (~> 2.0)
+      yell-adapters-syslog (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aruba (0.11.1)
+      childprocess (~> 0.5.6)
+      contracts (~> 0.9)
+      cucumber (>= 1.3.19)
+      event-bus (~> 0.2)
+      ffi (~> 1.9.10)
+      rspec-expectations (>= 2.99)
+      thor (~> 0.19)
+    awesome_print (1.6.1)
+    aws-sdk (2.2.20)
+      aws-sdk-resources (= 2.2.20)
+    aws-sdk-core (2.2.20)
+      jmespath (~> 1.0)
+    aws-sdk-resources (2.2.20)
+      aws-sdk-core (= 2.2.20)
+    builder (3.2.2)
+    childprocess (0.5.9)
+      ffi (~> 1.0, >= 1.0.11)
+    chronic (0.10.2)
+    coderay (1.1.0)
+    contracts (0.12.0)
+    cucumber (2.1.0)
+      builder (>= 2.1.2)
+      cucumber-core (~> 1.3.0)
+      diff-lcs (>= 1.1.3)
+      gherkin3 (~> 3.1.0)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.2)
+    cucumber-core (1.3.1)
+      gherkin3 (~> 3.1.0)
+    diff-lcs (1.2.5)
+    dotenv (2.1.0)
+    event-bus (0.2.3)
+    ffi (1.9.10)
+    gherkin3 (3.1.2)
+    gli (2.13.4)
+    hashie (3.4.3)
+    jmespath (1.1.3)
+    method_source (0.8.2)
+    multi_json (1.11.2)
+    multi_test (0.1.2)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-awesome_print (9.6.10)
+      awesome_print (>= 1.1.0, < 999)
+      pry (>= 0.9.0, < 999)
+    rake (10.4.2)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    rugged (0.23.3)
+    slop (3.6.0)
+    smart_polling (1.0.0)
+    thor (0.19.1)
+    yell (2.0.5)
+    yell-adapters-syslog (2.0.2)
+      yell (~> 2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba (~> 0.11.1)
+  bundler (~> 1.6)
+  leeroy_app!
+  pry (~> 0.10)
+  pry-awesome_print (~> 9.6)
+  rake (~> 10.0)
+  rspec (~> 3.3)
+
+BUNDLED WITH
+   1.11.2

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 FitnessKeeper
+
+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,40 @@
+# leeroy
+o rly?  ya rly!
+
+## Installation/Configuration
+
+### Development
+
+    $ bundle install
+    $ ./bin/leeroy env -d > .env
+    $ $EDITOR .env
+
+### Production
+
+    $ gem install leeroy_app
+    $ leeroy env -p -d >> ~/.profile
+    $ $EDITOR ~/.profile
+
+## Usage
+
+### General
+
+leeroy is a "git-like" application; it takes GNU-style command-line options, global options come before the subcommand, command-specific options come after the subcommand.
+
+    $ leeroy --help
+
+### Jenkins workflow
+
+Create a new gold master image:
+
+    $ leeroy instantiate --phase gold_master | leeroy image | leeroy terminate
+
+Create a new application image:
+
+    $ leeroy instantiate --phase application | leeroy image | leeroy terminate
+
+### Provisioning workflow
+
+FIXME not implemented yet
+
+    $ leeroy bootstrap | leeroy provision

data/Rakefile

@@ -0,0 +1,5 @@
+require "dotenv/tasks"
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)

data/bin/leeroy

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require 'dotenv'
+Dotenv.load
+
+if ENV['ENVIRONMENT'] == 'development'
+  require 'bundler/setup'
+  require 'pry'
+end
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'leeroy/app'
+
+include Leeroy::App
+
+#  vim: set et fenc= ft=ruby ff=unix sts=2 sw=2 ts=2 : 

data/hierarchy.md

@@ -0,0 +1,39 @@
+## General principles
+
+* Objects interact with the world outside the program (_e.g._ I/O)
+* Objects contain state
+* Modules provide traits/behaviors/information common to multiple objects (_e.g._ logging)
+* The Leeroy::App namespace defines the CLI (commands, runtime configuration)
+* The Leeroy::Data namespace defines the persistence layer
+* The Leeroy::Task namespace defines the application's capabilities
+* The Leeroy::Helpers namespace contains only helper modules, no class definitions
+
+## Hierarchy
+
+classes are marked with `*`
+
+```
+Leeroy
+
+Leeroy::App
+Leeroy::App::Command
+Leeroy::App::Command::Config
+Leeroy::App::Command::Env
+Leeroy::App::Command::State
+Leeroy::App::Command::Task
+Leeroy::App::Command::Version
+
+Leeroy::Helpers
+Leeroy::Helpers::AWS
+Leeroy::Helpers::Env
+Leeroy::Helpers::Polling
+Leeroy::Helpers::State
+
+Leeroy::Task
+Leeroy::Task::Base *
+Leeroy::Task::RunInstance *
+Leeroy::Task::ImageInstance *
+Leeroy::Task::TerminateInstance *
+
+Leeroy::Version
+```

data/leeroy.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'leeroy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "leeroy_app"
+  spec.version       = Leeroy::VERSION
+  spec.authors       = ["Steve Huff"]
+  spec.email         = ["steve.huff@runkeeper.com"]
+  spec.summary       = %q{Automate tasks with Jenkins}
+  spec.description   = %q{Leeroy is a framework and CLI app that captures common features required at various points in a CI pipeline.  It is designed to be invoked interactively or from Jenkins scripts.}
+  spec.homepage      = "https://github.com/FitnessKeeper/leeroy"
+  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"]
+
+  # external dependencies for building gems
+  spec.requirements << 'LibGit2 dependencies for rugged: https://github.com/libgit2/libgit2#optional-dependencies, also CMake and pkg-config'
+
+  spec.add_development_dependency "aruba", "~> 0.11.1"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "pry-awesome_print", "~> 9.6"
+
+  spec.add_runtime_dependency "awesome_print", "~> 1.6"
+  spec.add_runtime_dependency "aws-sdk", "~> 2"
+  spec.add_runtime_dependency "chronic", "~> 0.10"
+  spec.add_runtime_dependency "dotenv", "~> 2.1"
+  spec.add_runtime_dependency "gli", "~> 2.13"
+  spec.add_runtime_dependency "hashie", "~> 3.4"
+  spec.add_runtime_dependency "multi_json", "~> 1.11"
+  spec.add_runtime_dependency "rugged", "~> 0.23"
+  spec.add_runtime_dependency "smart_polling", "~> 1.0"
+  spec.add_runtime_dependency "yell", "~> 2.0"
+  spec.add_runtime_dependency "yell-adapters-syslog", "~> 2.0"
+end

data/lib/leeroy/app.rb

@@ -0,0 +1,132 @@
+#!/usr/bin/env ruby
+
+require 'gli'
+
+require 'leeroy'
+require 'leeroy/task/image'
+require 'leeroy/task/instantiate'
+require 'leeroy/task/terminate'
+require 'leeroy/task/sleep'
+require 'leeroy/task/stub'
+
+include GLI::App
+
+module Leeroy
+  module App
+
+    # constants
+    VALID_PHASE = ['gold_master','application']
+
+    program_desc 'Automate tasks with Jenkins'
+
+    # global options
+    desc "Perform the requested task (pass '--no-op' for testing)."
+    switch [:op], :default_value => true
+
+    desc 'Displays the version of leeroy and exits.'
+    command :version do |c|
+      c.action do |global_options,options,args|
+        printf("leeroy %s\n", Leeroy::VERSION)
+      end
+    end
+
+    desc "Displays leeroy's environment settings."
+    command :env do |c|
+      c.desc "Use default environment settings instead of reading from shell environment."
+      c.switch :default, :d
+
+      c.desc "Format environment settings for use in .profile."
+      c.switch :profile, :p
+
+      c.action do |global_options,options,args|
+        puts Leeroy::Env.new(options).to_s
+      end
+    end
+
+    desc "Instantiates an EC2 instance for imaging."
+    command :instantiate do |c|
+
+      valid_phase = VALID_PHASE
+      c.desc "Phase of deploy process for which to deploy (must be one of #{valid_phase.sort})."
+      c.flag [:p, :phase], :must_match => valid_phase
+
+      c.action do |global_options,options,args|
+        # validate input
+        unless options[:phase].nil? or valid_phase.include?(options[:phase])
+          help_now! "Valid arguments for '--phase' are: #{valid_phase.sort.join(',')}."
+        end
+
+        task = Leeroy::Task::Instantiate.new(global_options: global_options, options: options, args: args)
+        task.perform
+      end
+    end
+
+    desc "Terminates an EC2 instance."
+    command :terminate do |c|
+
+      c.desc "Instance ID (or IDs as comma-delimited strings) to terminate (reads from state if none provided)."
+      c.flag [:i, :instance], :type => Array
+
+      c.action do |global_options,options,args|
+        task = Leeroy::Task::Terminate.new(global_options: global_options, options: options, args: args)
+        task.perform
+      end
+    end
+
+    desc "Creates an image from a running EC2 instance."
+    command :image do |c|
+
+      valid_phase = VALID_PHASE
+      c.desc "Phase of deploy process for which to deploy (must be one of #{valid_phase.sort})."
+      c.flag [:p, :phase]
+
+      c.desc "Instance ID from which to image (optional, will be extracted from state if not provided)."
+      c.flag [:i, :instance]
+
+      c.desc "Image index (optional, will be calculated if not provided)."
+      c.flag [:n, :index]
+
+      c.action do |global_options,options,args|
+        # validate input
+        unless options[:phase].nil? or valid_phase.include?(options[:phase])
+          help_now! "Valid arguments for '--phase' are: #{valid_phase.sort.join(',')}."
+        end
+
+        # index must be nil or must look like a positive integer
+        begin
+          unless options[:index].nil? or options[:index].to_i > 0
+            help_now! "The argument for '--index' must be a positive integer."
+          end
+
+        rescue NoMethodError => e
+          help_now! "The argument for '--index' must be a positive integer."
+        end
+
+        task = Leeroy::Task::Image.new(global_options: global_options, options: options, args: args)
+        task.perform
+      end
+    end
+
+    desc "Sleeps for some number of seconds."
+    command :sleep do |c|
+      c.desc "Number of seconds to sleep."
+      c.flag [:i, :interval], :default_value => 2
+
+      c.action do |global_options,options,args|
+        Leeroy::Task::Sleep.new(global_options: global_options, options: options, args: args).perform
+      end
+    end
+
+    desc "Runs the stub task."
+    command :stub do |c|
+      c.desc "Amount by which to increment the stub value"
+      c.flag [:i, :increment], :default_value => 1
+      c.action do |global_options,options,args|
+        task = Leeroy::Task::Stub.new(global_options: global_options, options: options, args: args)
+        task.perform
+      end
+    end
+
+    exit run(ARGV)
+  end
+end

data/lib/leeroy/env.rb

@@ -0,0 +1,116 @@
+require 'dotenv'
+Dotenv.load
+
+require 'leeroy/types/mash'
+require 'leeroy/helpers/dumpable'
+require 'leeroy/helpers/env'
+require 'leeroy/helpers/logging'
+
+module Leeroy
+  class Env < Leeroy::Types::Mash
+    include Leeroy::Helpers::Dumpable
+    include Leeroy::Helpers::Env
+    include Leeroy::Helpers::Logging
+
+    # constants
+    S3_PREFIXES = {
+      :secrets    => 'secrets',
+      :jenkins    => 'jenkins',
+      :builds     => 'builds',
+      :logs       => 'logs',
+      :semaphores => 'semaphores',
+      :tests      => 'tests',
+    }
+
+    ENV_DEFAULTS = {
+      'LEEROY_APP_NAME' => '<identifying string, e.g. "tomcat7">',
+      'LEEROY_AWS_LINUX_AMI' => '<AMI ID to be used as base for gold master>',
+      'LEEROY_BUILD_INSTANCE_TYPE' => '<EC2 instance type to be used for imaging>',
+      'LEEROY_BUILD_PROFILE_NAME' => '<IAM instance profile name to be applied to imaging instances>',
+      'LEEROY_BUILD_SECURITY_GROUP' => '<VPC security group name to be applied to imaging instances>',
+      'LEEROY_BUILD_SSH_KEYPAIR' => '<SSH keypair name for access to imaging instances>',
+      'LEEROY_BUILD_SUBNET' => '<VPC subnet name to be applied to imaging instances>',
+      'LEEROY_BUILD_TARGET' => '<identifying string for application build, e.g. "webapi" or "stage20">',
+      'LEEROY_BUILD_VPC' => '<VPC name in which imaging instances are created>',
+      'LEEROY_GOLD_MASTER_IMAGE_PREFIX' => '<identifying string used to generate AMI names>',
+      'LEEROY_GOLD_MASTER_NAME' => '<identifying string used to tag gold master instances during imaging>',
+      'LEEROY_POLL_INTERVAL' => '<number of seconds to wait between polling for long-running AWS operations>',
+      'LEEROY_POLL_TIMEOUT' => '<number of seconds to wait between giving up on long-running AWS operations>',
+      'LEEROY_PROVISIONING_TEMPLATE_PREFIX' => '<path on local filesystem to directory containing provisioning templates>',
+      'LEEROY_S3_BUCKET' => '<name of bucket used as datastore>',
+      'LEEROY_PROVISIONING_TEMPLATE_PREFIX' => '<path on local filesystem to directory containing user-data templates>',
+    }
+
+    ENV_EXTRAS = {
+      'ENVIRONMENT' => '<development or production>',
+      'GLI_DEBUG' => '<true or false>',
+      'AWS_REGION' => '<your AWS region>',
+    }
+
+    # attr_reader :default, :profile
+    attr_reader :profile, :defaults
+
+    def initialize(options = {}, env = ENV)
+      begin
+        logger.debug "initializing #{self.class}"
+        logger.debug "options: #{options.inspect}"
+
+        @defaults = options[:default]
+        @profile = options[:profile]
+
+        if self.defaults
+          unfiltered = ENV_DEFAULTS
+          extras = ENV_EXTRAS
+        else
+          unfiltered = env
+          extras = {}
+        end
+
+        filtered = _filterEnv(unfiltered).merge(extras)
+        logger.debug "filtered: #{filtered.inspect}"
+
+        self.dump_properties = filtered.keys.sort.collect { |x| x.to_sym }
+        super(filtered)
+
+      rescue StandardError => e
+        raise e
+      end
+    end
+
+    def to_s
+      _prettyPrint
+    end
+
+    private
+
+    def _prettyPrint
+      if self.profile
+        formatstr = 'export %s=%s'
+        header = '# environment variables for leeroy configuration'
+      else
+        formatstr = '%s=%s'
+        header = nil
+      end
+
+      if self.defaults
+        formatstr = '# '.concat(formatstr)
+      end
+
+      properties = self.dump_properties.collect {|x| x.to_s}.sort.collect {|x| sprintf(formatstr, x, self.fetch(x))}
+
+      properties.unshift(header) unless header.nil?
+
+      properties.join("\n")
+    end
+
+    def _filterEnv(env, prefix = 'LEEROY_')
+      begin
+        logger.debug("filtering env by prefix '#{prefix}'")
+        env.select { |k,v| k.start_with?(prefix) }
+
+      rescue StandardError => e
+        raise e
+      end
+    end
+  end
+end