daemons 1.2.4 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 860b58ef469300cda2269a45f189796af8f36bcb
-  data.tar.gz: 29894094754c8013a9901f918f9e9ca2d700258f
+SHA256:
+  metadata.gz: 5114c4c5cb5dba3befcc82f6eaa45d901036bc7357a6d4d81cfd8cad8c49dae6
+  data.tar.gz: 0eb7b12972a659d053b87d4d59e24d5a3de21a9ff94c3432e8da62ac08f5c127
 SHA512:
-  metadata.gz: cd7e03dbc97d7dcaa21b582b868cea9b5610e52b975737b8c8309ce71f803647d3a87444e04a79b63feb2da895b0ee5ab8624985540c4a5dfba0be916f23d55a
-  data.tar.gz: c42a97021220ffbbe114349c8fe2ebeff0894b265cd4c2a960cf9efbdce5b0bcf873d92dd393b54fdde336b4d53c8ea4c53d827f567d0313829fd0f4f23c7cdb
+  metadata.gz: '00970b9deb9eab30e1ce69b31ceca7617bf406692f5dbbb5a9459c5a5a898bc8a0e751fb751cb463f027be1977b54c0b914fcee996ad0cbea997829ce54d2360'
+  data.tar.gz: f98f5696a4f482e29eb22c38fddc9fa6dafcfaaa4c6989a5015191c53711848e703267dc3c0da25080d9509035bf91b7aac7f009b4ccbb6de53fd8a299a4834b

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2005-2016 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,6 +1,6 @@
 Ruby 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)
+[![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)
 to be _run as a daemon_ and to be _controlled by simple start/stop/restart commands_.
@@ -201,7 +201,12 @@ end
 Daemons.run('myserver.rb', { show_status_callback: :custom_show_status })
 ```
 
+Documentation
+-------------------
+
+Documentation can be found at http://www.rubydoc.info/gems/daemons.
+
 Author
 ------
 
-Written 2005-2016 by Thomas Uehlinger, 2014-2016 by Aaron Stone.
+Written 2005-2021 by Thomas Uehlinger, 2014-2016 by Aaron Stone.

data/Releases

@@ -1,5 +1,30 @@
 = Daemons Release History
 
+== 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.
+
+== Release 1.2.5: October 22, 2017
+
+* In Application#stop, call zap, not cleanup on the pidfile (thanks to wevanscfi)
+* Use File.expand_path on and output and log files (thanks to Dave Harris)
+
 == Release 1.2.4: August 1, 2016
 
 * add :shush option

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,
@@ -238,23 +240,26 @@ module Daemons
   #   end
   #
   def call(options = {}, &block)
-    unless block_given?
-      fail 'Daemons.call: no block given'
-    end
+    new_app = Daemons.new(options, &block)
+    new_app.start
+    new_app
+  end
+  module_function :call
 
-    options[:proc] = block
-    options[:mode] = :proc
+  # Create a new Daemon application, like <tt>Daemons.call</tt>, but will not start it automatically
+  def new(options = {}, &block)
+    fail 'Daemons.call: no block given' unless block_given?
 
     options[:app_name] ||= 'proc'
+    options[:proc] = Proc.new
+    options[:mode] = :proc
+    options[:dir_mode] = :normal
 
     @group ||= ApplicationGroup.new(options[:app_name], options)
 
-    new_app = @group.new_application(options)
-    new_app.start
-
-    new_app
+    @group.new_application(options)
   end
-  module_function :call
+  module_function :new
 
   # Daemonize the currently runnig process, i.e. the calling process will become a daemon.
   #

data/lib/daemons/application.rb

@@ -28,10 +28,16 @@ module Daemons
       @options = group.options.dup
       @options.update(add_options)
 
+      ['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)
@@ -40,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
@@ -48,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
@@ -194,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
@@ -251,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
@@ -364,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
@@ -371,55 +383,43 @@ 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
         # didn't clean it up.
-        begin; @pid.cleanup; rescue ::Exception; end
+        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
 
@@ -469,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

@@ -23,19 +23,25 @@ module Daemons
       @app_name = app_name
       @options = options
 
-      if options[:script]
-        @script = File.expand_path(options[:script])
+      if @options[:script]
+        @script = File.expand_path(@options[:script])
       end
 
       @monitor = nil
 
-      @multiple = options[:multiple] || false
+      @multiple = @options[:multiple] || false
 
-      @dir_mode = options[:dir_mode] || :script
-      @dir = options[:dir] || ''
+      @dir_mode = @options[:dir_mode] || :script
+      ['dir'].each do |k|
+        @options[k] = File.expand_path(@options[k]) if @options.key?(k)
+      end
+      @dir = @options[:dir] || ''
+
+      @keep_pid_files = @options[:keep_pid_files] || false
+
+      @no_pidfiles = @options[:no_pidfiles] || false
 
-      @keep_pid_files = options[:keep_pid_files] || false
-      @no_pidfiles = options[:no_pidfiles] || false
+      @pid_delimiter = @options[:pid_delimiter]
 
       @applications = []
     end
@@ -77,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|
@@ -91,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/controller.rb

@@ -61,7 +61,7 @@ module Daemons
           @group.stop_all(@options[:no_wait])
         when 'restart'
           unless @group.applications.empty?
-            @group.stop_all
+            @group.stop_all(@options[:no_wait])
             sleep(1)
             @group.start_all
           else

data/lib/daemons/monitor.rb

@@ -107,7 +107,7 @@ module Daemons
           end
       rescue ::Exception => e
         $stderr.puts "exception while trying to stop monitor process #{pid}: #{e}"
-        $stderr.puts 'deleting pid-file.'
+        $stderr.puts "deleting pid-file."
       end
 
       # We try to remove the pid-files by ourselves, in case the monitor

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?
@@ -100,9 +103,9 @@ module Daemons
     end
 
     def zap
-      File.delete(filename)
+      File.delete(filename) if exist?
     end
-    
+
     def pid
       begin
         File.open(filename) do |f|

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.4'
+  VERSION = '1.4.0'
 end

metadata

@@ -1,71 +1,77 @@
 --- !ruby/object:Gem::Specification
 name: daemons
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.4.0
 platform: ruby
 authors:
 - Thomas Uehlinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-01 00:00:00.000000000 Z
+date: 2021-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     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
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '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
@@ -130,24 +136,24 @@ files:
 homepage: https://github.com/thuehlinger/daemons
 licenses:
 - MIT
-metadata: {}
+metadata:
+  documentation_uri: http://www.rubydoc.info/gems/daemons
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A toolkit to create and control daemons in different ways