daemon 1.1.0 → 1.2.0

data/Gemfile

@@ -1,15 +1,10 @@
-source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
+source 'http://rubygems.org'
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "rspec", "~> 2.3.0"
-  gem "shoulda", ">= 0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.6.4"
-  gem "rcov", ">= 0"
+  gem 'rspec', '~> 2.13'
+  gem 'jeweler', '~> 1.8.4'
+  gem 'rdoc', '~> 3.9'
 end
 

data/Gemfile.lock

@@ -1,30 +1,30 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    diff-lcs (1.1.3)
+    diff-lcs (1.2.4)
     git (1.2.5)
-    jeweler (1.6.4)
+    jeweler (1.8.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
-    rake (0.9.2)
-    rcov (0.9.10)
-    rspec (2.3.0)
-      rspec-core (~> 2.3.0)
-      rspec-expectations (~> 2.3.0)
-      rspec-mocks (~> 2.3.0)
-    rspec-core (2.3.1)
-    rspec-expectations (2.3.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.3.0)
-    shoulda (2.11.3)
+      rdoc
+    json (1.7.7)
+    rake (10.0.4)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.0.0)
-  jeweler (~> 1.6.4)
-  rcov
-  rspec (~> 2.3.0)
-  shoulda
+  jeweler (~> 1.8.4)
+  rdoc (~> 3.9)
+  rspec (~> 2.13)

data/README.rdoc

@@ -24,8 +24,16 @@ So full usage may look like this:
    Daemon.daemonize('myscript.pid', 'out.log')
  end
 
+To spawn a daemon process and keep current process runing:
+
+  pid, wait = Daemon.daemonize('myscript.pid', 'out.log') do |log|
+    # daemon code
+  end
+
+  wait.value # wait for daemon to finish; returns Process::Status
+
 == Contributing to daemon
- 
+
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
 * Fork the project

data/Rakefile

@@ -31,22 +31,9 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
 	  spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-	  spec.pattern = 'spec/**/*_spec.rb'
-	    spec.rcov = true
-end
-
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-  test.rcov_opts << '--exclude "gems/*"'
-end
-
 task :default => :spec
 
-require 'rake/rdoctask'
+require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

data/daemon.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "daemon"
-  s.version = "1.1.0"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jakub Pastuszek"]
-  s.date = "2011-09-28"
+  s.date = "2014-09-01"
   s.description = "Make calling script to become a daemon with pid file locking support and stdout/stderr redirection"
   s.email = "jpastuszek@gmail.com"
   s.extra_rdoc_files = [
@@ -32,31 +32,25 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/jpastuszek/daemon"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.10"
+  s.rubygems_version = "1.8.23"
   s.summary = "Daemonize your script with a single line of code"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.13"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.9"])
     else
-      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
-      s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
-      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.13"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<rdoc>, ["~> 3.9"])
     end
   else
-    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
-    s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
-    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.13"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<rdoc>, ["~> 3.9"])
   end
 end
 

data/lib/daemon.rb

@@ -6,35 +6,108 @@ class Daemon
 	end
 
 	def self.daemonize(pid_file, log_file = nil, sync = true)
-		exit if fork
-		Process.setsid # become session leader
-		exit if fork # and exits
-		# now in child
+		if block_given?
+			spawn do |send_ok, send_error|
+				log = begin
+					# try to lock before we kill stdin/out
+					lock(pid_file)
 
-		# try to lock before we kill stdin/out
-		lock(pid_file)
+					# close I/O
+					disconnect(log_file, sync)
+				rescue => error
+					send_error.call(error)
+				end
 
-		if log_file
-			log = File.open(log_file, 'a')
-			log.sync = sync
+				send_ok.call
+
+				yield log
+			end # => pid, wait
 		else
-			log = '/dev/null'
+			# become new process group leader
+			fence
+
+			# try to lock before we kill stdin/out
+			lock(pid_file)
+
+			# close I/O
+			disconnect(log_file, sync) # => log
 		end
+	end
 
-		# disconnect
-		STDIN.reopen '/dev/null'
-		STDOUT.reopen log
-		STDERR.reopen log
+	def self.spawn
+		r, w = IO.pipe
+
+		pid = fence do
+			r.close
+
+			yield(
+				->{
+					w.write Marshal.dump(nil) # send OK to parent
+					w.close
+				},
+				->(error){
+					w.write Marshal.dump(error) # send error to parent
+					w.close
+					exit 42
+				}
+			)
+		end
+		thr = Process.detach(pid)
+
+		w.close
+		data = r.read
+		data.empty? and fail 'ok/error handler not called!'
+
+		if error = Marshal.load(data)
+			thr.join # wait for child to die
+			raise error
+		end
+
+		return pid, thr
+	ensure
+		w.close unless w.closed?
+		r.close
+	end
+
+	def self.fence
+		if block_given?
+			fork do
+				Process.setsid # become new session leader
+				# now in child
+				yield
+			end # => pid
+		else
+			exit! 0 if fork
+			Process.setsid # become new session leader
+			# now in child
+		end
 	end
 
 	def self.lock(pid_file)
 		pf = File.open(pid_file, File::RDWR | File::CREAT)
-		raise LockError, pf unless pf.flock(File::LOCK_EX|File::LOCK_NB)
+		raise LockError, pf unless pf.flock(File::LOCK_EX | File::LOCK_NB)
 		pf.truncate(0)
 		pf.write(Process.pid.to_s + "\n")
 		pf.flush
 
 		@pf = pf # keep it open and locked until process exits
 	end
-end
 
+	def self.disconnect(log_file = nil, sync = true)
+		if log_file
+			log = File.open(log_file, File::WRONLY | File::CREAT | File::APPEND | File::BINARY)
+			log.sync = sync
+		else
+			# don't raise on STDOUT/STDERR write
+			log = File.new('/dev/null', File::WRONLY | File::BINARY)
+		end
+
+		# disconnect
+		STDIN.close # raise IOError on STDIN.read
+		STDOUT.reopen log
+		STDERR.reopen log
+
+		# provide log IO
+		return log
+	end
+end

data/spec/daemon_spec.rb

@@ -1,23 +1,282 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 require 'daemon'
-
-$pf = 'test.pid'
+require 'timeout'
+require 'tempfile'
 
 describe Daemon do
-	it '#lock should create a pid file with current process pid' do
-		Daemon.lock($pf)
-		File.open($pf).read.should == "#{Process.pid}\n"
+	let! :pid_file do
+		Tempfile.new('daemon-pid')
+	end
+
+	let! :log_file do
+		Tempfile.new('daemon-log')
 	end
 
-	it '#lock should raise error if called twice on same pid file' do
-		Daemon.lock($pf)
-		lambda {
-			Daemon.lock($pf)
-		}.should raise_error Daemon::LockError
+	describe 'locking' do
+		it '#lock should create a pid file with current process pid' do
+			Daemon.lock(pid_file)
+			File.open(pid_file).read.should == "#{Process.pid}\n"
+		end
+
+		it '#lock should raise error if called twice on same pid file' do
+			Daemon.lock(pid_file)
+			lambda {
+				Daemon.lock(pid_file)
+			}.should raise_error Daemon::LockError
+		end
 	end
 
-	after :each do
-		File.unlink($pf) if File.exist?($pf)
+	describe 'forking' do
+		it 'forked sub process can be terminated with SIGHUP to whole process group' do
+			cr, cw = *IO.pipe
+			mr, mw = *IO.pipe
+
+			pid = fork do # parent
+				Process.setsid # start new process group
+
+				pid = fork do # child
+					loop{cr.readline and mw.puts 'pong'}
+				end
+				Process.wait(pid)
+			end
+
+			# close our end
+			mw.close
+			cr.close
+
+			# wait for the child to start
+			cw.puts 'ping'
+			mr.readline.strip.should == 'pong'
+
+			Process.kill('HUP', -pid) # kill the group; this should kill the child
+			Process.wait(pid) # parent exit
+
+			expect {
+				Timeout.timeout(2) do
+					# child is dead
+					cw.puts 'ping'
+				end
+			}.to raise_error Errno::EPIPE
+		end
+
+		it '#fence should start new process group to protect the process from HUP signal' do
+			cr, cw = *IO.pipe
+			mr, mw = *IO.pipe
+
+			pid = fork do # parent
+				Process.setsid # start new process group
+
+				Daemon.fence
+
+				# now in protected child
+				loop{cr.readline and mw.puts 'pong'}
+			end
+			Process.wait(pid) # parent exits
+
+			# close our end
+			mw.close
+			cr.close
+
+			# wait for the child to start
+			cw.puts 'ping'
+			mr.readline.strip.should == 'pong'
+
+			expect {
+				Process.kill('HUP', -pid)
+				# the group is gone with the parent process
+			}.to raise_error Errno::ESRCH
+
+			Timeout.timeout(2) do
+				# child still there
+				cw.puts 'ping'
+				mr.readline.strip.should == 'pong'
+			end
+		end
+
+		it '#fence with block should start new process group to protect the process from HUP signal calling provided block within it' do
+			cr, cw = *IO.pipe
+			mr, mw = *IO.pipe
+
+			pid = fork do # parent
+				Process.setsid # start new process group
+
+				pid = Daemon.fence do
+					# now in protected child
+					loop{cr.readline and mw.puts 'pong'}
+				end
+
+				Process.wait(pid)
+			end
+
+			# close our end
+			mw.close
+			cr.close
+
+			# wait for the child to start
+			cw.puts 'ping'
+			mr.readline.strip.should == 'pong'
+
+			Process.kill('HUP', -pid) # kill the group; this would kill the child
+			Process.wait(pid) # parent exit
+
+			Timeout.timeout(2) do
+				# child still there
+				cw.puts 'ping'
+				mr.readline.strip.should == 'pong'
+			end
+		end
+
+		it '#spawn should call block in fenced child process and return child pid and wait thread' do
+			pid, wait = Daemon.spawn do |send_ok, send_error|
+				send_ok.call
+				sleep 0.2
+			end
+
+			pid.should > 0
+			wait.should be_alive
+
+			wait.value.should be_success
+		end
+
+		it '#spawn should call block in fenced child process raising reported errors in master' do
+			expect {
+				Daemon.spawn do |send_ok, send_error|
+					begin
+						fail 'test'
+					rescue => error
+						send_error.call error
+					end
+				end
+			}.to raise_error RuntimeError, 'test'
+		end
+	end
+
+	describe 'IO handling' do
+		it '#disconnect should close STDIN and redirect STDIN and STDERR to given log file' do
+			pid = fork do
+				Daemon.disconnect(log_file)
+
+				puts 'hello world'
+				begin
+					STDIN.read # should raise
+				rescue IOError
+					puts 'foo bar'
+				end
+			end
+			Process.wait(pid)
+
+			log_file.readlines.map(&:strip).should == ['hello world', 'foo bar']
+		end
+
+		it '#disconnect should provide log file IO' do
+			pid = fork do
+				log = Daemon.disconnect(log_file)
+				log.puts 'hello world'
+				puts 'foo bar'
+			end
+			Process.wait(pid)
+
+			log_file.readlines.map(&:strip).should == ['hello world', 'foo bar']
+		end
+
+		it '#disconnect should provide /dev/null file IO when no log file specified' do
+			pid = fork do
+				log = Daemon.disconnect
+				log.puts 'foo bar'
+				log.path.should == '/dev/null'
+			end
+
+			Process.wait2(pid).last.should be_success
+		end
+
+		it '#disconnect should append log file' do
+			pid = fork do
+				Daemon.disconnect(log_file)
+				puts 'hello world'
+			end
+			Process.wait(pid)
+
+			pid = fork do
+				Daemon.disconnect(log_file)
+				puts 'foo bar'
+			end
+
+			Process.wait(pid)
+			log_file.readlines.map(&:strip).should == ['hello world', 'foo bar']
+		end
+	end
+
+	it '#deamonize should terminate current process while keeping the script running' do
+		log_file.open do |log|
+
+			pid = fork do
+				puts master_pid = Process.pid
+				Daemon.daemonize(pid_file, log_file, true)
+				Process.pid.should_not == master_pid
+				puts 'hello world'
+			end
+
+			Process.wait2(pid).last.should be_success # wait for master to go away (successfully)
+
+			log.readline.map(&:strip).should == ['hello world']
+		end
+	end
+
+	it '#deamonize should return log file IO' do
+		log_file.open do |log|
+			pid = fork do
+				log = Daemon.daemonize(pid_file, log_file, true)
+				log.puts 'hello world'
+			end
+			Process.wait2(pid).last.should be_success # wait for master to go away
+
+			log.readline.map(&:strip).should == ['hello world']
+		end
+	end
+
+	it '#daemonize with block should fork new process with pid file and log file and call block with log IO' do
+		pid, wait = Daemon.daemonize(pid_file, log_file) do |log|
+			log.puts 'hello world'
+			puts 'foo bar'
+		end
+
+		# wait for process to finish
+		wait.join
+
+		log_file.readlines.map(&:strip).should == ['hello world', 'foo bar']
+	end
+
+	it '#daemonize with block should raise error when lock file is busy' do
+		pid, wait = Daemon.daemonize(pid_file, log_file) do |log|
+			log.puts 'hello world'
+			puts 'foo bar'
+			sleep 1
+		end
+
+		expect {
+			Daemon.daemonize(pid_file, log_file){|log|}
+		}.to raise_error Daemon::LockError
+
+		Process.kill('TERM', pid)
+		wait.join
+
+		log_file.readlines.map(&:strip).should == ['hello world', 'foo bar']
+	end
+
+	it '#daemnize should not call at_exit handler' do
+		pid = fork do
+			pid = Process.pid
+			at_exit do
+				fail 'at_exit called' if pid != Process.pid
+			end
+
+			fork do
+				Daemon.daemonize(pid_file, '/dev/stdout')
+				exit! # dont call at_exit
+			end
+			Process.wait
+		end
+		Process.wait2(pid).last.should be_success
 	end
 end
 

metadata

@@ -1,108 +1,73 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: daemon
-version: !ruby/object:Gem::Version 
-  hash: 19
+version: !ruby/object:Gem::Version
+  version: 1.2.0
   prerelease: 
-  segments: 
-  - 1
-  - 1
-  - 0
-  version: 1.1.0
 platform: ruby
-authors: 
+authors:
 - Jakub Pastuszek
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-09-28 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  requirement: &id001 !ruby/object:Gem::Requirement 
+date: 2014-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 3
-        - 0
-        version: 2.3.0
-  version_requirements: *id001
-  name: rspec
-  prerelease: false
+      - !ruby/object:Gem::Version
+        version: '2.13'
   type: :development
-- !ruby/object:Gem::Dependency 
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id002
-  name: shoulda
   prerelease: false
-  type: :development
-- !ruby/object:Gem::Dependency 
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
-        version: 1.0.0
-  version_requirements: *id003
-  name: bundler
-  prerelease: false
-  type: :development
-- !ruby/object:Gem::Dependency 
-  requirement: &id004 !ruby/object:Gem::Requirement 
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 1
-        - 6
-        - 4
-        version: 1.6.4
-  version_requirements: *id004
-  name: jeweler
-  prerelease: false
+      - !ruby/object:Gem::Version
+        version: 1.8.4
   type: :development
-- !ruby/object:Gem::Dependency 
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id005
-  name: rcov
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.9'
   type: :development
-description: Make calling script to become a daemon with pid file locking support and stdout/stderr redirection
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.9'
+description: Make calling script to become a daemon with pid file locking support
+  and stdout/stderr redirection
 email: jpastuszek@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE.txt
 - README.rdoc
-files: 
+files:
 - .document
 - Gemfile
 - Gemfile.lock
@@ -115,37 +80,31 @@ files:
 - spec/daemon_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/jpastuszek/daemon
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -3235773960414260177
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Daemonize your script with a single line of code
 test_files: []
-