zeevex_reliability 0.1.0 → 0.1.1

data/lib/zeevex_reliability/optimistic_lock_retryable.rb

@@ -1,6 +1,8 @@
 module ZeevexReliability
   module OptimisticLockRetryable
     def self.included(base)
+      require 'active_record'
+      require 'active_record/base'
       base.class_eval do
         include InstanceMethods
       end

data/lib/zeevex_reliability/retryable.rb

@@ -14,7 +14,7 @@ module ZeevexReliability
     #     # your code here
     #   end
     #
-    def self.retry(options = {}, &block)
+    def self.retryable(options = {}, &block)
       opts = { :tries => 3, :on => StandardError }.merge(options)
 
       retry_exception, retries = opts[:on], opts[:tries]

data/lib/zeevex_reliability/version.rb

@@ -1,3 +1,3 @@
 module ZeevexReliability
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/optimistic_lock_retryable_spec.rb

@@ -0,0 +1,121 @@
+# -*- coding: utf-8 -*-
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper.rb')
+
+require 'logger'
+
+class RunnerModel
+
+  include ZeevexReliability::OptimisticLockRetryable
+
+  def initialize(retry_count = 2)
+    @retry_count = retry_count
+    @executed = 0
+    @reload_count = 0
+  end
+
+  def execution_count
+    @executed
+  end
+
+  def succeed_at_once
+    @executed += 1
+    true
+  end
+
+  def never_succeed(error = ActiveRecord::StaleObjectError)
+    @executed += 1
+    raise error
+  end
+
+  def succeed_eventually(error = ActiveRecord::StaleObjectError)
+    @executed += 1
+
+    return true if @retry_count == 0
+    @retry_count -= 1
+    raise error
+  end
+
+  def reload
+    @reload_count += 1
+  end
+
+  def reload!
+    reload
+  end
+
+  def changed?
+    false
+  end
+
+end
+
+describe ZeevexReliability::OptimisticLockRetryable do 
+
+  let :logger do
+    Logger.new("/dev/null")
+  end
+  
+  let :runner do
+    RunnerModel.new
+  end
+
+  context "without error" do
+    it "should execute once and succeed" do
+      runner.with_optimistic_retry do
+        runner.succeed_at_once
+      end.should == true
+      runner.execution_count.should == 1
+    end
+  end
+
+  context "caught error" do
+    it "when block fails twice and then succeeds, should return true" do
+      runner.should_receive(:reload).twice.and_return(true)
+
+      runner.with_optimistic_retry do
+        runner.succeed_eventually
+      end.should == true
+      runner.execution_count.should == 3
+    end
+
+    it "when block fails twice and then succeeds, should return true" do
+      runner.should_receive(:changed?).and_return(true)
+      runner.should_receive(:logger).and_return(logger)
+      logger.should_receive(:warn).once
+      
+      runner.with_optimistic_retry do
+        runner.succeed_eventually
+      end.should == true
+    end
+
+    it "when block always fails, it should stop after 3 tries then re-raise error" do
+      expect {
+        runner.with_optimistic_retry do
+          runner.never_succeed
+        end
+      }.to raise_error(ActiveRecord::StaleObjectError)
+      runner.execution_count.should == 3
+    end
+
+    it "when block always fails, it should stop after # of tries specified then re-raise error" do
+      expect {
+        runner.with_optimistic_retry(:tries => 10) do
+          runner.never_succeed
+        end
+      }.to raise_error(ActiveRecord::StaleObjectError)
+      runner.execution_count.should == 10
+    end
+  end
+
+  context "uncaught error" do
+    it "should fail once and not retry" do
+      expect {
+        runner.with_optimistic_retry do
+          runner.never_succeed(NameError)
+        end
+      }.to raise_error(NameError)
+      runner.execution_count.should == 1
+    end
+  end
+end

data/spec/retryable_spec.rb

@@ -0,0 +1,94 @@
+# -*- coding: utf-8 -*-
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper.rb')
+
+class Runner
+  def initialize(retry_count = 2)
+    @retry_count = retry_count
+    @executed = 0
+  end
+
+  def execution_count
+    @executed
+  end
+  
+  def succeed_at_once
+    @executed += 1
+    true
+  end
+
+  def never_succeed(error = ArgumentError)
+    @executed += 1
+    raise error
+  end
+
+  def succeed_eventually(error = ArgumentError)
+    @executed += 1
+
+    return true if @retry_count == 0
+    @retry_count -= 1
+    raise error
+  end
+    
+  def raise_known
+    raise ArgumentError
+  end
+
+  def raise_unknown
+    raise "Just some other thing"
+  end
+end
+
+describe ZeevexReliability::Retryable do 
+
+  let :runner do
+    Runner.new
+  end
+  
+  context "without error" do
+    it "should execute once and succeed" do
+      ZeevexReliability::Retryable.retryable do
+        runner.succeed_at_once
+      end.should == true
+      runner.execution_count.should == 1
+    end
+  end
+
+  context "caught error" do
+    it "when block fails twice and then succeeds, should return true" do
+      ZeevexReliability::Retryable.retryable(:on => ArgumentError) do
+        runner.succeed_eventually
+      end.should == true
+      runner.execution_count.should == 3
+    end
+
+    it "when block always fails, it should stop after 3 tries then re-raise error" do
+      expect {
+        ZeevexReliability::Retryable.retryable(:on => ArgumentError) do
+          runner.never_succeed
+        end
+      }.to raise_error(ArgumentError)
+      runner.execution_count.should == 3
+    end
+
+    it "when block always fails, it should stop after # of tries specified then re-raise error" do
+      expect {
+        ZeevexReliability::Retryable.retryable(:on => ArgumentError, :tries => 10) do
+          runner.never_succeed
+        end
+      }.to raise_error(ArgumentError)
+      runner.execution_count.should == 10
+    end
+  end
+
+  context "uncaught error" do
+    it "should fail once and not retry" do
+      expect {
+        ZeevexReliability::Retryable.retryable(:on => NameError) do
+          runner.never_succeed
+        end
+      }.to raise_error(ArgumentError)
+      runner.execution_count.should == 1
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+# -*- coding: utf-8 -*-
+
+$: << File.expand_path(File.dirname(__FILE__) + '../lib')
+
+require 'rspec'
+require 'active_record'
+
+require 'zeevex_reliability'

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Robert Sanders
@@ -74,6 +74,9 @@ files:
 - lib/zeevex_reliability/optimistic_lock_retryable.rb
 - lib/zeevex_reliability/retryable.rb
 - lib/zeevex_reliability/version.rb
+- spec/optimistic_lock_retryable_spec.rb
+- spec/retryable_spec.rb
+- spec/spec_helper.rb
 - zeevex_reliability.gemspec
 has_rdoc: true
 homepage: ""
@@ -105,5 +108,7 @@ rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Utility functions to automate retry loops
-test_files: []
-
+test_files: 
+- spec/optimistic_lock_retryable_spec.rb
+- spec/retryable_spec.rb
+- spec/spec_helper.rb