sisyphus 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09c4ed5586564bbe862e247e22ade9cf3b8d0d91
-  data.tar.gz: 89cb27f90e6b9b62e7152cea92866ef3b88f83f1
+  metadata.gz: 1a96cdf599669e601888f70c06de7ae280b86fc6
+  data.tar.gz: 601d5544f93601e4b9aac5df9dad122040742300
 SHA512:
-  metadata.gz: 1835644e1bb451fa689024a33fba8e1e12f2f6ce6ded605611b4564117ae09f0c67f58c749f984c271ef8eab2509da5f56f3c832e11a3fcf08036830c0503797
-  data.tar.gz: 823fb159c29104d485fa6f7320b2340de260fb36d463cd80096d3c78d45e275687d6b30ccf3c5dcdb238dfaabea886d9a9912ccc5e7f2a1ca2a1c3a948e007f0
+  metadata.gz: 731a337d88e4ca319a824c2fdb44f2343808adfd1a15762bfb6a2417666c7aca8182b2859bf495c33f4c48c170091061b36f18fb0088281258288fe677a5d55a
+  data.tar.gz: e4c2bcbfb26349558d25d705fb69f370cc05e4040f8f46bc4430794b448b1e621bcece6988b68318a2ee6dba128594001cd42f2212bf52ac9ec79125e9704afc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sisyphus (0.2.1)
+    sisyphus (0.2.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -22,11 +22,16 @@ the job receives the `perform` message.
 Getting started
 ---------------
 
-1. Add `gem 'coolie'` to your Gemfile and run `bundle`
+1. Add `gem 'sisyphus'` to your Gemfile and run `bundle`
 2. Subclass `Sisyphus::Job` and implement the `perform` method
 3. Instantiate the `Sisyphus::Master`, giving it an instance of your job
-   and optionally an options hash with the key `:workers` specifying the
-   number of workers you need
+   and optionally an `options` hash. The `options` hash supports the
+   following keys:
+   * `:workers` which specifies the number (`FixNum`) of workers you need.
+   * `:logger` which is used to log any exceptions the
+     master or workers encounter. The logger should quack like a
+     `Logger` instance from the Ruby stdlib. Exceptions are logged with the
+     `Logger::WARN` level.
 4. You can start workers by doing one of the following things:
    * Send the `start` message to the master, if the `options` hash was
      provided. This starts a run loop which monitors workers and

data/lib/sisyphus/master.rb

@@ -1,5 +1,6 @@
 require 'timeout'
 require_relative './worker'
+require_relative './null_logger'
 
 module Sisyphus
   class Master
@@ -7,8 +8,11 @@ module Sisyphus
 
     HANDLED_SIGNALS = [:INT, :TTIN, :TTOU]
 
+    attr_reader :logger
+
     def initialize(job, options = {})
       @number_of_workers = options.fetch :workers, 0
+      @logger = options.fetch :logger, NullLogger.new
       @workers = []
       @job = job
 
@@ -35,17 +39,22 @@ module Sisyphus
         @workers << { pid: wpid, reader: reader }
       else
         reader.close
-        worker = Worker.new(@job, writer)
         self.process_name = "Worker #{Process.pid}"
-        worker.start
+        begin
+          worker = Worker.new(@job, writer, logger)
+          worker.setup
+          worker.start
+        rescue Exception => e
+          writer.write Worker::UNCAUGHT_ERROR
+          logger.warn(process_name) { e }
+          exit! 0
+        end
       end
     end
 
     def stop_worker(wpid)
       if @workers.find { |w| w.fetch(:pid) == wpid }
-        Process.kill 'INT', wpid
-      else
-        raise "Unknown worker PID: #{wpid}"
+        Process.kill 'INT', wpid rescue Errno::ESRCH # Ignore if the process is already gone
       end
     end
 
@@ -184,5 +193,9 @@ module Sisyphus
     def process_name=(name)
       $0 = name
     end
+
+    def process_name
+      $0
+    end
   end
 end

data/lib/sisyphus/null_logger.rb

@@ -0,0 +1,11 @@
+require 'logger'
+
+module Sisyphus
+  class NullLogger < Logger
+    def initialize(*args)
+    end
+
+    def add(*args, &block)
+    end
+  end
+end

data/lib/sisyphus/worker.rb

@@ -2,10 +2,16 @@ module Sisyphus
   class Worker
     UNCAUGHT_ERROR = '.'
 
-    def initialize(job, output)
+    attr_reader :logger
+
+    def initialize(job, output, logger)
       @job = job
       @output = output
-      setup
+      @logger = logger
+    end
+
+    def setup
+      @job.setup if @job.respond_to? :setup
     end
 
     def start
@@ -34,7 +40,8 @@ module Sisyphus
         begin
           @job.perform
           exit! 0
-        rescue Exception
+        rescue Exception => e
+          logger.warn(process_name) { e }
           exit! 1
         end
       end
@@ -54,12 +61,12 @@ module Sisyphus
       @stopped
     end
 
-    def setup
-      @job.setup if @job.respond_to? :setup
-    end
-
     def process_name=(name)
       $0 = name
     end
+
+    def process_name
+      $0
+    end
   end
 end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Sisyphus
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/spec/sisyphus/master_spec.rb

@@ -25,9 +25,15 @@ module Sisyphus
           Process.stub(:pid) { 666 }
           master.stub :exit!
           Worker.stub(:new) { worker }
+          worker.stub(:setup)
           worker.stub(:start)
         end
 
+        it 'should setup the worker' do
+          worker.should_receive :setup
+          master.start_worker
+        end
+
         it 'should rename the process' do
           master.should_receive(:process_name=).with("Worker #{666}")
           master.start_worker
@@ -39,7 +45,7 @@ module Sisyphus
         end
 
         it 'gives the writer pipe to the worker' do
-          Worker.should_receive(:new).with(job, pipes.last) { worker }
+          Worker.should_receive(:new).with(job, pipes.last, master.logger) { worker }
           master.start_worker
         end
 
@@ -47,6 +53,26 @@ module Sisyphus
           pipes.first.should_receive :close
           master.start_worker
         end
+
+        describe 'when an exception is raised' do
+          let(:logger) { double(:logger) }
+
+          it 'should log the exception' do
+            master.stub(:logger).and_return logger
+            pipes.last.stub(:write)
+            worker.stub(:setup).and_raise :raised_by_spec
+            logger.should_receive :warn
+            master.start_worker
+          end
+
+          it 'should write to the writer pipe' do
+            master.stub(:logger).and_return logger
+            worker.stub(:setup).and_raise :raised_by_spec
+            logger.stub :warn
+            pipes.last.should_receive(:write).with Worker::UNCAUGHT_ERROR
+            master.start_worker
+          end
+        end
       end
 
       describe 'in the master process' do
@@ -103,7 +129,7 @@ module Sisyphus
     describe 'when there are no running workers' do
       describe 'and it receives stop_worker' do
         it 'raises an error' do
-          expect { master.stop_worker(666) }.to raise_error("Unknown worker PID: #{666}")
+          expect { master.stop_worker(666) }.not_to raise_error
         end
       end
 

data/spec/sisyphus/worker_spec.rb

@@ -4,7 +4,8 @@ module Sisyphus
   describe Worker do
     let(:job) { double :job }
     let(:output) { double :pipe }
-    let(:worker) { Worker.new job, output }
+    let(:logger) { double :logger }
+    let(:worker) { Worker.new job, output, logger }
 
     it 'traps signals when started' do
       worker.stub :exit!
@@ -23,15 +24,15 @@ module Sisyphus
       it 'does not call job.setup' do
         job.stub(:respond_to?).with(:setup) { false }
         job.should_not_receive :setup
-        Worker.new job, output
+        Worker.new job, output, logger
       end
     end
 
     context 'when job responds to :setup' do
-      it 'sets up the job upon initialization' do
+      it 'sets up the job' do
         job.stub(:respond_to?).with(:setup) { true }
         job.should_receive :setup
-        Worker.new job, output
+        worker.setup
       end
     end
 
@@ -62,10 +63,18 @@ module Sisyphus
 
       context 'when job.perform raises an error' do
         it 'should exit with a non-zero status' do
+          logger.stub :warn
           job.stub(:perform).and_raise Exception.new "should be rescued!"
           worker.should_receive(:exit!).with(1)
           worker.send :perform_job
         end
+
+        it 'should log the raised error' do
+          worker.stub(:exit!).with(1)
+          job.stub(:perform).and_raise Exception.new "should be rescued!"
+          logger.should_receive :warn
+          worker.send :perform_job
+        end
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sisyphus
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Rasmus Bang Grouleff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-29 00:00:00.000000000 Z
+date: 2013-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -68,6 +68,7 @@ files:
 - lib/sisyphus.rb
 - lib/sisyphus/job.rb
 - lib/sisyphus/master.rb
+- lib/sisyphus/null_logger.rb
 - lib/sisyphus/sleep.rb
 - lib/sisyphus/worker.rb
 - lib/version.rb