process-daemon 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad2299e94a6c61f1720944c19525b84c535c597f
-  data.tar.gz: 38aed4cdf9ee795711e7b9507bb1008e7a9940c4
+  metadata.gz: 7db4156d137b48f2986d06e6dfd5f1b5150d8afb
+  data.tar.gz: fec53d11a1bea87a073f68f9829edbfbafc2826c
 SHA512:
-  metadata.gz: e6653cc71627aac7a2ebb0c5bf90c71eda263507d01f6ab5d1a6bd267fdfb866cf84a92e5f9ff13dc50219f2eca3e607843a4e161b9ddfdd87559bb6a3b3c662
-  data.tar.gz: 85831d76b49be8ee9e046e6a4921d72fa4ffd08b80fcee77dfb98652ce710504e9057a42cd645d758ed593ddef389a03de96b9b1c638ef1ba6a4e265be36ecbb
+  metadata.gz: 4e3b5741338cba187cba99156ee755812a8ada36ab4022cda60a870e19f87e2d373942a67567d387d00301e25becb86180cdf05726291a3976a8f320309eb7ee
+  data.tar.gz: da7769da5b93b2edd49541fcdb47615f6e2709765ebe38879ea87459aa899b4ba62be208a9c8c335f6606572b691fbd3ce35ebe8b4326705060c69c4efa8b367

data/lib/process/daemon.rb

@@ -130,30 +130,46 @@ module Process
 			Process.kill(0, :INT)
 		end
 		
-		# Helper methods for static daemon instance
+		def run
+			startup
+			
+			trap("INT") do
+				shutdown
+			end
+		end
 		
+		# A shared instance of the daemon.
 		def self.instance
 			@instance ||= self.new
 		end
 		
-		# Main entry point for command line:
-		def self.daemonize(argv = ARGV)
-			Controller.daemonize(instance, argv)
+		# The process controller, responsible for managing the daemon process start, stop, restart, etc.
+		def self.controller(options = {})
+			@controller ||= Controller.new(instance, options)
+		end
+		
+		# The main entry point for daemonized scripts.
+		def self.daemonize(*args)
+			# Wish Ruby 2.0 kwargs were backported to 1.9.3... oh well:
+			options = (args.last === Hash) ? args.pop : {}
+			argv = (args.last === Array) ? args.pop : ARGV
+			
+			controller(options).daemonize(argv)
 		end
 		
-		# Start the daemon instance:
+		# Start the daemon instance.
 		def self.start
-			Controller.start(instance)
+			controller.start
 		end
 		
-		# Stop the daemon instance:
+		# Stop the daemon instance.
 		def self.stop
-			Controller.stop(instance)
+			controller.stop
 		end
 		
-		# Get the status of the daemon instance, `:stopped`, `:running` or `:unknown`.
+		# Check if the daemon is runnning or not.
 		def self.status
-			ProcessFile.status(instance)
+			controller.status
 		end
 	end
 end

data/lib/process/daemon/controller.rb

@@ -25,75 +25,63 @@ module Process
 		# Daemon startup timeout
 		TIMEOUT = 5
 
-		# This module contains functionality related to starting and stopping the daemon, and code for processing command line input.
-		module Controller
+		# This module contains functionality related to starting and stopping the @daemon, and code for processing command line input.
+		class Controller
+			# `options[:output]` specifies where to write textual output describing what is going on.
+			def initialize(daemon, options = {})
+				@daemon = daemon
+				
+				@output = options[:output] || $stdout
+			end
+			
 			# This function is called from the daemon executable. It processes ARGV and checks whether the user is asking for `start`, `stop`, `restart`, `status`.
-			def self.daemonize(daemon, argv = ARGV)
+			def daemonize(argv = ARGV)
 				case argv.shift.to_sym
 				when :start
-					start(daemon)
-					status(daemon)
+					start
+					status
 				when :stop
-					stop(daemon)
-					status(daemon)
-					ProcessFile.cleanup(daemon)
+					stop
+					status
+					ProcessFile.cleanup(@daemon)
 				when :restart
-					stop(daemon)
-					ProcessFile.cleanup(daemon)
-					start(daemon)
-					status(daemon)
+					stop
+					ProcessFile.cleanup(@daemon)
+					start
+					status
 				when :status
-					status(daemon)
+					status
 				else
-					puts "Invalid command. Please specify start, restart, stop or status."
-					exit 1
+					@stderr.puts Rainbow("Invalid command. Please specify start, restart, stop or status.").red
 				end
 			end
-
-			# This function starts the supplied daemon
-			def self.start(daemon)
-				puts Rainbow("Starting daemon...").color(:blue)
-
-				case ProcessFile.status(daemon)
-				when :running
-					$stderr.puts Rainbow("Daemon already running!").color(:blue)
-					return
-				when :stopped
-					# We are good to go...
-				else
-					$stderr.puts Rainbow("Daemon in unknown state! Will clear previous state and continue.").color(:red)
-					status(daemon)
-					ProcessFile.clear(daemon)
-				end
-
-				daemon.prefork
-				daemon.mark_log
+			
+			# Fork a child process, detatch it and run the daemon code.
+			def spawn
+				@daemon.prefork
+				@daemon.mark_log
 
 				fork do
 					Process.setsid
 					exit if fork
 
-					ProcessFile.store(daemon, Process.pid)
+					ProcessFile.store(@daemon, Process.pid)
 
 					File.umask 0000
-					Dir.chdir daemon.working_directory
+					Dir.chdir @daemon.working_directory
 
 					$stdin.reopen "/dev/null"
-					$stdout.reopen daemon.log_file_path, "a"
+					$stdout.reopen @daemon.log_file_path, "a"
 					$stdout.sync = true
-					
+				
 					$stderr.reopen $stdout
 					$stderr.sync = true
 
 					begin
-						daemon.startup
-						
-						trap("INT") do
-							daemon.shutdown
-						end
-					rescue
+						@daemon.run
+					rescue Exception => error
 						$stderr.puts "=== Daemon Exception Backtrace @ #{Time.now.to_s} ==="
-						$stderr.puts "#{$!.class}: #{$!.message}"
+						$stderr.puts "#{error.class}: #{error.message}"
 						$!.backtrace.each { |at| $stderr.puts at }
 						$stderr.puts "=== Daemon Crashed ==="
 						$stderr.flush
@@ -102,63 +90,84 @@ module Process
 						$stderr.flush
 					end
 				end
+			end
+
+			# This function starts the daemon process in the background.
+			def start
+				@output.puts Rainbow("Starting daemon...").blue
+
+				case ProcessFile.status(@daemon)
+				when :running
+					@output.puts Rainbow("Daemon already running!").blue
+					return
+				when :stopped
+					# We are good to go...
+				else
+					@output.puts Rainbow("Daemon in unknown state! Will clear previous state and continue.").red
+					ProcessFile.clear(@daemon)
+				end
+
+				spawn
 
-				puts Rainbow("Waiting for daemon to start...").color(:blue)
 				sleep 0.1
 				timer = TIMEOUT
-				pid = ProcessFile.recall(daemon)
+				pid = ProcessFile.recall(@daemon)
 
 				while pid == nil and timer > 0
 					# Wait a moment for the forking to finish...
-					puts Rainbow("Waiting for daemon to start (#{timer}/#{TIMEOUT})").color(:blue)
+					@output.puts Rainbow("Waiting for daemon to start (#{timer}/#{TIMEOUT})").blue
 					sleep 1
 
-					# If the daemon has crashed, it is never going to start...
-					break if daemon.crashed?
+					# If the @daemon has crashed, it is never going to start...
+					break if @daemon.crashed?
 
-					pid = ProcessFile.recall(daemon)
+					pid = ProcessFile.recall(@daemon)
 
 					timer -= 1
 				end
 			end
-
+			
 			# Prints out the status of the daemon
-			def self.status(daemon)
-				case ProcessFile.status(daemon)
+			def status
+				daemon_state = ProcessFile.status(@daemon)
+				
+				case daemon_state
 				when :running
-					puts Rainbow("Daemon status: running pid=#{ProcessFile.recall(daemon)}").color(:green)
+					@output.puts Rainbow("Daemon status: running pid=#{ProcessFile.recall(@daemon)}").green
 				when :unknown
-					if daemon.crashed?
-						puts Rainbow("Daemon status: crashed").color(:red)
+					if @daemon.crashed?
+						@output.puts Rainbow("Daemon status: crashed").red
 
-						$stdout.flush
-						$stderr.puts Rainbow("Dumping daemon crash log:").color(:red)
-						daemon.tail_log($stderr)
+						@output.flush
+						@output.puts Rainbow("Dumping daemon crash log:").red
+						@daemon.tail_log(@output)
 					else
-						puts Rainbow("Daemon status: unknown").color(:red)
+						@output.puts Rainbow("Daemon status: unknown").red
 					end
 				when :stopped
-					puts Rainbow("Daemon status: stopped").color(:blue)
+					@output.puts Rainbow("Daemon status: stopped").blue
 				end
+				
+				return daemon_state
 			end
 
 			# Stops the daemon process.
-			def self.stop(daemon)
-				puts Rainbow("Stopping daemon...").color(:blue)
+			def stop
+				@output.puts Rainbow("Stopping daemon...").blue
 
 				# Check if the pid file exists...
-				unless File.file?(daemon.process_file_path)
-					puts Rainbow("Pid file not found. Is the daemon running?").color(:red)
+				unless File.file?(@daemon.process_file_path)
+					@output.puts Rainbow("Pid file not found. Is the daemon running?").red
 					return
 				end
 
-				pid = ProcessFile.recall(daemon)
+				pid = ProcessFile.recall(@daemon)
 
-				# Check if the daemon is already stopped...
-				unless ProcessFile.running(daemon)
-					puts Rainbow("Pid #{pid} is not running. Has daemon crashed?").color(:red)
+				# Check if the @daemon is already stopped...
+				unless ProcessFile.running(@daemon)
+					@output.puts Rainbow("Pid #{pid} is not running. Has daemon crashed?").red
 
-					daemon.tail_log($stderr)
+					@daemon.tail_log($stderr)
 
 					return
 				end
@@ -168,29 +177,29 @@ module Process
 				Process.kill("INT", pgid)
 				sleep 0.1
 
-				sleep 1 if ProcessFile.running(daemon)
+				sleep 1 if ProcessFile.running(@daemon)
 
-				# Kill/Term loop - if the daemon didn't die easily, shoot
+				# Kill/Term loop - if the @daemon didn't die easily, shoot
 				# it a few more times.
 				attempts = 5
-				while ProcessFile.running(daemon) and attempts > 0
+				while ProcessFile.running(@daemon) and attempts > 0
 					sig = (attempts >= 2) ? "KILL" : "TERM"
 
-					puts Rainbow("Sending #{sig} to process group #{pgid}...").color(:red)
+					@output.puts Rainbow("Sending #{sig} to process group #{pgid}...").red
 					Process.kill(sig, pgid)
 
 					attempts -= 1
 					sleep 1
 				end
 
-				# If after doing our best the daemon is still running (pretty odd)...
-				if ProcessFile.running(daemon)
-					puts Rainbow("Daemon appears to be still running!").color(:red)
+				# If after doing our best the @daemon is still running (pretty odd)...
+				if ProcessFile.running(@daemon)
+					@output.puts Rainbow("Daemon appears to be still running!").red
 					return
 				end
 
-				# Otherwise the daemon has been stopped.
-				ProcessFile.clear(daemon)
+				# Otherwise the @daemon has been stopped.
+				ProcessFile.clear(@daemon)
 			end
 		end
 	end

data/lib/process/daemon/priviledges.rb

@@ -25,10 +25,6 @@ module Process
 		module Priviledges
 			# Set the user of the current process. Supply either a user ID
 			# or a user name.
-			#
-			# Be aware that on Mac OS X / Ruby 1.8 there are bugs when the user id
-			# is negative (i.e. it doesn't work). For example "nobody" with uid -2
-			# won't work.
 			def self.change_user(user)
 				if user.kind_of?(String)
 					user = Etc.getpwnam(user).uid

data/lib/process/daemon/version.rb

@@ -20,6 +20,6 @@
 
 module Process
 	class Daemon
-		VERSION = "0.3.0"
+		VERSION = "0.5.0"
 	end
 end

data/process-daemon.gemspec

@@ -16,9 +16,11 @@ Gem::Specification.new do |spec|
 	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
 	spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
 	spec.require_paths = ["lib"]
-
+	
+	spec.required_ruby_version = '>= 1.9.3'
+	
 	spec.add_dependency "rainbow", "~> 2.0"
-
+	
 	spec.add_development_dependency "bundler", "~> 1.3"
 	spec.add_development_dependency "minitest", "~> 5.3.2"
 	spec.add_development_dependency "rake"

data/test/test_daemon.rb

@@ -106,4 +106,24 @@ class DaemonTest < MiniTest::Test
 	def test_instances
 		refute_equal SleepDaemon.instance, XMLRPCDaemon.instance
 	end
+	
+	def test_output
+		output = StringIO.new
+		
+		controller = Process::Daemon::Controller.new(XMLRPCDaemon.instance, :output => output)
+		
+		assert_equal :running, controller.status
+		
+		assert_match /Daemon status: running pid=\d+/, output.string
+		
+		output.rewind
+		controller.stop
+		
+		assert_match /Stopping daemon/, output.string
+		
+		output.rewind
+		controller.start
+		
+		assert_match /Starting daemon/, output.string
+	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: process-daemon
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-11 00:00:00.000000000 Z
+date: 2014-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -99,7 +99,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='