heroku_rails_deploy 0.2.2 → 0.3.0.rc0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc3e6f646b7ef7c41f69b59029b2c1fdee7cff1c
-  data.tar.gz: 2f6e0b9b32170b947a47980f1d671118fd5ef3cb
+  metadata.gz: 1aac6bef63e2d84fc55be74e10b2b9493fe153fc
+  data.tar.gz: 4bdd7c820d0085cb0a0960490e98adbbef42174b
 SHA512:
-  metadata.gz: 8dbf1c200f8e9647d867a5ece168149fa2c1999d23e42842262a1f1ef76b7ab57b1f4419af1ea49d5a0724cdf213d1aafe834dc3ed8515a7a9a801f6504f023f
-  data.tar.gz: a6c5700adc7fd2b6e1b20567896a7dfaca655440978addd2bdada60aa0999c254d42fd1ea5416711a17b05cf56da213d305b1469e3e169ba2d5ecd10310196ff
+  metadata.gz: aa22e648f9627077fc5f870a733d624e81ff90868289f12fe204e49677a0e90b8478c21f12ae0785d107d9c18d85fafa013d71b57ec798d6ff0d2e59ae921383
+  data.tar.gz: fce74dc0b5268c7df9aeac1e1eb4c06b720e332f0f615917a56e146055a5488a5371aada7c4fc1f36f20b0f3a7f9972bdbdc1af2fdd970197370ced5fa8aeb65

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # heroku_rails_deploy
 
+## v0.3.0
+- Add support for Avro schema registration during deployment.
+- Refuse to deploy when there are uncommitted changes.
+
 ## v0.2.2
 - Fixes bug in getting branch name from executing system command
 

data/README.md

@@ -3,8 +3,9 @@
 This gem provides a simple Heroku deploy script for Rails applications. Deploys
 following the following steps:
 
-1. Push code to Heroku
-2. If there are pending migrations, run them and restart the Heroku dynos
+1. Push updated Avro schemas to a schema registry
+2. Push code to Heroku
+3. If there are pending migrations, run them and restart the Heroku dynos
 
 ## Installation
 
@@ -42,6 +43,8 @@ $ bin/deploy --help
 Usage: deploy [options]
     -e, --environment ENVIRONMENT    The environment to deploy to. Must be in production, staging (default production)
     -r, --revision REVISION          The git revision to push. (default HEAD)
+        --register-avro-schemas      Force the registration of Avro schemas when deploying to a non-production environment.
+        --skip-avro-schemas          Skip the registration of Avro schemas when deploying to production.
     -h, --help                       Show this message
 ```
 

data/lib/heroku_rails_deploy/deployer.rb

@@ -1,14 +1,16 @@
 require 'optparse'
 require 'shellwords'
 require 'yaml'
+require 'english'
 
 module HerokuRailsDeploy
   class Deployer
     PRODUCTION_BRANCH_REGEX = /\A((master)|(release\/.+)|(hotfix\/.+))\z/
+    PRODUCTION = 'production'.freeze
 
     attr_reader :config_file, :args
 
-    class Options < Struct.new(:environment, :revision)
+    class Options < Struct.new(:environment, :revision, :register_avro_schemas, :skip_avro_schemas)
       def self.create_default(app_registry)
         new(app_registry.keys.first, 'HEAD')
       end
@@ -41,6 +43,16 @@ module HerokuRailsDeploy
                   'The git revision to push. (default HEAD)') do |revision|
           options.revision = revision
         end
+
+        parser.on('--register-avro-schemas',
+                  'Force the registration of Avro schemas when deploying to a non-production environment.') do |register_avro_schemas|
+          options.register_avro_schemas = register_avro_schemas
+        end
+
+        parser.on('--skip-avro-schemas',
+                  'Skip the registration of Avro schemas when deploying to production.') do |skip_avro_schemas|
+          options.skip_avro_schemas = skip_avro_schemas
+        end
       end.parse!(args)
 
       app_name = app_registry.fetch(options.environment) do
@@ -48,9 +60,24 @@ module HerokuRailsDeploy
           "Must be in #{app_registry.keys.join(', ')}")
       end
 
-      raise 'Only master, release or hotfix branches can be deployed to production' if options.environment == 'production' && !production_branch?(options.revision)
+      raise 'Only master, release or hotfix branches can be deployed to production' if production?(options) && !production_branch?(options.revision)
+
+      no_uncommitted_changes!
+
+      puts "Deploying to Heroku app #{app_name} for environment #{options.environment}"
+
+      if !options.skip_avro_schemas && (production?(options) || options.register_avro_schemas)
+        puts 'Checking for pending Avro schemas'
+        pending_schemas = list_pending_schemas(app_name)
+        if pending_schemas.any?
+          puts 'Registering Avro schemas'
+          register_avro_schemas!(registry_url(app_name), pending_schemas)
+        else
+          puts 'No pending Avro schemas'
+        end
+      end
 
-      puts "Pushing code to Heroku app #{app_name} for environment #{options.environment}"
+      puts 'Pushing code'
       push_code(app_name, options.revision)
 
       puts 'Checking for pending migrations'
@@ -64,18 +91,29 @@ module HerokuRailsDeploy
       end
     end
 
+    private
+
+    def production?(options)
+      options.environment == PRODUCTION
+    end
+
     def production_branch?(revision)
       git_branch_name(revision).match(PRODUCTION_BRANCH_REGEX)
     end
 
+    def no_uncommitted_changes!
+      uncommitted_changes = run_command!('git status --porcelain', quiet: true)
+      raise "There are uncommitted changes:\n#{uncommitted_changes}" unless uncommitted_changes.blank?
+    end
+
     def push_code(app_name, revision)
-      run_command!("git push --force git@heroku.com:#{app_name}.git #{revision}:master")
+      run_command!("git push --force #{app_remote(app_name)} #{revision}:master")
     end
 
     def git_branch_name(revision)
-      branch_name = `git rev-parse --abbrev-ref #{Shellwords.escape(revision)}`.strip
-      raise "Unable to get branch for #{revision}" unless $?.to_i == 0
-      branch_name
+      run_command!("git rev-parse --abbrev-ref #{Shellwords.escape(revision)}", quiet: true).strip
+    rescue
+      raise "Unable to get branch for #{revision}"
     end
 
     def run_migrations(app_name)
@@ -91,28 +129,62 @@ module HerokuRailsDeploy
     end
 
     def run_heroku_command!(app_name, command)
-      success = run_heroku_command(app_name, command)
-      raise "Heroku command '#{command}' failed" unless success
+      run_heroku_command(app_name, command, validate: true)
+    rescue
+      raise "Heroku command '#{command}' failed"
     end
 
-    def run_heroku_command(app_name, command)
+    def run_heroku_command(app_name, command, validate: nil)
       cli_command = "heroku #{command} --app #{app_name}"
       if command.start_with?('run ')
         # If we're running a shell command, return the underlying
         # shell command exit code
         cli_command << ' --exit-code'
       end
-      run_command(cli_command)
+      run_command(cli_command, validate: validate)
+    end
+
+    def registry_url(app_name)
+      result = run_command!("heroku config -a #{app_name} | grep AVRO_SCHEMA_REGISTRY_URL:", quiet: true)
+      result.split.last
+    end
+
+    def register_avro_schemas!(registry_url, schemas)
+      cmd = "rake avro:register_schemas schemas=#{schemas.join(',')}"
+      run_command!("DEPLOYMENT_SCHEMA_REGISTRY_URL=#{registry_url} #{cmd}", print_command: cmd)
+    end
+
+    def list_pending_schemas(app_name)
+      changed_files(app_name).select { |filename| /\.avsc$/ =~ filename }
+    end
+
+    def changed_files(app_name)
+      run_command("git diff --name-only #{remote_commit(app_name)}..#{current_commit}", quiet: true).split("\n").map(&:strip)
+    end
+
+    def current_commit
+      run_command!("git log --pretty=format:'%H' -n 1", quiet: true)
+    end
+
+    def remote_commit(app_name)
+      run_command!("git ls-remote --heads #{app_remote(app_name)} master", quiet: true).split.first
+    end
+
+    def app_remote(app_name)
+      "git@heroku.com:#{app_name}.git"
     end
 
-    def run_command!(command)
-      success = run_command(command)
-      raise "Command '#{command}' failed" unless success
+    def run_command!(command, print_command: nil, quiet: false)
+      run_command(command, print_command: print_command, quiet: quiet, validate: true)
     end
 
-    def run_command(command)
-      puts command
-      Bundler.with_clean_env { system(command) }
+    def run_command(command, print_command: nil, validate: nil, quiet: false)
+      printed_command = print_command || command
+      puts printed_command unless quiet
+      output = Bundler.with_clean_env { `#{command}` }
+      exit_status = $CHILD_STATUS.exitstatus
+      raise "Command '#{printed_command}' failed" if validate && exit_status.nonzero?
+      output
     end
   end
 end

data/lib/heroku_rails_deploy/version.rb

@@ -1,3 +1,3 @@
 module HerokuRailsDeploy
-  VERSION = '0.2.2'.freeze
+  VERSION = '0.3.0.rc0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heroku_rails_deploy
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0.rc0
 platform: ruby
 authors:
 - Salsify, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-12 00:00:00.000000000 Z
+date: 2017-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -151,12 +151,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Simple deployment of Rails app to Heroku