rocketjob 1.3.0 → 2.0.0.rc1

data/test/plugins/job/persistence_test.rb

@@ -0,0 +1,81 @@
+require_relative '../../test_helper'
+
+module Plugins
+  module Job
+    # Unit Test for RocketJob::Job
+    class PersistenceTest < Minitest::Test
+
+      class PersistJob < RocketJob::Job
+        rocket_job do |job|
+          job.priority = 53
+        end
+
+        def perform(hash)
+          hash
+        end
+      end
+
+      describe RocketJob::Plugins::Job::Persistence do
+        before do
+          @description = 'Hello World'
+          @arguments   = [{key: 'value'}]
+          @job         = PersistJob.new(
+            description:         @description,
+            arguments:           [{key: 'value'}],
+            destroy_on_complete: false
+          )
+        end
+
+        after do
+          @job.destroy if @job && !@job.new_record?
+        end
+
+        describe '.config' do
+          it 'support multiple databases' do
+            assert_equal 'test_rocketjob', RocketJob::Job.collection.db.name
+          end
+        end
+
+        describe '.rocket_job' do
+          it 'sets defaults after initialize' do
+            assert_equal 53, @job.priority
+          end
+        end
+
+        describe '#reload' do
+          it 'handle hash' do
+            assert_equal 'value', @job.arguments.first[:key]
+            @job.worker_name = nil
+            @job.save!
+            @job.worker_name = '123'
+            @job.reload
+            assert @job.arguments.first.is_a?(ActiveSupport::HashWithIndifferentAccess), @job.arguments.first.class.ai
+            assert_equal 'value', @job.arguments.first['key']
+            assert_equal 'value', @job.arguments.first[:key]
+            assert_equal nil, @job.worker_name
+          end
+        end
+
+        describe '#save!' do
+          it 'save a blank job' do
+            @job.save!
+            assert_nil @job.worker_name
+            assert_nil @job.completed_at
+            assert @job.created_at
+            assert_equal @description, @job.description
+            assert_equal false, @job.destroy_on_complete
+            assert_nil @job.expires_at
+            assert_equal @arguments, @job.arguments
+            assert_equal 0, @job.percent_complete
+            assert_equal 53, @job.priority
+            assert_equal 0, @job.failure_count
+            assert_nil @job.run_at
+            assert_nil @job.started_at
+            assert_equal :queued, @job.state
+          end
+        end
+
+      end
+    end
+  end
+end

data/test/plugins/job/state_machine_test.rb

@@ -0,0 +1,118 @@
+require_relative '../../test_helper'
+module Plugins
+  module Job
+    # Unit Test for RocketJob::Job
+    class StateMachineTest < Minitest::Test
+
+      class StateMachineJob < RocketJob::Job
+        def perform
+        end
+      end
+
+      describe RocketJob::Plugins::Job::StateMachine do
+        before do
+          @job = StateMachineJob.new
+        end
+
+        after do
+          @job.destroy if @job && !@job.new_record?
+        end
+
+        describe '#requeue!' do
+          it 'requeue jobs from dead workers' do
+            worker_name      = 'server:12345'
+            @job.worker_name = worker_name
+            @job.start!
+            assert @job.running?
+
+            @job.requeue!(worker_name)
+            @job.reload
+
+            assert @job.queued?
+            assert_equal nil, @job.worker_name
+          end
+        end
+
+        describe '#requeue' do
+          it 'requeue jobs from dead workers' do
+            worker_name      = 'server:12345'
+            @job.worker_name = worker_name
+            assert @job.valid?, @job.errors.messages
+            @job.start!
+            assert @job.running?, @job.state
+
+            @job.requeue(worker_name)
+            assert @job.queued?
+            assert_equal nil, @job.worker_name
+
+            @job.reload
+            assert @job.running?
+            assert_equal worker_name, @job.worker_name
+          end
+        end
+
+        describe '#after_complete' do
+          it 'destroy on complete' do
+            @job.destroy_on_complete = true
+            @job.perform_now
+            assert @job.completed?, @job.state
+            assert_equal 0, RocketJob::Job.where(id: @job.id).count
+          end
+        end
+
+        describe '#fail!' do
+          it 'fail with message' do
+            @job.start!
+            @job.fail!('myworker:2323', 'oh no')
+            assert @job.failed?
+            assert exc = @job.exception
+            assert_equal 'RocketJob::JobException', exc.class_name
+            assert_equal 'oh no', exc.message
+          end
+
+          it 'fail with no arguments' do
+            @job.start!
+            @job.fail!
+            assert @job.failed?
+            assert exc = @job.exception
+            assert_equal 'RocketJob::JobException', exc.class_name
+            assert_equal nil, exc.message
+            assert_equal nil, exc.worker_name
+            assert_equal [], exc.backtrace
+          end
+
+          it 'fail with exception' do
+            @job.start!
+            exception = RuntimeError.new('Oh no')
+            @job.fail!('myworker:2323', exception)
+            assert @job.failed?
+            assert exc = @job.exception
+            assert_equal exception.class.name, exc.class_name
+            assert_equal exception.message, exc.message
+            assert_equal [], exc.backtrace
+          end
+        end
+
+        describe '#retry!' do
+          it 'retry failed jobs' do
+            worker_name      = 'server:12345'
+            @job.worker_name = worker_name
+            @job.start!
+            assert @job.running?
+            assert_equal worker_name, @job.worker_name
+
+            @job.fail!(worker_name, 'oh no')
+            assert @job.failed?
+            assert_equal 'oh no', @job.exception.message
+
+            @job.retry!
+            assert @job.queued?
+            assert_equal nil, @job.worker_name
+            assert_equal nil, @job.exception
+          end
+        end
+
+      end
+    end
+  end
+end

data/test/plugins/job/worker_test.rb

@@ -0,0 +1,183 @@
+require_relative '../../test_helper'
+
+module Plugins
+  module Job
+    # Unit Test for RocketJob::Job
+    class WorkerTest < Minitest::Test
+      class QuietJob < RocketJob::Job
+        # Test increasing log level for debugging purposes
+        def perform
+          logger.trace 'enable tracing level for just the job instance'
+        end
+      end
+
+      class NoisyJob < RocketJob::Job
+        # Test silencing noisy logging
+        def perform
+          logger.info 'some very noisy logging'
+        end
+      end
+
+      class SumJob < RocketJob::Job
+        rocket_job do |job|
+          job.destroy_on_complete = false
+          job.collect_output      = true
+          job.priority            = 51
+        end
+
+        def perform(first, second)
+          first + second
+        end
+      end
+
+      describe RocketJob::Plugins::Job::Worker do
+        before do
+          RocketJob::Job.destroy_all
+        end
+
+        after do
+          @job.destroy if @job && !@job.new_record?
+        end
+
+        describe '.rocket_job_next_job' do
+          before do
+            @job    = QuietJob.new
+            @worker = RocketJob::Worker.new(name: 'worker:123')
+          end
+
+          it 'return nil when no jobs available' do
+            assert_equal nil, RocketJob::Job.rocket_job_next_job(@worker.name)
+          end
+
+          it 'return the first job' do
+            @job.save!
+            assert job = RocketJob::Job.rocket_job_next_job(@worker.name), 'Failed to find job'
+            assert_equal @job.id, job.id
+          end
+
+          it 'Ignore future dated jobs' do
+            @job.run_at = Time.now + 1.hour
+            @job.save!
+            assert_equal nil, RocketJob::Job.rocket_job_next_job(@worker.name)
+          end
+
+          it 'Process future dated jobs when time is now' do
+            @job.run_at = Time.now
+            @job.save!
+            assert job = RocketJob::Job.rocket_job_next_job(@worker.name), 'Failed to find future job'
+            assert_equal @job.id, job.id
+          end
+
+          it 'Skip expired jobs' do
+            count           = RocketJob::Job.count
+            @job.expires_at = Time.now - 100
+            @job.save!
+            assert_equal nil, RocketJob::Job.rocket_job_next_job(@worker.name)
+            assert_equal count, RocketJob::Job.count
+          end
+        end
+
+        describe '#perform_now' do
+          it 'calls perform method' do
+            @job = SumJob.new(arguments: [10, 5])
+            assert_equal 15, @job.perform_now['result']
+            assert @job.completed?, @job.attributes.ai
+            assert_equal 15, @job.result['result']
+          end
+
+          it 'saves exception' do
+            @job = SumJob.new(arguments: ['10', 5])
+            assert_raises TypeError do
+              @job.perform_now
+            end
+            assert @job.exception.backtrace
+            assert_equal 'TypeError', @job.exception.class_name
+            if RUBY_VERSION.to_f < 2.0
+              assert_equal "can't convert Fixnum into String", @job.exception.message
+            else
+              assert_equal 'no implicit conversion of Fixnum into String', @job.exception.message
+            end
+            assert_equal 'inline', @job.exception.worker_name
+          end
+
+          it 'silence logging when log_level is set' do
+            @job           = NoisyJob.new
+            @job.log_level = :warn
+            logged         = false
+            @job.logger.stub(:log_internal, -> level, index, message, payload, exception { logged = true if message.include?('some very noisy logging') }) do
+              @job.perform_now
+            end
+            assert_equal false, logged
+          end
+
+          it 'raise logging when log_level is set' do
+            @job           = QuietJob.new
+            @job.log_level = :trace
+            logged         = false
+            # Raise global log level to :info
+            SemanticLogger.stub(:default_level_index, 3) do
+              @job.logger.stub(:log_internal, -> { logged = true }) do
+                @job.perform_now
+              end
+            end
+            assert_equal false, logged
+          end
+        end
+
+        describe '.perform_later' do
+          it 'queues the job for processing' do
+            RocketJob::Config.stub(:inline_mode, false) do
+              @job = SumJob.perform_later(1, 23)
+            end
+            assert @job.queued?
+
+            # Manually run the job
+            @job.perform_now
+            assert @job.completed?, @job.attributes.ai
+            assert_equal 24, @job.result['result']
+
+            assert_nil @job.worker_name
+            assert @job.completed_at
+            assert @job.created_at
+            assert_equal false, @job.destroy_on_complete
+            assert_nil @job.expires_at
+            assert_equal 100, @job.percent_complete
+            assert_equal 51, @job.priority
+            assert_equal 0, @job.failure_count
+            assert_nil @job.run_at
+            assert @job.started_at
+          end
+
+          it 'runs the job immediately when inline_mode = true' do
+            RocketJob::Config.stub(:inline_mode, true) do
+              @job = SumJob.perform_later(1, 23)
+            end
+
+            assert @job.completed?, @job.attributes.ai
+            assert_equal 24, @job.result['result']
+
+            assert_nil @job.worker_name
+            assert @job.completed_at
+            assert @job.created_at
+            assert_equal false, @job.destroy_on_complete
+            assert_nil @job.expires_at
+            assert_equal 100, @job.percent_complete
+            assert_equal 51, @job.priority
+            assert_equal 0, @job.failure_count
+            assert_nil @job.run_at
+            assert @job.started_at
+          end
+        end
+
+        describe '.perform_now' do
+          it 'run the job immediately' do
+            @job = SumJob.perform_now(1, 5)
+            assert_equal true, @job.completed?
+            assert_equal 6, @job.result['result']
+          end
+        end
+
+      end
+    end
+  end
+end

data/test/plugins/restart_test.rb

@@ -0,0 +1,185 @@
+require_relative '../test_helper'
+
+# Unit Test for RocketJob::Job
+module Plugins
+  class RestartTest < Minitest::Test
+    class RestartableJob < RocketJob::Job
+      include RocketJob::Plugins::Restart
+
+      def perform
+        'DONE'
+      end
+    end
+
+    describe RocketJob::Plugins::Restart do
+      before do
+        # destroy_all could create new instances
+        RestartableJob.delete_all
+        assert_equal 0, RestartableJob.count
+      end
+
+      after do
+        @job.delete if @job && !@job.new_record?
+        RestartableJob.delete_all
+      end
+
+      describe '#create!' do
+        it 'queues a new job' do
+          @job = RestartableJob.create!
+          assert @job.valid?
+          refute @job.new_record?
+        end
+      end
+
+      describe '#save!' do
+        it 'queues a new job' do
+          @job = RestartableJob.new
+          @job.save!
+          assert @job.valid?
+          refute @job.new_record?
+        end
+      end
+
+      describe '#abort!' do
+        it 'queues a new job on abort' do
+          @job = RestartableJob.create!
+          @job.abort!
+          assert_equal 2, RestartableJob.count
+          assert other = RestartableJob.where(id: {'$ne' => @job.id}).first
+          refute_equal @job.id, other.id
+          assert other.queued?
+        end
+
+        it 'does not queue a new job when expired' do
+          @job = RestartableJob.create!(expires_at: Time.now - 1.day)
+          assert @job.expired?
+          @job.abort!
+          assert_equal 1, RestartableJob.count
+          assert_equal nil, RestartableJob.where(id: {'$ne' => @job.id}).first
+        end
+      end
+
+      describe '#complete' do
+        it 'queues a new job when destroy_on_complete' do
+          assert_equal 0, RestartableJob.count
+          @job = RestartableJob.create!(destroy_on_complete: true)
+          @job.perform_now
+          assert @job.completed?, @job.attributes.ai
+          assert_equal 1, RestartableJob.count, RestartableJob.all.to_a.ai
+        end
+
+        it 'queues a new job when not destroy_on_complete' do
+          @job = RestartableJob.create!(destroy_on_complete: false)
+          @job.perform_now
+          assert @job.completed?
+          assert_equal 2, RestartableJob.count
+        end
+
+        it 'does not queue a new job when expired' do
+          @job = RestartableJob.create!(expires_at: Time.now - 1.day)
+          @job.perform_now
+          assert @job.expired?
+          assert @job.completed?
+          assert_equal 0, RestartableJob.count
+        end
+      end
+
+      describe '#pause' do
+        it 'does not enqueues a new job when paused' do
+          @job = RestartableJob.new
+          @job.start
+          @job.pause!
+          assert @job.paused?
+          assert_equal 1, RestartableJob.count
+        end
+      end
+
+      describe '#fail' do
+        it 'aborts from queued' do
+          @job = RestartableJob.new
+          assert @job.queued?
+          @job.fail
+          assert @job.aborted?
+        end
+
+        it 'aborts from running' do
+          @job = RestartableJob.new
+          @job.start
+          assert @job.running?
+          @job.fail
+          assert @job.aborted?
+        end
+
+        it 'aborts from paused' do
+          @job = RestartableJob.new
+          @job.start
+          @job.pause
+          assert @job.paused?
+          @job.fail
+          assert @job.aborted?
+        end
+
+        it 'does not queue a new job when expired' do
+          @job = RestartableJob.new(expires_at: Time.now - 1.day)
+          @job.start!
+          assert @job.running?
+          assert @job.expired?
+          assert_equal 1, RestartableJob.count
+          assert_equal nil, RestartableJob.where(id: {'$ne' => @job.id}).first
+        end
+      end
+
+      describe '#create_new_instance' do
+        it 'sets job back to queued state' do
+          @job = RestartableJob.create!(destroy_on_complete: true)
+          @job.perform_now
+          assert_equal 1, RestartableJob.count
+          assert job2 = RestartableJob.where(id: {'$ne' => @job.id}).first
+          assert job2.queued?, job2.attributes.ai
+        end
+
+        it 'excludes attributes related to running jobs' do
+          @job = RestartableJob.create!(destroy_on_complete: true, expires_at: Time.now + 1.day)
+          refute @job.expired?
+          @job.perform_now
+          assert_equal 1, RestartableJob.count
+          assert job2 = RestartableJob.where(id: {'$ne' => @job.id}).first
+          assert job2.queued?, job2.attributes.ai
+
+          # Copy across all attributes, except
+          @job.attributes.each_pair do |key, value|
+            next if RocketJob::Plugins::Restart::RESTART_EXCLUDES.include?(key)
+            assert_equal value, job2[key], "Attributes are supposed to be copied across. For #{key}"
+          end
+
+          assert_equal :queued, job2.state
+          assert job2.created_at
+          assert_equal nil, job2.started_at
+          assert_equal nil, job2.completed_at
+          assert_equal 0, job2.failure_count
+          assert_equal nil, job2.worker_name
+          assert_equal 0, job2.percent_complete
+          assert_equal nil, job2.exception
+          assert_equal({}, job2.result)
+        end
+
+        it 'copies run_at when it is in the future' do
+          @job = RestartableJob.create!(run_at: Time.now + 1.day, destroy_on_complete: true)
+          @job.perform_now
+          assert_equal 1, RestartableJob.count
+          assert job2 = RestartableJob.where(id: {'$ne' => @job.id}).first
+          assert job2.run_at, job2.attributes.ai
+        end
+
+        it 'does not copy run_at when it is in the past' do
+          @job = RestartableJob.create!(run_at: Time.now - 1.day, destroy_on_complete: true)
+          @job.perform_now
+          assert_equal 1, RestartableJob.count
+          assert job2 = RestartableJob.where(id: {'$ne' => @job.id}).first
+          assert_equal nil, job2.run_at
+        end
+      end
+
+    end
+  end
+end

data/test/plugins/singleton_test.rb

@@ -0,0 +1,94 @@
+require_relative '../test_helper'
+
+module Plugins
+  # Unit Test for RocketJob::Job
+  class SingletonTest < Minitest::Test
+
+    class SingletonJob < RocketJob::Job
+      include RocketJob::Plugins::Singleton
+
+      def perform
+      end
+    end
+
+    describe RocketJob::Plugins::Singleton do
+      before do
+        SingletonJob.delete_all
+      end
+
+      after do
+        @job.destroy if @job && !@job.new_record?
+      end
+
+      describe '#rocket_job_singleton_active?' do
+        it 'returns false if no jobs of this class are active' do
+          @job = SingletonJob.new
+          assert_equal false, @job.rocket_job_singleton_active?
+        end
+
+        it 'excludes self when queued from check' do
+          @job = SingletonJob.create
+          assert @job.queued?
+          assert_equal false, @job.rocket_job_singleton_active?
+        end
+
+        it 'excludes self when started from check' do
+          @job = SingletonJob.new
+          @job.start!
+          assert @job.running?
+          assert_equal false, @job.rocket_job_singleton_active?
+        end
+
+        it 'returns true when other jobs of this class are queued' do
+          @job = SingletonJob.create!
+          job2 = SingletonJob.new
+          assert_equal true, job2.rocket_job_singleton_active?
+        end
+
+        it 'returns true when other jobs of this class are running' do
+          @job = SingletonJob.new
+          @job.start!
+          job2 = SingletonJob.new
+          assert_equal true, job2.rocket_job_singleton_active?
+        end
+
+        it 'returns false when other jobs of this class are not active' do
+          @job = SingletonJob.new
+          @job.perform_now
+          @job.save!
+          assert @job.completed?
+          job2 = SingletonJob.new
+          assert_equal false, job2.rocket_job_singleton_active?
+        end
+      end
+
+      describe 'validation' do
+        it 'passes if another job is not active' do
+          @job = SingletonJob.new
+          @job.perform_now
+          @job.save!
+          job2 = SingletonJob.new
+          assert_equal true, job2.valid?
+        end
+
+        it 'fails if another job is active' do
+          @job = SingletonJob.new
+          @job.start!
+          job2 = SingletonJob.new
+          refute job2.valid?
+          assert_equal ['Another instance of Plugins::SingletonTest::SingletonJob is already queued or running'], job2.errors.messages[:state]
+        end
+
+        it 'passes if another job is active, but this job is not' do
+          @job = SingletonJob.new
+          @job.start!
+          job2 = SingletonJob.new
+          job2.abort
+          assert job2.valid?
+          job2.save!
+        end
+      end
+
+    end
+  end
+end