powerhome-resque-status 0.6.0

data/test/test_resque_plugins_status.rb

@@ -0,0 +1,358 @@
+require 'test_helper'
+
+class TestResquePluginsStatus < Minitest::Test
+
+  describe "Resque::Plugins::Status" do
+    before do
+      Resque.redis.flushall
+    end
+
+    describe ".create" do
+      describe "not inline" do
+        before do
+          @uuid = WorkingJob.create('num' => 100)
+        end
+
+        it "add the job to the queue" do
+          assert_equal 1, Resque.size(:statused)
+        end
+
+        it "set the queued object to the current class" do
+          job = Resque.pop(:statused)
+          assert_equal @uuid, job['args'].first
+          assert_equal "WorkingJob", job['class']
+        end
+
+        it "add the uuid to the statuses" do
+          assert_includes Resque::Plugins::Status::Hash.status_ids, @uuid
+        end
+
+        it "return a UUID" do
+          assert_match(/^\w{32}$/, @uuid)
+        end
+      end
+
+      describe "inline" do
+        before do
+          Resque.stubs(:inline?).returns(true)
+        end
+
+        it "not queue a job" do
+          @uuid = WorkingJob.create('num' => 100)
+          assert_equal 0, Resque.size(:statused)
+        end
+
+        it "call perform" do
+          WorkingJob.any_instance.expects(:perform).once
+          @uuid = WorkingJob.create('num' => 100)
+        end
+      end
+    end
+
+    describe ".create with a failing before_enqueue hook" do
+      before do
+        @size = Resque.size(:statused)
+        @status_ids_size = Resque::Plugins::Status::Hash.status_ids.length
+        @res = NeverQueuedJob.create(:num => 100)
+      end
+
+      it "return nil" do
+        assert_equal nil, @res
+      end
+
+      it "not create a status" do
+        assert_equal @size, Resque.size(:statused)
+      end
+
+      it "not add the uuid to the statuses" do
+        assert_equal @status_ids_size, Resque::Plugins::Status::Hash.status_ids.length
+      end
+    end
+
+    describe ".scheduled" do
+      before do
+        @job_args = {'num' => 100}
+        @uuid = WorkingJob.scheduled(:queue_name, WorkingJob, @job_args)
+      end
+
+      it "create the job with the provided arguments" do
+        job = Resque.pop(:queue_name)
+        assert_equal @job_args, job['args'].last
+      end
+    end
+
+    describe ".enqueue" do
+      it "delegate to enqueue_to, filling in the queue from the class" do
+        @uuid = BasicJob.enqueue(WorkingJob, :num => 100)
+        @payload = Resque.pop(:statused)
+        assert_equal "WorkingJob", @payload['class']
+      end
+    end
+
+    describe ".enqueue_to" do
+      before do
+        @uuid = BasicJob.enqueue_to(:new_queue, WorkingJob, :num => 100)
+        @payload = Resque.pop(:new_queue)
+      end
+
+      it "add the job with the specific class to the queue" do
+        assert_equal "WorkingJob", @payload['class']
+      end
+
+      it "add the arguments to the options hash" do
+        assert_equal @uuid, @payload['args'].first
+      end
+
+      it "add the uuid to the statuses" do
+        assert_includes Resque::Plugins::Status::Hash.status_ids, @uuid
+      end
+
+      it "return UUID" do
+        assert_match(/^\w{32}$/, @uuid)
+      end
+
+    end
+
+    describe ".dequeue" do
+      before do
+        @uuid1 = BasicJob.enqueue(WorkingJob, :num => 100)
+        @uuid2 = BasicJob.enqueue(WorkingJob, :num => 100)
+      end
+
+      it "dequeue the job with the uuid from the correct queue" do
+        size = Resque.size(:statused)
+        BasicJob.dequeue(WorkingJob, @uuid2)
+        assert_equal size-1, Resque.size(:statused)
+      end
+      it "not dequeue any jobs with different uuids for same class name" do
+        BasicJob.dequeue(WorkingJob, @uuid2)
+        assert_equal @uuid1, Resque.pop(:statused)['args'].first
+      end
+    end
+
+    describe ".perform" do
+      let(:expectation) { }
+
+      before do
+        expectation
+        @uuid      = WorkingJob.create(:num => 100)
+        @payload   = Resque.pop(:statused)
+        @performed = WorkingJob.perform(*@payload['args'])
+      end
+
+      it "load load a new instance of the klass" do
+        assert @performed.is_a?(WorkingJob)
+      end
+
+      it "set the uuid" do
+        assert_equal @uuid, @performed.uuid
+      end
+
+      it "set the status" do
+        assert @performed.status.is_a?(Resque::Plugins::Status::Hash)
+        assert_equal 'WorkingJob({"num"=>100})', @performed.status.name
+      end
+
+      describe "before" do
+        let(:expectation) { WorkingJob.any_instance.expects(:perform).once }
+        it("call perform on the inherited class") {}
+      end
+    end
+
+    describe "manually failing a job" do
+      before do
+        @uuid      = FailureJob.create(:num => 100)
+        @payload   = Resque.pop(:statused)
+        @performed = FailureJob.perform(*@payload['args'])
+      end
+
+      it "load load a new instance of the klass" do
+        assert @performed.is_a?(FailureJob)
+      end
+
+      it "set the uuid" do
+        assert_equal @uuid, @performed.uuid
+      end
+
+      it "set the status" do
+        assert @performed.status.is_a?(Resque::Plugins::Status::Hash)
+        assert_equal 'FailureJob({"num"=>100})', @performed.status.name
+      end
+
+      it "be failed" do
+        assert_match(/failure/, @performed.status.message)
+        assert @performed.status.failed?
+      end
+
+    end
+
+    describe "killing a job" do
+      before do
+        @uuid      = KillableJob.create(:num => 100)
+        @payload   = Resque.pop(:statused)
+        Resque::Plugins::Status::Hash.kill(@uuid)
+        assert_includes Resque::Plugins::Status::Hash.kill_ids, @uuid
+        @performed = KillableJob.perform(*@payload['args'])
+        @status = Resque::Plugins::Status::Hash.get(@uuid)
+      end
+
+      it "set the status to killed" do
+        assert @status.killed?
+        assert !@status.completed?
+      end
+
+      it "only perform iterations up to kill" do
+        assert_equal 1, Resque.redis.get("#{@uuid}:iterations").to_i
+      end
+
+      it "not persist the kill key" do
+        refute_includes Resque::Plugins::Status::Hash.kill_ids, @uuid
+      end
+    end
+
+    describe "killing all jobs" do
+      before do
+        @uuid1    = KillableJob.create(:num => 100)
+        @uuid2    = KillableJob.create(:num => 100)
+
+        Resque::Plugins::Status::Hash.killall
+
+        assert_includes Resque::Plugins::Status::Hash.kill_ids, @uuid1
+        assert_includes Resque::Plugins::Status::Hash.kill_ids, @uuid2
+
+        @payload1   = Resque.pop(:statused)
+        @payload2   = Resque.pop(:statused)
+
+        @performed = KillableJob.perform(*@payload1['args'])
+        @performed = KillableJob.perform(*@payload2['args'])
+
+        @status1, @status2 = Resque::Plugins::Status::Hash.mget([@uuid1, @uuid2])
+      end
+
+      it "set the status to killed" do
+        assert @status1.killed?
+        assert !@status1.completed?
+        assert @status2.killed?
+        assert !@status2.completed?
+      end
+
+      it "only perform iterations up to kill" do
+        assert_equal 1, Resque.redis.get("#{@uuid1}:iterations").to_i
+        assert_equal 1, Resque.redis.get("#{@uuid2}:iterations").to_i
+      end
+
+      it "not persist the kill key" do
+        refute_includes Resque::Plugins::Status::Hash.kill_ids, @uuid1
+        refute_includes Resque::Plugins::Status::Hash.kill_ids, @uuid2
+      end
+
+    end
+
+    describe "invoking killall jobs to kill a range" do
+      before do
+        @uuid1    = KillableJob.create(:num => 100)
+        @uuid2    = KillableJob.create(:num => 100)
+
+        Resque::Plugins::Status::Hash.killall(0,0) # only @uuid2 it be killed
+
+        refute_includes Resque::Plugins::Status::Hash.kill_ids, @uuid1
+        assert_includes Resque::Plugins::Status::Hash.kill_ids, @uuid2
+
+        @payload1   = Resque.pop(:statused)
+        @payload2   = Resque.pop(:statused)
+
+        @performed = KillableJob.perform(*@payload1['args'])
+        @performed = KillableJob.perform(*@payload2['args'])
+
+        @status1, @status2 = Resque::Plugins::Status::Hash.mget([@uuid1, @uuid2])
+      end
+
+      it "set the status to killed" do
+        assert !@status1.killed?
+        assert @status1.completed?
+        assert @status2.killed?
+        assert !@status2.completed?
+      end
+
+      it "only perform iterations up to kill" do
+        assert_equal 100, Resque.redis.get("#{@uuid1}:iterations").to_i
+        assert_equal 1, Resque.redis.get("#{@uuid2}:iterations").to_i
+      end
+
+      it "not persist the kill key" do
+        refute_includes Resque::Plugins::Status::Hash.kill_ids, @uuid1
+        refute_includes Resque::Plugins::Status::Hash.kill_ids, @uuid2
+      end
+
+    end
+
+    describe "with an invoked job" do
+      before do
+        @job = WorkingJob.new('123', {'num' => 100})
+      end
+
+      describe "#at" do
+        before do
+          @job.at(50, 100, "At 50%")
+        end
+
+        it "calculate percent" do
+          assert_equal 50, @job.status.pct_complete
+        end
+
+        it "set status" do
+          assert @job.status.working?
+        end
+
+        it "save message" do
+          assert_equal "At 50%", @job.status.message
+        end
+      end
+
+      describe "#failed" do
+        before do
+          @job.failed("OOOOPS!")
+        end
+
+        it "set status" do
+          assert @job.status.failed?
+        end
+
+        it "set message" do
+          assert_equal "OOOOPS!", @job.status.message
+        end
+      end
+
+      describe "#completed" do
+        before do
+          @job.completed
+        end
+
+        it "set status" do
+          assert @job.status.completed?
+        end
+
+        it "set message" do
+          assert_match(/complete/i, @job.status.message)
+        end
+
+      end
+
+      describe "#safe_perform!" do
+        before do
+          @job = ErrorJob.new("123")
+          assert_raises(RuntimeError) do
+            @job.safe_perform!
+          end
+        end
+
+        it "set status as failed" do
+          assert @job.status.failed?
+        end
+      end
+
+    end
+
+  end
+
+end

data/test/test_resque_plugins_status_hash.rb

@@ -0,0 +1,222 @@
+require 'test_helper'
+
+class TestResquePluginsStatusHash < Minitest::Test
+
+  describe "Resque::Plugins::Status::Hash" do
+    before do
+      Resque.redis.flushall
+      Resque::Plugins::Status::Hash.expire_in = nil
+      @uuid = Resque::Plugins::Status::Hash.create(Resque::Plugins::Status::Hash.generate_uuid)
+      Resque::Plugins::Status::Hash.set(@uuid, "my status")
+      @uuid_with_json = Resque::Plugins::Status::Hash.create(Resque::Plugins::Status::Hash.generate_uuid, {"im" => "json"})
+    end
+
+    describe ".get" do
+      it "return the status as a Resque::Plugins::Status::Hash for the uuid" do
+        status = Resque::Plugins::Status::Hash.get(@uuid)
+        assert status.is_a?(Resque::Plugins::Status::Hash)
+        assert_equal 'my status', status.message
+      end
+
+      it "return nil if the status is not set" do
+        assert_nil Resque::Plugins::Status::Hash.get('invalid_uuid')
+      end
+
+      it "decode encoded json" do
+        assert_equal("json", Resque::Plugins::Status::Hash.get(@uuid_with_json)['im'])
+      end
+    end
+
+    describe ".mget" do
+      it "return statuses as array of Resque::Plugins::Status::Hash for the uuids" do
+        uuid2 = Resque::Plugins::Status::Hash.create(Resque::Plugins::Status::Hash.generate_uuid)
+        Resque::Plugins::Status::Hash.set(uuid2, "my status2")
+        statuses = Resque::Plugins::Status::Hash.mget([@uuid, uuid2])
+        assert_equal 2, statuses.size
+        assert statuses.all?{|s| s.is_a?(Resque::Plugins::Status::Hash) }
+        assert_equal ['my status', 'my status2'], statuses.map(&:message)
+      end
+
+      it "return nil if a status is not set" do
+        statuses = Resque::Plugins::Status::Hash.mget(['invalid_uuid', @uuid])
+        assert_equal 2, statuses.size
+        assert_nil statuses[0]
+        assert statuses[1].is_a?(Resque::Plugins::Status::Hash)
+        assert_equal 'my status', statuses[1].message
+      end
+
+      it "decode encoded json" do
+        assert_equal ['json'],
+          Resque::Plugins::Status::Hash.mget([@uuid_with_json]).map{|h| h['im']}
+      end
+    end
+
+    describe ".set" do
+
+      it "set the status for the uuid" do
+        assert Resque::Plugins::Status::Hash.set(@uuid, "updated")
+        assert_equal "updated", Resque::Plugins::Status::Hash.get(@uuid).message
+      end
+
+      it "return the status" do
+        assert Resque::Plugins::Status::Hash.set(@uuid, "updated").is_a?(Resque::Plugins::Status::Hash)
+      end
+
+    end
+
+    describe ".create" do
+      it "add an item to a key set" do
+        before = Resque::Plugins::Status::Hash.status_ids.length
+        Resque::Plugins::Status::Hash.create(Resque::Plugins::Status::Hash.generate_uuid)
+        after = Resque::Plugins::Status::Hash.status_ids.length
+        assert_equal 1, after - before
+      end
+
+      it "return a uuid" do
+        assert_match(/^\w{32}$/, Resque::Plugins::Status::Hash.create(Resque::Plugins::Status::Hash.generate_uuid))
+      end
+
+      it "store any status passed" do
+        uuid = Resque::Plugins::Status::Hash.create(Resque::Plugins::Status::Hash.generate_uuid, "initial status")
+        status = Resque::Plugins::Status::Hash.get(uuid)
+        assert status.is_a?(Resque::Plugins::Status::Hash)
+        assert_equal "initial status", status.message
+      end
+
+      it "expire keys if expire_in is set" do
+        Resque::Plugins::Status::Hash.expire_in = 1
+        uuid = Resque::Plugins::Status::Hash.create(Resque::Plugins::Status::Hash.generate_uuid, "new status")
+        assert_includes Resque::Plugins::Status::Hash.status_ids, uuid
+        assert_equal "new status", Resque::Plugins::Status::Hash.get(uuid).message
+        sleep 2
+        Resque::Plugins::Status::Hash.create(Resque::Plugins::Status::Hash.generate_uuid)
+        refute_includes Resque::Plugins::Status::Hash.status_ids, uuid
+        assert_nil Resque::Plugins::Status::Hash.get(uuid)
+      end
+
+      it "store the options for the job created" do
+        uuid = Resque::Plugins::Status::Hash.create(Resque::Plugins::Status::Hash.generate_uuid, "new", :options => {'test' => '123'})
+        assert uuid
+        status = Resque::Plugins::Status::Hash.get(uuid)
+        assert status.is_a?(Resque::Plugins::Status::Hash)
+        assert_equal '123', status.options['test']
+      end
+    end
+
+    describe ".clear" do
+      before do
+        Resque::Plugins::Status::Hash.clear
+      end
+
+      it "clear any statuses" do
+        assert_nil Resque::Plugins::Status::Hash.get(@uuid)
+      end
+
+      it "clear any recent statuses" do
+        assert Resque::Plugins::Status::Hash.status_ids.empty?
+      end
+
+    end
+
+    describe ".clear_completed" do
+      before do
+        @completed_status_id = Resque::Plugins::Status::Hash.create(Resque::Plugins::Status::Hash.generate_uuid, {'status' => "completed"})
+        @not_completed_status_id = Resque::Plugins::Status::Hash.create(Resque::Plugins::Status::Hash.generate_uuid)
+        Resque::Plugins::Status::Hash.clear_completed
+      end
+
+      it "clear completed status" do
+        assert_nil Resque::Plugins::Status::Hash.get(@completed_status_id)
+      end
+
+      it "not clear not-completed status" do
+        status = Resque::Plugins::Status::Hash.get(@not_completed_status_id)
+        assert status.is_a?(Resque::Plugins::Status::Hash)
+      end
+    end
+
+    describe ".clear_failed" do
+      before do
+        @failed_status_id = Resque::Plugins::Status::Hash.create(Resque::Plugins::Status::Hash.generate_uuid, {'status' => "failed"})
+        @not_failed_status_id = Resque::Plugins::Status::Hash.create(Resque::Plugins::Status::Hash.generate_uuid)
+        Resque::Plugins::Status::Hash.clear_failed
+      end
+
+      it "clear failed status" do
+        assert_nil Resque::Plugins::Status::Hash.get(@failed_status_id)
+      end
+
+      it "not clear not-failed status" do
+        status = Resque::Plugins::Status::Hash.get(@not_failed_status_id)
+        assert status.is_a?(Resque::Plugins::Status::Hash)
+      end
+    end
+
+    describe ".remove" do
+      before do
+        Resque::Plugins::Status::Hash.remove(@uuid)
+      end
+
+      it "clear specify status" do
+        assert_nil Resque::Plugins::Status::Hash.get(@uuid)
+      end
+    end
+
+    describe ".status_ids" do
+
+      before do
+        @uuids = []
+        30.times{ Resque::Plugins::Status::Hash.create(Resque::Plugins::Status::Hash.generate_uuid) }
+      end
+
+      it "return an array of job ids" do
+        assert Resque::Plugins::Status::Hash.status_ids.is_a?(Array)
+        assert_equal 32, Resque::Plugins::Status::Hash.status_ids.size # 30 + 2
+      end
+
+      it "let you paginate through the statuses" do
+        assert_equal Resque::Plugins::Status::Hash.status_ids[0, 10], Resque::Plugins::Status::Hash.status_ids(0, 9)
+        assert_equal Resque::Plugins::Status::Hash.status_ids[10, 10], Resque::Plugins::Status::Hash.status_ids(10, 19)
+        # assert_equal Resque::Plugins::Status::Hash.status_ids.reverse[0, 10], Resque::Plugins::Status::Hash.status_ids(0, 10)
+      end
+    end
+
+    describe ".statuses" do
+
+      it "return an array status objects" do
+        statuses = Resque::Plugins::Status::Hash.statuses
+        assert statuses.is_a?(Array)
+        assert_equal [@uuid_with_json, @uuid].sort, statuses.map(&:uuid).sort
+      end
+
+      it "return an empty array when no statuses are available" do
+        Resque.redis.flushall
+        statuses = Resque::Plugins::Status::Hash.statuses
+        assert_equal [], statuses
+      end
+
+    end
+
+    Resque::Plugins::Status::STATUSES.each do |status_code|
+      describe ".#{status_code}?" do
+
+        before do
+          uuid = Resque::Plugins::Status::Hash.create(Resque::Plugins::Status::Hash.generate_uuid, {'status' => status_code})
+          @status = Resque::Plugins::Status::Hash.get(uuid)
+        end
+
+        it "return true for the current status" do
+          assert @status.send("#{status_code}?"), status_code
+        end
+
+        it "return false for other statuses" do
+          (Resque::Plugins::Status::STATUSES - [status_code]).each do |other_status_code|
+            assert !@status.send("#{other_status_code}?"), other_status_code
+          end
+        end
+
+      end
+    end
+  end
+
+end