capistrano-runit-tasks 0.2.0 → 0.2.3

data/ChangeLog

@@ -1,4 +1,17 @@
+*SVN* 
+--------------------------------------------------
+
+* Add runit_sudo_tasks variable, array of symbols indicating tasks names to be
+  run using sudo.
+
+* Added support for mongrel, and basic mongrel runner template
+
+* Changed fcgi_port and fcgi_listener_base_port to listener_port and
+  listener_base_port. Old variable names still supported but considered
+  deprecated.
+
 *0.2.0* (March 23rd 2006)
+--------------------------------------------------
 
 * Added RunitServiceHelper which adds service.add to allow easy creation of
   services. Refactored other code to use new functionality.
@@ -14,4 +27,4 @@
 
 * Changed default fcgi_listener_base_port to 9000
 
-* Added tests for 0.1.0
+* Added tests for 0.1.0

data/Manifest.txt

@@ -0,0 +1,28 @@
+ChangeLog
+Manifest.txt
+README
+Rakefile
+lib/capistrano-runit-tasks-templates/default_fcgi_runner.rhtml
+lib/capistrano-runit-tasks-templates/default_log_runner.rhtml
+lib/capistrano-runit-tasks-templates/default_mongrel_runner.rhtml
+lib/capistrano-runit-tasks.rb
+lib/runit_command_helper.rb
+lib/runit_helper.rb
+lib/runit_runner_helper.rb
+lib/runit_service_helper.rb
+setup.rb
+test/capistrano-runit-tasks_test.rb
+test/fixtures/log_runner
+test/fixtures/runit_config.rb
+test/fixtures/standard_fcgi_runner
+test/fixtures/standard_mongrel_runner
+test/runit_command_helper_test.rb
+test/runit_helper_test.rb
+test/runit_runner_helper_test.rb
+test/runit_service_helper_test.rb
+test/templates/custom_runner_service_runner
+test/templates/test_log_runner
+test/templates/test_runner.rhtml
+test/templates/test_service_log_runner
+test/templates/test_service_runner
+test/test_helper.rb

data/README

@@ -5,12 +5,12 @@ Adds tasks to Capistrano for use with the runit supervision scheme.
 This library extends Capistrano to allow processes to be supervised using the
 runit package. It replaces some of the standard tasks with runit versions and
 includes tasks and helpers to create the service directory layout and populate
-it with run scripts. It currently only supports fcgi listeners, but tries to
+it with run scripts. It has support fcgi and mongrel listeners, and tries to
 make it easy to add other services in your deploy.rb.
 
 == Status
 
-capistrano-runit-tests 0.2.0 (known as cap-runit from now on) is the second
+capistrano-runit-tests 0.2.2 (known as cap-runit from now on) is the third
 release of the library. It will need more work to be useful to everybody who
 uses runit. It supports both the sv and runsvctrl/runsvstat versions of runit.
 Support for daemontools svc command will be added at a later date.
@@ -35,7 +35,7 @@ Then run:
 * cap setup
 * cap cold_deploy
 
-This sets up one fcgi listener on port 8000. Make sure your database is setup
+This sets up one mongrel listener on port 8000. Make sure your database is setup
 and point your webserver at the new listener.
 
 == Usage
@@ -66,38 +66,49 @@ Then adds the following tasks, helpers and variables:
                           service directories to to start the service.
                           (Default: ~/services)
 
-[fcgi_count]              Number of fcgi listener service dirs to create.
-                          (Default: 1)
+[listener_count]          Number of listener service dirs to create.
+                          (Default: 1) (old name: fcgi_count)
 
-[fcgi_listener_base_port] The base port number to use for the fcgi listeners.
-                          (Default: 9000)
+[listener_base_port]      The base port number to use for the listeners.
+                          (Default: 9000) (old name: fcgi_listener_base_port)
 
 [sv_command]               Either :sv or :runsvctrl
                            (Default: sv)
                            
 [runner_template_path]     The path to search for custom templates.
                            (Default: templates/runit)
+                           
+[runit_sudo_tasks]         Array of tasks names to run using sudo
+                           (default: [])
 
 cap-runit creates a directory for each listener you ask for. At the moment the
 directories are created by setup_service_dirs. Later versions should allow for
 dynamic creation / deletion.
 
-The directories are named after the port number the fcgi listener will run on.
-If you specified 8500 for the base port and 3 for the fcgi_count then
+The directories are named after the port number the listener will run on. If
+you specified 8500 for the base port and 3 for the listener_count then
 service/8500, service/8501 and service/8502 directories will be created and
-populated with run scripts that launch the fcgis on the corresponding port.
+populated with run scripts that launch the listeners on the corresponding
+port.
 
 When the service directories are linked into the master service dir to run,
 they are named <application>-<port number>. So if :application is set to "foo"
 in deploy.rb you'll get foo-8500, foo-8501 etc.
 
+=== Sudo
+
+When a runit task executes, it will check to see if it's name is included in
+the runit_sudo_tasks array. If so, it will use sudo rather than run when
+executing its commands. Note, only tasks defined within capistrano-runit-tasks
+will do this, none of the standard tasks are changed.
+
 === Helpers
 
-[each_fcgi_listener] Uses the values for fcgi_listener_base_port and
-                     fcgi_count to yield each of the fcgi port numbers back to
-                     the calling block
+[each_listener]      Uses the values for listener_base_port and listener_count
+                     to yield each of the listener port numbers back to the
+                     calling block
 
-[fcgi_listener_dirs] Returns an array containing the path to each of the fcgi
+[listener_dirs]      Returns an array containing the path to each of the 
                      listener dirs. This is useful when sending commands using
                      sv as it accepts an array of directories as an argument
                      
@@ -120,8 +131,9 @@ different.
 
 The directory pointed to by the runner_template_path variable is searched
 before the directory containing the default templates. If you want to override
-the default templates, create default_fcgi_runner.rhtml and/or
-default_log_runner.rhtml and cap-runit will pick your custom versions first.
+the default templates, create default_mongrel_runner.rhtml or
+default_fcgi_runner.rhtml and/or default_log_runner.rhtml and cap-runit will
+pick your custom versions first.
 
 == Adding your own services
 
@@ -168,7 +180,7 @@ This again should be automated, the manual steps I used were:
 * Revert deploy.rb
 * cap setup_service_dirs to create the structure (Won't touch what's running)
 * Kill the spinner process
-* use script/process/reaper to kill the running fcgis
+* use script/process/reaper to kill the running listeners
 * cap cold_deploy to start the service
 * Check everything is running OK
 

data/Rakefile

@@ -0,0 +1,78 @@
+require 'rubygems'
+require 'hoe'
+$:.unshift(File.dirname(__FILE__) + "/lib")
+
+Hoe.new("capistrano-runit-tasks", "0.2.3") do |p|
+  p.rubyforge_name = 'cappy-runit'
+  p.author         = "Chris McGrath"
+  p.changes        = p.paragraphs_of('ChangeLog', 1..3).join("\n")
+  p.summary        = p.paragraphs_of('README', 1)[0]
+  p.description    = p.paragraphs_of('README', 2)[0]
+  p.email          = 'chris@octopod.info'
+  p.url            = 'http://cappy-runit.rubyforge.org'
+  p.test_globs     = ['test/*_test.rb']
+end
+# Gem::manage_gems
+# 
+# require 'rake/packagetask'
+# require 'rake/gempackagetask'
+# require 'rake/rdoctask'
+# require 'rake/contrib/rubyforgepublisher'
+# require 'rake/testtask'
+# 
+# PACKAGE_NAME = "capistrano-runit-tasks"
+# PACKAGE_VERSION = "0.2.2"
+# RELEASE_NAME  = "REL #{PACKAGE_VERSION}"
+# PKG_FILE_NAME = "#{PACKAGE_NAME}-#{PACKAGE_VERSION}"
+# RUBY_FORGE_PROJECT = "cappy-runit"
+# RUBY_FORGE_USER = "octopod"
+# 
+# files = FileList["{lib}/**/*"].exclude("rdoc")
+# 
+# spec = Gem::Specification.new do |s| 
+#   s.name = PACKAGE_NAME 
+#   s.version = PACKAGE_VERSION
+#   s.rubyforge_project = 'cappy-runit'
+#   s.author = "Chris McGrath" 
+#   s.email = "chris@octopod.info" 
+#   s.files = files.dup
+#   s.homepage = "http://cappy-runit.rubyforge.org" 
+#   s.platform = Gem::Platform::RUBY 
+#   s.summary = "Adds tasks to capistrano for use with the runit supervision scheme." 
+#   s.require_path = "lib" 
+#   s.autorequire = "capistrano-runit-tasks" 
+#   s.has_rdoc = true 
+#   s.extra_rdoc_files = ["README", "ChangeLog"] 
+#   s.rdoc_options << '--title' << 'Capistrano runit tasks documentation' <<
+#                     '--main'  << 'README'
+#   s.add_dependency("capistrano", ">= 1.1.0") 
+# end
+#  
+# Rake::GemPackageTask.new(spec) do |pkg| 
+# end
+# 
+# Rake::PackageTask.new(PACKAGE_NAME, PACKAGE_VERSION) do |pkg|
+#   pkg.package_files = files.dup << 'setup.rb'
+#   pkg.need_tar_gz = true
+#   pkg.need_zip = true
+# end
+# 
+# Rake::RDocTask.new do |rd|
+#   rd.main = "README"
+#   rd.rdoc_files.include("README", 'ChangeLog', "lib/**/*.rb")
+# end
+# 
+# desc "Publish the docs"
+# task :publish_docs => :rdoc do
+#   Rake::RubyForgePublisher.new(RUBY_FORGE_PROJECT, RUBY_FORGE_USER).upload
+# end
+# 
+# desc "Run the tests"
+# Rake::TestTask.new do |t|
+#   t.test_files = FileList['test/*_test.rb']
+#   t.verbose = true
+# end
+# 
+# task :default => :test do
+#   
+# end

data/lib/capistrano-runit-tasks-templates/default_fcgi_runner.rhtml

@@ -1,3 +1,3 @@
 #!/bin/sh -e
 export RAILS_ENV=production
-exec 2>&1  /usr/bin/env spawn-fcgi -n -f <%= deploy_to %>/current/public/dispatch.fcgi -p <%= fcgi_port %>
+exec 2>&1  /usr/bin/env spawn-fcgi -n -f <%= deploy_to %>/current/public/dispatch.fcgi -p <%= listener_port %>

data/lib/capistrano-runit-tasks-templates/default_mongrel_runner.rhtml

@@ -0,0 +1,2 @@
+#!/bin/sh -e
+exec 2>&1  /usr/bin/env mongrel_rails start --environment production --port <%= listener_port %> --address 127.0.0.1 --chdir <%= deploy_to %>/current --log <%= deploy_to %>/shared/log/mongrel.log --pid <%= deploy_to %>/shared/log/mongrel.pid

data/lib/capistrano-runit-tasks.rb

@@ -1,14 +1,18 @@
+$:.unshift File.dirname(__FILE__)
+require 'runit_helper'
 require 'runit_runner_helper'
 require 'runit_command_helper'
 require 'runit_service_helper'
 
 Capistrano.configuration(:must_exist).load do
   set :service_dir, 'service'
-  set :fcgi_count, 1
+  set :listener_count, 1
+  set :listener_type, :mongrel
   set :master_service_dir, '~/service'
-  set :fcgi_listener_base_port, 9000
+  set :listener_base_port, 9000
   set :sv_command, :sv # can be :sv or :runsvctrl
   set :runner_template_path, File.join('templates', 'runit')
+  set :runit_sudo_tasks, []
    
   # We need our own task for this as the default cold_deploy
   # calls restart, which won't work until we've setup the 
@@ -16,6 +20,7 @@ Capistrano.configuration(:must_exist).load do
   # link exists, but that's beyond my current (very bad) shell-foo 
   desc "Used only for deploying when the services haven't been setup"
   task :cold_deploy do
+    handle_deprecated_vars
     transaction do
       update_code
       symlink
@@ -23,43 +28,69 @@ Capistrano.configuration(:must_exist).load do
     spinner
   end
 
-  desc "Sets up services directories for supervising fcgi using runit"
+  desc "Sets up services directories for supervising listeners using runit"
   task :setup_service_dirs do
+    handle_deprecated_vars
     application_service_dir = "#{deploy_to}/#{service_dir}"
-    run  "mkdir -p #{application_service_dir}"
+    runit_helper.run_or_sudo "mkdir -p #{application_service_dir}"
         
-    each_fcgi_listener do |fcgi_listener_port|
-      service.add fcgi_listener_port, :template => :fcgi, :fcgi_port => fcgi_listener_port
+    each_listener do |listener_port|
+      # DEPRECATION: Need to pass port and fcgi_port to handle old templates, fcgi_port is considered deprecated
+      service.add listener_port, :template => listener_type, :listener_port => listener_port, :fcgi_port => listener_port
     end
   end
     
-  desc "Links created service dir into master service dir so runit starts the fcgi"
+  desc "Links created service dir into master service dir so runit starts the listeners"
   task :spinner do
-    each_fcgi_listener do |fcgi_listener_port|
-      fcgi_service_dir = "#{deploy_to}/#{service_dir}/#{fcgi_listener_port}"
-      run "ln -sf #{fcgi_service_dir} #{master_service_dir}/#{application}-#{fcgi_listener_port}"    
+    handle_deprecated_vars
+    each_listener do |listener_port|
+      service_dir = "#{deploy_to}/#{service_dir}/#{listener_port}"
+      runit_helper.run_or_sudo "ln -sf #{service_dir} #{master_service_dir}/#{application}-#{listener_port}"    
     end
   end
   
-  desc "restart task for runit supervised fcgis"
-  task :restart do
-    sv.usr2 fcgi_listener_dirs      
+  desc "restart task for runit supervised listeners"
+  task :restart, :roles => :app do
+    handle_deprecated_vars
+    sv.usr2 listener_dirs      
   end
   
   desc "Hook into after setup to create the runit service directory"
   task :after_setup do
+    handle_deprecated_vars
     setup_service_dirs
   end
 
-  def each_fcgi_listener
-    fcgi_listener_base_port.upto(fcgi_listener_base_port + fcgi_count - 1) do |fcgi_listener_port|
-      yield fcgi_listener_port
+  def each_listener
+    listener_base_port.upto(listener_base_port + listener_count - 1) do |listener_port|
+      yield listener_port
     end
   end
   
-  def fcgi_listener_dirs
+  def listener_dirs
     dirs = []
-    each_fcgi_listener { |port| dirs << "#{deploy_to}/#{service_dir}/#{port}" }
+    each_listener { |port| dirs << "#{deploy_to}/#{service_dir}/#{port}" }
     dirs
   end
+  
+  ## DEPRECATED - and alias_method won't work inside the instance_eval this is run in
+  def each_fcgi_listener
+    each_listener { |listener_port| yield listener_port }
+  end
+
+  def fcgi_listener_dirs
+    listener_dirs
+  end
+  
+  def handle_deprecated_vars
+    handle_deprecated_var :fcgi_listener_base_port, :listener_base_port
+    handle_deprecated_var :fcgi_count, :listener_count
+  end
+  
+  def handle_deprecated_var(old_var, new_var)
+    if @variables.has_key?(old_var)
+      set new_var, @variables[old_var]
+    end
+    set old_var, @variables[new_var]
+  end
 end

data/lib/runit_command_helper.rb

@@ -21,7 +21,7 @@ end
 #
 # The methods are available through sv.<method name> in your deploy.rb
 module RunitCommandHelper
-  SIGNALS = %w(up down once pause cont hup alarm interrupt quit usr1 usr2 term kill status)
+  SIGNALS = %w(up down once pause cont hup alarm interrupt quit usr1 usr2 term kill status) unless defined? SIGNALS
 
   SIGNALS.each do |signal|
     if signal =~ /usr([1|2])/ then
@@ -32,7 +32,7 @@ module RunitCommandHelper
 
     define_method(signal) do |service_dirs|
       service_dirs = service_dirs.join(" ") if service_dirs.is_a? Array
-      run "#{get_command(signal, cmd)} #{service_dirs}"
+      runit_helper.run_or_sudo "#{get_command(signal, cmd)} #{service_dirs}"
     end
   end
 

data/lib/runit_helper.rb

@@ -0,0 +1,32 @@
+begin
+  require 'capistrano'
+rescue LoadError
+  require 'rubygems'
+  require 'capistrano'
+end
+
+# This module provides a run_or_sudo helper method that checks what is should
+# use before running a command
+module RunitHelper
+  def run_or_sudo(command)
+    if configuration.runit_sudo_tasks.include? configuration.actor.current_task.name
+      sudo command
+    else
+      run command
+    end
+  end
+  
+  private
+  def find_caller
+    Kernel.caller.each do |caller_details|
+      if caller_details =~ /`(.*?)'$/
+        unless $1.nil? || %(run_or_sudo instance_eval initialize).include?($1)
+          break $1.intern
+        end
+      end
+      next
+    end
+  end
+end
+
+Capistrano.plugin :runit_helper, RunitHelper

data/lib/runit_runner_helper.rb

@@ -14,8 +14,8 @@ module RunitRunnerHelper
   #
   # * service_dir should be the path to your service directory, it should not 
   #   include run or log/run, these are added by create.
-  # * template can be :log, :fcgi, the name of a file or a string.
-  #   :log and :fcgi create the standard logger/fcgi templates,
+  # * template can be :log, :mongrel, :fcgi, the name of a file or a string.
+  #   :log, :mongrel and :fcgi create the standard templates,
   #   see get_template below for a list of places searched for template files.
   # * If you're making a custom log runner, include :log_runner => true in the 
   #   options so create knows to put the contents in service_dir/log/run, you  
@@ -29,6 +29,8 @@ module RunitRunnerHelper
         options.merge!(:log_runner => true)
       when :fcgi
         template = 'default_fcgi_runner'
+      when :mongrel
+        template = 'default_mongrel_runner'
     end
     
     path = "#{service_dir}/#{options[:log_runner] ? 'log/run' : 'run'}" 

data/lib/runit_service_helper.rb

@@ -5,8 +5,6 @@ rescue LoadError
   require 'capistrano'
 end
 
-require 'runit_runner_helper'
-
 # This module provides an easy method to create service directories in your application and have them
 # populated with runner scripts.
 # 
@@ -58,7 +56,7 @@ module RunitServiceHelper
   end
 
   def make_service_dir(service_name)
-    run "mkdir -p #{service_dir(service_name)}/log/main"
+    runit_helper.run_or_sudo "mkdir -p #{service_dir(service_name)}/log/main"
   end
 end