integration-tests-rails 1.0.9 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8565c51a68e4a566e3a2c24beac10c56e34135db4d21d75c877b9014d94093f2
-  data.tar.gz: 3bc4334e481beec869779f050d8ba9993e5696739ab75544e2f7835970697fcd
+  metadata.gz: a76f78f94ceebb76953e47c1d45a2e4b39f3f5260e3238721861bf6102522690
+  data.tar.gz: 2e2c200ec76728898e642ece116eb1ad163490f55a6a855c7dc8a96dc7f03cb1
 SHA512:
-  metadata.gz: 6580bf376345a375c56a051c237ec5b0937c03313f2967a708716d231f03034629b610bd41f9ef8c0901266984ac25f76d17b80746c1896f4ddc273ed30f50bd
-  data.tar.gz: e5471e16f941749f504575705f3e4992084a6e34b2c9d794a65273dfb690edadb3a150f1d31c5019fcbf8d266f7b38ba515c8ac130e25906d1d708190d095dcf
+  metadata.gz: cb4e8d66540dd7b3a854af21a5fad11c439fc3c8a31b8aa96f7a9dcab74e9a2f97c6d30478201b9e2afb057121f5ca89a8c36a1019a0548e93d241c4e96171c5
+  data.tar.gz: 52227cad3110ba38c617a671614419fb321a0f58a05249ed5957a5d46f2881c0ff3cf09a3e792f28e8b9881b073be97303a53329c2f73a8970e1bce5d3061347

data/README.md

@@ -66,6 +66,8 @@ IntegrationTestsRails.setup do |config|
   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.
   config.puma_threads = '1:1' # Number of threads for the Puma server used by Cuprite.
   config.remote = false # Whether to use a remote Chrome instance.
+  config.retry_attempts = 1 # Number of times to retry a test if an example fails inside a retry_on_fail block.
+  config.retry_sleep_duration = 0 # Number of seconds to wait between retries inside a retry_on_fail block.
   config.server_host = '0.0.0.0' # Host for the Puma server used by Cuprite.
   config.server_port = nil # Port for the Puma server used by Cuprite.
   config.source_dir = 'app/javascript' # Directory containing the JavaScript files to be instrumented.
@@ -221,6 +223,34 @@ In such cases where `script` is an array, the `result` component will contain th
 
 Refer to [Cuprite](https://github.com/rubycdp/cuprite) and [Capybara](https://github.com/teamcapybara/capybara). Use them as normally in integration tests.
 
+## Retrying Flaky Tests
+
+In practice, this is frowned upon. However, in such cases where there exists a flaky test (e.g. network issues, timing issues, third-party services respnsiveness, etc.), the gem provides a way to retry tests through `retry_on_fail`.
+
+```ruby
+RSpec.describe 'Flaky Test', type: :feature do
+  describe 'Flaky Behavior' do
+    it 'must succeed' do
+      visit '/form_with_complex_javascript'
+      retry_on_fail do
+        check 'Checkbox that executes scripts with animations'
+        expect(page).to have_css('div#animated-element', visible: :visible, wait: 5)
+      end
+
+      expect(page).to have_content('Complex Modal Opened')
+    end
+  end
+end
+```
+
+The above will retry the test if the browser was not able to find the checkbox or the page was not able to find the animated element. The number of retries and sleep duration between retries can be configured through `retry_attempts` and `retry_sleep_duration` configuration options respectively. The default number of retries is 1 and the default sleep duration is 0 seconds. You can also pass them as arguments:
+
+```ruby
+retry_on_fail(retry_attempts: 3, retry_sleep_duration: 1) do
+  expect(page).to have_css('div#animated-element', visible: :visible, wait: 5)
+end
+```
+
 ## JavaScript Coverage Reports
 
 After the tests (successful, failed or cancelled), coverage reports will be generated in `coverage/javascript` by default.
@@ -268,6 +298,11 @@ IntegrationTestsRails.setup do |config|
 end
 ```
 
+## TODO
+
+1. JavaScript unit testing needs to have a way to define the JavaScript loader in the spec file itself instead of in `IntegrationTestsRails.configuration.tests_page_html`.
+2. There is no graceful way to stop failing CDNs from being retried. Find a way to wait for them to complete loading. It should respect the `IntegrationTestsRails.configuration.timeout` setting.
+
 ## Contributing
 
 1. Fork the repository.

data/lib/integration_tests_rails/capybara/dsl.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module IntegrationTestsRails
+  module Capybara
+    # This module provides the main DSL for writing integration tests with Capybara.
+    module Dsl
+      def retry_on_fail(attempts: nil, sleep_duration: nil)
+        config = IntegrationTestsRails.configuration
+        attempts ||= config.retry_attempts
+        sleep_duration ||= config.retry_sleep_duration
+        counter = 0
+
+        begin
+          yield
+        rescue RSpec::Expectations::ExpectationNotMetError, Capybara::ElementNotFound => e
+          counter += 1
+          Util.log("Attempt #{counter} for #{RSpec.current_example.full_description} failed!")
+          raise e if counter >= attempts
+
+          sleep(sleep_duration) if sleep_duration.positive?
+          retry
+        end
+      end
+    end
+  end
+end

data/lib/integration_tests_rails/capybara/util.rb

@@ -36,6 +36,7 @@ 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)

data/lib/integration_tests_rails/configuration.rb

@@ -39,7 +39,8 @@ module IntegrationTestsRails
 
     attr_accessor :source_dir, :output_dir, :backup_dir, :coverage_path, :wait_time, :remote,
                   :chrome_url, :tests_page_html, :window_size, :max_server_retries,
-                  :verbose, :timeout, :server_host, :server_port, :puma_threads, :experimental_features
+                  :verbose, :timeout, :server_host, :server_port, :puma_threads, :experimental_features,
+                  :retry_attempts, :retry_sleep_duration
 
     def initialize
       @backup_dir = 'tmp/js_backup'
@@ -50,6 +51,8 @@ module IntegrationTestsRails
       @output_dir = 'tmp/instrumented_js'
       @puma_threads = '1:1'
       @remote = false
+      @retry_attempts = 1
+      @retry_sleep_duration = 0
       @server_host = '0.0.0.0' # rubocop:disable Style/IpAddresses
       @server_port = nil
       @source_dir = 'app/javascript'

data/lib/integration_tests_rails/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: integration-tests-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.1.0
 platform: ruby
 authors:
 - Tien
@@ -90,6 +90,7 @@ files:
 - lib/integration-tests-rails.rb
 - lib/integration_tests_rails.rb
 - lib/integration_tests_rails/capybara.rb
+- lib/integration_tests_rails/capybara/dsl.rb
 - lib/integration_tests_rails/capybara/helpers.rb
 - lib/integration_tests_rails/capybara/local.rb
 - lib/integration_tests_rails/capybara/remote.rb