recap 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93a885c11e132676dc0f220d5eb9cbd50508e861
-  data.tar.gz: fb685ee8cded3a4771b985ea60c2d0823c5d1fbd
+  metadata.gz: 001ac16e3f6040b7229222dfabd8c945be2bb1b2
+  data.tar.gz: f07c98d248d99f45b774f57711c9769f5d32d2bb
 SHA512:
-  metadata.gz: 512cd41ee586903a52d2d65f6c298ece8a0329906ed2b28e20503af8797198098da12d5c5df5172432c85ddeda906b79ced0368d63cbcf47843e69f81fe41342
-  data.tar.gz: 3d1358e405a2fe2815f2d9280e10b9a344bb8009e235222d83ebb392e13ba5a62d659a18697e896623ab6ef02263aaf9d3e21cf57aed9f1451a5ac5e2e1e0374
+  metadata.gz: 8a47f44dcf16f289d474e456a9e6a1fc512e829fe9af591bc653e7b7b50261721d74e702cf4592a8293ffc434474313e90f2a82d031dc548a083aa45017bbf1f
+  data.tar.gz: eeb0c99b00c97f82c194b7fda771c6d44382e18ea41fc9114c712366e29dbb7b59ffb0d6bcfe63023566baa358b4a69ecff5bec83f2a66b27b5508bcc60d2a83

data/lib/recap/support/capistrano_extensions.rb

@@ -10,7 +10,7 @@ module Recap::Support::CapistranoExtensions
   end
 
   def as_app_once(command, pwd = deploy_to)
-    sudo "su - #{application_user} -c 'cd #{pwd} && #{command}'", once: true
+    sudo "su - #{application_user} -c 'cd #{pwd} && #{command}'", :once => true
   end
 
   # Put a string into a file as the application user
@@ -87,5 +87,31 @@ module Recap::Support::CapistranoExtensions
     force_full_deploy || changed_files.detect {|p| p[0, path.length] == path}
   end
 
+  def claim_lock(message)
+    begin
+      sudo "[ ! -e #{deploy_lock_file} ] && echo '#{message}' > #{deploy_lock_file}"
+    rescue Exception => e
+      abort %{
+Failed to claim lock: " + capture("cat #{deploy_lock_file}"
+
+If you think this lock no longer applies, clear it using the `deploy:unlock` task
+and try again.
+}
+    end
+  end
+
+  def release_lock
+    sudo "rm -rf #{deploy_lock_file}"
+  end
+
+  def transaction_with_lock(message)
+    on_rollback { release_lock }
+    transaction do
+      claim_lock(message)
+      yield
+      release_lock
+    end
+  end
+
   Capistrano::Configuration.send :include, self
 end

data/lib/recap/tasks/deploy.rb

@@ -52,6 +52,13 @@ module Recap::Tasks::Deploy
     # Force a complete deploy, even if no trigger files have changed
     set(:force_full_deploy, false)
 
+    # A lock file is used to ensure deployments don't overlap
+    set(:deploy_lock_file) { "#{deploy_to}/.recap-lock"}
+
+    # The lock file is set to include a message that can be displayed
+    # if claiming the lock fails
+    set(:deploy_lock_message) { "Deployment in progress (started #{Time.now.to_s})" }
+
     # To authenticate with github or other git servers, it is easier (and cleaner) to forward the
     # deploying user's ssh key than manage keys on deployment servers.
     ssh_options[:forward_agent] = true
@@ -87,7 +94,7 @@ module Recap::Tasks::Deploy
     # tags the release and restarts the application.
     desc "Deploy the latest application code"
     task :default do
-      transaction do
+      transaction_with_lock deploy_lock_message do
         top.env.set
         update_code
         tag
@@ -148,5 +155,18 @@ module Recap::Tasks::Deploy
     task :destroy do
       sudo "rm -rf #{deploy_to}"
     end
+
+    # As well as locking during each deployment, locks can manually be set with `deploy:lock`.  To
+    # use a custom lock message, do `DEPLOY_LOCK_MESSAGE="My message" cap deploy:lock`.  Locking
+    # prevents deployments, but not other tasks.
+    task :lock do
+      claim_lock ENV['DEPLOY_LOCK_MESSAGE'] || "Manually locked at #{Time.now}"
+    end
+
+    # To unlock a manually set lock, or a lock that has been left behind in error, the `deploy:unlock`
+    # task can be used.
+    task :unlock do
+      release_lock
+    end
   end
 end

data/lib/recap/version.rb

@@ -1,3 +1,3 @@
 module Recap
-  VERSION = '1.1.3'
+  VERSION = '1.2.0'
 end

data/spec/tasks/deploy_spec.rb

@@ -161,6 +161,7 @@ describe Recap::Tasks::Deploy do
 
     describe 'deploy' do
       it 'runs env:set, deploy:update_code, deploy:tag and then deploy:restart tasks' do
+        namespace.stubs(:transaction_with_lock).yields
         env = stub('env')
         config.stubs(:env).returns(env)
         env.expects('set')
@@ -170,20 +171,20 @@ describe Recap::Tasks::Deploy do
         config.find_and_execute_task('deploy')
       end
 
-      it 'calls deploy:update_code task within a transaction' do
-        namespace.stubs(:transaction)
+      it 'calls deploy:update_code task within a locked transaction' do
+        namespace.stubs(:transaction_with_lock)
         namespace.expects(:update_code).never
         config.find_and_execute_task('deploy')
       end
 
-      it 'calls deploy:tag task within a transaction' do
-        namespace.stubs(:transaction)
+      it 'calls deploy:tag task within a locked transaction' do
+        namespace.stubs(:transaction_with_lock)
         namespace.expects(:tag).never
         config.find_and_execute_task('deploy')
       end
 
       it 'calls restart outside the transaction' do
-        namespace.stubs(:transaction)
+        namespace.stubs(:transaction_with_lock)
         namespace.expects(:restart)
         config.find_and_execute_task('deploy')
       end
@@ -242,6 +243,28 @@ describe Recap::Tasks::Deploy do
       end
     end
 
+    describe 'deploy:lock' do
+      it 'locks deployments with the message DEPLOY_LOCK_MESSAGE if available' do
+        ENV.stubs("[]").with("DEPLOY_LOCK_MESSAGE").returns("custom-message")
+        namespace.expects(:claim_lock).with("custom-message")
+        namespace.find_and_execute_task('deploy:lock')
+      end
+
+      it 'locks deployments with a default message if no message provided' do
+        now = Time.now
+        Time.stubs(:now).returns(now)
+        namespace.expects(:claim_lock).with("Manually locked at #{Time.now}")
+        namespace.find_and_execute_task('deploy:lock')
+      end
+    end
+
+    describe 'deploy:unlock' do
+      it 'removes any existing locks' do
+        namespace.expects(:release_lock)
+        namespace.find_and_execute_task('deploy:unlock')
+      end
+    end
+
     describe 'deploy:restart' do
       it 'does nothing (but can be overidden by other recipes)' do
         namespace.expects(:run).never
@@ -258,4 +281,4 @@ describe Recap::Tasks::Deploy do
       end
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recap
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Tom Ward
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-04 00:00:00.000000000 Z
+date: 2013-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -223,7 +223,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: GIT based deployment recipes for Capistrano