integration-tests-rails 1.1.3 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 384f4f3272d0ff29fee4b9a2d6bc580eec97967dcfaa195735c24dc147d56a01
-  data.tar.gz: 8748fcb21a1a74c012254bc9cc1f219c3cf43ab1dfcf5051965e000f7d1893ea
+  metadata.gz: 53944743e03bea5bc70d05907ebaf666e5da367c41844a9df967427c41c42860
+  data.tar.gz: d144aef9b18271dbb7921bce4e2718072aa9f685b727ebb7907aa13d75c29694
 SHA512:
-  metadata.gz: 9e97a327ac819b6fd3155ea5366e959119a25305e6f5db0dbf994bfeaf1be26b621f6d22d5987708f272bca15672a9c9f0e13efdde1c41590c5af3724ca07f05
-  data.tar.gz: 99848ce892f5abc64e4282d02f2e360e370e2b1c0495e2d470aed7882a6b0bf0b60aea227e0cc9a24577be30c9bfb224730e37329f1be828443d6c456a5ce9b5
+  metadata.gz: 0fc048144a72cbef17015e994d933efdedec5f7ccbc573470514eb722fac65a1df6166bde2b87a24cdacd3cb8d11bfee6aa8cc36ecd5143ff5da72219b14da06
+  data.tar.gz: ee70f5ac6184b97c2c8e637313fe6fc1d6ecd6ee6c4219e9e9bacc1712d5c2b3a2b108bcb33792d29ba4d7413e9a6e3ec0d5c2fe42ac3b6b64f768a7c29c0b8d

data/README.md

@@ -62,7 +62,9 @@ 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.
   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.
@@ -252,9 +254,23 @@ 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.
+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.
 
 ## Example Setups
 

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

@@ -37,16 +37,18 @@ module IntegrationTestsRails
       </html>
     HTML
 
-    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,
+    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, :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'
       @experimental_features = false
+      @js_coverage = true
       @max_server_retries = 1000
       @output_dir = 'tmp/instrumented_js'
       @puma_threads = '1:1'

data/lib/integration_tests_rails/istanbul.rb

@@ -9,14 +9,22 @@ module IntegrationTestsRails
   module Istanbul
     class << self
       def setup
-        Util.configure_rspec
+        if IntegrationTestsRails.configuration.js_coverage
+          Util.configure_rspec
+        else
+          Util.log('JS coverage is disabled, skipping Istanbul setup.')
+        end
       end
     end
 
     # Ensure cleanup at exit, either success, failure or cancellation.
     at_exit do
-      Collector.generate_report
-      Collector.restore_original_files
+      if IntegrationTestsRails.configuration.js_coverage
+        Collector.generate_report
+        Collector.restore_original_files
+      else
+        Util.log('JS coverage is disabled, skipping Istanbul cleanup.')
+      end
     rescue StandardError => e
       warn "Istanbul cleanup failed: #{e.message}"
     end

data/lib/integration_tests_rails/railtie.rb

@@ -37,6 +37,35 @@ module IntegrationTestsRails
 
           puts 'Integration tests environment setup complete.'
         end
+
+        namespace :istanbul do
+          desc 'Remove Istanbul installation.'
+          task uninstall: :environment do
+            puts 'Removing Istanbul...'
+            system('yarn remove istanbul-lib-instrument istanbul-lib-coverage istanbul-lib-report istanbul-reports')
+            puts 'Istanbul removed. '
+
+            if File.exist?('.gitignore')
+              content = File.read('.gitignore')
+              new_content = content.dup
+              lines_to_remove = ['tmp/instrumented_js/', 'tmp/js_backup/']
+              lines_to_remove.each do |line|
+                if content.include?(line)
+                  new_content = new_content.gsub("#{line}\n", '')
+                  puts "Removed '#{line}' from .gitignore."
+                else
+                  puts "'#{line}' not found in .gitignore. Skipping."
+                end
+              end
+              if new_content == content
+                puts 'No changes made to .gitignore.'
+              else
+                File.write('.gitignore', new_content)
+                puts '.gitignore updated.'
+              end
+            end
+          end
+        end
       end
     end
     # rubocop:enable Metrics/BlockLength

data/lib/integration_tests_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IntegrationTestsRails
-  VERSION = '1.1.3'
+  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.3
+  version: 1.1.5
 platform: ruby
 authors:
 - Tien