caplock 0.2.0 → 0.3.1

data/README.rdoc

@@ -15,6 +15,13 @@ Include in your Capfile
 Define the name of your lock file in your deploy.rb
    set :lockfile, "my.lock" # defaults to "cap.lock"
 
+The `lock:check` task is executed automatically before `deploy:update_code` (i.e. before deploy).
+If you have overridden the default deploy task, you may need to add the task with:
+   before "deploy", "lock:check"
+
+If the lockfile becomes stale (because you interrupted the deployment with CTRL-C for example)
+   cap lock:release  # or "cap production lock:release" with multistage
+
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/Rakefile

@@ -9,7 +9,7 @@ begin
     gem.description = %Q{Adds a lock file to Capistrano deployments to prevent concurrent deployments.}
     gem.email = "Druwerd@gmail.com"
     gem.homepage = "http://github.com/Druwerd/caplock"
-    gem.authors = ["Dru Ibarra"]
+    gem.authors = ["Dru Ibarra", "Giorgio Premi"]
     gem.add_dependency "capistrano", '>= 2.9.0'
     gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
@@ -43,9 +43,9 @@ task :test => :check_dependencies
 
 task :default => :test
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION').strip : ""
 
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "caplock #{version}"

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.1

data/caplock.gemspec

@@ -4,14 +4,14 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{caplock}
-  s.version = "0.2.0"
+  s.name = "caplock"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = [%q{Dru Ibarra}]
-  s.date = %q{2012-03-09}
-  s.description = %q{Adds a lock file to Capistrano deployments to prevent concurrent deployments.}
-  s.email = %q{Druwerd@gmail.com}
+  s.authors = ["Dru Ibarra", "Giorgio Premi"]
+  s.date = "2014-07-08"
+  s.description = "Adds a lock file to Capistrano deployments to prevent concurrent deployments."
+  s.email = "Druwerd@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE",
     "README.rdoc"
@@ -27,10 +27,10 @@ Gem::Specification.new do |s|
     "test/helper.rb",
     "test/test_caplock.rb"
   ]
-  s.homepage = %q{http://github.com/Druwerd/caplock}
-  s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.6}
-  s.summary = %q{Adds a lock file to Capistrano deployments}
+  s.homepage = "http://github.com/Druwerd/caplock"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.23"
+  s.summary = "Adds a lock file to Capistrano deployments"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/lib/caplock.rb

@@ -2,11 +2,13 @@ require 'capistrano'
 
 module Capistrano
   module Caplock
-  
+
+    class LockedDeployError < RuntimeError ; end
+
     # Returns Boolean indicating the result of +filetest+ on +full_path+ on the server, evaluated by shell on 
     # the server (usually bash or something roughly compatible).
     def remote_filetest_passes?(filetest, full_path)
-      'true' ==  capture("if [ #{filetest} #{full_path} ]; then echo 'true'; fi").strip
+      'true' ==  top.capture("if [ #{filetest} #{full_path} ]; then echo 'true'; fi").strip
     end
   
     # Checks if a symlink exists on the remote machine.
@@ -23,7 +25,7 @@ module Capistrano
     # is equivalent to content by checking whether or not the MD5 of the remote content is the same as the
     # MD5 of the String in +content+.
     def remote_file_content_same_as?(full_path, content)
-      Digest::MD5.hexdigest(content) == capture("md5sum #{full_path} | awk '{ print $1 }'").strip
+      Digest::MD5.hexdigest(content) == top.capture("md5sum #{full_path} | awk '{ print $1 }'").strip
     end
 
     # Returns Boolean indicating whether the remote file is present and has the same contents as
@@ -35,12 +37,16 @@ module Capistrano
     def self.load_into(configuration)
       configuration.load do
         set :lockfile, "cap.lock"
-        
+
+        # internal
+        set :keep_lock, false
+
         namespace :lock do
           desc "check lock"
           task :check, :roles => :app do
             if caplock.remote_file_exists?("#{deploy_to}/#{lockfile}")
-              abort "\n\n\n\e[0;31m A Deployment is already in progress\n Remove #{deploy_to}/#{lockfile} to unlock  \e[0m\n\n\n"
+              keep_lock = true
+              raise LockedDeployError, "\n\n\n\e[0;31m A Deployment is already in progress\n Remove #{deploy_to}/#{lockfile} to unlock  \e[0m\n\n\n"
             end
           end
 
@@ -49,16 +55,17 @@ module Capistrano
             timestamp = Time.now.strftime("%m/%d/%Y %H:%M:%S %Z")
             lock_message = "Deploy started at #{timestamp} in progress"
             put lock_message, "#{deploy_to}/#{lockfile}", :mode => 0644
+            on_rollback { find_and_execute_task("lock:release") }
           end
 
           desc "release lock"
           task :release, :roles => :app do
-             run "rm -f #{deploy_to}/#{lockfile}"
+             run "rm -f #{deploy_to}/#{lockfile}" unless keep_lock
           end
         end
 
         # Deployment
-        before "deploy", "lock:check"
+        before "deploy:update_code", "lock:check"
         after "lock:check", "lock:create"
         after "deploy", "lock:release"
 
@@ -76,4 +83,4 @@ end
 
 if Capistrano::Configuration.instance
   Capistrano::Caplock.load_into(Capistrano::Configuration.instance)
-end
+end

data/test/test_caplock.rb

@@ -1,13 +1,44 @@
 require 'helper'
 
+class StubLogger
+  def close ; end
+  def log(level, message, line_prefix=nil) ; end
+  def important(message, line_prefix=nil) ; end
+  def info(message, line_prefix=nil) ; end
+  def debug(message, line_prefix=nil) ; end
+  def trace(message, line_prefix=nil); end
+  def format(message, color, style, nl = "\n") ; end
+end
+
 class TestCaplock < Test::Unit::TestCase
+  class TestCaplockError < RuntimeError ; end
+
   def setup
+    @update_code_raise = false;
     @config = Capistrano::Configuration.new
+    @config.load do
+      namespace :deploy do
+        task :default do
+          transaction do
+            update_code
+          end
+        end
+        task :update_code do
+          raise TestCaplockError, "update_code simulated exception" if caplock_update_code_raise
+        end
+      end
+    end
+    @config.logger = StubLogger.new
+    #@config.logger = Capistrano::Logger.new :level => Capistrano::Logger::MAX_LEVEL
     Capistrano::Caplock.load_into(@config)
     @config.set :deploy_to, "/tmp"
+    @config.set :caplock_update_code_raise, false
     @config.role :app, "localhost"
+
+    # ensure clean test
+    File.unlink("/tmp/cap.lock") if File.exists?("/tmp/cap.lock")
   end
-  
+
   should "use default lockfile name 'cap.lock'" do
     assert_equal @config.lockfile, 'cap.lock'
   end
@@ -32,4 +63,36 @@ class TestCaplock < Test::Unit::TestCase
      assert_nil @config.lock.release
      assert_nil @config.lock.check
   end
+  
+  should "check for lock and abort" do
+     assert_nil @config.lock.create
+     assert_raises(Capistrano::Caplock::LockedDeployError) { @config.lock.check }
+  end
+  
+  should "check if remote file exists" do
+     @config.set :lockfile, 'test.lock'
+     assert_nil @config.lock.create
+     assert @config.caplock.remote_file_exists?("/tmp/test.lock")
+  end
+
+  should "remove lock on rollback" do
+    @config.set :caplock_update_code_raise, true
+    assert_raises(TestCaplockError) { @config.deploy.default }
+    assert_nil @config.lock.check
+  end
+
+  should "not remove lock owned by other process" do
+    File.open("/tmp/cap.lock", "w") { |file| file.write("Simulate cap.lock from another deploy process") }
+    assert File.exists?("/tmp/cap.lock")
+    assert_raises(Capistrano::Caplock::LockedDeployError) { @config.deploy.default }
+    # rollback should not have removed the file, so it is still locked
+    assert_raises(Capistrano::Caplock::LockedDeployError) { @config.lock.check }
+  end
+
+  should "remove lock owned by other process on manual release" do
+    File.open("/tmp/cap.lock", "w") { |file| file.write("Simulate cap.lock from another deploy process") }
+    assert File.exists?("/tmp/cap.lock")
+    assert_nil @config.lock.release
+    assert_nil @config.lock.check
+  end
 end

metadata

@@ -1,62 +1,57 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: caplock
-version: !ruby/object:Gem::Version 
-  hash: 23
+version: !ruby/object:Gem::Version
+  version: 0.3.1
   prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 0
-  version: 0.2.0
 platform: ruby
-authors: 
+authors:
 - Dru Ibarra
+- Giorgio Premi
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-03-09 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: capistrano
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 43
-        segments: 
-        - 2
-        - 9
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.9.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: thoughtbot-shoulda
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+- !ruby/object:Gem::Dependency
+  name: thoughtbot-shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Adds a lock file to Capistrano deployments to prevent concurrent deployments.
 email: Druwerd@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - README.rdoc
-files: 
+files:
 - .document
 - LICENSE
 - README.rdoc
@@ -68,36 +63,26 @@ files:
 - test/test_caplock.rb
 homepage: http://github.com/Druwerd/caplock
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Adds a lock file to Capistrano deployments
 test_files: []
-