momentum 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e6d9f5cfb124f1061f031e1830abf34dc1c9dab3
+  data.tar.gz: 85c8676d3ca113bda88117ec61d6eda40260316a
+SHA512:
+  metadata.gz: 3a4991c287f2fe675ec3293040a2adf55260420d1c3ae3ed859f53be884b400572c0475facd367ef764c67d4b036ac6a997f038a9c705dcf3fa37db793732527
+  data.tar.gz: 0f99656306f1ce62477c222088d6cad42e4a0de76655ccab35f5fcd62fba1b3ebc679a5e36f2d833f175fa94fb5ecd8481eae6ce95bbcba1ab38bd3d5b00ff3c

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Artsy
+
+MIT License
+
+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,92 @@
+# Momentum
+
+Shared utilities for managing and deploying OpsWorks apps at Artsy.
+
+
+## Installation
+
+Add this line to your application's Gemfile, probably in the `:development` group:
+
+    gem 'momentum', github: 'artsy/momentum', require: false
+
+In your application's Rakefile, add this line above the `load_tasks` command:
+
+    begin
+      require 'momentum'  # necessary b/c tasks from gems in :development group aren't loaded automatically
+      Momentum.configure do |conf|
+        conf[:app_base_name] = 'your_app_name'
+      end
+    rescue LoadError
+      # momentum should only be installed in development
+    end
+
+And then execute:
+
+    $ bundle
+    $ gem install librarian-chef  # ideally this would be in the bundle, but has conflicts
+    $ bundle exec rake momentum:init
+
+
+## Rake Tasks
+
+This gem adds a few useful rake tasks to your project. In general, the `aws_id` and `aws_secret` arguments are taken from `AWS_ID` and `AWS_SECRET` ENV variables. The `to` argument can refer to an environment or developer (e.g., _joey_ in the case of _reflection-joey_, or _staging_ in the case of _gravity-staging_). It's assumed that this value can be appended to the `app_base_name` to form the stack name.
+
+### momentum:init
+
+Initialize a default librarian-chef config.
+
+### ow:config[to,aws_id,aws_secret]
+
+Print the custom configuration values for the given stack. E.g.:
+
+    bundle exec rake ow:config[joey]
+
+### ow:config:from_env[to,aws_id,aws_secret]
+
+Add the given stack's custom configuration values to the current task's ENV. Can be prepended to other rake tasks that depend on the ENV, e.g.:
+
+    bundle exec rake ow:config:from_env[production] some:migration
+
+### ow:console[to,env,aws_id,aws_secret]
+
+Start a rails console on the given remote OpsWorks stack. Chooses an instance of the _rails-app_ layer by default, or the configured `rails_console_layer` if provided. E.g.:
+
+    bundle exec rake ow:console[production]
+
+For stacks with labels not matching the Rails environment (e.g., _reflection-joey_), provide a 2nd argument with the desired environment:
+
+    bundle exec rake ow:console[joey,staging]
+
+### ow:cookbooks:update[to,aws_id,aws_secret]
+
+Zip, upload, and propagate custom cookbooks to the given stack. Or, more concisely:
+
+    bundle exec rake ow:cookbooks:update[staging]
+    # or just:
+    bundle exec rake ow:cookbooks:update:staging
+
+### ow:deploy[to,aws_id,aws_secret]
+
+Trigger an OpsWorks deploy to the given stack. By default, deploys app to all running instances of the _rails-app_ layer, or the list configured in `app_layers`. E.g.:
+
+    bundle exec rake ow:deploy[staging]
+    # or just:
+    bundle exec rake ow:deploy:staging
+
+## Configuration:
+
+* **app_base_name** - Your app's name. Stacks are assumed to be named like _appbasename-env_ (e.g., _gravity-staging_ or _reflection-joey_).
+* **app_layers** - Array of OpsWorks layer names to which this rails app should be deployed. Default: `['rails-app']`
+* **cookbooks_install_path** - Local path where librarian-chef will install cookbooks. Default: _tmp/cookbooks_
+* **custom_cookbooks_bucket** - Bucket to which custom cookbooks are uploaded. Default: _artsy-cookbooks_
+* **rails_console_layer** - The OpsWorks layer used for SSH-ing and starting a rails console. Default: _rails-app_
+
+
+## To Do
+
+* git/branch helpers
+* Integrate librarian-chef as legit dependency once rails/chef conflicts resolved
+
+
+© 2014 [Artsy](http://artsy.net). See [LICENSE](LICENSE.txt) for details.
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/momentum/opsworks.rb

@@ -0,0 +1,89 @@
+module Momentum::OpsWorks
+
+  def self.client(aws_id, aws_secret)
+    raise "You must specify aws_id and aws_secret!" unless aws_id.present? && aws_secret.present?
+    require 'aws-sdk'
+    AWS::OpsWorks::Client.new(access_key_id: aws_id, secret_access_key: aws_secret)
+  end
+
+  def self.get_stack(client, stack_name)
+    client.describe_stacks[:stacks].detect { |k, v| k[:name] == stack_name }.tap do |stack|
+      raise "No #{stack_name} stack found!" unless stack
+    end
+  end
+
+  def self.get_app(client, stack, app_name)
+    client.describe_apps(stack_id: stack[:stack_id])[:apps].detect { |a| a[:name] == app_name }
+  end
+
+  def self.get_layers(client, stack, layer_names)
+    client.describe_layers(stack_id: stack[:stack_id])[:layers].select { |l| layer_names.include?(l[:shortname]) }
+  end
+
+  def self.get_online_instance_ids(client, query = {})
+    get_online_instances(client, query).map { |i| i[:instance_id] }
+  end
+
+  def self.get_online_instances(client, query = {})
+    client.describe_instances(query)[:instances].select { |i| i[:status] == 'online' }
+  end
+
+  class Config
+
+    def self.from_stack(client, stack_name, app_name = Momentum.config[:app_base_name])
+      @@configs ||= {}
+      @@configs[[stack_name, app_name]] ||= load_from_stack(client, stack_name, app_name)
+    end
+
+    private
+
+    def self.load_from_stack(client, stack_name, app_name)
+      stack = Momentum::OpsWorks.get_stack(client, stack_name)
+      JSON.parse(stack[:custom_json])["custom_env"][app_name].tap do |config|
+        # Custom config from OpsWorks doesn't include RAILS_ENV, so add it.
+        config['RAILS_ENV'] = Momentum::OpsWorks.get_app(client, stack, app_name)[:attributes]['RailsEnv']
+      end
+    end
+
+  end
+
+
+  class Deployer
+    TIMEOUT = 15 * 60  # wait up to 15 minutes
+
+    def initialize(aws_id, aws_secret)
+      @ow = Momentum::OpsWorks.client(aws_id, aws_secret)
+    end
+
+    def deploy!(stack_name, app_name = Momentum.config[:app_base_name])
+      stack = Momentum::OpsWorks.get_stack(@ow, stack_name)
+      app = Momentum::OpsWorks.get_app(@ow, stack, app_name)
+      layers = Momentum::OpsWorks.get_layers(@ow, stack, Momentum.config[:app_layers])
+      instance_ids = layers.inject([]) { |ids, l| ids + Momentum::OpsWorks.get_online_instance_ids(@ow, layer_id: l[:layer_id]) }
+      raise 'No online instances found!' if instance_ids.empty?
+      @ow.create_deployment(
+        stack_id: stack[:stack_id],
+        app_id: app[:app_id],
+        command: { name: 'deploy' },
+        instance_ids: instance_ids
+      )
+    end
+
+    def wait_for_success!(deployment, timeout = TIMEOUT)
+      Timeout.timeout(timeout) do
+        status = @ow.describe_deployments(deployment_ids: [deployment[:deployment_id]])[:deployments].first[:status]
+        $stderr.puts 'Polling deploy status...'
+        while status == 'running'
+          sleep 10
+          status = @ow.describe_deployments(deployment_ids: [deployment[:deployment_id]])[:deployments].first[:status]
+          $stderr.print '.'
+        end
+        raise "Deploy failed (status: #{status})!" unless status == 'successful'
+      end
+      $stderr.puts 'Success!'
+    rescue Timeout::Error
+      raise "Timed out waiting for deploy to succeed after #{timeout} seconds."
+    end
+  end
+
+end

data/lib/momentum/railtie.rb

@@ -0,0 +1,14 @@
+class Momentum::Railtie < ::Rails::Railtie
+
+  railtie_name :momentum
+
+  rake_tasks do
+    load 'tasks/init.rake'
+    load 'tasks/librarian.rake'
+    load 'tasks/ow-config.rake'
+    load 'tasks/ow-console.rake'
+    load 'tasks/ow-cookbooks.rake'
+    load 'tasks/ow-deploy.rake'
+  end
+
+end

data/lib/momentum/tasks.rb

@@ -0,0 +1,19 @@
+# Helpers for rake tasks
+
+def require_credentials!(args)
+  args.with_defaults aws_id: ENV['AWS_ID'], aws_secret: ENV['AWS_SECRET'], to: ENV['RAILS_ENV']
+  raise "Must specify target environment (e.g., staging)!" unless args[:to]
+  raise "Must set aws_id and aws_secret!" unless args[:aws_id] && args[:aws_secret]
+end
+
+def cookbooks_s3_key(to)
+  "#{stack_name(to)}.zip"
+end
+
+def stack_name(to)
+  "#{Momentum.config[:app_base_name]}-#{to}"
+end
+
+def cookbooks_zip
+  "#{Momentum.config[:cookbooks_install_path]}.zip"
+end

data/lib/momentum/version.rb

@@ -0,0 +1,3 @@
+module Momentum
+  VERSION = "0.0.3"
+end

data/lib/momentum.rb

@@ -0,0 +1,21 @@
+require "momentum/version"
+require 'momentum/railtie' if defined?(::Rails)
+
+module Momentum
+
+  DEFAULT_CONFIG = {
+    cookbooks_install_path: 'tmp/cookbooks',
+    custom_cookbooks_bucket: 'artsy-cookbooks',
+    rails_console_layer: 'rails-app',
+    app_layers: ['rails-app']
+  }
+
+  def self.config
+    @@config ||= DEFAULT_CONFIG.dup
+  end
+
+  def self.configure(&block)
+    yield self.config
+  end
+
+end

data/lib/tasks/init.rake

@@ -0,0 +1,6 @@
+namespace :momentum do
+
+  desc "Initialize a project with librarian-chef, etc."
+  task :init => ['librarian:config', 'librarian:init']
+
+end

data/lib/tasks/librarian.rake

@@ -0,0 +1,28 @@
+namespace :librarian do
+
+  LIBRARIAN_CONFIG = <<-EOF
+---
+LIBRARIAN_CHEF_PATH: #{Momentum.config[:cookbooks_install_path]}
+LIBRARIAN_CHEF_INSTALL__STRIP_DOT_GIT: '1'
+  EOF
+
+  task :config do
+    FileUtils.mkdir_p './.librarian/chef'
+    File.open('./.librarian/chef/config', 'w+') do |f|
+      f.write(LIBRARIAN_CONFIG)
+    end
+    $stderr.puts "Wrote .librarian/chef/config"
+  end
+
+  task :init => :require do
+    # librarian-chef and rails declare incompatible json dependencies,
+    # so librarian-chef must be installed but can't be in the bundle
+    Bundler.with_clean_env do
+      system "librarian-chef init"
+    end
+  end
+
+  task :require do
+    raise "librarian-chef must be installed!" if `which librarian-chef`.empty?
+  end
+end

data/lib/tasks/ow-config.rake

@@ -0,0 +1,26 @@
+namespace :ow do
+
+  require 'momentum/tasks'
+
+  desc "Print current configuration values for given stack."
+  task :config, [:to, :aws_id, :aws_secret] do |t, args|
+    require_credentials!(args)
+    ow = Momentum::OpsWorks.client(args[:aws_id], args[:aws_secret])
+    Momentum::OpsWorks::Config.from_stack(ow, stack_name(args[:to])).each do |k, v|
+      puts "#{k}: #{v}"
+    end
+  end
+
+  namespace :config do
+    desc "Set configuration values from OpsWorks on the current environment. Can be chained to other tasks that need the ENV."
+    task :from_env, [:to, :aws_id, :aws_secret] do |t, args|
+      require_credentials!(args)
+      ow = Momentum::OpsWorks.client(args[:aws_id], args[:aws_secret])
+      Momentum::OpsWorks::Config.from_stack(ow, stack_name(args[:to])).each do |k, v|
+        ENV[k] = v.to_s
+      end
+      @ow_config_from_env = true  # allow chained tasks to raise an error unless this is set
+    end
+  end
+
+end

data/lib/tasks/ow-console.rake

@@ -0,0 +1,26 @@
+namespace :ow do
+
+  require 'momentum/opsworks'
+  require 'momentum/tasks'
+
+  desc "Open a Rails console on the given remote OpsWorks stack (uses AWS_USER as SSH username or falls back to local username)."
+  task :console, [:to, :env, :aws_id, :aws_secret] do |t, args|
+    require_credentials!(args)
+    ow = Momentum::OpsWorks.client(args[:aws_id], args[:aws_secret])
+    name = stack_name(args[:to])
+    stack = Momentum::OpsWorks.get_stack(ow, name)
+    layer = ow.describe_layers(stack_id: stack[:stack_id])[:layers].detect { |l| l[:shortname] == Momentum.config[:rails_console_layer] }
+    instance = Momentum::OpsWorks.get_online_instances(ow, layer_id: layer[:layer_id]).sample
+    raise "No online #{Momentum.config[:rails_console_layer]} instances found for #{name} stack!" unless instance
+
+    $stderr.puts "Starting remote console... (use Ctrl-D to exit cleanly)"
+    sh [
+      'ssh -t',
+      (['-i', ENV['AWS_PUBLICKEY']] if ENV['AWS_PUBLICKEY']),
+      (['-l', ENV['AWS_USER']] if ENV['AWS_USER']),
+      instance[:public_dns],
+      "'sudo su deploy --session-command=\"cd /srv/www/#{Momentum.config[:app_base_name]}/current && RAILS_ENV=#{args[:env] || args[:to]} bundle exec rails console\"'"
+    ].compact.flatten.join(' ')
+  end
+
+end

data/lib/tasks/ow-cookbooks.rake

@@ -0,0 +1,66 @@
+namespace :ow do
+  namespace :cookbooks do
+
+    require 'momentum/opsworks'
+    require 'momentum/tasks'
+
+    # TODO add dependency on librarian-chef once chef/json conflict resolved
+    # desc "Run librarian-chef install"
+    # task :install do
+    #   `librarian-chef install`
+    # end
+
+    desc "Zip the #{Momentum.config[:cookbooks_install_path]} directory into #{Momentum.config[:cookbooks_install_path]}.zip"
+    task :zip do
+      raise "No cookbooks found at #{Momentum.config[:cookbooks_install_path]}! Run librarian-chef install." unless File.exists?(Momentum.config[:cookbooks_install_path])
+      dir = File.dirname(Momentum.config[:cookbooks_install_path])
+      base = File.basename(Momentum.config[:cookbooks_install_path])
+      system "rm -f #{cookbooks_zip} && pushd #{dir} && zip -r #{base} #{base} && popd"
+      $stderr.puts "Zipped cookbooks to #{cookbooks_zip}"
+    end
+
+    desc "Upload custom cookbooks from #{cookbooks_zip} to S3 (at bucket/appname-env.zip)."
+    task :upload, [:to, :aws_id, :aws_secret] => [:require_app_base_name] do |t, args|
+      require_credentials!(args)
+      require 'aws-sdk'
+      AWS.config(access_key_id: args[:aws_id], secret_access_key: args[:aws_secret])
+
+      key = cookbooks_s3_key(args[:to])
+      File.open(cookbooks_zip) do |zip|
+        AWS::S3.new.client.put_object bucket_name: Momentum.config[:custom_cookbooks_bucket], key: key, data: zip
+      end
+      $stderr.puts "Uploaded cookbooks.zip to #{Momentum.config[:custom_cookbooks_bucket]}/#{key}."
+    end
+
+    desc "Install, zip and upload custom cookbooks, then trigger update_custom_cookbooks command."
+    task :update, [:to, :aws_id, :aws_secret] => [:require_app_base_name, :zip, :upload] do |t, args|
+      require_credentials!(args)
+
+      ow = Momentum::OpsWorks.client(args[:aws_id], args[:aws_secret])
+      stack = Momentum::OpsWorks.get_stack(ow, stack_name(args[:to]))
+      instance_ids = Momentum::OpsWorks.get_online_instance_ids(ow, stack_id: stack[:stack_id])
+      if instance_ids.any?
+        ow.create_deployment(
+          stack_id: stack[:stack_id],
+          command: {name: 'update_custom_cookbooks'},
+          instance_ids: instance_ids
+        )
+        $stderr.puts "Triggered 'update_custom_cookbooks' command for #{stack[:name]}... (it might take a few moments)."
+      else
+        $stderr.puts "No online instances found."
+      end
+    end
+
+    namespace :update do
+      %w{staging production}.each do |env|
+        desc "Zip, upload, and propagate custom OpsWorks cookbooks to the #{env} stack."
+        task(env.to_sym) { Rake::Task['ow:cookbooks:update'].invoke(env) }
+      end
+    end
+
+    task :require_app_base_name do
+      raise "An app_base_name must be configured!" unless Momentum.config[:app_base_name]
+    end
+
+  end
+end

data/lib/tasks/ow-deploy.rake

@@ -0,0 +1,21 @@
+namespace :ow do
+
+  require 'momentum/tasks'
+
+  namespace :deploy do
+    %w{staging production}.each do |env|
+      desc "Deploy the #{Momentum.config[:app_base_name]} to the #{stack_name(env)} OpsWorks stack."
+      task(env.to_sym) { Rake::Task['ow:deploy'].invoke(env) }
+    end
+  end
+
+  desc "Deploy to the given OpsWorks stack."
+  task :deploy, [:to, :aws_id, :aws_secret] do |t, args|
+    require_credentials!(args)
+    deployer = Momentum::OpsWorks::Deployer.new(args[:aws_id], args[:aws_secret])
+    name = stack_name(args[:to])
+    deployment = deployer.deploy!(name)
+    $stderr.puts "Triggered deployment #{deployment[:deployment_id]} to #{name}..."
+    deployer.wait_for_success!(deployment)
+  end
+end

data/momentum.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'momentum/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "momentum"
+  spec.version       = Momentum::VERSION
+  spec.authors       = ["Joey Aghion"]
+  spec.email         = ["joey@aghion.com"]
+  spec.description   = %q{Utilities for working with OpsWorks apps in the style of Artsy Engineering.}
+  spec.summary       = %q{Utilities for working with OpsWorks apps in the style of Artsy Engineering.}
+  spec.homepage      = "https://github.com/artsy/momentum"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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"]
+
+  spec.add_dependency "aws-sdk", "~> 1.30"
+  # spec.add_dependency "librarian-chef"  # rails/chef require incompatible json versions
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: momentum
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Joey Aghion
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.30'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.30'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: Utilities for working with OpsWorks apps in the style of Artsy Engineering.
+email:
+- joey@aghion.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/momentum.rb
+- lib/momentum/opsworks.rb
+- lib/momentum/railtie.rb
+- lib/momentum/tasks.rb
+- lib/momentum/version.rb
+- lib/tasks/init.rake
+- lib/tasks/librarian.rake
+- lib/tasks/ow-config.rake
+- lib/tasks/ow-console.rake
+- lib/tasks/ow-cookbooks.rake
+- lib/tasks/ow-deploy.rake
+- momentum.gemspec
+homepage: https://github.com/artsy/momentum
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Utilities for working with OpsWorks apps in the style of Artsy Engineering.
+test_files: []