resqued 0.10.1 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 477007ffc7e6d2630b794ef021d1bbe2bc4f2cc5fc5df95fbd91b92f2e6121fe
-  data.tar.gz: 39531525a5afdd44ab077f69355d5b17a615f6430c21171bbd8cddc36adbaf66
+  metadata.gz: bc14cf354d4cd292119aa6e6f06f0c59dd09faf982fe10707e69c5bbb3ef56e4
+  data.tar.gz: 7bad129217778e76f14c1dc6a732025d5cc0bba17baaee9d81ee5a1648768edc
 SHA512:
-  metadata.gz: e0f13ad32bc91c04058201882a00a65d4f67da7f3fadd19cac227eaca76d1816b47987f517a53d2ec03de9c39b3ff2c7ed6b2956e44ff0890cea0eb467085adc
-  data.tar.gz: 6c8399d793a329ae717d18c38dfca7e1f5b286e218e6ae39b5ce9deaed26b12a325d7e49292f5687a5ecb1e3814360fe9d5c6b670e0a5d49ed01473b978008c4
+  metadata.gz: e8b5e943ec7612022b8a937c6a380b1d396be6cd2c5ebad13239961232c992dcce54d42e807c1d52f036f102defe4492f4fd498f0299c33e40e5095dc26ab48f
+  data.tar.gz: a26e43be4a408d59d8db061c00b112e45a6fec8b6ba318e145cbac1e53b4087b12f9b2ba3510fa118714aeb8b0117673c90b6f7fb987ca028a8962c85f594e5f

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.10.2
+-------
+* Shut down cleanly even if there are other stray child processes of the master. (#59)
+
 v0.10.1
 -------
 * Avoid deadlock if a listener stops responding. (#58)

data/lib/resqued/listener_pool.rb

@@ -25,6 +25,11 @@ module Resqued
       @listener_proxies.size
     end
 
+    # Public: Are the listeners all gone?
+    def empty?
+      @listener_proxies.empty?
+    end
+
     # Public: Initialize a new listener, run it, and record it as the current listener. Returns its ListenerProxy.
     def start!
       listener_state = ListenerState.new

data/lib/resqued/master.rb

@@ -187,7 +187,7 @@ module Resqued
     end
 
     def reap_all_listeners(waitpid_flags = 0)
-      loop do
+      until @listeners.empty?
         begin
           lpid, status = Process.waitpid2(-1, waitpid_flags)
           return unless lpid
@@ -203,9 +203,11 @@ module Resqued
             @state.clear_last_good!
           end
 
-          dead_listener = @listeners.delete(lpid)
-          listener_status dead_listener, "stop"
-          dead_listener.dispose
+          if dead_listener = @listeners.delete(lpid)
+            listener_status dead_listener, "stop"
+            dead_listener.dispose
+          end
+
           write_procline
         rescue Errno::ECHILD
           return

data/lib/resqued/version.rb

@@ -1,3 +1,3 @@
 module Resqued
-  VERSION = '0.10.1'
+  VERSION = '0.10.2'
 end

data/spec/integration/master_inherits_child_spec.rb

@@ -0,0 +1,85 @@
+require "spec_helper"
+require "timeout"
+
+describe "Resqued master with an extra child process" do
+  include ResquedPath
+
+  # Starts resqued with an extra child process.
+  def start_resqued_with_extra_child
+    shim_path = File.expand_path("../support/extra-child-shim", File.dirname(__FILE__))
+
+    config_path = File.join(SPEC_TEMPDIR, "config.rb")
+    File.write(config_path, <<-CONFIG)
+      before_fork { File.write(ENV["LISTENER_PIDFILE"], $$.to_s) }
+    CONFIG
+
+    logfile = File.join(SPEC_TEMPDIR, "resqued.log")
+    File.write(logfile, "") # truncate it
+
+    env = {
+      "LISTENER_PIDFILE" => listener_pidfile,
+      "EXTRA_CHILD_PIDFILE" => extra_child_pidfile,
+    }
+
+    pid = spawn(env, shim_path, resqued_path, "--logfile", logfile, config_path)
+    sleep 1.0
+    pid
+  end
+
+  let(:extra_child_pidfile) { File.join(SPEC_TEMPDIR, "extra-child.pid") }
+  def extra_child_pid
+    File.read(extra_child_pidfile).to_i
+  end
+
+  let(:listener_pidfile) { File.join(File.join(SPEC_TEMPDIR, "listener.pid")) }
+  def listener_pid
+    File.read(listener_pidfile).to_i
+  end
+
+  before do
+    File.unlink(extra_child_pidfile) rescue nil
+    File.unlink(listener_pidfile) rescue nil
+    @resqued_pid = start_resqued_with_extra_child
+  end
+
+  after do
+    kill_safely(:TERM) { @resqued_pid }
+    kill_safely(:KILL) { extra_child_pid }
+    sleep 0.1
+    kill_safely(:KILL) { @resqued_pid }
+  end
+
+  it "doesn't exit when listener dies unexpectedly" do
+    # Kill off the listener process.
+    first_listener_pid = listener_pid
+    Process.kill :QUIT, first_listener_pid
+    # Let Resqued::Backoff decide it's OK to start the listener again.
+    sleep 2.5
+    # Resqued should start a new listener to replace the dead one.
+    expect(listener_pid).not_to eq(first_listener_pid)
+  end
+
+  it "exits when listeners have all exited during shutdown" do
+    # Do a normal shutdown.
+    Process.kill :QUIT, @resqued_pid
+    # Expect the resqued process to exit.
+    expect(Timeout.timeout(5.0) { Process.waitpid(@resqued_pid) }).to eq(@resqued_pid)
+  end
+
+  it "doesn't crash when extra child exits" do
+    # Kill off the extra child process. Resqued should wait on it, but not exit.
+    Process.kill :KILL, extra_child_pid
+    sleep 1.0
+    # The resqued process should not have exited.
+    expect(Process.waitpid(@resqued_pid, Process::WNOHANG)).to be_nil
+    expect(Process.kill(0, @resqued_pid)).to eq(1)
+  end
+
+  def kill_safely(signal)
+    return unless pid = yield
+
+    Process.kill(signal, pid)
+  rescue Errno::ESRCH, Errno::ENOENT
+    # Process isn't there anymore, or pidfile isn't there. :+1:
+  end
+end

data/spec/integration/restart_spec.rb

@@ -0,0 +1,63 @@
+require "spec_helper"
+
+describe "Resqued can restart" do
+  include ResquedPath
+
+  it "expect to be able to restart" do
+    start_resqued
+    expect_running listener: "listener #1"
+    restart_resqued
+    expect_running listener: "listener #2"
+    stop_resqued
+    expect_not_running
+  end
+
+  after do
+    begin
+      Process.kill(:QUIT, @pid) if @pid
+    rescue Errno::ESRCH
+    end
+  end
+
+  def expect_running(listener:)
+    processes = list_processes
+    expect(processes).to include(is_resqued_master)
+    listeners = processes.select { |p| p[:ppid] == @pid }.map { |p| p[:args] }
+    expect(listeners).to all(match(/#{listener}/)).and(satisfy { |l| l.size == 1 })
+  end
+
+  def expect_not_running
+    processes = list_processes
+    expect(processes).not_to include(is_resqued_master)
+  end
+
+  def start_resqued
+    # Don't configure any workers. That way, we don't need to have redis running.
+    config_path = File.join(SPEC_TEMPDIR, "config.rb")
+    File.write(config_path, "")
+
+    logfile = File.join(SPEC_TEMPDIR, "resqued.log")
+    File.write(logfile, "") # truncate it
+
+    @pid = spawn resqued_path, "--logfile", logfile, config_path
+    sleep 1.0
+  end
+
+  def restart_resqued
+    Process.kill(:HUP, @pid)
+    sleep 1.0
+  end
+
+  def stop_resqued
+    Process.kill(:TERM, @pid)
+    sleep 1.0
+  end
+
+  def list_processes
+    `ps axo pid,ppid,args`.lines.map { |line| pid, ppid, args = line.strip.split(/\s+/, 3); { pid: pid.to_i, ppid: ppid.to_i, args: args } }
+  end
+
+  def is_resqued_master
+    satisfy { |p| p[:pid] == @pid && p[:args] =~ /resqued-/ }
+  end
+end

data/spec/spec_helper.rb

@@ -1 +1,5 @@
 require "support/custom_matchers"
+require "support/resqued_path"
+
+SPEC_TEMPDIR = File.expand_path("../tmp/spec", File.dirname(__FILE__))
+FileUtils.mkpath(SPEC_TEMPDIR)

data/spec/support/extra-child-shim

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+extra_child_pid = fork { sleep(100); exit! }
+File.write(ENV["EXTRA_CHILD_PIDFILE"], extra_child_pid.to_s)
+
+exec(*ARGV)

data/spec/support/resqued_path.rb

@@ -0,0 +1,11 @@
+module ResquedPath
+  def resqued_path
+    return @resqued_path if @resqued_path
+
+    @resqued_path = File.expand_path("../../gemfiles/bin/resqued", File.dirname(__FILE__))
+    unless File.executable?(@resqued_path)
+      @resqued_path = File.expand_path("../../bin/resqued", File.dirname(__FILE__))
+    end
+    @resqued_path
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resqued
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.10.2
 platform: ruby
 authors:
 - Matt Burke
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-04 00:00:00.000000000 Z
+date: 2020-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kgio
@@ -137,6 +137,8 @@ files:
 - spec/fixtures/test_case_clean.rb
 - spec/fixtures/test_case_environment.rb
 - spec/fixtures/test_case_no_workers.rb
+- spec/integration/master_inherits_child_spec.rb
+- spec/integration/restart_spec.rb
 - spec/resqued/backoff_spec.rb
 - spec/resqued/config/fork_event_spec.rb
 - spec/resqued/config/worker_spec.rb
@@ -146,7 +148,8 @@ files:
 - spec/resqued/test_case_spec.rb
 - spec/spec_helper.rb
 - spec/support/custom_matchers.rb
-- spec/test_restart.sh
+- spec/support/extra-child-shim
+- spec/support/resqued_path.rb
 homepage: https://github.com/spraints/resqued
 licenses:
 - MIT
@@ -172,8 +175,11 @@ specification_version: 4
 summary: Daemon of resque workers
 test_files:
 - spec/spec_helper.rb
-- spec/test_restart.sh
+- spec/integration/restart_spec.rb
+- spec/integration/master_inherits_child_spec.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

data/spec/test_restart.sh

@@ -1,84 +0,0 @@
-#!/bin/bash
-
-set -e
-set -o nounset
-
-WORKDIR="$(mktemp)"
-PIDFILE="${WORKDIR}/resqued.pid"
-CONFIG="${WORKDIR}/config.rb"
-
-# mktemp makes a file, but we want a dir.
-rm -f "$WORKDIR"
-mkdir "$WORKDIR"
-
-set -x
-cd "$(dirname "$0")/.."
-
-main() {
-  trap cleanup EXIT
-
-  configure_resqued
-  start_resqued
-  restart_resqued
-  stop_resqued
-}
-
-configure_resqued() {
-  # Don't configure any workers. That way, we don't need to have redis running.
-  touch "${CONFIG}"
-}
-
-start_resqued() {
-  bin_resqued=bin/resqued
-  if [ -x gemfiles/bin/resqued ]; then
-    bin_resqued=gemfiles/bin/resqued
-  fi
-  $bin_resqued --pidfile "${PIDFILE}" "${CONFIG}" &
-  sleep 1
-  echo expect to find the master process and the first listener
-  running # set -e will make the test fail if it's not running
-  ps axo pid,args -H | grep [r]esqued-
-  ps axo pid,args | grep [r]esqued- | grep -q 'listener #1.*running'
-}
-
-restart_resqued() {
-  local pid="$(cat "${PIDFILE}")"
-  kill -HUP "$pid"
-  sleep 1
-  echo expect to find the master process and the second listener
-  running
-  ps axo pid,args -H | grep [r]esqued-
-  ps axo pid,args | grep [r]esqued- | grep -qv 'listener #1'
-  ps axo pid,args | grep [r]esqued- | grep -q 'listener #2.*running'
-}
-
-stop_resqued() {
-  local pid="$(cat "${PIDFILE}")"
-  kill -TERM "$pid"
-  sleep 1
-  echo expect everything to be stopped
-  if running >&/dev/null; then
-    echo "expected resqued to be stopped"
-    false
-  fi
-  ps axo pid,args -H | grep [r]esqued- || true
-  test -z "$(ps axo pid,args | grep [r]esqued-)"
-}
-
-running() {
-  set -e
-  test -f "${PIDFILE}"
-  local pid="$(cat "${PIDFILE}")"
-  kill -0 "$pid"
-  ps o pid,args "$pid"
-}
-
-cleanup() {
-  while running >&/dev/null; do
-    kill -TERM "$(cat "${PIDFILE}")"
-    sleep 2
-  done
-  rm -rfv "${WORKDIR}" || rm -rf "${WORKDIR}"
-}
-
-main