daemon_controller 0.2.4 → 0.2.5

data/daemon_controller.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |s|
   s.name = "daemon_controller"
   # Don't forget to update version.rb too.
-  s.version = "0.2.4"
-  s.date = "2009-11-13"
+  s.version = "0.2.5"
+  s.date = "2010-01-13"
   s.summary = "A library for implementing daemon management capabilities"
   s.email = "hongli@phusion.nl"
   s.homepage = "http://github.com/FooBarWidget/daemon_controller/tree/master"
@@ -14,9 +14,11 @@ Gem::Specification.new do |s|
       "README.markdown", "LICENSE.txt", "daemon_controller.gemspec",
       "lib/daemon_controller.rb",
       "lib/daemon_controller/lock_file.rb",
+      "lib/daemon_controller/spawn.rb",
       "lib/daemon_controller/version.rb",
       "spec/test_helper.rb",
       "spec/daemon_controller_spec.rb",
-      "spec/echo_server.rb"
+      "spec/echo_server.rb",
+      "spec/unresponsive_daemon.rb"
   ]
 end

data/lib/daemon_controller.rb

@@ -56,6 +56,8 @@ class DaemonController
 	end
 	class ConnectError < Error
 	end
+	class DaemonizationTimeout < TimeoutError
+	end
 
 	# Create a new DaemonController object.
 	#
@@ -347,17 +349,24 @@ private
 				started = run_ping_command
 			end
 			result = started
-		rescue Timeout::Error
+		rescue DaemonizationTimeout, Timeout::Error => e
 			start_timed_out
 			if pid_file_available?
-				kill_daemon_with_signal
+				kill_daemon_with_signal(true)
+			end
+			if e.is_a?(DaemonizationTimeout)
+				result = :daemonization_timeout
+			else
+				result = :start_timeout
 			end
-			result = :timeout
 		end
 		if !result
 			raise(StartError, differences_in_log_file ||
 				"Daemon '#{@identifier}' failed to start.")
-		elsif result == :timeout
+		elsif result == :daemonization_timeout
+			raise(StartTimeout, differences_in_log_file ||
+				"Daemon '#{@identifier}' didn't daemonize in time.")
+		elsif result == :start_timeout
 			raise(StartTimeout, differences_in_log_file ||
 				"Daemon '#{@identifier}' failed to start in time.")
 		else
@@ -391,10 +400,14 @@ private
 		end
 	end
 	
-	def kill_daemon_with_signal
+	def kill_daemon_with_signal(force = false)
 		pid = read_pid_file
 		if pid
-			Process.kill('SIGTERM', pid)
+			if force
+				Process.kill('SIGKILL', pid)
+			else
+				Process.kill('SIGTERM', pid)
+			end
 		end
 	rescue Errno::ESRCH, Errno::ENOENT
 	end
@@ -482,6 +495,10 @@ private
 	def start_timed_out
 	end
 	
+	# This method does nothing and only serves as a hook for the unit test.
+	def daemonization_timed_out
+	end
+	
 	def save_log_file_information
 		@original_log_file_stat = File.stat(@log_file) rescue nil
 		@current_log_file_stat = @original_log_file_stat
@@ -584,6 +601,8 @@ private
 				# it.
 				return
 			rescue Timeout::Error
+				daemonization_timed_out
+				
 				# If the daemon doesn't fork into the background
 				# in time, then kill it.
 				begin
@@ -604,7 +623,7 @@ private
 					rescue SystemCallError
 					end
 				end
-				raise
+				raise DaemonizationTimeout
 			end
 			if $?.exitstatus != 0
 				raise StartError, File.read(tempfile_path).strip
@@ -643,6 +662,7 @@ private
 				if double_fork
 					pid2 = fork
 					if pid2.nil?
+						Process.setsid
 						yield
 					end
 				else

data/lib/daemon_controller/spawn.rb

@@ -0,0 +1,24 @@
+# daemon_controller, library for robust daemon management
+# Copyright (c) 2010 Phusion
+# 
+# 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.
+
+# Used on Ruby 1.9 because forking is not safe.
+Process.setsid
+Process.spawn(ARGV[0])

data/lib/daemon_controller/version.rb

@@ -22,6 +22,6 @@
 class DaemonController
 	MAJOR = 0
 	MINOR = 2
-	TINY  = 4
+	TINY  = 5
 	VERSION_STRING = "#{MAJOR}.#{MINOR}.#{TINY}"
 end # class DaemonController

data/spec/daemon_controller_spec.rb

@@ -103,7 +103,8 @@ describe DaemonController, "#start" do
 		end
 	end
 	
-	it "kills the daemon with a signal if the daemon doesn't start in time and there's a PID file" do
+	it "kills the daemon forcefully if the daemon has forked but doesn't " <<
+	   "become pingable in time, and there's a PID file" do
 		new_controller(:wait2 => 3, :start_timeout => 1)
 		pid = nil
 		@controller.should_receive(:start_timed_out).and_return do
@@ -113,21 +114,41 @@ describe DaemonController, "#start" do
 			pid = @controller.send(:read_pid_file)
 		end
 		begin
-			lambda { @controller.start }.should raise_error(DaemonController::StartTimeout)
+			block = lambda { @controller.start }
+			block.should raise_error(DaemonController::StartTimeout, /failed to start in time/)
+			eventually(1) do
+				!process_is_alive?(pid)
+			end
+			
+			# The daemon should not be able to clean up its PID file since
+			# it's killed with SIGKILL.
+			File.exist?("spec/echo_server.pid").should be_true
 		ensure
-			# It's possible that because of a racing condition, the PID
-			# file doesn't get deleted before the next test is run. So
-			# here we ensure that the PID file is gone.
 			File.unlink("spec/echo_server.pid") rescue nil
 		end
 	end
 	
-	if DaemonController.send(:fork_supported?)
-		it "kills the daemon if it doesn't start in time and hasn't " <<
-		   "forked yet, on platforms where Ruby supports fork()" do
-			new_controller(:start_command => '(echo $$ > spec/echo_server.pid && sleep 5)',
-				:start_timeout => 0.3)
-			lambda { @controller.start }.should raise_error(DaemonController::StartTimeout)
+	if DaemonController.send(:fork_supported?) || Process.respond_to?(:spawn)
+		it "kills the daemon if it doesn't start in time and hasn't forked " <<
+		   "yet, on platforms where Ruby supports fork() or Process.spawn" do
+			begin
+				new_controller(:start_command => "./spec/unresponsive_daemon.rb",
+					:start_timeout => 0.2)
+				pid = nil
+				@controller.should_receive(:daemonization_timed_out).and_return do
+					@controller.send(:wait_until) do
+						@controller.send(:pid_file_available?)
+					end
+					pid = @controller.send(:read_pid_file)
+				end
+				block = lambda { @controller.start }
+				block.should raise_error(DaemonController::StartTimeout, /didn't daemonize in time/)
+				eventually(1) do
+					!process_is_alive?(pid)
+				end
+			ensure
+				File.unlink("spec/echo_server.pid") rescue nil
+			end
 		end
 	end
 	
@@ -188,28 +209,30 @@ describe DaemonController, "#start" do
 		log.should == ["before_start", "start_command"]
 	end
 	
-	it "keeps the file descriptors in 'keep_ios' open" do
-		a, b = IO.pipe
-		begin
-			new_controller(:keep_ios => [b])
+	if DaemonController.send(:fork_supported?) || Process.respond_to?(:spawn)
+		it "keeps the file descriptors in 'keep_ios' open" do
+			a, b = IO.pipe
 			begin
-				@controller.start
-				b.close
-				select([a], nil, nil, 0).should be_nil
+				new_controller(:keep_ios => [b])
+				begin
+					@controller.start
+					b.close
+					select([a], nil, nil, 0).should be_nil
+				ensure
+					@controller.stop
+				end
 			ensure
-				@controller.stop
+				a.close if !a.closed?
+				b.close if !b.closed?
 			end
-		ensure
-			a.close if !a.closed?
-			b.close if !b.closed?
 		end
-	end
-	
-	it "performs the daemonization on behalf of the daemon if 'daemonize_for_me' is set" do
-		new_controller(:no_daemonize => true, :daemonize_for_me => true)
-		@controller.start
-		ping_echo_server.should be_true
-		@controller.stop
+		
+		it "performs the daemonization on behalf of the daemon if 'daemonize_for_me' is set" do
+			new_controller(:no_daemonize => true, :daemonize_for_me => true)
+			@controller.start
+			ping_echo_server.should be_true
+			@controller.stop
+		end
 	end
 end
 
@@ -235,7 +258,7 @@ describe DaemonController, "#stop" do
 			@controller.stop
 		end
 		@controller.should_not be_running
-		(0.3 .. 0.6).should === result.real
+		result.real.should be_between(0.3, 0.6)
 	end
 	
 	it "raises StopTimeout if the daemon does not stop in time" do

data/spec/test_helper.rb

@@ -50,6 +50,29 @@ module TestHelper
 	def exec_is_slow?
 		return RUBY_PLATFORM == "java"
 	end
+	
+	def process_is_alive?(pid)
+		begin
+			Process.kill(0, pid)
+			return true
+		rescue Errno::ESRCH
+			return false
+		rescue SystemCallError => e
+			return true
+		end
+	end
+	
+	def eventually(deadline_duration = 1, check_interval = 0.05)
+		deadline = Time.now + deadline_duration
+		while Time.now < deadline
+			if yield
+				return
+			else
+				sleep(check_interval)
+			end
+		end
+		raise "Time limit exceeded"
+	end
 end
 
 # A thread which doesn't execute its block until the

data/spec/unresponsive_daemon.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+dir = File.dirname(__FILE__)
+Dir.chdir(File.dirname(dir))
+begin
+	File.open("spec/echo_server.pid", "w") do |f|
+		f.puts(Process.pid)
+	end
+	sleep 30
+rescue SignalException
+	File.unlink("spec/echo_server.pid") rescue nil
+	raise
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: daemon_controller
 version: !ruby/object:Gem::Version 
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors: 
 - Hongli Lai
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-13 00:00:00 +01:00
+date: 2010-01-13 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -27,10 +27,12 @@ files:
 - daemon_controller.gemspec
 - lib/daemon_controller.rb
 - lib/daemon_controller/lock_file.rb
+- lib/daemon_controller/spawn.rb
 - lib/daemon_controller/version.rb
 - spec/test_helper.rb
 - spec/daemon_controller_spec.rb
 - spec/echo_server.rb
+- spec/unresponsive_daemon.rb
 has_rdoc: true
 homepage: http://github.com/FooBarWidget/daemon_controller/tree/master
 licenses: []