daemon_controller 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd4f2d08b82c7340e6b00c8a97e63f66a6677fbc28e9b705ecb6c53d75701e00
-  data.tar.gz: 11bc6d68d7837db49c123b5e2b08fc932bf60c1b0c29742e7e891e66d8f4f82a
+  metadata.gz: a1f6789411c7ea7ff1a641d74b0495b9d8e434d7ea5beaa4abbeade3e0cf2c33
+  data.tar.gz: 47ea5871588be9702620cd1487c2c05a5d314d70ff6e1a9df58456d3c6c1be53
 SHA512:
-  metadata.gz: c29f7ea6b92d607774bef4f42dba2e03215f85078079fb3febd404cf87efff8f0536e03ba870234c72925f7404142dba2bf73217d7586175328d6611ba72e3d8
-  data.tar.gz: 1b5d67e7165fb4c2ba1c667c774e089a5a5029e57ba47dd1f91cbcd17e2dcdef7136947b0d115d71b7db9c154013043f9da01428d55659898eee198bd1ca3d3a
+  metadata.gz: bcecb7cd5d60e2a565e96d104085f2d09262336a1c3afcd583acff5d27f988bd617bb326aa0b5447d284e61cfd93d8ea8c42cf3d44ae918322b4167b17182681
+  data.tar.gz: 6fa2da44033e92a77a47ff0fdde71683e271f4115ddd7a5c5d2ef4a0904bcb65111f211564598ee7594ef97fe9b075918bfa3b76a4532f6fac131971d068448a

data/Rakefile

@@ -8,15 +8,13 @@ task :test do
   ruby "-S rspec spec/*_spec.rb"
 end
 
-desc "Build & upload gem"
-task "package:release" do
-  sh "git tag -s release-#{PACKAGE_VERSION}"
-  sh "gem build #{PACKAGE_NAME}.gemspec"
-  puts "Proceed with pushing tag to Github and uploading the gem? [y/n]"
-  if $stdin.readline == "y\n"
-    sh "git push origin release-#{PACKAGE_VERSION}"
-    sh "gem push #{PACKAGE_NAME}-#{PACKAGE_VERSION}.gem"
-  else
-    puts "Did not upload the gem."
-  end
+desc "Build gem"
+task :gem do
+  mkdir_p "pkg"
+  sh "gem build daemon_controller.gemspec -o pkg/#{PACKAGE_NAME}-#{PACKAGE_VERSION}.gem"
+end
+
+desc "Build release artifacts"
+task release: :gem do
+  sh "gem push pkg/#{PACKAGE_NAME}-#{PACKAGE_VERSION}.gem"
 end

data/lib/daemon_controller/version.rb

@@ -24,6 +24,6 @@
 class DaemonController
   MAJOR = 3
   MINOR = 0
-  TINY = 0
+  TINY = 1
   VERSION_STRING = "#{MAJOR}.#{MINOR}.#{TINY}"
 end # class DaemonController

data/lib/daemon_controller.rb

@@ -74,7 +74,7 @@ class DaemonController
     lock_file: nil, stop_command: nil, restart_command: nil, before_start: nil,
     start_timeout: 30, start_abort_timeout: 10, stop_timeout: 30,
     log_file_activity_timeout: 10, ping_interval: 0.1, stop_graceful_signal: "TERM", dont_stop_if_pid_file_invalid: false,
-    daemonize_for_me: false, keep_ios: nil, env: nil, logger: nil)
+    daemonize_for_me: false, keep_ios: nil, env: {}, logger: nil)
     @identifier = identifier
     @start_command = start_command
     @ping_command = ping_command
@@ -140,7 +140,7 @@ class DaemonController
     end
     if connection.nil?
       @lock_file.exclusive_lock do
-        if !daemon_is_running?
+        unless daemon_is_running?
           start_without_locking
         end
         connect_exception = nil
@@ -335,9 +335,7 @@ class DaemonController
 
   def kill_daemon
     if @stop_command
-      if @dont_stop_if_pid_file_invalid && read_pid_file.nil?
-        return
-      end
+      return if @dont_stop_if_pid_file_invalid && read_pid_file.nil?
 
       result = run_command(@stop_command)
       case result
@@ -356,8 +354,7 @@ class DaemonController
   end
 
   def kill_daemon_with_signal(force: false)
-    pid = read_pid_file
-    if pid
+    if (pid = read_pid_file)
       if force
         Process.kill("SIGKILL", pid)
       else
@@ -380,14 +377,11 @@ class DaemonController
   end
 
   def read_pid_file
-    begin
-      pid = File.read(@pid_file).strip
-    rescue Errno::ENOENT
-      return nil
-    end
+    pid = File.read(@pid_file).strip
     if /\A\d+\Z/.match?(pid)
       pid.to_i
     end
+  rescue Errno::ENOENT
   end
 
   def delete_pid_file
@@ -438,7 +432,7 @@ class DaemonController
   end
 
   def pid_file_available?
-    File.exist?(@pid_file) && File.stat(@pid_file).size != 0
+    File.exist?(@pid_file) && !File.zero?(@pid_file)
   end
 
   # This method does nothing and only serves as a hook for the unit test.
@@ -464,27 +458,7 @@ class DaemonController
     begin
       timeoutable(@start_abort_timeout) do
         allow_timeout do
-          if is_direct_child
-            begin
-              debug "Waiting directly for process #{pid}"
-              Process.waitpid(pid)
-            rescue SystemCallError
-            end
-
-            # The daemon may have:
-            # 1. Written a PID file before forking. We delete this PID file.
-            #    -OR-
-            # 2. It might have forked (and written a PID file) right before
-            #    we terminated it. We'll want the fork to stay alive rather
-            #    than going through the (complicated) trouble of killing it.
-            #    Don't touch the PID file.
-            pid2 = read_pid_file
-            debug "PID file contains #{pid2.inspect}"
-            delete_pid_file if pid == pid2
-          else
-            debug "Waiting until daemon is no longer running"
-            wait_until { !daemon_is_running? }
-          end
+          wait_for_aborted_process(pid:, is_direct_child:)
         end
       end
     rescue Timeout::Error
@@ -494,28 +468,32 @@ class DaemonController
       end
 
       allow_timeout do
-        if is_direct_child
-          begin
-            debug "Waiting directly for process #{pid}"
-            Process.waitpid(pid)
-          rescue SystemCallError
-          end
+        wait_for_aborted_process(pid:, is_direct_child:)
+      end
+    end
+  end
 
-          # The daemon may have:
-          # 1. Written a PID file before forking. We delete this PID file.
-          #    -OR-
-          # 2. It might have forked (and written a PID file) right before
-          #    we terminated it. We'll want the fork to stay alive rather
-          #    than going through the (complicated) trouble of killing it.
-          #    Don't touch the PID file.
-          pid2 = read_pid_file
-          debug "PID file contains #{pid2.inspect}"
-          delete_pid_file if pid == pid2
-        else
-          debug "Waiting until daemon is no longer running"
-          wait_until { !daemon_is_running? }
-        end
+  def wait_for_aborted_process(pid:, is_direct_child:)
+    if is_direct_child
+      begin
+        debug "Waiting directly for process #{pid}"
+        Process.waitpid(pid)
+      rescue SystemCallError
       end
+
+      # The daemon may have:
+      # 1. Written a PID file before forking. We delete this PID file.
+      #    -OR-
+      # 2. It might have forked (and written a PID file) right before
+      #    we terminated it. We'll want the fork to stay alive rather
+      #    than going through the (complicated) trouble of killing it.
+      #    Don't touch the PID file.
+      pid2 = read_pid_file
+      debug "PID file contains #{pid2.inspect}"
+      delete_pid_file if pid == pid2
+    else
+      debug "Waiting until daemon is no longer running"
+      wait_until { !daemon_is_running? }
     end
   end
 
@@ -598,10 +576,10 @@ class DaemonController
     end
 
     pid = if @daemonize_for_me
-      Process.spawn(@env || {}, ruby_interpreter, SPAWNER_FILE,
+      Process.spawn(@env, ruby_interpreter, SPAWNER_FILE,
         command, spawn_options)
     else
-      Process.spawn(@env || {}, command, spawn_options)
+      Process.spawn(@env, command, spawn_options)
     end
 
     # run_command might be running in a timeout block (like
@@ -615,9 +593,9 @@ class DaemonController
       # it started successfully; if it didn't we'll know
       # that later by checking the PID file and by pinging
       # it.
-      return InternalCommandOkResult.new(pid, tempfile_path ? File.read(tempfile_path).strip : nil)
+      return InternalCommandOkResult.new(pid, tempfile_path && File.read(tempfile_path).strip)
     rescue Timeout::Error
-      return InternalCommandTimeoutResult.new(pid, tempfile_path ? File.read(tempfile_path).strip : nil)
+      return InternalCommandTimeoutResult.new(pid, tempfile_path && File.read(tempfile_path).strip)
     end
 
     child_status = $?
@@ -629,7 +607,7 @@ class DaemonController
     end
   ensure
     begin
-      File.unlink(tempfile_path) if tempfile_path
+      tempfile.unlink if tempfile
     rescue SystemCallError
       nil
     end
@@ -706,43 +684,7 @@ class DaemonController
     end
   end
 
-  if !can_ping_unix_sockets?
-    require "java"
-
-    def ping_socket(host_name, port)
-      channel = java.nio.channels.SocketChannel.open
-      begin
-        address = java.net.InetSocketAddress.new(host_name, port)
-        channel.configure_blocking(false)
-        if channel.connect(address)
-          return true
-        end
-
-        deadline = Time.now.to_f + 0.1
-        while true
-          begin
-            if channel.finish_connect
-              return true
-            end
-          rescue java.net.ConnectException => e
-            if /Connection refused/i.match?(e.message)
-              return false
-            else
-              throw e
-            end
-          end
-
-          # Not done connecting and no error.
-          sleep 0.01
-          if Time.now.to_f >= deadline
-            return false
-          end
-        end
-      ensure
-        channel.close
-      end
-    end
-  else
+  if can_ping_unix_sockets?
     def ping_socket(socket_domain, sockaddr)
       socket = Socket.new(socket_domain, Socket::Constants::SOCK_STREAM, 0)
       begin
@@ -775,18 +717,43 @@ class DaemonController
     rescue Errno::EAFNOSUPPORT
       ping_socket(Socket::Constants::AF_INET6, sockaddr)
     end
+  else
+    require "java"
+
+    def ping_socket(host_name, port)
+      channel = java.nio.channels.SocketChannel.open
+      begin
+        address = java.net.InetSocketAddress.new(host_name, port)
+        channel.configure_blocking(false)
+        return true if channel.connect(address)
+
+        deadline = Time.now.to_f + 0.1
+        loop do
+          begin
+            return true if channel.finish_connect
+          rescue java.net.ConnectException => e
+            if /Connection refused/i.match?(e.message)
+              return false
+            else
+              throw e
+            end
+          end
+
+          # Not done connecting and no error.
+          sleep 0.01
+          return false if Time.now.to_f >= deadline
+        end
+      ensure
+        channel.close
+      end
+    end
   end
 
   def ruby_interpreter
-    rb_config = if defined?(RbConfig)
-      RbConfig::CONFIG
-    else
-      Config::CONFIG
-    end
     File.join(
-      rb_config["bindir"],
-      rb_config["RUBY_INSTALL_NAME"]
-    ) + rb_config["EXEEXT"]
+      RbConfig::CONFIG["bindir"],
+      RbConfig::CONFIG.values_at("RUBY_INSTALL_NAME", "EXEEXT").join
+    )
   end
 
   def timeoutable(amount, &block)
@@ -818,7 +785,7 @@ class DaemonController
   end
 
   def signal_name_for(num)
-    if (name = Signal.list.find { |name, n| n == num }[0])
+    if (name = Signal.list.key(num))
       "SIG#{name}"
     else
       num.to_s
@@ -826,30 +793,27 @@ class DaemonController
   end
 
   def concat_spawn_output_and_logs(output, logs, exit_status = nil, suffix_message = nil)
-    if output.nil? && logs.nil?
-      result_inner = [
-        "logs not available",
+    format_full_suffix_message = lambda do |main_message = nil|
+      [
+        main_message,
         exit_status ? signal_termination_message(exit_status) : nil,
         suffix_message
       ].compact.join("; ")
-      "(#{result_inner})"
+    end
+
+    if output.nil? && logs.nil?
+      "(#{format_full_suffix_message.call("logs not available")})"
     elsif (output && output.empty? && logs && logs.empty?) || (output && output.empty? && logs.nil?) || (output.nil? && logs && logs.empty?)
-      result_inner = [
-        "logs empty",
-        exit_status ? signal_termination_message(exit_status) : nil,
-        suffix_message
-      ].compact.join("; ")
-      "(#{result_inner})"
+      "(#{format_full_suffix_message.call("logs empty")})"
     else
-      result = ((output || "") + "\n" + (logs || "")).strip
-      result_suffix = [
-        exit_status ? signal_termination_message(exit_status) : nil,
-        suffix_message
-      ].compact.join("; ")
-      if !result_suffix.empty?
-        result << "\n(#{result_suffix})"
+      full_suffix_message = format_full_suffix_message.call
+      if full_suffix_message.empty?
+        "#{output}\n#{logs}".strip
+      elsif logs && logs.empty?
+        "#{output}\n(#{full_suffix_message})".strip
+      else
+        "#{output}\n#{logs}\n(#{full_suffix_message})".strip
       end
-      result
     end
   end
 

data/spec/test_helper.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "shellwords"
+require "logger"
 
 root = File.absolute_path(File.join(File.dirname(__FILE__), ".."))
 Dir.chdir(root)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: daemon_controller
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Hongli Lai
 bindir: bin
 cert_chain: []
-date: 2025-04-08 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: A library for robust daemon management.
 email: software-signing@phusion.nl
@@ -46,7 +46,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A library for implementing daemon management capabilities
 test_files: []