daemon-spawn 0.3.0 → 0.4.0

data/Rakefile

@@ -1,7 +1,6 @@
 # -*- ruby -*-
 
 require 'rubygems'
-require 'jeweler'
 require './lib/daemon_spawn.rb'
 
 begin
@@ -15,9 +14,9 @@ begin
     gemspec.rubyforge_project = "daemon-spawn"
     gemspec.email = "alex.vollmer@gmail.com"
     gemspec.homepage = "http://github.com/alexvollmer/daemon-spawn"
-    gemspec.authors = ["Alex Vollmer"]
-    Jeweler::GemcutterTasks.new
+    gemspec.authors = ["Alex Vollmer", "Seamus Abshere", "Emmanual Gomez", "Seth Falcon", "Woody Peterson"]
   end
+  Jeweler::GemcutterTasks.new
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install jeweler"
 end

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/daemon-spawn.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{daemon-spawn}
-  s.version = "0.3.0"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Alex Vollmer"]
-  s.date = %q{2010-05-20}
+  s.authors = ["Alex Vollmer", "Seamus Abshere", "Emmanual Gomez", "Seth Falcon", "Woody Peterson"]
+  s.date = %q{2010-09-05}
   s.description = %q{With daemon-spawn you can start, stop and restart processes that run
     in the background. Processed are tracked by a simple PID file written
     to disk.}
@@ -28,9 +28,13 @@ Gem::Specification.new do |s|
      "daemon-spawn.gemspec",
      "lib/daemon_spawn.rb",
      "test/daemon_spawn_test.rb",
+     "test/helper.rb",
      "test/multi_daemon_spawn_test.rb",
+     "test/servers/deaf_server.rb",
      "test/servers/echo_server.rb",
-     "test/servers/simple_server.rb"
+     "test/servers/simple_server.rb",
+     "test/servers/stubborn_server.rb",
+     "test/servers/taps_server.rb"
   ]
   s.homepage = %q{http://github.com/alexvollmer/daemon-spawn}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -40,9 +44,13 @@ Gem::Specification.new do |s|
   s.summary = %q{Daemon launching and management made dead simple}
   s.test_files = [
     "test/daemon_spawn_test.rb",
+     "test/helper.rb",
      "test/multi_daemon_spawn_test.rb",
+     "test/servers/deaf_server.rb",
      "test/servers/echo_server.rb",
-     "test/servers/simple_server.rb"
+     "test/servers/simple_server.rb",
+     "test/servers/stubborn_server.rb",
+     "test/servers/taps_server.rb"
   ]
 
   if s.respond_to? :specification_version then

data/lib/daemon_spawn.rb

@@ -3,6 +3,7 @@ require 'fileutils'
 # Large portions of this were liberally stolen from the
 # 'simple-daemon' project at http://simple-daemon.rubyforge.org/
 module DaemonSpawn
+  VERSION = '0.3.0'
 
   def self.usage(msg=nil) #:nodoc:
     print "#{msg}, " if msg
@@ -10,6 +11,12 @@ module DaemonSpawn
     puts "Where <command> is one of start, stop, restart or status"
     puts "[options] are additional options passed to the underlying process"
   end
+  
+  def self.alive?(pid)
+    Process.kill 0, pid
+  rescue Errno::ESRCH
+    false
+  end
 
   def self.start(daemon, args) #:nodoc:
     if !File.writable?(File.dirname(daemon.log_file))
@@ -48,11 +55,22 @@ module DaemonSpawn
   def self.stop(daemon) #:nodoc:
     if pid = daemon.pid
       FileUtils.rm(daemon.pid_file)
-      Process.kill("TERM", pid)
+      Process.kill(daemon.signal, pid)
       begin
         Process.wait(pid)
       rescue Errno::ECHILD
       end
+      if ticks = daemon.timeout
+        while ticks > 0 and alive?(pid) do
+          puts "Process is still alive. #{ticks} seconds until I kill -9 it..."
+          sleep 1
+          ticks -= 1
+        end
+        if alive?(pid)
+          puts "Process didn't quit after timeout of #{daemon.timeout} seconds. Killing..."
+          Process.kill 9, pid
+        end
+      end
     else
       puts "PID file not found. Is the daemon started?"
     end
@@ -65,7 +83,7 @@ module DaemonSpawn
   end
 
   class Base
-    attr_accessor :log_file, :pid_file, :sync_log, :working_dir, :app_name, :singleton, :index
+    attr_accessor :log_file, :pid_file, :sync_log, :working_dir, :app_name, :singleton, :index, :signal, :timeout
 
     def initialize(opts = {})
       raise 'You must specify a :working_dir' unless opts[:working_dir]
@@ -73,6 +91,8 @@ module DaemonSpawn
       self.app_name = opts[:application] || classname
       self.pid_file = opts[:pid_file] || File.join(working_dir, 'tmp', 'pids', app_name + extension)
       self.log_file = opts[:log_file] || File.join(working_dir, 'logs', app_name + '.log')
+      self.signal = opts[:signal] || 'TERM'
+      self.timeout = opts[:timeout]
       self.index = opts[:index] || 0
       if self.index > 0
         self.pid_file += ".#{self.index}"
@@ -100,12 +120,8 @@ module DaemonSpawn
     end
 
     def alive? #:nodoc:
-      if File.file?(self.pid_file)
-        begin
-          Process.kill(0, self.pid)
-        rescue Errno::ESRCH, ::Exception
-          false
-        end
+      if File.file?(pid_file)
+        DaemonSpawn.alive? pid
       else
         false
       end
@@ -156,15 +172,14 @@ module DaemonSpawn
     end
 
     def self.start(opts, args)
-      daemons = find(opts)
-      if daemons.empty?
-        daemons = build(opts)
-        daemons.map { |d| DaemonSpawn.start(d, args) }
-      else
-        puts "Daemons already started! PIDS: #{daemons.map {|d| d.pid}.join(', ')}"
+      living_daemons = find(opts).select { |d| d.alive? }
+      if living_daemons.any?
+        puts "Daemons already started! PIDS: #{living_daemons.map {|d| d.pid}.join(', ')}"
         exit 1
+      else
+        build(opts).map { |d| DaemonSpawn.start(d, args) }
       end
-    end
+    end      
 
     def self.stop(opts, args)
       daemons = find(opts)
@@ -186,7 +201,7 @@ module DaemonSpawn
     end
 
     def self.restart(opts, args)
-      daemons = find(opts)
+      daemons = build(opts)
       daemons.map do |daemon|
         DaemonSpawn.stop(daemon)
         DaemonSpawn.start(daemon, args)

data/test/daemon_spawn_test.rb

@@ -1,12 +1,28 @@
+require File.join(File.dirname(__FILE__), "helper")
 require "socket"
-require "test/unit"
 
 class DaemonSpawnTest < Test::Unit::TestCase
 
   SERVERS = File.join(File.dirname(__FILE__), "servers")
 
+  # Try to make sure no pidfile (or process) is left over from another test.
+  def setup
+    %w{ echo_server deaf_server stubborn_server }.each do |server|
+      begin
+        Process.kill 9, possible_pid(server)
+      rescue Errno::ESRCH
+        # good, no process to kill
+      end
+      begin
+        File.unlink pid_file(server)
+      rescue Errno::ENOENT
+        # good, no pidfile to clear
+      end
+    end
+  end
+
   def with_socket
-    socket = TCPSocket.new('localhost', 5150)
+    socket = TCPSocket.new('127.0.0.1', 5150)
     socket.setsockopt(Socket::SOL_SOCKET,
                       Socket::SO_RCVTIMEO,
                       [1, 0].pack("l_2"))
@@ -31,10 +47,25 @@ class DaemonSpawnTest < Test::Unit::TestCase
         with_socket
       ensure
         assert_match(//, `./echo_server.rb stop`)
-        assert_raises(Errno::ECONNREFUSED) { TCPSocket.new('localhost', 5150) }
+        assert_raises(Errno::ECONNREFUSED) { TCPSocket.new('127.0.0.1', 5150) }
       end
     end
   end
+  
+  def after_daemon_dies_leaving_pid_file
+    Dir.chdir(SERVERS) do
+      `./echo_server.rb stop`
+      sleep 1
+      `./echo_server.rb start 5150`
+      sleep 1
+      leftover_pid = IO.read(pid_file('echo_server')).to_i
+      Process.kill 9, leftover_pid
+      sleep 1
+      assert dead?(leftover_pid)
+      assert File.exists?(pid_file('echo_server'))
+      yield leftover_pid
+    end
+  end
 
   def test_daemon_running
     while_running do |socket|
@@ -98,5 +129,56 @@ class DaemonSpawnTest < Test::Unit::TestCase
       end
     end
   end
+  
+  def test_start_after_daemon_dies_leaving_pid_file
+    after_daemon_dies_leaving_pid_file do |leftover_pid|
+      assert_match /EchoServer started/, `./echo_server.rb start 5150`
+      sleep 1
+      new_pid = IO.read(pid_file('echo_server')).to_i
+      assert new_pid != leftover_pid
+      assert alive?(new_pid)
+    end
+  end
 
+  def test_restart_after_daemon_dies_leaving_pid_file
+    after_daemon_dies_leaving_pid_file do |leftover_pid|
+      assert_match /EchoServer started/, `./echo_server.rb restart 5150`
+      sleep 1
+      new_pid = reported_pid 'echo_server'
+      assert new_pid != leftover_pid
+      assert alive?(new_pid)
+    end
+  end
+  
+  def test_stop_using_custom_signal
+    Dir.chdir(SERVERS) do
+      `./deaf_server.rb start`
+      sleep 1
+      pid = reported_pid 'deaf_server'
+      assert alive?(pid)
+      Process.kill 'TERM', pid
+      sleep 1
+      assert alive?(pid)
+      Process.kill 'INT', pid
+      sleep 1
+      assert alive?(pid)
+      `./deaf_server.rb stop`
+      sleep 1
+      assert dead?(pid)
+    end
+  end
+
+  def test_kill_9_following_timeout
+    Dir.chdir(SERVERS) do
+      `./stubborn_server.rb start`
+      sleep 1
+      pid = reported_pid 'stubborn_server'
+      assert alive?(pid)
+      Process.kill 'TERM', pid
+      sleep 1
+      assert alive?(pid)
+      `./stubborn_server.rb stop`
+      assert dead?(pid)
+    end
+  end
 end

data/test/helper.rb

@@ -0,0 +1,26 @@
+require "test/unit"
+require "tmpdir"
+
+class Test::Unit::TestCase
+  def pid_file(daemon_name)
+    File.join Dir.tmpdir, "#{daemon_name}.pid"
+  end
+  
+  def possible_pid(daemon_name)
+    `ps x | grep ruby | grep #{daemon_name} | awk '{ print $1 }'`.to_i
+  end
+  
+  def reported_pid(daemon_name)
+    IO.read(pid_file(daemon_name)).to_i
+  end
+  
+  def alive?(pid)
+    Process.kill 0, pid
+  rescue Errno::ESRCH
+    false
+  end
+  
+  def dead?(pid)
+    not alive? pid
+  end
+end

data/test/multi_daemon_spawn_test.rb

@@ -1,4 +1,4 @@
-require "test/unit"
+require File.join(File.dirname(__FILE__), "helper")
 require "tempfile"
 
 class MultiDaemonSpawnTest < Test::Unit::TestCase

data/test/servers/deaf_server.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.join(File.dirname(__FILE__), "..", "..", "lib"))
+
+require "daemon_spawn"
+require "tmpdir"
+
+# A server that only quits if you send it SIGWINCH
+class DeafServer < DaemonSpawn::Base
+  def start(args)
+    trap('TERM') { }
+    trap('INT')  { }
+    trap('SIGWINCH') { exit 0 }
+    loop do
+      sleep 100
+    end
+  end
+
+  def stop
+  end
+end
+
+DeafServer.spawn!(:working_dir => File.join(File.dirname(__FILE__), '..', '..'),
+                  :log_file => File.join(Dir.tmpdir, 'deaf_server.log'),
+                  :pid_file => File.join(Dir.tmpdir, 'deaf_server.pid'),
+                  :sync_log => true,
+                  :singleton => true,
+                  :signal => 'SIGWINCH')

data/test/servers/echo_server.rb

@@ -4,6 +4,7 @@ $:.unshift(File.join(File.dirname(__FILE__), "..", "..", "lib"))
 
 require "daemon_spawn"
 require "socket"
+require "tmpdir"
 
 # An echo server using daemon-spawn. It starts up local TCP server
 # socket and repeats each line it receives on the connection. To fire
@@ -48,7 +49,7 @@ class EchoServer < DaemonSpawn::Base
 end
 
 EchoServer.spawn!(:working_dir => File.join(File.dirname(__FILE__), '..', '..'),
-                  :log_file => '/tmp/echo_server.log',
-                  :pid_file => '/tmp/echo_server.pid',
+                  :log_file => File.join(Dir.tmpdir, 'echo_server.log'),
+                  :pid_file => File.join(Dir.tmpdir, 'echo_server.pid'),
                   :sync_log => true,
                   :singleton => true)

data/test/servers/stubborn_server.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.join(File.dirname(__FILE__), "..", "..", "lib"))
+
+require "daemon_spawn"
+require "tmpdir"
+
+# A server that needs to be kill -9'ed
+class StubbornServer < DaemonSpawn::Base
+  def start(args)
+    trap('TERM') { }
+    loop do
+      sleep 100
+    end
+  end
+
+  def stop
+    raise "You should never get to me"
+  end
+end
+
+StubbornServer.spawn!(:working_dir => File.join(File.dirname(__FILE__), '..', '..'),
+                      :log_file => File.join(Dir.tmpdir, 'stubborn_server.log'),
+                      :pid_file => File.join(Dir.tmpdir, 'stubborn_server.pid'),
+                      :sync_log => true,
+                      :singleton => true,
+                      :timeout => 2)

data/test/servers/taps_server.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.join(File.dirname(__FILE__), "..", "..", "lib"))
+
+require "daemon_spawn"
+
+class TapsServer < DaemonSpawn::Base
+  def start(args)
+    sleep 5 # Sinatra takes its sweet time to shut down
+    Kernel.exec "/usr/bin/taps server mysql://dbusername:dbpassword@localhost/data1_production?encoding=utf8 username password"
+  end
+
+  def stop
+  end
+end
+TapsServer.spawn!(:working_dir => File.join(File.dirname(__FILE__), '..', '..'),
+                  :log_file => File.join(Dir.tmpdir, 'taps_server.log'),
+                  :pid_file => File.join(Dir.tmpdir, 'taps_server.pid'),
+                  :sync_log => true,
+                  :singleton => true,
+                  :signal => 'INT') # Sinatra ignores TERM

metadata

@@ -1,21 +1,25 @@
 --- !ruby/object:Gem::Specification 
 name: daemon-spawn
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Alex Vollmer
+- Seamus Abshere
+- Emmanual Gomez
+- Seth Falcon
+- Woody Peterson
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-05-20 00:00:00 -07:00
+date: 2010-09-05 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -41,9 +45,13 @@ files:
 - daemon-spawn.gemspec
 - lib/daemon_spawn.rb
 - test/daemon_spawn_test.rb
+- test/helper.rb
 - test/multi_daemon_spawn_test.rb
+- test/servers/deaf_server.rb
 - test/servers/echo_server.rb
 - test/servers/simple_server.rb
+- test/servers/stubborn_server.rb
+- test/servers/taps_server.rb
 has_rdoc: true
 homepage: http://github.com/alexvollmer/daemon-spawn
 licenses: []
@@ -80,6 +88,10 @@ specification_version: 3
 summary: Daemon launching and management made dead simple
 test_files: 
 - test/daemon_spawn_test.rb
+- test/helper.rb
 - test/multi_daemon_spawn_test.rb
+- test/servers/deaf_server.rb
 - test/servers/echo_server.rb
 - test/servers/simple_server.rb
+- test/servers/stubborn_server.rb
+- test/servers/taps_server.rb