Move queue classes to ActiveSupport

3 files changed, 228 insertions, 0 deletions

diff --git a/activesupport/test/queueing/container_test.rb b/activesupport/test/queueing/container_test.rb
new file mode 100644
index 0000000000..7afc11e7a9
--- /dev/null
+++ b/activesupport/test/queueing/container_test.rb
@@ -0,0 +1,28 @@
+require 'abstract_unit'
+require 'active_support/queueing'
+
+module ActiveSupport
+  class ContainerTest < ActiveSupport::TestCase
+    def test_delegates_to_default
+      q         = Queue.new
+      container = QueueContainer.new q
+      job       = Object.new
+
+      container.push job
+      assert_equal job, q.pop
+    end
+
+    def test_access_default
+      q         = Queue.new
+      container = QueueContainer.new q
+      assert_equal q, container[:default]
+    end
+
+    def test_assign_queue
+      container = QueueContainer.new Object.new
+      q         = Object.new
+      container[:foo] = q
+      assert_equal q, container[:foo]
+    end
+  end
+end
diff --git a/activesupport/test/queueing/test_queue_test.rb b/activesupport/test/queueing/test_queue_test.rb
new file mode 100644
index 0000000000..4c08314366
--- /dev/null
+++ b/activesupport/test/queueing/test_queue_test.rb
@@ -0,0 +1,102 @@
+require 'abstract_unit'
+require 'active_support/queueing'
+
+class TestQueueTest < ActiveSupport::TestCase
+  def setup
+    @queue = ActiveSupport::TestQueue.new
+  end
+
+  class ExceptionRaisingJob
+    def run
+      raise
+    end
+  end
+
+  def test_drain_raises
+    @queue.push ExceptionRaisingJob.new
+    assert_raises(RuntimeError) { @queue.drain }
+  end
+
+  def test_jobs
+    @queue.push 1
+    @queue.push 2
+    assert_equal [1,2], @queue.jobs
+  end
+
+  class EquivalentJob
+    def initialize
+      @initial_id = self.object_id
+    end
+
+    def run
+    end
+
+    def ==(other)
+      other.same_initial_id?(@initial_id)
+    end
+
+    def same_initial_id?(other_id)
+      other_id == @initial_id
+    end
+  end
+
+  def test_contents
+    assert @queue.empty?
+    job = EquivalentJob.new
+    @queue.push job
+    refute @queue.empty?
+    assert_equal job, @queue.pop
+  end
+
+  class ProcessingJob
+    def self.clear_processed
+      @processed = []
+    end
+
+    def self.processed
+      @processed
+    end
+
+    def initialize(object)
+      @object = object
+    end
+
+    def run
+      self.class.processed << @object
+    end
+  end
+
+  def test_order
+    ProcessingJob.clear_processed
+    job1 = ProcessingJob.new(1)
+    job2 = ProcessingJob.new(2)
+
+    @queue.push job1
+    @queue.push job2
+    @queue.drain
+
+    assert_equal [1,2], ProcessingJob.processed
+  end
+
+  class ThreadTrackingJob
+    attr_reader :thread_id
+
+    def run
+      @thread_id = Thread.current.object_id
+    end
+
+    def ran?
+      @thread_id
+    end
+  end
+
+  def test_drain
+    @queue.push ThreadTrackingJob.new
+    job = @queue.jobs.last
+    @queue.drain
+
+    assert @queue.empty?
+    assert job.ran?, "The job runs synchronously when the queue is drained"
+    assert_not_equal job.thread_id, Thread.current.object_id
+  end
+end
diff --git a/activesupport/test/queueing/threaded_consumer_test.rb b/activesupport/test/queueing/threaded_consumer_test.rb
new file mode 100644
index 0000000000..20a1cc4e8e
--- /dev/null
+++ b/activesupport/test/queueing/threaded_consumer_test.rb
@@ -0,0 +1,98 @@
+require 'abstract_unit'
+require 'active_support/queueing'
+require "active_support/log_subscriber/test_helper"
+
+class TestThreadConsumer < ActiveSupport::TestCase
+  class Job
+    attr_reader :id
+    def initialize(id, &block)
+      @id = id
+      @block = block
+    end
+
+    def run
+      @block.call if @block
+    end
+  end
+
+  def setup
+    @queue = ActiveSupport::Queue.new
+    @logger = ActiveSupport::LogSubscriber::TestHelper::MockLogger.new
+    @consumer = ActiveSupport::ThreadedQueueConsumer.start(@queue, @logger)
+  end
+
+  def teardown
+    @queue.push nil
+  end
+
+  test "the jobs are executed" do
+    ran = false
+
+    job = Job.new(1) do
+      ran = true
+    end
+
+    @queue.push job
+    sleep 0.1
+    assert_equal true, ran
+  end
+
+  test "the jobs are not executed synchronously" do
+    ran = false
+
+    job = Job.new(1) do
+      sleep 0.1
+      ran = true
+    end
+
+    @queue.push job
+    assert_equal false, ran
+  end
+
+  test "shutting down the queue synchronously drains the jobs" do
+    ran = false
+
+    job = Job.new(1) do
+      sleep 0.1
+      ran = true
+    end
+
+    @queue.push job
+    assert_equal false, ran
+
+    @consumer.shutdown
+
+    assert_equal true, ran
+  end
+
+  test "log job that raises an exception" do
+    job = Job.new(1) do
+      raise "RuntimeError: Error!"
+    end
+
+    @queue.push job
+    sleep 0.1
+
+    assert_equal 1, @logger.logged(:error).size
+    assert_match(/Job Error: RuntimeError: Error!/, @logger.logged(:error).last)
+  end
+
+  test "test overriding exception handling" do
+    @consumer.shutdown
+    @consumer = Class.new(ActiveSupport::ThreadedQueueConsumer) do
+      attr_reader :last_error
+      def handle_exception(e)
+        @last_error = e.message
+      end
+    end.start(@queue)
+
+    job = Job.new(1) do
+      raise "RuntimeError: Error!"
+    end
+
+    @queue.push job
+    sleep 0.1
+
+    assert_equal "RuntimeError: Error!", @consumer.last_error
+  end
+end