daemons 1.2.6 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fc83cd9641e813a84137af3a5ee5a0ce14ae8b3f
-  data.tar.gz: 6ff0dedb0c407a49ab2b3037fe7aeba50c161ee4
+SHA256:
+  metadata.gz: cb08e3c11dd04ba70fdfa9a27e41d004839a48318b77bf7edb5e93976de129f7
+  data.tar.gz: 683d0ed93f6a41378a3ed585035b773f4008a147542ab6f29281374aa746ccf9
 SHA512:
-  metadata.gz: e712b26c9135ec38e02d4283ae52cfdf2b13f22c7168d66e66563223e34653f1603232e6e2dc65c1a5f39df8411f59fd9a1e6be106ae878456a4ef6d314d5eed
-  data.tar.gz: 8ba557b1f944a37544079bac30b25a86395c8e74366eca728ef9e245f12c1d2483a9ee777f715390c6975c45f6fb522162e69a95fc2d2b945ee512814f7d3047
+  metadata.gz: 9a8743b8307c977149bcfbb1d6b6b36897a1c750ef63a25f7225d7b1774eaffd128843a1d92d626c3062ff680066831214eed8dc3523216b61f15b355701f4d5
+  data.tar.gz: de074de7aa4ba81a507d9b06f900c2eb044628ceb3a02b5cf4abb717dfdbf6df52c56f709caa85b223d8a18b9da2c0057017074089832412a231499ef050dcde

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2005-2017 Thomas Uehlinger, 2014-2016 Aaron Stone
+Copyright (c) 2005-2021 Thomas Uehlinger, 2014-2016 Aaron Stone
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/README.md

@@ -1,5 +1,5 @@
-Ruby Daemons
-============
+# Ruby Daemons
+
 [![Build Status](https://travis-ci.org/thuehlinger/daemons.svg?branch=master)](https://travis-ci.org/thuehlinger/daemons)[![Code Climate](https://codeclimate.com/github/acuppy/daemons/badges/gpa.svg)](https://codeclimate.com/github/acuppy/daemons)[![Test Coverage](https://circleci.com/gh/acuppy/daemons.svg?style=shield&circle-token=a4f96fd41f7682661d6543e30207427ac8870c0d)](https://circleci.com/gh/acuppy/daemons)
 
 Daemons provides an easy way to wrap existing ruby scripts (for example a self-written server)
@@ -12,8 +12,7 @@ Besides this basic functionality, daemons offers many advanced features like _ex
 and logging (in case your ruby script crashes) and _monitoring_ and automatic restarting of your processes
 if they crash.
 
-Basic Usage
------------
+## Basic Usage
 
 You can use Daemons in four different ways:
 
@@ -45,7 +44,7 @@ Daemons.run('myserver.rb')
 
 And use it like this from the console:
 
-``` ruby
+``` sh
 $ ruby myserver_control.rb start
     (myserver.rb is now running in the background)
 $ ruby myserver_control.rb restart
@@ -55,18 +54,17 @@ $ ruby myserver_control.rb stop
 
 For testing purposes you can even run `myserver.rb` _without forking_ in the background:
 
-``` ruby
+``` sh
 $ ruby myserver_control.rb run
 ```
 
 An additional nice feature of Daemons is that you can pass _additional arguments_ to the script that
 should be daemonized by seperating them by two _hyphens_:
 
-``` ruby
+``` sh
 $ ruby myserver_control.rb start -- --file=anyfile --a_switch another_argument
 ```
 
-
 ### 2. Create wrapper scripts that include your server procs
 
 Layout: suppose you have some code you want to run in the background and control that background process
@@ -96,7 +94,7 @@ end
 
 And use it like this from the console:
 
-``` ruby
+``` sh
 $ ruby myproc_control.rb start
     (myproc.rb is now running in the background)
 $ ruby myproc_control.rb restart
@@ -106,7 +104,7 @@ $ ruby myproc_control.rb stop
 
 For testing purposes you can even run `myproc.rb` _without forking_ in the background:
 
-``` ruby
+``` sh
 $ ruby myproc_control.rb run
 ```
 
@@ -169,13 +167,12 @@ end
 
 For further documentation, refer to the module documentation of Daemons.
 
-Displaying daemon status
-------------------------
+## Displaying daemon status
 
 When daemonizing a process using a wrapper script, as examples 1 and 2 above,
 the status can be shown using
 
-``` ruby
+``` sh
 $ ruby myproc_control.rb status
 ```
 
@@ -201,12 +198,10 @@ end
 Daemons.run('myserver.rb', { show_status_callback: :custom_show_status })
 ```
 
-Documenation
--------------------
+## Documentation
 
-Documentation can be found at http://www.rubydoc.info/gems/daemons.
+Documentation can be found at <http://www.rubydoc.info/gems/daemons>.
 
-Author
-------
+## Author
 
-Written 2005-2017 by Thomas Uehlinger, 2014-2016 by Aaron Stone.
+Written 2005-2021 by Thomas Uehlinger, 2014-2016 by Aaron Stone.

data/Releases

@@ -1,5 +1,26 @@
 = Daemons Release History
 
+== Release 1.4.1: August 26, 2021
+
+* Fix :proc mode (pass &block explicitly) (thanks to Graham Rogers)
+* Fix style of REAMDE.md
+
+== Release 1.4.0: May 1, 2021
+
+* Allow for customization which signals are sent to stop process (thanks to philister)
+* Resolves mismatched indentations (thanks to Luis M Rodriguez)
+* Allow to use pry-byebug 3.8.0 (thanks to kamipo)
+
+== Release 1.3.1: December 14, 2018
+
+* Fix undefined local variable or method `pid_delimiter'
+
+== Release 1.3.0: December 10, 2018
+
+* Make logging more configurable.
+* Add configuration options for pid file delimters, force_kill_waittime
+* All status callback to be anything callable.
+
 == Release 1.2.6: December 24, 2017
 
 * Add links to rubydoc.info documentation.

data/lib/daemons/application.rb

@@ -31,11 +31,13 @@ module Daemons
       ['dir', 'log_dir', 'logfilename', 'output_logfilename'].each do |k|
         @options[k] = File.expand_path(@options[k]) if @options.key?(k)
       end
-        
+
       @dir_mode = @dir = @script = nil
 
       @force_kill_waittime = @options[:force_kill_waittime] || 20
 
+      @signals_and_waits = parse_signals_and_waits(@options[:signals_and_waits])
+
       @show_status_callback = method(:default_show_status)
 
       @report = Reporter.new(@options)
@@ -44,7 +46,7 @@ module Daemons
         if @options[:no_pidfiles]
           @pid = PidMem.new
         elsif dir = pidfile_dir
-          @pid = PidFile.new(dir, @group.app_name, @group.multiple)
+          @pid = PidFile.new(dir, @group.app_name, @group.multiple, @options[:pid_delimiter])
         else
           @pid = PidMem.new
         end
@@ -52,7 +54,12 @@ module Daemons
     end
 
     def show_status_callback=(function)
-      @show_status_callback = method(function)
+      @show_status_callback =
+        if function.respond_to?(:call)
+          function
+        else
+          method(function)
+        end
     end
 
     def change_privilege
@@ -198,7 +205,7 @@ module Daemons
           if $daemons_stop_proc
             $daemons_stop_proc.call
           end
-          rescue ::Exception
+        rescue ::Exception
         end
 
         begin; @pid.cleanup; rescue ::Exception; end
@@ -255,7 +262,7 @@ module Daemons
             if $daemons_stop_proc
               $daemons_stop_proc.call
             end
-            rescue ::Exception
+          rescue ::Exception
           end
 
           begin; @pid.cleanup; rescue ::Exception; end
@@ -368,6 +375,7 @@ module Daemons
         return
       end
 
+      # confusing: pid is also a attribute_reader
       pid = @pid.pid
 
       # Catch errors when trying to kill a process that doesn't
@@ -375,47 +383,12 @@ module Daemons
       # restarted by the monitor yet. By catching the error, we allow the
       # pid file clean-up to occur.
       begin
-        Process.kill(SIGNAL, pid)
+        wait_and_retry_kill_harder(pid, @signals_and_waits, no_wait)
       rescue Errno::ESRCH => e
         @report.output_message("#{e} #{pid}")
         @report.output_message('deleting pid-file.')
       end
 
-      unless no_wait
-        if @force_kill_waittime > 0
-          @report.stopping_process(group.app_name, pid)
-          $stdout.flush
-
-          begin
-            Timeout.timeout(@force_kill_waittime, TimeoutError) do
-              while Pid.running?(pid)
-                sleep(0.2)
-              end
-            end
-          rescue TimeoutError
-            @report.forcefully_stopping_process(group.app_name, pid)
-            $stdout.flush
-
-            begin
-              Process.kill('KILL', pid)
-            rescue Errno::ESRCH
-            end
-
-            begin
-              Timeout.timeout(20, TimeoutError) do
-                while Pid.running?(pid)
-                  sleep(1)
-                end
-              end
-            rescue TimeoutError
-              @report.cannot_stop_process(group.app_name, pid)
-              $stdout.flush
-            end
-          end
-        end
-
-      end
-
       sleep(0.1)
       unless Pid.running?(pid)
         # We try to remove the pid-files by ourselves, in case the application
@@ -423,7 +396,30 @@ module Daemons
         zap!
 
         @report.stopped_process(group.app_name, pid)
-        $stdout.flush
+      end
+    end
+
+    # @param Hash remaing_signals
+    # @param Boolean no_wait Send first Signal and return
+    def wait_and_retry_kill_harder(pid, remaining_signals, no_wait = false)
+      sig_wait = remaining_signals.shift
+      sig      = sig_wait[:sig]
+      wait     = sig_wait[:wait]
+      Process.kill(sig, pid)
+      return if no_wait || !wait.positive?
+
+      @report.stopping_process(group.app_name, pid, sig, wait)
+
+      begin
+        Timeout.timeout(wait, TimeoutError) do
+          sleep(0.2) while Pid.running?(pid)
+        end
+      rescue TimeoutError
+        if remaining_signals.any?
+          wait_and_retry_kill_harder(pid, remaining_signals)
+        else
+          @report.cannot_stop_process(group.app_name, pid)
+        end
       end
     end
 
@@ -473,5 +469,15 @@ module Daemons
     def dir
       @dir or group.dir
     end
+
+    def parse_signals_and_waits(argv)
+      unless argv
+        return [
+          { sig: 'TERM', wait: @force_kill_waittime },
+          { sig: 'KILL', wait: 20 }
+        ]
+      end
+      argv.split('|').collect{ |part| splitted = part.split(':'); {sig: splitted[0], wait: splitted[1].to_i}}
+    end
   end
 end

data/lib/daemons/application_group.rb

@@ -38,8 +38,11 @@ module Daemons
       @dir = @options[:dir] || ''
 
       @keep_pid_files = @options[:keep_pid_files] || false
+
       @no_pidfiles = @options[:no_pidfiles] || false
 
+      @pid_delimiter = @options[:pid_delimiter]
+
       @applications = []
     end
 
@@ -80,7 +83,7 @@ module Daemons
           end
           pids = processes.map { |p| p.split(/\s/)[0].to_i }
         end
-        rescue ::Exception
+      rescue ::Exception
       end
 
       pids.map do |f|
@@ -94,7 +97,7 @@ module Daemons
       @monitor = Monitor.find(dir, app_name + '_monitor')
 
       reporter = Reporter.new(options)
-      pid_files = PidFile.find_files(dir, app_name, ! @keep_pid_files) do |pid, file|
+      pid_files = PidFile.find_files(dir, app_name, ! @keep_pid_files, @pid_delimiter) do |pid, file|
         reporter.deleted_found_pidfile(pid, file)
       end
 

data/lib/daemons/cmdline.rb

@@ -12,7 +12,7 @@ module Daemons
         opts.on('-t', '--ontop', 'Stay on top (does not daemonize)') do |t|
           @options[:ontop] = t
         end
-        
+
         opts.on('-s', '--shush', 'Silent mode (no output to the terminal)') do |t|
           @options[:shush] = t
         end
@@ -25,9 +25,40 @@ module Daemons
           @options[:no_wait] = t
         end
 
+        opts.on('-w', '--force_kill_waittime SECONDS', Integer, 'Maximum time to wait for processes to stop before force-killing') do |t|
+          @options[:force_kill_waittime] = t
+        end
+        opts.on('--signals_and_waits STRING', String, 'which signal to use to stop and how long to wait e.g. TERM:20|KILL:20') do |t|
+          @options[:signals_and_waits] = t
+        end
+
+        opts.on('--pid_delimiter STRING', 'Text used to separate process number in full process name and pid-file name') do |value|
+          @options[:pid_delimiter] = value
+        end
+
         opts.separator ''
         opts.separator 'Common options:'
 
+        opts.on('-l', '--log_output', 'Enable input/output stream redirection') do |value|
+          @options[:log_output] = value
+        end
+
+        opts.on('--logfilename FILE', String, 'Custom log file name for exceptions') do |value|
+          @options[:logfilename] = value
+        end
+
+        opts.on('--output_logfilename FILE', String, 'Custom file name for input/output stream redirection log') do |value|
+          @options[:output_logfilename] = value
+        end
+
+        opts.on('--log_dir DIR', String, 'Directory for log files') do |value|
+          @options[:log_dir] = value
+        end
+
+        opts.on('--syslog', 'Enable output redirction into SYSLOG instead of a file') do |value|
+          @options[:log_output_syslog] = value
+        end
+
         # No argument, shows at tail.  This will print an options summary
         opts.on_tail('-h', '--help', 'Show this message') do
           controller.print_usage
@@ -62,7 +93,7 @@ END
     def parse(args)
       # The options specified on the command line will be collected in *options*.
       # We set default values here.
-      
+
       @opts.parse(args)
 
       @options
@@ -71,20 +102,21 @@ END
 
   class Controller
     def print_usage
-      puts "Usage: #{@app_name} <command> <options> -- <application options>"
-      puts
-      puts '* where <command> is one of:'
-      puts '  start         start an instance of the application'
-      puts '  stop          stop all instances of the application'
-      puts '  restart       stop all instances and restart them afterwards'
-      puts '  reload        send a SIGHUP to all instances of the application'
-      puts '  run           start the application and stay on top'
-      puts '  zap           set the application to a stopped state'
-      puts '  status        show status (PID) of application instances'
-      puts
-      puts '* and where <options> may contain several of the following:'
-
-      puts @optparse.usage
+      puts <<-USAGE.gsub(/^ {6}/, '')
+      Usage: #{@app_name} <command> <options> -- <application options>
+
+      * where <command> is one of:
+        start         start an instance of the application
+        stop          stop all instances of the application
+        restart       stop all instances and restart them afterwards
+        reload        send a SIGHUP to all instances of the application
+        run           run the application in the foreground (same as start -t)
+        zap           set the application to a stopped state
+        status        show status (PID) of application instances
+
+      * and where <options> may contain several of the following:
+      #{@optparse.usage}
+      USAGE
     end
 
     def catch_exceptions(&block)

data/lib/daemons/pidfile.rb

@@ -13,8 +13,8 @@ module Daemons
   # === How does a Pid-File look like?
   #
   # Pid-Files generated by Daemons have to following format:
-  #   <scriptname>.rb<number>.pid
-  # (Note that <tt><number></tt> is omitted if only one instance of the script can
+  #   <scriptname>_num<number>.pid
+  # (Note that <tt>_num<number></tt> is omitted if only one instance of the script can
   # run at any time)
   #
   # Each file just contains one line with the pid as string (for example <tt>6432</tt>).
@@ -28,10 +28,11 @@ module Daemons
   # 3.  in the preconfigured directory <tt>/var/run</tt> (<tt>:system</tt> option for <tt>:dir_mode</tt>)
   #
   class PidFile < Pid
-    attr_reader :dir, :progname, :multiple, :number
+    DEFAULT_PID_DELIMITER = '_num'
+    attr_reader :dir, :progname, :multiple, :number, :pid_delimiter
 
-    def self.find_files(dir, progname, delete = false)
-      files = Dir[File.join(dir, "#{progname}_num*.pid")]
+    def self.find_files(dir, progname, delete = false, pid_delimiter = nil)
+      files = Dir[File.join(dir, "#{progname}#{pid_delimiter || DEFAULT_PID_DELIMITER}*.pid")]
       files = Dir[File.join(dir, "#{progname}.pid")] if files.size == 0
 
       files.delete_if { |f| not (File.file?(f) and File.readable?(f)) }
@@ -62,10 +63,11 @@ module Daemons
       new_instance
     end
 
-    def initialize(dir, progname, multiple = false)
+    def initialize(dir, progname, multiple = false, pid_delimiter = nil)
       @dir = File.expand_path(dir)
       @progname = progname
       @multiple = multiple
+      @pid_delimiter = pid_delimiter || DEFAULT_PID_DELIMITER
       @number = nil
       @number = 0 if multiple
 
@@ -81,7 +83,8 @@ module Daemons
     end
 
     def filename
-      File.join(@dir, "#{@progname}#{@number ? '_num' + @number.to_s : '' }.pid")
+      suffix = "#{pid_delimiter}#{@number}" if @number
+      File.join(@dir, "#{@progname}#{suffix}.pid")
     end
 
     def exist?

data/lib/daemons/reporter.rb

@@ -32,20 +32,19 @@ module Daemons
       output_message 'option :backtrace is not supported with :mode => :exec, ignoring'
     end
 
-    def stopping_process(app_name, pid)
-      output_message "#{app_name}: trying to stop process with pid #{pid}..."
-    end
-
-    def forcefully_stopping_process(app_name, pid)
-      output_message "#{app_name}: process with pid #{pid} won't stop, we forcefully kill it..." 
+    def stopping_process(app_name, pid, sig, wait)
+      output_message "#{app_name}: trying to stop process with pid #{pid}#{' forcefully :(' if sig == 'KILL'} sending #{sig} and waiting #{wait}s ..."
+      $stdout.flush
     end
 
     def cannot_stop_process(app_name, pid)
       output_message "#{app_name}: unable to forcefully kill process with pid #{pid}."
+      $stdout.flush
     end
 
     def stopped_process(app_name, pid)
       output_message "#{app_name}: process with pid #{pid} successfully stopped."
+      $stdout.flush
     end
 
     def status(app_name, running, pid_exists, pid)

data/lib/daemons/version.rb

@@ -1,3 +1,3 @@
 module Daemons
-  VERSION = '1.2.6'
+  VERSION = '1.4.1'
 end

data/lib/daemons.rb

@@ -99,6 +99,7 @@ module Daemons
   # <tt>:dir</tt>::       Used in combination with <tt>:dir_mode</tt> (description above)
   # <tt>:multiple</tt>::  Specifies whether multiple instances of the same script are allowed to run at the
   #                       same time
+  # <tt>:pid_delimiter</tt>:: Specifies the separator used when enumerating multiple process names/pid-files. Default is '_num'.
   # <tt>:ontop</tt>::     When given (i.e. set to true), stay on top, i.e. do not daemonize the application
   #                       (but the pid-file and other things are written as usual)
   # <tt>:shush</tt>::     When given (i.e. set to true), turn on silent mode (no output to the terminal)
@@ -129,6 +130,7 @@ module Daemons
   #     :dir_mode           => :script,
   #     :dir                => 'pids',
   #     :multiple           => true,
+  #     :pid_delimiter      => '.n',
   #     :ontop              => true,
   #     :shush              => false,
   #     :mode               => :exec,
@@ -249,7 +251,7 @@ module Daemons
     fail 'Daemons.call: no block given' unless block_given?
 
     options[:app_name] ||= 'proc'
-    options[:proc] = Proc.new
+    options[:proc] = Proc.new(&block)
     options[:mode] = :proc
     options[:dir_mode] = :normal
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: daemons
 version: !ruby/object:Gem::Version
-  version: 1.2.6
+  version: 1.4.1
 platform: ruby
 authors:
 - Thomas Uehlinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-24 00:00:00.000000000 Z
+date: 2021-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -16,14 +16,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
 description: |2
       Daemons provides an easy way to wrap existing ruby scripts (for example a
       self-written server)  to be run as a daemon and to be controlled by simple
@@ -147,8 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A toolkit to create and control daemons in different ways