capistrano-resque 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e15d3f8b0d54a6296f6bf508c33dc7314f335dd
-  data.tar.gz: 1f59211f7df131c3ec3067d8d48915c8ca82d2ea
+  metadata.gz: 5b898f69f6ed18119548b8e823a1e4256a05bacf
+  data.tar.gz: a3125435d75fa17c2178bde81ea35d744ee9a028
 SHA512:
-  metadata.gz: 15c30dc1bb42ca0b7891732921eebb365fe4ac5698a13c747f282b3c7a9bcf4a987e7f2c4f4ddcc5c5fbdeecfecf135f8f4de413266b971254c1eae17dd491b7
-  data.tar.gz: a2bfd6313c338ffef06a2f9173faf76c2b9cb94a5b4eac6a04902e45fa91f0d76a5ee3b8a67124de4021189da259b3acde1049e8aa90a19db28b321944d12087
+  metadata.gz: 0feb02dd81e7a47541af2b2af9b562278938b95ff40fd83a99de26ff85a9b40e6705cce6fb537b9b9eddbee7163033cd3f04229f8ecf72d129bcb6380a791429
+  data.tar.gz: 8481eeb7d14e711bcac8c218a0c736ea8e706c8d8a929c30291a829742b5f7daa8513a3a87e3acac36192a20b232c81e4ec2aaa9f08ee77f50b3ff70a04034c6

data/Changelog.md

@@ -1,8 +1,15 @@
-# Unreleased
+# 0.2.1
+* Create the directory for pid files when it doesn't exist
+* Default pid files to `#{shared_path}/tmp/pids` now
+* Added a `:resque_pid_path` option to specify a custom path
+
+# 0.2.0
 * Added support for Capistrano 3.0
 * Set MUTE environment variable for resque_scheduler
 * Added a `resque_environment_task` option to load the `environment` rake task before running Resque workers
 * Add a resque:scheduler:status task
+* Detect stale PID files and clean up instead of aborting
+* Add a `resque_rails_env` setting in case workers need to be run in a different environment than the app itself
 
 # 0.1.0
 * Interval is configurable

data/README.md

@@ -27,9 +27,10 @@ role :resque_scheduler, "app_domain"
 
 set :workers, { "my_queue_name" => 2 }
 
-# To ensure resque can start/stop properly between deploys, you'll want to make
-# sure to link the `tmp/pids` directory.
-set :linked_dirs, %w(tmp/pids)
+# We default to storing PID files in a tmp/pids folder in your shared path, but
+# you can customize it here (make sure to use a full path). The path will be
+# created before starting workers if it doesn't already exist.
+# set :resque_pid_path, -> { File.join(shared_path, 'tmp', 'pids') }
 
 # Uncomment this line if your workers need access to the Rails environment:
 # set :resque_environment_task, true
@@ -158,8 +159,9 @@ To to use more workers, please change your sshd configuration (/etc/ssh/sshd_con
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+4. If possible, make sure your changes apply to both the Capistrano v2 and v3 code (`capistrano_integration.rb` is v2, `capistrano-resque.rake` is v3)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request
 
 ### License
 

data/lib/capistrano-resque/capistrano_integration.rb

@@ -11,6 +11,7 @@ module CapistranoResque
         _cset(:interval, "5")
         _cset(:resque_environment_task, false)
         _cset(:resque_log_file, "/dev/null")
+        _cset(:resque_pid_path) { File.join(shared_path, 'tmp', 'pids') }
 
         def rails_env
           fetch(:resque_rails_env, fetch(:rails_env, "production"))
@@ -36,8 +37,8 @@ module CapistranoResque
         end
 
         def status_command
-          "if [ -e #{current_path}/tmp/pids/resque_work_1.pid ]; then \
-            for f in $(ls #{current_path}/tmp/pids/resque_work*.pid); \
+          "if [ -e #{fetch(:resque_pid_path)}/resque_work_1.pid ]; then \
+            for f in $(ls #{fetch(:resque_pid_path)}/resque_work*.pid); \
               do ps -p $(cat $f) | sed -n 2p ; done \
            ;fi"
         end
@@ -51,8 +52,8 @@ module CapistranoResque
         end
 
         def stop_command
-          "if [ -e #{current_path}/tmp/pids/resque_work_1.pid ]; then \
-           for f in `ls #{current_path}/tmp/pids/resque_work*.pid`; \
+          "if [ -e #{fetch(:resque_pid_path)}/resque_work_1.pid ]; then \
+           for f in `ls #{fetch(:resque_pid_path)}/resque_work*.pid`; \
              do \
                if kill -0 `cat $f`> /dev/null 2>&1; then \
                  kill -s #{resque_kill_signal} `cat $f` \
@@ -66,8 +67,8 @@ module CapistranoResque
         end
 
         def status_scheduler
-          "if [ -e #{current_path}/tmp/pids/scheduler.pid ]; then \
-             ps -p $(cat #{current_path}/tmp/pids/scheduler.pid) | sed -n 2p \
+          "if [ -e #{fetch(:resque_pid_path)}/scheduler.pid ]; then \
+             ps -p $(cat #{fetch(:resque_pid_path)}/scheduler.pid) | sed -n 2p \
            ;fi"
         end
 
@@ -83,6 +84,13 @@ module CapistranoResque
            ;fi"
         end
 
+        def create_pid_path
+          "if [ ! -d #{fetch(:resque_pid_path)} ]; then \
+            echo 'Creating #{fetch(:resque_pid_path)}' \
+            && mkdir -p #{fetch(:resque_pid_path)}\
+          ;fi"
+        end
+
         namespace :resque do
           desc "See current worker status"
           task :status, :roles => lambda { workers_roles() }, :on_no_matching_servers => :continue do
@@ -91,13 +99,14 @@ module CapistranoResque
 
           desc "Start Resque workers"
           task :start, :roles => lambda { workers_roles() }, :on_no_matching_servers => :continue do
+            run(create_pid_path)
             for_each_workers do |role, workers|
               worker_id = 1
               workers.each_pair do |queue, number_of_workers|
                 logger.info "Starting #{number_of_workers} worker(s) with QUEUE: #{queue}"
                 threads = []
                 number_of_workers.times do
-                  pid = "./tmp/pids/resque_work_#{worker_id}.pid"
+                  pid = "#{fetch(:resque_pid_path)}/resque_work_#{worker_id}.pid"
                   threads << Thread.new(pid) { |pid| run(start_command(queue, pid), :roles => role) }
                   worker_id += 1
                 end
@@ -131,13 +140,14 @@ module CapistranoResque
 
             desc "Starts resque scheduler with default configs"
             task :start, :roles => :resque_scheduler do
-              pid = "#{current_path}/tmp/pids/scheduler.pid"
+              run(create_pid_path)
+              pid = "#{fetch(:resque_pid_path)}/scheduler.pid"
               run(start_scheduler(pid))
             end
 
             desc "Stops resque scheduler"
             task :stop, :roles => :resque_scheduler do
-              pid = "#{current_path}/tmp/pids/scheduler.pid"
+              pid = "#{fetch(:resque_pid_path)}/scheduler.pid"
               run(stop_scheduler(pid))
             end
 

data/lib/capistrano-resque/tasks/capistrano-resque.rake

@@ -5,6 +5,7 @@ namespace :load do
     set :interval, "5"
     set :resque_environment_task, false
     set :resque_log_file, "/dev/null"
+    set :resque_pid_path, -> { File.join(shared_path, 'tmp', 'pids') }
   end
 end
 
@@ -34,12 +35,19 @@ namespace :resque do
     end
   end
 
+  def create_pid_path
+    if !(test "[ -d #{fetch(:resque_pid_path)} ]")
+      info "Creating #{fetch(:resque_pid_path)}"
+      execute :mkdir, "-p #{fetch(:resque_pid_path)}"
+    end
+  end
+
   desc "See current worker status"
   task :status do
     on roles(*workers_roles) do
-      if test "[ -e #{current_path}/tmp/pids/resque_work_1.pid ]"
+      if test "[ -e #{fetch(:resque_pid_path)}/resque_work_1.pid ]"
         within current_path do
-          files = capture(:ls, "-1 tmp/pids/resque_work*.pid")
+          files = capture(:ls, "-1 #{fetch(:resque_pid_path)}/resque_work*.pid")
           files.each_line do |file|
             info capture(:ps, "-f -p $(cat #{file.chomp}) | sed -n 2p")
           end
@@ -50,13 +58,15 @@ namespace :resque do
 
   desc "Start Resque workers"
   task :start do
+
     for_each_workers do |role, workers|
       on roles(role) do
+        create_pid_path
         worker_id = 1
         workers.each_pair do |queue, number_of_workers|
           info "Starting #{number_of_workers} worker(s) with QUEUE: #{queue}"
           number_of_workers.times do
-            pid = "./tmp/pids/resque_work_#{worker_id}.pid"
+            pid = "#{fetch(:resque_pid_path)}/resque_work_#{worker_id}.pid"
             within current_path do
               execute :rake, %{RAILS_ENV=#{rails_env} QUEUE="#{queue}" PIDFILE=#{pid} BACKGROUND=yes VERBOSE=1 INTERVAL=#{fetch(:interval)} #{"environment" if fetch(:resque_environment_task)} resque:work #{output_redirection}}
             end
@@ -76,9 +86,9 @@ namespace :resque do
   desc "Quit running Resque workers"
   task :stop do
     on roles(*workers_roles) do
-      if test "[ -e #{current_path}/tmp/pids/resque_work_1.pid ]"
+      if test "[ -e #{fetch(:resque_pid_path)}/resque_work_1.pid ]"
         within current_path do
-          pids = capture(:ls, "-1 tmp/pids/resque_work*.pid").lines.map(&:chomp)
+          pids = capture(:ls, "-1 #{fetch(:resque_pid_path)}/resque_work*.pid").lines.map(&:chomp)
           pids.each do |pid_file|
             pid = capture(:cat, pid_file)
             if test "kill -0 #{pid} > /dev/null 2>&1"
@@ -105,7 +115,7 @@ namespace :resque do
     desc "See current scheduler status"
     task :status do
       on roles :resque_scheduler do
-        pid = "#{current_path}/tmp/pids/scheduler.pid"
+        pid = "#{fetch(:resque_pid_path)}/scheduler.pid"
         if test "[ -e #{pid} ]"
           info capture(:ps, "-f -p $(cat #{pid}) | sed -n 2p")
         end
@@ -115,7 +125,8 @@ namespace :resque do
     desc "Starts resque scheduler with default configs"
     task :start do
       on roles :resque_scheduler do
-        pid = "#{current_path}/tmp/pids/scheduler.pid"
+        create_pid_path
+        pid = "#{fetch(:resque_pid_path)}/scheduler.pid"
         within current_path do
           execute :rake, %{RAILS_ENV=#{rails_env} PIDFILE=#{pid} BACKGROUND=yes VERBOSE=1 MUTE=1 resque:scheduler #{output_redirection}}
         end
@@ -125,7 +136,7 @@ namespace :resque do
     desc "Stops resque scheduler"
     task :stop do
       on roles :resque_scheduler do
-        pid = "#{current_path}/tmp/pids/scheduler.pid"
+        pid = "#{fetch(:resque_pid_path)}/scheduler.pid"
         if test "[ -e #{pid} ]"
           execute :kill, "-s #{fetch(:resque_kill_signal)} $(cat #{pid}); rm #{pid}"
         end

data/lib/capistrano-resque/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-resque
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Steven Shingler