resqued 0.12.1 → 0.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13f45787a92226688e4b30d34f1f6a5390277c34423b94786511d6bf6a4b5d71
-  data.tar.gz: 0d6af78fd2ced8e9fff8703456052333ddb20e75c32d7c1ffab0466dbab6b9cb
+  metadata.gz: 87a69574c5ec392def740d29a5274248e815e96f02304f59e27c0faa805153a4
+  data.tar.gz: 6809178bc9ad88a6c8da0be070521aa9273ecf4eac6b99e5219d0870af813efe
 SHA512:
-  metadata.gz: 782cb7f9c4d7ceeb3e7de4d8612eb2df0363105f447fe110404dc779e73cffa9a433e3d08f6021cd6fd6f7f17b34c305c4ac623c28536b140c72ca8a451f3030
-  data.tar.gz: 766db53a09ffab45db9288b9ed165bdb0c679ff394edcb2f40dd1e626c12e1735cb32a4dc39e2fbbb248d8d596826ff1bb01ff568bd944ad9ff0483c836947d4
+  metadata.gz: 94c143e2563fe9b42f6e3e73361b0a0949219e690188b822aa91da8247bef42f3e223844a9f7348fe03cc340a1b6fd70c6ef802bca8413d07d6c1eb4eb398ad7
+  data.tar.gz: 01acb7c8e6a9036696e53a4c97e09b78c812ab8cb0211e686ba79391cbab1663d54979c91e2405f8bb42c980534abb2505e459a5fd7d81aa8cd581c53cf8db4b

data/CHANGES.md

@@ -1,5 +1,9 @@
 Starting with version 0.6.1, resqued uses semantic versioning to indicate incompatibilities between the master process, listener process, and configuration.
 
+v0.12.2
+-------
+* Added lifecycle hook for container runtimes. (#67)
+
 v0.12.1
 -------
 * Fixed Resqued::TestCase. v0.12.0 introduced a regression that stopped

data/exe/resqued

@@ -1,9 +1,14 @@
 #!/usr/bin/env ruby
 
-if ARGV[0] == "listener"
+case ARGV[0]
+when "listener"
   require "resqued/listener"
   Resqued::Listener.exec!
   exit 0
+when "quit-and-wait"
+  require "resqued/quit-and-wait"
+  Resqued::QuitAndWait.exec!(ARGV.drop(1))
+  exit 0
 end
 
 require "optparse"

data/lib/resqued/quit-and-wait.rb

@@ -0,0 +1,84 @@
+require "optparse"
+
+module Resqued
+  class QuitAndWait
+    def self.exec!(argv)
+      options = { grace_seconds: 30 }
+
+      opts = OptionParser.new do |opts| # rubocop: disable Lint/ShadowingOuterLocalVariable
+        opts.banner = <<~USAGE
+          Usage: resqued quit-and-wait PIDFILE [--grace-period SECONDS]
+
+          Use this as a preStop script in kubernetes. This script will send a SIGQUIT to
+          resqued immediately, and then sleep until either resqued exits or until the
+          grace period is nearing expiration. This script exits 0 if resqued exited and
+          99 otherwise.
+        USAGE
+
+        opts.on "-h", "--help", "Show this message" do
+          puts opts
+          exit
+        end
+
+        opts.on "-v", "--version", "Show the version" do
+          require "resqued/version"
+          puts Resqued::VERSION
+          exit
+        end
+
+        opts.on "--grace-period SECONDS", Numeric, "Grace period provided to container runtime (default 30)" do |v|
+          options[:grace_seconds] = v
+        end
+
+        opts.on "--quiet" do
+          options[:quiet] = true
+        end
+      end
+
+      argv = opts.parse(argv)
+      if argv.size != 1
+        puts opts
+        exit 1
+      end
+      options[:pidfile] = argv.shift
+
+      new(**options).exec!
+    end
+
+    def initialize(grace_seconds:, pidfile:, quiet: false)
+      @grace_seconds = grace_seconds
+      @pidfile = pidfile
+      @quiet = quiet
+    end
+
+    attr_reader :grace_seconds, :pidfile, :quiet
+
+    def exec!
+      start = Time.now
+      stop_at = start + grace_seconds - 5
+      pid = File.read(pidfile).to_i
+
+      log "kill -QUIT #{pid} (resqued-master)"
+      Process.kill(:QUIT, pid)
+
+      while Time.now < stop_at
+        begin
+          # check if pid is still alive.
+          Process.kill(0, pid)
+        rescue Errno::ESRCH # no such process, it exited!
+          log "ok: resqued-master with pid #{pid} exited"
+          exit 0
+        end
+      end
+
+      log "giving up, resqued-master with pid #{pid} is still running."
+      exit 99
+    end
+
+    def log(message)
+      return if quiet
+
+      puts "#{Time.now.strftime('%H:%M:%S.%L')} #{message}"
+    end
+  end
+end

data/lib/resqued/version.rb

@@ -1,3 +1,3 @@
 module Resqued
-  VERSION = "0.12.1".freeze
+  VERSION = "0.12.2".freeze
 end

data/spec/integration/quit_and_wait_spec.rb

@@ -0,0 +1,37 @@
+require "spec_helper"
+require "timeout"
+
+describe "quit-and-wait gracefully stops resqued" do
+  include ResquedIntegrationHelpers
+
+  it do
+    pidfile = File.join(SPEC_TEMPDIR, "graceful.pid")
+
+    start_resqued(pidfile: pidfile)
+    expect_running listener: "listener #1"
+
+    # Make sure the process gets cleaned up.
+    Thread.new do
+      begin
+        loop do
+          Process.wait(@pid)
+        end
+      rescue Errno::ECHILD
+        # ok!
+      end
+    end
+
+    Timeout.timeout(15) do
+      expect(system(resqued_path, "quit-and-wait", pidfile, "--grace-period", "10")).to be true
+    end
+
+    expect_not_running
+  end
+
+  after do
+    begin
+      Process.kill(:QUIT, @pid) if @pid
+    rescue Errno::ESRCH
+    end
+  end
+end

data/spec/support/resqued_integration_helpers.rb

@@ -1,20 +1,25 @@
 module ResquedIntegrationHelpers
   include ResquedPath
 
-  def start_resqued(config: "", debug: false)
-    # Don't configure any workers. That way, we don't need to have redis running.
+  def start_resqued(config: "", debug: false, pidfile: nil)
+    # Don't configure any workers by default. That way, we don't need to have
+    # redis running.
     config_path = File.join(SPEC_TEMPDIR, "config.rb")
     File.write(config_path, config)
 
-    @pid =
-      if debug
-        spawn resqued_path, config_path
-      else
-        logfile = File.join(SPEC_TEMPDIR, "resqued.log")
-        File.write(logfile, "") # truncate it
+    cmd = [resqued_path]
+    if pidfile
+      cmd += ["--pidfile", pidfile]
+    end
+    unless debug
+      logfile = File.join(SPEC_TEMPDIR, "resqued.log")
+      File.write(logfile, "") # truncate it
+      cmd += ["--logfile", logfile]
+    end
+    cmd += [config_path]
+
+    @pid = spawn(*cmd)
 
-        spawn resqued_path, "--logfile", logfile, config_path
-      end
     sleep 1.0
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resqued
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.12.2
 platform: ruby
 authors:
 - Matt Burke
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-23 00:00:00.000000000 Z
+date: 2022-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kgio
@@ -127,6 +127,7 @@ files:
 - lib/resqued/master_state.rb
 - lib/resqued/pidfile.rb
 - lib/resqued/procline_version.rb
+- lib/resqued/quit-and-wait.rb
 - lib/resqued/runtime_info.rb
 - lib/resqued/sleepy.rb
 - lib/resqued/test_case.rb
@@ -139,6 +140,7 @@ files:
 - spec/fixtures/test_case_no_workers.rb
 - spec/integration/listener_still_starting_spec.rb
 - spec/integration/master_inherits_child_spec.rb
+- spec/integration/quit_and_wait_spec.rb
 - spec/integration/restart_spec.rb
 - spec/resqued/backoff_spec.rb
 - spec/resqued/config/fork_event_spec.rb
@@ -156,7 +158,7 @@ homepage: https://github.com/spraints/resqued
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -171,28 +173,29 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Daemon of resque workers
 test_files:
-- spec/fixtures/test_case_after_fork_raises.rb
-- spec/fixtures/test_case_before_fork_raises.rb
+- spec/spec_helper.rb
+- spec/integration/restart_spec.rb
+- spec/integration/quit_and_wait_spec.rb
+- spec/integration/listener_still_starting_spec.rb
+- spec/integration/master_inherits_child_spec.rb
+- spec/support/resqued_integration_helpers.rb
+- spec/support/custom_matchers.rb
+- spec/support/resqued_path.rb
+- spec/support/extra-child-shim
 - spec/fixtures/test_case_clean.rb
+- spec/fixtures/test_case_before_fork_raises.rb
 - spec/fixtures/test_case_environment.rb
 - spec/fixtures/test_case_no_workers.rb
-- spec/integration/listener_still_starting_spec.rb
-- spec/integration/master_inherits_child_spec.rb
-- spec/integration/restart_spec.rb
-- spec/resqued/backoff_spec.rb
+- spec/fixtures/test_case_after_fork_raises.rb
+- spec/resqued/config_spec.rb
 - spec/resqued/config/fork_event_spec.rb
 - spec/resqued/config/worker_spec.rb
-- spec/resqued/config_spec.rb
 - spec/resqued/sleepy_spec.rb
-- spec/resqued/start_ctx_spec.rb
 - spec/resqued/test_case_spec.rb
-- spec/spec_helper.rb
-- spec/support/custom_matchers.rb
-- spec/support/extra-child-shim
-- spec/support/resqued_integration_helpers.rb
-- spec/support/resqued_path.rb
+- spec/resqued/start_ctx_spec.rb
+- spec/resqued/backoff_spec.rb