FooBarWidget-daemon_controller 0.2.0 → 0.2.1

data/README.markdown

@@ -24,7 +24,7 @@ some of them.
 ### Starting daemons is a hassle
 
 If you've used similar software, then you might agree that managing these
-daemons are a hassle. If you're using BackgrounDRb, then the daemon must be
+daemons is a hassle. If you're using BackgrounDRb, then the daemon must be
 running. Starting the daemon is not hard, but it is annoying. It's also
 possible that the system administrator forgets to start the daemon. While
 configuring the system to automatically start a daemon at startup is not hard,
@@ -209,6 +209,46 @@ daemon_controller's goal is to make daemon management less of a hassle, and as
 automatic and straightforward as possible.
 
 
+What about Monit/God?
+=====================
+
+daemon_controller is not a replacement for [Monit](http://www.tildeslash.com/monit/)
+or [God](http://god.rubyforge.org/). Rather, it is a solution to the following
+problem:
+
+> **Hongli:** hey Ninh, do a 'git pull', I just implemented awesome searching
+>             features in our application!  
+>   **Ninh:** cool. *pulls from repository*  
+>   **Ninh:** hey Hongli, it doesn't work.  
+> **Hongli:** what do you mean, it doesn't work?  
+>   **Ninh:** it says "connection refused", or something  
+> **Hongli:** oh I forgot to mention it, you have to run the Sphinx search
+>             daemon before it works. type "rake sphinx:daemon:start" to do
+>             that  
+>   **Ninh:** great. but now I get a different error. something about
+>             BackgrounDRb.  
+> **Hongli:** oops, I forgot to mention this too. you need to start the
+>             BackgrounDRb server with "rake backgroundrb:start_server"  
+>   **Ninh:** okay, so every time I want to use this app, I have to type
+>             "rake sphinx:daemon:start", "rake backgroundrb:start_server" and
+>             "./script/server"?  
+> **Hongli:** yep
+
+Imagine the above conversation becoming just:
+
+> **Hongli:** hey Ninh, do a 'git pull', I just implemented awesome searching
+>             features in our application!  
+>   **Ninh:** cool. *pulls from repository*  
+>   **Ninh:** awesome, it works!
+
+This is not something that can be achieved with Monit/God. Monit/God are for
+monitoring daemons, auto-restarting them when they use too much resources.
+daemon_controller's goal is to allow developers to implement daemon
+starting/stopping and daemon auto-starting code that's robust. daemon_controller
+is intended to be used to make daemon-dependent applications Just Work(tm)
+without having to start the daemons manually.
+
+
 Tutorial #1: controlling Apache
 ===============================
 
@@ -271,7 +311,7 @@ raises `Errno::ECONNREFUSED`, then that's also interpreted by DaemonController
 as meaning that the daemon isn't responding yet.
 
 After `controller.start` has returned, we can continue with the test case. At
-this point, we know that Apache has done initializing.
+this point, we know that Apache is done with initializing.
 When we're done with Apache, we stop it with `controller.stop`. This does not
 return until Apache has fully stopped.
 
@@ -295,7 +335,7 @@ that there's little room for human screw-up, and so we've developed this
 library. Our Sphinx search daemon is completely managed through this library
 and is automatically started on demand.
 
-Our Sphinx config file is generated from an ERB template. This ERB templates
+Our Sphinx config file is generated from an ERB template. This ERB template
 writes different values in the config file, depending on whether we're in
 development, test or production mode. We will want to regenerate this config
 file every time, just before we start the search daemon.
@@ -325,7 +365,7 @@ This can be achieved with the following code:
              :before_start => method(:before_start),
              :ping_command => lambda { TCPSocket.new('localhost', SEARCH_SERVER_PORT) },
              :pid_file => 'tmp/pids/sphinx.pid',
-             :log_file => 'log/sphinx.log',
+             :log_file => 'log/sphinx.log')
        end
        
        def query(search_terms)

data/daemon_controller.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name = "daemon_controller"
-  s.version = "0.2.0"
-  s.date = "2008-08-21"
+  s.version = "0.2.1"
+  s.date = "2009-02-22"
   s.summary = "A library for implementing daemon management capabilities"
   s.email = "hongli@phusion.nl"
   s.homepage = "http://github.com/FooBarWidget/daemon_controller/tree/master"

data/lib/daemon_controller.rb

@@ -21,12 +21,13 @@
 
 require 'tempfile'
 require 'fcntl'
+require 'timeout'
 require File.expand_path(File.dirname(__FILE__) << '/daemon_controller/lock_file')
 
 # Main daemon controller object. See the README for an introduction and tutorial.
 class DaemonController
 	ALLOWED_CONNECT_EXCEPTIONS = [Errno::ECONNREFUSED, Errno::ENETUNREACH,
-		Errno::ETIMEDOUT, Errno::ECONNRESET]
+		Errno::ETIMEDOUT, Errno::ECONNRESET, Errno::EINVAL]
 	
 	class Error < StandardError
 	end
@@ -497,6 +498,11 @@ private
 				STDIN.reopen("/dev/null", "r")
 				STDOUT.reopen(tempfile_path, "w")
 				STDERR.reopen(tempfile_path, "w")
+				ObjectSpace.each_object(IO) do |obj|
+					if STDIN != obj && STDOUT != obj && STDERR != obj
+						obj.close rescue nil
+					end
+				end
 				exec(command)
 			end
 			begin
@@ -519,7 +525,9 @@ private
 				raise StartError, File.read(tempfile_path).strip
 			end
 		else
-			if !system("#{command} >\"#{tempfile_path}\" 2>\"#{tempfile_path}\"")
+			cmd = "#{command} >\"#{tempfile_path}\""
+			cmd += " 2>\"#{tempfile_path}\"" unless PLATFORM =~ /mswin/
+			if !system(cmd)
 				raise StartError, File.read(tempfile_path).strip
 			end
 		end

data/lib/daemon_controller/lock_file.rb

@@ -21,6 +21,9 @@
 
 class DaemonController
 class LockFile
+	class AlreadyLocked < StandardError
+	end
+	
 	def initialize(filename)
 		@filename = filename
 	end
@@ -44,5 +47,31 @@ class LockFile
 			yield
 		end
 	end
-end # class PidFile
+	
+	def try_shared_lock
+		File.open(@filename, 'w') do |f|
+			if Fcntl.const_defined? :F_SETFD
+				f.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
+			end
+			if f.flock(File::LOCK_SH | File::LOCK_NB)
+				yield
+			else
+				raise AlreadyLocked
+			end
+		end
+	end
+	
+	def try_exclusive_lock
+		File.open(@filename, 'w') do |f|
+			if Fcntl.const_defined? :F_SETFD
+				f.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
+			end
+			if f.flock(File::LOCK_EX | File::LOCK_NB)
+				yield
+			else
+				raise AlreadyLocked
+			end
+		end
+	end
+end # class LockFile
 end # class DaemonController

data/spec/daemon_controller_spec.rb

@@ -165,8 +165,12 @@ describe DaemonController, "#start" do
 		@controller.should_receive(:start_timed_out).and_return do
 			end_time = Time.now
 		end
-		lambda { @controller.start }.should raise_error(DaemonController::StartTimeout)
-		(min_start_timeout .. max_start_timeout).should === end_time - start_time
+		begin
+			lambda { @controller.start }.should raise_error(DaemonController::StartTimeout)
+			(min_start_timeout .. max_start_timeout).should === end_time - start_time
+		ensure
+			@controller.stop
+		end
 	end
 	
 	it "kills the daemon with a signal if the daemon doesn't start in time and there's a PID file" do
@@ -178,7 +182,14 @@ describe DaemonController, "#start" do
 			end
 			pid = @controller.send(:read_pid_file)
 		end
-		lambda { @controller.start }.should raise_error(DaemonController::StartTimeout)
+		begin
+			lambda { @controller.start }.should raise_error(DaemonController::StartTimeout)
+		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("echo_server.pid") rescue nil
+		end
 	end
 	
 	if DaemonController.send(:fork_supported?)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: FooBarWidget-daemon_controller
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Hongli Lai
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-21 00:00:00 -07:00
+date: 2009-02-22 00:00:00 -08:00
 default_executable: 
 dependencies: []