capistrano-unicorn 0.1.6 → 0.1.7

data/Gemfile

@@ -1,3 +1,3 @@
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
 gemspec

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2011-2012 Dan Sosedoff.
+
+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

@@ -4,33 +4,50 @@ Capistrano plugin that integrates Unicorn tasks into capistrano deployment scrip
 
 ## Installation
 
+Install library from rubygems:
+
 ```
 gem install capistrano-unicorn
 ```
 
 ## Usage
 
-Add the gem to your ```Gemfile```:
+### Setup
+
+Add the library to your `Gemfile`:
 
 ```ruby
 group :development do
-  gem 'capistrano-unicorn'
+  gem 'capistrano-unicorn', :require => false
 end
 ```
 
-Add unicorn plugin into your deploy.rb file.
-
-**NOTE:** Should be placed after all hooks
+And load it into your deployment script `config/deploy.rb`:
 
 ```ruby
 require 'capistrano-unicorn'
 ```
 
-This should add a unicorn server start task after ```deploy:restart```.
+Add unicorn restart task hook:
 
-Unicorn configuration file should be placed under ```config/unicorn/YOUR_ENV.rb```
+```ruby
+after 'deploy:restart', 'unicorn:reload' # app IS NOT preloaded
+after 'deploy:restart', 'unicorn:restart'  # app preloaded
+```
 
-To test if it works type:
+Create a new configuration file `config/unicorn/unicorn.rb` or `config/unicorn/STAGE.rb`, where stage is your deployment environment.
+
+Example config - [examples/rails3.rb](https://github.com/sosedoff/capistrano-unicorn/blob/master/examples/rails3.rb). Please refer to unicorn documentation for more examples and configuration options.
+
+### Test
+
+First, make sure you're running the latest release:
+
+```
+cap deploy
+```
+
+Then you can test each individual task:
 
 ```
 cap unicorn:start
@@ -38,20 +55,32 @@ cap unicorn:stop
 cap unicorn:reload
 ```
 
-**NOTE:** This plugin uses bundler.
+## Configuration
 
-## Configuration options
+You can modify any of the following options in your `deploy.rb` config.
 
-- ```unicorn_env``` - Set unicorn environment. Default to ```rails_env``` variable.
-- ```unicorn_pid``` - Set unicorn PID file path. Default to ```current_path/tmp/pids/unicorn.pid```
-- ```unicorn_bin``` - Set unicorn executable file. Default to ```unicorn```.
+- `unicorn_env` - Set unicorn environment. Default to `rails_env` variable.
+- `unicorn_pid` - Set unicorn PID file path. Default to `current_path/tmp/pids/unicorn.pid`
+- `unicorn_bin` - Set unicorn executable file. Default to `unicorn`.
+- `unicorn_bundle` - Set bundler command for unicorn. Default to `bundle`.
+- `unicorn_user` - Launch unicorn master as the specified user. Default to `user` variable.
 
-## License
+If you are using capistrano multistage, please refer to [Using capistrano unicorn with multistage environment](https://github.com/sosedoff/capistrano-unicorn/wiki/Using-capistrano-unicorn-with-multistage-environment).
 
-Copyright (c) 2011-2012 Dan Sosedoff.
+## Available Tasks
 
-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:
+To get a list of all capistrano tasks, run `cap -T`:
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+```
+cap unicorn:add_worker                # Add a new worker
+cap unicorn:remove_worker             # Remove amount of workers
+cap unicorn:reload                    # Reload Unicorn
+cap unicorn:restart                   # Restart Unicorn
+cap unicorn:shutdown                  # Immediately shutdown Unicorn
+cap unicorn:start                     # Start Unicorn master process
+cap unicorn:stop                      # Stop Unicorn
+```
+
+## License
 
-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.
+See LICENSE file for details.

data/capistrano-unicorn.gemspec

@@ -14,6 +14,8 @@ Gem::Specification.new do |gem|
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
   gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'rake'
   
   gem.add_runtime_dependency 'capistrano'
 end

data/lib/capistrano-unicorn/capistrano_integration.rb

@@ -3,97 +3,219 @@ require 'capistrano/version'
 
 module CapistranoUnicorn
   class CapistranoIntegration
+    TASKS = [
+      'unicorn:start',
+      'unicorn:stop',
+      'unicorn:restart',
+      'unicorn:duplicate',
+      'unicorn:reload',
+      'unicorn:shutdown',
+      'unicorn:add_worker',
+      'unicorn:remove_worker'
+    ]
+
     def self.load_into(capistrano_config)
       capistrano_config.load do
+        before(CapistranoIntegration::TASKS) do
+          _cset(:app_env)                    { (fetch(:rails_env) rescue 'production') }
+          _cset(:unicorn_pid)                { "#{fetch(:current_path)}/tmp/pids/unicorn.pid" }
+          _cset(:unicorn_env)                { fetch(:app_env) }
+          _cset(:unicorn_bin)                { "unicorn" }
+          _cset(:unicorn_bundle)             { fetch(:bundle_cmd) rescue 'bundle' }
+          _cset(:unicorn_restart_sleep_time) { 2 }
+          _cset(:unicorn_user)               { nil }
+        end
 
-        # Check if remote file exists
+        # Check if a remote process exists using its pid file
         #
-        def remote_file_exists?(full_path)
-          'true' ==  capture("if [ -e #{full_path} ]; then echo 'true'; fi").strip
+        def remote_process_exists?(pid_file)
+          "[ -e #{pid_file} ] && #{try_unicorn_user} kill -0 `cat #{pid_file}` > /dev/null 2>&1"
         end
-        
-        # Check if process is running
+
+        # Stale Unicorn process pid file
         #
-        def process_exists?(pid_file)
-          capture("ps -p $(cat #{pid_file}) ; true").strip.split("\n").size == 2
+        def old_unicorn_pid
+          "#{unicorn_pid}.oldbin"
         end
 
-        # Set unicorn vars
+        # Command to check if Unicorn is running
         #
-        _cset(:unicorn_pid, "#{fetch(:current_path)}/tmp/pids/unicorn.pid")
-        _cset(:app_env, (fetch(:rails_env) rescue 'production'))
-        _cset(:unicorn_env, (fetch(:app_env)))
-        _cset(:unicorn_bin, "unicorn")
+        def unicorn_is_running?
+          remote_process_exists?(unicorn_pid)
+        end
 
-        namespace :unicorn do
-          desc 'Start Unicorn'
-          task :start, :roles => :app, :except => {:no_release => true} do
-            if remote_file_exists?(unicorn_pid)
-              if process_exists?(unicorn_pid)
-                logger.important("Unicorn is already running!", "Unicorn")
-                next
+        # Command to check if stale Unicorn is running
+        #
+        def old_unicorn_is_running?
+          remote_process_exists?(old_unicorn_pid)
+        end
+
+        # Get unicorn master process PID (using the shell)
+        #
+        def get_unicorn_pid(pid_file=unicorn_pid)
+          "`cat #{pid_file}`"
+        end
+
+        # Get unicorn master (old) process PID
+        #
+        def get_old_unicorn_pid
+          get_unicorn_pid(old_unicorn_pid)
+        end
+
+        # Send a signal to a unicorn master processes
+        #
+        def unicorn_send_signal(signal, pid=get_unicorn_pid)
+          "#{try_unicorn_user} kill -s #{signal} #{pid}"
+        end
+
+        # Run a command as the :unicorn_user user if :unicorn_user is a string.
+        # Otherwise run as default (:user) user.
+        #
+        def try_unicorn_user
+          "#{sudo :as => unicorn_user.to_s}" if unicorn_user.kind_of?(String)
+        end
+
+        # Kill Unicorns in multiple ways O_O
+        #
+        def kill_unicorn(signal)
+          script = <<-END
+            set -x;
+            if #{unicorn_is_running?}; then
+              echo "Stopping Unicorn...";
+              #{unicorn_send_signal(signal)};
+            else
+              echo "Unicorn is not running.";
+            fi;
+          END
+
+          script
+        end
+
+        # Start the Unicorn server
+        #
+        def start_unicorn
+          primary_config_path = "#{current_path}/config/unicorn.rb"
+          secondary_config_path = "#{current_path}/config/unicorn/#{unicorn_env}.rb"
+
+          script = <<-END
+            set -x;
+            if [ -e #{primary_config_path} ]; then
+              UNICORN_CONFIG_PATH=#{primary_config_path};
+            else
+              if [ -e #{secondary_config_path} ]; then
+                UNICORN_CONFIG_PATH=#{secondary_config_path};
               else
-                run "rm #{unicorn_pid}"
-              end
-            end
-            
-            config_path = "#{current_path}/config/unicorn/#{unicorn_env}.rb"
-            if remote_file_exists?(config_path)
-              logger.important("Starting...", "Unicorn")
-              run "cd #{current_path} && BUNDLE_GEMFILE=#{current_path}/Gemfile bundle exec #{unicorn_bin} -c #{config_path} -E #{app_env} -D"
+                echo "Config file for \"#{unicorn_env}\" environment was not found at either \"#{primary_config_path}\" or \"#{secondary_config_path}\"";
+                exit 1;
+              fi;
+            fi;
+
+            if [ -e #{unicorn_pid} ]; then
+              if #{try_unicorn_user} kill -0 `cat #{unicorn_pid}` > /dev/null 2>&1; then
+                echo "Unicorn is already running!";
+                exit 0;
+              fi;
+
+              #{try_unicorn_user} rm #{unicorn_pid};
+            fi;
+
+            echo "Starting Unicorn...";
+            cd #{current_path} && #{try_unicorn_user} BUNDLE_GEMFILE=#{current_path}/Gemfile #{unicorn_bundle} exec #{unicorn_bin} -c $UNICORN_CONFIG_PATH -E #{app_env} -D;
+          END
+
+          script
+        end
+
+        def duplicate_unicorn
+          script = <<-END
+            set -x;
+            if #{unicorn_is_running?}; then
+              echo "Duplicating Unicorn...";
+              #{unicorn_send_signal('USR2')};
             else
-              logger.important("Config file for \"#{unicorn_env}\" environment was not found at \"#{config_path}\"", "Unicorn")
-            end
+              #{start_unicorn}
+            fi;
+          END
+
+          script
+        end
+
+        #
+        # Unicorn cap tasks
+        #
+        namespace :unicorn do
+          desc 'Start Unicorn master process'
+          task :start, :roles => :app, :except => {:no_release => true} do
+            run start_unicorn
           end
 
           desc 'Stop Unicorn'
           task :stop, :roles => :app, :except => {:no_release => true} do
-            if remote_file_exists?(unicorn_pid)
-              if process_exists?(unicorn_pid)
-                logger.important("Stopping...", "Unicorn")
-                run "#{try_sudo} kill `cat #{unicorn_pid}`"
-              else
-                run "rm #{unicorn_pid}"
-                logger.important("Unicorn is not running.", "Unicorn")
-              end
-            else
-              logger.important("No PIDs found. Check if unicorn is running.", "Unicorn")
-            end
+            run kill_unicorn('QUIT')
           end
 
-          desc 'Unicorn graceful shutdown'
-          task :graceful_stop, :roles => :app, :except => {:no_release => true} do
-            if remote_file_exists?(unicorn_pid)
-              if process_exists?(unicorn_pid)
-                logger.important("Stopping...", "Unicorn")
-                run "#{try_sudo} kill -s QUIT `cat #{unicorn_pid}`"
-              else
-                run "rm #{unicorn_pid}"
-                logger.important("Unicorn is not running.", "Unicorn")
-              end
-            else
-              logger.important("No PIDs found. Check if unicorn is running.", "Unicorn")
-            end
+          desc 'Immediately shutdown Unicorn'
+          task :shutdown, :roles => :app, :except => {:no_release => true} do
+            run kill_unicorn('TERM')
+          end
+
+          desc 'Restart Unicorn'
+          task :restart, :roles => :app, :except => {:no_release => true} do
+            run <<-END
+              #{duplicate_unicorn}
+
+              sleep #{unicorn_restart_sleep_time}; # in order to wait for the (old) pidfile to show up
+
+              if #{old_unicorn_is_running?}; then
+                #{unicorn_send_signal('QUIT', get_old_unicorn_pid)};
+              fi;
+            END
+          end
+
+          desc 'Duplicate Unicorn'
+          task :duplicate, :roles => :app, :except => {:no_release => true} do
+            run duplicate_unicorn()
           end
 
           desc 'Reload Unicorn'
           task :reload, :roles => :app, :except => {:no_release => true} do
-            if remote_file_exists?(unicorn_pid)
-              logger.important("Stopping...", "Unicorn")
-              run "#{try_sudo} kill -s USR2 `cat #{unicorn_pid}`"
-            else
-              logger.important("No PIDs found. Starting Unicorn server...", "Unicorn")
-              config_path = "#{current_path}/config/unicorn/#{unicorn_env}.rb"
-              if remote_file_exists?(config_path)
-                run "cd #{current_path} && BUNDLE_GEMFILE=#{current_path}/Gemfile bundle exec #{unicorn_bin} -c #{config_path} -E #{app_env} -D"
+            run <<-END
+              set -x;
+              if #{unicorn_is_running?}; then
+                echo "Reloading Unicorn...";
+                #{unicorn_send_signal('HUP')};
               else
-                logger.important("Config file for \"#{unicorn_env}\" environment was not found at \"#{config_path}\"", "Unicorn")
-              end
-            end
+                #{start_unicorn}
+              fi;
+            END
+          end
+
+          desc 'Add a new worker'
+          task :add_worker, :roles => :app, :except => {:no_release => true} do
+            run <<-END
+              set -x;
+              if #{unicorn_is_running?}; then
+                echo "Adding a new Unicorn worker...";
+                #{unicorn_send_signal('TTIN')};
+              else
+                echo "Unicorn is not running.";
+              fi;
+            END
           end
-        end
 
-        after "deploy:restart", "unicorn:reload"
+          desc 'Remove amount of workers'
+          task :remove_worker, :roles => :app, :except => {:no_release => true} do
+            run <<-END
+              set -x;
+              if #{unicorn_is_running?}; then
+                echo "Removing a Unicorn worker...";
+                #{unicorn_send_signal('TTOU')};
+              else
+                echo "Unicorn is not running.";
+              fi;
+            END
+          end
+        end
       end
     end
   end

data/lib/capistrano-unicorn/version.rb

@@ -1,5 +1,5 @@
 module CapistranoUnicorn
   unless defined?(::CapistranoUnicorn::VERSION)
-    VERSION = "0.1.6".freeze
+    VERSION = "0.1.7".freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-unicorn
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,27 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-23 00:00:00.000000000Z
+date: 2013-03-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: capistrano
-  requirement: &2166810460 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +37,12 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2166810460
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Capistrano plugin that integrates Unicorn server tasks.
 email: dan.sosedoff@gmail.com
 executables: []
@@ -30,6 +51,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - capistrano-unicorn.gemspec
@@ -57,8 +79,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Unicorn integration for Capistrano
 test_files: []
+has_rdoc: