capistrano-deploy-lock 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d4652733e283c12103ecd2b697180b3ff456779
+  data.tar.gz: f95004d72cf11976f3239df1479cb6e41d11cb5f
+SHA512:
+  metadata.gz: e493cdfeb9e74fcc287ffc3dfda4036bee1849eec3f3040fba4809cdf4bf9f5cb2b9e62a9c9a72cec3dceb45354edb4adff5d728dec7f6d487acc845cf9cb4b5
+  data.tar.gz: ff6eeb61f098a5b7eb1a89becd4ecfc024e53a203520e10e03371b8fd7ababc43f03c6f6fcc2ff4973eabda2f720d7f44c9fb81fd9b6daaacfa48ff9a40c2060

data/.gitignore

@@ -0,0 +1 @@
+nbproject/

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+# Cap Deploy Lock Change log
+

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Maruf Hasan Bulbul
+
+MIT License
+
+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.md

@@ -0,0 +1,42 @@
+# Cap Deploy Lock 1.0.0
+
+Deploy Lock feature for Capistrano 3.x
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capistrano-deploy-lock', '~> 1.0'
+    gem 'capistrano'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install capistrano-deploy-lock
+
+## Usage
+
+Require in `Capfile` to use the default task:
+
+```ruby
+require 'capistrano/deploy-lock'
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Credits
+
+cap-deploy-lock is maintained by [Maruf Hasan Bulbul](http://www.mhbweb.com).
+
+## License
+
+© 2016 Maruf Hasan Bulbul. It is free software and may be redistributed under the terms specified in the LICENSE file.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/capistrano-deploy-lock.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-deploy-lock"
+  spec.version       = "1.0.0"
+  spec.authors       = ["Maruf Hasan Bulbul"]
+  spec.email         = ["mhb.cse@gmail.com"]
+  spec.summary       = %q{Deploy lock feature for Capistrano 3.x}
+  spec.description   = %q{Lock deploy when one deployment is running.}
+  spec.homepage      = "https://github.com/maruf-freelancer/capistrano-deploy-lock"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'capistrano', '~> 3.4'
+
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/capistrano/deploy-lock.rb

@@ -0,0 +1 @@
+load File.expand_path('../tasks/deploy-lock.rake', __FILE__)

data/lib/capistrano/tasks/deploy-lock.rake

@@ -0,0 +1,215 @@
+set :deploy_lock_file, -> { File.join(shared_path, "deploy-lock.yml") }
+set :deploy_lock_roles, -> { :app }
+set :deploy_lock_rack_env, -> { fetch(:rails_env) == "development" ? "development" : "deployment" }
+set :default_lock_expiry, (15 * 60)
+set :deploy_lock, false
+set :lock_message, nil
+set :lock_expiry, nil
+
+namespace :deploy do
+  
+  desc "Deploy with a custom deploy lock"
+  task :with_lock do
+    on roles(fetch(:deploy_lock_roles)) do
+      with rails_env: fetch(:deploy_lock_rack_env) do
+        invoke 'deploy:lock'
+        invoke 'deploy'
+      end
+    end
+  end
+  
+  desc "Set deploy lock with a custom lock message and expiry time"
+  task :lock do
+    on roles(fetch(:deploy_lock_roles)) do
+      with rails_env: fetch(:deploy_lock_rack_env) do
+        set :custom_deploy_lock, true
+        set :lock_message, ask('lock message', '', echo: true)
+        puts "Lock message: #{fetch(:lock_message)}"
+
+        while fetch(:lock_expiry).nil?
+          set :expire_after, ask('minutes of expiry', 'optional', echo: true) 
+          expire_after = fetch(:expire_after)
+          
+          if expire_after == "optional"
+            # Never expire an explicit lock if no time given
+            set :lock_expiry, false
+            puts colorize("Lock will never expire automatically.", color: 33)
+          else
+            unless expire_after.to_i == 0
+              set :lock_expiry, (Time.now + expire_after.to_i * 60).utc
+              puts colorize("Expire after #{fetch(:expire_after)} minutes", color: 33)
+            else
+              puts colorize("'#{expire_after}' is not valid input. Please try again.")
+            end
+          end
+        end
+    
+        invoke 'deploy:create_lock'
+      end
+    end
+  end
+  
+  desc "Creates a lock file, so that futher deploys will be prevented"
+  task :create_lock do 
+    on roles(fetch(:deploy_lock_roles)) do
+      with rails_env: fetch(:deploy_lock_rack_env) do
+        if fetch(:deploy_lock)
+          puts colorize('Deploy lock already created.', color: 33)
+          next
+        end
+
+        if fetch(:lock_message).nil?
+          set :lock_message, "Deploying #{fetch(:branch)} branch in #{fetch(:rails_env)}"
+        end
+        
+        if fetch(:lock_expiry).nil?
+          set :lock_expiry, (Time.now + fetch(:default_lock_expiry)).utc
+        end
+
+        deploy_lock_data = {
+          created_at: Time.now.utc,
+          username: ENV['USER'],
+          expire_at: fetch(:lock_expiry),
+          message: fetch(:lock_message).to_s,
+          custom: !!fetch(:custom_deploy_lock)
+        }
+        
+        write_deploy_lock(deploy_lock_data)
+        set :deploy_lock, deploy_lock_data
+      end
+    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 
+    on roles(fetch(:deploy_lock_roles)) do
+      with rails_env: fetch(:deploy_lock_rack_env) do
+        # Don't check the lock if we just created it
+        next if fetch(:deploy_lock)
+
+        fetch_deploy_lock
+        
+        # Return if no lock
+        next unless fetch(:deploy_lock)
+
+        deploy_lock = fetch(:deploy_lock)
+        
+        if deploy_lock[:expire_at] && deploy_lock[:expire_at] < Time.now
+          remove_deploy_lock
+          next
+        end
+
+        # Check if lock is a custom lock
+        set :custom_deploy_lock, deploy_lock[:custom]
+
+        # Unexpired lock is present, so display the lock message
+        puts message(fetch(:application), fetch(:stage), deploy_lock)
+
+        # 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']
+          10.downto(1) do |i|
+            Kernel.print "\r\e[0;33mDeploy lock was created by you (#{ENV['USER']}). Continuing deploy in #{i}...\e[0m"
+            sleep 1
+          end
+          puts
+        else
+          exit 1
+        end
+      end
+    end
+  end
+  
+  namespace :unlock do
+    desc "Unlocks the server for deployment"
+    task :default do
+      on roles(fetch(:deploy_lock_roles)) do
+        with rails_env: fetch(:deploy_lock_rack_env) do
+          # Don't automatically remove custom deploy locks created by deploy:lock task
+          if fetch(:custom_deploy_lock)
+            puts colorize('Not removing custom deploy lock.', color: 33)
+          else
+            remove_deploy_lock
+            puts colorize("Deploy unlocked.", color: 32)
+          end
+        end
+      end
+    end
+
+    task :force do
+      on roles(fetch(:deploy_lock_roles)) do
+        with rails_env: fetch(:deploy_lock_rack_env) do
+          remove_deploy_lock
+          puts colorize("Deploy unlocked.", color: 32)
+        end
+      end
+    end
+  end
+  
+  before 'deploy:started', 'check_lock' do
+    invoke 'deploy:check_lock'
+  end
+  before 'deploy:started', 'create_lock' do
+    invoke 'deploy:create_lock'
+  end
+  after 'deploy:published', 'unlock' do
+    invoke 'deploy:unlock:default'
+  end
+  after 'deploy:rollback', 'unlock' do
+    invoke 'deploy:unlock:default'
+  end
+
+end
+
+# 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 fetch(:deploy_lock_removed)
+
+  unless fetch(:deploy_lock)
+    # Check all matching servers for a deploy lock.
+    on roles(fetch(:deploy_lock_roles)).to_a, in: :parallel do |host|
+      if test("[ -f #{fetch(:deploy_lock_file)} ]")
+        system "mkdir -p tmp"
+        download! fetch(:deploy_lock_file), "tmp/deploy-lock.yml"
+        output = File.read("tmp/deploy-lock.yml")
+        system "rm -f tmp/deploy-lock.yml"
+        if output && output != ""
+          set :deploy_lock, YAML.load(output)
+          next
+        end
+      end
+    end
+  end
+end
+
+def write_deploy_lock(deploy_lock)
+  sudo %{touch #{fetch(:deploy_lock_file)}}
+  upload! StringIO.new(deploy_lock.to_yaml), fetch(:deploy_lock_file)
+end
+
+def remove_deploy_lock
+  sudo %{rm -f #{fetch(:deploy_lock_file)}}
+  set :deploy_lock, nil
+  set :deploy_lock_removed, true
+end
+
+def message(application, stage, deploy_lock)
+  message = "#{application} (#{stage}) was locked"
+  message << " at #{deploy_lock[:created_at].localtime.strftime("%c %Z")}"
+  message << " by '#{deploy_lock[:username]}'\nMessage: #{deploy_lock[:message]}"
+
+  if deploy_lock[:expire_at]
+    message << "\n\e[0;33mLock expires at #{deploy_lock[:expire_at].localtime.strftime("%H:%M:%S")}\e[0m"
+  else
+    message << "\n\e[0;33mLock must be manually removed with: cap #{stage} deploy:unlock\e[0m"
+  end
+  
+  colorize(message)
+end
+
+def colorize(text, options = {})
+  attribute = options[:attribute] || 0
+  color = options[:color] || 31
+  "\e[#{attribute};#{color}m" + text.strip + "\e[0m\n"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-deploy-lock
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Maruf Hasan Bulbul
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Lock deploy when one deployment is running.
+email:
+- mhb.cse@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-deploy-lock.gemspec
+- lib/capistrano-deploy-lock.rb
+- lib/capistrano/deploy-lock.rb
+- lib/capistrano/tasks/deploy-lock.rake
+homepage: https://github.com/maruf-freelancer/capistrano-deploy-lock
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Deploy lock feature for Capistrano 3.x
+test_files: []