daemon_controller 0.2.3 → 0.2.4

data/README.markdown

@@ -29,10 +29,10 @@ It provides the following functionality:
 
     gem install daemon_controller
 
-
 ## Resources
 
 *   [Website](http://github.com/FooBarWidget/daemon_controller)
+*   [RDoc](http://rdoc.info/projects/FooBarWidget/daemon_controller)
 *   [Git repository](git://github.com/FooBarWidget/daemon_controller.git)
 *   [RubyForge project](http://rubyforge.org/projects/daemoncontrol/)
 

data/daemon_controller.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name = "daemon_controller"
   # Don't forget to update version.rb too.
-  s.version = "0.2.3"
+  s.version = "0.2.4"
   s.date = "2009-11-13"
   s.summary = "A library for implementing daemon management capabilities"
   s.email = "hongli@phusion.nl"

data/lib/daemon_controller.rb

@@ -1,5 +1,5 @@
 # daemon_controller, library for robust daemon management
-# Copyright (c) 2008 Phusion
+# 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
@@ -22,7 +22,14 @@
 require 'tempfile'
 require 'fcntl'
 require 'timeout'
-require File.expand_path(File.dirname(__FILE__) << '/daemon_controller/lock_file')
+
+libdir = File.expand_path(File.dirname(__FILE__))
+$LOAD_PATH.unshift(libdir)
+require 'daemon_controller/lock_file'
+
+if Process.respond_to?(:spawn)
+	require 'rbconfig'
+end
 
 # Main daemon controller object. See the README for an introduction and tutorial.
 class DaemonController
@@ -30,6 +37,9 @@ class DaemonController
 		Errno::ETIMEDOUT, Errno::ECONNRESET, Errno::EINVAL,
 		Errno::EADDRNOTAVAIL]
 	
+	SPAWNER_FILE = File.expand_path(File.join(File.dirname(__FILE__),
+		"daemon_controller", "spawn.rb"))
+	
 	class Error < StandardError
 	end
 	class TimeoutError < Error
@@ -125,8 +135,8 @@ class DaemonController
 	# [:log_file_activity_timeout]
 	#  Once a daemon has gone into the background, it will become difficult to
 	#  know for certain whether it is still initializing or whether it has
-	#  failed and exited, until it has written its PID file. It's 99.9% probable
-	#  that the daemon has terminated with an if its start timeout has expired,
+	#  failed and exited, until it has written its PID file. Suppose that it
+	#  failed with an error after daemonizing but before it has written its PID file;
 	#  not many system administrators want to wait 15 seconds (the default start
 	#  timeout) to be notified of whether the daemon has terminated with an error.
 	#  
@@ -137,6 +147,21 @@ class DaemonController
 	#  have terminated with an error.
 	#  
 	#  The default value is 7.
+	#
+	# [:daemonize_for_me]
+	#  Normally daemon_controller will wait until the daemon has daemonized into the
+	#  background, in order to capture any errors that it may print on stdout or
+	#  stderr before daemonizing. However, if the daemon doesn't support daemonization
+	#  for some reason, then setting this option to true will cause daemon_controller
+	#  to do the daemonization for the daemon.
+	#  
+	#  The default is false.
+	#
+	# [:keep_ios]
+	#  Upon spawning the daemon, daemon_controller will normally close all file
+	#  descriptors except stdin, stdout and stderr. However if there are any file
+	#  descriptors you want to keep open, specify the IO objects here. This must be
+	#  an array of IO objects.
 	def initialize(options)
 		[:identifier, :start_command, :ping_command, :pid_file, :log_file].each do |option|
 			if !options.has_key?(option)
@@ -154,6 +179,8 @@ class DaemonController
 		@start_timeout = options[:start_timeout] || 15
 		@stop_timeout = options[:stop_timeout] || 15
 		@log_file_activity_timeout = options[:log_file_activity_timeout] || 7
+		@daemonize_for_me = options[:daemonize_for_me]
+		@keep_ios = options[:keep_ios] || []
 		@lock_file = determine_lock_file(@identifier, @pid_file)
 	end
 	
@@ -511,16 +538,31 @@ private
 		
 		if self.class.fork_supported? || Process.respond_to?(:spawn)
 			if Process.respond_to?(:spawn)
-				pid = Process.spawn(command,
-					:in  => "/dev/null",
-					:out => tempfile_path,
-					:err => tempfile_path,
+				options = {
+					STDIN  => "/dev/null",
+					STDOUT => tempfile_path,
+					STDERR => tempfile_path,
 					:close_others => true
-				)
+				}
+				@keep_ios.each do |io|
+					options[io] = io
+				end
+				if @daemonize_for_me
+					ruby_interpreter = File.join(
+						Config::CONFIG['bindir'],
+						Config::CONFIG['RUBY_INSTALL_NAME']
+					) + Config::CONFIG['EXEEXT']
+					pid = Process.spawn(ruby_interpreter, SPAWNER_FILE,
+						command, options)
+				else
+					pid = Process.spawn(command, options)
+				end
 			else
-				pid = safe_fork do
+				pid = safe_fork(@daemonize_for_me) do
 					ObjectSpace.each_object(IO) do |obj|
-						obj.close rescue nil
+						if !@keep_ios.include?(obj)
+							obj.close rescue nil
+						end
 					end
 					STDIN.reopen("/dev/null", "r")
 					STDOUT.reopen(tempfile_path, "w")
@@ -594,11 +636,18 @@ private
 		end
 	end
 	
-	def safe_fork
+	def safe_fork(double_fork)
 		pid = fork
 		if pid.nil?
 			begin
-				yield
+				if double_fork
+					pid2 = fork
+					if pid2.nil?
+						yield
+					end
+				else
+					yield
+				end
 			rescue Exception => e
 				message = "*** Exception #{e.class} " <<
 					"(#{e}) (process #{$$}):\n" <<
@@ -609,7 +658,12 @@ private
 				exit!
 			end
 		else
-			return pid
+			if double_fork
+				Process.waitpid(pid) rescue nil
+				return pid
+			else
+				return pid
+			end
 		end
 	end
 	

data/lib/daemon_controller/lock_file.rb

@@ -1,5 +1,5 @@
 # daemon_controller, library for robust daemon management
-# Copyright (c) 2008 Phusion
+# 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

data/lib/daemon_controller/version.rb

@@ -1,5 +1,5 @@
 # daemon_controller, library for robust daemon management
-# Copyright (c) 2009 Phusion
+# 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
@@ -22,6 +22,6 @@
 class DaemonController
 	MAJOR = 0
 	MINOR = 2
-	TINY  = 3
+	TINY  = 4
 	VERSION_STRING = "#{MAJOR}.#{MINOR}.#{TINY}"
 end # class DaemonController

data/spec/daemon_controller_spec.rb

@@ -12,6 +12,7 @@ describe DaemonController, "#start" do
 	
 	it "works" do
 		@controller.start
+		ping_echo_server.should be_true
 		@controller.stop
 	end
 	
@@ -186,6 +187,30 @@ describe DaemonController, "#start" do
 		end
 		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])
+			begin
+				@controller.start
+				b.close
+				select([a], nil, nil, 0).should be_nil
+			ensure
+				@controller.stop
+			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
+	end
 end
 
 describe DaemonController, "#stop" do

data/spec/echo_server.rb

@@ -9,7 +9,8 @@ options = {
 	:log_file => "/dev/null",
 	:wait1 => 0,
 	:wait2 => 0,
-	:stop_time => 0
+	:stop_time => 0,
+	:daemonize => true
 }
 parser = OptionParser.new do |opts|
 	opts.banner = "Usage: echo_server.rb [options]"
@@ -40,6 +41,9 @@ parser = OptionParser.new do |opts|
 	opts.on("--crash-before-bind", "Whether the daemon should crash before binding the server socket.") do
 		options[:crash_before_bind] = true
 	end
+	opts.on("--no-daemonize", "Don't daemonize.") do
+		options[:daemonize] = false
+	end
 end
 begin
 	parser.parse!
@@ -57,60 +61,65 @@ if options[:pid_file]
 	end
 end
 
-pid = fork do
-	Process.setsid
-	fork do
-		STDIN.reopen("/dev/null", 'r')
-		STDOUT.reopen(options[:log_file], 'a')
-		STDERR.reopen(options[:log_file], 'a')
-		STDOUT.sync = true
-		STDERR.sync = true
-		Dir.chdir(options[:chdir])
-		File.umask(0)
-		
-		if options[:pid_file]
-			sleep(options[:wait1])
-			File.open(options[:pid_file], 'w') do |f|
-				f.write(Process.pid)
-			end
-			at_exit do
-				File.unlink(options[:pid_file]) rescue nil
-			end
+def main(options)
+	STDIN.reopen("/dev/null", 'r')
+	STDOUT.reopen(options[:log_file], 'a')
+	STDERR.reopen(options[:log_file], 'a')
+	STDOUT.sync = true
+	STDERR.sync = true
+	Dir.chdir(options[:chdir])
+	File.umask(0)
+	
+	if options[:pid_file]
+		sleep(options[:wait1])
+		File.open(options[:pid_file], 'w') do |f|
+			f.write(Process.pid)
 		end
-		
-		sleep(options[:wait2])
-		if options[:crash_before_bind]
-			puts "#{Time.now}: crashing, as instructed."
-			exit 2
+		at_exit do
+			File.unlink(options[:pid_file]) rescue nil
 		end
-		
-		server = TCPServer.new('127.0.0.1', options[:port])
-		begin
-			puts "*** #{Time.now}: echo server started"
-			while (client = server.accept)
-				puts "#{Time.now}: new client"
-				begin
-					while (line = client.readline)
-						puts "#{Time.now}: client sent: #{line.strip}"
-						client.puts(line)
-					end
-				rescue EOFError
-				ensure
-					puts "#{Time.now}: connection closed"
-					client.close rescue nil
+	end
+	
+	sleep(options[:wait2])
+	if options[:crash_before_bind]
+		puts "#{Time.now}: crashing, as instructed."
+		exit 2
+	end
+	
+	server = TCPServer.new('127.0.0.1', options[:port])
+	begin
+		puts "*** #{Time.now}: echo server started"
+		while (client = server.accept)
+			puts "#{Time.now}: new client"
+			begin
+				while (line = client.readline)
+					puts "#{Time.now}: client sent: #{line.strip}"
+					client.puts(line)
 				end
+			rescue EOFError
+			ensure
+				puts "#{Time.now}: connection closed"
+				client.close rescue nil
 			end
-		rescue SignalException
-			exit 2
-		rescue => e
-			puts e.to_s
-			puts "    " << e.backtrace.join("\n    ")
-			exit 3
-		ensure
-			puts "*** #{Time.now}: echo server exiting..."
-			sleep(options[:stop_time])
-			puts "*** #{Time.now}: echo server exited"
 		end
+	rescue SignalException
+		exit 2
+	rescue => e
+		puts e.to_s
+		puts "    " << e.backtrace.join("\n    ")
+		exit 3
+	ensure
+		puts "*** #{Time.now}: echo server exiting..."
+		sleep(options[:stop_time])
+		puts "*** #{Time.now}: echo server exited"
 	end
 end
-Process.waitpid(pid)
+
+if options[:daemonize]
+	fork do
+		Process.setsid
+		main(options)
+	end
+else
+	main(options)
+end

data/spec/test_helper.rb

@@ -17,17 +17,13 @@ module TestHelper
 		if options[:crash_before_bind]
 			@start_command << " --crash-before-bind"
 		end
+		if options[:no_daemonize]
+			@start_command << " --no-daemonize"
+		end
 		new_options = {
 			:identifier    => 'My Test Daemon',
 			:start_command => @start_command,
-			:ping_command  => proc do
-				begin
-					TCPSocket.new('127.0.0.1', 3230)
-					true
-				rescue SystemCallError
-					false
-				end
-			end,
+			:ping_command  => method(:ping_echo_server),
 			:pid_file      => 'spec/echo_server.pid',
 			:log_file      => 'spec/echo_server.log',
 			:start_timeout => 3,
@@ -36,6 +32,15 @@ module TestHelper
 		@controller = DaemonController.new(new_options)
 	end
 	
+	def ping_echo_server
+		begin
+			TCPSocket.new('127.0.0.1', 3230)
+			true
+		rescue SystemCallError
+			false
+		end
+	end
+	
 	def write_file(filename, contents)
 		File.open(filename, 'w') do |f|
 			f.write(contents)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: daemon_controller
 version: !ruby/object:Gem::Version 
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors: 
 - Hongli Lai