bb_deploy 0.0.0.4 → 0.0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e3ab6a10e9c48f895924a60da529cf39c50d515
-  data.tar.gz: 0d308635d39f89225e1d519c2cda81cfd23c94d8
+  metadata.gz: 4265cc5173996544b0df461c34d76fa8dc525d39
+  data.tar.gz: be98bb1650d4a2c678a9e09d72ea22ae7a41a2eb
 SHA512:
-  metadata.gz: ebe7d62cefd67cd9842b8fdedf4fb3b6d2841efece4256156726abf6b509cf84ac4b4e3c18d0be605a201559674235bfea289178d4e8c2379050feae7e8a740b
-  data.tar.gz: 0e95d557849838c29f84020d4f9ebd5fc4bd1f5af56ca749c1673621249e4f9dc89a571b16db5b2f9365439b7a52ccc039781f0cf66c108149cf15d72df0727f
+  metadata.gz: f4cd670da569b6c8954023da9fd7d374a4cc56cd903ed82167422a8bc6d3021c9b26da8302a0dcb00b11094405dc25a39c5863bfbb3f1b017edf745a3acd9141
+  data.tar.gz: e25c4afd11033f7f7c6002497a14ffd76c6260b0e1021f98e49cb5b27fbe57975108a0ebbed5d5b30e365206461ec99688116bcb0ae3a16147435cda9c515b8e

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2016 BRIGHTBYTES, INC.
+
+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,14 @@
+# BB Deploy
+----------
+This is a gem for deploying Rails services to Heroku via Rake task. In order to use it, the app you are trying to deploy should be set up as follows:
+
+- Add the `bb_deploy` gem to your Gemfile
+
+- Copy the following code to a file `config/deploy.rb` in your Rails app, and set the fields as appropriate: http://bit.ly/2cdRzAo
+
+- Add the following line to your application's Rakefile:
+    `require File.expand_path('../config/deploy', __FILE__)`
+
+- Make sure that your machine has all the necessary Git/Heroku keys, and that your endpoints are set up correctly.
+
+- That's it! You will now be able to deploy your app by typing `bundle exec rake heroku:deploy:<qa|staging|production>` in the root dir of your app.

data/lib/bb_deploy/config.rb

@@ -1,6 +1,3 @@
-require 'yaml'
-require_relative './heroku'
-
 module BbDeploy
   class Config
     attr_accessor :application_name,
@@ -17,23 +14,6 @@ module BbDeploy
 
       def configure
         yield(configuration)
-        configuration
-      end
-
-      def configure_from_yaml(file_path)
-        options = YAML.load(ERB.new(File.read(file_path)).result)
-        configure do |config|
-          %w(application_name application_urls deployment_channel engineering_channel).each do |key|
-            config.send("#{key}=", options[key])
-          end
-        end
-      end
-
-      def set_heroku_fields!(phase)
-        configure do |config|
-          config.logentries_token  = BbDeploy::Heroku.get_variable(phase, 'DEPLOY_LOG_TOKEN').freeze
-          config.slack_webhook_key = BbDeploy::Heroku.get_variable(phase, 'SLACK_WEBHOOK').freeze
-        end
       end
 
       def method_missing(method, *args)

data/lib/bb_deploy/deployer.rb

@@ -1,4 +1,3 @@
-require 'pp'
 require_relative './config'
 require_relative './task'
 require_relative './logger'
@@ -11,17 +10,11 @@ class BbDeploy::Deployer
 
   attr_reader :phase
 
-  def initialize(phase)
-    BbDeploy::Config.configure_from_yaml('config/deploy.yml')
-    BbDeploy::Config.set_heroku_fields!(phase)
+  def initialize(phase:)
+    BbDeploy::Config.set_dynamic_fields!(phase: phase)
     @phase = phase
   end
 
-  # Environment inquiry methods
-  %w(qa staging production).each do |phase|
-    define_method("#{phase}?") { @phase == phase }
-  end
-
   def deploy!
     BbDeploy::Git.check_git_status!
     check_access!
@@ -36,18 +29,6 @@ class BbDeploy::Deployer
 
   private
 
-  def notify_eng_hub?
-    BbDeploy::Config.application_name == "Clarity"
-  end
-
-  def dputs(*msgs)
-    asterisks = "*" * 80
-    puts asterisks
-    puts(*msgs.map(&:to_s))
-    puts asterisks
-  end
-
-
   def current_branch
     BbDeploy::Git.current_branch(started_on_master?)
   end
@@ -55,7 +36,7 @@ class BbDeploy::Deployer
   def do_deploy
     branch = current_branch
 
-    chat_broadcast(":alert:    '#{ENV['USER']}' is deploying the #{BbDeploy::Config.application_name} branch '#{branch}' to '#{phase}'    :alert:", phase: phase, notify_eng_hub: notify_eng_hub?)
+    chat_broadcast("'#{ENV['USER']}' is deploying the #{BbDeploy::Config.application_name} branch '#{branch}' to '#{phase}' ...", phase: phase, notify_eng_hub: true)
 
     do_heroku_deploy!
 
@@ -67,7 +48,7 @@ class BbDeploy::Deployer
       puts "You must now resolve any conflicts in the merge and then `git push origin master` ..."
      end
 
-    chat_broadcast(":alertgreen: Deployment of the #{BbDeploy::Config.application_name} branch '#{branch}' to '#{phase}' completed! :alertgreen:", phase: phase, notify_eng_hub: notify_eng_hub?)
+    chat_broadcast("(successful) Deployment of the #{BbDeploy::Config.application_name} branch '#{branch}' to '#{phase}' completed!", phase: phase, notify_eng_hub: true)
   end
 
   def logger
@@ -75,7 +56,7 @@ class BbDeploy::Deployer
   end
 
   def check_access!
-    unless BbDeploy::Heroku.has_access?(phase)
+    if BbDeploy::Heroku.has_access?(phase)
       exit_with_message("You do not have access to the #{BbDeploy::Config.application_name} #{phase} application!")
     end
   end
@@ -87,6 +68,7 @@ class BbDeploy::Deployer
 
   def do_heroku_deploy! # rubocop:disable all
     run_migrations = run_migrations?
+    stay_in_maint_mode = false
 
     exit(0) if run_migrations && !BbDeploy::Task.ask("There are new migrations to run.  If you proceed,\n\n*** YOU WILL INCUR SITE DOWNTIME!!! ***\n\nDo you wish to proceed?")
 
@@ -98,7 +80,15 @@ class BbDeploy::Deployer
 
     push_release!
 
-    run_migrations! if run_migrations
+    if run_migrations
+      started_at = Time.current
+      run_migrations!
+      time_spent = Time.zone.at(Time.current - started_at).getutc.strftime("%H:%M:%S")
+      # The only time started_on_master is non-nil is when creating a new staging branch
+      if started_on_master?
+        chat_broadcast("Yo, @jake - the #{BbDeploy::Config.application_name} branch '#{current_branch}' contains migrations that take #{time_spent} to run", phase: phase, notify_eng_hub: true)
+      end
+    end
 
     if enter_maint_mode
       if stay_in_maint_mode
@@ -109,35 +99,26 @@ class BbDeploy::Deployer
     end
   end
 
-  def run_migrations!
-    started_at = Time.current
-
-    chat_broadcast("Running migrations from #{BbDeploy::Config.application_name} branch '#{current_branch}' in #{phase} ...", phase: phase)
-    logger.with_consolidated_logging { BbDeploy::Heroku.migrate_db!(phase) }
-    chat_broadcast("Successfully ran migrations from #{BbDeploy::Config.application_name} branch '#{current_branch}' in #{phase}.", phase: phase)
-
-    time_spent = Time.zone.at(Time.current - started_at).getutc.strftime("%H:%M:%S")
-    # The only time started_on_master is non-nil is when creating a new staging branch
-    if started_on_master?
-      chat_broadcast("Yo, @jake - the #{BbDeploy::Config.application_name} branch '#{current_branch}' contains migrations that take #{time_spent} to run", phase: phase, notify_eng_hub: notify_eng_hub?)
-    end
-  end
-
   def push_release!
     puts "Deploying ..."
     chat_broadcast("Pushing #{BbDeploy::Config.application_name} branch '#{current_branch}' to #{phase} ...", phase: phase)
     logger.with_consolidated_logging { puts(BbDeploy::Git.push_to_phase(phase)) }
   end
 
+  def run_migrations!
+    chat_broadcast("Running migrations from #{BbDeploy::Config.application_name} branch '#{current_branch}' in #{phase} ...", phase: phase)
+    logger.with_consolidated_logging { BbDeploy::Heroku.migrate_db! }
+    chat_broadcast("Successfully ran migrations from #{BbDeploy::Config.application_name} branch '#{current_branch}' in #{phase}.", phase: phase)
+  end
+
   def open_in_browser
     sleep 2 # because removing maint mode takes a couple seconds to propagate
     host_and_path =
       case phase
-      when 'qa'; BbDeploy::Config.application_urls['qa']
-      when 'staging'; BbDeploy::Config.application_urls['staging']
-      when 'production'; BbDeploy::Config.application_urls['production']
+      when 'qa'; BbDeploy::Config.application_urls[:qa]
+      when 'staging'; BbDeploy::Config.application_urls[:staging]
+      when 'production'; BbDeploy::Config.application_urls[:production]
       end
-
     puts "Opening the site for inspection ..."
     BbDeploy::Task.run("open https://#{host_and_path}")
   end
@@ -157,21 +138,21 @@ class BbDeploy::Deployer
 
   def staging_checks
     if BbDeploy::Git.on_master?
-      do_it = BbDeploy::Task.ask("You are on master. Do you want to create a ***NEW*** release branch from the HEAD of master and deploy it to #{BbDeploy::Config.application_name} #{phase}?")
+      do_it = BbDeploy::Task.ask("You are on master. Do you want to create a ***NEW*** release branch from the HEAD of master and deploy it to #{BbDeploy::Config.application_name} #{phase}?\n\n(If, instead, you want to ***REDEPLOY*** a release branch you ***PREVIOUSLY*** created, checkout that branch and rerun this script.)")
 
       if do_it
         date = Time.zone.today.to_s(:db).tr('-', '_')
-        new_release_branch = "release_#{date}"
+        new_branch = "release_#{date}"
 
-        if BbDeploy::Git.local_release(new_release_branch).present?
-          exit_with_message("There already exists a local release branch named #{new_release_branch}!")
+        if BbDeploy::Git.local_release(new_branch).present?
+          exit_with_message("There already exists a local release branch named #{new_branch}!")
         end
 
-        if BbDeploy::Git.remote_release(new_release_branch).present?
-          exit_with_message("There already exists a remote release branch named #{new_release_branch}!")
+        if BbDeploy::Git.remote_release(new_branch).present?
+          exit_with_message("There already exists a remote release branch named #{new_branch}!")
         end
 
-        BbDeploy::Git.push_release_branch!(new_release_branch)
+        # puts `git checkout -lb #{new_branch} && git push origin #{new_branch} -u`
 
         started_on_master!
       end

data/lib/bb_deploy/git.rb

@@ -23,10 +23,6 @@ module BbDeploy::Git
       current_branch == 'master'
     end
 
-    def push_release_branch!
-      puts `git checkout -lb #{new_branch} && git push origin #{new_branch} -u`
-    end
-
     def on_a_release_branch?
       current_branch.start_with?('release_')
     end

data/lib/bb_deploy/heroku.rb

@@ -1,25 +1,18 @@
-require_relative './task'
-
 module BbDeploy::Heroku
   class << self
-    def get_variable(phase, var_name)
-      @heroku_env_vars ||= {}
-      return @heroku_env_vars[var_name] if @heroku_env_vars[var_name]
-      token = heroku_run("heroku config:get #{var_name} --remote #{phase}")
-      if token.present?
-        token = token.chomp
-        @heroku_env_vars[var_name] = token.split.last
+    def set_dynamic_fields!(phase:)
+      BbDeploy::Config.configure do |config|
+        config.logentries_token  = get_heroku_variable(phase, 'DEPLOY_LOG_TOKEN').freeze
+        config.slack_webhook_key = get_heroku_variable(phase, 'SLACK_WEBHOOK').freeze
       end
-      @heroku_env_vars[var_name]
     end
 
     def last_release_sha(phase)
-      heroku_run("heroku releases -n 25 --remote #{phase} | grep Deploy | head -n 1 | awk '{print $3}'")
+      heroku_run("heroku releases --remote #{phase} | grep Deploy | head -n 1 | awk '{print $3}'")
     end
 
     def has_access?(phase)
-      heroku_info = heroku_run("heroku info --remote #{phase} 2>&1")
-      !(heroku_info =~ /You do not have access/i || heroku_info =~ /Enter your Heroku credentials./)
+      heroku_run("heroku info --remote #{phase} 2>&1") =~ /You do not have access/i
     end
 
     def migrate_db!(phase)
@@ -35,8 +28,8 @@ module BbDeploy::Heroku
 
     def heroku_run(*cmds)
       # Heroku Toolbelt uses Ruby 1.9, which requires clearing the RUBYOPT var ...
-      puts "Running: #{cmds.map(&:inspect).join(", ")}"
-      BbDeploy::Task.run(*cmds.map { |cmd| cmd =~ /heroku/ ? "export RUBYOPT='' && #{cmd}" : cmd })
+      puts "Running\n#{cmds}"
+      run(*cmds.map { |cmd| cmd =~ /heroku/ ? "export RUBYOPT='' && #{cmd}" : cmd })
     end
   end
 end

data/lib/bb_deploy/logger.rb

@@ -1,5 +1,5 @@
+require 'slack-notifier'
 require 'le'
-require 'logger'
 
 # Helper file for Logging/Slack notifications
 module BbDeploy::Logger
@@ -39,7 +39,7 @@ module BbDeploy::Logger
       # Logs originating here will be found in the BB
       # Logentries account in the "Ruby Log" for each phase
       def logger
-        @logger ||= BbDeploy::Config.logentries_token.present? ? Le.new(BbDeploy::Config.logentries_token) : Logger.new($stdout)
+        @logger ||= Le.new(BbDeploy::Config.logentries_token)
       end
     end
   end
@@ -48,11 +48,12 @@ module BbDeploy::Logger
     attachment = [
       {
         fallback: "Deploying to #{phase}",
-        color: " ",
+        color: "good",
         fields: [
           {
             title: "Details",
-            value: msg,
+            # Work the cuteness back in at some point ...
+            value: msg.gsub("(successful)", ":rocket:"), # .gsub("(hisham)", ":hisham:").gsub("(jusx)", ":jusx:")
             short: false
           }
         ]

data/lib/bb_deploy/task.rb

@@ -1,3 +1,5 @@
+require 'highline'
+
 module BbDeploy::Task
   class << self
     def run(*cmds)
@@ -6,6 +8,7 @@ module BbDeploy::Task
       result = cmds.map do |cmd|
         cmd_s = "==> \`#{cmd}\`"
         if dry_run
+          # rubocop:disable Rails/Output
           puts "DRY RUN ONLY"
           puts cmd_s
         else
@@ -21,7 +24,6 @@ module BbDeploy::Task
         msg = "\e[31m#{msg}\e[0m"
         msg.sub!(/'#{required_response}'/, "\e[47m'#{required_response}'\e[49m")
       end
-      puts
       HighLine.new.ask(msg) =~ /\A#{required_response}\Z/i
     end
 
@@ -29,6 +31,7 @@ module BbDeploy::Task
 
     def with_timing(what)
       start = Time.current
+      # rubocop:disable Rails/Output
       puts
       puts "Commencing #{what} ..."
       result = yield

data/lib/tasks/deploy.rake

@@ -1,17 +1,15 @@
-require_relative '../bb_deploy'
-
 namespace :heroku do
   namespace :deploy do
     task qa: :environment do
-      BbDeploy::Deployer.new('qa').deploy!
+      BbDeploy::Deployer.new(phase: 'qa').deploy!
     end
 
     task staging: :environment do
-      BbDeploy::Deployer.new('staging').deploy!
+      BbDeploy::Deployer.new(phase: 'staging').deploy!
     end
 
     task production: :environment do
-      BbDeploy::Deployer.new('production').deploy!
+      BbDeploy::Deployer.new(phase: 'production').deploy!
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bb_deploy
 version: !ruby/object:Gem::Version
-  version: 0.0.0.4
+  version: 0.0.1.1
 platform: ruby
 authors:
 - Peter van Wesep
@@ -9,76 +9,20 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2016-09-01 00:00:00.000000000 Z
-dependencies:
-- !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'
-- !ruby/object:Gem::Dependency
-  name: highline
-  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: le
-  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: slack-notifier
-  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'
+dependencies: []
 description: 
 email: peter@brightbytes.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/bb_deploy.rb
+- LICENSE
+- README.md
 - lib/bb_deploy/config.rb
 - lib/bb_deploy/deployer.rb
 - lib/bb_deploy/git.rb
 - lib/bb_deploy/heroku.rb
 - lib/bb_deploy/logger.rb
-- lib/bb_deploy/railtie.rb
 - lib/bb_deploy/task.rb
 - lib/tasks/deploy.rake
 homepage: 
@@ -101,7 +45,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Shared gem for deploying BrightBytes repositories

data/lib/bb_deploy/railtie.rb

@@ -1,12 +0,0 @@
-require 'bb_deploy'
-# require 'rails'
-
-module BbDeploy
-  class Railtie < Rails::Railtie
-    railtie_name :bb_deploy
-
-    rake_tasks do
-      load "tasks/deploy.rake"
-    end
-  end
-end

data/lib/bb_deploy.rb

@@ -1,4 +0,0 @@
-module BbDeploy
-  require 'bb_deploy/railtie' if defined?(Rails)
-  require 'bb_deploy/deployer'
-end