capistrano-deploy_locker 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7ddff18ae5088deb7d0338f7b49410b39a05d169
+  data.tar.gz: fe7ac69700f0ba6bd278db44df3ee795861ae431
+SHA512:
+  metadata.gz: 23928bd1519b9b4d35628aed7c2245375530d92b081a1495dd1ba115da1cd7ad644025cced6166383a6e5cae1999c6d1108e9000a9a1bfe90d2a43feca1702e2
+  data.tar.gz: d1b639908264163ddc729d8e7f4c752d281eef9a33f76335b82e85460073f4dd4ffb4a15530e72079cde06e7eda4f2b97a99bf2259d5079f63ce935673e0be57

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.sw[pon]
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,12 @@
+sudo: false
+language: ruby
+rvm:
+- 2.0.0
+- 2.1.8
+- 2.2.0
+before_install: gem install bundler -v 1.14.6
+install: bundle _1.14.6_ install
+script: bundle _1.14.6_ exec rake spec
+notifications:
+  slack:
+    secure: MaiWfXSv4HSSOCYHunEuFIyVEhCaw/uhjWjSsZYDJSiGXcSYPrDfY4L3ccCkAM0j3EueNfxK5rh+aN8f5b0fAFTapmnHlBTlK0prb78kJCDuoxHFKjH5GWQL5UmyPftvr/V1ydtq8PJMMI+Hd4ui1NqE/LbMWdABsznssXM+wVs5yYaf+R4NxSE6nQPQdTAFEjzwXfHq0xmKcvLWKkxjuJSr503FgEdaYxVXndhz0wmsSWH/F/0v07rz75jzmlCJOIqU2zQ/dCZxEouZuq+beHemyT4BQkxj0ashhaHo1R6evBsg3TwxC+gBt8IvoPS7UaJyJbJYMgRezRezMWkUcH8o/cIQ4cHd0l9H/ZAR7WETN1uISvTFUVELFMYLg4vWIH3JJaXpy4YNn7hB/hXU44RBdZdwWhY1IcneN/kXydTRalq2rrl84YyoEp51qjH/f7GenR4K6UNL5ZYGqNxllPdD3vf7+ulGoGcRIc7uxfrIs/qhjNXYrHKSUUo1t/MQmomeWnLgIzz1MBHID6qW4yskw8Vy5YIr8crE8YzRBO5jQ1n1wOL6yiKdGgkBTRPM26GEDmO0kT51os+3AxMqPdtskNv5nolHiJyxNlDFJcj4gDmKstjA6DOrWvXtP4EYdZex3CFXlIwtNRrqjWINicPtHIlJOqngC94WP63vMDg=

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.3.0 (2017/4/12)
+
+Initial release.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano-deploy_locker.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 DeNA Co., Ltd., IKEDA Kiyoshi
+
+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,69 @@
+[![Gem Version](https://badge.fury.io/rb/capistrano-deploy_locker.svg)](https://badge.fury.io/rb/capistrano-deploy_locker)
+[![Build Status](https://travis-ci.org/DeNADev/capistrano-deploy_locker.svg?branch=master)](https://travis-ci.org/DeNADev/capistrano-deploy_locker)
+# Capistrano::DeployLocker
+
+A capistrano plugin to make deployment with exclusive lock.
+
+In other words, this protects any two processes from running `cap deploy`
+command at the same time.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-deploy_locker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-deploy_locker
+
+
+## Configuration
+
+Set Capistrano variables with `set name, value`.
+
+Name | Default | Description
+-----|---------|------------
+deploy_lock_key |  `"#{fetch(:application)}.#{fetch(:stage)}"` | String to specify lock target
+deploy_lock_dir | `./.lock` | Directory to write lockfile or other info
+deploy_lock_user | `ENV['USER'] || ENV['LOGIN']` | Who locks deploy
+deploy_lock_reason | `"#{$0} #{ARGV}"` | Why deploy is locked
+
+You can provide `:deploy_lock_user` and `:deploy_lock_reason` to show infomation
+of your deployment for other operators who try to get lock in fail.
+
+## Usage
+
+Edit Capfile:
+
+```ruby
+# Load DSL and Setup Up Stages
+require 'capistrano/setup'
+
+# Includes default deployment tasks
+require 'capistrano/deploy'
+
+# Includes tasks from other gems included in your Gemfile
+require 'capistrano/deploy_locker'
+```
+
+Edit your `config/deploy.rb`:
+
+```ruby
+before 'deploy:starting', 'deploy:lock'
+after 'deploy:finished', 'deploy:unlock'
+after 'deploy:failed', 'deploy:unlock'
+```
+
+## License
+
+Available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+Copyright (c) 2017 DeNA Co., Ltd., IKEDA Kiyoshi
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/capistrano-deploy_locker.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/deploy_locker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capistrano-deploy_locker'
+  spec.version       = Capistrano::DeployLocker::VERSION
+  spec.authors       = ['progrhyme']
+
+  spec.summary       = 'Capistrano Plugin to Lock Deployment'
+  spec.description   = 'A capistrano 3 plugin which provides locking feature for deployment'
+  spec.homepage      = 'https://github.com/DeNADev/capistrano-deploy_locker'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'capistrano'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/lib/capistrano/deploy_locker.rb

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

data/lib/capistrano/deploy_locker/base.rb

@@ -0,0 +1,29 @@
+require 'fileutils'
+require 'forwardable'
+require 'json'
+require 'capistrano/configuration'
+
+module Capistrano
+  module DeployLocker
+    require 'capistrano/deploy_locker/provider'
+    require 'capistrano/deploy_locker/config'
+    require 'capistrano/deploy_locker/version'
+
+    class << self
+      extend ::Forwardable
+      def_delegator :provider, :locked?
+      def_delegator :provider, :create, :lock
+      def_delegator :provider, :clear, :unlock
+    end
+
+    class AlreadyLocked < ::StandardError; end
+
+    def self.provider
+      @provider ||= Capistrano::DeployLocker::Provider.new
+    end
+
+    def self.config
+      @config ||= Capistrano::DeployLocker::Config.new
+    end
+  end
+end

data/lib/capistrano/deploy_locker/config.rb

@@ -0,0 +1,27 @@
+require 'capistrano/deploy_locker/base'
+
+class Capistrano::DeployLocker::Config
+  extend ::Forwardable
+  def_delegator :@env, :fetch
+
+  def initialize(env = Capistrano::Configuration.env)
+    @env = env
+  end
+
+  def lock_key
+    @lock_key ||= fetch(:deploy_lock_key, nil)
+    @lock_key ||= [fetch(:application), fetch(:stage)].join('.')
+  end
+
+  def lock_dir
+    @lock_dir ||= fetch(:deploy_lock_dir, File.join(Dir.pwd, '.lock'))
+  end
+
+  def who
+    @who ||= fetch(:deploy_lock_user, ENV['USER'] || ENV['LOGIN'] || Etc.getlogin || Etc.getpwuid.name)
+  end
+
+  def why
+    @why ||= fetch(:deploy_lock_reason, "#{$PROGRAM_NAME} #{ARGV.join(' ')}")
+  end
+end

data/lib/capistrano/deploy_locker/provider.rb

@@ -0,0 +1,60 @@
+require 'capistrano/deploy_locker/base'
+
+class Capistrano::DeployLocker::Provider
+  def initialize(config = Capistrano::DeployLocker.config)
+    @config = config
+    FileUtils.mkpath(config.lock_dir)
+  end
+
+  def locked?
+    locked = false
+    File.open(lock_file, File::RDWR | File::CREAT, 0o0644) do |f|
+      locked = true unless f.flock(File::LOCK_EX | File::LOCK_NB)
+    end
+    locked
+  end
+
+  def create
+    @lock_file = File.open(lock_file, File::RDWR | File::CREAT, 0o0644)
+    unless @lock_file.flock(File::LOCK_EX | File::LOCK_NB)
+      @lock_file.close
+      message = "#{lock_file} is already locked!\n"
+      if i = info
+        message << "Info: #{i}"
+      else
+        message << 'No additional info available.'
+      end
+      raise Capistrano::DeployLocker::AlreadyLocked, message
+    end
+    update_info
+  end
+
+  def clear
+    @lock_file.flock(File::LOCK_UN | File::LOCK_NB)
+    @lock_file.close
+  end
+
+  def info
+    return unless File.readable?(info_file)
+    JSON.parse(File.read(info_file))
+  end
+
+  def update_info
+    content = {
+      user: @config.who,
+      reason: @config.why,
+      date: Time.now,
+    }.to_json
+    File.write(info_file, "#{content}\n")
+  end
+
+  private
+
+  def lock_file
+    File.join(@config.lock_dir, "#{@config.lock_key}.lock")
+  end
+
+  def info_file
+    File.join(@config.lock_dir, "#{@config.lock_key}.info")
+  end
+end

data/lib/capistrano/deploy_locker/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module DeployLocker
+    VERSION = '0.3.0'
+  end
+end

data/lib/capistrano/tasks/deploy_locker.rake

@@ -0,0 +1,32 @@
+require 'capistrano/deploy_locker/base'
+
+namespace :deploy do
+  namespace :lock do
+    task :check do
+      Capistrano::DeployLocker.locked?
+    end
+
+    task :create do
+      begin
+        Capistrano::DeployLocker.lock
+      rescue Capistrano::DeployLocker::AlreadyLocked => e
+        puts "ERROR! #{e}"
+        exit(1)
+      end
+    end
+
+    task :clear do
+      Capistrano::DeployLocker.unlock
+    end
+  end
+
+  desc 'Get lock for Deploy operation'
+  task :lock do
+    invoke 'deploy:lock:create'
+  end
+
+  desc 'Release lock for Deploy operation'
+  task :unlock do
+    invoke 'deploy:lock:clear'
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-deploy_locker
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- progrhyme
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A capistrano 3 plugin which provides locking feature for deployment
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-deploy_locker.gemspec
+- lib/capistrano-deploy_locker.rb
+- lib/capistrano/deploy_locker.rb
+- lib/capistrano/deploy_locker/base.rb
+- lib/capistrano/deploy_locker/config.rb
+- lib/capistrano/deploy_locker/provider.rb
+- lib/capistrano/deploy_locker/version.rb
+- lib/capistrano/tasks/deploy_locker.rake
+homepage: https://github.com/DeNADev/capistrano-deploy_locker
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Capistrano Plugin to Lock Deployment
+test_files: []