capistrano-unicorn-edge 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ea77bba82cc4703c42b81691b9da9cde60ef05c3
+  data.tar.gz: dfe67836b374e0b635bec316a494363d4c8593b4
+SHA512:
+  metadata.gz: 87461ffd0a9804cc42da3c3b7b8272ab280612ab6643489f64f34b7d9ce98882823ae7641488e015f8b243283df2c5920b19a288431c55f7a34855774d2da5ee
+  data.tar.gz: 3f132926442f85b297fd8df88fb4a172541350952305bd1729c576396a3b1203f9f94aa8259636d6c3e9b7dff1cb50c37a787bfa56076d4c892c918cb95267e2

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alexander Menzhinsky
+
+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,68 @@
+# Capistrano 3.x :: Unicorn
+
+Unicorn specific tasks for Capistrano 3.x
+
+```
+cap unicorn:start                  # Start unicorn
+cap unicorn:stop                   # Stop unicorn gracefully (QUIT)
+cap unicorn:shutdown               # Stop unicorn immediately (TERM)
+cap unicorn:restart                # Restart unicorn, invokes unicorn:restart_usr2
+cap unicorn:restart_hup            # Restart unicorn, when preload_app is false (HUP)
+cap unicorn:restart_usr2           # Restart unicorn, when before_fork hook is set and preload_app is true (USR2)
+cap unicorn:restart_usr2_quit      # Restart unicorn, when before_fork hook is not set and preload_app is true (USR2 + QUIT)
+cap unicorn:add_worker[count]      # Add a worker (TTIN)
+cap unicorn:remove_worker[count]   # Remove a worker (TTOU)
+cap unicorn:stop_workers           # Stop all workers but keep the master running (WINCH)
+cap unicorn:reopen_logs            # Reopen all logs owned by the master and all workers (USR1)
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-unicorn-edge', require: false, group: :development
+```
+
+And then execute:
+```
+$ bundle
+```
+
+Or install it yourself as:
+```
+$ gem install capistrano-unicorn-edge
+```
+
+## Usage
+
+Require in `Capfile` to use tasks:
+```ruby
+require 'capistrano/unicorn'
+```
+
+Configurable options:
+```ruby
+set :unicorn_pid, -> { current_path.join('tmp/pids/unicorn.pid') } # this is default
+set :unicorn_config, -> { current_path.join("config/unicorn/#{fetch(:rails_env)}.rb") } # this is default
+set :unicorn_roles, :app # this is default
+set :unicorn_options, '' # this is default
+set :unicorn_restart_delay, 5 # this is default
+set :unicorn_rack_env, :deployment # this is default
+set :unicorn_restart_method, :restart_usr2 # this is default
+```
+
+Everything should work **out-of-box** but you need to **set up unicorn's config**. (see an example `examples/unicorn.rb`).
+
+There are three different ways to restart server:
+  * `:restart_hup` reloads config file and gracefully restart all workers, if `preload_app` is true, then application code changes will have no effect
+  * `:restart_usr2_quit` re-execute the running binary and kill old instance in a time interval specified in `:unicorn_restart_delay`, but this method can't be absolutely reliable
+  * `:restart_usr2` the same as above but `before_fork` hook which kills old instance has to be set, default and the best choice
+
+## Contributing
+
+1. Fork it ( https://github.com/amenzhinsky/capistrano-unicorn-edge/fork )
+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 a new Pull Request

data/Rakefile

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

data/capistrano-unicorn.gemspec

@@ -0,0 +1,24 @@
+# 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-unicorn-edge"
+  spec.version       = "0.1.4"
+  spec.authors       = ["Alexander Menzhinsky"]
+  spec.email         = ["amenzhinsky@gmail.com"]
+  spec.summary       = %q{Unicorn support for Capistrano 3.x}
+  spec.description   = %q{Unicorn support for Capistrano 3.x}
+  spec.homepage      = "https://github.com/amenzhinsky/capistrano-unicorn-edge"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'capistrano', '~> 3.1'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/examples/unicorn.rb

@@ -0,0 +1,52 @@
+# Set your full path to application.
+app_path = '/home/deploy/web-app/current'
+
+# Set unicorn options
+worker_processes 2
+preload_app true
+check_client_connection false
+timeout 30
+
+listen "#{app_path}/tmp/sockets/unicorn.sock", backlog: 64
+listen 8888, tcp_nopush: true
+
+# Spawn unicorn master worker for user deploy (group: deploy)
+user 'deploy', 'deploy'
+
+# Fill path to your app
+working_directory app_path
+
+# Log everything to one file
+stderr_path "#{app_path}/log/unicorn.log"
+stdout_path "#{app_path}/log/unicorn.log"
+
+# Set master PID location
+pid "#{app_path}/tmp/pids/unicorn.pid"
+
+before_fork do |server, worker|
+  ##
+  # When sent a USR2, Unicorn will suffix its pidfile with .oldbin and
+  # immediately start loading up a new version of itself (loaded with a new
+  # version of our app). When this new Unicorn is completely loaded
+  # it will begin spawning workers. The first worker spawned will check to
+  # see if an .oldbin pidfile exists. If so, this means we've just booted up
+  # a new Unicorn and need to tell the old one that it can now die. To do so
+  # we send it a QUIT.
+  #
+  # Using this method we get 0 downtime deploys.
+  ActiveRecord::Base.connection.disconnect!
+
+  old_pid = "#{server.config[:pid]}.oldbin"
+
+  if File.exists?(old_pid) && server.pid != old_pid
+    begin
+      Process.kill("QUIT", File.read(old_pid).to_i)
+    rescue Errno::ENOENT, Errno::ESRCH
+      # someone else did our job for us
+    end
+  end
+end
+
+after_fork do |server, worker|
+  ActiveRecord::Base.establish_connection
+end

data/lib/capistrano/tasks/unicorn.cap

@@ -0,0 +1,124 @@
+namespace :unicorn do
+  desc 'Start unicorn'
+  task :start do
+    on roles(fetch(:unicorn_roles)) do
+      unicorn_start unless unicorn_is_running?
+    end
+  end
+
+  desc 'Stop unicorn gracefully (QUIT)'
+  task :stop do
+    on roles(fetch(:unicorn_roles)) do
+      unicorn_send_signal(:QUIT) if unicorn_is_running?
+    end
+  end
+
+  desc 'Stop unicorn immediately (TERM)'
+  task :shutdown do
+    on roles(fetch(:unicorn_roles)) do
+      unicorn_send_signal('TERM') if unicorn_is_running?
+    end
+  end
+
+  desc 'Restart unicorn'
+  task :restart do
+    invoke "unicorn:#{fetch(:unicorn_restart_method)}"
+  end
+
+  desc 'Restart unicorn, when preload_app is false (HUP)'
+  task :restart_hup do
+    on roles(fetch(:unicorn_roles)) do
+      if unicorn_is_running?
+        unicorn_send_signal(:HUP)
+      else
+        unicorn_start
+      end
+    end
+  end
+
+  desc 'Restart unicorn, when before_fork hook is set and preload_app is true (USR2)'
+  task :restart_usr2 do
+    on roles(fetch(:unicorn_roles)) do
+      if unicorn_is_running?
+        unicorn_send_signal(:USR2)
+      else
+        unicorn_start
+      end
+    end
+  end
+
+  desc 'Restart unicorn, when before_fork hook is not set and preload_app is true (USR2 + QUIT)'
+  task :restart_usr2_quit do
+    on roles(fetch(:unicorn_roles)) do
+      if unicorn_is_running?
+        unicorn_send_signal(:USR2)
+
+        execute :sleep, fetch(:unicorn_restart_delay)
+
+        if unicorn_is_running?(unicorn_old_pid)
+          unicorn_send_signal(:QUIT, unicorn_old_pid)
+        end
+      else
+        unicorn_start
+      end
+    end
+  end
+
+  desc 'Add a worker (TTIN)'
+  task :add_worker, :count do |_, args|
+    on roles(fetch(:unicorn_roles)) do
+      if unicorn_is_running?
+        args.fetch(:count, 1).to_i.times do
+          unicorn_send_signal(:TTIN)
+        end
+      else
+        error 'unicorn is not running'
+      end
+    end
+  end
+
+  desc 'Remove a worker (TTOU)'
+  task :remove_worker, :count do |_, args|
+    on roles(fetch(:unicorn_roles)) do
+      if unicorn_is_running?
+        args.fetch(:count, 1).to_i.times do
+          unicorn_send_signal(:TTOU)
+        end
+      else
+        error 'unicorn is not running'
+      end
+    end
+  end
+
+  desc 'Stop all workers but keep the master running (WINCH)'
+  task :stop_workers do
+    if unicorn_is_running?
+      unicorn_send_signal(:WINCH)
+    else
+      error 'unicorn is not running'
+    end
+  end
+
+  desc 'Reopen all logs owned by the master and all workers (USR1)'
+  task :reopen_logs do
+    if unicorn_is_running?
+      unicorn_send_signal(:USR1)
+    else
+      error 'unicorn is not running'
+    end
+  end
+end
+
+namespace :load do
+  task :defaults do
+    set :unicorn_pid, -> { current_path.join('tmp/pids/unicorn.pid') }
+    set :unicorn_config, -> { current_path.join("config/unicorn/#{fetch(:rails_env)}.rb") }
+    set :unicorn_roles, :app
+    set :unicorn_options, ''
+    set :unicorn_restart_delay, 5
+    set :unicorn_rack_env, :deployment
+    set :unicorn_restart_method, :restart_usr2
+  end
+end
+
+after 'deploy:published', 'unicorn:restart'

data/lib/capistrano/unicorn.rb

@@ -0,0 +1,23 @@
+def unicorn_is_running?(pidfile = fetch(:unicorn_pid))
+  test "[[ -e #{pidfile} ]] && $(kill -0 $(cat #{pidfile}) &> /dev/null)"
+end
+
+def unicorn_start
+  within release_path do
+    with rails_env: fetch(:rails_env) do
+      execute :bundle, 'exec', 'unicorn',  '-c', fetch(:unicorn_config),
+                                           '-E', fetch(:unicorn_rack_env),
+                                           '-D', fetch(:unicorn_options)
+    end
+  end
+end
+
+def unicorn_old_pid
+  "#{fetch(:unicorn_pid)}.oldbin"
+end
+
+def unicorn_send_signal(signal, pidfile = fetch(:unicorn_pid))
+  execute :kill, "-#{signal}", capture(:cat, pidfile)
+end
+
+load File.expand_path('../tasks/unicorn.cap', __FILE__)

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-unicorn-edge
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Alexander Menzhinsky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+description: Unicorn support for Capistrano 3.x
+email:
+- amenzhinsky@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-unicorn.gemspec
+- examples/unicorn.rb
+- lib/capistrano/tasks/unicorn.cap
+- lib/capistrano/unicorn.rb
+homepage: https://github.com/amenzhinsky/capistrano-unicorn-edge
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Unicorn support for Capistrano 3.x
+test_files: []