dual_burner 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7dbe1637a1f1600e292900b7f14e08fd2b50927
-  data.tar.gz: b2290b3f03c7731627ab03b914843868d23b1a79
+  metadata.gz: 9a4f4e3667ff50c1d51eeea5c61d7528299f4039
+  data.tar.gz: 0f43660fd6fc53398f8c69c284296426d0112d1b
 SHA512:
-  metadata.gz: a820476c0628ff669590f26f021ee305f682bc4b55849d3e3930c6ae548f1766b2d890ecf3e43d45278fdbd4b394a01b850775a12054b8cedee9c0644cd67fe2
-  data.tar.gz: 4f7a647f9bd73e50db2802a55e04d4dfe259c13d28f167bb13ef762bc79a591d28b62e4a18c37882db5474fbd5b150d2c893419e18adcd0d01d8f766f729b80d
+  metadata.gz: a3f8678547cfe7da8ee3dfd9dbd87b41a359ba85e22e53e3c257f92af6f3b5f3d4e33d03be131be4e96f12720446d2dd8773099f619e0a2a69605b28cb154087
+  data.tar.gz: bf96153bf676b0e735d96f05b4a31b594336898bfa72c55761e157c747d836de3bc51d15cf898dd087223ea30e8886540e6571f61f27eb01025f0f4f60f53a21

data/.ruby-version

@@ -1 +1 @@
-2.3.0
+2.3.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at engineering@blueapron.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Blue Apron, 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

@@ -38,22 +38,28 @@ The YML file manages the environment and clustering information.
 
 ```
 staging:
-  - remote_url: 'git@heroku.com:blueapron-alpha.git'
+  - remote_url: 'git@heroku.com:example-alpha.git'
     name: 'Alpha'
     color: 'blue'
-  - remote_url: 'git@heroku.com:blueapron-alpha.git'
+    version_url: 'https://alpha.example.com/version'
+  - remote_url: 'git@heroku.com:example-bravo.git'
     name: 'Bravo'
     color: 'green'
+    version_url: 'https://bravo.example.com/version'
+
 production:
-  - remote_url: 'git@heroku.com:blueapron-api.git
+  - remote_url: 'git@heroku.com:example-api.git
     name: 'API'
     color: 'blue'
-  - remote_url: 'git@heroku.com:blueapron-admin.git'
+    version_url: 'https://api.example.com/version'
+  - remote_url: 'git@heroku.com:example-admin.git'
     name: 'Admin'
     color: 'green'
-  - remote_url: 'git@heroku.com:blueapron-www.git'
+    version_url: 'https://admin.example.com/version'
+  - remote_url: 'git@heroku.com:example-www.git'
     name: 'WWW'
     color: 'yellow'
+    version_url: 'https://www.example.com/version'
 ```
 
 These are the possible configurations for your application.
@@ -64,6 +70,7 @@ These are the possible configurations for your application.
 | name            | yes           | The presentation name for the app. |
 | color           | yes           | The presentation color for display. |
 | heroku_app_name | no            | The heroku app name. Needed only for Heroku related commands i.e. `dual_burner config_set`. |
+| version_url     | no            | An endpoint providing the current app version. Used to notify when a deployment is live. |
 
 ## Git Commands
 
@@ -73,9 +80,9 @@ Use the `dual_burner deploy` executable to deploy your projects.
 
 Below are some examples.
 
-#### Deploy of Master to Staging
+#### Deploy of Master to Staging with a live status notification
 
-`dual_burner deploy -e staging -g master`
+`dual_burner deploy -e staging -g master -n`
 
 #### Deploy of Master to Staging with Force
 

data/circle.yml

@@ -4,6 +4,3 @@ machine:
 dependencies:
   pre:
     - gem update bundler
-test:
-  pre:
-    - bundle exec rubocop -D -fp -fh -o $CIRCLE_ARTIFACTS/rubocop.html

data/dual_burner.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['engineering@blueapron.com']
 
   spec.summary       = %q{Blue Apron Dual Burner}
-  spec.description   = %q{A simply Ruby utility to push to many Heroku applications.}
+  spec.description   = %q{A simple Ruby utility to push to many Heroku applications.}
   spec.homepage      = 'https://github.com/blueapron/dual_burner'
 
   # Note: Files must be registered with git for things to package properly....
@@ -19,8 +19,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'colorize', '~> 0.7' 
-  spec.add_dependency 'thor', '~> 0.19' 
+  spec.add_dependency 'colorize', '~> 0.7'
+  spec.add_dependency 'thor', '~> 0.19'
+  spec.add_dependency 'terminal-notifier', '~> 1.7'
 
   spec.add_development_dependency 'bundler', '>= 1.9.5', '< 2.0'
   spec.add_development_dependency 'rake', '~> 10.0'

data/exe/dual_burner

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 require 'rubygems'
 require 'thor'
+require 'terminal-notifier'
 require 'dual_burner'
 
 DualBurner::Runner.start ? exit(0) : exit(1)

data/lib/dual_burner/base_command.rb

@@ -54,7 +54,7 @@ module DualBurner
     end
 
     def app_struct
-      Struct.new(:remote_url, :name, :color, :heroku_app_name)
+      Struct.new(:remote_url, :name, :color, :heroku_app_name, :version_url)
     end
 
     #
@@ -64,7 +64,8 @@ module DualBurner
         options.fetch('remote_url'),
         options.fetch('name'),
         options.fetch('color', nil),
-        options.fetch('heroku_app_name', nil)
+        options.fetch('heroku_app_name', nil),
+        options.fetch('version_url', nil)
       )
     end
 

data/lib/dual_burner/commands/deployer.rb

@@ -1,7 +1,12 @@
 module DualBurner
   module Commands
     class Deployer < DualBurner::BaseCommand
-      def deploy(git_reference: 'master')
+      def deploy(git_reference: 'master', notify: false)
+        # Require version_url
+        if notify && apps.any? { |app| app.version_url.nil? }
+          raise 'version_url must be defined to notify!'
+        end
+
         # Need to handle the explicit passing of nil too....
         if git_reference.nil? || git_reference.strip.empty?
           git_reference = 'master'
@@ -23,15 +28,43 @@ module DualBurner
           build_deploy_command(app: app, git_reference: git_reference)
         end
 
-        verify_results_exit_0(results, context: 'deploys')
+        verify_results_exit_0(results, context: 'deploys').tap do |success|
+          if success && notify
+            wait_for_deployment(git_reference)
+          end
+        end
       end
 
+      private
+
       def build_deploy_command(app:, git_reference:)
         remote = app.remote_url
         raise DualBurner::RemoteNotFoundException if remote.nil? || remote.strip.empty?
         "git push #{remote} #{git_reference}"
       end
 
+      def wait_for_deployment(git_reference)
+        deployed_sha = `git log #{git_reference} -n 1 --pretty=format:'%H'`
+
+        while current_app_versions.any? { |sha| sha != deployed_sha }
+          sleep 2
+        end
+
+        TerminalNotifier.notify(
+          "Latest version (#{git_reference}) is now live!",
+          title: "#{env} deploy",
+          sound: 'alarm'
+        )
+      end
+
+      def current_app_versions
+        results = execute_command_with_threads do |app|
+          "curl -s #{app.version_url} -w \"\n\""
+        end
+
+        results.map { |result| result.lines.first.strip }
+      end
+
       ##
       # Make sure the user knows what he/she is doing!
       def challenge_user!(git_reference:)

data/lib/dual_burner/runner.rb

@@ -7,6 +7,7 @@ module DualBurner
     GIT_DESC = 'The git reference to deploy.'.freeze unless defined?(GIT_DESC)
     HEROKU_KEY_DESC = 'The key to set on the Heroku app.'.freeze unless defined?(HEROKU_KEY_DESC)
     INTERACTIVE_DESC = 'Enable or disable interactive mode'.freeze unless defined?(INTERACTIVE_DESC)
+    NOTIFY_DESC = 'Verify and notify me when this deploy is live.'.freeze unless defined?(NOTIFY_DESC)
 
     desc 'last_release', 'Finds the HEAD git revision for all applications in cluster <ENV>.'
     method_option :env, aliases: '-e', type: :string, required: true, desc: ENV_DESC
@@ -23,6 +24,7 @@ module DualBurner
     method_option :config, aliases: '-c', type: :string, optional: true, desc: CONFIG_DESC
     method_option :git_reference, aliases: '-g', default: 'master', type: :string, optional: true, desc: GIT_DESC
     method_option :interactive, default: true, type: :boolean, optional: true, desc: INTERACTIVE_DESC
+    method_option :notify, aliases: '-n', default: false, lazy_default: true, type: :boolean, optional: true, desc: NOTIFY_DESC
     def deploy
       ::DualBurner::Commands::Deployer.new(
         env: options.fetch('env'),
@@ -30,7 +32,7 @@ module DualBurner
           deploy_file: options['config'],
           interactive: options['interactive']
         )
-      ).deploy(git_reference: options['git_reference'])
+      ).deploy(git_reference: options['git_reference'], notify: options['notify'])
     end
 
     desc 'config_set', 'Set <KEY> to <VALUE> for all Heroku appslocations in cluster <ENV>.'

data/lib/dual_burner/version.rb

@@ -1,3 +1,3 @@
 module DualBurner
-  VERSION = '0.3.1'.freeze
+  VERSION = '0.4.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dual_burner
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Blue Apron Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-18 00:00:00.000000000 Z
+date: 2016-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -128,7 +142,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A simply Ruby utility to push to many Heroku applications.
+description: A simple Ruby utility to push to many Heroku applications.
 email:
 - engineering@blueapron.com
 executables:
@@ -141,7 +155,9 @@ files:
 - ".rubocop.yml"
 - ".ruby-version"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Gemfile
+- LICENSE.txt
 - README.md
 - Rakefile
 - bin/console