ruby_raider 2.0.0 → 3.0.0

data/lib/generators/cucumber/templates/accessibility_steps.tt

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+Given('I am on the home page') do
+  <% if capybara? -%>
+visit '/'
+  <% elsif watir? -%>
+browser.goto 'https://raider-test-site.onrender.com/'
+  <% else -%>
+driver.get 'https://raider-test-site.onrender.com/'
+  <% end -%>
+end
+
+Then('the page should be accessible') do
+  <% if capybara? -%>
+expect(page).to be_axe_clean
+  <% elsif watir? -%>
+expect(browser.driver).to be_axe_clean
+  <% else -%>
+expect(driver).to be_axe_clean
+  <% end -%>
+end

data/lib/generators/cucumber/templates/cucumber.tt

@@ -1 +1,8 @@
-default: --format AllureCucumber::CucumberFormatter --out allure-results --publish-quiet
+<%- if allure_reporter? -%>
+default: --format AllureCucumber::CucumberFormatter --out allure-results --publish-quiet --retry 0
+<%- else -%>
+default: --publish-quiet --retry 0
+<%- end -%>
+<%- if json_reporter? -%>
+json: --format json --out results/results.json --publish-quiet
+<%- end -%>

data/lib/generators/cucumber/templates/feature.tt

@@ -4,11 +4,7 @@ Feature: Login Page
 Scenario: A user can login
     Given I'm a registered user on the login page
     When I login with my credentials
-<%- if axe? -%>
-    Then the page should be axe clean
-<%- else -%>
     Then I'm logged in
-<% end -%>
 
 <%- else -%>
 Feature: Home Page

data/lib/generators/cucumber/templates/partials/appium_env.tt

@@ -1,12 +1,17 @@
 require 'tmpdir'
 require_relative '../../helpers/allure_helper'
+require_relative '../../helpers/video_helper'
 
 Before do
   AllureHelper.configure
   driver.start_driver
+  @video_recorder = VideoHelper.recorder_for(driver)
+  @video_recorder&.start(self.class.to_s)
 end
 
 After do |scenario|
+  video_file = @video_recorder&.stop
+  AllureHelper.add_video(scenario.name, video_file)
   Dir.mktmpdir do |temp_folder|
     screenshot = driver.screenshot("#{temp_folder}/#{scenario.name}.png")
     AllureHelper.add_screenshot(scenario.name, screenshot)

data/lib/generators/cucumber/templates/partials/capybara_env.tt

@@ -4,14 +4,32 @@ require 'rspec'
 require 'tmpdir'
 require_relative '../../helpers/allure_helper'
 require_relative '../../helpers/capybara_helper'
+require_relative '../../helpers/video_helper'
+require_relative '../../helpers/debug_helper'
 
 CapybaraHelper.configure
 
 Before do
-  Capybara.current_session.driver.browser.manage.window.maximize
+  viewport = YAML.load_file('config/config.yml')['viewport']
+  if viewport
+    Capybara.current_session.driver.browser.manage.window.resize_to(viewport['width'], viewport['height'])
+  else
+    Capybara.current_session.driver.browser.manage.window.maximize
+  end
+  @video_recorder = VideoHelper.recorder_for(Capybara.current_session.driver)
+  @video_recorder&.start(self.class.to_s)
+  DebugHelper.enable_network_logging(Capybara.current_session.driver)
+  @debug_action_logger = DebugHelper.action_logger_for(self.class.to_s)
 end
 
 After do |scenario|
+  if scenario.failed?
+    DebugHelper.capture_failure_diagnostics(Capybara.current_session.driver, scenario.name, exception: scenario.exception)
+    DebugHelper.capture_network_logs(DebugHelper.resolve_selenium_driver(Capybara.current_session.driver), DebugHelper.sanitize(scenario.name))
+  end
+  @debug_action_logger&.close
+  video_file = @video_recorder&.stop
+  AllureHelper.add_video(scenario.name, video_file)
   Dir.mktmpdir do |temp_folder|
     screenshot = Capybara.page.save_screenshot("#{temp_folder}/#{scenario.name}.png")
     AllureHelper.add_screenshot(scenario.name, screenshot)

data/lib/generators/cucumber/templates/partials/driver_world.tt

@@ -1,11 +1,8 @@
 require_relative '../../helpers/driver_helper'
-<%- if visual? -%>
-require_relative '../../helpers/visual_helper'
-<%- end -%>
 <%- if selenium_based? -%>
 require_relative '../../models/user_factory'
 
-World(DriverHelper<%- if visual? -%>, VisualHelper<%- end -%>)
+World(DriverHelper)
 <%- else -%>
 
 World(DriverHelper)

data/lib/generators/cucumber/templates/partials/selenium_env.tt

@@ -1,52 +1,39 @@
 # frozen_string_literal: true
-<%- if visual? -%>
 
-require 'tmpdir'
-require_relative '../../helpers/allure_helper'
-require_relative '../../helpers/driver_helper'
-require_relative '../../helpers/visual_helper'
-
-include DriverHelper
-include VisualHelper
-
-Before do
-  OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE
-  @grid_runner = VisualHelper.create_grid_runner
-  @eyes = VisualHelper.create_eyes(@grid_runner)
-  VisualHelper.configure_eyes @eyes
-  @driver = @eyes.open(driver: driver)
-end
-
-After do |scenario|
-  Dir.mktmpdir do |temp_folder|
-    screenshot = driver.save_screenshot("#{temp_folder}/#{scenario.name}.png")
-    AllureHelper.add_screenshot(scenario.name, screenshot)
-  end
-  @eyes.close
-  @driver.quit
-  @eyes.abort_async
-  results = @grid_runner.get_all_test_results
-  puts results
-end
-
-<%- else -%>
-
-<%- if axe? && cucumber? -%>
+<%- if axe_addon? && cucumber? -%>
 require 'axe-rspec'
 <%- end -%>
 require 'rspec'
 require 'tmpdir'
+require 'yaml'
 require_relative '../../helpers/allure_helper'
+require_relative '../../helpers/video_helper'
+require_relative '../../helpers/debug_helper'
 
 Before do
-  driver.manage.window.maximize
+  viewport = YAML.load_file('config/config.yml')['viewport']
+  if viewport
+    driver.manage.window.resize_to(viewport['width'], viewport['height'])
+  else
+    driver.manage.window.maximize
+  end
+  @video_recorder = VideoHelper.recorder_for(driver)
+  @video_recorder&.start(self.class.to_s)
+  DebugHelper.enable_network_logging(driver)
+  @debug_action_logger = DebugHelper.action_logger_for(self.class.to_s)
 end
 
 After do |scenario|
+  if scenario.failed?
+    DebugHelper.capture_failure_diagnostics(driver, scenario.name, exception: scenario.exception)
+    DebugHelper.capture_network_logs(DebugHelper.resolve_selenium_driver(driver), DebugHelper.sanitize(scenario.name))
+  end
+  @debug_action_logger&.close
+  video_file = @video_recorder&.stop
+  AllureHelper.add_video(scenario.name, video_file)
   Dir.mktmpdir do |temp_folder|
     screenshot = driver.save_screenshot("#{temp_folder}/#{scenario.name}.png")
     AllureHelper.add_screenshot(scenario.name, screenshot)
   end
   driver.quit
-end
-<%- end -%>
+end

data/lib/generators/cucumber/templates/partials/watir_env.tt

@@ -1,13 +1,32 @@
 # frozen_string_literal: true
 
 require 'tmpdir'
+require 'yaml'
 require_relative '../../helpers/allure_helper'
+require_relative '../../helpers/video_helper'
+require_relative '../../helpers/debug_helper'
 
 Before do
-  browser.window.maximize
+  viewport = YAML.load_file('config/config.yml')['viewport']
+  if viewport
+    browser.window.resize_to(viewport['width'], viewport['height'])
+  else
+    browser.window.maximize
+  end
+  @video_recorder = VideoHelper.recorder_for(browser)
+  @video_recorder&.start(self.class.to_s)
+  DebugHelper.enable_network_logging(browser)
+  @debug_action_logger = DebugHelper.action_logger_for(self.class.to_s)
 end
 
 After do |scenario|
+  if scenario.failed?
+    DebugHelper.capture_failure_diagnostics(browser, scenario.name, exception: scenario.exception)
+    DebugHelper.capture_network_logs(DebugHelper.resolve_selenium_driver(browser), DebugHelper.sanitize(scenario.name))
+  end
+  @debug_action_logger&.close
+  video_file = @video_recorder&.stop
+  AllureHelper.add_video(scenario.name, video_file)
   Dir.mktmpdir do |temp_folder|
     screenshot = browser.screenshot.save("#{temp_folder}/#{scenario.name}.png")
     AllureHelper.add_screenshot(scenario.name, screenshot)

data/lib/generators/cucumber/templates/partials/web_steps.tt

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+# Uncomment for interactive debugging:
+# require 'debug'    # Ruby's built-in debugger (binding.break)
+# require 'pry'      # Pry debugger (binding.pry)
+
 require_relative '../../page_objects/pages/account'
 require_relative '../../page_objects/pages/login'
 
@@ -10,22 +14,12 @@ Given("I'm a {user} on the login page") do |user|
 end
 
 When('I login with my credentials') do
+  # binding.break  # Uncomment to pause here and inspect state
   @login_page.login(@user['username'], @user['password'])
 end
 
-<%- if axe? -%>
-Then('the page should be axe clean') do
-  account = Account.new(driver)
-  expect(account.page).to be_axe_clean
-end
-<%- else -%>
 Then("I'm logged in") do
   account_page = <% if capybara? %>Account.new<% elsif watir? %>Account.new(browser)<% else %>Account.new(driver)<% end %>
-  <%- if visual? -%>
-  check_page account_page
-  <%- else -%>
   account_page.<% if capybara? %>visit_page<% else %>visit<% end %>
   expect(account_page.header.customer_name).to eq "Welcome back #{@user['name']}"
-  <%- end -%>
-end
-<%- end -%>
+end

data/lib/generators/cucumber/templates/performance_feature.tt

@@ -0,0 +1,5 @@
+Feature: Performance Audit
+
+Scenario: Page meets performance threshold
+    Given I audit the home page performance
+    Then the performance score should be above the threshold

data/lib/generators/cucumber/templates/performance_steps.tt

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative '../../helpers/performance_helper'
+
+include PerformanceHelper
+
+Given('I audit the home page performance') do
+  @result = assert_performance_above('https://raider-test-site.onrender.com/', threshold: 0.7)
+end
+
+Then('the performance score should be above the threshold') do
+  expect(@result[:status]).not_to eq(:error),
+    "Lighthouse error: #{@result[:message]}"
+
+  expect(@result[:passed]).to be(true),
+    "Performance below threshold (#{@result[:threshold]}): #{@result[:scores]}"
+end

data/lib/generators/cucumber/templates/visual_feature.tt

@@ -0,0 +1,5 @@
+Feature: Visual Regression
+
+Scenario: Login page matches baseline
+    Given I'm on the login page
+    Then the page should match the visual baseline "login_page"

data/lib/generators/cucumber/templates/visual_steps.tt

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative '../../helpers/visual_helper'
+require_relative '../../page_objects/pages/login'
+
+include VisualHelper
+
+Given("I'm on the login page") do
+  @login_page = <% if capybara? %>Login.new<% elsif watir? %>Login.new(browser)<% else %>Login.new(driver)<% end %>
+  @login_page.<% if capybara? %>visit_page<% else %>visit<% end %>
+end
+
+Then('the page should match the visual baseline {string}') do |baseline_name|
+  screenshot_path = <% if capybara? %>page.save_screenshot("tmp/visual_#{baseline_name}.png")<% elsif watir? %>browser.screenshot.save("tmp/visual_#{baseline_name}.png")<% else %>driver.save_screenshot("tmp/visual_#{baseline_name}.png")<% end %>
+  result = compare_screenshot(baseline_name, screenshot_path)
+
+  expect(result[:status]).not_to eq(:mismatch),
+    "Visual diff: #{(result[:diff].to_f * 100).round(2)}% difference. See: #{result[:diff_path]}"
+end

data/lib/generators/generator.rb

@@ -3,11 +3,12 @@
 require 'thor'
 require_relative 'template_renderer'
 
-# :reek:TooManyMethods { enabled: false }
 class Generator < Thor::Group
   include Thor::Actions
   include TemplateRenderer
 
+  LATEST_RUBY = '3.4'
+
   argument :automation
   argument :framework
   argument :name
@@ -64,8 +65,8 @@ class Generator < Thor::Group
     args.include?('capybara')
   end
 
-  def visual?
-    args.include?('applitools')
+  def visual_addon?
+    args.include?('visual_addon')
   end
 
   def watir?
@@ -73,15 +74,45 @@ class Generator < Thor::Group
   end
 
   def web?
-    (args & %w[selenium watir axe applitools capybara]).count.positive?
+    (args & %w[selenium watir capybara]).count.positive?
+  end
+
+  def axe_addon?
+    args.include?('axe_addon')
   end
 
-  def axe?
-    args.include?('axe')
+  def lighthouse_addon?
+    args.include?('lighthouse_addon')
   end
 
   def selenium_based?
-    (args & %w[selenium axe applitools]).count.positive?
+    args.include?('selenium')
+  end
+
+  def skip_allure?
+    args.include?('skip_allure')
+  end
+
+  def skip_video?
+    args.include?('skip_video')
+  end
+
+  def allure_reporter?
+    has_reporter = args.any? { |a| a&.start_with?('reporter_') }
+    has_reporter ? args.include?('reporter_allure') : !skip_allure?
+  end
+
+  def junit_reporter?
+    args.include?('reporter_junit')
+  end
+
+  def json_reporter?
+    args.include?('reporter_json')
+  end
+
+  def ruby_version
+    arg = args.find { |a| a&.start_with?('ruby_version:') }
+    arg ? arg.split(':', 2).last : LATEST_RUBY
   end
 
   private

data/lib/generators/helper_generator.rb

@@ -9,11 +9,12 @@ class HelpersGenerator < Generator
     generate_capybara_helper
     generate_appium_helper
     generate_allure_helper
+    generate_video_helper
+    generate_debug_helper
+    generate_visual_helper
+    generate_performance_helper
 
-    if visual?
-      generate_visual_helper
-      generate_visual_spec_helper
-    elsif minitest?
+    if minitest?
       generate_test_helper
     else
       generate_spec_helper
@@ -23,9 +24,17 @@ class HelpersGenerator < Generator
   private
 
   def generate_allure_helper
+    return unless allure_reporter?
+
     template('helpers/allure_helper.tt', "#{name}/helpers/allure_helper.rb")
   end
 
+  def generate_video_helper
+    return if skip_video?
+
+    template('helpers/video_helper.tt', "#{name}/helpers/video_helper.rb")
+  end
+
   def generate_browser_helper
     return if selenium_based? || mobile? || capybara?
 
@@ -60,13 +69,21 @@ class HelpersGenerator < Generator
     template('helpers/test_helper.tt', "#{name}/helpers/test_helper.rb")
   end
 
+  def generate_debug_helper
+    return unless web?
+
+    template('helpers/debug_helper.tt', "#{name}/helpers/debug_helper.rb")
+  end
+
   def generate_visual_helper
+    return unless visual_addon? && web?
+
     template('helpers/visual_helper.tt', "#{name}/helpers/visual_helper.rb")
   end
 
-  def generate_visual_spec_helper
-    return if cucumber?
+  def generate_performance_helper
+    return unless lighthouse_addon? && web?
 
-    template('helpers/visual_spec_helper.tt', "#{name}/helpers/spec_helper.rb")
+    template('helpers/performance_helper.tt', "#{name}/helpers/performance_helper.rb")
   end
 end

data/lib/generators/infrastructure/templates/github.tt

@@ -22,7 +22,7 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.4.0
+          ruby-version: <%= ruby_version %>.0
           bundler-cache: true
 
       - name: Set up Chrome

data/lib/generators/infrastructure/templates/github_appium.tt

@@ -14,7 +14,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.4.0
+          ruby-version: <%= ruby_version %>.0
           bundler-cache: true
 
       - name: Download iOS app
@@ -63,7 +63,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.4.0
+          ruby-version: <%= ruby_version %>.0
           bundler-cache: true
 
       - name: Download Android app

data/lib/generators/infrastructure/templates/gitlab.tt

@@ -4,7 +4,7 @@ stages:
   - report
 
 variables:
-  RUBY_VERSION: "3.4.0"
+  RUBY_VERSION: "<%= ruby_version %>.0"
   HEADLESS: "true"
 
 setup_ruby:

data/lib/generators/invoke_generators.rb

@@ -7,8 +7,6 @@ require_relative 'helper_generator'
 require_relative 'minitest/minitest_generator'
 require_relative 'rspec/rspec_generator'
 
-# :reek:FeatureEnvy { enabled: false }
-# :reek:UtilityFunction { enabled: false }
 module InvokeGenerators
   module_function
 
@@ -16,14 +14,16 @@ module InvokeGenerators
     generators = %w[Automation Common Helpers]
     framework = structure[:framework]
     add_generator(generators, framework.capitalize)
-    add_generator(generators, structure[:ci_platform].capitalize) if structure[:ci_platform]
+    add_generator(generators, structure[:ci_platform].capitalize) if !structure[:skip_ci] && (structure[:ci_platform])
+    extra_args = collect_skip_flags(structure)
     generators.each do |generator|
       invoke_generator({
                          automation: structure[:automation],
                          framework:,
                          generator:,
                          ci_platform: structure[:ci_platform],
-                         name: structure[:name]
+                         name: structure[:name],
+                         extra_args:
                        })
     end
   end
@@ -32,12 +32,45 @@ module InvokeGenerators
     gens.each { |generator| generators.push generator }
   end
 
+  # Generator class lookup cache — avoids repeated Object.const_get string interpolation
+  GENERATOR_CLASSES = Hash.new { |h, k| h[k] = Object.const_get("#{k}Generator") }
+
   def invoke_generator(structure = {})
-    Object.const_get("#{structure[:generator]}Generator")
-          .new([structure[:automation],
-                structure[:framework],
-                structure[:name],
-                structure[:ci_platform]]).invoke_all
+    args = [structure[:automation], structure[:framework], structure[:name], structure[:ci_platform]]
+    args.concat(structure[:extra_args] || [])
+    generator_class = GENERATOR_CLASSES[structure[:generator]]
+    generator = generator_class.new(args)
+    # Enable batch mode on the template cache to skip mtime checks during generation
+    generator.class.template_renderer.batch_mode = true if generator.class.respond_to?(:template_renderer)
+    generator.invoke_all
+  end
+
+  def collect_skip_flags(structure)
+    flags = []
+    flags << 'skip_allure' if structure[:skip_allure]
+    flags << 'skip_video' if structure[:skip_video]
+    flags << 'axe_addon' if structure[:accessibility] && !mobile_automation?(structure[:automation])
+    flags << 'visual_addon' if structure[:visual] && !mobile_automation?(structure[:automation])
+    flags << 'lighthouse_addon' if structure[:performance] && !mobile_automation?(structure[:automation])
+    flags << "ruby_version:#{structure[:ruby_version]}" if structure[:ruby_version]
+    flags.concat(reporter_flags(structure[:reporter]))
+    flags
+  end
+
+  def reporter_flags(reporter)
+    case reporter
+    when 'allure' then ['reporter_allure']
+    when 'junit' then ['reporter_junit']
+    when 'json' then ['reporter_json']
+    when 'both' then %w[reporter_allure reporter_junit]
+    when 'all' then %w[reporter_allure reporter_junit reporter_json]
+    when 'none' then ['reporter_none']
+    else []
+    end
+  end
+
+  def mobile_automation?(automation)
+    %w[ios android cross_platform].include?(automation)
   end
 
   def to_bool(string)