sepastian-capistrano3-unicorn 0.3.0

data/.gitignore

@@ -0,0 +1,41 @@
+!.gitignore
+*.gem
+*.rbc
+*.sw[a-p]
+*.tmproj
+*.tmproject
+*.un~
+*~
+.DS_Store
+.Spotlight-V100
+.Trashes
+._*
+.bundle
+.config
+.directory
+.elc
+.redcar
+.yardoc
+/.emacs.desktop
+/.emacs.desktop.lock
+Desktop.ini
+Gemfile.lock
+Icon?
+InstalledFiles
+Session.vim
+Thumbs.db
+\#*\#
+_yardoc
+auto-save-list
+coverage
+doc/
+lib/bundler/man
+pkg
+pkg/*
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tmtags
+tramp

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

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

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2011-2013 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/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

@@ -0,0 +1,177 @@
+# Capistrano Unicorn
+
+Capistrano plugin that integrates Unicorn tasks into capistrano deployment script.
+
+**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.
+
+[![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`:
+
+```ruby
+group :development do
+  gem 'capistrano-unicorn', :require => false
+end
+```
+
+And load it into your deployment script `config/deploy.rb`:
+
+```ruby
+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: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.
+
+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.
+
+### Deploy
+
+First, make sure you're running the latest release:
+
+```
+cap deploy
+```
+
+Then you can test each individual task:
+
+```
+cap unicorn:start
+cap unicorn:stop
+cap unicorn:reload
+```
+
+## Configuration
+
+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.
+
+### Environment parameters
+
+- `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`.
+
+### 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
+
+To get a list of all capistrano tasks, run `cap -T`:
+
+```
+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

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/capistrano/unicorn/version", __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name        = "sepastian-capistrano3-unicorn"
+  spec.version     = CapistranoUnicorn::VERSION.dup
+  spec.author      = "Sebastian Gassner, Dan Sosedoff"
+  spec.email       = "sebastian.gassner@gmail.com"
+  spec.homepage    = "https://github.com/sepastian/capistrano-unicorn"
+  spec.summary     = %q{Unicorn integration for Capistrano 3.x}
+  spec.description = %q{Capistrano 3.x plugin that integrates Unicorn server tasks.}
+  spec.license     = "MIT"
+
+  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"]
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "unicorn"
+  spec.add_runtime_dependency     "capistrano", "~> 3.0.0"
+end

data/examples/rails3.rb

@@ -0,0 +1,45 @@
+# ------------------------------------------------------------------------------
+# Sample rails 3 config
+# ------------------------------------------------------------------------------
+
+# Set your full path to application.
+app_path = "/path/to/app"
+
+# Set unicorn options
+worker_processes 1
+preload_app true
+timeout 180
+listen "127.0.0.1:9000"
+
+# Spawn unicorn master worker for user apps (group: apps)
+user 'apps', 'apps' 
+
+# Fill path to your app
+working_directory app_path
+
+# Should be 'production' by default, otherwise use other env 
+rails_env = ENV['RAILS_ENV'] || 'production'
+
+# Log everything to one file
+stderr_path "log/unicorn.log"
+stdout_path "log/unicorn.log"
+
+# Set master PID location
+pid "#{app_path}/tmp/pids/unicorn.pid"
+
+before_fork do |server, worker|
+  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,170 @@
+require 'capistrano'
+require 'capistrano/unicorn/utility'
+
+include CapistranoUnicorn::Utility
+
+# Load default values the capistrano 3.x way.
+# See https://github.com/capistrano/capistrano/pull/605
+namespace :load do
+  task :defaults do
+
+    # Environments
+    set :unicorn_env     , Proc.new{ fetch(:rails_env, 'production') }
+    # Following recommendations from http://unicorn.bogomips.org/unicorn_1.html
+    set :unicorn_rack_env, Proc.new{ fetch(:rails_env) == 'development' ? 'development' : 'deployment' }
+    
+    # Execution
+    set :unicorn_user              , nil
+    set :unicorn_bundle            , Proc.new{ fetch(:bundle_cmd, "bundle") }
+    set :unicorn_bin               , "unicorn"
+    set :unicorn_options           , ''
+    set :unicorn_restart_sleep_time, 2
+    
+    # Relative paths
+    set :app_subdir                        , ''
+    set :unicorn_config_rel_path           , "config"
+    set :unicorn_config_filename           , "unicorn.rb"
+    set :unicorn_config_rel_file_path      , Proc.new{ File.join(fetch(:unicorn_config_rel_path), fetch(:unicorn_config_filename)) }
+    set :unicorn_config_stage_rel_file_path, Proc.new{ File.join(fetch(:unicorn_config_rel_path), 'unicorn', "#{fetch(:unicorn_env)}.rb") }
+    
+    # Absolute paths
+    # If you find the following confusing, try running 'cap unicorn:show_vars' -
+    # it might help :-)
+    set :app_path                      , Proc.new{ File.join(current_path, fetch(:app_subdir)) }
+    set :bundle_gemfile                , Proc.new{ File.join(fetch(:app_path), 'Gemfile') }
+    set :unicorn_config_path           , Proc.new{ File.join(fetch(:app_path), fetch(:unicorn_config_rel_path)) }
+    set :unicorn_config_file_path      , Proc.new{ File.join(fetch(:app_path), fetch(:unicorn_config_rel_file_path)) }
+    set :unicorn_config_stage_file_path, Proc.new{ File.join(fetch(:app_path), fetch(:unicorn_config_stage_rel_file_path)) }
+    set :unicorn_default_pid           , Proc.new{ File.join(fetch(:app_path), 'tmp', 'pids', 'unicorn.pid') }
+    set :unicorn_pid, Proc.new{
+      extracted_pid = extract_pid_file
+      if extracted_pid
+        extracted_pid
+      else
+        # TODO logger is not defined
+        #logger.important "err :: failed to auto-detect pid from #{local_unicorn_config}"
+        #logger.important "err :: falling back to default: #{unicorn_default_pid}"
+        fetch :unicorn_default_pid
+      end
+    }
+  end
+end
+
+namespace :unicorn do
+  desc 'Debug Unicorn variables'
+  task :show_vars do
+    on roles :app do
+      puts <<-EOF.gsub(/^ +/, '')
+        # Environments
+        rails_env          #{fetch :rails_env}
+        unicorn_env        #{fetch :unicorn_env}
+        unicorn_rack_env   #{fetch :unicorn_rack_env}
+
+        # Execution
+        unicorn_user       #{fetch(:unicorn_user).inspect}
+        unicorn_bundle     #{fetch :unicorn_bundle}
+        unicorn_bin        #{fetch :unicorn_bin}
+        unicorn_options    #{fetch :unicorn_options}
+        unicorn_restart_sleep_time  #{fetch :unicorn_restart_sleep_time}
+  
+        # Relative paths
+        app_subdir                         #{fetch :app_subdir}
+        unicorn_config_rel_path            #{fetch :unicorn_config_rel_path}
+        unicorn_config_filename            #{fetch :unicorn_config_filename}
+        unicorn_config_rel_file_path       #{fetch :unicorn_config_rel_file_path}
+        unicorn_config_stage_rel_file_path #{fetch :unicorn_config_stage_rel_file_path}
+
+        # Absolute paths
+        app_path                  #{fetch :app_path}
+        unicorn_pid               #{fetch :unicorn_pid}
+        bundle_gemfile            #{fetch :bundle_gemfile}
+        unicorn_config_path       #{fetch :unicorn_config_path}
+        unicorn_config_file_path  #{fetch :unicorn_config_file_path}
+        unicorn_config_stage_file_path
+        ->                        "#{fetch :unicorn_config_stage_file_path}
+      EOF
+    end
+  end
+
+  desc 'Start Unicorn master process'
+  task :start do
+    on roles unicorn_roles, :except => {:no_release => true} do
+      execute start_unicorn
+    end
+  end
+  
+  desc 'Stop Unicorn'
+  task :stop do
+    on roles unicorn_roles, :except => {:no_release => true} do
+      execute kill_unicorn('QUIT')
+    end
+  end
+  
+  desc 'Immediately shutdown Unicorn'
+  task :shutdown do
+    on roles unicorn_roles, :except => {:no_release => true} do
+      execute kill_unicorn('TERM')
+    end
+  end
+  
+  desc 'Restart Unicorn'
+  task :restart do
+    on roles unicorn_roles, :except => {:no_release => true} do
+      execute duplicate_unicorn
+      execute :sleep, fetch(:unicorn_restart_sleep_time)
+      execute "if #{old_unicorn_is_running?}; then #{unicorn_send_signal('QUIT', get_old_unicorn_pid)}; fi;"
+    end
+  end
+
+  desc 'Duplicate Unicorn'
+  task :duplicate do
+    on roles unicorn_roles, :except => {:no_release => true} do
+      execute duplicate_unicorn()
+    end
+  end
+  
+  desc 'Reload Unicorn'
+  task :reload do
+    on roles => unicorn_roles, :except => {:no_release => true} do
+      execute "if #{unicorn_is_running?}; then #{unicorn_send_signal('HUP')}; else #{start_unicorn}; fi;"
+      # run <<-END
+      #   if #{unicorn_is_running?}; then
+      #     echo "Reloading Unicorn...";
+      #       #{unicorn_send_signal('HUP')};
+      #     else
+      #       #{start_unicorn}
+      #     fi;
+      # END
+    end
+  end
+
+  desc 'Add a new worker'
+  task :add_worker do
+    on roles => unicorn_roles, :except => {:no_release => true} do
+      execute "if #{unicorn_is_running?}; then #{unicorn_send_signal('TTIN')}; fi;"
+      # run <<-END
+      #   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
+
+  desc 'Remove amount of workers'
+  task :remove_worker do
+    on roles => unicorn_roles, :except => {:no_release => true} do
+      execute "if #{unicorn_is_running?}; then #{unicorn_send_signal('TTOU')}; fi;"
+      # run <<-END
+      #   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

data/lib/capistrano/unicorn.rb

@@ -0,0 +1 @@
+load File.expand_path(File.join('..', 'tasks', 'unicorn.cap'), __FILE__)

data/lib/capistrano/unicorn/utility.rb

@@ -0,0 +1,166 @@
+require 'tempfile'
+
+module CapistranoUnicorn
+  module Utility
+    # In Capistrano 3, shell scripts must be invoked with SSHKit's execute, instead of run.
+    # SSHKit will "sanitize" all multi-line commands (here docs), replacing "\n" with ";".
+    # Sanitizing renders some shell scripts illegal, for instance:
+    #
+    #   if [ -e FILE ]; then
+    #     echo "Found."
+    #   fi
+    # 
+    # This would become
+    #
+    #   if [ -e FILE ]; then; echo "Found."; fi;
+    #
+    # which is illegal because of the ';' after 'then'.
+    #
+    # To avoid errors, replace all "\n" with " " in shell scripts,
+    # before SSHKit gets a chance to replace "\n" with ";"
+    def local_unicorn_config
+      if File.exist? fetch(:unicorn_config_rel_file_path)
+        fetch(:unicorn_config_rel_file_path)
+      else
+        fetch(:unicorn_config_stage_rel_file_path)
+      end
+    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
+      "#{fetch :unicorn_pid}.oldbin"
+    end
+
+    # Command to check if Unicorn is running
+    #
+    def unicorn_is_running?
+      remote_process_exists?(fetch :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=fetch(: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 fetch(: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.split.join(' ')
+    end
+
+    # Start the Unicorn server
+    #
+    def start_unicorn
+      %Q%
+        if [ -e "#{fetch :unicorn_config_file_path}" ]; then
+          UNICORN_CONFIG_PATH=#{fetch :unicorn_config_file_path};
+        else
+          if [ -e "#{fetch :unicorn_config_stage_file_path}" ]; then
+            UNICORN_CONFIG_PATH=#{fetch :unicorn_config_stage_file_path};
+          else
+            echo "Config file for "#{fetch :unicorn_env}" environment was not found at either "#{fetch :unicorn_config_file_path}" or "#{fetch :unicorn_config_stage_file_path}"";
+            exit 1;
+          fi;
+        fi;
+
+        if [ -e "#{fetch :unicorn_pid}" ]; then
+          if #{try_unicorn_user} kill -0 `cat #{fetch :unicorn_pid}` > /dev/null 2>&1; then
+            echo "Unicorn is already running!";
+            exit 0;
+          fi;
+
+          #{try_unicorn_user} rm #{fetch :unicorn_pid};
+        fi;
+
+        echo "Starting Unicorn...";
+        cd #{fetch :app_path} && #{try_unicorn_user} RAILS_ENV=#{fetch :rails_env} BUNDLE_GEMFILE=#{fetch :bundle_gemfile} #{fetch :unicorn_bundle} exec #{fetch :unicorn_bin} -c $UNICORN_CONFIG_PATH -E #{fetch :unicorn_rack_env} -D #{fetch :unicorn_options};
+      %.split.join(' ')
+    end
+
+    def duplicate_unicorn
+      script = <<-END
+        if #{unicorn_is_running?}; then
+          echo "Duplicating Unicorn...";
+          #{unicorn_send_signal('USR2')};
+        else
+          #{start_unicorn}
+        fi;
+      END
+      script.split.join(' ')
+    end
+
+    def unicorn_roles
+      # TODO proc necessary here?
+      Proc.new{ fetch(:unicorn_roles, :app) }.call
+      #defer{ fetch(:unicorn_roles, :app) }
+    end
+
+  end
+end

data/lib/capistrano/unicorn/version.rb

@@ -0,0 +1,5 @@
+module CapistranoUnicorn
+  unless defined?(::CapistranoUnicorn::VERSION)
+    VERSION = "0.3.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

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: sepastian-capistrano3-unicorn
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+  prerelease: 
+platform: ruby
+authors:
+- Sebastian Gassner, Dan Sosedoff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-22 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: unicorn
+  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: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Capistrano 3.x plugin that integrates Unicorn server tasks.
+email: sebastian.gassner@gmail.com
+executables: []
+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/tasks/unicorn.cap
+- lib/capistrano/unicorn.rb
+- lib/capistrano/unicorn/utility.rb
+- lib/capistrano/unicorn/version.rb
+- lib/unicorn.rb
+- spec/capistrano_integration_spec.rb
+- spec/config_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sepastian/capistrano-unicorn
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Unicorn integration for Capistrano 3.x
+test_files: []
+has_rdoc: