process-daemon 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f2719836b2dfefcb18754e6157764c3f964d667
-  data.tar.gz: 696fd41006946dd13a6a04eaabef60e5f35c8925
+  metadata.gz: c61cccea3d2c60a71ac3a57248e041a6474d1fc8
+  data.tar.gz: 547c4355486f24c30eeb00c4aed3c633d0290656
 SHA512:
-  metadata.gz: 4a2c171b1f7007a6c69e198ee47b56409c870a6c6fe525b6d0b75f75529ea8a4cc802bf22aaad27751f0ec7e631c6ea2221be4ad83e64b4ffe4fe84b1554aeb5
-  data.tar.gz: 37b32a1adec863f0b34451b11e1dec6ddaed83e0c568be6f72d4171e5b878a7c873814353f19273ad901e63933381ee2a4699c340b18735742da40432bec4d2c
+  metadata.gz: c984adf509aa62ba982fccb52dea7f692b44b9300a38f79d4ce4c8225185e66b113ad723634aea8084a749cb8900ed3e3b30c567b381113dc1167e1adcc4af21
+  data.tar.gz: 195aff6013ab3a1b61d7865cf8292caafa05e797a1f01b9d8d4db8fdb4b0735d92d7f067217e70a0c79f2e194fcb9fe71b4959fafd84ba6d477f00867d16fe73

data/README.md

@@ -32,11 +32,12 @@ A process daemon has a specific structure:
 		end
 		
 		def run
-			# Do the actual work. Does not need to be implemented, e.g. if using threads or other background processing mechanisms.
+			# Do the actual work. Does not need to be implemented, e.g. if using threads or other background processing mechanisms which were kicked off in #startup.
 		end
 		
 		def shutdown
-			# Stop everything that was setup in startup.
+			# Stop everything that was setup in startup. Called as part of main daemon thread/process, not in trap context (e.g. SIGINT).
+			# Asynchronous code can call self.request_shutdown from a trap context to interrupt the main process, provided you aren't doing work in #run.
 		end
 	end
 	
@@ -57,6 +58,8 @@ After calling `prefork`, the working directory is expanded to a full path and sh
 
 ### WEBRick Server
 
+Some servers must run on the main process thread. In this case, the normal interrupt mechanism won't be used and we will handle signals directly.
+
 Create a file for your daemon, e.g. `daemon.rb`:
 
 	#!/usr/bin/env ruby

data/lib/process/daemon/controller.rb

@@ -188,8 +188,12 @@ module Process
 				end
 
 				pgid = -Process.getpgid(pid)
-
+				
+				# Stop by interrupt sends a single interrupt and waits for the process to terminate:
 				unless stop_by_interrupt(pgid)
+					# If the process is still running, we try sending SIGTERM followed by SIGKILL:
+					@output.puts Rainbow("** Daemon did not stop gracefully after #{@stop_timeout}s **").red
+					
 					stop_by_terminate_or_kill(pgid)
 				end
 
@@ -207,6 +211,7 @@ module Process
 			
 			private
 			
+			# Returns true if the process was stopped.
 			def stop_by_interrupt(pgid)
 				running = true
 				
@@ -219,7 +224,7 @@ module Process
 					end
 				end
 				
-				return running
+				return !running
 			end
 			
 			def stop_by_terminate_or_kill(pgid)

data/lib/process/daemon/listen.rb

@@ -0,0 +1,85 @@
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+module Process
+	class Daemon
+		# Access incoming file descriptors from daemons started by systemd.
+		class Listen
+			LISTEN_PID = 'LISTEN_PID'
+			LISTEN_FDS = 'LISTEN_FDS'
+			LISTEN_FDNAMES = 'LISTEN_FDNAMES'
+			
+			FD_START = 3
+			SEPERATOR = ':'
+			
+			def self.set_close_at_exec(fd)
+				fd.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC) if defined? Fcntl::F_SETFD
+			end
+			
+			def self.open(fd)
+				set_close_at_exec(fd)
+				
+				return IO.for_fd(fd)
+			end
+			
+			# Returns a Array or Hash of file descriptors. If LISTEN_FDNAMES is set, a Hash is returned which includes key => value pairs for named file descriptors.
+			def self.file_descriptors(env = ENV)
+				pid, fds, names = env.values_at(LISTEN_PID, LISTEN_FDS, LISTEN_FDNAMES)
+				
+				# Are the PIDs valid for this process?
+				unless pid and Integer(pid) == Process.pid
+					return nil
+				end
+				
+				files = Integer(fds).times.collect do |i|
+					self.open(FD_START + i)
+				end
+				
+				if names
+					names = names.split(SEPARATOR, -1)
+				end
+				
+				self.new(files, names)
+			end
+			
+			def initialize(files, names)
+				@files = files
+				@names = names
+				
+				@named = {}
+				@unnamed = []
+				
+				@names.each_with_index do |name, index|
+					if name
+						@named[name] = @files[index]
+					else
+						@unnamed << @files[index]
+					end
+				end
+			end
+			
+			attr :files
+			attr :names
+			
+			attr :named
+			attr :unnamed
+		end
+	end
+end

data/lib/process/daemon/version.rb

@@ -20,6 +20,6 @@
 
 module Process
 	class Daemon
-		VERSION = "1.0.0"
+		VERSION = "1.0.1"
 	end
 end

data/spec/process/daemon/process_file_spec.rb

@@ -26,10 +26,6 @@ module Process::Daemon::ProcessFileSpec
 		def working_directory
 			File.expand_path("../tmp", __FILE__)
 		end
-
-		def startup
-			sleep 1 while true
-		end
 	end
 
 	describe Process::Daemon::ProcessFile do

data/spec/process/daemon/terminate_spec.rb

@@ -0,0 +1,71 @@
+# Copyright, 2014, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'process/daemon'
+require 'process/daemon/process_file'
+
+module Process::Daemon::TerminateSpec
+	class SleepDaemon < Process::Daemon
+		def working_directory
+			File.expand_path("../tmp", __FILE__)
+		end
+
+		def startup
+			setup_signals
+		end
+		
+		def setup_signals
+			trap('INT') do
+				puts 'INT'
+			end
+			
+			trap('TERM') do
+				puts 'TERM'
+			end
+		end
+
+		def run
+			sleep 1 while true
+		end
+	end
+
+	describe Process::Daemon do
+		let(:daemon) {SleepDaemon.instance}
+		let(:controller) {Process::Daemon::Controller.new(daemon)}
+		
+		# Print out the daemon log file:
+		#after(:each) do
+		#	system('cat', daemon.log_file_path)
+		#end
+		
+		it "should be killed" do
+			controller.start
+			
+			expect(controller.status).to be == :running
+			
+			controller.stop
+			
+			expect(controller.status).to be == :stopped
+			
+			output = File.readlines(daemon.log_file_path).last(6)
+			expect(output).to be == ["INT\n", "TERM\n", "TERM\n", "TERM\n", "TERM\n", "TERM\n"]
+		end
+	end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: process-daemon
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-03 00:00:00.000000000 Z
+date: 2016-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -82,6 +82,7 @@ files:
 - Rakefile
 - lib/process/daemon.rb
 - lib/process/daemon/controller.rb
+- lib/process/daemon/listen.rb
 - lib/process/daemon/log_file.rb
 - lib/process/daemon/notification.rb
 - lib/process/daemon/privileges.rb
@@ -96,6 +97,7 @@ files:
 - spec/process/daemon/notification_spec.rb
 - spec/process/daemon/privileges_spec.rb
 - spec/process/daemon/process_file_spec.rb
+- spec/process/daemon/terminate_spec.rb
 homepage: https://github.com/ioquatix/process-daemon
 licenses:
 - MIT
@@ -130,3 +132,4 @@ test_files:
 - spec/process/daemon/notification_spec.rb
 - spec/process/daemon/privileges_spec.rb
 - spec/process/daemon/process_file_spec.rb
+- spec/process/daemon/terminate_spec.rb