rocketjob 1.3.0 → 2.0.0.rc1

data/test/job_test.rb

@@ -1,25 +1,18 @@
 require_relative 'test_helper'
-require_relative 'jobs/test_job'
 
 # Unit Test for RocketJob::Job
 class JobTest < Minitest::Test
+
+  class SimpleJob < RocketJob::Job
+    def perform
+    end
+  end
+
   describe RocketJob::Job do
     before do
-      @worker = RocketJob::Worker.new
-      @worker.started
       @description = 'Hello World'
-      @arguments   = [1]
-      @job         = Jobs::TestJob.new(
-        description:         @description,
-        arguments:           @arguments,
-        destroy_on_complete: false
-      )
-      @job2        = Jobs::TestJob.new(
-        description:         "#{@description} 2",
-        arguments:           @arguments,
-        destroy_on_complete: false,
-        priority:            52
-      )
+      @job         = SimpleJob.new(description: @description)
+      @job2        = SimpleJob.new(description: @description, priority: 52)
     end
 
     after do
@@ -27,52 +20,6 @@ class JobTest < Minitest::Test
       @job2.destroy if @job2 && !@job2.new_record?
     end
 
-    describe '.config' do
-      it 'support multiple databases' do
-        assert_equal 'test_rocketjob', RocketJob::Job.collection.db.name
-      end
-    end
-
-    describe '#reload' do
-      it 'handle hash' do
-        @job = Jobs::TestJob.new(
-          description:         @description,
-          arguments:           [{key: 'value'}],
-          destroy_on_complete: false,
-          worker_name:         'worker:123'
-        )
-
-        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.inspect
-        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 51, @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
-
     describe '#status' do
       it 'return status for a queued job' do
         assert_equal true, @job.queued?
@@ -91,182 +38,6 @@ class JobTest < Minitest::Test
         assert_equal 'RocketJob::JobException', h['exception']['class_name'], h
         assert_equal 'oh no', h['exception']['message'], h
       end
-
-      it 'mark user as reason for failure when not supplied' do
-        @job.start!
-        @job.fail!
-        assert_equal true, @job.failed?
-        assert_equal @description, @job.description
-        assert_equal 'RocketJob::JobException', @job.exception.class_name
-        assert_equal 'Job failed through user action', @job.exception.message
-        assert_equal 'user', @job.exception.worker_name
-      end
-    end
-
-    describe '#fail_with_exception!' do
-      it 'fail with message' do
-        @job.start!
-        @job.fail!('myworker:2323', 'oh no')
-        assert_equal true, @job.failed?
-        h = @job.status
-        assert_equal :failed, h['state']
-        assert_equal @description, h['description']
-        assert_equal 'RocketJob::JobException', h['exception']['class_name'], h
-        assert_equal 'oh no', h['exception']['message'], h
-      end
-
-      it 'fail with exception' do
-        @job.start!
-        exception = nil
-        begin
-          blah
-        rescue Exception => exc
-          exception = exc
-        end
-        @job.fail!('myworker:2323', exception)
-        assert_equal true, @job.failed?
-        h = @job.status
-        assert_equal :failed, h['state']
-        assert_equal @description, h['description']
-        assert_equal exception.class.name.to_s, h['exception']['class_name'], h
-        assert h['exception']['message'].include?('undefined local variable or method'), h
-      end
-    end
-
-    describe '#work' do
-      it 'call default perform method' do
-        @job.start!
-        assert_equal false, @job.work(@worker)
-        assert_equal true, @job.completed?, @job.state
-        assert_equal 2, Jobs::TestJob.result
-      end
-
-      it 'call specific method' do
-        @job.perform_method = :sum
-        @job.arguments      = [23, 45]
-        @job.start!
-        assert_equal false, @job.work(@worker)
-        assert_equal true, @job.completed?
-        assert_equal 68, Jobs::TestJob.result
-      end
-
-      it 'destroy on complete' do
-        @job.destroy_on_complete = true
-        @job.start!
-        assert_equal false, @job.work(@worker)
-        assert @job.completed?, @job.state
-        assert_equal 0, RocketJob::Job.where(id: @job.id).count
-      end
-
-      it 'silence logging when log_level is set' do
-        @job.destroy_on_complete = true
-        @job.log_level           = :warn
-        @job.perform_method      = :noisy_logger
-        @job.arguments           = []
-        @job.start!
-        logged = false
-        Jobs::TestJob.logger.stub(:log_internal, -> level, index, message, payload, exception { logged = true if message.include?('some very noisy logging') }) do
-          assert_equal false, @job.work(@worker), @job.inspect
-        end
-        assert_equal false, logged
-      end
-
-      it 'raise logging when log_level is set' do
-        @job.destroy_on_complete = true
-        @job.log_level           = :trace
-        @job.perform_method      = :debug_logging
-        @job.arguments           = []
-        @job.start!
-        logged = false
-        # Raise global log level to :info
-        SemanticLogger.stub(:default_level_index, 3) do
-          Jobs::TestJob.logger.stub(:log_internal, -> { logged = true }) do
-            assert_equal false, @job.work(@worker)
-          end
-        end
-        assert_equal false, logged
-      end
-
-      it 'call before and after' do
-        named_parameters    = {'counter' => 23}
-        @job.perform_method = :event
-        @job.arguments      = [named_parameters]
-        @job.start!
-        assert_equal false, @job.work(@worker), @job.inspect
-        assert_equal true, @job.completed?
-        assert_equal named_parameters.merge('before_event' => true, 'after_event' => true), @job.arguments.first
-      end
-
-    end
-
-    describe '.next_job' do
-      before do
-        RocketJob::Job.destroy_all
-      end
-
-      it 'return nil when no jobs available' do
-        assert_equal nil, RocketJob::Job.next_job(@worker.name)
-      end
-
-      it 'return the first job' do
-        @job.save!
-        assert job = RocketJob::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.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.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.next_job(@worker.name)
-        assert_equal count, RocketJob::Job.count
-      end
-    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!
-        @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
-        assert @job.queued?
-        assert_equal nil, @job.worker_name
-
-        @job.reload
-        assert @job.running?
-        assert_equal worker_name, @job.worker_name
-      end
     end
 
     describe '.requeue_dead_worker' do
@@ -280,6 +51,9 @@ class JobTest < Minitest::Test
         worker_name2      = 'server:76467'
         @job2.worker_name = worker_name2
         @job2.start!
+        assert_equal true, @job2.valid?
+        assert @job2.running?, @job2.state
+        @job2.save!
 
         RocketJob::Job.requeue_dead_worker(worker_name)
         @job.reload
@@ -287,28 +61,11 @@ class JobTest < Minitest::Test
         assert @job.queued?
         assert_equal nil, @job.worker_name
 
+        assert_equal worker_name2, @job2.worker_name
         @job2.reload
-        assert @job2.running?
         assert_equal worker_name2, @job2.worker_name
-      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
+        assert @job2.running?, @job2.state
+        assert_equal worker_name2, @job2.worker_name
       end
     end
 

data/test/plugins/job/callbacks_test.rb

@@ -0,0 +1,163 @@
+require_relative '../../test_helper'
+
+module Plugins
+  module Job
+    # Unit Test for RocketJob::Job
+    class CallbacksTest < Minitest::Test
+      # This job adds each callback as they run into an array
+      class BeforePerformJob < RocketJob::Job
+        before_perform do
+          arguments.first << 'before_perform_block'
+        end
+
+        before_perform :before_perform_method
+
+        def perform(list)
+          list << 'perform'
+        end
+
+        private
+
+        def before_perform_method
+          arguments.first << 'before_perform_method'
+        end
+
+      end
+
+      # This job adds each callback as they run into an array
+      class AfterPerformJob < RocketJob::Job
+        after_perform do
+          arguments.first << 'after_perform_block'
+        end
+
+        after_perform :after_perform_method
+
+        def perform(list)
+          list << 'perform'
+        end
+
+        private
+
+        def after_perform_method
+          arguments.first << 'after_perform_method'
+        end
+
+      end
+
+      # This job adds each callback as they run into an array
+      class AroundPerformJob < RocketJob::Job
+        around_perform do |job, block|
+          arguments.first << 'around_perform_block_before'
+          block.call
+          arguments.first << 'around_perform_block_after'
+        end
+
+        around_perform :around_perform_method
+
+        def perform(list)
+          list << 'perform'
+        end
+
+        private
+
+        def around_perform_method
+          arguments.first << 'around_perform_method_before'
+          yield
+          arguments.first << 'around_perform_method_after'
+        end
+
+      end
+
+      # This job adds each callback as they run into an array
+      class CombinedPerformJob < RocketJob::Job
+        before_perform do
+          arguments.first << 'before_perform_block'
+        end
+
+        after_perform do
+          arguments.first << 'after_perform_block'
+        end
+
+        around_perform do |job, block|
+          arguments.first << 'around_perform_block_before'
+          block.call
+          arguments.first << 'around_perform_block_after'
+        end
+
+        before_perform :before_perform_method
+
+        around_perform :around_perform_method
+
+        after_perform :after_perform_method
+
+        def perform(list)
+          list << 'perform'
+        end
+
+        private
+
+        def before_perform_method
+          arguments.first << 'before_perform_method'
+        end
+
+        def around_perform_method(&block)
+          arguments.first << 'around_perform_method_before'
+          block.call
+          arguments.first << 'around_perform_method_after'
+        end
+
+        def after_perform_method
+          arguments.first << 'after_perform_method'
+        end
+
+      end
+
+      describe RocketJob::Plugins::Job::Callbacks do
+        after do
+          @job.destroy if @job && !@job.new_record?
+        end
+
+        describe '#before_perform' do
+          it 'runs blocks and functions' do
+            @job = BeforePerformJob.new(arguments: [[]])
+            @job.perform_now
+            assert @job.completed?, @job.attributes.ai
+            expected = %w(before_perform_block before_perform_method perform)
+            assert_equal expected, @job.arguments.first, 'Sequence of before_perform callbacks is incorrect'
+          end
+        end
+
+        describe '#after_perform' do
+          it 'runs blocks and functions' do
+            @job = AfterPerformJob.new(arguments: [[]])
+            @job.perform_now
+            assert @job.completed?, @job.attributes.ai
+            expected = %w(perform after_perform_method after_perform_block)
+            assert_equal expected, @job.arguments.first, 'Sequence of after_perform callbacks is incorrect'
+          end
+        end
+
+        describe '#around_perform' do
+          it 'runs blocks and functions' do
+            @job = AroundPerformJob.new(arguments: [[]])
+            @job.perform_now
+            assert @job.completed?, @job.attributes.ai
+            expected = %w(around_perform_block_before around_perform_method_before perform around_perform_method_after around_perform_block_after)
+            assert_equal expected, @job.arguments.first, 'Sequence of around_perform callbacks is incorrect'
+          end
+        end
+
+        describe 'all callbacks' do
+          it 'runs them in the right order' do
+            @job = CombinedPerformJob.new(arguments: [[]])
+            @job.perform_now
+            assert @job.completed?, @job.attributes.ai
+            expected = %w(before_perform_block around_perform_block_before before_perform_method around_perform_method_before perform after_perform_method around_perform_method_after around_perform_block_after after_perform_block)
+            assert_equal expected, @job.arguments.first, 'Sequence of around_perform callbacks is incorrect'
+          end
+        end
+
+      end
+    end
+  end
+end

data/test/plugins/job/defaults_test.rb

@@ -0,0 +1,52 @@
+require_relative '../../test_helper'
+
+module Plugins
+  module Job
+    # Unit Test for RocketJob::Job
+    class DefaultsTest < Minitest::Test
+
+      class ParentJob < RocketJob::Job
+        rocket_job do |job|
+          job.priority    = 53
+          job.description = 'Hello'
+        end
+
+        def perform
+        end
+      end
+
+      class ChildJob < ParentJob
+        rocket_job do |job|
+          job.priority = 72
+        end
+
+        def perform
+        end
+      end
+
+      describe RocketJob::Plugins::Job::Defaults do
+        after do
+          @job.destroy if @job && !@job.new_record?
+        end
+
+        describe '.rocket_job' do
+          it 'sets defaults after initialize' do
+            @job = ParentJob.new
+            assert_equal 53, @job.priority
+            assert_equal 'Hello', @job.description
+          end
+
+          it 'allows a child to override parent defaults' do
+            @job = ChildJob.new
+            assert_equal 72, @job.priority
+          end
+
+          it 'passes down parent defaults' do
+            @job = ChildJob.new
+            assert_equal 'Hello', @job.description
+          end
+        end
+      end
+    end
+  end
+end

data/test/plugins/job/logger_test.rb

@@ -0,0 +1,58 @@
+require_relative '../../test_helper'
+
+# Unit Test for RocketJob::Job
+module Plugins
+  module Job
+    class LoggerTest < Minitest::Test
+
+      class LoggerJob < RocketJob::Job
+        def perform
+          logger.debug('DONE', value: 123, other_value: 'HI')
+        end
+      end
+
+      describe RocketJob::Plugins::Job::Logger do
+        before do
+          LoggerJob.delete_all
+        end
+
+        after do
+          @job.destroy if @job && !@job.new_record?
+          SemanticLogger.flush
+        end
+
+        describe '#logger' do
+          it 'uses semantic logger' do
+            @job = LoggerJob.new
+            assert_kind_of SemanticLogger::Logger, @job.logger, @job.logger.ai
+            assert_equal @job.class.name, @job.logger.name, @job.logger.ai
+          end
+
+          it 'allows perform to log its own data' do
+            @job = LoggerJob.new
+            @job.perform_now
+          end
+
+          it 'adds start logging' do
+            @job        = LoggerJob.new
+            info_called = false
+            @job.logger.stub(:info, -> description { info_called = true if description == 'Start #perform' }) do
+              @job.perform_now
+            end
+            assert info_called, "In Plugins::Job::Logger.around_perform logger.info('Start #perform') not called"
+          end
+
+          it 'adds completed logging' do
+            @job             = LoggerJob.new
+            benchmark_called = false
+            @job.logger.stub(:benchmark_info, -> description, *args { benchmark_called = true if description == 'Completed #perform' }) do
+              @job.perform_now
+            end
+            assert benchmark_called, "In Plugins::Job::Logger.around_perform logger.benchmark_info('Completed #perform') not called"
+          end
+        end
+
+      end
+    end
+  end
+end

data/test/plugins/job/model_test.rb

@@ -0,0 +1,97 @@
+require_relative '../../test_helper'
+
+module Plugins
+  module Job
+    # Unit Test for RocketJob::Job
+    class ModelTest < Minitest::Test
+      class SimpleJob < RocketJob::Job
+        def perform
+          10
+        end
+      end
+
+      class TwoArgumentJob < RocketJob::Job
+        rocket_job do |job|
+          job.priority = 53
+        end
+
+        def perform(a, b)
+          a + b
+        end
+      end
+
+      describe RocketJob::Plugins::Job::Model do
+        after do
+          @job.destroy if @job && !@job.new_record?
+          @job2.destroy if @job2 && !@job2.new_record?
+          @job3.destroy if @job3 && !@job3.new_record?
+        end
+
+        describe '#scheduled?' do
+          it 'returns true if job is queued to run in the future' do
+            @job = SimpleJob.new(run_at: 1.day.from_now)
+            assert_equal true, @job.queued?
+            assert_equal true, @job.scheduled?
+            @job.start
+            assert_equal true, @job.running?
+            assert_equal false, @job.scheduled?
+          end
+
+          it 'returns false if job is queued and can be run now' do
+            @job = SimpleJob.new
+            assert_equal true, @job.queued?
+            assert_equal false, @job.scheduled?
+          end
+
+          it 'returns false if job is running' do
+            @job = SimpleJob.new
+            @job.start
+            assert_equal true, @job.running?
+            assert_equal false, @job.scheduled?
+          end
+        end
+
+        describe 'with queued jobs' do
+          before do
+            @job  = SimpleJob.create!(description: 'first')
+            @job2 = SimpleJob.create!(description: 'second', run_at: 1.day.from_now)
+            @job3 = SimpleJob.create!(description: 'third', run_at: 2.days.from_now)
+          end
+
+          describe '#scheduled' do
+            it 'returns only scheduled jobs' do
+              count = 0
+              RocketJob::Job.scheduled.each do |job|
+                count += 1
+                assert job.scheduled?
+              end
+              assert 2, count
+            end
+          end
+
+          describe '#queued_now' do
+            it 'returns only queued jobs, not scheduled ones' do
+              count = 0
+              RocketJob::Job.queued_now.each do |job|
+                count += 1
+                refute job.scheduled?
+              end
+              assert 1, count
+            end
+          end
+
+          describe '#queued' do
+            it 'returns all queued jobs' do
+              count = 0
+              RocketJob::Job.queued.each do |job|
+                count += 1
+              end
+              assert 3, count
+            end
+          end
+        end
+
+      end
+    end
+  end
+end