ruby_raider 3.12.1 → 3.13.0

data/spec/integration/content/config_content_spec.rb

@@ -59,6 +59,22 @@ describe 'Config file content' do
     end
   end
 
+  shared_examples 'trace config' do |project_name|
+    it 'has tracing enabled with 200 steps and 20 MB, with the spec comments' do
+      raw = read_generated(project_name, 'config/config.yml')
+      config = YAML.safe_load(raw, permitted_classes: [Symbol])
+      expect(config['trace']).to eq('enabled' => true, 'max_steps' => 200, 'max_mb' => 20)
+      expect(raw.index('trace:')).to be > raw.index('video:')
+      expect(raw.index('trace:')).to be < raw.index('login_state:')
+    end
+  end
+
+  shared_examples 'no trace config' do |project_name|
+    it 'has no trace block' do
+      expect(read_generated(project_name, 'config/config.yml')).not_to include('trace')
+    end
+  end
+
   shared_examples 'login state config' do |project_name|
     it 'has a login_state max_age of an hour' do
       config = YAML.safe_load(read_generated(project_name, 'config/config.yml'), permitted_classes: [Symbol])
@@ -73,6 +89,7 @@ describe 'Config file content' do
     include_examples 'valid web config', name
     include_examples 'selenium config with timeout', name
     include_examples 'video config', name
+    include_examples 'trace config', name
     include_examples 'login state config', name
   end
 
@@ -80,6 +97,7 @@ describe 'Config file content' do
     name = "#{FrameworkIndex::RSPEC}_#{AutomationIndex::WATIR}"
     include_examples 'valid web config', name
     include_examples 'config without driver_options', name
+    include_examples 'no trace config', name
     include_examples 'login state config', name
   end
 
@@ -87,6 +105,7 @@ describe 'Config file content' do
     name = "#{FrameworkIndex::CUCUMBER}_#{AutomationIndex::SELENIUM}"
     include_examples 'valid web config', name
     include_examples 'selenium config with timeout', name
+    include_examples 'trace config', name
     include_examples 'login state config', name
   end
 
@@ -95,6 +114,7 @@ describe 'Config file content' do
   # Single-platform Appium projects have no config.yml; VideoHelper falls back to its defaults.
   context 'with rspec and cross platform' do
     include_examples 'video config', "#{FrameworkIndex::RSPEC}_#{AutomationIndex::CROSS_PLATFORM}"
+    include_examples 'no trace config', "#{FrameworkIndex::RSPEC}_#{AutomationIndex::CROSS_PLATFORM}"
   end
 
   context 'with rspec and appium android' do

data/spec/integration/content/cucumber_reporter_content_spec.rb

@@ -68,6 +68,57 @@ describe 'Cucumber raider_reporter wiring' do
         end
       end
 
+      if automation == 'selenium'
+        context 'with trace recording' do
+          it 'requires trace_helper' do
+            expect(env).to include("require_relative '../../helpers/trace_helper'")
+          end
+
+          it 'counts attempts per scenario location and starts the trace recorder after the video recorder' do
+            before_hook = env[/^Before do.*?^end$/m]
+            expect(env).to match(/^TRACE_ATTEMPTS = Hash\.new\(0\) unless defined\?\(TRACE_ATTEMPTS\)$/)
+            expect(before_hook).to include('TRACE_ATTEMPTS[scenario.location.to_s] += 1', '@trace_recorder = TraceHelper.recorder_for(driver)')
+            expect(before_hook).to match(/^Before do \|scenario\|$/)
+            expect(before_hook.index('@video_recorder.start')).to be < before_hook.index('@trace_recorder = TraceHelper')
+            expect(before_hook).to match(/if defined\?\(TraceHelper\)\n(.*\n)*.*@trace_recorder = TraceHelper/)
+          end
+
+          it 'stops with keep: TraceHelper.keep_all? || scenario.failed? before the video, attaches it and cleans up before quitting' do
+            expect(hook).to include('TraceHelper.keep_all? || scenario.failed?', 'error: scenario.exception', 'attempt: @trace_attempt')
+            expect(hook).to include("RaiderReporter.attach('trace', trace_path, type: :trace, attempt: @trace_attempt) if trace_path")
+            order = [hook.index('@trace_recorder&.stop'), hook.index('@video_recorder&.stop'), hook.index("RaiderReporter.attach('trace'"),
+                     hook.index(/^ensure/), hook.index('@trace_recorder&.cleanup'), hook.index('@video_recorder&.cleanup'), hook.index('driver.quit')]
+            expect(order).to all(be_an(Integer)).and eq(order.compact.sort)
+          end
+
+          it 'survives a Before that raised before the trace init, and a failing plugin setup or handler' do
+            expect(hook).to include('@trace_test&.merge(')
+            expect(hook).not_to include('@trace_test.merge(')
+            plugin = env[/^InstallPlugin do.*?^end$/m]
+            expect(plugin.scan('rescue StandardError => e').size).to eq(3)
+            expect(plugin.index('AstLookup.new')).to be > plugin.index("begin\n")
+            expect(plugin).to include('TraceHelper.warn_once("Gherkin step groups unavailable')
+          end
+
+          it 'turns tracing off with TraceHelper.disable! when a step group handler raises' do
+            plugin = env[/^InstallPlugin do.*?^end$/m]
+            expect(plugin.scan(/TraceHelper\.disable!\("step groups failed: \#\{e\.message\}"\) if defined\?\(TraceHelper\)/).size).to eq(2)
+            expect(plugin).not_to include('tracing disabled')
+          end
+
+          it 'records each Gherkin step as a group through the InstallPlugin step events, skipping hooks' do
+            plugin = env[/^InstallPlugin do.*?^end$/m]
+            expect(plugin).to include('config.on_event(:test_step_started)', 'config.on_event(:test_step_finished)', 'next if event.test_step.hook?')
+            expect(plugin).to include('TraceHelper.active_recorder&.step_started', 'TraceHelper.active_recorder&.step_finished')
+            expect(plugin).to include('defined?(TraceHelper)')
+          end
+        end
+      else
+        it 'has no trace wiring' do
+          expect(env).not_to match(/trace/i)
+        end
+      end
+
       it 'does not generate the allure helper' do
         expect(File).not_to exist(File.join(project_name, 'helpers/allure_helper.rb'))
       end

data/spec/integration/content/gemfile_content_spec.rb

@@ -127,7 +127,7 @@ describe 'Gemfile content' do
         let(:gemfile) { read_generated("#{FrameworkIndex::RSPEC}_#{automation}", 'Gemfile') }
 
         it 'includes raider_reporter' do
-          expect(gemfile).to include("gem 'raider_reporter', '~> 0.10'")
+          expect(gemfile).to include("gem 'raider_reporter', '~> 0.12'")
         end
 
         it 'has no allure gems' do
@@ -143,7 +143,7 @@ describe 'Gemfile content' do
         let(:gemfile) { read_generated("#{FrameworkIndex::CUCUMBER}_#{automation}", 'Gemfile') }
 
         it 'includes raider_reporter' do
-          expect(gemfile).to include("gem 'raider_reporter', '~> 0.10'")
+          expect(gemfile).to include("gem 'raider_reporter', '~> 0.12'")
         end
 
         it 'drops allure-cucumber' do

data/spec/integration/content/helper_content_spec.rb

@@ -43,6 +43,21 @@ describe 'Helper file content' do
     it 'does not reference Capybara' do
       expect(helper).not_to include('Capybara')
     end
+
+    it 'requires trace_helper' do
+      expect(helper).to include("require_relative 'trace_helper'")
+    end
+
+    it 'sets web_socket_url only for chrome, edge and firefox and not with TRACE=off' do
+      expect(helper).to include('options.web_socket_url = true if defined?(TraceHelper) && TraceHelper.bidi?(load_browser)')
+    end
+
+    it 'fans the video and trace listeners out through one listener, each guarded by defined?' do
+      expect(helper).to include('class FanOutListener < Selenium::WebDriver::Support::AbstractEventListener',
+                                'listener = FanOutListener.for(listeners)',
+                                'listeners << VideoHelper.listener if defined?(VideoHelper)',
+                                'listeners << TraceHelper.listener if defined?(TraceHelper)')
+    end
   end
 
   # --- Browser helper ---
@@ -168,7 +183,7 @@ describe 'Helper file content' do
                after_hook.index(/driver\.quit|browser\.quit/)]
       expect(order).to all(be_an(Integer)).and eq(order.compact.sort)
       expect(after_hook.scan(/driver\.quit|browser\.quit/).size).to eq(1)
-      expect(after_hook[order[2]..]).to match(/\n      @video_recorder&\.cleanup\n      (driver|browser)\.quit(_driver)?\n    end\n/)
+      expect(after_hook[order[2]..]).to match(/\n      (@trace_recorder&\.cleanup\n      )?@video_recorder&\.cleanup\n      (driver|browser)\.quit(_driver)?\n    end\n/)
     end
 
     it 'keeps the screenshot attachment' do
@@ -176,6 +191,41 @@ describe 'Helper file content' do
     end
   end
 
+  shared_examples 'trace spec helper wiring' do |project_name|
+    subject(:helper) { read_generated(project_name, 'helpers/spec_helper.rb') }
+
+    let(:before_hook) { helper[/config\.before\(:each\) do.*?^    end$/m] }
+    let(:after_hook) { helper[/config\.after\(:each\).*\z/m] }
+
+    it 'starts the trace recorder after the video recorder, each guarded by defined?(TraceHelper)' do
+      expect(before_hook).to include('@trace_recorder = TraceHelper.recorder_for(driver) if defined?(TraceHelper)', '@trace_recorder&.start')
+      expect(before_hook.index('@video_recorder.start')).to be < before_hook.index('@trace_recorder = TraceHelper')
+    end
+
+    it 'keeps the trace for TRACE=on or a final-attempt failure, falling back to keeping failures without a video helper' do
+      expect(after_hook).to include('TraceHelper.keep_all? || (example.exception && (defined?(VideoHelper) ? VideoHelper.final_attempt?(example) : true))')
+    end
+
+    it 'counts the attempt from the rspec-retry metadata and hands the recorder the test' do
+      expect(after_hook).to include('example.metadata[:retry_attempts].to_i + 1', 'error: example.exception')
+      expect(after_hook).to include('@trace_recorder&.stop(keep: keep_trace, test: trace_test)')
+    end
+
+    it 'stops the trace before the video and the screenshot, then attaches it, then cleans up before quitting' do
+      order = [after_hook.index('@trace_recorder&.stop'), after_hook.index('@video_recorder&.stop'), after_hook.index('RaiderReporter.attach(\'screenshot\''),
+               after_hook.index("RaiderReporter.attach('trace', trace_path, type: :trace, attempt: attempt) if trace_path"),
+               after_hook.index("\n    ensure\n"), after_hook.index('@trace_recorder&.cleanup'), after_hook.index('@video_recorder&.cleanup'),
+               after_hook.index('driver.quit')]
+      expect(order).to all(be_an(Integer)).and eq(order.compact.sort)
+    end
+  end
+
+  shared_examples 'no trace wiring' do |project_name, file|
+    it "leaves #{file} without trace code" do
+      expect(read_generated(project_name, file)).not_to match(/trace/i)
+    end
+  end
+
   shared_examples 'selenium spec helper' do |project_name|
     subject(:helper) { read_generated(project_name, 'helpers/spec_helper.rb') }
 
@@ -313,6 +363,10 @@ describe 'Helper file content' do
     it 'does not wire a listener into the appium driver helper' do
       expect(read_generated(name, 'helpers/driver_helper.rb')).not_to include('listener')
     end
+
+    it 'does not wire tracing or BiDi into the appium driver helper' do
+      expect(read_generated(name, 'helpers/driver_helper.rb')).not_to include('TraceHelper', 'web_socket_url')
+    end
   end
 
   # --- RSpec + automation contexts ---
@@ -357,6 +411,11 @@ describe 'Helper file content' do
       it_behaves_like 'raider reporter spec helper', name, screenshot_call
       it_behaves_like 'video spec helper wiring', name, automation == 'watir' ? 'browser' : 'driver',
                       %w[selenium watir].include?(automation) ? ':webm' : ':mp4'
+      if automation == 'selenium'
+        it_behaves_like 'trace spec helper wiring', name
+      else
+        it_behaves_like 'no trace wiring', name, 'helpers/spec_helper.rb'
+      end
     end
 
     context "with cucumber and #{automation}" do

data/spec/integration/content/readme_content_spec.rb

@@ -52,6 +52,52 @@ describe 'Generated Readme content' do
         end
       end
     end
+
+    context "with #{framework} and #{automation}, the Trace replay section" do
+      subject(:section) { readme[/^### Trace replay\n.*?(?=^##)/m]&.gsub(/\s+/, ' ') }
+
+      let(:readme) { read_generated("#{framework}_#{automation}", 'Readme.md') }
+
+      if automation == 'selenium'
+        it 'covers the defaults, TRACE=on, TRACE=off, the file location and how to open it' do
+          expect(section).to include('only for failing tests', 'TRACE=on', 'TRACE=off', 'raider u trace off',
+                                     'raider u trace on', 'raider-results/attachments/', 'Raider Desktop', 'Hideout',
+                                     'helpers/trace_helper.rb')
+          expect(section).to include('raider-results/attachments/<n>-trace.zip')
+          expect(section).to include('`raider u trace on` and `raider u trace off` write `enabled:`')
+          expect(section).not_to include('Both write')
+        end
+
+        it 'states the per-step cost and the caps' do
+          expect(section).to include('one screenshot and one page HTML', 'max_mb', 'max_steps', 'trace:')
+        end
+
+        it 'allows at most one [trace] notice, plus one line when tracing stops' do
+          expect(section).to include('at most one `[trace]` notice', 'one more `[trace]` line', 'tracing disabled for this run')
+        end
+
+        it 'limits network and console to Chrome, Edge or Firefox' do
+          expect(section).to include('Chrome, Edge or Firefox', 'Safari', 'steps, screenshots and HTML')
+        end
+
+        it 'says what is hidden, what is kept and what is never captured' do
+          expect(section).to include('password', 'RAIDER_SECRET_', 'page text', 'query strings', 'console text',
+                                     'like the video', 'never captured', 'cookies')
+          expect(section).to include('Failure messages can contain typed text too, because an assertion message is kept as it is')
+        end
+
+        it 'says how to remove the trace helper and notes the wait helper link' do
+          expect(readme).to include('Removing the trace helper', 'require_relative',
+                                    'without WaitHelper a trace records only navigation and the failure')
+          expect(readme).not_to match(/allure/i)
+          expect(readme).not_to include('—')
+        end
+      else
+        it 'does not mention trace replay' do
+          expect(readme).not_to include('Trace replay', 'TRACE=', 'trace_helper')
+        end
+      end
+    end
   end
 
   AUTOMATION_TYPES.each do |automation|

data/spec/integration/content/rspec_reporter_content_spec.rb

@@ -18,8 +18,8 @@ describe 'RSpec projects without Allure' do
         expect(File).not_to exist(File.join(project_name, 'allure-results'))
       end
 
-      it 'pins raider_reporter 0.10' do
-        expect(read_generated(project_name, 'Gemfile')).to include("gem 'raider_reporter', '~> 0.10'")
+      it 'pins raider_reporter 0.12' do
+        expect(read_generated(project_name, 'Gemfile')).to include("gem 'raider_reporter', '~> 0.12'")
       end
     end
   end