resqued 0.12.0 → 0.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a92bd03c3a0bf63c872341d0df842ea52762a641efeb490584ef508ff61a868
-  data.tar.gz: 0c49b197b2fc672ff436f3eab41908de2a2a6e641a9a2d7df202a14c90557263
+  metadata.gz: 87a69574c5ec392def740d29a5274248e815e96f02304f59e27c0faa805153a4
+  data.tar.gz: 6809178bc9ad88a6c8da0be070521aa9273ecf4eac6b99e5219d0870af813efe
 SHA512:
-  metadata.gz: cebc5d49661bafd589c3eeecea7a2e8729fe26a546c6b2dd3839c8b7939c62f2baf7f26b99434df8863759a7bb228f5939551f1986e9798aab0e9ff314337d69
-  data.tar.gz: e3fdac521d55d512431f24d3dc26fdbd435491d7251ab6c5f4e7f375fac9d1956e2e878dcad47b54c1fe2323a968222dced0fd81733163c29eb61819cdc8f68d
+  metadata.gz: 94c143e2563fe9b42f6e3e73361b0a0949219e690188b822aa91da8247bef42f3e223844a9f7348fe03cc340a1b6fd70c6ef802bca8413d07d6c1eb4eb398ad7
+  data.tar.gz: 01acb7c8e6a9036696e53a4c97e09b78c812ab8cb0211e686ba79391cbab1663d54979c91e2405f8bb42c980534abb2505e459a5fd7d81aa8cd581c53cf8db4b

data/CHANGES.md

@@ -1,5 +1,15 @@
 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
+  `after_fork` blocks from being tested. This fixes some other problems in CI,
+  too. (#66)
+
 v0.12.0
 -------
 * Drop "resque" as a dependency. Apps that use Resqued with a different job

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/listener.rb

@@ -96,7 +96,7 @@ module Resqued
       if Resque.respond_to?("logger=")
         Resque.logger = Resqued::Logging.build_logger
       end
-    rescue LoadError
+    rescue LoadError # rubocop: disable Lint/SuppressedException
       # Skip this step.
     end
 

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/test_case.rb

@@ -17,11 +17,17 @@ module Resqued
         config = Resqued::Config.new(paths)
         config.before_fork(RuntimeInfo.new)
         config.build_workers
+        config.after_fork(FakeWorker.new)
       end
     end
 
     Default = LoadConfig
 
     include Default
+
+    class FakeWorker
+      def initialize
+      end
+    end
   end
 end

data/lib/resqued/version.rb

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

data/spec/fixtures/test_case_environment.rb

@@ -1,3 +1,4 @@
 before_fork do
+  require "resque"
   Resque.redis = Redis.new(host: "localhost", port: ENV["RESQUED_TEST_REDIS_PORT"].to_i)
 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.0
+  version: 0.12.2
 platform: ruby
 authors:
 - Matt Burke
 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
@@ -39,33 +39,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: resque
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.9.1
+        version: 13.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.9.1
+        version: 13.0.1
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: resque
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 13.0.1
+        version: 1.9.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 13.0.1
+        version: 1.9.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.78.0
+        version: 0.79.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.78.0
+        version: 0.79.0
 description: Daemon of resque workers
 email: spraints@gmail.com
 executables:
@@ -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
@@ -178,6 +180,7 @@ summary: Daemon of resque workers
 test_files:
 - 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