backburner-allq 1.0.0

data/test/hooks_test.rb

@@ -0,0 +1,112 @@
+require File.expand_path('../test_helper', __FILE__)
+require File.expand_path('../fixtures/hooked', __FILE__)
+
+describe "Backburner::Hooks module" do
+  before do
+    $hooked_fail_count = 0
+    @hooks = Backburner::Hooks
+  end
+
+  describe "for invoke_hook_events method" do
+    describe "with before_enqueue" do
+      it "should support successful invocation" do
+        out = silenced { @res = @hooks.invoke_hook_events(HookedObjectSuccess, :before_enqueue, 5, 6) }
+        assert_equal [nil, nil], @res
+        assert_match(/!!before_enqueue_foo!! \[5\, 6\]/, out)
+        assert_match(/!!before_enqueue_bar!! \[5\, 6\]/, out)
+      end
+
+      it "should support fail case" do
+        out = silenced { @res = @hooks.invoke_hook_events(HookedObjectBeforeEnqueueFail, :before_enqueue, 5, 6) }
+        assert_equal false, @res
+        assert_match(/!!before_enqueue_foo!! \[5\, 6\]/, out)
+      end
+    end # before_enqueue
+
+    describe "with after_enqueue" do
+      it "should support successful invocation" do
+        out = silenced { @hooks.invoke_hook_events(HookedObjectSuccess, :after_enqueue, 7, 8) }
+        assert_match(/!!after_enqueue_foo!! \[7\, 8\]/, out)
+        assert_match(/!!after_enqueue_bar!! \[7\, 8\]/, out)
+      end
+
+      it "should support fail case" do
+        assert_raises(HookFailError) do
+          silenced { @res = @hooks.invoke_hook_events(HookedObjectAfterEnqueueFail, :after_enqueue, 5, 6) }
+        end
+      end
+    end # after_enqueue
+
+    describe "with before_perform" do
+      it "should support successful invocation" do
+        out = silenced { @hooks.invoke_hook_events(HookedObjectSuccess, :before_perform, 1, 2) }
+        assert_match(/!!before_perform_foo!! \[1\, 2\]/, out)
+      end
+
+      it "should support fail case" do
+        out = silenced { @res = @hooks.invoke_hook_events(HookedObjectBeforePerformFail, :before_perform, 5, 6) }
+        assert_equal false, @res
+        assert_match(/!!before_perform_foo!! \[5\, 6\]/, out)
+      end
+    end # before_perform
+
+    describe "with after_perform" do
+      it "should support successful invocation" do
+        out = silenced { @hooks.invoke_hook_events(HookedObjectSuccess, :after_perform, 3, 4) }
+        assert_match(/!!after_perform_foo!! \[3\, 4\]/, out)
+      end
+
+      it "should support fail case" do
+        assert_raises(HookFailError) do
+          silenced { @res = @hooks.invoke_hook_events(HookedObjectAfterPerformFail, :after_perform, 5, 6) }
+        end
+      end
+    end # after_perform
+
+    describe "with on_failure" do
+      it "should support successful invocation" do
+        out = silenced { @hooks.invoke_hook_events(HookedObjectSuccess, :on_failure, RuntimeError, 10) }
+        assert_match(/!!on_failure_foo!! RuntimeError \[10\]/, out)
+      end
+    end # on_failure
+
+    describe 'with on_retry' do
+      it "should support successful invocation" do
+        out = silenced { @hooks.invoke_hook_events(HookedObjectSuccess, :on_retry, 1, 0, 10) }
+        assert_match(/!!on_retry_foo!! 1 0 \[10\]/, out)
+      end
+    end
+
+    describe 'with on_bury' do
+      it "should support successful invocation" do
+        out = silenced { @hooks.invoke_hook_events(HookedObjectSuccess, :on_bury, 10) }
+        assert_match(/!!on_bury_foo!! \[10\]/, out)
+      end
+    end
+
+    describe "with on_reconnect" do
+      it "should support successful invocation" do
+        out = silenced { @hooks.invoke_hook_events(HookedWorker.new, :on_reconnect)}
+        assert_match(/!!on_reconnect!!/, out)
+      end
+    end
+  end # invoke_hook_events
+
+  describe "for around_hook_events method" do
+    describe "with around_perform" do
+      it "should support successful invocation" do
+        out = silenced do
+          @hooks.around_hook_events(HookedObjectSuccess, :around_perform, 7, 8) {
+            puts "!!FIRED!!"
+          }
+        end
+        assert_match(/BEGIN.*?bar.*BEGIN.*cat.*FIRED.*END.*cat.*END.*bar/m, out)
+        assert_match(/!!BEGIN around_perform_bar!! \[7\, 8\]/, out)
+        assert_match(/!!BEGIN around_perform_cat!! \[7\, 8\]/, out)
+        assert_match(/!!FIRED!!/, out)
+        assert_match(/!!END around_perform_cat!! \[7\, 8\]/, out)
+        assert_match(/!!END around_perform_bar!! \[7\, 8\]/, out)
+      end
+    end # successful
+  end # around_hook_events
+end # Hooks

data/test/job_test.rb

@@ -0,0 +1,185 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module NestedDemo
+  class TestJobC
+    def self.perform(x); puts "Performed #{x} in #{self}"; end
+  end
+
+  class TestJobD
+    include Backburner::Queue
+    def self.perform(x); raise RuntimeError; end
+  end
+end
+
+describe "Backburner::Job module" do
+  describe "for initialize" do
+    describe "with hash" do
+      before do
+        @task = stub(:body => task_body, :ttr => 120, :delete => true, :bury => true)
+      end
+
+      describe "with string keys" do
+        let(:task_body) { { "class" => "NewsletterSender", "args" => ["foo@bar.com", "bar@foo.com"] } }
+        it "should create job with correct task data" do
+          @job = Backburner::Job.new(@task)
+          assert_equal @task, @job.task
+          assert_equal ["class", "args"], @job.body.keys
+          assert_equal task_body["class"], @job.name
+          assert_equal task_body["args"], @job.args
+        end
+      end
+
+      describe "with symbol keys" do
+        let(:task_body) { { :class => "NewsletterSender", :args => ["foo@bar.com", "bar@foo.com"] } }
+        it "should create job with correct task data" do
+          @job = Backburner::Job.new(@task)
+          assert_equal @task, @job.task
+          assert_equal [:class, :args], @job.body.keys
+          assert_equal task_body[:class], @job.name
+          assert_equal task_body[:args], @job.args
+        end
+      end
+    end # with hash
+
+    describe "with json string" do
+      before do
+        @task_body =  { "class" => "NewsletterSender", "args" => ["foo@bar.com", "bar@foo.com"] }
+        @task = stub(:body => @task_body.to_json, :ttr => 120, :delete => true, :bury => true)
+      end
+
+      it "should create job with correct task data" do
+        @job = Backburner::Job.new(@task)
+        assert_equal @task, @job.task
+        assert_equal ["class", "args"], @job.body.keys
+        assert_equal @task_body["class"], @job.name
+        assert_equal @task_body["args"], @job.args
+      end
+    end # with json
+
+    describe "with invalid string" do
+      before do
+        @task_body =  "^%$*&^*"
+        @task = stub(:body => @task_body, :ttr => 120, :delete => true, :bury => true)
+      end
+
+      it "should raise a job format exception" do
+        assert_raises(Backburner::Job::JobFormatInvalid) {
+          @job = Backburner::Job.new(@task)
+        }
+      end
+    end # invalid
+  end # initialize
+
+  describe "for process method" do
+    describe "with valid task" do
+      before do
+        @task_body =  { "class" => "NestedDemo::TestJobC", "args" => [56] }
+        @task = stub(:body => @task_body, :ttr => 120, :delete => true, :bury => true)
+        @task.expects(:delete).once
+      end
+
+      it "should process task" do
+        @job = Backburner::Job.new(@task)
+        out = silenced(1) { @job.process }
+        assert_match(/Performed 56 in NestedDemo::TestJobC/, out)
+      end # process
+    end # valid
+
+    describe "with invalid task" do
+      before do
+        @task_body =  { "class" => "NestedDemo::TestJobD", "args" => [56] }
+        @task = stub(:body => @task_body, :ttr => 120, :delete => true, :bury => true)
+        @task.expects(:delete).never
+      end
+
+      it "should raise an exception" do
+        @job = Backburner::Job.new(@task)
+        assert_raises(RuntimeError) { @job.process }
+      end # error invalid
+    end # invalid
+
+    describe "with invalid class" do
+      before do
+        @task_body =  { "class" => "NestedDemo::TestJobY", "args" => [56] }
+        @task = stub(:body => @task_body, :ttr => 120, :delete => true, :bury => true)
+        @task.expects(:delete).never
+      end
+
+      it "should raise an exception" do
+        @job = Backburner::Job.new(@task)
+        assert_raises(Backburner::Job::JobNotFound) { @job.process }
+      end # error class
+    end # invalid
+  end # process
+
+  describe "for simple delegation method" do
+    describe "with valid class" do
+      before do
+        @task_body =  { "class" => "NestedDemo::TestJobC", "args" => [56] }
+        @task = stub(:body => @task_body, :ttr => 120, :delete => true, :bury => true)
+        @task.expects(:bury).once
+      end
+
+      it "should call bury for task" do
+        @job = Backburner::Job.new(@task)
+        @job.bury
+      end # bury
+    end
+
+    describe "with invalid class" do
+      before do
+        @task_body = { "class" => "AnUnknownClass", "args" => [] }
+        @task = stub(:body => @task_body, :ttr => 120, :delete => true, :bury => true, :release => true)
+      end
+
+      it "should call bury for task" do
+        @task.expects(:bury).once
+        @job = Backburner::Job.new(@task)
+        Backburner::Hooks.expects(:invoke_hook_events)
+          .with("AnUnknownClass", :on_bury, anything)
+        @job.bury
+      end
+
+      it "should call retry for task" do
+        @task.expects(:release).once
+        @job = Backburner::Job.new(@task)
+        Backburner::Hooks.expects(:invoke_hook_events)
+          .with("AnUnknownClass", :on_retry, 0, is_a(Integer), anything)
+        @job.retry(0, 0)
+      end
+    end
+  end # simple delegation
+
+  describe "timing out for various values of ttr" do
+    before do
+      @task_body = { "class" => "NestedDemo::TestJobC", "args" => [56] }
+    end
+
+    describe "when ttr == 0" do
+      it "should use 0 for the timeout" do
+        @task = stub(:body => @task_body, :delete => true, :ttr => 0)
+        @job = Backburner::Job.new(@task)
+        Timeout.expects(:timeout).with(0)
+        @job.process
+      end
+    end
+
+    describe "when ttr == 1" do
+      it "should use 1 for the timeout" do
+        @task = stub(:body => @task_body, :delete => true, :ttr => 1)
+        @job = Backburner::Job.new(@task)
+        Timeout.expects(:timeout).with(1)
+        @job.process
+      end
+    end
+
+    describe "when ttr > 1" do
+      it "should use ttr-1 for the timeout" do
+        @task = stub(:body => @task_body, :delete => true, :ttr => 2)
+        @job = Backburner::Job.new(@task)
+        Timeout.expects(:timeout).with(1)
+        @job.process
+      end
+    end
+  end
+end

data/test/logger_test.rb

@@ -0,0 +1,44 @@
+require File.expand_path('../test_helper', __FILE__)
+
+describe "Backburner::Logger module" do
+  include Backburner::Logger
+
+  before do
+    @strio = StringIO.new
+    @logger = Logger.new(@strio)
+  end
+
+  describe "for log_info method" do
+    it "prints out to std out" do
+      output = capture_stdout { log_info("foo") }
+      assert_equal "foo\n", output
+    end
+
+    it "can be configured to log to logger" do
+      Backburner.configure { |config| config.logger = @logger }
+      log_info("foo")
+      assert_match(/I,.*?foo/, @strio.string)
+    end
+
+    after do
+      Backburner.configure { |config| config.logger = nil }
+    end
+  end # log_info
+
+  describe "for log_error method" do
+    it "prints out to std err" do
+      output = capture_stdout { log_error("bar") }
+      assert_equal "bar\n", output
+    end
+
+    it "can be configured to log to logger" do
+      Backburner.configure { |config| config.logger = @logger }
+      log_error("bar")
+      assert_match(/E,.*?bar/, @strio.string)
+    end
+
+    after do
+      Backburner.configure { |config| config.logger = nil }
+    end
+  end # log_error
+end

data/test/performable_test.rb

@@ -0,0 +1,88 @@
+require File.expand_path('../test_helper', __FILE__)
+
+class TestObj
+  ID = 56
+  def id; ID; end
+  def self.find(id); TestObj.new if id == ID; end
+  def foo(state, state2); "bar #{state} #{state2}"; end
+  def self.bar(state, state2); "baz #{state} #{state2}"; end
+end
+
+class PerformableTestObj < TestObj
+  include Backburner::Performable
+end
+
+class AutomagicTestObj < TestObj
+  # Don't include Backburner::Performable because it should be automagically included
+  def qux(state, state2); "garply #{state} #{state2}" end
+  def self.garply(state, state2); "thud #{state} #{state2}" end
+  def qux?; "garply!" end
+end
+
+class AsyncInstanceMethodsTestObj < PerformableTestObj; end
+class AsyncStaticMethodsTestObj < PerformableTestObj; end
+
+
+
+describe "Backburner::Performable module" do
+  after { ENV["TEST"] = nil }
+
+  describe "for async instance method" do
+    it "should invoke worker enqueue" do
+      Backburner::Worker.expects(:enqueue).with(PerformableTestObj, [56, :foo, true, false], has_entries(:pri => 5000, :queue => "foo"))
+      PerformableTestObj.new.async(:pri => 5000, :queue => "foo").foo(true, false)
+    end
+  end # async instance
+
+  describe "for async class method" do
+    it "should invoke worker enqueue" do
+      Backburner::Worker.expects(:enqueue).with(PerformableTestObj, [nil, :bar, true, false], has_entries(:pri => 5000, :queue => "foo"))
+      PerformableTestObj.async(:pri => 5000, :queue => "foo").bar(true, false)
+    end
+  end # async class
+
+  describe "for perform class method" do
+    it "should work for instance" do
+      assert_equal "bar true false", PerformableTestObj.perform(PerformableTestObj::ID, :foo, true, false)
+    end # instance
+
+    it "should work for class level" do
+      assert_equal "baz false true", PerformableTestObj.perform(nil, :bar, false, true)
+    end # class
+  end # perform
+
+  describe "for handle_asynchronously class method" do
+    it "should automagically asynchronously proxy calls to the method" do
+      Backburner::Performable.handle_asynchronously(AutomagicTestObj, :qux, :pri => 5000, :queue => "qux")
+
+      Backburner::Worker.expects(:enqueue).with(AutomagicTestObj, [56, :qux_without_async, true, false], has_entries(:pri => 5000, :queue => "qux"))
+      AutomagicTestObj.new.qux(true, false)
+    end
+
+    it "should work for class methods, too" do
+      Backburner::Performable.handle_static_asynchronously(AutomagicTestObj, :garply, :pri => 5000, :queue => "garply")
+
+      Backburner::Worker.expects(:enqueue).with(AutomagicTestObj, [nil, :garply_without_async, true, false], has_entries(:pri => 5000, :queue => "garply"))
+      AutomagicTestObj.garply(true, false)
+    end
+
+    it "should correctly handle punctuation" do
+      Backburner::Performable.handle_asynchronously(AutomagicTestObj, :qux?)
+
+      Backburner::Worker.expects(:enqueue).with(AutomagicTestObj, [56, :qux_without_async?], {})
+      AutomagicTestObj.new.qux?
+    end
+
+    it "should be available for instance methods on any class that includes the Performable module" do
+      AsyncInstanceMethodsTestObj.handle_asynchronously :foo, pri: 5000, queue: 'qux'
+      Backburner::Worker.expects(:enqueue).with(AsyncInstanceMethodsTestObj, [56, :foo_without_async, true, false], has_entries(:pri => 5000, :queue => "qux"))
+      AsyncInstanceMethodsTestObj.new.foo(true, false)
+    end
+
+    it "should be available for class methods on any class that includes the Performable module" do
+      AsyncStaticMethodsTestObj.handle_static_asynchronously :bar, pri: 5000, queue: 'garply'
+      Backburner::Worker.expects(:enqueue).with(AsyncStaticMethodsTestObj, [nil, :bar_without_async, true, false], has_entries(:pri => 5000, :queue => "garply"))
+      AsyncStaticMethodsTestObj.bar(true, false)
+    end
+  end
+end

data/test/queue_test.rb

@@ -0,0 +1,69 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module NestedDemo
+  class TestJobA; include Backburner::Queue; end
+  class TestJobB; include Backburner::Queue; end
+end
+
+describe "Backburner::Queue module" do
+  describe "contains known_queue_classes" do
+    it "has all defined known queues" do
+      assert_contains Backburner::Worker.known_queue_classes, NestedDemo::TestJobA
+      assert_contains Backburner::Worker.known_queue_classes, NestedDemo::TestJobB
+    end
+  end
+
+  describe "for queue method accessor" do
+    it "should return the queue name" do
+      assert_equal Backburner.configuration.primary_queue, NestedDemo::TestJobA.queue
+    end
+  end # queue_name
+
+  describe "for queue assignment method" do
+    it "should allow queue name to be assigned" do
+      NestedDemo::TestJobB.queue("nested/job")
+      assert_equal "nested/job", NestedDemo::TestJobB.queue
+    end
+
+    it "should allow lambdas" do
+      NestedDemo::TestJobB.queue(lambda { |klass| klass.name })
+      assert_equal "NestedDemo::TestJobB", NestedDemo::TestJobB.queue
+    end
+  end # queue
+
+  describe "for queue_priority assignment method" do
+    it "should allow queue priority to be assigned" do
+      NestedDemo::TestJobB.queue_priority(1000)
+      assert_equal 1000, NestedDemo::TestJobB.queue_priority
+    end
+  end # queue_priority
+
+  describe "for queue_respond_timeout assignment method" do
+    it "should allow queue respond_timeout to be assigned" do
+      NestedDemo::TestJobB.queue_respond_timeout(300)
+      assert_equal 300, NestedDemo::TestJobB.queue_respond_timeout
+    end
+  end # queue_respond_timeout
+
+  describe "for queue_max_job_retries assignment method" do
+    it "should allow queue max_job_retries to be assigned" do
+      NestedDemo::TestJobB.queue_max_job_retries(5)
+      assert_equal 5, NestedDemo::TestJobB.queue_max_job_retries
+    end
+  end # queue_max_job_retries
+
+  describe "for queue_retry_delay assignment method" do
+    it "should allow queue retry_delay to be assigned" do
+      NestedDemo::TestJobB.queue_retry_delay(300)
+      assert_equal 300, NestedDemo::TestJobB.queue_retry_delay
+    end
+  end # queue_retry_delay
+
+  describe "for queue_retry_delay_proc assignment method" do
+    it "should allow queue retry_delay_proc to be assigned" do
+      retry_delay_proc = lambda { |x, y| x - y }
+      NestedDemo::TestJobB.queue_retry_delay_proc(retry_delay_proc)
+      assert_equal retry_delay_proc.call(2, 1), NestedDemo::TestJobB.queue_retry_delay_proc.call(2, 1)
+    end
+  end # queue_retry_delay_proc
+end # Backburner::Queue