rufus-scheduler 2.0.24 → 3.1.0

data/spec/job_spec.rb

@@ -2,239 +2,628 @@
 #
 # Specifying rufus-scheduler
 #
-# Wed Apr 27 00:51:07 JST 2011
+# Wed Apr 17 06:00:59 JST 2013
 #
 
-require 'spec_base'
+require 'spec_helper'
 
 
-describe 'job classes' do
+describe Rufus::Scheduler::Job do
 
-  before(:each) do
-    @s = start_scheduler
+  # specify behaviours common to all job classes
+
+  before :each do
+
+    @taoe = Thread.abort_on_exception
+    Thread.abort_on_exception = false
+
+    @ose = $stderr
+    $stderr = StringIO.new
+
+    @scheduler = Rufus::Scheduler.new
   end
-  after(:each) do
-    stop_scheduler(@s)
+
+  after :each do
+
+    @scheduler.shutdown
+
+    Thread.abort_on_exception = @taoe
+
+    $stderr = @ose
   end
 
-  describe Rufus::Scheduler::Job do
+  describe '#last_time' do
 
-    describe '#running' do
+    it 'returns nil if the job never fired' do
 
-      it 'returns false when the job is inactive' do
+      job = @scheduler.schedule_in '10d' do; end
 
-        job = @s.in '2d' do
-        end
+      expect(job.last_time).to eq(nil)
+    end
 
-        job.running.should == false
-      end
+    it 'returns the last time the job fired' do
+
+      job = @scheduler.schedule_in '0s' do; end
+
+      sleep 0.4
+
+      expect(job.last_time).not_to eq(nil)
+    end
+  end
+
+  describe '#threads' do
+
+    it 'returns an empty list when the job is not running' do
+
+      job = @scheduler.in('1d', :job => true) {}
+
+      expect(job.threads.size).to eq(0)
+    end
+
+    it 'returns an empty list after the job terminated' do
+
+      job = @scheduler.in('0s', :job => true) {}
 
-      it 'returns true when the job is active' do
+      sleep 0.8
 
-        job = @s.in 0 do
-          sleep(100)
+      expect(job.threads.size).to eq(0)
+    end
+
+    it 'lists the threads the job currently runs in' do
+
+      job =
+        @scheduler.schedule_in('0s') do
+          sleep(1)
         end
 
-        wait_next_tick
+      sleep 0.4
 
-        job.running.should == true
-      end
+      expect(job.threads.size).to eq(1)
+
+      t = job.threads.first
+      expect(t[:rufus_scheduler_job]).to eq(job)
+    end
+  end
+
+  describe '#kill' do
+
+    it 'has no effect if the job is not running' do
+
+      job = @scheduler.schedule_in '10d' do; end
+
+      tls = Thread.list.size
 
-      it 'returns false when the job hits some error' do
+      job.kill
 
-        $exception = nil
+      expect(Thread.list.size).to eq(tls)
+    end
+
+    it 'makes the threads vacant' do
+
+      counter = 0
 
-        def @s.handle_exception(j, e)
-          #p e
-          $exception = e
+      job =
+        @scheduler.schedule_in '0s' do
+          sleep 2
+          counter = counter + 1
         end
 
-        job = @s.in 0 do
-          raise "nada"
+      sleep 1
+
+      v0 = @scheduler.work_threads(:vacant).size
+      a0 = @scheduler.work_threads(:active).size
+
+      job.kill
+
+      sleep 2
+
+      v1 = @scheduler.work_threads(:vacant).size
+      a1 = @scheduler.work_threads(:active).size
+
+      expect(counter).to eq(0)
+
+      expect(v0).to eq(0)
+      expect(a0).to eq(1)
+
+      expect(v1).to eq(1)
+      expect(a1).to eq(0)
+    end
+  end
+
+  describe '#running?' do
+
+    it 'returns false when the job is not running in any thread' do
+
+      job = @scheduler.in('1d', :job => true) {}
+
+      expect(job.running?).to eq(false)
+    end
+
+    it 'returns true when the job is running in at least one thread' do
+
+      job = @scheduler.in('0s', :job => true) { sleep(1) }
+
+      sleep 0.4
+
+      expect(job.running?).to eq(true)
+    end
+  end
+
+  describe '#scheduled?' do
+
+    it 'returns true when the job is scheduled' do
+
+      job = @scheduler.schedule_in('1d') {}
+
+      expect(job.scheduled?).to eq(true)
+    end
+
+    it 'returns false when the job is not scheduled' do
+
+      job = @scheduler.schedule_in('0.1s') {}
+
+      sleep 0.4
+
+      expect(job.scheduled?).to eq(false)
+    end
+
+    it 'returns true for repeat jobs that are running' do
+
+      job = @scheduler.schedule_interval('0.4s') { sleep(10) }
+
+      sleep 1
+
+      expect(job.running?).to eq(true)
+      expect(job.scheduled?).to eq(true)
+    end
+  end
+
+  describe '#call' do
+
+    it 'calls the job (like it were a proc)' do
+
+      counter = 0
+
+      job =
+        @scheduler.schedule_in('0.5s') do
+          counter = counter + 1
         end
+      job.call
+
+      sleep 0.8
+
+      expect(counter).to eq(2)
+    end
+  end
+
+  describe '#call(true)' do
 
-        wait_next_tick
+    it 'calls the job and let the scheduler handle errors' do
 
-        $exception.should_not == nil
-        job.running.should == false
+      $err = nil
+
+      def @scheduler.on_error(job, err)
+        $err = "#{job.class} #{job.original} #{err.message}"
+      rescue
+        p $!
       end
+
+      job =
+        @scheduler.schedule_in('1d') do
+          fail 'again'
+        end
+
+      job.call(true)
+
+      expect($err).to eq('Rufus::Scheduler::InJob 1d again')
     end
+  end
 
-    describe '#running?' do
+  describe '#call(false)' do
 
-      it 'is an alias for #running' do
+    it 'calls the job and let errors slip through' do
 
-        job = @s.in 0 do
-          sleep(100)
+      job =
+        @scheduler.schedule_in('1d') do
+          fail 'fast'
         end
 
-        wait_next_tick
+      begin
+
+        #job.call(false)
+        job.call # false is the default
+
+        expect(false).to eq(true)
 
-        job.running?.should == true
+      rescue => ex
+
+        expect(ex.message).to eq('fast')
       end
     end
   end
 
-  describe Rufus::Scheduler::AtJob do
+  context 'job-local variables' do
 
-    describe '#unschedule' do
+    describe '#[]=' do
 
-      it 'removes the job from the scheduler' do
+      it 'sets a job-local variable' do
 
-        job = @s.at Time.now + 3 * 3600 do
-        end
+        job =
+          @scheduler.schedule_every '1s' do |job|
+            job[:counter] ||= 0
+            job[:counter] += 1
+          end
+
+        sleep 3
+
+        expect(job[:counter]).to be > 1
+      end
+    end
 
-        wait_next_tick
+    describe '#[]' do
 
-        job.unschedule
+      it 'returns nil if there is no such entry' do
 
-        @s.jobs.size.should == 0
+        job = @scheduler.schedule_in '1s' do; end
+
+        expect(job[:nada]).to eq(nil)
+      end
+
+      it 'returns the value of a job-local variable' do
+
+        job = @scheduler.schedule_in '1s' do; end
+        job[:x] = :y
+
+        expect(job[:x]).to eq(:y)
       end
     end
 
-    describe '#next_time' do
+    describe '#key?' do
 
-      it 'returns the time when the job will trigger' do
+      it 'returns true if there is an entry with the given key' do
 
-        t = Time.now + 3 * 3600
+        job = @scheduler.schedule_in '1s' do; end
+        job[:x] = :y
 
-        job = @s.at Time.now + 3 * 3600 do
-        end
+        expect(job.key?(:x)).to eq(true)
+      end
+    end
+
+    describe '#keys' do
 
-        job.next_time.class.should == Time
-        job.next_time.to_i.should == t.to_i
+      it 'returns the array of keys of the job-local variables' do
+
+        job = @scheduler.schedule_in '1s' do; end
+        job[:x] = :y
+        job['hello'] = :z
+        job[123] = {}
+
+        expect(job.keys.sort_by { |k| k.to_s }).to eq([ 123, 'hello', :x ])
       end
     end
   end
 
-  describe Rufus::Scheduler::InJob do
+  context ':tag / :tags => [ t0, t1 ]' do
 
-    describe '#unschedule' do
+    it 'accepts one tag' do
 
-      it 'removes the job from the scheduler' do
+      job = @scheduler.in '10d', :job => true, :tag => 't0' do; end
 
-        job = @s.in '2d' do
-        end
+      expect(job.tags).to eq(%w[ t0 ])
+    end
 
-        wait_next_tick
+    it 'accepts an array of tags' do
 
-        job.unschedule
+      job = @scheduler.in '10d', :job => true, :tag => %w[ t0 t1 ] do; end
 
-        @s.jobs.size.should == 0
-      end
+      expect(job.tags).to eq(%w[ t0 t1 ])
     end
 
-    describe '#next_time' do
+    it 'turns tags into strings' do
+
+      job = @scheduler.in '10d', :job => true, :tags => [ 1, 2 ] do; end
 
-      it 'returns the time when the job will trigger' do
+      expect(job.tags).to eq(%w[ 1 2 ])
+    end
+  end
 
-        t = Time.now + 3 * 3600
+  context ':blocking => true' do
 
-        job = @s.in '3h' do
+    it 'runs the job in the same thread as the scheduler thread' do
+
+      job =
+        @scheduler.in('0s', :job => true, :blocking => true) do
+          sleep(1)
         end
 
-        job.next_time.class.should == Time
-        job.next_time.to_i.should == t.to_i
-      end
+      sleep 0.4
+
+      expect(job.threads.first).to eq(@scheduler.thread)
+
+      sleep 1.4
+
+      expect(job.threads.size).to eq(0)
     end
   end
 
-  describe Rufus::Scheduler::EveryJob do
+  context 'default one thread per job behaviour' do
 
-    describe '#next_time' do
+    it 'runs the job in a dedicated thread' do
 
-      it 'returns the time when the job will trigger' do
+      job =
+        @scheduler.in('0s', :job => true) do
+          sleep(1)
+        end
 
-        t = Time.now + 3 * 3600
+      sleep 0.4
 
-        job = @s.every '3h' do
-        end
+      expect(job.threads.first).not_to eq(@scheduler.thread)
+
+      sleep 1.4
+
+      expect(job.threads.size).to eq(0)
+    end
+  end
+
+  context ':allow_overlapping / :allow_overlap / :overlap' do
+
+    context 'default (:overlap => true)' do
+
+      it 'lets a job overlap itself' do
+
+        job =
+          @scheduler.every('0.3', :job => true) do
+            sleep(5)
+          end
+
+        sleep 3
+
+        expect(job.threads.size).to be > 1
+      end
+    end
+
+    context 'when :overlap => false' do
+
+      it 'prevents a job from overlapping itself' do
+
+        job =
+          @scheduler.every('0.3', :job => true, :overlap => false) do
+            sleep(5)
+          end
 
-        job.next_time.class.should == Time
-        job.next_time.to_i.should == t.to_i
+        sleep 3
+
+        expect(job.threads.size).to eq(1)
       end
     end
+  end
+
+  context ':mutex' do
 
-    describe '#paused?' do
+    context ':mutex => "mutex_name"' do
 
-      it 'returns false initially' do
+      it 'prevents concurrent executions' do
 
-        job = @s.every '3h' do; end
+        j0 =
+          @scheduler.in('0s', :job => true, :mutex => 'vladivostok') do
+            sleep(3)
+          end
+        j1 =
+          @scheduler.in('0s', :job => true, :mutex => 'vladivostok') do
+            sleep(3)
+          end
+
+        sleep 0.7
+
+        if j0.threads.any?
+          expect(j0.threads.size).to eq(1)
+          expect(j1.threads.size).to eq(0)
+        else
+          expect(j0.threads.size).to eq(0)
+          expect(j1.threads.size).to eq(1)
+        end
 
-        job.paused?.should == false
+        expect(@scheduler.mutexes.keys).to eq(%w[ vladivostok ])
       end
     end
 
-    describe '#pause' do
+    context ':mutex => mutex_instance' do
 
-      it 'pauses the job' do
+      it 'prevents concurrent executions' do
 
-        job = @s.every '3h' do; end
+        m = Mutex.new
 
-        job.pause
+        j0 = @scheduler.in('0s', :job => true, :mutex => m) { sleep(3) }
+        j1 = @scheduler.in('0s', :job => true, :mutex => m) { sleep(3) }
 
-        job.paused?.should == true
+        sleep 0.7
+
+        if j0.threads.any?
+          expect(j0.threads.size).to eq(1)
+          expect(j1.threads.size).to eq(0)
+        else
+          expect(j0.threads.size).to eq(0)
+          expect(j1.threads.size).to eq(1)
+        end
+
+        expect(@scheduler.mutexes.keys).to eq([])
       end
     end
 
-    describe '#resume' do
+    context ':mutex => [ array_of_mutex_names_or_instances ]' do
 
-      it 'resumes the job' do
+      it 'prevents concurrent executions' do
 
-        job = @s.every '3h' do; end
+        j0 =
+          @scheduler.in('0s', :job => true, :mutex => %w[ a b ]) do
+            sleep(3)
+          end
+        j1 =
+          @scheduler.in('0s', :job => true, :mutex => %w[ a b ]) do
+            sleep(3)
+          end
 
-        job.resume
+        sleep 0.7
 
-        job.paused?.should == false
+        if j0.threads.any?
+          expect(j0.threads.size).to eq(1)
+          expect(j1.threads.size).to eq(0)
+        else
+          expect(j0.threads.size).to eq(0)
+          expect(j1.threads.size).to eq(1)
+        end
+
+        expect(@scheduler.mutexes.keys.sort).to eq(%w[ a b ])
       end
     end
   end
 
-  describe Rufus::Scheduler::CronJob do
+  context ':timeout => duration_or_point_in_time' do
 
-    describe '#next_time' do
+    it 'interrupts the job it is stashed to (duration)' do
 
-      it 'returns the time when the job will trigger' do
+      counter = 0
+      toe = nil
 
-        job = @s.cron '* * * * *' do
+      job =
+        @scheduler.schedule_in '0s', :timeout => '1s' do
+          begin
+            counter = counter + 1
+            sleep 1.5
+            counter = counter + 1
+          rescue Rufus::Scheduler::TimeoutError => e
+            toe = e
+          end
         end
 
-        job.next_time.class.should == Time
-        (job.next_time.to_i - Time.now.to_i).should satisfy { |v| v < 60 }
+      sleep(3)
+
+      expect(counter).to eq(1)
+      expect(toe.class).to eq(Rufus::Scheduler::TimeoutError)
+    end
+
+    it 'interrupts the job it is stashed to (point in time)' do
+
+      counter = 0
+
+      job =
+        @scheduler.schedule_in '0s', :timeout => Time.now + 1 do
+          begin
+            counter = counter + 1
+            sleep 1.5
+            counter = counter + 1
+          rescue Rufus::Scheduler::TimeoutError => e
+          end
+        end
+
+      sleep(3)
+
+      expect(counter).to eq(1)
+    end
+
+    it 'starts timing when the job enters successfully all its mutexes' do
+
+      t0, t1, t2 = nil
+
+      @scheduler.schedule_in '0s', :mutex => 'a' do
+        sleep 1
+        t0 = Time.now
       end
+
+      job =
+        @scheduler.schedule_in '0.5s', :mutex => 'a', :timeout => '1s' do
+          begin
+            t1 = Time.now
+            sleep 2
+          rescue Rufus::Scheduler::TimeoutError => e
+            t2 = Time.now
+          end
+        end
+
+      sleep 3
+
+      expect(t0).to be <= t1
+
+      d = t2 - t1
+      expect(d).to be >= 1.0
+      expect(d).to be < 1.5
     end
 
-    describe '#paused?' do
+    it 'emits the timeout information to $stderr (default #on_error)' do
 
-      it 'returns false initially' do
+      @scheduler.every('1s', :timeout => '0.5s') do
+        sleep 0.9
+      end
 
-        job = @s.cron '* * * * *' do; end
+      sleep 2
 
-        job.paused?.should == false
+      expect($stderr.string).to match(/Rufus::Scheduler::TimeoutError/)
+    end
+
+    it 'does not prevent a repeat job from recurring' do
+
+      counter = 0
+
+      @scheduler.every('1s', :timeout => '0.5s') do
+        counter = counter + 1
+        sleep 0.9
       end
+
+      sleep 3
+
+      expect(counter).to be > 1
     end
+  end
 
-    describe '#pause' do
+  context 'work time' do
 
-      it 'pauses the job' do
+    describe '#last_work_time' do
 
-        job = @s.cron '* * * * *' do; end
+      it 'starts at 0' do
 
-        job.pause
+        job = @scheduler.schedule_every '5m' do; end
 
-        job.paused?.should == true
+        expect(job.last_work_time).to eq(0.0)
+      end
+
+      it 'keeps track of how long the work was upon last trigger' do
+
+        job =
+          @scheduler.schedule_in '0.5s'  do
+            sleep 0.7
+          end
+
+        sleep 2
+
+        expect(job.last_work_time).to be >= 0.7
+        expect(job.last_work_time).to be < 0.8
       end
     end
 
-    describe '#resume' do
+    describe '#mean_work_time' do
+
+      it 'starts at 0' do
+
+        job = @scheduler.schedule_every '5m' do; end
+
+        expect(job.mean_work_time).to eq(0.0)
+      end
 
-      it 'resumes the job' do
+      it 'gathers work times and computes the mean' do
 
-        job = @s.cron '* * * * *' do; end
+        job =
+          @scheduler.schedule_every '0.5s' do |j|
+            #p j.last_work_time
+            #p j.mean_work_time
+            sleep 0.01 * (j.count + 1)
+          end
 
-        job.resume
+        sleep 4.6
 
-        job.paused?.should == false
+        expect(job.last_work_time).to be >= 0.08
+        expect(job.last_work_time).to be < 0.099
+        expect(job.mean_work_time).to be > 0.05
+        expect(job.mean_work_time).to be < 0.06
       end
     end
   end