capistrano-delayed_job 0.0.1

data/Gemfile

@@ -0,0 +1,9 @@
+source 'http://rubygems.org'
+
+gem "capistrano",     ">= 2.15.5"
+gem 'capistrano-base_helper', ">= 0.0.3"
+
+group :development do
+  gem "bundler", ">= 1.3.0"
+  gem "jeweler", "~> 1.8.6"
+end

data/Gemfile.lock

@@ -0,0 +1,69 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    builder (3.2.2)
+    capistrano (2.15.5)
+      highline
+      net-scp (>= 1.0.0)
+      net-sftp (>= 2.0.0)
+      net-ssh (>= 2.0.14)
+      net-ssh-gateway (>= 1.1.0)
+    capistrano-base_helper (0.0.3)
+      capistrano (>= 2.15.5)
+    faraday (0.8.7)
+      multipart-post (~> 1.1)
+    git (1.2.5)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.19)
+    httpauth (0.2.0)
+    jeweler (1.8.6)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.0)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    multi_json (1.7.7)
+    multi_xml (0.5.4)
+    multipart-post (1.2.0)
+    net-scp (1.1.1)
+      net-ssh (>= 2.6.5)
+    net-sftp (2.1.2)
+      net-ssh (>= 2.6.5)
+    net-ssh (2.6.7)
+    net-ssh-gateway (1.2.0)
+      net-ssh (>= 2.6.5)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.1.0)
+    rdoc (4.0.1)
+      json (~> 1.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.3.0)
+  capistrano (>= 2.15.5)
+  capistrano-base_helper (>= 0.0.3)
+  jeweler (~> 1.8.6)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Leif Ringstad
+
+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/README.md

@@ -0,0 +1,60 @@
+# Capistrano Recipes for Delayed Job
+
+This gem provides recipes for [Delayed Job](https://github.com/collectiveidea/delayed_job) to setup runit and monit
+
+## Usage
+
+Add it to your Gemfile without requiring it
+
+```ruby
+gem 'capistrano-delayed_job', require: false
+```
+
+In your deploy.rb:
+
+```ruby
+require 'capistrano-delayed_job'
+```
+
+### Monit
+
+```ruby
+cap delayed_job:monit:disable          # Disable and stop monit services for Delayed Job
+cap delayed_job:monit:enable           # Enable monit services for Delayed Job
+cap delayed_job:monit:monitor          # Monitor Delayed Job
+cap delayed_job:monit:restart          # Restart monit services for Delayed Job
+cap delayed_job:monit:setup            # Setup Delayed Job monit-service
+cap delayed_job:monit:start            # Start monit services for Delayed Job (will also tr...
+cap delayed_job:monit:stop             # Stop monit services for Delayed Job (will also sto...
+cap delayed_job:monit:unmonitor        # Purge Delayed Job monit configuration
+```
+
+### Runit
+
+```ruby
+cap delayed_job:runit:disable          # Disable Delayed Job runit-service
+cap delayed_job:runit:enable           # Enable Delayed Job runit-service
+cap delayed_job:runit:flush_sockets    # Flush delayed_job sockets, as they can end up 'han...
+cap delayed_job:runit:once             # Start Delayed Job runit-service only ONCE (no supe...
+cap delayed_job:runit:purge            # Purge Delayed Job runit configuration
+cap delayed_job:runit:quit             # Quit the Delayed Job runit-service
+cap delayed_job:runit:restart          # Restart Delayed Job runit-service
+cap delayed_job:runit:setup            # Setup Delayed Job runit-service
+cap delayed_job:runit:start            # Start Delayed Job runit-service
+cap delayed_job:runit:stop             # Stop Delayed Job runit-service
+```
+
+## Configuration
+
+See delayed_job/config.rb for default options, and ovveride any in your deploy.rb file.
+
+## Contributing
+
+* Fork the project
+* Make a feature addition or bug fix
+* Please test the feature or bug fix
+* Make a pull request
+
+## Copyright
+
+(c) 2013 Leif Ringstad. See LICENSE for details

data/Rakefile

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "capistrano-delayed_job"
+  gem.homepage = "https://github.com/leifcr/capistrano-delayed_job"
+  gem.license = "MIT"
+  gem.summary = %Q{Capistrano recipes for Delayed Job using runit and monit}
+  gem.description = %Q{Capistrano recipes for Delayed Job using runit and monit.}
+  gem.email = "leifcr@gmail.com"
+  gem.authors = ["Leif Ringstad"]
+  gem.files.exclude ".ruby-*"
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+# require 'rdoc/task'
+# Rake::RDocTask.new do |rdoc|
+#   version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+#   rdoc.rdoc_dir = 'rdoc'
+#   rdoc.title = "capistrano-empty #{version}"
+#   rdoc.rdoc_files.include('README*')
+#   rdoc.rdoc_files.include('lib/**/*.rb')
+# end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/capistrano-delayed_job.rb

@@ -0,0 +1,11 @@
+def try_require(library)
+  begin
+    require "#{library}"
+  rescue LoadError => e
+    puts "Capistrano-Delayed Job: Cannot load library: #{library} Error: #{e}"
+  end
+end
+
+try_require 'capistrano-delayed_job/config'
+try_require 'capistrano-delayed_job/runit'
+try_require 'capistrano-delayed_job/monit'

data/capistrano-delayed_job/config.rb

@@ -0,0 +1,28 @@
+Capistrano::Configuration.instance(true).load do
+  _cset :delayed_job_runit_service_name, "delayed_job"
+  _cset :delayed_job_workers, 1 # More than 1 is not implemented yet.
+
+  _cset :delayed_job_bin, 'bundle exec rake jobs:work'
+
+  _cset :delayed_job_pid_file,    defer {Capistrano::RunitBase::service_pid(fetch(:delayed_job_runit_service_name))}
+
+  # 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")
+  _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")
+
+  # monit configuration
+  _cset :delayed_job_monit_service_name,  defer { "#{fetch(:user)}_#{fetch(:application)}_#{Capistrano::BaseHelper.environment}_delayed_job" }
+  _cset :delayed_job_monit_start_command, defer {"/bin/bash -c '[ ! -h #{Capistrano::RunitBase.service_path(fetch(:delayed_job_runit_service_name))}/run ] || /usr/bin/sv start #{Capistrano::RunitBase.service_path(fetch(:delayed_job_runit_service_name))}'"}
+  _cset :delayed_job_monit_stop_command,  defer {"/usr/bin/sv -w 12 force-stop #{Capistrano::RunitBase.service_path(fetch(:delayed_job_runit_service_name))}"}
+  _cset :delayed_job_monit_memory_alert_threshold, "45.0 MB for 2 cycles"
+  _cset :delayed_job_monit_memory_restart_threshold, "50.0 MB for 3 cycles"
+  _cset :delayed_job_monit_cpu_alert_threshold,   "90% for 2 cycles"
+  _cset :delayed_job_monit_cpu_restart_threshold, "95% for 5 cycles"
+
+  _cset :delayed_job_local_monit_config, File.join(File.expand_path(File.join(File.dirname(__FILE__),"../templates", "monit")), "delayed_job.conf.erb")
+
+end

data/capistrano-delayed_job/monit.rb

@@ -0,0 +1,70 @@
+# Delayed Job - Monit
+# Setup and management of Monit for Delayed Job
+#
+require 'capistrano-base_helper/base_helper'
+require 'capistrano-base_helper/monit_base'
+
+Capistrano::Configuration.instance(true).load do
+  after "monit:setup", "delayed_job:monit:setup"
+  after "delayed_job:monit:setup", "delayed_job:monit:enable"
+  after "delayed_job:monit:enable", "monit:reload"
+
+  before "delayed_job:monit.disable", "delayed_job:monit:unmonitor"
+  after  "delayed_job:monit:disable", "monit:reload"
+
+  # start service after update in case it has not been stopped
+  # after "deploy:update", "delayed_job:monit:start"
+  # Not needed?
+
+  namespace :delayed_job do
+    namespace :monit do
+      desc "Setup Delayed Job monit-service"
+      task :setup, :roles => [:app, :web, :db] do
+        # Upload configuration
+        Capistrano::BaseHelper::generate_and_upload_config(delayed_job_local_monit_config, File.join(fetch(:monit_available_path), "#{fetch(:delayed_job_runit_service_name)}.conf"))
+        # Enable monitor
+      end
+    
+      desc "Enable monit services for Delayed Job"
+      task :enable, :roles => [:app, :web, :db] do
+        Capistrano::MonitBase::Service.enable("#{fetch(:delayed_job_runit_service_name)}.conf")
+      end
+
+      desc "Disable and stop monit services for Delayed Job"
+      task :disable, :roles => [:app, :web, :db] do
+        Capistrano::MonitBase::Service.disable("#{fetch(:delayed_job_runit_service_name)}.conf")
+      end
+
+      desc "Start monit services for Delayed Job (will also try to start the service)"
+      task :start, :roles => [:app, :web, :db] do
+        Capistrano::MonitBase::Service.command_monit("start", fetch(:delayed_job_monit_service_name))
+      end
+
+      desc "Stop monit services for Delayed Job (will also stop the service)"
+      task :stop, :roles => [:app, :web, :db] do
+        Capistrano::MonitBase::Service.command_monit("stop", fetch(:delayed_job_monit_service_name))
+      end
+
+      desc "Restart monit services for Delayed Job"
+      task :restart, :roles => [:app, :web, :db] do
+        Capistrano::MonitBase::Service.command_monit("restart", fetch(:delayed_job_monit_service_name))
+      end
+
+      desc "Monitor Delayed Job"
+      task :monitor, :roles => [:app, :web, :db] do
+        Capistrano::MonitBase::Service.command_monit("monitor", fetch(:delayed_job_monit_service_name))
+      end
+
+      desc "Unmonitor Delayed Job"
+      task :unmonitor, :roles => [:app, :web, :db] do
+        Capistrano::MonitBase::Service.command_monit("unmonitor", fetch(:delayed_job_monit_service_name))
+      end
+
+      desc "Purge Delayed Job monit configuration"
+      task :unmonitor, :roles => [:app, :web, :db], :on_error => :continue do
+      end      
+
+    end
+
+  end
+end

data/capistrano-delayed_job/runit.rb

@@ -0,0 +1,80 @@
+# Delayed Job - Runit
+
+require 'capistrano-base_helper/base_helper'
+require 'capistrano-base_helper/runit_base'
+
+Capistrano::Configuration.instance(true).load do
+  after "deploy:setup", "delayed_job:runit:setup"
+
+  # enable service after update in case it has not been setup or is disabled
+  # Service should probably be started as well?
+  after "deploy:update", "delayed_job:runit:enable"
+  after "delayed_job:runit:quit", "delayed_job:runit:stop"
+
+  namespace :delayed_job do
+    namespace :runit do
+      desc "Setup Delayed Job runit-service"
+      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"))
+
+        # 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))
+
+        # Make scripts executable
+        Capistrano::RunitBase.make_service_scripts_executeable(delayed_job_runit_service_name)
+
+        # Set correct permissions/owner on log path
+        Capistrano::RunitBase.create_and_permissions_on_path(fetch(:delayed_job_log_path))
+      end 
+      
+      desc "Enable Delayed Job runit-service"
+      task :enable, :roles => :app do
+        Capistrano::RunitBase.enable_service(delayed_job_runit_service_name)
+      end
+
+      desc "Disable Delayed Job runit-service"
+      task :disable, :roles => :app do
+        Capistrano::RunitBase.disable_service(delayed_job_runit_service_name)
+      end
+
+      desc "Start Delayed Job runit-service"
+      task :start, :roles => :app do
+        Capistrano::RunitBase.start_service(delayed_job_runit_service_name)
+      end
+
+      desc "Start Delayed Job runit-service only ONCE (no supervision...)"
+      task :once, :roles => :app do
+        Capistrano::RunitBase.start_service_once(delayed_job_runit_service_name)
+      end
+
+      desc "Stop Delayed Job runit-service"
+      task :stop, :roles => :app, :on_error => :continue do
+        # have to use force-stop on failed stop, since delayed_job might not terminate properly
+        # will wait 25 seconds for delayed_job to shut down, to allow it to serve any on-going requests
+        Capistrano::RunitBase.control_service(delayed_job_runit_service_name, "force-stop", false, "-w 25")
+      end
+
+      desc "Quit the Delayed Job runit-service"
+      task :quit, :roles => :app, :on_error => :continue do
+        Capistrano::RunitBase.control_service(delayed_job_runit_service_name, "quit")
+      end
+
+      desc "Restart Delayed Job runit-service"
+      task :restart, :roles => :app do
+        Capistrano::RunitBase.control_service(delayed_job_runit_service_name, "restart")
+      end
+      
+      desc "Purge Delayed Job runit configuration"
+      task :purge, :roles => :app, :on_error => :continue do
+        Capistrano::RunitBase.force_control_service(delayed_job_runit_service_name, "force-stop", true)
+        Capistrano::RunitBase.purge_service(delayed_job_runit_service_name)
+      end
+      
+    end
+  end
+end

data/templates/monit/delayed_job.conf.erb

@@ -0,0 +1,16 @@
+# Monit configuration for Delayed Job
+# <% c = Capistrano::BaseHelper::get_capistrano_instance %>
+# <%= "#{c.fetch(:application)} running as #{c.fetch(:user)} in environment #{Capistrano::BaseHelper.environment}" %>
+#
+# Service name: <%= c.fetch(:delayed_job_monit_service_name) %>
+#
+check process <%= c.fetch(:delayed_job_monit_service_name) %>
+    with pidfile <%= c.fetch(:delayed_job_pid_file) %>
+    start program = "<%= c.fetch(:delayed_job_monit_start_command) %>"
+    stop program = "<%= c.fetch(:delayed_job_monit_stop_command) %>"
+    <%= "if mem is greater than #{c.fetch(:delayed_job_monit_memory_alert_threshold)} then alert"     unless c.fetch(:delayed_job_monit_memory_alert_threshold).nil? %>
+    <%= "if mem is greater than #{c.fetch(:delayed_job_monit_memory_restart_threshold)} then restart" unless c.fetch(:delayed_job_monit_memory_restart_threshold).nil? %>
+    <%= "if cpu is greater than #{c.fetch(:delayed_job_monit_cpu_alert_threshold)} then alert"        unless c.fetch(:delayed_job_monit_cpu_alert_threshold).nil? %>
+    <%= "if cpu is greater than #{c.fetch(:delayed_job_monit_cpu_restart_threshold)} then restart"    unless c.fetch(:delayed_job_monit_cpu_restart_threshold).nil? %>
+
+    group <%= c.fetch(:monit_application_group_name) %>

data/templates/runit/log-run.erb

@@ -0,0 +1,10 @@
+#!/bin/sh -e
+<% c = Capistrano::BaseHelper::get_capistrano_instance %>
+# Log output for delayed_job running on <%= c.fetch(:application) %> running as <%= c.fetch(:user) %>
+# make sure the log directory exists
+mkdir -p "<%= c.fetch(:delayed_job_log_path) %>"
+# change path to the log directory
+cd "<%= c.fetch(:delayed_job_log_path) %>"
+# start logging
+# exec chpst -u syslog svlogd -tt "<%= c.fetch(:delayed_job_log_path) %>"
+exec svlogd -tt "<%= c.fetch(:delayed_job_log_path) %>"

data/templates/runit/run.erb

@@ -0,0 +1,6 @@
+#!/bin/bash --login
+# Start delayed job using rake
+<% c = Capistrano::BaseHelper::get_capistrano_instance %>
+cd '<%= c.current_path %>'
+exec 2>&1
+RAILS_ENV=<%= Capistrano::BaseHelper.environment %> exec <%= c.fetch(:delayed_job_bin) %>

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-delayed_job
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Leif Ringstad
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.15.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.15.5
+- !ruby/object:Gem::Dependency
+  name: capistrano-base_helper
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.6
+description: Capistrano recipes for Delayed Job using runit and monit.
+email: leifcr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- capistrano-delayed_job.rb
+- capistrano-delayed_job/config.rb
+- capistrano-delayed_job/monit.rb
+- capistrano-delayed_job/runit.rb
+- templates/monit/delayed_job.conf.erb
+- templates/runit/log-run.erb
+- templates/runit/run.erb
+homepage: https://github.com/leifcr/capistrano-delayed_job
+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'
+      segments:
+      - 0
+      hash: -1879143255629248842
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Capistrano recipes for Delayed Job using runit and monit
+test_files: []