capistrano-unicorn 0.1.10 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1a058f515bf172a37d40eedbd47982db1374ffb3
+  data.tar.gz: d9e4825ca605a00f559985fd5cbfbac9768cb958
+SHA512:
+  metadata.gz: fb193dc5a958641c7febf145c9586b3186b1727fbd59e615022283fba9d7d32f109bd6e2f249f9f8930407f5229bb30e99ee0fa5574384c4a3de16e994d77b1f
+  data.tar.gz: 3821b7cf00a08cc83d068881caae0fae99132b091f4ea71d07fb3eeef73ffb6b7af559bf0d57da6300ae79fcb9396a56793166cba3b742ffabec254c68a05676

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -1,3 +1,9 @@
 source 'https://rubygems.org'
 
-gemspec
+gemspec
+
+group :test do
+  gem 'rspec'
+  gem 'capistrano-spec'
+  gem 'pry-debugger'
+end

data/NEWS.md

@@ -0,0 +1,27 @@
+# Capistrano Unicorn NEWS
+
+## 0.2.0
+
+Significant changes since 0.1.10 are as follows.  Backwards-incompatible changes are **in bold**.
+
+*   Ensured `RAILS_ENV` is set correctly.
+*   Embedded multistage docs directly within the [README](README.md) (the wiki page was version-specific and misleading).
+*   Significantly tidied up the usage and documentation of configuration variables:
+    *   **In most cases, it should now be sufficient to simply set `rails_env` correctly,
+        and other variables should assume the correct value by default.**
+    *   **Make `unicorn_env` default to `rails_env` or `'production'`.**
+    *   **Rename `app_env` to `unicorn_rack_env` and fix default value.**
+    *   Add `unicorn_options` variable which allows passing of arbitrary options to unicorn.
+    *   Added `app_subdir` to support app running in a subdirectory.
+    *   Updated documentation in [README](README.md) to fix inaccuracies and ambiguities.
+    *   `unicorn_pid` defaults to attempting to auto-detect from unicorn config file.
+        This avoids having to keep two paths in sync.
+        https://github.com/sosedoff/capistrano-unicorn/issues/7
+    *   Also added the `unicorn:show_vars` task to make it easier to debug
+        config variable values client-side.
+*   Defer calculation of `unicorn-roles`.
+
+It was noticed that there are a
+[huge number of unmerged forks on github](https://github.com/sosedoff/capistrano-unicorn/issues/45),
+so we also updated the [README](README.md) asking the community to
+contribute back any useful changes they make.

data/README.md

@@ -2,16 +2,18 @@
 
 Capistrano plugin that integrates Unicorn tasks into capistrano deployment script.
 
-## Installation
+**Developers:** Please consider contributing your forked changes, or opening an
+issue if there is no existing relevant one. There are a lot of forks--we'd love
+to reabsorb some of the issues/solutions the community has encountered.
 
-Install library from rubygems:
-
-```
-gem install capistrano-unicorn
-```
+[![Build Status](https://travis-ci.org/sosedoff/capistrano-unicorn.png?branch=master)](https://travis-ci.org/sosedoff/capistrano-unicorn)
+[![Gem Version](https://badge.fury.io/rb/capistrano-unicorn.png)](http://badge.fury.io/rb/capistrano-unicorn)
+[![Code Climate](https://codeclimate.com/github/sosedoff/capistrano-unicorn.png)](https://codeclimate.com/github/sosedoff/capistrano-unicorn)
 
 ## Usage
 
+If you are upgrading from a previous version, please see the [NEWS file](NEWS.md).
+
 ### Setup
 
 Add the library to your `Gemfile`:
@@ -31,15 +33,18 @@ require 'capistrano-unicorn'
 Add unicorn restart task hook:
 
 ```ruby
-after 'deploy:restart', 'unicorn:reload' # app IS NOT preloaded
-after 'deploy:restart', 'unicorn:restart'  # app preloaded
+after 'deploy:restart', 'unicorn:reload'    # app IS NOT preloaded
+after 'deploy:restart', 'unicorn:restart'   # app preloaded
+after 'deploy:restart', 'unicorn:duplicate' # before_fork hook implemented (zero downtime deployments)
 ```
 
-Create a new configuration file `config/unicorn.rb` or `config/unicorn/STAGE.rb`, where stage is your deployment environment.
+Create a new configuration file `config/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.
+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
+### Deploy
 
 First, make sure you're running the latest release:
 
@@ -57,20 +62,43 @@ cap unicorn:reload
 
 ## Configuration
 
-You can modify any of the following options in your `deploy.rb` config.
+You can modify any of the following Capistrano variables in your `deploy.rb` config.
+You can use the `unicorn:show_vars` task to check that the values you have specified
+are set correctly.
 
-- `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.
-- `unicorn_roles`           - Define which roles to perform unicorn recpies on. Default to `:app`.
-- `unicorn_config_path`     - Set the directory where unicorn config files reside. Default to `current_path/config`.
-- `unicorn_config_filename` - Set the filename of the unicorn config file. Not used in multistage installations. Default to `unicorn.rb`.
+### Environment parameters
 
-### Multistage
+- `unicorn_env`             - Set basename of unicorn config `.rb` file to be used loaded from `unicorn_config_path`. Defaults to `rails_env` variable if set, otherwise `production`.
+- `unicorn_rack_env`        - Set the value which will be passed to unicorn via [the `-E` parameter as the Rack environment](http://unicorn.bogomips.org/unicorn_1.html). Valid values are `development`, `deployment`, and `none`. Defaults to `development` if `rails_env` is `development`, otherwise `deployment`.
+
+### Execution parameters
+
+- `unicorn_user`            - Launch unicorn master as the specified user via `sudo`. Defaults to `nil`, which means no use of `sudo`, i.e. run as the user defined by the `user` variable.
+- `unicorn_roles`           - Define which roles to perform unicorn recipes on. Defaults to `:app`.
+- `unicorn_bundle`          - Set bundler command for unicorn. Defaults to `bundle`.
+- `unicorn_bin`             - Set unicorn executable file. Defaults to `unicorn`.
+- `unicorn_options`         - Set any additional options to be passed to unicorn on startup.
+- `unicorn_restart_sleep_time` - Number of seconds to wait for (old) pidfile to show up when restarting unicorn. Defaults to 2.
+
+### Relative path parameters
+
+- `app_subdir`              - If your app lives in a subdirectory 'rails' (say) of your repository, set this to `/rails` (the leading slash is required).
+- `unicorn_config_rel_path` - Set the directory path (relative to `app_path` - see below) where unicorn config files reside. Defaults to `config`.
+- `unicorn_config_filename` - Set the filename of the unicorn config file loaded from `unicorn_config_path`. Should not be present in multistage installations. Defaults to `unicorn.rb`.
 
-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).
+### Absolute path parameters
+
+- `app_path`                - Set path to app root. Defaults to `current_path + app_subdir`.
+- `unicorn_pid`             - Set unicorn PID file path. By default, attempts to auto-detect from unicorn config file. On failure, falls back to value in `unicorn_default_pid`
+- `unicorn_default_pid`     - See above. Defaults to `#{current_path}/tmp/pids/unicorn.pid`
+- `bundle_gemfile`          - Set path to Gemfile. Defaults to `#{app_path}/Gemfile`
+- `unicorn_config_path`     - Set the directory where unicorn config files reside. Defaults to `#{current_path}/config`.
+
+### Zero Downtime Deployment Options
+
+* `unicorn:restart`: :-1: This can sort of support it with a configurable timeout, which may not be reliable.
+* `unicorn:reload`: :question: Can anyone testify to its zero-downtime support?
+* `unicorn:duplicate`: :+1: If you install the Unicorn `before_fork` hook, then yes! See: https://github.com/sosedoff/capistrano-unicorn/issues/40#issuecomment-16011353
 
 ## Available Tasks
 
@@ -81,11 +109,69 @@ 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:show_vars                 # Debug Unicorn variables
 cap unicorn:shutdown                  # Immediately shutdown Unicorn
 cap unicorn:start                     # Start Unicorn master process
 cap unicorn:stop                      # Stop Unicorn
 ```
 
+## Tests
+
+To execute test suite run:
+
+```
+bundle exec rake test
+```
+
+### Multistage
+
+The issue here is that capistrano loads default configuration and then
+executes your staging task and overrides previously defined
+variables. The default environment before executing your stage task is
+set to `:production`, so it will use a wrong environment unless you
+take steps to ensure that `:rails_env` and `:unicorn_env` are
+set correctly.
+
+Let's say you have a scenario involving two deployment stages: staging
+and production.  You’ll need to add `config/deploy/staging.rb` and
+`config/deploy/production.rb` files.  However, it makes sense to
+adhere to DRY and avoid duplicating lines between the two files.  So
+it would be nicer to keep common settings in `config/deploy.rb`, and
+only put stuff in each staging definition file which is really
+specific to that staging environment.  Fortunately this can be done
+using the [lazy evaluation form of `set`](https://github.com/capistrano/capistrano/wiki/2.x-DSL-Configuration-Variables-Set).
+
+So `config/deploy.rb` file would contain something like:
+
+```ruby
+set :stages, %w(production staging)
+set :default_stage, "staging"
+require 'capistrano/ext/multistage'
+
+role(:web) { domain }
+role(:app) { domain }
+role(:db, :primary => true) { domain }
+
+set(:deploy_to)    { "/home/#{user}/#{application}/#{fetch :rails_env}" }
+set(:current_path) { File.join(deploy_to, current_dir) }
+```
+
+Then `config/deploy/production.rb` would contain something like:
+
+```ruby
+set :domain,      "app.mydomain.com"
+set :rails_env,   "production"
+```
+
+and `config/deploy/staging.rb` would only need to contain something like:
+
+```ruby
+set :domain,      "app.staging.mydomain.com"
+set :rails_env,   "staging"
+```
+
+Nice and clean!
+
 ## License
 
 See LICENSE file for details.

data/Rakefile

@@ -1,2 +1,10 @@
-require 'bundler'
-require 'bundler/gem_tasks'
+require "bundler"
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+
+RSpec::Core::RakeTask.new(:test) do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+task :default => :test

data/capistrano-unicorn.gemspec

@@ -1,21 +1,22 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/capistrano-unicorn/version', __FILE__)
+require File.expand_path("../lib/capistrano-unicorn/version", __FILE__)
 
-Gem::Specification.new do |gem|
-  gem.name        = 'capistrano-unicorn'
-  gem.version     = CapistranoUnicorn::VERSION.dup
-  gem.author      = 'Dan Sosedoff'
-  gem.email       = 'dan.sosedoff@gmail.com'
-  gem.homepage    = 'https://github.com/sosedoff/capistrano-unicorn'
-  gem.summary     = %q{Unicorn integration for Capistrano}
-  gem.description = %q{Capistrano plugin that integrates Unicorn server tasks.}
+Gem::Specification.new do |spec|
+  spec.name        = "capistrano-unicorn"
+  spec.version     = CapistranoUnicorn::VERSION.dup
+  spec.author      = "Dan Sosedoff"
+  spec.email       = "dan.sosedoff@gmail.com"
+  spec.homepage    = "https://github.com/sosedoff/capistrano-unicorn"
+  spec.summary     = %q{Unicorn integration for Capistrano}
+  spec.description = %q{Capistrano plugin that integrates Unicorn server tasks.}
+  spec.license     = "MIT"
 
-  gem.files         = `git ls-files`.split("\n")
-  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']
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.require_paths = ["lib"]
 
-  gem.add_development_dependency 'rake'
-  
-  gem.add_runtime_dependency 'capistrano'
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "unicorn"
+  spec.add_runtime_dependency     "capistrano", "< 3.0"
 end

data/lib/capistrano-unicorn/capistrano_integration.rb

@@ -1,6 +1,11 @@
+require 'tempfile'
+
 require 'capistrano'
 require 'capistrano/version'
 
+require 'capistrano-unicorn/config'
+require 'capistrano-unicorn/utility'
+
 module CapistranoUnicorn
   class CapistranoIntegration
     TASKS = [
@@ -11,142 +16,57 @@ module CapistranoUnicorn
       'unicorn:reload',
       'unicorn:shutdown',
       'unicorn:add_worker',
-      'unicorn:remove_worker'
+      'unicorn:remove_worker',
+      'unicorn:show_vars',
     ]
 
     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 }
-          _cset(:unicorn_config_path)        { "#{fetch(:current_path)}/config" }
-          _cset(:unicorn_config_filename)    { "unicorn.rb" }
-        end
-
-        # Check if a remote process exists using its pid file
-        #
-        def remote_process_exists?(pid_file)
-          "[ -e #{pid_file} ] && #{try_unicorn_user} kill -0 `cat #{pid_file}` > /dev/null 2>&1"
-        end
-
-        # Stale Unicorn process pid file
-        #
-        def old_unicorn_pid
-          "#{unicorn_pid}.oldbin"
-        end
 
-        # Command to check if Unicorn is running
-        #
-        def unicorn_is_running?
-          remote_process_exists?(unicorn_pid)
-        end
-
-        # 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
-            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 = "#{unicorn_config_path}/#{unicorn_config_filename}"
-          secondary_config_path = "#{unicorn_config_path}/unicorn/#{unicorn_env}.rb"
-
-          script = <<-END
-            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
-                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
-            if #{unicorn_is_running?}; then
-              echo "Duplicating Unicorn...";
-              #{unicorn_send_signal('USR2')};
-            else
-              #{start_unicorn}
-            fi;
-          END
-
-          script
+        before(CapistranoIntegration::TASKS) do
+          Config.load(self)
         end
 
-        def unicorn_roles
-          fetch(:unicorn_roles, :app)
-        end
+        extend Utility
 
         #
         # Unicorn cap tasks
         #
         namespace :unicorn do
+          desc 'Debug Unicorn variables'
+          task :show_vars, :roles => :app do
+            puts <<-EOF.gsub(/^ +/, '')
+
+              # Environments
+              rails_env          "#{rails_env}"
+              unicorn_env        "#{unicorn_env}"
+              unicorn_rack_env   "#{unicorn_rack_env}"
+
+              # Execution
+              unicorn_user       #{unicorn_user.inspect}
+              unicorn_bundle     "#{unicorn_bundle}"
+              unicorn_bin        "#{unicorn_bin}"
+              unicorn_options    "#{unicorn_options}"
+              unicorn_restart_sleep_time  #{unicorn_restart_sleep_time}
+
+              # Relative paths
+              app_subdir                         "#{app_subdir}"
+              unicorn_config_rel_path            "#{unicorn_config_rel_path}"
+              unicorn_config_filename            "#{unicorn_config_filename}"
+              unicorn_config_rel_file_path       "#{unicorn_config_rel_file_path}"
+              unicorn_config_stage_rel_file_path "#{unicorn_config_stage_rel_file_path}"
+
+              # Absolute paths
+              app_path                  "#{app_path}"
+              unicorn_pid               "#{unicorn_pid}"
+              bundle_gemfile            "#{bundle_gemfile}"
+              unicorn_config_path       "#{unicorn_config_path}"
+              unicorn_config_file_path  "#{unicorn_config_file_path}"
+              unicorn_config_stage_file_path
+              ->                        "#{unicorn_config_stage_file_path}"
+            EOF
+          end
+
           desc 'Start Unicorn master process'
           task :start, :roles => unicorn_roles, :except => {:no_release => true} do
             run start_unicorn

data/lib/capistrano-unicorn/config.rb

@@ -0,0 +1,52 @@
+module CapistranoUnicorn
+  class Config
+    def self.load(config)
+      config.instance_eval do
+        # Environments
+        _cset(:unicorn_env)                { fetch(:rails_env, 'production' ) }
+        _cset(:unicorn_rack_env) do
+          # Following recommendations from http://unicorn.bogomips.org/unicorn_1.html
+          fetch(:rails_env) == 'development' ? 'development' : 'deployment'
+        end
+
+        # Execution
+        _cset(:unicorn_user)               { nil }
+        _cset(:unicorn_bundle)             { fetch(:bundle_cmd, "bundle") }
+        _cset(:unicorn_bin)                { "unicorn" }
+        _cset(:unicorn_options)            { '' }
+        _cset(:unicorn_restart_sleep_time) { 2 }
+
+        # Relative paths
+        _cset(:app_subdir)                 { '' }
+        _cset(:unicorn_config_rel_path)    { "config" }
+        _cset(:unicorn_config_filename)    { "unicorn.rb" }
+        _cset(:unicorn_config_rel_file_path) \
+          { unicorn_config_rel_path + '/' + unicorn_config_filename }
+        _cset(:unicorn_config_stage_rel_file_path) \
+          { [ unicorn_config_rel_path, 'unicorn',
+              "#{unicorn_env}.rb" ].join('/') }
+
+          # Absolute paths
+          # If you find the following confusing, try running 'cap unicorn:show_vars' -
+          # it might help :-)
+          _cset(:app_path)                   { current_path + app_subdir }
+          _cset(:bundle_gemfile)             { app_path + '/Gemfile' }
+          _cset(:unicorn_config_path)        { app_path + '/' + unicorn_config_rel_path }
+          _cset(:unicorn_config_file_path)   { app_path + '/' + unicorn_config_rel_file_path }
+          _cset(:unicorn_config_stage_file_path) \
+            { app_path + '/' + unicorn_config_stage_rel_file_path }
+          _cset(:unicorn_default_pid)        { app_path + "/tmp/pids/unicorn.pid" }
+          _cset(:unicorn_pid) do
+            extracted_pid = extract_pid_file
+            if extracted_pid
+              extracted_pid
+            else
+              logger.important "err :: failed to auto-detect pid from #{local_unicorn_config}"
+              logger.important "err :: falling back to default: #{unicorn_default_pid}"
+              unicorn_default_pid
+            end
+          end
+      end
+    end
+  end
+end

data/lib/capistrano-unicorn/utility.rb

@@ -0,0 +1,147 @@
+module CapistranoUnicorn
+  module Utility
+
+    def local_unicorn_config
+      File.exist?(unicorn_config_rel_file_path) ?
+          unicorn_config_rel_file_path
+        : unicorn_config_stage_rel_file_path
+    end
+
+    def extract_pid_file
+      tmp = Tempfile.new('unicorn.rb')
+      begin
+        conf = local_unicorn_config
+        tmp.write <<-EOF.gsub(/^ */, '')
+          config_file = "#{conf}"
+
+          # stub working_directory to avoid chdir failure since this will
+          # run client-side:
+          def working_directory(path); end
+
+          instance_eval(File.read(config_file), config_file) if config_file
+          puts set[:pid]
+          exit 0
+        EOF
+        tmp.close
+        extracted_pid = `unicorn -c "#{tmp.path}"`
+        $?.success? ? extracted_pid.rstrip : nil
+      rescue StandardError => e
+        return nil
+      ensure
+        tmp.close
+        tmp.unlink
+      end
+    end
+
+    # Check if a remote process exists using its pid file
+    #
+    def remote_process_exists?(pid_file)
+      "[ -e #{pid_file} ] && #{try_unicorn_user} kill -0 `cat #{pid_file}` > /dev/null 2>&1"
+    end
+
+    # Stale Unicorn process pid file
+    #
+    def old_unicorn_pid
+      "#{unicorn_pid}.oldbin"
+    end
+
+    # Command to check if Unicorn is running
+    #
+    def unicorn_is_running?
+      remote_process_exists?(unicorn_pid)
+    end
+
+    # 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
+        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
+      %Q%
+        if [ -e "#{unicorn_config_file_path}" ]; then
+          UNICORN_CONFIG_PATH=#{unicorn_config_file_path};
+        else
+          if [ -e "#{unicorn_config_stage_file_path}" ]; then
+            UNICORN_CONFIG_PATH=#{unicorn_config_stage_file_path};
+          else
+            echo "Config file for "#{unicorn_env}" environment was not found at either "#{unicorn_config_file_path}" or "#{unicorn_config_stage_file_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 #{app_path} && #{try_unicorn_user} RAILS_ENV=#{rails_env} BUNDLE_GEMFILE=#{bundle_gemfile} #{unicorn_bundle} exec #{unicorn_bin} -c $UNICORN_CONFIG_PATH -E #{unicorn_rack_env} -D #{unicorn_options};
+      %
+    end
+
+    def duplicate_unicorn
+      script = <<-END
+        if #{unicorn_is_running?}; then
+          echo "Duplicating Unicorn...";
+          #{unicorn_send_signal('USR2')};
+        else
+          #{start_unicorn}
+        fi;
+      END
+
+      script
+    end
+
+    def unicorn_roles
+      defer{ fetch(:unicorn_roles, :app) }
+    end
+
+  end
+end

data/lib/capistrano-unicorn/version.rb

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

data/spec/capistrano_integration_spec.rb

@@ -0,0 +1,84 @@
+require "spec_helper"
+
+describe CapistranoUnicorn::CapistranoIntegration, "loaded tasks into capistrano" do
+  before do
+    @configuration = Capistrano::Configuration.new
+    @configuration.extend(Capistrano::Spec::ConfigurationExtension)
+    CapistranoUnicorn::CapistranoIntegration.load_into(@configuration)
+  end
+
+  shared_examples_for "a task" do |task_name|
+    it "sets attributes in before_task hook" do
+      # Environments
+      @configuration.should_receive(:_cset).with(:unicorn_env)
+      @configuration.should_receive(:_cset).with(:unicorn_rack_env)
+
+      # Execution
+      @configuration.should_receive(:_cset).with(:unicorn_user)
+      @configuration.should_receive(:_cset).with(:unicorn_bundle)
+      @configuration.should_receive(:_cset).with(:unicorn_bin)
+      @configuration.should_receive(:_cset).with(:unicorn_options)
+      @configuration.should_receive(:_cset).with(:unicorn_restart_sleep_time)
+
+      # Relative paths
+      @configuration.should_receive(:_cset).with(:app_subdir)
+      @configuration.should_receive(:_cset).with(:unicorn_config_rel_path)
+      @configuration.should_receive(:_cset).with(:unicorn_config_filename)
+      @configuration.should_receive(:_cset).with(:unicorn_config_rel_file_path)
+      @configuration.should_receive(:_cset).with(:unicorn_config_stage_rel_file_path)
+
+      # Absolute paths
+      @configuration.should_receive(:_cset).with(:app_path)
+      @configuration.should_receive(:_cset).with(:unicorn_pid)
+      @configuration.should_receive(:_cset).with(:bundle_gemfile)
+      @configuration.should_receive(:_cset).with(:unicorn_config_path)
+      @configuration.should_receive(:_cset).with(:unicorn_config_file_path)
+      @configuration.should_receive(:_cset).with(:unicorn_config_stage_file_path)
+
+      @configuration.find_and_execute_task(task_name)
+    end
+  end
+
+  describe "task" do
+    describe 'unicorn:start' do
+      before do
+        @configuration.stub(:start_unicorn)
+        @configuration.stub(:_cset)
+      end
+
+      it_behaves_like "a task", 'unicorn:start'
+
+      it "runs start_unicorn command" do
+        @configuration.should_receive(:start_unicorn).and_return("start unicorn command")
+        @configuration.find_and_execute_task('unicorn:start')
+        @configuration.should have_run("start unicorn command")
+      end
+    end
+
+    describe 'unicorn:stop' do
+      before do
+        @configuration.stub(:kill_unicorn)
+        @configuration.stub(:_cset)
+      end
+
+      it_behaves_like "a task", 'unicorn:stop'
+
+      it "runs kill_unicorn command" do
+        @configuration.should_receive(:kill_unicorn).with('QUIT').and_return("kill unicorn command")
+        @configuration.find_and_execute_task('unicorn:stop')
+        @configuration.should have_run("kill unicorn command")
+      end
+    end
+  end
+
+  describe "#kill_unicorn" do
+    before do
+      @configuration.stub(:unicorn_pid).and_return(999)
+      @configuration.stub(:unicorn_user).and_return("deploy_user")
+    end
+
+    it "generates the kill unicorn command" do
+      @configuration.kill_unicorn('QUIT').should match /-u deploy_user kill -s QUIT `cat 999`;/
+    end
+  end
+end

data/spec/config_spec.rb

@@ -0,0 +1,134 @@
+require 'spec_helper'
+describe CapistranoUnicorn::Config, "loaded into a configuration" do
+  before do
+    @configuration = Capistrano::Configuration.new
+    @configuration.extend(Capistrano::Spec::ConfigurationExtension)
+    CapistranoUnicorn::CapistranoIntegration.load_into(@configuration)
+  end
+
+  context "testing variables" do
+    before do
+      # define _cset etc. from capistrano
+      @configuration.load 'deploy'
+
+      # capistrano-unicorn variables are set during a 'before'
+      # callback, so in order to be able to test the result, we need
+      # to ensure the callback is triggered.
+      @configuration.trigger :before
+    end
+
+    describe "app paths" do
+      cur_path = '/path/to/myapp'
+
+      before do
+        @configuration.set(:current_path, cur_path)
+      end
+
+      shared_examples_for "an app in path" do |app_path|
+        let(:shell) { :` } # ` } work around confused emacs ruby-mode
+
+        specify "app_path should default to #{app_path}" do
+          @configuration.fetch(:app_path).should == app_path
+        end
+
+        it "should default to a sensible pid file when auto-detection failed" do
+          @configuration.should_receive(shell).with(/unicorn -c /).and_return('') do |cmd|
+            `false` # Simulate failure by setting $?
+          end
+          @configuration.logger.stub(:important)
+          @configuration.fetch(:unicorn_pid).should == app_path + "/tmp/pids/unicorn.pid"
+        end
+
+        shared_examples "auto-detect pid file from unicorn config" do
+          |pid_file, primary_exists, config_file|
+          which_config = primary_exists ? 'primary' : 'stage'
+          it "should auto-detect pid file from #{which_config} unicorn config" do
+            # Tempfile.new in Ruby 1.9.2 will call File.exist?
+            allow(File).to receive(:exist?).with(/tmp/)
+
+            File.should_receive(:exist?).with('config/unicorn.rb').and_return(primary_exists)
+            tmpfile = nil
+            @configuration.should_receive(shell).with(/unicorn -c /) do |cmd|
+              (cmd =~ /^unicorn -c "(.+)"$/).should be_true
+              tmpfile = $~[1]
+              tmpfile.should include("tmp")
+              File.read(tmpfile).should include(%!config_file = "#{config_file}"!)
+              `true` # Simulate success by setting $?
+              pid_file
+            end
+            @configuration.fetch(:unicorn_pid).should == pid_file
+          end
+        end
+
+        include_examples "auto-detect pid file from unicorn config", \
+          '/path/to/pid/from/config/file', true, "config/unicorn.rb"
+
+        include_examples "auto-detect pid file from unicorn config", \
+          '/path/to/pid/from/stage/config/file', false, "config/unicorn/production.rb"
+
+        specify "Gemfile should default correctly" do
+          @configuration.fetch(:bundle_gemfile).should == app_path + "/Gemfile"
+        end
+
+        specify "config/ directory should default correctly" do
+          @configuration.fetch(:unicorn_config_path).should == app_path + "/config"
+        end
+
+        specify "config file should default correctly" do
+          @configuration.fetch(:unicorn_config_file_path).should == app_path + "/config/unicorn.rb"
+        end
+
+        specify "per-stage config file should default correctly" do
+          @configuration.fetch(:unicorn_config_stage_file_path).should == app_path + "/config/unicorn/production.rb"
+        end
+
+        specify "per-stage config file should be set correctly for different environment" do
+          @configuration.set(:rails_env, 'staging')
+          @configuration.fetch(:unicorn_config_stage_file_path).should == app_path + "/config/unicorn/staging.rb"
+        end
+      end
+
+      context "app in current_path" do
+        it_should_behave_like "an app in path", cur_path
+      end
+
+      context "app in a subdirectory" do
+        subdir = 'mysubdir'
+
+        before do
+          @configuration.set(:app_subdir, '/' + subdir)
+        end
+
+        it_should_behave_like "an app in path", cur_path + '/' + subdir
+      end
+    end
+
+    describe "unicorn_env" do
+      it "should default to value of rails_env if set" do
+        @configuration.set(:rails_env, 'staging')
+        @configuration.fetch(:unicorn_env).should == \
+          @configuration.fetch(:rails_env)
+      end
+
+      it "should default to production if rails_env not set" do
+        @configuration.fetch(:unicorn_env).should == 'production'
+      end
+    end
+
+    describe "unicorn_rack_env" do
+      it "should default to deployment if rails_env not set" do
+        @configuration.fetch(:unicorn_rack_env).should == 'deployment'
+      end
+
+      it "should default to development if rails_env set to development" do
+        @configuration.set(:rails_env, 'development')
+        @configuration.fetch(:unicorn_rack_env).should == 'development'
+      end
+
+      it "should default to deployment if rails_env set to anything else" do
+        @configuration.set(:rails_env, 'staging')
+        @configuration.fetch(:unicorn_rack_env).should == 'deployment'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'capistrano-spec'
+require 'capistrano-unicorn'
+
+RSpec.configure do |config|
+  config.include Capistrano::Spec::Matchers
+  config.include Capistrano::Spec::Helpers
+end

metadata

@@ -1,48 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-unicorn
 version: !ruby/object:Gem::Version
-  version: 0.1.10
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Dan Sosedoff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-25 00:00:00.000000000 Z
+date: 2013-10-17 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
+  name: unicorn
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  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: !ruby/object:Gem::Requirement
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Capistrano plugin that integrates Unicorn server tasks.
 email: dan.sosedoff@gmail.com
 executables: []
@@ -50,43 +59,48 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE
+- NEWS.md
 - README.md
 - Rakefile
 - capistrano-unicorn.gemspec
 - examples/rails3.rb
 - lib/capistrano-unicorn.rb
 - lib/capistrano-unicorn/capistrano_integration.rb
+- lib/capistrano-unicorn/config.rb
+- lib/capistrano-unicorn/utility.rb
 - lib/capistrano-unicorn/version.rb
+- spec/capistrano_integration_spec.rb
+- spec/config_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/sosedoff/capistrano-unicorn
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 759058187647909637
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 759058187647909637
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Unicorn integration for Capistrano
-test_files: []
+test_files:
+- spec/capistrano_integration_spec.rb
+- spec/config_spec.rb
+- spec/spec_helper.rb