integration-tests-rails 1.0.8 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd9324031c217a8ec83714af3b5e4aa13970d8f7207329dec77cf7eac9e67f77
-  data.tar.gz: 063caea1b6bb80fd619cb1fb9cde292140282b5d9943c5bd7d35cbdf11e1942f
+  metadata.gz: 8565c51a68e4a566e3a2c24beac10c56e34135db4d21d75c877b9014d94093f2
+  data.tar.gz: 3bc4334e481beec869779f050d8ba9993e5696739ab75544e2f7835970697fcd
 SHA512:
-  metadata.gz: 63ca3042ff7f05e8f785f79c396b644267fb3570599bb4a7f21ca6034a58dc75460ee71d396af671502e0721a012b63daeabe22683fc24b7f825951ddce5606a
-  data.tar.gz: d5a1972b1930d8ae3d68b1c2498cc2a08d496d32d18af7ca1274b3e6999be06b8a6990e9b58988c364c492ecf0e997649a0e8fdd75fa94adc376c6ed61dd62ab
+  metadata.gz: 6580bf376345a375c56a051c237ec5b0937c03313f2967a708716d231f03034629b610bd41f9ef8c0901266984ac25f76d17b80746c1896f4ddc273ed30f50bd
+  data.tar.gz: e5471e16f941749f504575705f3e4992084a6e34b2c9d794a65273dfb690edadb3a150f1d31c5019fcbf8d266f7b38ba515c8ac130e25906d1d708190d095dcf

data/README.md

@@ -13,6 +13,8 @@ This gem is designed to facilitate integration testing in Ruby on Rails applicat
 
 ## Getting Started
 
+Gem is easy to setup.
+
 ### Installation
 
 Add this line to your Rails application's Gemfile:
@@ -76,6 +78,14 @@ end
 
 ## Unit Testing JavaScript Code
 
+This feature is **EXPERIMENTAL** and may change in future releases. It allows you to write unit tests for JavaScript code using RSpec and Capybara. To enable the feature, one must set the `experimental_features` configuration option to `true`:
+
+```ruby
+IntegrationTestsRails.setup do |config|
+  config.experimental_features = true
+end
+```
+
 ### Usage
 
 To unit test JavaScript code, the gem will visit a test HTML page. By default, it only renders a complete HTML page that also loads importmap-supporting JavaScript code to set up the environment for testing.
@@ -217,6 +227,8 @@ After the tests (successful, failed or cancelled), coverage reports will be gene
 
 ## Example Setups
 
+The following are working examples.
+
 ### Using Docker Desktop
 
 If you want to use the [Alpine Chrome](https://hub.docker.com/r/zenika/alpine-chrome) image, this is definitely possible.

data/lib/integration_tests_rails/capybara/helpers.rb

@@ -37,6 +37,7 @@ module IntegrationTestsRails
       let(:function) { nil }
 
       before do
+        # page.driver.wait_for_network_idle(timeout: IntegrationTestsRails.configuration.timeout)
         visit '/tests'
         result
       end

data/lib/integration_tests_rails/capybara/remote.rb

@@ -34,6 +34,10 @@ module IntegrationTestsRails
             timeout = config.timeout
             options = {
               window_size: config.window_size,
+              browser_options: {
+                'no-sandbox': nil,
+                'disable-dev-shm-usage': nil
+              },
               url: config.chrome_url,
               timeout: timeout,
               process_timeout: timeout

data/lib/integration_tests_rails/capybara/util.rb

@@ -16,12 +16,15 @@ module IntegrationTestsRails
         def ensure_server_ready(context)
           return if @server_ready
 
-          config = IntegrationTestsRails.configuration
           log "Waiting for server on #{::Capybara.app_host.presence || 'localhost'} to start..."
-
-          server_retries = config.max_server_retries
+          configuration = IntegrationTestsRails.configuration
+          server_retries = configuration.max_server_retries
           server_retries.times do |attempt|
-            context.visit('/400')
+            if configuration.experimental_features
+              context.visit('/tests')
+            else
+              context.visit('/')
+            end
             @server_ready = true
             log 'Server is ready!'
             break
@@ -38,11 +41,15 @@ module IntegrationTestsRails
               IntegrationTestsRails::Capybara::Util.ensure_server_ready(self)
             end
 
-            config.include(Helper, type: :feature, unit: true)
+            if IntegrationTestsRails.configuration.experimental_features
+              config.include(Helper, type: :feature, unit: true)
+            end
           end
         end
 
         def configure_routes
+          return unless IntegrationTestsRails.configuration.experimental_features
+
           app = Rails.application
           routes = app.routes
           # Use append and let Rails handle finalization automatically

data/lib/integration_tests_rails/configuration.rb

@@ -39,12 +39,13 @@ 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
+                  :verbose, :timeout, :server_host, :server_port, :puma_threads, :experimental_features
 
     def initialize
       @backup_dir = 'tmp/js_backup'
       @chrome_url = nil
       @coverage_path = 'coverage/nyc'
+      @experimental_features = false
       @max_server_retries = 1000
       @output_dir = 'tmp/instrumented_js'
       @puma_threads = '1:1'

data/lib/integration_tests_rails/istanbul/instrumenter.rb

@@ -32,27 +32,45 @@ module IntegrationTestsRails
 
         def instrument_file(file)
           config = IntegrationTestsRails.configuration
-
           relative_path = Pathname.new(file).relative_path_from(config.source_path)
           output_file = config.output_path.join(relative_path)
 
           FileUtils.mkdir_p(output_file.dirname)
 
-          # Use Node.js to instrument the file
           code = File.read(file)
-          escaped_code = JSON.generate(code)
+          instrumented = instrument_code_with_istanbul(code, file)
+
+          write_instrumented_file(output_file, instrumented, relative_path)
+        end
+
+        private
+
+        def instrument_code_with_istanbul(code, file)
+          require 'tempfile'
+          Tempfile.create(['code', '.js']) do |temp_code|
+            temp_code.write(code)
+            temp_code.flush
+
+            js_command = build_istanbul_command(temp_code.path, file)
+            `node -e #{Shellwords.escape(js_command)}`.strip
+          end
+        end
+
+        def build_istanbul_command(code_path, file)
+          escaped_code_path = JSON.generate(code_path)
           escaped_file = JSON.generate(file.to_s)
 
-          js_command = <<~JS
+          <<~JS
+            const fs = require('fs');
             const { createInstrumenter } = require('istanbul-lib-instrument');
             const instrumenter = createInstrumenter({ esModules: true, compact: false });
-            const code = #{escaped_code};
+            const code = fs.readFileSync(#{escaped_code_path}, 'utf8');
             const filename = #{escaped_file};
             console.log(instrumenter.instrumentSync(code, filename));
           JS
+        end
 
-          instrumented = `node -e #{Shellwords.escape(js_command)}`.strip
-
+        def write_instrumented_file(output_file, instrumented, relative_path)
           if $CHILD_STATUS.success?
             File.write(output_file, instrumented)
           else

data/lib/integration_tests_rails/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: integration-tests-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.9
 platform: ruby
 authors:
 - Tien