ruby_raider 1.1.4 → 3.0.0

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'active_support/core_ext/string/inflections'
 require 'yaml'
 require 'watir'
 
@@ -16,7 +17,17 @@ module BrowserHelper
   end
 
   def create_browser(*args)
-    args = args.empty? ? config['browser_arguments'][config['browser']] : args
-    Watir::Browser.new(config['browser'], options: { args: args })
+    Watir.default_timeout = config.fetch('timeout', 10)
+    browser_name = config['browser'].to_s
+    args = args.empty? ? config['browser_arguments'][browser_name] : args
+    args += ['--headless'] if ENV['HEADLESS'] && !args.include?('--headless')
+    capitalized = browser_name == 'ie' ? browser_name.upcase : browser_name.capitalize
+    browser_options = "Selenium::WebDriver::#{capitalized}::Options".constantize.new(args:)
+    debug_cfg = config['debug'] || {}
+    if %w[chrome edge msedge].include?(browser_name.downcase) &&
+       (debug_cfg.fetch('enabled', false) || ENV['DEBUG']&.downcase == 'true')
+      browser_options.add_option('goog:loggingPrefs', { browser: 'ALL', performance: 'ALL' })
+    end
+    Watir::Browser.new(browser_name.to_sym, options: browser_options)
   end
 end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'capybara'
+require 'capybara/dsl'
+require 'selenium-webdriver'
+require 'yaml'
+
+module CapybaraHelper
+  def self.configure
+    config = YAML.load_file('config/config.yml')
+
+    Capybara.configure do |capybara_config|
+      capybara_config.default_driver = :selenium
+      capybara_config.javascript_driver = :selenium
+      capybara_config.app_host = config['url']
+      capybara_config.default_max_wait_time = config.fetch('timeout', 10)
+      capybara_config.run_server = false
+    end
+
+    Capybara.register_driver :selenium do |app|
+      browser = config['browser'].to_sym
+      args = config['browser_arguments'][config['browser']] || []
+      args += ['--headless'] if ENV['HEADLESS'] && !args.include?('--headless')
+      options = Selenium::WebDriver::Chrome::Options.new(args:)
+      debug_cfg = config['debug'] || {}
+      if debug_cfg.fetch('enabled', false) || ENV['DEBUG']&.downcase == 'true'
+        options.add_option('goog:loggingPrefs', { browser: 'ALL', performance: 'ALL' })
+      end
+      Capybara::Selenium::Driver.new(app, browser:, options:)
+    end
+  end
+end

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

@@ -0,0 +1,190 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'yaml'
+require 'logger'
+require 'json'
+
+module DebugHelper
+  LOG_DIR = 'debug_logs'
+
+  module_function
+
+  # --- Configuration ---
+
+  def config
+    @config ||= begin
+      yml = YAML.load_file('config/config.yml')
+      yml['debug'] || {}
+    rescue StandardError
+      {}
+    end
+  end
+
+  def enabled?
+    ENV['DEBUG']&.downcase == 'true' || config.fetch('enabled', false)
+  end
+
+  def console_logs?
+    enabled? && config.fetch('console_logs', true)
+  end
+
+  def action_logging?
+    enabled? && config.fetch('action_logging', true)
+  end
+
+  def network_logging?
+    enabled? && config.fetch('network_logging', true)
+  end
+
+  def log_dir
+    config.fetch('log_dir', LOG_DIR)
+  end
+
+  def ensure_log_dir
+    FileUtils.mkdir_p(log_dir)
+  end
+
+  # --- Driver Resolution ---
+
+  def resolve_selenium_driver(obj)
+    if obj.respond_to?(:driver) && !obj.is_a?(Selenium::WebDriver::Driver)
+      obj.driver
+    elsif obj.respond_to?(:browser) && obj.browser.respond_to?(:driver)
+      obj.browser.driver
+    else
+      obj
+    end
+  rescue StandardError
+    obj
+  end
+
+  # --- Failure Diagnostics (returns structured hash for desktop integration) ---
+
+  def capture_failure_diagnostics(driver_or_browser, test_name, exception: nil)
+    return {} unless enabled?
+
+    ensure_log_dir
+    sel_driver = resolve_selenium_driver(driver_or_browser)
+    safe_name = sanitize(test_name)
+    diagnostics = { test_name: test_name, timestamp: Time.now.iso8601 }
+
+    diagnostics[:url] = sel_driver.current_url rescue 'unknown'
+    diagnostics[:title] = sel_driver.title rescue 'unknown'
+
+    if exception
+      diagnostics[:error_message] = exception.message
+      diagnostics[:error_class] = exception.class.name
+      diagnostics[:stack_trace] = exception.backtrace&.first(20) || []
+    end
+
+    diagnostics[:console_logs] = capture_console_logs(sel_driver) if console_logs?
+    diagnostics[:network_log_path] = capture_network_logs(sel_driver, safe_name) if network_logging?
+
+    # HTML snapshot
+    html_path = File.join(log_dir, "#{safe_name}_page.html")
+    File.write(html_path, sel_driver.page_source) rescue nil
+    diagnostics[:html_snapshot] = html_path
+
+    # Write diagnostics JSON (desktop app reads this)
+    summary_path = File.join(log_dir, "#{safe_name}_diagnostics.json")
+    File.write(summary_path, JSON.pretty_generate(diagnostics))
+    diagnostics[:summary_path] = summary_path
+
+    diagnostics
+  rescue StandardError => e
+    warn "[debug] Failed to capture diagnostics: #{e.message}"
+    {}
+  end
+
+  # --- Console Log Capture ---
+
+  def capture_console_logs(sel_driver)
+    return [] unless chrome_or_edge?(sel_driver)
+
+    sel_driver.logs.get(:browser).map { |entry| { level: entry.level, message: entry.message, timestamp: entry.timestamp } }
+  rescue StandardError
+    []
+  end
+
+  # --- Action Logger ---
+
+  class ActionLogger
+    def initialize(test_name)
+      DebugHelper.ensure_log_dir
+      log_path = File.join(DebugHelper.log_dir, "#{DebugHelper.sanitize(test_name)}_actions.log")
+      @logger = Logger.new(log_path)
+      @logger.formatter = proc { |severity, datetime, _progname, msg|
+        "[#{datetime.strftime('%H:%M:%S.%L')}] #{severity}: #{msg}\n"
+      }
+    end
+
+    def log(action, details = '')
+      @logger.info("#{action} #{details}".strip)
+    end
+
+    def close
+      @logger.close
+    rescue StandardError
+      nil
+    end
+  end
+
+  class NullActionLogger
+    def log(_action, _details = '') = nil
+    def close = nil
+  end
+
+  def action_logger_for(test_name)
+    action_logging? ? ActionLogger.new(test_name) : NullActionLogger.new
+  end
+
+  # --- Network Logging Setup ---
+
+  def enable_network_logging(driver_or_browser)
+    return unless network_logging?
+
+    sel_driver = resolve_selenium_driver(driver_or_browser)
+    return unless chrome_or_edge?(sel_driver)
+
+    sel_driver.execute_cdp('Network.enable')
+  rescue StandardError => e
+    warn "[debug] Could not enable network logging: #{e.message}"
+  end
+
+  # --- Network Log Capture ---
+
+  def capture_network_logs(sel_driver, safe_name)
+    return unless chrome_or_edge?(sel_driver)
+
+    logs = sel_driver.logs.get(:performance)
+    return if logs.empty?
+
+    entries = logs.filter_map do |entry|
+      parsed = JSON.parse(entry.message)['message'] rescue next
+      parsed if parsed.is_a?(Hash) && parsed['method']&.start_with?('Network.')
+    end
+
+    return if entries.empty?
+
+    network_path = File.join(log_dir, "#{safe_name}_network.json")
+    File.write(network_path, JSON.pretty_generate(entries))
+    network_path
+  rescue StandardError => e
+    warn "[debug] Failed to capture network logs: #{e.message}"
+    nil
+  end
+
+  # --- Helpers ---
+
+  def chrome_or_edge?(driver)
+    browser_name = driver.capabilities[:browser_name].to_s.downcase
+    %w[chrome chromium msedge edge].any? { |b| browser_name.include?(b) }
+  rescue StandardError
+    false
+  end
+
+  def sanitize(name)
+    name.to_s.gsub(/[^a-zA-Z0-9_-]/, '_')[0..80]
+  end
+end

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

@@ -1,26 +1,18 @@
 # frozen_string_literal: true
-<% if axe? -%>
-require 'axe-selenium'
-<% end -%>
+
 require 'yaml'
-<%- unless axe? %>
 <%- if selenium_based? -%>
 require 'active_support/inflector'
 require 'selenium-webdriver'
 <%- else -%>
 require 'appium_lib'
 <%- end -%>
-<%- end -%>
 
 module DriverHelper
-  <%- if selenium_based? && !axe? -%>
+  <%- if selenium_based? -%>
   def driver(*opts)
     @driver ||= create_driver(*opts)
   end
-  <%- elsif axe? -%>
-  def driver(browser = :chrome, js_path = nil, skip_iframes = nil)
-    @driver ||= create_driver(browser, js_path, skip_iframes)
-  end
   <%- else -%>
   def driver
     @driver ||= create_driver
@@ -29,5 +21,5 @@ module DriverHelper
 
   private
 
-  <%= ERB.new(File.read(File.expand_path('./partials/driver_and_options.tt', __dir__)), trim_mode: '-').result(binding).strip! %>
+  <%= partial('driver_and_options', strip: true) %>
 end

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

@@ -1,5 +1,7 @@
 <% if rspec? %>
 AllureRspec
-<% else %>
+<% elsif cucumber? %>
 AllureCucumber
+<% else %>
+Allure
 <% end %>

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

@@ -1,6 +1,8 @@
 <% if cucumber? %>
 require 'allure-cucumber'
-<% else %>
+<% elsif rspec? %>
 require 'allure-ruby-commons'
 require 'allure-rspec'
+<% else %>
+require 'allure-ruby-commons'
 <% end %>

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

@@ -0,0 +1,44 @@
+  def create_driver
+    @driver = configure_driver
+  end
+<%- if cross_platform? -%>
+
+  def platform
+    @platform ||= YAML.load_file('config/config.yml')['platform'].to_s
+  end
+
+  def platform_caps
+    @platform_caps ||= YAML.load_file('config/capabilities.yml')[platform]
+  end
+
+  def parsed_caps
+    platform_caps['appium:options']['app'] = parse_app_path(platform_caps['appium:options']['app'])
+    platform_caps
+  end
+
+  def parse_app_path(path)
+    File.expand_path(path, Dir.pwd)
+  end
+<%- else -%>
+
+  def parsed_caps
+    caps = YAML.load_file('config/capabilities.yml')
+    caps['appium:options']['app'] = app_path(caps['appium:options']['app'])
+    caps
+  end
+
+  def app_path(path)
+    File.expand_path(path, Dir.pwd)
+  end
+<%- end -%>
+
+<%= partial('browserstack_config', strip: true) %>
+
+  def configure_driver
+    if browserstack?
+      Appium::Driver.new({ caps: browserstack_caps,
+                           'appium_lib': { server_url: parsed_browserstack_url}}, true)
+    else
+      Appium::Driver.new({ caps: parsed_caps })
+    end
+  end

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

@@ -0,0 +1,13 @@
+  def browserstack?
+    ENV['TEST_ENV'] == 'browserstack'
+  end
+
+  def browserstack_caps
+    @browserstack_caps ||= YAML.load_file('config/capabilities.yml')['browserstack']
+  end
+
+  def parsed_browserstack_url
+    username = ENV['BROWSERSTACK_USER']
+    access_key = ENV['BROWSERSTACK_KEY']
+    "https://#{username}:#{access_key}@hub-cloud.browserstack.com/wd/hub"
+  end

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

@@ -0,0 +1,7 @@
+<% if capybara? %>
+  DebugHelper.capture_failure_diagnostics(Capybara.current_session.driver, example_name, exception: @_exception)
+<% elsif selenium_based? %>
+  DebugHelper.capture_failure_diagnostics(driver, example_name, exception: @_exception)
+<% elsif watir? %>
+  DebugHelper.capture_failure_diagnostics(browser, example_name, exception: @_exception)
+<% end %>

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

@@ -0,0 +1,7 @@
+<% if capybara? %>
+  DebugHelper.enable_network_logging(Capybara.current_session.driver)
+<% elsif selenium_based? %>
+  DebugHelper.enable_network_logging(driver)
+<% elsif watir? %>
+  DebugHelper.enable_network_logging(browser)
+<% end %>

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

@@ -1,115 +1,5 @@
-<% if axe? -%>
-  def create_driver(browser, js_path, skip_iframes)
-    AxeSelenium.configure(browser) do |config|
-      config.jslib_path = js_path if js_path
-      config.skip_iframes = skip_iframes if skip_iframes
-    end.page
-  end
-<% elsif selenium_based? -%>
-  def create_driver(*opts)
-    @config = YAML.load_file('config/config.yml')
-    browser = @config['browser']
-    Selenium::WebDriver.for(browser.to_sym, options: create_webdriver_options(*opts))
-  end
-
-  def browser_arguments(*opts)
-    opts.empty? ? @config['browser_arguments'][@config['browser']] : opts
-  end
-
-  def driver_options
-    @config['driver_options']
-  end
-
-  # :reek:FeatureEnvy
-  def create_webdriver_options(*opts)
-    load_browser = @config['browser'].to_s
-    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) }
-    driver_options.each { |opt| options.add_option(opt.first, opt.last) }
-    options
-  end
-<% elsif cross_platform? -%>
-  def create_driver
-    @driver = configure_driver
-  end
-
-  def platform
-    @platform ||= YAML.load_file('config/config.yml')['platform'].to_s
-  end
-
-  def platform_caps
-    @platform_caps ||= YAML.load_file('config/capabilities.yml')[platform]
-  end
-
-  # :reek:UtilityFunction
-  def parsed_caps
-    platform_caps['appium:options']['app'] = parse_app_path(platform_caps['appium:options']['app'])
-    platform_caps
-  end
-
-  def parse_app_path(path)
-    File.expand_path(path, Dir.pwd)
-  end
-
-  def browserstack?
-    ENV['TEST_ENV'] == 'browserstack'
-  end
-
-  def browserstack_caps
-    @browserstack_caps ||= YAML.load_file('config/capabilities.yml')['browserstack']
-  end
-
-  def configure_driver
-    if browserstack?
-      Appium::Driver.new({ caps: browserstack_caps,
-                           'appium_lib': { server_url: parsed_browserstack_url}}, true)
-    else
-      Appium::Driver.new({ caps: parsed_caps })
-    end
-  end
-
-  def parsed_browserstack_url
-    username = ENV['BROWSERSTACK_USER']
-    access_key = ENV['BROWSERSTACK_KEY']
-    "https://#{username}:#{access_key}@hub-cloud.browserstack.com/wd/hub"
-  end
-<% else -%>
-    def create_driver
-      @driver = configure_driver
-    end
-
-     # :reek:UtilityFunction
-     def parsed_caps
-       caps = YAML.load_file('config/capabilities.yml')
-       caps['appium:options']['app'] = app_path(caps['appium:options']['app'])
-       caps
-     end
-
-     def app_path(path)
-       File.expand_path(path, Dir.pwd)
-     end
-
-    def browserstack?
-      ENV['TEST_ENV'] == 'browserstack'
-    end
-
-    def browserstack_caps
-      @browserstack_caps ||= YAML.load_file('config/capabilities.yml')['browserstack']
-    end
-
-    def configure_driver
-      if browserstack?
-        Appium::Driver.new({ caps: browserstack_caps,
-                             'appium_lib': { server_url: parsed_browserstack_url}}, true)
-      else
-        Appium::Driver.new({ caps: parsed_caps })
-      end
-    end
-
-    def parsed_browserstack_url
-      username = ENV['BROWSERSTACK_USER']
-      access_key = ENV['BROWSERSTACK_KEY']
-      "https://#{username}:#{access_key}@hub-cloud.browserstack.com/wd/hub"
-    end
-<% end -%>
+<% if selenium_based? -%>
+<%= partial('selenium_driver', strip: true) %>
+<%- else -%>
+<%= partial('appium_driver', strip: true) %>
+<%- end -%>

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

@@ -1,4 +1,6 @@
-<% if selenium_based? %>
+<% if capybara? %>
+  Capybara.reset_sessions!
+<% elsif selenium_based? %>
   driver.quit
 <% elsif watir? %>
   browser.quit

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

@@ -1,4 +1,6 @@
-<% if selenium_based? %>
+<% if capybara? %>
+  screenshot = Capybara.page.save_screenshot("#{temp_folder}/#{example_name}.png")
+<% elsif selenium_based? %>
   screenshot = driver.save_screenshot("#{temp_folder}/#{example_name}.png")
 <% elsif watir? %>
   screenshot = browser.screenshot.save("#{temp_folder}/#{example_name}.png")

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

@@ -0,0 +1,26 @@
+  def create_driver(*opts)
+    @config = YAML.load_file('config/config.yml')
+    browser = @config['browser']
+    driver = Selenium::WebDriver.for(browser.to_sym, options: create_webdriver_options(*opts))
+    driver.manage.timeouts.implicit_wait = @config.fetch('timeout', 10)
+    driver
+  end
+
+  def browser_arguments(*opts)
+    args = opts.empty? ? @config['browser_arguments'][@config['browser']] : opts
+    args += ['--headless'] if ENV['HEADLESS'] && !args.include?('--headless')
+    args
+  end
+
+  def create_webdriver_options(*opts)
+    load_browser = @config['browser'].to_s
+    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) }
+    debug_cfg = @config['debug'] || {}
+    if %w[chrome edge msedge].include?(@config['browser'].to_s.downcase) &&
+       (debug_cfg.fetch('enabled', false) || ENV['DEBUG']&.downcase == 'true')
+      options.add_option('goog:loggingPrefs', { browser: 'ALL', performance: 'ALL' })
+    end
+    options
+  end

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

@@ -0,0 +1,9 @@
+<% if capybara? %>
+  @video_recorder = VideoHelper.recorder_for(Capybara.current_session.driver)
+<% elsif selenium_based? %>
+  @video_recorder = VideoHelper.recorder_for(driver)
+<% elsif watir? %>
+  @video_recorder = VideoHelper.recorder_for(browser)
+<% else %>
+  @video_recorder = VideoHelper.recorder_for(driver)
+<% end %>

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

@@ -0,0 +1,4 @@
+  video_file = @video_recorder&.stop
+<% if allure_reporter? %>
+  AllureHelper.add_video(example_name, video_file)
+<% end %>

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'open3'
+require 'json'
+require 'fileutils'
+require 'yaml'
+
+module PerformanceHelper
+  REPORTS_DIR = 'lighthouse_reports'
+
+  def run_lighthouse_audit(url, categories: %w[performance accessibility best-practices seo])
+    FileUtils.mkdir_p(REPORTS_DIR)
+
+    report_path = File.join(REPORTS_DIR, "report_#{Time.now.to_i}.json")
+    category_flags = categories.map { |c| "--only-categories=#{c}" }.join(' ')
+
+    config_timeout = if File.exist?('config/config.yml')
+                        YAML.load_file('config/config.yml').fetch('timeout', 10)
+                      else
+                        10
+                      end
+    max_wait = config_timeout * 1000
+
+    command = "lighthouse #{url} --output=json --output-path=#{report_path} " \
+              "--chrome-flags=\"--headless --no-sandbox\" #{category_flags} " \
+              "--max-wait-for-load=#{max_wait} --quiet"
+
+    stdout, stderr, status = Open3.capture3(command)
+
+    unless status.success?
+      return { status: :error, message: "Lighthouse failed: #{stderr.strip.empty? ? stdout : stderr}" }
+    end
+
+    report = JSON.parse(File.read(report_path))
+    scores = extract_scores(report)
+
+    { status: :success, scores:, report_path: }
+  end
+
+  def assert_performance_above(url, threshold: 0.8, categories: %w[performance])
+    result = run_lighthouse_audit(url, categories:)
+    return result if result[:status] == :error
+
+    passed = result[:scores].all? { |_category, score| score >= threshold }
+
+    { status: passed ? :pass : :fail, scores: result[:scores], passed:, threshold:,
+      report_path: result[:report_path] }
+  end
+
+  private
+
+  def extract_scores(report)
+    report.fetch('categories', {}).each_with_object({}) do |(key, data), scores|
+      scores[key] = data['score']
+    end
+  end
+end