capistrano_deploy_lock 1.1.0 → 1.2.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NWVmOTJlNzg5NjYzZTY0NzJiOGViMzBiZDFhYzk0ODhmYjQ0OTE5OA==
+  data.tar.gz: !binary |-
+    MDEzMjM3MDBmMTU1ZjBhZTI3OGM3YTlhNjNhMGZmNGEzNTU1MzVlMQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NjMyYTFhN2U5OTE2MjI1MDlmYjg2NzYyN2NkODhiNzM4Y2M1MDA5YmYzYmU5
+    MGJmYzQ0MmQ1MWRlODFhOTA3MWUzYmE4YjE0NDQ3NTQ4ZDgwYjg4ZTU3MGMx
+    YjE5YTdiZjI1ZTk2YmQwODQwOWM3YTExN2MyODA1ZTk1MmRjMzY=
+  data.tar.gz: !binary |-
+    ODgzNjA2NzlhMGIwZTllOTYyN2NmNzg0ZWM5Y2IxNzEyZjIyNmU5YjJjYjNm
+    MWMyNGU2NTM1YWJiZTE1YmJmMzk4ZDBlYjE2MjBmYWZiMTEyOTUyNGIyN2Mz
+    Nzc5NmQwZGMzZDdjZjE2NzI5OWVkOThkYzIzNWIzMDJmZDMwOWM=

data/README.md

@@ -48,7 +48,6 @@ The following task will be run after deploy:
     * Removes any default deploy locks. If you set a custom lock, it will not be removed at this step.
     * You can remove a custom deploy lock by running `cap deploy:unlock` by itself, or by chaining `deploy:unlock:force` at the end of the command.
 
-
 ## Tasks
 
 ### `deploy:with_lock`
@@ -102,6 +101,20 @@ The lock file will be created at `#{shared_path}/capistrano.lock.yml` by default
     set :deploy_lockfile, "path/to/deploy/lock/file"
 
 
+## MOTD script
+
+If you install the gem on your server, you can use the `cap_deploy_lock_msg` script to display the lock status when you login via SSH.
+
+Usage:
+
+    cap_deploy_lock_msg <application_name> <stage> <path/to/lock_file.yml>
+
+If you are using `update-motd` on Ubuntu, create `/etc/update-motd.d/10-deploy-lock` with the following:
+
+    #!/bin/sh
+    /usr/local/bin/cap_deploy_lock_msg application stage /var/www/apps/application/shared/capistrano.lock.yml
+
+
 ## Thanks
 
 Special thanks to [David Bock](https://github.com/bokmann), who wrote the [deploy_lock.rb](https://github.com/bokmann/dunce-cap/blob/master/recipes/deploy_lock.rb)

data/lib/capistrano/deploy_lock.rb

@@ -30,9 +30,31 @@ module Capistrano
       if deploy_lock[:expire_at]
         if defined?(Capistrano::DateHelper)
           expires_in = Capistrano::DateHelper.distance_of_time_in_words_to_now deploy_lock[:expire_at].localtime
-          message << "\nExpires in #{expires_in}"
+          message << "\nLock expires in #{expires_in}"
         else
-          message << "\nExpires at #{deploy_lock[:expire_at].localtime.strftime("%H:%M:%S")}"
+          message << "\nLock expires at #{deploy_lock[:expire_at].localtime.strftime("%H:%M:%S")}"
+        end
+      else
+        message << "\nLock must be manually removed with: cap #{stage} deploy:unlock"
+      end
+    end
+
+    def self.expired_message(application, stage, deploy_lock)
+      message = "#{application} (#{stage}) was locked"
+      if defined?(Capistrano::DateHelper)
+        locked_ago = Capistrano::DateHelper.distance_of_time_in_words_to_now deploy_lock[:created_at].localtime
+        message << " #{locked_ago} ago"
+      else
+        message << " at #{deploy_lock[:created_at].localtime}"
+      end
+      message << " by '#{deploy_lock[:username]}'\nMessage: #{deploy_lock[:message]}"
+
+      if deploy_lock[:expire_at]
+        if defined?(Capistrano::DateHelper)
+          expires_in = Capistrano::DateHelper.distance_of_time_in_words_to_now deploy_lock[:expire_at].localtime
+          message << "\nLock expired #{expires_in} ago, unlocking..."
+        else
+          message << "\nLock expired at #{deploy_lock[:expire_at].localtime.strftime("%H:%M:%S")}"
         end
       else
         message << "\nLock must be manually removed with: cap #{stage} deploy:unlock"

data/lib/capistrano/recipes/deploy_lock.rb

@@ -1,11 +1,11 @@
 Capistrano::Configuration.instance(:must_exist).load do
-  before "deploy", "deploy:check_lock"
-  before "deploy", "deploy:refresh_lock"
-  before "deploy", "deploy:create_lock"
-  after  "deploy", "deploy:unlock"
+  before "deploy:update_code",    "deploy:check_lock"
+  before "deploy:update_code",    "deploy:refresh_lock"
+  before "deploy:update_code",    "deploy:create_lock"
+  after  "deploy:create_symlink", "deploy:unlock"
 
-  # Default lock expiry of 15 minutes (in case deploy crashes or is interrupted)
-  _cset :default_lock_expiry, (15 * 60)
+  # Default lock expiry of 10 minutes (in case deploy crashes or is interrupted)
+  _cset :default_lock_expiry, (10 * 60)
   _cset(:deploy_lockfile) { "#{shared_path}/capistrano.lock.yml" }
 
   # Show lock message as bright red
@@ -14,6 +14,9 @@ Capistrano::Configuration.instance(:must_exist).load do
   namespace :deploy do
     # Fetch the deploy lock unless already cached
     def fetch_deploy_lock
+      # Return if we know that the deploy lock has just been removed
+      return if self[:deploy_lock_removed]
+
       if self[:deploy_lock].nil?
         lock_file = capture("[ -e #{deploy_lockfile} ] && cat #{deploy_lockfile} || true").strip
         if lock_file != ""
@@ -28,6 +31,12 @@ Capistrano::Configuration.instance(:must_exist).load do
       put deploy_lock.to_yaml, deploy_lockfile, :mode => 0777
     end
 
+    def remove_deploy_lock
+      run "rm -f #{deploy_lockfile}"
+      self[:deploy_lock] = nil
+      self[:deploy_lock_removed] = true
+    end
+
     desc "Deploy with a custom deploy lock"
     task :with_lock do
       lock
@@ -37,6 +46,7 @@ Capistrano::Configuration.instance(:must_exist).load do
     desc "Set deploy lock with a custom lock message and expiry time"
     task :lock do
       set :lock_message, Capistrano::CLI.ui.ask("Lock Message: ")
+      set :custom_deploy_lock, true
 
       while self[:lock_expiry].nil?
         expiry_str = Capistrano::CLI.ui.ask("Expire lock at? (optional): ")
@@ -60,13 +70,12 @@ Capistrano::Configuration.instance(:must_exist).load do
       end
 
       create_lock
-      set :custom_deploy_lock, true
     end
 
     desc "Creates a lock file, so that futher deploys will be prevented"
     task :create_lock do
-      if self[:custom_deploy_lock]
-        logger.info 'Custom deploy lock already created.'
+      if self[:deploy_lock]
+        logger.info 'Deploy lock already created.'
         next
       end
 
@@ -77,13 +86,16 @@ Capistrano::Configuration.instance(:must_exist).load do
         set :lock_expiry, (Time.now + default_lock_expiry).utc
       end
 
-      deploy_lock = {
+      deploy_lock_data = {
         :created_at => Time.now.utc,
         :username   => ENV['USER'],
         :expire_at  => self[:lock_expiry],
-        :message    => self[:lock_message]
+        :message    => self[:lock_message],
+        :custom     => !!self[:custom_deploy_lock]
       }
-      write_deploy_lock(deploy_lock)
+      write_deploy_lock(deploy_lock_data)
+
+      self[:deploy_lock] = deploy_lock_data
     end
 
     namespace :unlock do
@@ -93,37 +105,40 @@ Capistrano::Configuration.instance(:must_exist).load do
         if self[:custom_deploy_lock]
           logger.info 'Not removing custom deploy lock.'
         else
-          force
+          remove_deploy_lock
         end
       end
 
       task :force do
-        run "rm -f #{deploy_lockfile}"
+        remove_deploy_lock
       end
     end
 
     desc "Checks for a deploy lock. If present, deploy is aborted and message is displayed. Any expired locks are deleted."
     task :check_lock do
       # Don't check the lock if we just created it
-      next if self[:custom_deploy_lock]
+      next if self[:deploy_lock]
 
       fetch_deploy_lock
       # Return if no lock
       next unless self[:deploy_lock]
 
       if deploy_lock[:expire_at] && deploy_lock[:expire_at] < Time.now
-        logger.info "Deleting expired deploy lock..."
-        unlock
+        logger.info Capistrano::DeployLock.expired_message(application, stage, deploy_lock)
+        remove_deploy_lock
         next
       end
 
+      # Check if lock is a custom lock
+      self[:custom_deploy_lock] = deploy_lock[:custom]
+
       # Unexpired lock is present, so display the lock message
       logger.important Capistrano::DeployLock.message(application, stage, deploy_lock)
 
-      # Don't raise exception if current user owns the lock.
-      # Just sleep so they have a chance to Ctrl-C
-      if deploy_lock[:username] == ENV['USER']
-        4.downto(1) do |i|
+      # Don't raise exception if current user owns the lock, and lock has an expiry time.
+      # Just sleep for a few seconds so they have a chance to cancel the deploy with Ctrl-C
+      if deploy_lock[:expire_at] && deploy_lock[:username] == ENV['USER']
+        5.downto(1) do |i|
           Kernel.print "\rDeploy lock was created by you (#{ENV['USER']}). Continuing deploy in #{i}..."
           sleep 1
         end
@@ -135,22 +150,23 @@ Capistrano::Configuration.instance(:must_exist).load do
 
     desc "Refreshes an existing deploy lock's expiry time, if it is less than the default time"
     task :refresh_lock do
-      # Don't refresh custom locks
-      next if self[:custom_deploy_lock]
-
       fetch_deploy_lock
       next unless self[:deploy_lock]
 
-      # Refresh lock expiry time if it's going to expire soon
+      # Don't refresh custom locks
+      if deploy_lock[:custom]
+        logger.info 'Not refreshing custom deploy lock.'
+        next
+      end
+
+      # Refresh lock expiry time if it's going to expire
       if deploy_lock[:expire_at] && deploy_lock[:expire_at] < (Time.now + default_lock_expiry)
         logger.info "Resetting lock expiry to default..."
+        deploy_lock[:username]  = ENV['USER']
         deploy_lock[:expire_at] = (Time.now + default_lock_expiry).utc
 
         write_deploy_lock(deploy_lock)
       end
-
-      # Set the deploy_lock_created flag so that the lock isn't automatically removed after deploy
-      set :custom_deploy_lock, true
     end
   end
 end

data/lib/capistrano_deploy_lock/version.rb

@@ -1,3 +1,3 @@
 module CapistranoDeployLock
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano_deploy_lock
 version: !ruby/object:Gem::Version
-  version: 1.1.0
-  prerelease: 
+  version: 1.2.0
 platform: ruby
 authors:
 - Nathan Broadbent
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-16 00:00:00.000000000 Z
+date: 2013-09-12 00:00:00.000000000 Z
 dependencies: []
 description: Lock a server during deploy, to prevent people from deploying at the
   same time.
@@ -35,32 +34,25 @@ files:
 homepage: https://github.com/ndbroadbent/capistrano_deploy_lock
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2094697491794115315
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2094697491794115315
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Capistrano Deploy Lock
 test_files: []