integration-tests-rails 1.1.4 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3020cc3bc2a7fdcda72ea6b7fd12bb5786b4f26b1be3ff1c8533ff6a3046de3a
-  data.tar.gz: 3603ab4f58a7b508879fda0c91901142f22c39df3894013a54e4e88e8809b396
+  metadata.gz: 53944743e03bea5bc70d05907ebaf666e5da367c41844a9df967427c41c42860
+  data.tar.gz: d144aef9b18271dbb7921bce4e2718072aa9f685b727ebb7907aa13d75c29694
 SHA512:
-  metadata.gz: '032484b408cd1cfc672d6e0dfa379b1e3d01866546a750cb98d7d45d3e098941c79f77621f5431e41a2008ed1a45e0b299f38a18fe78a1a39496c2d5a00ddba7'
-  data.tar.gz: 8612c1eb1ac54ba15c2f63f236b85d07e93783f57d0fbbcdd39e2ddc6dd8521d9402bd15d53e600210f44009a7f923103a97153e6b88dbeb4a6aeee5eb745978
+  metadata.gz: 0fc048144a72cbef17015e994d933efdedec5f7ccbc573470514eb722fac65a1df6166bde2b87a24cdacd3cb8d11bfee6aa8cc36ecd5143ff5da72219b14da06
+  data.tar.gz: ee70f5ac6184b97c2c8e637313fe6fc1d6ecd6ee6c4219e9e9bacc1712d5c2b3a2b108bcb33792d29ba4d7413e9a6e3ec0d5c2fe42ac3b6b64f768a7c29c0b8d

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/util.rb

@@ -43,6 +43,15 @@ module IntegrationTestsRails
               IntegrationTestsRails::Capybara::Util.ensure_server_ready(self)
             end
 
+            config.around(:each, type: :feature) do |example|
+              if IntegrationTestsRails.configuration.auto_retry
+                kwargs = example.metadata.fetch(:auto_retry, {})
+                retry_on_fail(**kwargs) { example.run }
+              else
+                example.run
+              end
+            end
+
             if IntegrationTestsRails.configuration.experimental_features
               config.include(Helper, type: :feature, unit: true)
             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.5'
 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.5
 platform: ruby
 authors:
 - Tien