capistrano-simple-unicorn 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f64084737f469cb0dcf81ff40b7c3c1130a0a450
-  data.tar.gz: af00481fadf86312dcb2d9c5b5fda7048151f96a
+  metadata.gz: dc900d264d6068259766d0fd89b6a73eccd7fe8b
+  data.tar.gz: 4815ed5cbe0251e1f4d06cbea417cd914223e9bf
 SHA512:
-  metadata.gz: ad68e3d32476967894822e35cd88b2dff20f75286635594d97d6cc3c65a07737091145160a5caa6561c97afad716cb1a1d477ddc6fd7986ac769d52148e00e6a
-  data.tar.gz: 6ad7e35e6e67762392178e557743c7e458ad18944b36c0c370b354ef47e1fa63569e3ce0fc3c53a749c22a7d7c3610b89828d27e30ba7a9fd5417c05a41cc86a
+  metadata.gz: ab7943a6de75ce9c6e43c646029f48716ff3156176a5f1c1fbdea7de0414469f4d190abd3c405de8bc7a1724d5baaaa2028733ed115f68eb9b89884794cd3f62
+  data.tar.gz: 44f112be6584c1dd2f7d793d9c73cbf33d904fba841d2c638007903ee1a9fa7cdd9a14bbbf2743dbd8a7494fdf3fa5df2000b70cd9744defb04fbf094b84946b

data/README.md

@@ -1,4 +1,4 @@
-# Capistrano::SimpleNginx
+# Capistrano::SimpleUnicorn
 Support for Capistrano 3.x
 
 Capistrano task for automatic and unicorn configuration
@@ -40,9 +40,9 @@ Default value:
 ```
 set :unicorn_service, -> { "unicorn_#{fetch(:application)}" }
 set :user_home_path, -> { "/home/#{fetch(:user)}" }
-set :unicorn_config_file, -> { shared_path.join("config", "unicorn.rb") }
-set :unicorn_pid_file, -> { shared_path.join("tmp", "pids", "unicorn.pid") }
-set :unicorn_sock_file, -> { shared_path.join("tmp", "unicorn.sock") }
+set :unicorn_config_path, -> { shared_path.join("config", "unicorn.rb") }
+set :unicorn_pid_path, -> { shared_path.join("tmp", "pids", "unicorn.pid") }
+set :unicorn_sock_path, -> { shared_path.join("tmp", "unicorn.sock") }
 set :unicorn_log_file, -> { shaed_path.join("log", "unicorn.stdout.log") }
 set :unicorn_error_log_file, -> {shared_path.join("log","unicorn.stderr.log")}
 set :ruby_version, -> { fetch(:rvm_ruby_version) || fetch(:rbenv_ruby) }
@@ -96,5 +96,5 @@ set :nginx_upstream_file, "/tmp/unicorn.sock"
     set :nginx_fail_timeout, 0
     set :nginx_access_log_file, -> { "/var/log/nginx/#{fetch(:nginx_config_name)}.access.log" } # access log file
     set :nginx_error_log_file, -> { "/var/log/nginx/#{fetch(:nginx_config_name)}.error.log" } # error log file
-    set :nginx_upstream_file, -> { "#{fetch(:unicorn_sock_file)}" } # .sock file path
+    set :nginx_upstream_file, -> { "#{fetch(:unicorn_sock_path)}" } # .sock file path
 ```

data/lib/capistrano/simple_unicorn/helpers.rb

@@ -44,15 +44,15 @@ module Capistrano
         "/etc/init.d/#{fetch(:unicorn_service)}"
       end
 
-      def unicorn_sock_file
+      def unicorn_sock_path
         shared_path.join("tmp", "unicorn.sock")
       end
 
-      def unicorn_config_file
+      def unicorn_config_path
         shared_path.join("config", "unicorn.rb")
       end
 
-      def unicorn_pid_file
+      def unicorn_pid_path
         shared_path.join("tmp", "pids", "unicorn.pid")
       end
 

data/lib/capistrano/simple_unicorn/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module SimpleUnicorn
-    VERSION = '1.0.0'.freeze
+    VERSION = '1.1.0'.freeze
   end
 end

data/lib/capistrano/tasks/nginx.rake

@@ -10,7 +10,7 @@ namespace :load do
     set :nginx_fail_timeout, 0
     set :nginx_access_log_file, -> { "/var/log/nginx/#{fetch(:nginx_config_name)}.access.log" }
     set :nginx_error_log_file, -> { "/var/log/nginx/#{fetch(:nginx_config_name)}.error.log" }
-    set :nginx_upstream_file, -> { "#{fetch(:unicorn_sock_file)}" }
+    set :nginx_upstream_file, -> { "#{fetch(:unicorn_sock_path)}" }
   end
 end
 

data/lib/capistrano/tasks/unicorn.rake

@@ -5,11 +5,15 @@ namespace :load do
   task :defaults do
     set :unicorn_service, -> { "unicorn_#{fetch(:application)}" }
     set :user_home_path, -> { "/home/#{fetch(:user)}" }
-    set :unicorn_config_file, -> { unicorn_config_file }
-    set :unicorn_pid_file, -> { unicorn_pid_file }
-    set :unicorn_sock_file, -> { unicorn_sock_file }
-    set :unicorn_log_file, -> { unicorn_log_file }
-    set :unicorn_error_log_file, -> { unicorn_error_log_file }
+    set :unicorn_config_path, -> { unicorn_config_path }
+    set :unicorn_pid_path, -> { unicorn_pid_path }
+    set :unicorn_sock_path, -> { unicorn_sock_path }
+    set :unicorn_stdout_path, -> { unicorn_log_file }
+    set :unicorn_stderr_path, -> { unicorn_error_log_file }
+    set :unicorn_roles, -> { :app }
+    set :unicorn_restart_sleep_time, 3
+    set :unicorn_options, -> { '' }
+    set :unicorn_env, -> { fetch(:rails_env) || 'deployment' }
     set :ruby_version, -> { fetch(:rvm_ruby_version) || fetch(:rbenv_ruby) }
     set :unicorn_worker_processes, 2
     set :unicorn_timeout, 30
@@ -19,52 +23,70 @@ namespace :load do
 end
 
 namespace :unicorn do
-  desc 'Unicorn Initializer'
-  task :unicorn_init do
-    on roles :app do
-      sudo_upload! template('unicorn_init.erb'), unicorn_initd_file
-      execute :chmod, '+x', unicorn_initd_file
-      if os_is_ubuntu?
-        sudo 'update-rc.d', '-f', fetch(:unicorn_service), 'defaults'
-      else
-        sudo 'chkconfig', '--add', fetch(:unicorn_service)
+  desc 'Start Unicorn' do
+    task :start do
+      on roles(fetch(:unicorn_roles)) do
+        within current_path do
+          if test("[ -e #{fetch(:unicorn_pid)} ] && kill -0 #{pid}")
+            info 'unicorn is running...'
+          else
+            with rails_env: fetch(:rails_env) do
+              execute :bundle, 'exec unicorn', '-c', fetch(:unicorn_config_path), '-E', fetch(:unicorn_env), '-D', fetch(:unicorn_options)
+            end
+          end
+        end
       end
     end
   end
 
-  desc 'Setup unicorn config'
-  task :setup_unicorn_config do
-    on roles :app do
-      unless file_exists? fetch(:unicorn_config_file)
-        execute :mkdir, '-pv', File.dirname(fetch(:unicorn_config_file))
+  desc 'Stop Unicorn (QUIT)'
+  task :stop do
+    on roles(fetch(:unicorn_roles)) do
+      within current_path do
+        if test("[ -e #{fetch(:unicorn_pid_path)} ]")
+          if test("kill -0 #{pid}")
+            info 'stopping unicorn...'
+            execute :kill, '-s QUIT', pid
+          else
+            info 'cleaning up dead unicorn pid...'
+            execute :rm, fetch(:unicorn_pid_path)
+          end
+        else
+          info 'unicorn is not running...'
+        end
       end
-      upload! template('unicorn.rb.erb'), fetch(:unicorn_config_file)
     end
   end
 
-  %w[start stop restart upgrade].each do |action|
-    desc "#{action} unicorn"
-    task action do
-      on roles :app do
-        sudo :service, fetch(:unicorn_service), action
+  desc 'Restart Unicorn (USR2); use this when preload_app: true'
+  task :restart do
+    invoke 'unicorn:start'
+    on roles(fetch(:unicorn_roles)) do
+      within current_path do
+        info 'unicorn restarting...'
+        execute :kill, '-s USR2', pid
       end
     end
   end
 
-  desc 'restart unicorn'
-  task 'reload' do
-    on roles :app do
-      invoke "unicorn:unicorn_init" unless file_exists?(unicorn_initd_file)
-      invoke 'unicorn:setup_unicorn_config'
-      if test "[ -f #{fetch(:unicorn_pid)} ]"
-        sudo 'service', fetch(:unicorn_service), 'restart'
-      else
-        sudo 'service', fetch(:unicorn_service), 'start'
+  desc 'Legacy Restart (USR2 + QUIT); use this when preload_app: true and oldbin pid needs cleanup'
+  task :legacy_restart do
+    invoke 'unicorn:restart'
+    on roles(fetch(:unicorn_roles)) do
+      within current_path do
+        execute :sleep, fetch(:unicorn_restart_sleep_time)
+        if test("[ -e #{fetch(:unicorn_pid_path)}.oldbin ]")
+          execute :kill, '-s QUIT', pid_oldbin
+        end
       end
     end
   end
 end
 
-namespace :deploy do
-  after :publishing, 'unicorn:reload'
+def pid
+  "`cat #{fetch(:unicorn_pid_path)}`"
+end
+
+def pid_oldbin
+  "`cat #{fetch(:unicorn_pid_path)}.oldbin`"
 end

data/lib/generators/capistrano/simple_unicorn/templates/unicorn.rb.erb

@@ -1,26 +1,36 @@
 worker_processes <%= fetch(:unicorn_worker_processes) %>
 timeout <%= fetch(:unicorn_timeout) %>
+app_path = "<%= fetch(:deploy_to) %>"
+listen "<%= fetch(:unicorn_sock_path) %>"
+pid "<%= fetch(:unicorn_pid_path) %>"
 
-listen "<%= fetch(:unicorn_sock_file) %>"
-pid "<%= fetch(:unicorn_pid_file) %>"
+stderr_path "<%= fetch(:unicorn_stderr_path) %>"
+stdout_path "<%= fetch(:unicorn_stdout_path %>"
 
-stderr_path "<%= fetch(:unicorn_error_log_file) %>"
-stdout_path "<%= fetch(:unicorn_log_file) %>"
+preload_app true
+
+# use correct Gemfile on restarts
+before_exec do |server|
+  ENV['BUNDLE_GEMFILE'] = "#{app_path}/current/Gemfile"
+end
 
 preload_app true
 
 before_fork do |server, worker|
-  defined?(ActiveRecord::Base) and ActiveRecord::Base.connection.disconnect!
+  # the following is highly recomended for Rails + "preload_app true"
+  # as there's no need for the master process to hold a connection
+  if defined?(ActiveRecord::Base)
+    ActiveRecord::Base.connection.disconnect!
+  end
 
-  old_pid = "#{ server.config[:pid] }.oldbin"
-  unless old_pid == server.pid
+  # Before forking, kill the master process that belongs to the .oldbin PID.
+  # This enables 0 downtime deploys.
+  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
+      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|
-  defined?(ActiveRecord::Base) and ActiveRecord::Base.establish_connection
-end

data/lib/generators/capistrano/simple_unicorn/templates/unicorn_init.erb

@@ -11,11 +11,11 @@
 set -e
 HOME=<%= fetch(:user_home_path) %>
 APP_ROOT=<%= current_path %>
-PID=<%= fetch(:unicorn_pid_file) %>
+PID=<%= fetch(:unicorn_pid_path) %>
 USER=<%= fetch(:user) %>
 ENV="<%= fetch(:stage) %>"
 RUBY_VERSION="<%= fetch(:ruby_version) %>"
-CONFIG_FILE="<%= fetch(:unicorn_config_file) %>"
+CONFIG_FILE="<%= fetch(:unicorn_config_path) %>"
 CMD="cd $APP_ROOT && export RBENV_ROOT="$HOME/.rbenv" RBENV_VERSION=$RUBY_VERSION; $HOME/.rbenv/bin/rbenv exec bundle exec unicorn -c $CONFIG_FILE -E $ENV -D"
 
 set -u

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-simple-unicorn
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - truongkma