integration-tests-rails 1.1.4 → 1.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3020cc3bc2a7fdcda72ea6b7fd12bb5786b4f26b1be3ff1c8533ff6a3046de3a
-  data.tar.gz: 3603ab4f58a7b508879fda0c91901142f22c39df3894013a54e4e88e8809b396
+  metadata.gz: 1668370843b5697395c5716bfd2442188ab3dc44381b65d9442b3df2d8a77db7
+  data.tar.gz: c55dbc2cc27128a3858e72a16ba1ea14b09069a84f0d154993c6c6423a752a9b
 SHA512:
-  metadata.gz: '032484b408cd1cfc672d6e0dfa379b1e3d01866546a750cb98d7d45d3e098941c79f77621f5431e41a2008ed1a45e0b299f38a18fe78a1a39496c2d5a00ddba7'
-  data.tar.gz: 8612c1eb1ac54ba15c2f63f236b85d07e93783f57d0fbbcdd39e2ddc6dd8521d9402bd15d53e600210f44009a7f923103a97153e6b88dbeb4a6aeee5eb745978
+  metadata.gz: 5c8b64492f395681aa22d9e64a3c3a23adca9a9088a48c5e9ec427d36e1ef326efd549f6a96890087aee5be6d03fac63b2d4321ddedade93027876d340977bee
+  data.tar.gz: 6f836c2525fa07283f1270c98ddbc9a52815a26b2c5452f2d50408cdbdcc10c2547b1ca2834064b9e5dc53cb17c61cf78cbadc6194c973c942c8fd26b2d28410

data/README.md

@@ -62,6 +62,7 @@ The `IntegrationTestsRails.setup` method accepts an optional block for further c
 
 ```ruby
 IntegrationTestsRails.setup do |config|
+  config.auto_retry = false # Whether to automatically wrap all examples inside retry_on_fail block.
   config.chrome_url = nil # Used for remote Chrome instances. Needs remote to be true.
   config.js_coverage = true # Whether to enable JavaScript coverage using Istanbul.
   config.max_server_retries = 1000 # Before running the tests, Cuprite starts a server to communicate with Chrome. This sets the maximum number of retries to connect to that server.
@@ -253,6 +254,20 @@ retry_on_fail(retry_attempts: 3, retry_sleep_duration: 1, capture_exceptions: [S
 end
 ```
 
+### Auto Retry
+
+If you want to automatically retry all examples in a test suite without having to wrap them in `retry_on_fail`, you can set the `auto_retry` configuration option to `true`. This will automatically wrap all examples in a `retry_on_fail` block with the configured number of retries, exceptions to capture and sleep duration between retries.
+
+It is possible to pass custom arguments with `auto_retry` enabled through example metadata:
+
+```ruby
+it 'is a flaky test', auto_retry: { retry_attempts: 3, retry_sleep_duration: 2, capture_exceptions: [StandardError] } do
+  expect(page).to have_css('div#popover', visible: :visible, wait: 8)
+end
+```
+
+If no metadata is passed, it will use the default configuration values.
+
 ## JavaScript Coverage Reports
 
 After the tests (successful, failed or cancelled), coverage reports will be generated in `coverage/javascript` by default. This can be disabled in the configuration by setting `js_coverage` to `false`. Be sure to uninstall Istanbul packages through the rake task `rake integration_tests_rails:istanbul:uninstall` if you do not need this feature.

data/lib/integration_tests_rails/capybara/dsl.rb

@@ -15,7 +15,7 @@ module IntegrationTestsRails
           yield
         rescue *capture_exceptions => e
           counter += 1
-          Util.log("Attempt #{counter} for #{RSpec.current_example.full_description} failed!")
+          Util.log("Inline Retry Attempt #{counter} for #{RSpec.current_example.full_description} failed!")
           raise e if counter > attempts
 
           sleep(sleep_duration) if sleep_duration.positive?

data/lib/integration_tests_rails/capybara/retry.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module IntegrationTestsRails
+  module Capybara
+    # Handles auto-retry logic for RSpec feature examples.
+    module Retry
+      class << self
+        def run(example, context)
+          description = example.full_description
+          attempts, sleep_duration, capture_exceptions = retry_config(example)
+
+          (attempts + 1).times do |attempt_number|
+            reset_example_state(context)
+            example.run
+            ex = RSpec.current_example.exception
+            break unless ex
+            break unless capture_exceptions.any? { |klass| ex.is_a?(klass) }
+
+            Util.log "Auto Retry Attempt #{attempt_number + 1} failed for: #{description}"
+            sleep(sleep_duration) if attempt_number < attempts && sleep_duration.positive?
+          end
+        end
+
+        private
+
+        def retry_config(example)
+          kwargs = example.metadata.fetch(:auto_retry, {})
+          config_obj = IntegrationTestsRails.configuration
+          attempts = kwargs.fetch(:attempts, config_obj.retry_attempts)
+          sleep_duration = kwargs.fetch(:sleep_duration, config_obj.retry_sleep_duration)
+          capture_exceptions = constantize_exceptions(config_obj)
+          [attempts, sleep_duration, capture_exceptions]
+        end
+
+        def constantize_exceptions(config)
+          config.retry_capture_exceptions.filter_map { |e| e.constantize if e.is_a?(String) }
+        end
+
+        def reset_example_state(context)
+          RSpec.current_example.instance_variable_set(:@exception, nil)
+          memoized_class = begin
+            RSpec::Core::MemoizedHelpers::ThreadsafeMemoized
+          rescue StandardError
+            RSpec::Core::MemoizedHelpers::NonThreadSafeMemoized
+          end
+          context.instance_variable_set(:@__memoized, memoized_class.new)
+        end
+      end
+    end
+  end
+end

data/lib/integration_tests_rails/capybara/util.rb

@@ -2,6 +2,7 @@
 
 require_relative 'helpers'
 require_relative 'dsl'
+require_relative 'retry'
 require_relative 'tests_controller'
 
 module IntegrationTestsRails
@@ -14,6 +15,28 @@ module IntegrationTestsRails
           log 'WebMock configured to allow localhost connections'
         end
 
+        def configure_routes
+          return unless IntegrationTestsRails.configuration.experimental_features
+
+          app = Rails.application
+          routes = app.routes
+          # Use append and let Rails handle finalization automatically
+          routes.append do
+            get '/tests', to: 'tests#index', as: :tests
+          end
+          routes.instance_variable_set(:@finalized, false)
+          routes.finalize!
+          log 'Routes appended.'
+        end
+
+        def verbose?
+          IntegrationTestsRails.configuration.verbose
+        end
+
+        def log(message)
+          puts "[CAPYBARA] #{message}" if verbose?
+        end
+
         def ensure_server_ready(context)
           return if @server_ready
 
@@ -38,37 +61,32 @@ module IntegrationTestsRails
         def configure_rspec
           RSpec.configure do |config|
             config.include Dsl, type: :feature
-            config.before(:each, type: :feature) do
-              ::Capybara.current_driver = ::Capybara.javascript_driver
-              IntegrationTestsRails::Capybara::Util.ensure_server_ready(self)
-            end
-
+            configure_before_hook(config)
+            configure_around_hook(config)
             if IntegrationTestsRails.configuration.experimental_features
-              config.include(Helper, type: :feature, unit: true)
+              config.include(Helper, type: :feature,
+                                     unit: true)
             end
           end
         end
 
-        def configure_routes
-          return unless IntegrationTestsRails.configuration.experimental_features
+        private
 
-          app = Rails.application
-          routes = app.routes
-          # Use append and let Rails handle finalization automatically
-          routes.append do
-            get '/tests', to: 'tests#index', as: :tests
+        def configure_before_hook(config)
+          config.before(:each, type: :feature) do
+            ::Capybara.current_driver = ::Capybara.javascript_driver
+            IntegrationTestsRails::Capybara::Util.ensure_server_ready(self)
           end
-          routes.instance_variable_set(:@finalized, false)
-          routes.finalize!
-          log 'Routes appended.'
-        end
-
-        def verbose?
-          IntegrationTestsRails.configuration.verbose
         end
 
-        def log(message)
-          puts "[CAPYBARA] #{message}" if verbose?
+        def configure_around_hook(config)
+          config.around(:each, type: :feature) do |example|
+            if IntegrationTestsRails.configuration.auto_retry
+              Retry.run(example, self)
+            else
+              example.run
+            end
+          end
         end
       end
     end

data/lib/integration_tests_rails/configuration.rb

@@ -38,11 +38,12 @@ module IntegrationTestsRails
     HTML
 
     attr_accessor :source_dir, :output_dir, :backup_dir, :coverage_path, :wait_time, :remote, :chrome_url, :window_size,
-                  :tests_page_html, :max_server_retries, :verbose, :js_coverage,
+                  :tests_page_html, :max_server_retries, :verbose, :js_coverage, :auto_retry,
                   :timeout, :server_host, :server_port, :puma_threads, :experimental_features,
                   :retry_attempts, :retry_sleep_duration, :retry_capture_exceptions
 
-    def initialize
+    def initialize # rubocop:disable Metrics/MethodLength
+      @auto_retry = false
       @backup_dir = 'tmp/js_backup'
       @chrome_url = nil
       @coverage_path = 'coverage/nyc'

data/lib/integration_tests_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IntegrationTestsRails
-  VERSION = '1.1.4'
+  VERSION = '1.1.7'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: integration-tests-rails
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.1.7
 platform: ruby
 authors:
 - Tien
@@ -94,6 +94,7 @@ files:
 - lib/integration_tests_rails/capybara/helpers.rb
 - lib/integration_tests_rails/capybara/local.rb
 - lib/integration_tests_rails/capybara/remote.rb
+- lib/integration_tests_rails/capybara/retry.rb
 - lib/integration_tests_rails/capybara/tests_controller.rb
 - lib/integration_tests_rails/capybara/util.rb
 - lib/integration_tests_rails/configuration.rb