ruby_raider 3.12.0 → 3.13.0

data/lib/generators/templates/helpers/driver_helper.tt

@@ -5,12 +5,34 @@ require 'yaml'
 require 'active_support/inflector'
 require 'selenium-webdriver'
 require_relative 'video_helper'
+<%- if trace_helper? -%>
+require_relative 'trace_helper'
+<%- end -%>
 <%- else -%>
 require 'appium_lib'
 <%- end -%>
 
 module DriverHelper
   <%- if selenium_based? -%>
+  # Selenium takes one listener: this one hands every event on to the video and trace listeners.
+  class FanOutListener < Selenium::WebDriver::Support::AbstractEventListener
+    def self.for(listeners)
+      listeners.empty? ? nil : new(listeners)
+    end
+
+    def initialize(listeners)
+      super()
+      @listeners = listeners
+    end
+
+    Selenium::WebDriver::Support::AbstractEventListener.instance_methods(false).each do |event|
+      define_method(event) do |*args|
+        @listeners.each { |listener| listener.public_send(event, *args) if listener.respond_to?(event) }
+        nil
+      end
+    end
+  end
+
   def driver(*opts)
     @driver ||= create_driver(*opts)
   end

data/lib/generators/templates/helpers/partials/appium_driver.tt

@@ -32,7 +32,7 @@
   end
 <%- end -%>
 
-<%= partial('browserstack_config', strip: true) %>
+  <%= partial('browserstack_config', strip: true) %>
 
   def configure_driver
     if browserstack?

data/lib/generators/templates/helpers/partials/selenium_driver.tt

@@ -2,11 +2,19 @@
     @config = YAML.load_file('config/config.yml')
     browser = @config['browser']
     arguments = { options: create_webdriver_options(*opts) }
-    listener = VideoHelper.listener
+    listener = FanOutListener.for(listeners)
     arguments[:listener] = listener if listener
     Selenium::WebDriver.for(browser.to_sym, **arguments)
   end
 
+  # The helpers' Selenium listeners. Deleting video_helper.rb or trace_helper.rb needs only its require.
+  def listeners
+    listeners = []
+    listeners << VideoHelper.listener if defined?(VideoHelper)
+    listeners << TraceHelper.listener if defined?(TraceHelper)
+    listeners.compact
+  end
+
   def browser_arguments(*opts)
     args = opts.empty? ? @config['browser_arguments'][@config['browser']] : opts
     args += ['--headless'] if (ENV['HEADLESS'] || @config['headless']) && !args.include?('--headless')
@@ -18,5 +26,7 @@
     browser = load_browser == 'ie' ? load_browser.upcase : load_browser.capitalize
     options = "Selenium::WebDriver::#{browser}::Options".constantize.new
     browser_arguments(*opts).each { |arg| options.add_argument(arg) }
+    # WebDriver BiDi carries the trace's network and console (chrome, edge and firefox).
+    options.web_socket_url = true if defined?(TraceHelper) && TraceHelper.bidi?(load_browser)
     options
   end

data/lib/generators/templates/helpers/raider_element.tt

@@ -65,13 +65,13 @@ class RaiderElement
   end
 
   def send_keys(*keys, timeout: nil)
-    perform(:send_keys, timeout) { |element| element.send_keys(*keys) }
+    perform(:send_keys, timeout, args: keys) { |element| element.send_keys(*keys) }
     self
   end
 
 <%- unless mobile? -%>
   def select_by(how, what, timeout: nil)
-    perform(:select_by, timeout) { |element| Selenium::WebDriver::Support::Select.new(element).select_by(how, what) }
+    perform(:select_by, timeout, args: [how, what]) { |element| Selenium::WebDriver::Support::Select.new(element).select_by(how, what) }
     self
   end
 
@@ -143,8 +143,8 @@ class RaiderElement
     WaitHelper::Lookup.for(@driver, locator, by, scope: @lookup)
   end
 
-  def perform(action, timeout, &block)
-    waiter(timeout).perform_action(action, @lookup, WaitHelper::Waiter::CHECKS.fetch(action), &block)
+  def perform(action, timeout, args: nil, &block)
+    waiter(timeout).perform_action(action, @lookup, WaitHelper::Waiter::CHECKS.fetch(action), args: args, &block)
   end
 
   def method_missing(name, *args, **options, &block)

data/lib/generators/templates/helpers/session_state.tt

@@ -17,7 +17,7 @@ require 'yaml'
 class SessionState
   FORMAT = 1
   DEFAULT_MAX_AGE = 3600
-  NAME_PATTERN = /\A[a-z0-9_-]+\z/.freeze
+  NAME_PATTERN = Regexp.new('\A[a-z0-9_-]+\z').freeze
   DIR = File.join('.raider', 'auth')
   READ_STORAGE = 'return Object.assign({}, window[arguments[0]]);'
   WRITE_STORAGE = 'var s = window[arguments[0]]; s.clear(); var d = arguments[1]; ' \

data/lib/generators/templates/helpers/spec_helper.tt

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-<%- if axe_addon? %>
+<%- if axe_addon? -%>
 require 'axe-rspec'
 <%- end -%>
 require 'rspec'
@@ -62,6 +62,10 @@ module SpecHelper
     <%- end -%>
       @video_recorder = VideoHelper.recorder_for(<%= watir? ? 'browser' : 'driver' %>)
       @video_recorder.start
+<%- if trace_helper? -%>
+      @trace_recorder = TraceHelper.recorder_for(driver) if defined?(TraceHelper)
+      @trace_recorder&.start
+<%- end -%>
     end
 <%- if web? && examples? -%>
 
@@ -80,6 +84,15 @@ module SpecHelper
 
     config.after(:each) do |example|
       example_name = example.description
+<%- if trace_helper? -%>
+      if defined?(TraceHelper)
+        attempt = example.metadata[:retry_attempts].to_i + 1
+        keep_trace = TraceHelper.keep_all? || (example.exception && (defined?(VideoHelper) ? VideoHelper.final_attempt?(example) : true))
+        trace_test = { identifier: example.id.delete_prefix('./'), full_name: example.full_description,
+                       status: example.exception ? 'failed' : 'passed', attempt: attempt, error: example.exception }
+        trace_path = @trace_recorder&.stop(keep: keep_trace, test: trace_test)
+      end
+<%- end -%>
       keep_video = example.exception ? VideoHelper.final_attempt?(example) : false
       video_path = @video_recorder&.stop(keep: keep_video)
       if example.exception
@@ -91,7 +104,13 @@ module SpecHelper
         end
       end
       RaiderReporter.attach('video', video_path, type: <%= mobile? ? ':mp4' : ':webm' %>) if video_path
+<%- if trace_helper? -%>
+      RaiderReporter.attach('trace', trace_path, type: :trace, attempt: attempt) if trace_path
+<%- end -%>
     ensure
+<%- if trace_helper? -%>
+      @trace_recorder&.cleanup
+<%- end -%>
       @video_recorder&.cleanup
       <%= partial('quit_driver', strip: true) %>
     end