queueing_rabbit 0.3.5 → 0.3.6

data/lib/queueing_rabbit/client/bunny.rb

@@ -89,6 +89,8 @@ module QueueingRabbit
 
       def close
         @connection.close
+        yield if block_given?
+        @continue_worker_loop = false
       end
 
       def open?
@@ -97,7 +99,9 @@ module QueueingRabbit
 
       def begin_worker_loop
         yield
-        @connection.reader_loop.join
+        @continue_worker_loop = true
+        # We may need to add signal handling here
+        sleep 2 while @continue_worker_loop
       end
 
     private

data/lib/queueing_rabbit/tasks.rb

@@ -8,10 +8,6 @@ namespace :queueing_rabbit do
   task :work => :setup do
     require 'queueing_rabbit'
 
-    if ENV['PIDFILE'] && File.exists?(ENV['PIDFILE'])
-      abort "PID file already exists. Is the worker running?"
-    end
-
     jobs = (ENV['JOBS'] || ENV['JOB']).to_s.split(',')
 
     begin
@@ -28,10 +24,11 @@ namespace :queueing_rabbit do
       Process.daemon(true)
     end
 
-    worker.use_pidfile(ENV['PIDFILE']) if ENV['PIDFILE']
-
-    worker.info "starting a new queueing_rabbit worker #{worker}"
-
-    worker.work!
+    begin
+      worker.use_pidfile(ENV['PIDFILE']) if ENV['PIDFILE']
+      worker.work!
+    rescue QueueingRabbit::Worker::WorkerError => e
+      abort e.message
+    end
   end
 end

data/lib/queueing_rabbit/version.rb

@@ -1,3 +1,3 @@
 module QueueingRabbit
-  VERSION = "0.3.5"
+  VERSION = "0.3.6"
 end

data/lib/queueing_rabbit/worker.rb

@@ -1,5 +1,8 @@
 module QueueingRabbit
   class Worker
+
+    class WorkerError < RuntimeError; end
+
     include QueueingRabbit::Logging
 
     attr_accessor :jobs
@@ -13,28 +16,37 @@ module QueueingRabbit
     end
 
     def work
-      conn = QueueingRabbit.connection
-      trap_signals(conn)
+      trap_signals
 
       QueueingRabbit.trigger_event(:worker_ready)
 
-      jobs.each { |job| run_job(conn, job) }
+      jobs.each { |job| run_job(QueueingRabbit.connection, job) }
 
       QueueingRabbit.trigger_event(:consuming_started)
     end
 
     def work!
-      QueueingRabbit.begin_worker_loop do
-        work
-      end
+      info "starting a new queueing_rabbit worker #{self}"
+
+      QueueingRabbit.begin_worker_loop { work }
     end
 
     def use_pidfile(filename)
-      File.open(@pidfile = filename, 'w') { |f| f << pid }
+      @pidfile = filename
+      cleanup_pidfile
+      File.open(@pidfile, 'w') { |f| f << pid }
     end
 
     def remove_pidfile
-      File.delete(@pidfile) if @pidfile && File.exists?(@pidfile)
+      File.delete(@pidfile) if pidfile_exists?
+    end
+
+    def read_pidfile
+      File.read(@pidfile).to_i if pidfile_exists?
+    end
+
+    def pidfile_exists?
+      @pidfile && File.exists?(@pidfile)
     end
 
     def pid
@@ -45,6 +57,16 @@ module QueueingRabbit
       "PID=#{pid}, JOBS=#{jobs.join(',')}"
     end
 
+    def stop
+      return unless QueueingRabbit.connection
+
+      QueueingRabbit.connection.close {
+        info "gracefully shutting down the worker #{self}"
+        remove_pidfile
+        QueueingRabbit.trigger_event(:consuming_done)
+      }
+    end
+
   private
 
     def validate_jobs
@@ -80,7 +102,7 @@ module QueueingRabbit
       elsif job <= QueueingRabbit::AbstractJob
         job.new(payload, metadata).perform
       else
-        error "do not know how to perform job #{job}"
+        error "don't know how to perform job #{job}"
       end
     end
 
@@ -89,16 +111,20 @@ module QueueingRabbit
       $stderr.sync = true
     end
 
-    def trap_signals(connection)
-      handler = Proc.new do
-        connection.close {
-          QueueingRabbit.trigger_event(:consuming_done)
-          remove_pidfile
-        }
-      end
+    def trap_signals
+      Signal.trap("TERM") { stop }
+      Signal.trap("INT") { stop }
+    end
 
-      Signal.trap("TERM", &handler)
-      Signal.trap("INT", &handler)
+    def cleanup_pidfile
+      return unless pid_in_file = read_pidfile
+      Process.getpgid(pid_in_file)
+      fatal "failed to use the pidfile #{@pidfile}. It is already " \
+            "in use by a process with pid=#{pid_in_file}."
+      raise WorkerError.new('The pidfile is already in use.')
+    rescue Errno::ESRCH
+      info "found abandoned pidfile: #{@pidfile}. Can be safely overwritten."
     end
+
   end
 end

data/spec/unit/queueing_rabbit/client/bunny_spec.rb

@@ -126,5 +126,23 @@ describe QueueingRabbit::Client::Bunny do
       end
     end
 
+    describe '#close' do
+
+      before do
+        connection.should_receive(:close)
+      end
+
+      it 'closes the connection and yields a block if given' do
+        expect { |b| client.close(&b) }.to yield_control
+      end
+
+      it 'discontinues the worker loop' do
+        expect { |b| client.close(&b) }.
+            to change{client.instance_variable_get(:@continue_worker_loop)}.
+               to(false)
+      end
+
+    end
+
   end
 end

data/spec/unit/queueing_rabbit/worker_spec.rb

@@ -69,7 +69,7 @@ describe QueueingRabbit::Worker do
 
     describe '#work' do
       before do
-        QueueingRabbit.should_receive(:connection).and_return(connection)
+        QueueingRabbit.stub(:connection).and_return(connection)
         [class_based_job, instance_based_job].each do |job|
           QueueingRabbit.should_receive(:follow_job_requirements).
                          with(job).
@@ -106,13 +106,45 @@ describe QueueingRabbit::Worker do
       let(:file_name) { mock }
       let(:file) { mock }
 
-      before do
-        File.should_receive(:open).with(file_name, 'w').and_yield(file)
-        file.should_receive(:<<).with(Process.pid)
+      context 'given pidfile is already in use' do
+
+        it 'raises a worker error' do
+          File.stub(:exists?).with(file_name).and_return(true)
+          File.should_receive(:read).with(file_name).and_return('123')
+          Process.should_receive(:getpgid).with(123).and_return(123)
+          expect { subject.use_pidfile(file_name) }.
+              to raise_error(QueueingRabbit::Worker::WorkerError)
+        end
+
       end
 
-      it 'writes pid to a file' do
-        subject.use_pidfile(file_name)
+      context 'given pidfile is not in use' do
+
+        before do
+          File.should_receive(:open).with(file_name, 'w').and_yield(file)
+          file.should_receive(:<<).with(Process.pid)
+        end
+
+        context 'there is an abandoned pidfile' do
+
+          it 'removes the abandoned pidfile and writes pid to a file' do
+            File.stub(:exists?).with(file_name).and_return(true)
+            File.should_receive(:read).with(file_name).and_return('123')
+            Process.should_receive(:getpgid).with(123).and_raise(Errno::ESRCH)
+            subject.use_pidfile(file_name)
+          end
+
+        end
+
+        context 'new pidfile' do
+
+          it 'creates a pidfile' do
+            File.stub(:exists?).with(file_name).and_return(false)
+            subject.use_pidfile(file_name)
+          end
+
+        end
+
       end
     end
 
@@ -133,5 +165,25 @@ describe QueueingRabbit::Worker do
     describe "#pid" do
       its(:pid) { should == Process.pid }
     end
+
+    describe '#stop' do
+
+      let(:file_name) { mock }
+
+      before do
+        subject.instance_variable_set(:@pidfile, file_name)
+        QueueingRabbit.stub(:connection).and_return(connection)
+      end
+
+      it 'closes the connection, removes the pidfile and reports the event' do
+        connection.should_receive(:close).and_yield
+        File.stub(:exists?).with(file_name).and_return(true)
+        File.should_receive(:delete).with(file_name)
+        QueueingRabbit.should_receive(:trigger_event).with(:consuming_done)
+        subject.stop
+      end
+
+    end
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: queueing_rabbit
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-08 00:00:00.000000000 Z
+date: 2014-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amqp
@@ -172,7 +172,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2062286161310013900
+      hash: -1747676710658043461
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -181,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2062286161310013900
+      hash: -1747676710658043461
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23