capistrano-delayed_job 0.0.3 → 0.0.4

data/Gemfile

@@ -1,7 +1,7 @@
 source 'http://rubygems.org'
 
 gem "capistrano",     ">= 2.15.5"
-gem 'capistrano-base_helper', ">= 0.0.5"
+gem 'capistrano-base_helper', ">= 0.0.6"
 
 group :development do
   gem "bundler", ">= 1.3.0"

data/Gemfile.lock

@@ -9,7 +9,7 @@ GEM
       net-sftp (>= 2.0.0)
       net-ssh (>= 2.0.14)
       net-ssh-gateway (>= 1.1.0)
-    capistrano-base_helper (0.0.5)
+    capistrano-base_helper (0.0.6)
       capistrano (>= 2.15.5)
     faraday (0.8.7)
       multipart-post (~> 1.1)
@@ -65,5 +65,5 @@ PLATFORMS
 DEPENDENCIES
   bundler (>= 1.3.0)
   capistrano (>= 2.15.5)
-  capistrano-base_helper (>= 0.0.5)
+  capistrano-base_helper (>= 0.0.6)
   jeweler (~> 1.8.6)

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/capistrano-delayed_job.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "capistrano-delayed_job"
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Leif Ringstad"]
-  s.date = "2013-07-05"
+  s.date = "2013-07-08"
   s.description = "Capistrano recipes for Delayed Job using runit and monit."
   s.email = "leifcr@gmail.com"
   s.extra_rdoc_files = [
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
     "lib/capistrano/delayed_job/monit.rb",
     "lib/capistrano/delayed_job/runit.rb",
     "templates/monit/delayed_job.conf.erb",
+    "templates/runit/finish.erb",
     "templates/runit/log-run.erb",
     "templates/runit/run.erb"
   ]
@@ -43,18 +44,18 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<capistrano>, [">= 2.15.5"])
-      s.add_runtime_dependency(%q<capistrano-base_helper>, [">= 0.0.5"])
+      s.add_runtime_dependency(%q<capistrano-base_helper>, [">= 0.0.6"])
       s.add_development_dependency(%q<bundler>, [">= 1.3.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.6"])
     else
       s.add_dependency(%q<capistrano>, [">= 2.15.5"])
-      s.add_dependency(%q<capistrano-base_helper>, [">= 0.0.5"])
+      s.add_dependency(%q<capistrano-base_helper>, [">= 0.0.6"])
       s.add_dependency(%q<bundler>, [">= 1.3.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.6"])
     end
   else
     s.add_dependency(%q<capistrano>, [">= 2.15.5"])
-    s.add_dependency(%q<capistrano-base_helper>, [">= 0.0.5"])
+    s.add_dependency(%q<capistrano-base_helper>, [">= 0.0.6"])
     s.add_dependency(%q<bundler>, [">= 1.3.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.6"])
   end

data/lib/capistrano/delayed_job/config.rb

@@ -10,8 +10,14 @@ Capistrano::Configuration.instance(true).load do
   # Logging to path
   _cset :delayed_job_log_path, defer {"/var/log/service/#{fetch(:user)}/#{fetch(:application)}_#{Capistrano::BaseHelper.environment}/delayed_job"}
 
-  # runit paths
-  _cset :delayed_job_runit_local_config,  File.join(File.expand_path(File.join(File.dirname(__FILE__),"../../../templates", "runit", )), "run.erb")
+  # runit defaults
+  _cset :delayed_job_restart_interval, defer {fetch(:runit_restart_interval)}
+  _cset :delayed_job_restart_count, defer {fetch(:runit_restart_count)}
+  _cset :delayed_job_autorestart_clear_interval, defer {fetch(:runit_autorestart_clear_interval)}
+
+    # runit paths
+  _cset :delayed_job_runit_local_run,     File.join(File.expand_path(File.join(File.dirname(__FILE__),"../../../templates", "runit", )), "run.erb")
+  _cset :delayed_job_runit_local_finish,  File.join(File.expand_path(File.join(File.dirname(__FILE__),"../../../templates", "runit", )), "finish.erb")
   _cset :delayed_job_runit_control_q,     File.join(File.expand_path(File.join(File.dirname(__FILE__),"../../../templates", "runit")), "control-q.erb")
   _cset :delayed_job_runit_local_log_run, File.join(File.expand_path(File.join(File.dirname(__FILE__),"../../../templates", "runit")), "log-run.erb")
 

data/lib/capistrano/delayed_job/runit.rb

@@ -17,10 +17,8 @@ Capistrano::Configuration.instance(true).load do
       task :setup, :roles => :app do
         # Create runit config
         Capistrano::RunitBase.create_service_dir(delayed_job_runit_service_name)
-        Capistrano::BaseHelper::generate_and_upload_config(delayed_job_runit_local_config, Capistrano::RunitBase.remote_run_config_path(delayed_job_runit_service_name))
-        # must use quit script for stop as well
-        # Capistrano::BaseHelper::generate_and_upload_config(delayed_job_runit_control_q, Capistrano::RunitBase.remote_control_path(delayed_job_runit_service_name, "q"))
-        # Capistrano::BaseHelper::generate_and_upload_config(delayed_job_runit_control_q, Capistrano::RunitBase.remote_control_path(delayed_job_runit_service_name, "s"))
+        Capistrano::BaseHelper::generate_and_upload_config(delayed_job_runit_local_run, Capistrano::RunitBase.remote_run_config_path(delayed_job_runit_service_name))
+        Capistrano::BaseHelper::generate_and_upload_config(delayed_job_runit_local_finish, Capistrano::RunitBase.remote_finish_config_path(delayed_job_runit_service_name))
 
         # Log run script
         Capistrano::BaseHelper::generate_and_upload_config(delayed_job_runit_local_log_run, Capistrano::RunitBase.remote_service_log_run_path(delayed_job_runit_service_name))

data/templates/runit/finish.erb

@@ -0,0 +1,135 @@
+#!/bin/bash
+#
+# This finish file is originally from:
+# https://github.com/erwbgy/puppet-runit/blob/fde6006e6d400f0c99b6ff0b1b63094207dc8783/templates/service/finish.erb
+# Thanks to erwbgy!
+#
+# <% c = Capistrano::BaseHelper::get_capistrano_instance %>
+# Variable name setup
+<%
+exit_code   = "EXIT_CODE_#{Capistrano::BaseHelper.user_app_env_underscore_short}_#{c.fetch(:delayed_job_runit_service_name)}".upcase
+exit_status = "EXIT_STATUS_#{Capistrano::BaseHelper.user_app_env_underscore_short}_#{c.fetch(:delayed_job_runit_service_name)}".upcase
+min_auto_restart_interval         = "MIN_AUTO_RESTART_INTERVAL_#{Capistrano::BaseHelper.user_app_env_underscore_short}_#{c.fetch(:delayed_job_runit_service_name)}".upcase
+max_auto_restart_count            = "MAX_AUTO_RESTART_COUNT_#{Capistrano::BaseHelper.user_app_env_underscore_short}_#{c.fetch(:delayed_job_runit_service_name)}".upcase
+auto_restart_count_clear_interval = "AUTO_RESTART_COUNT_CLEAR_INTERVAL_#{Capistrano::BaseHelper.user_app_env_underscore_short}_#{c.fetch(:delayed_job_runit_service_name)}".upcase
+%>
+#
+# The following variables are set by Runit:
+#
+# <%= "#{exit_code}" %>: ./run's exit code
+#
+# <%= "#{exit_status}" %>: The least significant byte of the exit status as determined by
+#  waitpid(2); for instance it is 0 if ./run exited normally, and the signal
+#  number if ./run was terminated by a signal.
+#
+# The following configuration variables must be set:
+#
+# <%= "#{min_auto_restart_interval}" %>: The minimum delay (in seconds) between automatic restarts
+#
+# <%= "#{max_auto_restart_count}" %>: The maximum number of automatic restarts allowed
+#
+# <%= "#{auto_restart_count_clear_interval}" %>: Reset the restart count if
+#  <%= "#{auto_restart_count_clear_interval}" %> seconds have elapsed since the last
+#  automatic restart.
+#
+# Creates two new files in the service directory:
+#
+#   last_finish - the Unix time (seconds since 1970) when the ./finish script
+#                 last ran
+#
+#   restart_count - the number of automatic restarts that have taken place
+#
+# These files must be removed BEFORE the service is cleanly shut down.
+
+### Configuration
+
+# ./run's exit code
+<%= "#{exit_code}" %>=$1
+ 
+# The least significant byte of the exit status as determined by waitpid(2);
+# for instance it is 0 if ./run exited normally, and the signal number if
+# ./run was terminated by a signal.
+<%= "#{exit_status}" %>=$2
+ 
+# The minimum delay (in seconds) between automatic restarts
+<%= "#{min_auto_restart_interval}" %>=<%= c.fetch(:delayed_job_restart_interval) %>
+ 
+# The maximum number of automatic restarts allowed
+<%= "#{max_auto_restart_count}" %>=<%= c.fetch(:delayed_job_restart_count) %>
+ 
+# Reset the restart count if <%= "#{auto_restart_count_clear_interval}" %> seconds
+# have elapsed since the last automatic restart.
+<%= "#{auto_restart_count_clear_interval}" %>=<%= c.fetch(:delayed_job_autorestart_clear_interval) %>
+
+export <%= "#{exit_code}" %>
+export <%= "#{exit_status}" %>
+export <%= "#{min_auto_restart_interval}" %>
+export <%= "#{max_auto_restart_count}" %>
+export <%= "#{auto_restart_count_clear_interval }" %>
+
+### Normally no changes should be made after this point
+ 
+echo "<%= "User: #{c.fetch(:user)} Application: #{c.fetch(:application)} Service: #{c.fetch(:delayed_job_runit_service_name)}" %> finish; exit code: $<%= "#{exit_code}" %>; exit status: $<%= "#{exit_status}" %>"
+
+if test $<%= "#{exit_code}" %> -eq 0 -a $<%= "#{exit_status}" %> -eq 0
+then
+    echo "Clean shutdown."
+    sv down .
+    exit 0
+fi
+
+NOW=$(date +%s)
+
+# Determine when the finish script last ran
+if test -r last_finish
+then
+    LAST_FINISH=$(head -1 last_finish)
+    INTERVAL=$(expr $NOW - $LAST_FINISH)
+fi
+echo $NOW > last_finish
+
+# Remove the restart_count file if <%= "#{auto_restart_count_clear_interval}" %> seconds
+# have elapsed since the last automatic restart.
+if test $INTERVAL -gt $<%= "#{auto_restart_count_clear_interval}" %>
+then
+    echo "NOTICE: <%= "User: #{c.fetch(:user)} Application: #{c.fetch(:application)} Service: #{c.fetch(:delayed_job_runit_service_name)}" %>"
+    echo "The last automatic restart was $INTERVAL seconds ago."
+    echo "Since this is greater than $<%= "#{auto_restart_count_clear_interval}" %> the restart count is being reset."
+    rm -f restart_count
+fi
+
+# Determine how many automatic restarts we have had
+# and then increment this value by one
+if test -r restart_count
+then
+    RESTART_COUNT=$(head -1 restart_count)
+    RESTART_COUNT=$(expr $RESTART_COUNT + 1)
+else
+    RESTART_COUNT=1
+fi
+echo $RESTART_COUNT > restart_count
+
+# Check that we have not exceeded the maximum number of automatic restarts
+if test $RESTART_COUNT -gt $<%= "#{max_auto_restart_count}" %>
+then
+    echo "WARNING: <%= "User: #{c.fetch(:user)} Application: #{c.fetch(:application)} Service: #{c.fetch(:delayed_job_runit_service_name)}" %>"
+    echo "Reached the limit of $<%= "#{max_auto_restart_count}" %> automatic restarts."
+    echo "The last automatic restart was within $<%= "#{auto_restart_count_clear_interval}" %> seconds."
+    echo "Manual intervention required.  No further automatic restarts will be attempted."
+    sv down .
+    exit 0
+fi
+
+if test -n "$INTERVAL"
+then
+    SLEEP_TIME=$(expr $<%= "#{min_auto_restart_interval}" %> - $INTERVAL)
+    if test $SLEEP_TIME -gt 0
+    then
+        echo "NOTICE: Restart attempt $RESTART_COUNT for <%= "User: #{c.fetch(:user)} Application: #{c.fetch(:application)} Service: #{c.fetch(:delayed_job_runit_service_name)}" %>"
+        echo "$INTERVAL seconds have elapsed since the last automatic restart."
+        echo "Sleeping for $SLEEP_TIME seconds before the next automatic restart ..."
+        sleep $SLEEP_TIME
+    fi
+fi
+
+exit 0

data/templates/runit/run.erb

@@ -1,6 +1,14 @@
 #!/bin/bash --login
 # Start delayed job using rake
 <% c = Capistrano::BaseHelper::get_capistrano_instance %>
-cd '<%= c.current_path %>'
+# Redirect stderr so everything ends up in the log file
 exec 2>&1
+
+# Announce start
+echo "<%= "User: #{c.fetch(:user)} Application: #{c.fetch(:application)} Service: #{c.fetch(:delayed_job_runit_service_name)}" %> starting..."
+
+# Change path to current path
+cd '<%= c.current_path %>'
+
+# Start delayed job
 RAILS_ENV=<%= Capistrano::BaseHelper.environment %> exec <%= c.fetch(:delayed_job_bin) %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-delayed_job
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-05 00:00:00.000000000 Z
+date: 2013-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: 0.0.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: 0.0.6
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -95,6 +95,7 @@ files:
 - lib/capistrano/delayed_job/monit.rb
 - lib/capistrano/delayed_job/runit.rb
 - templates/monit/delayed_job.conf.erb
+- templates/runit/finish.erb
 - templates/runit/log-run.erb
 - templates/runit/run.erb
 homepage: https://github.com/leifcr/capistrano-delayed_job
@@ -112,7 +113,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 17458906657746692
+      hash: -3670686879823204823
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: