rspec-retry 0.4.5 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 08f3170cb5eb3a96fbf45a6facaac88f02261c99
-  data.tar.gz: a7831c2d528f9fb89f04aba2da2d0caf989741a3
+  metadata.gz: 80a92fbfbdc8b02950034f0bb7bdd72128e4cfc5
+  data.tar.gz: ee08ca136b1b395852588248cba85979e98addc3
 SHA512:
-  metadata.gz: 345abf819be3c81a57da26220b46c6d19441d012350d101ff97ecec3d98e1d6d9f552ecb18e62600827fb3beb76911937a13e15f097ad1338e4a25650e4c7ce0
-  data.tar.gz: 21c46735aac3ae909c27b162b65eff164a4a7bb36233efdf55f65b6fcfbd3bd35a3775b58dbbb5a870ce8c09369559f75ccd52f9eccef90ba00e9ce46fd1693a
+  metadata.gz: a4bde86cebd9d880131499789b673b2466ef4a75269084bcd28e82810bd35d07bc091cceb420c06bef1559701301c2275930eba94e9ff2274f8cf5b53ddd4b16
+  data.tar.gz: 0fa26f941a2cba998405e42d07c8d962a909ead3e015f40182db03b0c8d2a2d78f136ccb74ab19bddf88d0033c3c88cdc21e1856837c5eb9169ca5618f7ac7a0

data/README.md

@@ -64,6 +64,7 @@ You can call `ex.run_with_retry(opts)` on an individual example.
 - __:default_retry_count__(default: *1*) If retry count is not set in an example, this value is used by default
 - __:default_sleep_interval__(default: *0*) Seconds to wait between retries
 - __:clear_lets_on_failure__(default: *true*) Clear memoized values for ``let``s before retrying
+- __:exceptions_to_hard_fail__(default: *[]*) List of exceptions that will trigger an immediate test failure without retry. Takes precedence over __:exceptions_to_retry__
 - __:exceptions_to_retry__(default: *[]*) List of exceptions that will trigger a retry (when empty, all exceptions will)
 
 ## Environment Variables

data/changelog.md

@@ -1,8 +1,12 @@
+# 0.4.6 - 2016-8-8
+failure message was off by 1 (thanks @anthonywoo, @vgrigoruk / #57)
+add the `exceptions_to_hard_fail` options (thanks @james-dominy, @ShockwaveNN / #59)
+add retry reporter & api for accessing retry from reporter (thanks @tdeo / #54)
+
 # 0.4.5 - 2015-11-4
 ## enhancements
 retry can be called programmatically (thanks, @dwbutler / #45)
 
-
 # 0.4.4 - 2015-9-9
 ## bugfixes
 fix gem permissions to be readable (thanks @jdelStrother / #42)

data/lib/rspec/retry.rb

@@ -11,6 +11,14 @@ module RSpec
         config.add_setting :default_sleep_interval, :default => 0
         config.add_setting :clear_lets_on_failure, :default => true
         config.add_setting :display_try_failure_messages, :default => false
+
+        # If a list of exceptions is provided and 'retry' > 1, we only retry if
+        # the exception that was raised by the example is NOT in that list. Otherwise
+        # we ignore the 'retry' value and fail immediately.
+        #
+        # If no list of exceptions is provided and 'retry' > 1, we always retry.
+        config.add_setting :exceptions_to_hard_fail, :default => []
+
         # If a list of exceptions is provided and 'retry' > 1, we only retry if
         # the exception that was raised by the example is in that list. Otherwise
         # we ignore the 'retry' value and fail immediately.
@@ -69,6 +77,11 @@ module RSpec
           RSpec.configuration.default_sleep_interval
     end
 
+    def exceptions_to_hard_fail
+      ex.metadata[:exceptions_to_hard_fail] ||
+          RSpec.configuration.exceptions_to_hard_fail
+    end
+
     def exceptions_to_retry
       ex.metadata[:exceptions_to_retry] ||
           RSpec.configuration.exceptions_to_retry
@@ -86,8 +99,9 @@ module RSpec
       example = current_example
 
       loop do
-        if verbose_retry?
-          if attempts > 0
+        if attempts > 0
+          RSpec.configuration.formatters.each { |f| f.retry(example) if f.respond_to? :retry }
+          if verbose_retry?
             message = "RSpec::Retry: #{ordinalize(attempts + 1)} try #{example.location}"
             message = "\n" + message if attempts == 1
             RSpec.configuration.reporter.message(message)
@@ -103,6 +117,12 @@ module RSpec
 
         break if attempts >= retry_count
 
+        if exceptions_to_hard_fail.any?
+          break if exceptions_to_hard_fail.any? do |exception_klass|
+            example.exception.is_a?(exception_klass)
+          end
+        end
+
         if exceptions_to_retry.any?
           break unless exceptions_to_retry.any? do |exception_klass|
             example.exception.is_a?(exception_klass)
@@ -110,8 +130,8 @@ module RSpec
         end
 
         if verbose_retry? && display_try_failure_messages?
-          if attempts != (retry_count-1)
-            try_message = "#{ordinalize(attempts + 1)} Try error in #{example.location}:\n #{example.exception.to_s} \n"
+          if attempts != retry_count
+            try_message = "#{ordinalize(attempts)} Try error in #{example.location}:\n #{example.exception.to_s} \n"
             RSpec.configuration.reporter.message(try_message)
           end
         end

data/lib/rspec/retry/formatter.rb

@@ -0,0 +1,56 @@
+require 'rspec/core/formatters/base_text_formatter'
+
+class RSpec::Retry::Formatter < RSpec::Core::Formatters::BaseTextFormatter
+  RSpec::Core::Formatters.register self, :example_passed
+
+  def initialize(output)
+    super(output)
+    @tries = Hash.new { |h, k| h[k] = { successes: 0, tries: 0 } }
+  end
+
+  def seed(_); end
+
+  def message(_message); end
+
+  def close(_); end
+
+  def dump_failures(_); end
+
+  def dump_pending(_); end
+
+  def dump_summary(notification)
+    output = "\nRSpec Retry Summary:\n"
+    @tries.each do |key, retry_data|
+      next if retry_data[:successes] < 1 || retry_data[:tries] <= 1
+      output += "\t#{key.location}: #{key.full_description}: passed at attempt #{retry_data[:tries]}\n"
+    end
+    retried = @tries.count { |_, v| v[:tries] > 1  && v[:successes] > 0 }
+    output += "\n\t#{retried} of #{notification.example_count} tests passed with retries.\n"
+    output += "\t#{notification.failure_count} tests failed all retries.\n"
+    puts output
+  end
+
+  def example_passed(notification)
+    increment_success notification.example
+  end
+
+  def retry(example)
+    increment_tries example
+  end
+
+  private
+
+  def increment_success(example)
+    # debugger
+    previous = @tries[example]
+    @tries[example] = {
+      successes: previous[:successes] + 1, tries: previous[:tries] + 1 }
+  end
+
+  def increment_tries(example)
+    # debugger
+    previous = @tries[example]
+    @tries[example] = {
+      successes: previous[:successes], tries: previous[:tries] + 1 }
+  end
+end

data/lib/rspec/retry/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   class Retry
-    VERSION = "0.4.5"
+    VERSION = "0.4.6"
   end
 end

data/spec/lib/rspec/retry_spec.rb

@@ -19,6 +19,13 @@ describe RSpec::Retry do
     @expectations.shift
   end
 
+  class RetryError < StandardError; end
+  class RetryChildError < RetryError; end
+  class HardFailError < StandardError; end
+  class HardFailChildError < HardFailError; end
+  class OtherError < StandardError; end;
+  class SharedError < StandardError; end;
+
   before(:all) do
     ENV.delete('RSPEC_RETRY_RETRY_COUNT')
   end
@@ -77,17 +84,42 @@ describe RSpec::Retry do
       end
     end
 
-    describe "with a list of exceptions", :retry => 2, :exceptions_to_retry => [NameError] do
+    describe "with a list of exceptions to immediately fail on", :retry => 2, :exceptions_to_hard_fail => [HardFailError] do
+      context "the example throws an exception contained in the hard fail list" do
+        it "does not retry" do
+          expect(count).to be < 2
+          pending "This should fail with a count of 1: Count was #{count}"
+          raise HardFailError unless count > 1
+        end
+      end
+
+      context "the example throws a child of an exception contained in the hard fail list" do
+        it "does not retry" do
+          expect(count).to be < 2
+          pending "This should fail with a count of 1: Count was #{count}"
+          raise HardFailChildError unless count > 1
+        end
+      end
+
+      context "the throws an exception not contained in the hard fail list" do
+        it "retries the maximum number of times" do
+          raise OtherError unless count > 1
+          expect(count).to eq(2)
+        end
+      end
+    end
+
+    describe "with a list of exceptions to retry on", :retry => 2, :exceptions_to_retry => [RetryError] do
       context "the example throws an exception contained in the retry list" do
         it "retries the maximum number of times" do
-          raise NameError unless count > 1
+          raise RetryError unless count > 1
           expect(count).to eq(2)
         end
       end
 
       context "the example throws a child of an exception contained in the retry list" do
         it "retries the maximum number of times" do
-          raise NoMethodError unless count > 1
+          raise RetryChildError unless count > 1
           expect(count).to eq(2)
         end
       end
@@ -99,6 +131,39 @@ describe RSpec::Retry do
         end
       end
     end
+
+    describe "with both hard fail and retry list of exceptions", :retry => 2, :exceptions_to_retry => [SharedError, RetryError], :exceptions_to_hard_fail => [SharedError, HardFailError] do
+      context "the exception thrown exists in both lists" do
+        it "does not retry because the hard fail list takes precedence" do
+          expect(count).to be < 2
+          pending "This should fail with a count of 1: Count was #{count}"
+          raise SharedError unless count > 1
+        end
+      end
+
+      context "the example throws an exception contained in the hard fail list" do
+        it "does not retry because the hard fail list takes precedence" do
+          expect(count).to be < 2
+          pending "This should fail with a count of 1: Count was #{count}"
+          raise HardFailError unless count > 1
+        end
+      end
+
+      context "the example throws an exception contained in the retry list" do
+        it "retries the maximum number of times because the hard fail list doesn't affect this exception" do
+          raise RetryError unless count > 1
+          expect(count).to eq(2)
+        end
+      end
+
+      context "the example throws an exception contained in neither list" do
+        it "does not retry because the the exception is not in the retry list" do
+          expect(count).to be < 2
+          pending "This should fail with a count of 1: Count was #{count}"
+          raise OtherError unless count > 1
+        end
+      end
+    end
   end
 
   describe 'clearing lets' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-retry
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
 platform: ruby
 authors:
 - Yusuke Mito
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-04 00:00:00.000000000 Z
+date: 2016-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -102,6 +102,7 @@ files:
 - gemfiles/rspec_3.3.gemfile
 - gemfiles/rspec_3.3.gemfile.lock
 - lib/rspec/retry.rb
+- lib/rspec/retry/formatter.rb
 - lib/rspec/retry/version.rb
 - lib/rspec_ext/rspec_ext.rb
 - rspec-retry.gemspec
@@ -126,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: retry intermittently failing rspec examples