capistrano-runit-tasks 0.2.0 → 0.2.3

data/test/capistrano-runit-tasks_test.rb

@@ -0,0 +1,38 @@
+$:.unshift File.dirname(__FILE__) + "/../lib"
+
+require 'test/unit'
+begin
+  require 'capistrano'
+rescue LoadError
+  require 'rubygems'
+  require 'capistrano'
+end
+
+class CappyRunitTasksConfigurationTest < Test::Unit::TestCase
+  class MockActor
+    attr_reader :tasks
+
+    def initialize(config)
+    end
+
+    def define_task(*args, &block)
+      (@tasks ||= []).push [args, block].flatten
+    end
+  end
+
+  def setup
+    @config = Capistrano::Configuration.new(MockActor)
+    file = File.dirname(__FILE__) + "/fixtures/runit_config.rb"
+    @config.load file
+  end  
+
+  def test_should_include_capistrano_runit_tasks
+    assert task_names(@config.actor.tasks).include?(:setup_service_dirs)
+  end
+  
+  def task_names(tasks)
+    tasks.map { |task| task[0] }
+  end
+end
+
+

data/test/fixtures/log_runner

@@ -0,0 +1,2 @@
+#!/bin/sh -e
+exec svlogd -t ./main

data/test/fixtures/runit_config.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__) + '/../../lib/capistrano-runit-tasks'
+
+set :application, "foo"
+role :web, "www.example.com", :primary => true
+role :app, "www.example.com", :primary => true
+
+task :setup do
+  
+end

data/test/fixtures/standard_fcgi_runner

@@ -0,0 +1,3 @@
+#!/bin/sh -e
+export RAILS_ENV=production
+exec 2>&1  /usr/bin/env spawn-fcgi -n -f app_dir/current/public/dispatch.fcgi -p 8000

data/test/fixtures/standard_mongrel_runner

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

data/test/runit_command_helper_test.rb

@@ -0,0 +1,61 @@
+require 'test_helper'
+
+class RunitCommandHelperTest < Test::Unit::TestCase
+  include TestHelper
+  
+  SIGNALS = %w(up down once pause cont hup alarm interrupt quit usr1 usr2 term kill)
+  
+  def setup
+    @actor = TestActor.new(MockConfiguration.new)    
+    @actor.configuration.set :runit_sudo_tasks, []
+  end
+  
+  def test_should_load_runit_runner_helper
+    assert Capistrano.const_get(:EXTENSIONS).include?(:sv)    
+  end
+  
+  def test_should_raise_error_if_sv_command_set_to_invalid_value
+    @actor.configuration.set :sv_command, :foo_bar
+    assert_raises(RuntimeError) { @actor.sv.down "foo" }
+  end
+  
+  def test_should_generate_correct_commands_for_sv
+    @actor.configuration.set :sv_command, :sv
+
+    SIGNALS.each_with_index do |signal, i|
+      @actor.sv.send(signal, "foo")
+      if signal =~ /usr([1|2])/
+        assert_equal "sv #{$1} foo", @actor.run_data[i]
+      else
+        assert_equal "sv #{signal} foo", @actor.run_data[i]
+      end
+    end
+    
+    @actor.reset!
+    @actor.sv.status "foo"
+    assert_equal "sv status foo", @actor.run_data[0]
+  end
+
+  def test_should_generate_correct_commands_for_runsvctrl
+    @actor.configuration.set :sv_command, :runsvctrl
+
+    SIGNALS.each_with_index do |signal, i|
+      @actor.sv.send(signal, "foo")
+      if signal =~ /usr([1|2])/
+        assert_equal "runsvctrl #{$1} foo", @actor.run_data[i]
+      else
+        assert_equal "runsvctrl #{signal} foo", @actor.run_data[i]
+      end
+    end
+
+    @actor.reset!
+    @actor.sv.status "foo"
+    assert_equal "runsvstat foo", @actor.run_data[0]
+  end
+  
+  def test_should_accept_array_of_service_directions
+    @actor.configuration.set :sv_command, :sv
+    @actor.sv.down %w(foo bar)
+    assert_equal "sv down foo bar", @actor.run_data[0]
+  end  
+end

data/test/runit_helper_test.rb

@@ -0,0 +1,25 @@
+require 'test_helper'
+
+class RunitHelperTest < Test::Unit::TestCase
+  include TestHelper
+  
+  def setup
+    @actor = MockConfiguration.new.actor    
+    @actor.configuration.set :runner_template_path, File.join(File.dirname(__FILE__), 'templates')
+    @actor.configuration.set :deploy_to, 'app_dir'
+    @actor.configuration.set :service_dir, 'service'
+    @actor.configuration.set :runit_sudo_tasks, [:sudo_task]
+  end
+  
+  def test_should_run_command
+    @actor.send :run_task
+    assert_equal "run", @actor.run_data[0]
+    assert_nil @actor.sudo_data
+  end
+  
+  def test_should_sudo_command
+    @actor.send :sudo_task
+    assert_equal "sudo", @actor.sudo_data[0]
+    assert_nil @actor.run_data
+  end
+end

data/test/runit_runner_helper_test.rb

@@ -0,0 +1,53 @@
+require 'test_helper'
+
+class RunitRunnerHelperTest < Test::Unit::TestCase
+  include TestHelper
+  
+  def setup
+    @actor = TestActor.new(MockConfiguration.new)    
+    @actor.configuration.set :runner_template_path, File.join(File.dirname(__FILE__), 'templates')
+    @actor.configuration.set :deploy_to, 'app_dir'
+    @actor.configuration.set :runit_sudo_tasks, []
+  end
+  
+  def test_should_load_runit_runner_helper
+    assert Capistrano.const_get(:EXTENSIONS).include?(:runner)    
+  end
+  
+  def test_should_create_default_fcgi_runner
+    @actor.runner.create 'test/output', :fcgi, :listener_port => 8000
+    assert_equal File.read("#{File.dirname(__FILE__)}/fixtures/standard_fcgi_runner"), @actor.put_data['test/output/run']
+  end
+
+  def test_should_create_default_mongrel_runner
+    @actor.runner.create 'test/output', :mongrel, :listener_port => 8000
+    assert_equal File.read("#{File.dirname(__FILE__)}/fixtures/standard_mongrel_runner"), @actor.put_data['test/output/run']
+  end
+  
+  def test_should_create_custom_runner
+    custom_runner = "<%= foo %>"
+    @actor.runner.create 'test/output', custom_runner, :foo => 'bar'
+    assert_equal 'bar', @actor.put_data['test/output/run']
+  end
+
+  def test_should_create_log_runner
+    @actor.runner.create 'test/output', :log
+    assert_equal File.read("#{File.dirname(__FILE__)}/fixtures/log_runner"), @actor.put_data['test/output/log/run']
+  end
+  
+  def test_should_create_custom_log_runnner
+    custom_runner = "<%= foo %>"
+    @actor.runner.create 'test/output', custom_runner, :log_runner => true, :foo => 'bar'
+    assert_equal 'bar', @actor.put_data['test/output/log/run']    
+  end
+  
+  def test_should_create_runner_from_file_template
+    @actor.runner.create 'test/output', 'test_runner', :listener_port => 8000
+    assert_equal File.read("#{File.dirname(__FILE__)}/fixtures/standard_fcgi_runner"), @actor.put_data['test/output/run']
+  end
+
+  def test_should_create_log_runner_from_log_file_template
+    @actor.runner.create 'test/output', 'test_log_runner', :log_runner => true
+    assert_equal File.read("#{File.dirname(__FILE__)}/fixtures/log_runner"), @actor.put_data['test/output/log/run']
+  end
+end

data/test/runit_service_helper_test.rb

@@ -0,0 +1,45 @@
+require 'test_helper'
+
+class RunitRunnerServiceTest < Test::Unit::TestCase
+  include TestHelper
+  
+  def setup
+    @actor = TestActor.new(MockConfiguration.new)    
+    @actor.configuration.set :runner_template_path, File.join(File.dirname(__FILE__), 'templates')
+    @actor.configuration.set :deploy_to, 'app_dir'
+    @actor.configuration.set :service_dir, 'service'
+    @actor.configuration.set :runit_sudo_tasks, []
+  end
+  
+  def test_should_create_new_service_using_standard_files
+    @actor.service.add 'test_service'
+    assert_equal 'mkdir -p app_dir/service/test_service/log/main', @actor.run_data[0]
+    assert_equal "#!/bin/sh\nrun me", @actor.put_data['app_dir/service/test_service/run'], @actor.put_data.inspect
+    assert_equal "#!/bin/sh\nlog me", @actor.put_data['app_dir/service/test_service/log/run'], @actor.put_data.inspect
+  end
+  
+  def test_should_raise_exception_if_no_runner_template_exists
+    assert_raises(RuntimeError) { @actor.service.add 'foo' }
+  end
+  
+  def test_should_create_new_service_with_standard_logger_if_logger_template_does_not_exist
+    @actor.service.add 'custom_runner_service'
+    assert_equal 'mkdir -p app_dir/service/custom_runner_service/log/main', @actor.run_data[0]
+    assert_equal "#!/bin/sh\nrun me", @actor.put_data['app_dir/service/custom_runner_service/run'], @actor.put_data.inspect
+    assert_equal "#!/bin/sh -e\nexec svlogd -t ./main\n", @actor.put_data['app_dir/service/custom_runner_service/log/run'], @actor.put_data.inspect
+  end
+  
+  def test_should_create_new_service_with_custom_runner_template
+    @actor.service.add 'custom_runner_service', :template => "custom runner\n"
+    assert_equal 'mkdir -p app_dir/service/custom_runner_service/log/main', @actor.run_data[0]
+    assert_equal "custom runner\n", @actor.put_data['app_dir/service/custom_runner_service/run'], @actor.put_data.inspect
+    assert_equal "#!/bin/sh -e\nexec svlogd -t ./main\n", @actor.put_data['app_dir/service/custom_runner_service/log/run'], @actor.put_data.inspect        
+  end
+  
+  def test_should_create_new_service_with_custom_logger_template
+    @actor.service.add 'custom_logger_service', { :template => "custom runner\n" }, { :template => "custom logger\n" } 
+    assert_equal 'mkdir -p app_dir/service/custom_logger_service/log/main', @actor.run_data[0]
+    assert_equal "custom runner\n", @actor.put_data['app_dir/service/custom_logger_service/run'], @actor.put_data.inspect
+    assert_equal "custom logger\n", @actor.put_data['app_dir/service/custom_logger_service/log/run'], @actor.put_data.inspect
+  end
+end

data/test/templates/custom_runner_service_runner

@@ -0,0 +1,2 @@
+#!/bin/sh
+run me

data/test/templates/test_log_runner

@@ -0,0 +1,2 @@
+#!/bin/sh -e
+exec svlogd -t ./main

data/test/templates/test_runner.rhtml

@@ -0,0 +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 <%= listener_port %>

data/test/templates/test_service_log_runner

@@ -0,0 +1,2 @@
+#!/bin/sh
+log me

data/test/templates/test_service_runner

@@ -0,0 +1,2 @@
+#!/bin/sh
+run me

data/test/test_helper.rb

@@ -0,0 +1,123 @@
+begin
+  require 'capistrano'
+rescue LoadError
+  require 'rubygems'
+  require 'capistrano'
+end
+require 'test/unit'
+$:.unshift File.dirname(__FILE__) + "/../lib", File.dirname(__FILE__)
+require 'runit_helper'
+
+module TestHelper
+  class TestingConnectionFactory
+    def initialize(config)
+    end
+
+    def connect_to(server)
+      server
+    end
+  end
+
+  class TestActor < Capistrano::Actor
+    class TestTask
+      attr_reader :name
+      
+      def initialize(name)
+        @name = name
+      end
+    end
+
+    attr_reader :put_data, :run_data, :sudo_data
+    
+    def initialize(*args)
+      super
+      @current_task = nil
+    end
+    
+    def run(cmd, options={}, &block)
+      (@run_data ||= []) << cmd
+    end
+
+    def sudo(cmd, options={}, &block)
+      (@sudo_data ||= []) << cmd
+    end
+  
+    def put(data, path, options={})
+      (@put_data ||= {})[path] = data
+    end
+    
+    def metaclass
+      class << self; self; end
+    end
+    
+    def current_task
+      @current_task || TestTask.new("")
+    end
+    
+    def define_method(name, &block)
+      metaclass.send(:define_method, name, &block)
+    end
+    
+    def define_task(name, options={}, &block)
+      @tasks[name] = (options[:task_class] || Task).new(name, self, options)
+      define_method(name) do
+        @current_task = TestTask.new(name)
+        instance_eval(&block)
+      end
+    end    
+
+    self.connection_factory = TestingConnectionFactory
+    
+    def reset!
+      @put_data = {}
+      @run_data = []
+      @sudo_data = []
+    end
+  end
+
+  class MockConfiguration
+    attr_reader :actor
+    
+    def initialize(actor_class=TestActor)
+      @variables = {}
+      @actor = actor_class.new(self)
+      instance_eval <<-TASKS
+      task :run_task do
+        runit_helper.run_or_sudo("run")
+      end
+
+      task :sudo_task do
+        runit_helper.run_or_sudo("sudo")
+      end
+      TASKS
+    end
+    
+    def set(variable, value = nil)
+      @variables[variable] = value
+    end
+    
+    def task(name, options={}, &block)
+      actor.define_task(name, options, &block)
+    end
+    
+    Role = Struct.new(:host, :options)
+
+    ROLES = { 
+      :db  => [ Role.new("01.example.com", :primary => true)],
+      :web => [ Role.new("01.example.com", {})],
+      :app => [ Role.new("01.example.com", {})]
+    }
+
+    def roles
+      ROLES
+    end
+        
+    def method_missing(sym, *args, &block)
+      if @variables.has_key?(sym)
+        @variables[sym]
+      else
+        super
+      end
+    end
+  end
+end

metadata

@@ -1,63 +1,86 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.11
+rubygems_version: 0.9.0
 specification_version: 1
 name: capistrano-runit-tasks
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
-date: 2006-03-23 00:00:00 +00:00
-summary: Adds tasks to capistrano for use with the runit supervision scheme.
+  version: 0.2.3
+date: 2006-11-20 00:00:00 +00:00
+summary: Adds tasks to Capistrano for use with the runit supervision scheme.
 require_paths: 
-  - lib
+- lib
 email: chris@octopod.info
 homepage: http://cappy-runit.rubyforge.org
 rubyforge_project: cappy-runit
-description: 
-autorequire: capistrano-runit-tasks
+description: 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 has support fcgi and mongrel listeners, and tries to make it easy to add other services in your deploy.rb.
+autorequire: 
 default_executable: 
 bindir: bin
 has_rdoc: true
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
-    - 
-      - ">"
-      - !ruby/object:Gem::Version 
-        version: 0.0.0
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
   version: 
 platform: ruby
 signing_key: 
 cert_chain: 
+post_install_message: 
 authors: 
-  - Chris McGrath
+- Chris McGrath
 files: 
-  - lib/capistrano-runit-tasks-templates
-  - lib/capistrano-runit-tasks.rb
-  - lib/runit_command_helper.rb
-  - lib/runit_runner_helper.rb
-  - lib/runit_service_helper.rb
-  - lib/capistrano-runit-tasks-templates/default_fcgi_runner.rhtml
-  - lib/capistrano-runit-tasks-templates/default_log_runner.rhtml
-  - README
-  - ChangeLog
-test_files: []
-rdoc_options: 
-  - "--title"
-  - Capistrano runit tasks documentation
-  - "--main"
-  - README
-extra_rdoc_files: 
-  - README
-  - ChangeLog
+- 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
+test_files: 
+- test/capistrano-runit-tasks_test.rb
+- test/runit_command_helper_test.rb
+- test/runit_helper_test.rb
+- test/runit_runner_helper_test.rb
+- test/runit_service_helper_test.rb
+rdoc_options: []
+
+extra_rdoc_files: []
+
 executables: []
+
 extensions: []
+
 requirements: []
+
 dependencies: 
-  - !ruby/object:Gem::Dependency 
-    name: capistrano
-    version_requirement: 
-    version_requirements: !ruby/object:Gem::Version::Requirement 
-      requirements: 
-        - 
-          - ">="
-          - !ruby/object:Gem::Version 
-            version: 1.1.0
-      version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.4
+    version: 
+  type: :development