gnm-caplock 0.2.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Dru Ibarra
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,30 @@
+= gnm-caplock
+
+Adds a lock file to Capistrano deployments.
+
+== Installation
+
+   $ gem install caplock
+   
+Include in your Capfile
+    require 'rubygems'
+    require 'caplock'
+    
+== Usage
+
+Define the name of your lock file in your deploy.rb
+   set :lockfile, "my.lock" # defaults to "cap.lock"
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2012 Dru Ibarra. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "gnm-caplock"
+    gem.summary = %Q{Adds a lock file to Capistrano deployments}
+    gem.description = %Q{Adds a lock file to Capistrano deployments to prevent concurrent deployments.}
+    gem.email = "ConfigurationManagement@gorillanation.com"
+    gem.homepage = "https://github.com/GorillaNation/gnm-caplock"
+    gem.authors = ["Dru Ibarra"]
+    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
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "gnm-caplock #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/gnm-caplock.gemspec

@@ -0,0 +1,50 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{gnm-caplock}
+  s.version = "0.2.0"
+
+  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-20}
+  s.description = %q{Adds a lock file to Capistrano deployments to prevent concurrent deployments.}
+  s.email = %q{ConfigurationManagement@gorillanation.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "gnm-caplock.gemspec",
+    "lib/gnm-caplock.rb",
+    "test/helper.rb",
+    "test/test_caplock.rb"
+  ]
+  s.homepage = %q{https://github.com/GorillaNation/gnm-caplock}
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.6}
+  s.summary = %q{Adds a lock file to Capistrano deployments}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<capistrano>, [">= 2.9.0"])
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<capistrano>, [">= 2.9.0"])
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<capistrano>, [">= 2.9.0"])
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/lib/gnm-caplock.rb

@@ -0,0 +1,79 @@
+require 'capistrano'
+
+module Capistrano
+  module Caplock
+  
+    # 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
+    end
+  
+    # Checks if a symlink exists on the remote machine.
+    def remote_symlink_exists?(full_path)
+      remote_filetest_passes?('-L', full_path)
+    end
+  
+    # Returns Boolean value indicating whether file exists on server
+    def remote_file_exists?(full_path)
+      remote_filetest_passes?('-e', full_path)
+    end
+
+    # Returns Boolean value indicating whether the file at +full_path+ matches +content+.  Checks if file
+    # 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
+    end
+
+    # Returns Boolean indicating whether the remote file is present and has the same contents as
+    # the String in +content+.
+    def remote_file_differs?(full_path, content)
+      !remote_file_exists?(full_path) || remote_file_exists?(full_path) && !remote_file_content_same_as?(full_path, content)
+    end
+    
+    def self.load_into(configuration)
+      configuration.load do
+        set :lockfile, "cap.lock"
+        
+        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"
+            end
+          end
+
+          desc "create lock"
+          task :create, :roles => :app do
+            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
+          end
+
+          desc "release lock"
+          task :release, :roles => :app do
+             run "rm -f #{deploy_to}/#{lockfile}"
+          end
+        end
+
+        # Deployment
+        before "deploy", "lock:check"
+        after "lock:check", "lock:create"
+        after "deploy", "lock:release"
+
+        # Rollback
+        before "deploy:rollback", "lock:check"
+        after "deploy:rollback", "lock:release"
+        
+      end
+    end
+    
+    Capistrano.plugin :caplock, Caplock
+    
+  end
+end
+
+if Capistrano::Configuration.instance
+  Capistrano::Caplock.load_into(Capistrano::Configuration.instance)
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'caplock'
+
+class Test::Unit::TestCase
+end

data/test/test_caplock.rb

@@ -0,0 +1,47 @@
+require 'helper'
+
+class TestCaplock < Test::Unit::TestCase
+  def setup
+    @config = Capistrano::Configuration.new
+    Capistrano::Caplock.load_into(@config)
+    @config.set :deploy_to, "/tmp"
+    @config.role :app, "localhost"
+  end
+  
+  should "use default lockfile name 'cap.lock'" do
+    assert_equal @config.lockfile, 'cap.lock'
+  end
+  
+  should "set lockfile name to 'test.lock'" do
+    @config.set :lockfile, 'test.lock'
+    assert_equal @config.lockfile, 'test.lock'
+  end
+  
+  should "create lock" do
+     assert_nil @config.lock.create
+     assert File.exists?("/tmp/cap.lock")
+  end
+  
+  should "remove lock" do
+     assert_nil @config.lock.create
+     assert_nil @config.lock.release
+     assert !File.exists?("/tmp/cap.lock")
+  end
+  
+  should "check for lock and pass" do
+     assert_nil @config.lock.release
+     assert_nil @config.lock.check
+  end
+  
+  # FIXME: need to find a way to test 'abort'
+  should "check for lock and abort" do
+     assert_nil @config.lock.create
+     #assert_raises SystemExit, @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
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: gnm-caplock
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Dru Ibarra
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-20 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: capistrano
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 2
+        - 9
+        - 0
+        version: 2.9.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Adds a lock file to Capistrano deployments to prevent concurrent deployments.
+email: ConfigurationManagement@gorillanation.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- gnm-caplock.gemspec
+- lib/gnm-caplock.rb
+- test/helper.rb
+- test/test_caplock.rb
+homepage: https://github.com/GorillaNation/gnm-caplock
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Adds a lock file to Capistrano deployments
+test_files: []
+