shred 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87f02895b1c18d05766bf9e02790f0e98314fda3
-  data.tar.gz: 0d966bf202d43cbcc82d2e3bb6a4c8333b1bd329
+  metadata.gz: dc7d3395add485fc83816532c717b9e507d2a4ca
+  data.tar.gz: 2e51812cfbc8b84d64c69444cb88806600e6ee9f
 SHA512:
-  metadata.gz: f03a12b0426f62dc6131920cb9af95d0b4aa5ee605c54c75447bb22e4f129ff39640537d642c728dd9dcf430eb0d6ff424ae0f1d195b88fce5ca95230d158108
-  data.tar.gz: 14fd3fd258cc4001ec313518d3ef0a316206f270e7aca49103d63c770079e34a5774e55d6b1b80c1cd329d2288154f09f36a571f475e63f2a44fd0948652d6f8
+  metadata.gz: 7b78a34732cba64175900fcc65bad96316222c35478dd3fefb30ab6cf7a52eed68acd56a4823a07ae11b268f6b15c6fa353bf54553f47ed5fcfaa823815d0471
+  data.tar.gz: d829b8587f15cac0c577387bd15a3a2790e304bb805b7a8909d6010a6e9dc921474d96f6f5e585837bb51671b3e45e472a81464e64e444bbfffee9a3912a60ef

data/README.md

@@ -20,7 +20,7 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+TODO: Write usage instructions here. For now, see the wiki.
 
 ## Contributing
 

data/lib/shred/commands/base.rb

@@ -64,7 +64,11 @@ module Shred
         @success_msg = success_msg
         @error_msg = error_msg
         @output = output
-        @out = File.open(output, 'w') if output
+        @out = if output && output.respond_to?(:write)
+          output
+        elsif output
+          File.open(output, 'w')
+        end
       end
 
       def run(&block)
@@ -107,6 +111,7 @@ module Shred
             console.say_err(exit_status)
           end
         end
+        exit_status
       end
     end
 
@@ -150,10 +155,12 @@ module Shred
           sub_keys = key.to_s.split('.')
           value = nil
           sub_keys.each_with_index do |sub_key, i|
-            if base_cfg.key?(sub_key)
+            if base_cfg && base_cfg.key?(sub_key)
               value = base_cfg = base_cfg[sub_key]
             elsif i < sub_keys.length - 1
-              raise "Missing '#{key}' config for '#{command}'"
+              raise "Missing '#{key}' config for '#{command_name}' command"
+            else
+              value = nil
             end
           end
           raise "Missing '#{key}' config for '#{command_name}' command" if required && !value

data/lib/shred/commands/deploy.rb

@@ -0,0 +1,274 @@
+require 'shred/commands/base'
+require 'dotenv'
+require 'platform-api'
+
+module Shred
+  module Commands
+    class Deploy < Base
+      class_option :environment
+      class_option :branch
+
+      desc 'all', 'Fully deploy the application by performing all deploy steps'
+      long_desc <<-LONGDESC
+        Fully deploy the application by performing all deploy steps in this order:
+
+          1. update_code_from_heroku
+          2. detect_pending_migrations
+          3. if migrations were detected,
+             a. maintenance_on
+             b. scale_down
+          4. push_code_to_heroku
+          5. if migrations were detected,
+             a. snapshot_db
+             b. migrate_db
+             c. scale_up
+             d. restart_app
+             e. maintenance_off
+          6. send_notifications
+      LONGDESC
+      def all
+        invoke(:update_code_from_heroku)
+        invoke(:detect_pending_migrations)
+        if migration_count > 0
+          maintenance_on
+          scale_down
+        end
+        push_code_to_heroku
+        if migration_count > 0
+          snapshot_db
+          migrate_db
+          scale_up
+          restart_app
+          maintenance_off
+        end
+        send_notifications
+      end
+
+      desc 'update_code_from_heroku', 'Update local copy of Heroku git remote'
+      def update_code_from_heroku
+        exit_status = run_shell_command(ShellCommand.new(
+          command_lines: "git remote | grep #{heroku_remote_name} > /dev/null"
+        ))
+        unless exit_status.success?
+          run_shell_command(ShellCommand.new(
+            command_lines: "git remote add #{heroku_remote_name} #{heroku_info['git_url']}"
+          ))
+        end
+        run_shell_command(ShellCommand.new(
+          command_lines: "git fetch #{heroku_remote_name}"
+        ))
+        console.say_ok("Updated code from #{heroku_app_name} Heroku app")
+      end
+
+      desc 'detect_pending_migrations', 'Detect whether or not the local branch has pending migrations to apply'
+      def detect_pending_migrations
+        if migration_count > 1
+          console.say_ok("#{migration_count} pending database migrations detected")
+        elsif migration_count == 1
+          console.say_ok("#{migration_count} pending database migration detected")
+        else
+          console.say_ok("No pending database migrations detected")
+        end
+      end
+
+      desc 'maintenance_on', 'Enable maintenance mode for the Heroku app'
+      def maintenance_on
+        heroku.app.update(heroku_app_name, maintenance: true)
+        console.say_ok("Maintenance mode enabled")
+      end
+
+      desc 'scale_down', 'Scale down all non-web processes'
+      def scale_down
+        updates = process_counts.each_with_object([]) do |(process_type, count), m|
+          m << {'process' => process_type.to_s, 'quantity' => 0} if count > 0
+        end
+        heroku.formation.batch_update(heroku_app_name, 'updates' => updates)
+        updated = process_counts.map do |(process_type, count)|
+          if count > 1
+            "#{count} #{process_type} processes"
+          elsif count == 1
+            "#{count} #{process_type} process"
+          else
+            nil
+          end
+        end.compact
+        if updated.any?
+          console.say_ok("Scaled down #{updated.join(', ')}")
+        else
+          console.say_ok("No non-web processes to scale down")
+        end
+      end
+
+      desc 'push_code_to_heroku', 'Push local git branch to Heroku remote'
+      def push_code_to_heroku
+        run_shell_command(ShellCommand.new(
+          command_lines: "git push -f #{heroku_remote_name} #{branch}:master"
+        ))
+        console.say_ok("Pushed code to Heroku")
+      end
+
+      desc 'snapshot_db', 'Capture a snapshot of the Heroku database'
+      def snapshot_db
+        run_shell_command(ShellCommand.new(
+          command_lines: "heroku pgbackups:capture --expire --app #{heroku_app_name}"
+        ))
+        console.say_ok("Database snapshot captured")
+      end
+
+      desc 'migrate_db', 'Apply pending migrations to the database'
+      def migrate_db
+        if migration_count > 0
+          dyno = heroku.dyno.create(heroku_app_name, command: 'rake db:migrate db:seed')
+          poll_one_off_dyno_until_done(dyno)
+          console.say_ok("Pending database migrations applied")
+        else
+          console.say_ok("No pending database migrations to apply")
+        end
+      end
+
+      desc 'scale_up [--worker=NUM] [--clock=NUM]', 'Scale up all non-web processes'
+      option :worker, type: :numeric
+      option :clock, type: :numeric
+      def scale_up
+        updates = if options[:worker] || options[:clock]
+          [:worker, :clock].each_with_object([]) do |process_type, m|
+            m << {'process' => process_type.to_s, 'quantity' => options[process_type]}
+          end
+        else
+          [:worker, :clock].each_with_object([]) do |process_type, m|
+            count = process_counts[process_type] || 0
+            m << {'process' => process_type.to_s, 'quantity' => count} if count > 0
+          end
+        end
+        heroku.formation.batch_update(heroku_app_name, 'updates' => updates)
+        updated = process_counts.map do |(process_type, count)|
+          if count > 1
+            "#{count} #{process_type} processes"
+          elsif count == 1
+            "#{count} #{process_type} process"
+          else
+            nil
+          end
+        end.compact
+        if updated.any?
+          console.say_ok("Scaled up #{updated.join(', ')}")
+        else
+          console.say_ok("No non-web processes to scale up")
+        end
+      end
+
+      desc 'restart_app', 'Restart the Heroku app'
+      def restart_app
+        dynos = heroku.dyno.list(heroku_app_name).find_all { |d| d['type'] == 'web' }
+        dynos.each do |dyno|
+          heroku.dyno.restart(heroku_app_name, dyno['id'])
+        end
+        if dynos.count > 1
+          console.say_ok("Restarted #{dynos.count} web dynos")
+        elsif dynos.count == 1
+          console.say_ok("Restarted #{dynos.count} web dyno")
+        else
+          console.say_ok("No web dynos to restart")
+        end
+      end
+
+      desc 'maintenance_off', 'Disable maintenance mode for the Heroku app'
+      def maintenance_off
+        heroku.app.update(heroku_app_name, maintenance:false)
+        console.say_ok("Maintenance mode disabled")
+      end
+
+      desc 'send_notifications', 'Send deploy notifications to external services'
+      def send_notifications
+        Array(cfg('notifications', required: false)).each do |(service, command)|
+          command.
+            gsub!(%r[{environment}], environment).
+            gsub!(%r[{revision}], revision)
+          dyno = heroku.dyno.create(heroku_app_name, command: command)
+          poll_one_off_dyno_until_done(dyno)
+          console.say_ok("Notification sent to #{service}")
+        end
+      end
+
+      no_commands do
+        def environment
+          @environment ||= begin
+            env = options[:environment] || cfg('default_environment', required: false)
+            return env if env
+            console.say_err("Deployment environment must be specified, either with --environment or with 'default_environment' config for '#{command_name}' command")
+            exit(1)
+          end
+        end
+
+        def branch
+          @branch ||= begin
+            br = options[:branch] || cfg("#{environment}.branch", required: false)
+            return br if br
+            console.say_err("Local branch name must be specified, either with --branch or with '#{environment}.branch' config for '#{command_name}' command")
+          end
+        end
+
+        def revision
+          `git rev-parse #{branch}`
+        end
+
+        def heroku
+          @heroku ||= begin
+            ::Dotenv.load
+            begin
+              PlatformAPI.connect_oauth(ENV['HEROKU_DEPLOY_TOKEN'])
+            rescue Excon::Errors::Unauthorized
+              console.say_err("Access to Heroku is not authorized. Did you set the HEROKU_DEPLOY_TOKEN environment variable?")
+              exit(1)
+            end
+          end
+        end
+
+        def heroku_info
+          @heroku_info ||= heroku.app.info(heroku_app_name)
+        end
+
+        def migration_count
+          @migration_count ||= `git diff #{branch} #{heroku_remote_name}/master --name-only -- db | wc -l`.strip!.to_i
+        end
+
+        def process_counts
+          @process_counts ||= begin
+            formations = heroku.formation.list(heroku_app_name).each_with_object({}) { |f, m| m[f['type'].to_sym] = f }
+            [:worker, :clock].each_with_object({}) do |process_type, m|
+              quantity = formations.fetch(process_type, {}).fetch('quantity', 0)
+              m[process_type] = quantity if quantity > 0
+            end
+          end
+        end
+
+        def heroku_app_name
+          @heroku_app_name ||= cfg("#{environment}.heroku.app_name")
+        end
+
+        def heroku_remote_name
+          @heroku_remote_name ||= cfg("#{environment}.heroku.remote_name", required: false) || heroku_app_name
+        end
+
+        def poll_one_off_dyno_until_done(dyno)
+          done = false
+          state = 'starting'
+          console.say_trace("Starting process with command `#{dyno['command']}`")
+          while !done do
+            begin
+              dyno = heroku.dyno.info(heroku_app_name, dyno['id'])
+              if dyno['state'] != state
+                console.say_trace("State changed from #{state} to #{dyno['state']}")
+                state = dyno['state']
+              end
+              sleep 2
+            rescue Excon::Errors::NotFound
+              done = true
+              console.say_trace("State changed from #{state} to complete")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shred/version.rb

@@ -1,3 +1,3 @@
 module Shred
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/lib/shred.rb

@@ -1,5 +1,6 @@
 require 'shred/commands/app'
 require 'shred/commands/db'
+require 'shred/commands/deploy'
 require 'shred/commands/dotenv'
 require 'shred/commands/js_deps'
 require 'shred/commands/platform_deps'
@@ -57,6 +58,10 @@ module Shred
           desc 'app SUBCOMMAND ...ARGS', 'Control the application'
           subcommand 'app', Commands::App
         end
+        if commands.key?('deploy')
+          desc 'deploy SUBCOMMAND ...ARGS', 'Deploy the application'
+          subcommand 'deploy', Commands::Deploy
+        end
         if commands.key?('setup')
           desc 'setup', 'First-time application setup'
           def setup

data/shred.gemspec

@@ -21,5 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
 
+  spec.add_dependency 'dotenv'
+  spec.add_dependency 'platform-api'
   spec.add_dependency 'thor'
 end

data/shred.yml

@@ -3,6 +3,19 @@ commands:
     start:
       - foreman start
   db:
+  deploy:
+    default_environment: staging
+    staging:
+      branch: master
+      heroku:
+        app_name: my-app-staging
+    production:
+      branch: production
+      heroku:
+        app_name: my-app-production
+    notifications:
+      airbrake: bin/rake airbrake:deploy RAILS_ENV={environment} TO={environment}
+      new_relic: bin/newrelic deployments -e {environment} -r {revision}
   dotenv:
     heroku:
       app_name: my-app

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shred
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Brian
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-14 00:00:00.000000000 Z
+date: 2014-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,6 +39,34 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: platform-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -72,6 +100,7 @@ files:
 - lib/shred/commands/app.rb
 - lib/shred/commands/base.rb
 - lib/shred/commands/db.rb
+- lib/shred/commands/deploy.rb
 - lib/shred/commands/dotenv.rb
 - lib/shred/commands/js_deps.rb
 - lib/shred/commands/platform_deps.rb