paratrooper 2.4.1 → 3.0.0.beta1

data/lib/paratrooper/local_api_key_extractor.rb

@@ -1,8 +1,9 @@
 require 'netrc'
+require 'paratrooper/error'
 
 module Paratrooper
   class LocalApiKeyExtractor
-    class NetrcFileDoesNotExist < StandardError; end
+    class NetrcFileDoesNotExist < Paratrooper::Error; end
 
     attr_reader :file_path, :netrc_klass
 

data/lib/paratrooper/notifiers/screen_notifier.rb

@@ -48,7 +48,12 @@ module Paratrooper
       end
 
       def push_repo(options = {})
-        display("Pushing #{options[:reference_point]} to Heroku")
+        desc = "#{options[:reference_point]} to #{options[:app_name]} on Heroku"
+        if options[:force]
+          display("Force pushing #{desc}")
+        else
+          display("Pushing #{desc}")
+        end
       end
 
       def run_migrations(options = {})
@@ -58,10 +63,6 @@ module Paratrooper
       def app_restart(options = {})
         display("Restarting application")
       end
-
-      def warm_instance(options = {})
-        display("Accessing #{options[:app_url]} to warm up your application")
-      end
     end
   end
 end

data/lib/paratrooper/pending_migration_check.rb

@@ -2,16 +2,17 @@ require 'paratrooper/system_caller'
 
 module Paratrooper
   class PendingMigrationCheck
-    attr_accessor :diff, :heroku, :match_tag_name, :system_caller
+    attr_accessor :diff, :heroku, :deployment_sha, :system_caller
 
-    def initialize(match_tag_name, heroku_wrapper, system_caller)
+    def initialize(deployment_sha, heroku_wrapper, system_caller)
       self.heroku         = heroku_wrapper
-      self.match_tag_name = match_tag_name
+      self.deployment_sha = deployment_sha
       self.system_caller  = system_caller
     end
 
     def migrations_waiting?
-      @migrations_waiting ||= check_for_pending_migrations
+      defined?(@migrations_waiting) or @migrations_waiting = check_for_pending_migrations
+      @migrations_waiting
     end
 
     def last_deployed_commit
@@ -21,8 +22,8 @@ module Paratrooper
     private
 
     def check_for_pending_migrations
-      call = %Q[git diff --shortstat #{last_deployed_commit} #{match_tag_name} -- db/migrate]
-      self.diff = system_caller.execute(call)
+      cmd = %Q[git diff --shortstat #{last_deployed_commit} #{deployment_sha} -- db/migrate]
+      self.diff = system_caller.execute(cmd)
       !diff.strip.empty?
     end
   end

data/lib/paratrooper/source_control.rb

@@ -0,0 +1,49 @@
+require 'forwardable'
+
+module Paratrooper
+  class SourceControl
+    extend Forwardable
+    delegate [:system_caller] => :config
+
+    attr_accessor :config
+
+    def initialize(config)
+      @config = config
+    end
+
+    def remote
+      "git@#{config.deployment_host}:#{config.app_name}.git"
+    end
+
+    def branch_name
+      if config.branch_name?
+        branch = config.branch_name.to_s
+        branch.upcase == "HEAD" ? "HEAD" : "refs/heads/#{config.branch_name}"
+      end
+    end
+
+    def push_to_deploy
+      system_call("git push #{force_flag}#{remote} #{reference_point}:refs/heads/master", :exit_code)
+    end
+
+    def reference_point
+      branch_name || 'HEAD'
+    end
+
+    def deployment_sha
+      system_call("git rev-parse #{reference_point}").strip
+    end
+
+    def force_flag
+      "-f " if config.force_push
+    end
+
+    # Internal: Calls commands meant to go to system
+    #
+    # cmd - String version of system command
+    #
+    def system_call(cmd, exit_code = false)
+      system_caller.execute(cmd, exit_code)
+    end
+  end
+end

data/lib/paratrooper/system_caller.rb

@@ -1,19 +1,32 @@
+require 'paratrooper/error'
+
 module Paratrooper
   class SystemCaller
+    class ErrorSystemExit < Paratrooper::Error
+      def initialize(cmd)
+        msg = "The system command '#{cmd}' has exited unsuccessfully"
+        super(msg)
+      end
+    end
     attr_accessor :debug
 
     def initialize(debug = false)
-      self.debug = debug
+      @debug = debug
     end
 
-    def execute(call)
-      debug_message_for(call)
-      `#{call}`
+    def execute(cmd, exit_code = false)
+      debug_message_for(cmd)
+      result = %x[#{cmd}]
+      if exit_code && $? != 0
+        fail(ErrorSystemExit.new(cmd))
+      end
+      result
     end
 
     private
-    def debug_message_for(call)
-      p "DEBUG: #{call}" if debug
+
+    def debug_message_for(cmd)
+      puts "DEBUG: #{cmd}" if debug
     end
   end
 end

data/lib/paratrooper/version.rb

@@ -1,3 +1,3 @@
 module Paratrooper
-  VERSION = "2.4.1".freeze
+  VERSION = "3.0.0.beta1".freeze
 end

data/paratrooper.gemspec

@@ -20,10 +20,10 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = '>= 1.9.2'
 
   gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'rspec', '~> 2.12'
+  gem.add_development_dependency 'rspec', '~> 3.0'
   gem.add_development_dependency 'pry'
   gem.add_dependency 'heroku-api', '~> 0.3'
-  gem.add_dependency 'rendezvous', '~> 0.0.1'
+  gem.add_dependency 'rendezvous', '~> 0.1'
   gem.add_dependency 'netrc', '~> 0.7'
   gem.add_dependency 'excon'
 end

data/spec/paratrooper/configuration_spec.rb

@@ -0,0 +1,352 @@
+require 'spec_helper'
+require 'paratrooper/configuration'
+
+describe Paratrooper::Configuration do
+  let(:configuration) { described_class.new }
+
+  describe "attributes=" do
+    it "takes hash of attributes and calls the key as a method setter" do
+      attrs = { app_name: 'APP_NAME', screen_notifier: 'SCREEN_NOTIFIER' }
+      configuration.attributes = attrs
+
+      expect(configuration.app_name).to eq('APP_NAME')
+      expect(configuration.screen_notifier).to eq('SCREEN_NOTIFIER')
+    end
+  end
+
+  describe "app_name" do
+    context "with passed value" do
+      it "returns passed value" do
+        configuration.app_name = "APP_NAME"
+        expect(configuration.app_name).to eq("APP_NAME")
+      end
+    end
+
+    context "with no value passed" do
+      it "returns nil" do
+        expect(configuration.app_name).to be_nil
+      end
+    end
+  end
+
+  describe "branch_name?" do
+    context "when branch_name is a valid string" do
+      it "returns true" do
+        configuration.branch_name = 'BRANCH_NAME'
+        expect(configuration.branch_name?).to eq(true)
+      end
+    end
+
+    context "when branch_name is an invalid string" do
+      it "returns false" do
+        configuration.branch_name = "   "
+        expect(configuration.branch_name?).to eq(false)
+      end
+    end
+
+    context "when branch_name is nil" do
+      it "returns false" do
+        configuration.branch_name = nil
+        expect(configuration.branch_name?).to eq(false)
+      end
+    end
+  end
+
+  describe "branch_name" do
+    context "with passed value" do
+      it "returns passed value" do
+        configuration.branch_name = "TAG_NAME"
+        expect(configuration.branch_name).to eq("TAG_NAME")
+      end
+    end
+
+    context "with no value passed" do
+      it "returns nil" do
+        expect(configuration.branch_name).to be_nil
+      end
+    end
+  end
+
+  describe "branch=" do
+    specify "branch is set and @branch_name holds value" do
+      configuration.branch = "branch_name"
+
+      expect(configuration.branch_name).to eq("branch_name")
+    end
+  end
+
+  describe "protocol" do
+    context "with passed value" do
+      specify "passed value is returned" do
+        configuration.protocol = 'https'
+
+        expect(configuration.protocol).to eq('https')
+      end
+    end
+
+    context "no value passed" do
+      specify "default value of 'http' is returned" do
+        expect(configuration.protocol).to eq('http')
+      end
+    end
+  end
+
+  describe "deployment_host" do
+    context "with passed value" do
+      it "returns the value passed" do
+        configuration.deployment_host = 'HOST_NAME'
+        expect(configuration.deployment_host).to eq('HOST_NAME')
+      end
+    end
+
+    context "with no passed value" do
+      it "returns the default value of 'heroku.com'" do
+        expect(configuration.deployment_host).to eq('heroku.com')
+      end
+    end
+  end
+
+  describe "api_key" do
+    context "with passed value" do
+      it "returns the value passed" do
+        configuration.api_key = 'API_KEY'
+        expect(configuration.api_key).to eq('API_KEY')
+      end
+    end
+
+    context "with no passed value" do
+      it "returns nil" do
+        expect(configuration.api_key).to be_nil
+      end
+    end
+  end
+
+  describe "maintenance" do
+    context "with passed value" do
+      it "returns the value passed" do
+        configuration.maintenance = 'true'
+        expect(configuration.maintenance).to eq(true)
+      end
+    end
+
+    context "with no passed value" do
+      it "returns false" do
+        expect(configuration.maintenance).to eq(false)
+      end
+    end
+  end
+
+  describe "maintenance?" do
+    context "when #maintenance is truthy" do
+      it "returns true" do
+        configuration.maintenance = "YUP"
+        expect(configuration.maintenance?).to eq(true)
+      end
+    end
+
+    context "when #maintenance is falsey" do
+      it "returns false" do
+        configuration.maintenance = false
+        expect(configuration.maintenance?).to eq(false)
+      end
+    end
+  end
+
+  describe "force_push" do
+    context "with passed value" do
+      it "returns the value passed" do
+        configuration.force_push = "true"
+        expect(configuration.force_push).to eq(true)
+      end
+    end
+
+    context "with no passed value" do
+      it "returns false" do
+        expect(configuration.force_push).to eq(false)
+      end
+    end
+  end
+
+  describe "force_push?" do
+    context "when #force_push is truthy" do
+      it "returns true" do
+        configuration.force_push = "YUP"
+        expect(configuration.force_push?).to eq(true)
+      end
+    end
+
+    context "when #force_push is falsey" do
+      it "returns false" do
+        configuration.force_push = false
+        expect(configuration.force_push?).to eq(false)
+      end
+    end
+  end
+
+  describe "heroku" do
+    context "with passed value" do
+      it "returns passed value" do
+        heroku = double(:heroku)
+        configuration.heroku = heroku
+
+        expect(configuration.heroku).to eq(heroku)
+      end
+    end
+
+    context "with no value passed" do
+      it "returns internal heroku wrapper" do
+        heroku = class_double("HerokuWrapper")
+        stub_const("Paratrooper::HerokuWrapper", heroku)
+        wrapper_instance = double(:heroku)
+        expect(heroku).to receive(:new).with("APP_NAME").and_return(wrapper_instance)
+
+        configuration.app_name = "APP_NAME"
+        expect(configuration.heroku).to eq(wrapper_instance)
+      end
+    end
+  end
+
+  describe "migration_check" do
+    context "with passed value" do
+      it "returns passed value" do
+        migration_check = double(:pending_migration_check)
+        configuration.migration_check = migration_check
+
+        expect(configuration.migration_check).to eq(migration_check)
+      end
+    end
+
+    context "with no value passed" do
+      it "returns the default pending migration check object" do
+        migration_check_class = class_double("PendingMigrationCheck")
+        stub_const("Paratrooper::PendingMigrationCheck", migration_check_class)
+        migration_check = double(:heroku)
+        source_control = double(:source_control, deployment_sha: "SHA")
+
+        configuration.heroku = "HEROKU"
+        configuration.system_caller = "SYSTEM"
+        configuration.source_control = source_control
+
+        expect(migration_check_class).to receive(:new).with("SHA", "HEROKU", "SYSTEM")
+          .and_return(migration_check)
+        expect(configuration.migration_check).to eq(migration_check)
+      end
+    end
+  end
+
+  describe "system_caller" do
+    context "with passed value" do
+      it "returns passed value" do
+        system_caller = double(:system_caller)
+        configuration.system_caller = system_caller
+
+        expect(configuration.system_caller).to eq(system_caller)
+      end
+    end
+
+    context "with no value passed" do
+      it "returns default system_caller" do
+        system_caller = class_double("SystemCaller")
+        stub_const("Paratrooper::SystemCaller", system_caller)
+        wrapper_instance = double(:system_caller)
+        expect(system_caller).to receive(:new).and_return(wrapper_instance)
+
+        expect(configuration.system_caller).to eq(wrapper_instance)
+      end
+    end
+  end
+
+  describe "http_client" do
+    context "with passed value" do
+      it "returns passed value" do
+        http_client = double(:http_client)
+        configuration.http_client = http_client
+
+        expect(configuration.http_client).to eq(http_client)
+      end
+    end
+
+    context "with no value passed" do
+      it "returns internal http_client wrapper" do
+        http_client = class_double("HttpClientWrapper")
+        stub_const("Paratrooper::HttpClientWrapper", http_client)
+        wrapper_instance = double(:http_client)
+        expect(http_client).to receive(:new).and_return(wrapper_instance)
+
+        expect(configuration.http_client).to eq(wrapper_instance)
+      end
+    end
+  end
+
+  describe "screen_notifier" do
+    context "with passed value" do
+      it "returns passed value" do
+        screen_notifier = double(:screen_notifier)
+        configuration.screen_notifier = screen_notifier
+
+        expect(configuration.screen_notifier).to eq(screen_notifier)
+      end
+    end
+
+    context "with no value passed" do
+      it "returns default screen_notifier" do
+        screen_notifier = class_double("Notifiers::ScreenNotifier")
+        stub_const("Paratrooper::Notifiers::ScreenNotifier", screen_notifier)
+        notifier = double(:screen_notifier)
+        expect(screen_notifier).to receive(:new).and_return(notifier)
+
+        expect(configuration.screen_notifier).to eq(notifier)
+      end
+    end
+  end
+
+  describe "notifiers" do
+    context "with passed value as array" do
+      it "returns passed value" do
+        notifier = double(:notifier)
+        configuration.notifiers = [notifier]
+
+        expect(configuration.notifiers).to eq([notifier])
+      end
+    end
+
+    context "with passed value as single item" do
+      it "returns array containing passed value" do
+        notifier = double(:notifier)
+        configuration.notifiers = notifier
+
+        expect(configuration.notifiers).to eq([notifier])
+      end
+    end
+
+    context "with no value passed" do
+      it "returns array containing screen notifier" do
+        configuration.screen_notifier = "SCREEN_NOTIFIER"
+
+        expect(configuration.notifiers).to eq(["SCREEN_NOTIFIER"])
+      end
+    end
+  end
+
+  describe "source_control" do
+    context "with passed value" do
+      it "returns passed value" do
+        source_control = double(:source_control)
+        configuration.source_control = source_control
+
+        expect(configuration.source_control).to eq(source_control)
+      end
+    end
+
+    context "with no value passed" do
+      it "returns default source_control" do
+        source_control = class_double("SourceControl")
+        stub_const("Paratrooper::SourceControl", source_control)
+        controller = double(:source_control)
+        expect(source_control).to receive(:new).with(configuration).and_return(controller)
+
+        expect(configuration.source_control).to eq(controller)
+      end
+    end
+  end
+end