Run tests for Puma plugin with Solid Queue as fork and async

Author: rosa

test/dummy/config/puma.rb

@@ -0,0 +1 @@
+puma_fork.rb

test/dummy/config/puma.rb

@@ -0,0 +1,46 @@
+# Puma can serve each request in a thread from an internal thread pool.
+# The `threads` method setting takes two numbers: a minimum and maximum.
+# Any libraries that use thread pools should be configured to match
+# the maximum value specified for Puma. Default is set to 5 threads for minimum
+# and maximum; this matches the default thread size of Active Record.
+#
+max_threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 }
+min_threads_count = ENV.fetch("RAILS_MIN_THREADS") { max_threads_count }
+threads min_threads_count, max_threads_count
+
+# Specifies the `worker_timeout` threshold that Puma will use to wait before
+# terminating a worker in development environments.
+#
+worker_timeout 3600 if ENV.fetch("RAILS_ENV", "development") == "development"
+
+# Specifies the `port` that Puma will listen on to receive requests; default is 3000.
+#
+port ENV.fetch("PORT") { 3000 }
+
+# Specifies the `environment` that Puma will run in.
+#
+environment ENV.fetch("RAILS_ENV") { "development" }
+
+# Specifies the `pidfile` that Puma will use.
+pidfile ENV.fetch("PIDFILE") { "tmp/pids/server.pid" }
+
+# Specifies the number of `workers` to boot in clustered mode.
+# Workers are forked web server processes. If using threads and workers together
+# the concurrency of the application would be max `threads` * `workers`.
+# Workers do not work on JRuby or Windows (both of which do not support
+# processes).
+#
+# workers ENV.fetch("WEB_CONCURRENCY") { 2 }
+
+# Use the `preload_app!` method when specifying a `workers` number.
+# This directive tells Puma to first boot the application and load code
+# before forking the application. This takes advantage of Copy On Write
+# process behavior so workers use less memory.
+#
+# preload_app!
+
+# Allow puma to be restarted by `bin/rails restart` command.
+plugin :tmp_restart
+plugin :solid_queue
+
+solid_queue_mode :async

test/dummy/config/puma_async.rb

@@ -0,0 +1,46 @@
+# Puma can serve each request in a thread from an internal thread pool.
+# The `threads` method setting takes two numbers: a minimum and maximum.
+# Any libraries that use thread pools should be configured to match
+# the maximum value specified for Puma. Default is set to 5 threads for minimum
+# and maximum; this matches the default thread size of Active Record.
+#
+max_threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 }
+min_threads_count = ENV.fetch("RAILS_MIN_THREADS") { max_threads_count }
+threads min_threads_count, max_threads_count
+
+# Specifies the `worker_timeout` threshold that Puma will use to wait before
+# terminating a worker in development environments.
+#
+worker_timeout 3600 if ENV.fetch("RAILS_ENV", "development") == "development"
+
+# Specifies the `port` that Puma will listen on to receive requests; default is 3000.
+#
+port ENV.fetch("PORT") { 3000 }
+
+# Specifies the `environment` that Puma will run in.
+#
+environment ENV.fetch("RAILS_ENV") { "development" }
+
+# Specifies the `pidfile` that Puma will use.
+pidfile ENV.fetch("PIDFILE") { "tmp/pids/server.pid" }
+
+# Specifies the number of `workers` to boot in clustered mode.
+# Workers are forked web server processes. If using threads and workers together
+# the concurrency of the application would be max `threads` * `workers`.
+# Workers do not work on JRuby or Windows (both of which do not support
+# processes).
+#
+# workers ENV.fetch("WEB_CONCURRENCY") { 2 }
+
+# Use the `preload_app!` method when specifying a `workers` number.
+# This directive tells Puma to first boot the application and load code
+# before forking the application. This takes advantage of Copy On Write
+# process behavior so workers use less memory.
+#
+# preload_app!
+
+# Allow puma to be restarted by `bin/rails restart` command.
+plugin :tmp_restart
+plugin :solid_queue
+
+solid_queue_mode :fork

test/dummy/config/puma_fork.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require_relative "plugin_testing"
+
+class PluginAsyncTest < ActiveSupport::TestCase
+  include PluginTesting
+
+  private
+    def solid_queue_mode
+      :async
+    end
+end

test/integration/puma/plugin_async_test.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require_relative "plugin_testing"
+
+class PluginForkTest < ActiveSupport::TestCase
+  include PluginTesting
+
+  test "stop puma when solid queue's supervisor dies" do
+    supervisor = find_processes_registered_as("Supervisor(fork)").first
+
+    signal_process(supervisor.pid, :KILL)
+    wait_for_process_termination_with_timeout(@pid)
+
+    assert_not process_exists?(@pid)
+  end
+
+  private
+    def solid_queue_mode
+      :fork
+    end
+end

test/integration/puma/plugin_fork_test.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+module PluginTesting
+  extend ActiveSupport::Concern
+  extend ActiveSupport::Testing::Declarative
+
+  included do
+    self.use_transactional_tests = false
+
+    setup do
+      FileUtils.mkdir_p Rails.root.join("tmp", "pids")
+
+      Dir.chdir("test/dummy") do
+        cmd = %W[
+          bundle exec puma
+            -b tcp://127.0.0.1:9222
+            -C config/puma_#{solid_queue_mode}.rb
+            -s
+            config.ru
+        ]
+
+        @pid = fork do
+          exec(*cmd)
+        end
+      end
+
+      wait_for_registered_processes(4, timeout: 3.second)
+    end
+
+    teardown do
+      terminate_process(@pid, signal: :INT) if process_exists?(@pid)
+
+      wait_for_registered_processes 0, timeout: 1.second
+
+      JobResult.delete_all
+    end
+  end
+
+  test "perform jobs inside puma's process" do
+    StoreResultJob.perform_later(:puma_plugin)
+
+    wait_for_jobs_to_finish_for(1.second)
+    assert_equal 1, JobResult.where(queue_name: :background, status: "completed", value: :puma_plugin).count
+  end
+
+  test "stop the queue on puma's restart" do
+    signal_process(@pid, :SIGUSR2)
+    # Ensure the restart finishes before we try to continue with the test
+    wait_for_registered_processes(0, timeout: 3.second)
+    wait_for_registered_processes(4, timeout: 3.second)
+
+    StoreResultJob.perform_later(:puma_plugin)
+    wait_for_jobs_to_finish_for(2.seconds)
+    assert_equal 1, JobResult.where(queue_name: :background, status: "completed", value: :puma_plugin).count
+  end
+
+  private
+    def solid_queue_mode
+      raise NotImplementedError
+    end
+end