ruby_raider 1.1.4 → 3.0.0

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

@@ -1,30 +1,25 @@
 # 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'
 
 Given("I'm a {user} on the login page") do |user|
   @user = user
-  @login_page = Login.new(<% if watir? %>browser<% else %>driver<% end %>)
-  @login_page.visit
+  @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
 
 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 = Account.new(<% if watir? %>browser<% else %>driver<% end %>)
-  <%- if visual? -%>
-  check_page account_page
-  <%- else -%>
+  account_page = <% if capybara? %>Account.new<% elsif watir? %>Account.new(browser)<% else %>Account.new(driver)<% end %>
+  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/steps.tt

@@ -1,5 +1,5 @@
 <%- if web? -%>
-<%= ERB.new(File.read(File.expand_path('./partials/web_steps.tt', __dir__)), trim_mode: '-').result(binding).strip! -%>
+<%= partial('web_steps', strip: true) -%>
 <%- else -%>
-<%= ERB.new(File.read(File.expand_path('./partials/mobile_steps.tt', __dir__)), trim_mode: '-').result(binding).strip! -%>
+<%= partial('mobile_steps', strip: true) -%>
 <%- 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/cucumber/templates/world.tt

@@ -1,5 +1,7 @@
-<%- if watir? -%>
-<%=- ERB.new(File.read(File.expand_path('./partials/watir_world.tt', __dir__)), trim_mode: '-').result(binding).strip! -%>
+<%- if capybara? -%>
+<%=- partial('capybara_world', strip: true) -%>
+<%- elsif watir? -%>
+<%=- partial('watir_world', strip: true) -%>
 <%- else -%>
-<%=- ERB.new(File.read(File.expand_path('./partials/driver_world.tt', __dir__)), trim_mode: '-').result(binding).strip! -%>
+<%=- partial('driver_world', strip: true) -%>
 <%- end -%>

data/lib/generators/generator.rb

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
 
 require 'thor'
+require_relative 'template_renderer'
 
 class Generator < Thor::Group
   include Thor::Actions
+  include TemplateRenderer
+
+  LATEST_RUBY = '3.4'
 
   argument :automation
   argument :framework
@@ -12,7 +16,8 @@ class Generator < Thor::Group
   def self.source_paths
     base_path = File.dirname(__FILE__)
     %W[#{base_path}/automation/templates #{base_path}/cucumber/templates
-       #{base_path}/rspec/templates #{base_path}/templates #{base_path}/infrastructure/templates ]
+       #{base_path}/rspec/templates #{base_path}/minitest/templates
+       #{base_path}/templates #{base_path}/infrastructure/templates ]
   end
 
   def args
@@ -48,12 +53,20 @@ class Generator < Thor::Group
     args.include?('rspec')
   end
 
+  def minitest?
+    args.include?('minitest')
+  end
+
   def selenium?
     args.include?('selenium')
   end
 
-  def visual?
-    args.include?('applitools')
+  def capybara?
+    args.include?('capybara')
+  end
+
+  def visual_addon?
+    args.include?('visual_addon')
   end
 
   def watir?
@@ -61,15 +74,45 @@ class Generator < Thor::Group
   end
 
   def web?
-    (args & (%w[selenium watir axe applitools])).count.positive?
+    (args & %w[selenium watir capybara]).count.positive?
   end
 
-  def axe?
-    args.include?('axe')
+  def axe_addon?
+    args.include?('axe_addon')
+  end
+
+  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

@@ -6,12 +6,16 @@ class HelpersGenerator < Generator
   def generate_helpers
     generate_browser_helper
     generate_driver_helper
+    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
+    if minitest?
+      generate_test_helper
     else
       generate_spec_helper
     end
@@ -20,40 +24,66 @@ 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?
+    return if selenium_based? || mobile? || capybara?
 
     template('helpers/browser_helper.tt', "#{name}/helpers/browser_helper.rb")
   end
 
   def generate_spec_helper
-    return if cucumber?
+    return if cucumber? || minitest?
 
     template('helpers/spec_helper.tt', "#{name}/helpers/spec_helper.rb")
   end
 
   def generate_driver_helper
-    return if watir?
+    return if watir? || capybara?
 
     template('helpers/driver_helper.tt', "#{name}/helpers/driver_helper.rb")
   end
 
+  def generate_capybara_helper
+    return unless capybara?
+
+    template('helpers/capybara_helper.tt', "#{name}/helpers/capybara_helper.rb")
+  end
+
   def generate_appium_helper
     return unless cross_platform?
 
     template('helpers/appium_helper.tt', "#{name}/helpers/appium_helper.rb")
   end
 
+  def generate_test_helper
+    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/github_generator.rb

@@ -8,4 +8,10 @@ class GithubGenerator < Generator
 
     template('github.tt', "#{name}/.github/workflows/test_pipeline.yml")
   end
+
+  def generate_appium_pipeline
+    return unless mobile?
+
+    template('github_appium.tt', "#{name}/.github/workflows/appium_pipeline.yml")
+  end
 end

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

@@ -16,23 +16,27 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.4.0
+          ruby-version: <%= ruby_version %>.0
           bundler-cache: true
 
-      - name: Checkout repository
-        uses: actions/checkout@v3
-
-      - name: Install gems
-        run: bundle install
+      - name: Set up Chrome
+        uses: browser-actions/setup-chrome@v1
+        with:
+          chrome-version: stable
 
       - name: Create allure-results folder
         run: mkdir -p allure-results
 
-      - name: Build and test with rspec
-        run: <%- if framework == 'cucumber' -%>cucumber features --format pretty <%- else -%>bundle exec rspec spec --format documentation<%- end -%>
+      - name: Run tests
+        run: <%- if framework == 'cucumber' -%>bundle exec cucumber features --format pretty<%- elsif minitest? -%>bundle exec ruby -Itest test/test_login_page.rb<%- else -%>bundle exec rspec spec --format documentation<%- end %>
+        env:
+          HEADLESS: true
 
       - name: Get Allure history
         uses: actions/checkout@v2

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

@@ -0,0 +1,108 @@
+name: Appium Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+<%- if ios? || cross_platform? -%>
+  ios-tests:
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: <%= ruby_version %>.0
+          bundler-cache: true
+
+      - name: Download iOS app
+        uses: dawidd6/action-download-artifact@v6
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          repo: RaiderHQ/raider_test_app
+          workflow: build-ios.yml
+          name: raider-test-app-ios
+          path: apps/
+
+      - name: Unzip iOS app
+        run: |
+          cd apps
+          unzip RaiderTestApp.app.zip
+
+      - name: Start iOS Simulator
+        uses: futureware-tech/simulator-action@v3
+        with:
+          model: 'iPhone 15'
+          os_version: '17'
+
+      - name: Install and start Appium
+        run: |
+          npm install -g appium
+          appium driver install xcuitest
+          appium &
+          sleep 5
+
+      - name: Run tests
+<%- if cucumber? -%>
+        run: bundle exec cucumber features/ --format pretty
+<%- elsif minitest? -%>
+        run: bundle exec ruby -Itest test/test_pdp_page.rb
+<%- else -%>
+        run: bundle exec rspec spec/ --format documentation
+<%- end -%>
+        env:
+          APP_PATH: ${{ github.workspace }}/apps/RaiderTestApp.app
+<%- end -%>
+
+<%- if android? || cross_platform? -%>
+  android-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: <%= ruby_version %>.0
+          bundler-cache: true
+
+      - name: Download Android app
+        uses: dawidd6/action-download-artifact@v6
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          repo: RaiderHQ/raider_test_app
+          workflow: build-android.yml
+          name: raider-test-app-android
+          path: apps/
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+
+      - name: Install and start Appium
+        run: |
+          npm install -g appium
+          appium driver install uiautomator2
+          appium &
+          sleep 5
+
+      - name: Run Android Emulator and Tests
+        uses: reactivecircus/android-emulator-runner@v2
+        with:
+          api-level: 34
+          target: google_apis
+          arch: x86_64
+          profile: pixel_8
+          script: |
+<%- if cucumber? -%>
+            bundle exec cucumber features/ --format pretty
+<%- elsif minitest? -%>
+            bundle exec ruby -Itest test/test_pdp_page.rb
+<%- else -%>
+            bundle exec rspec spec/ --format documentation
+<%- end -%>
+        env:
+          APP_PATH: ${{ github.workspace }}/apps/app-release.apk
+<%- end -%>

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

@@ -4,7 +4,8 @@ stages:
   - report
 
 variables:
-  RUBY_VERSION: "3.4.0"
+  RUBY_VERSION: "<%= ruby_version %>.0"
+  HEADLESS: "true"
 
 setup_ruby:
   stage: setup
@@ -18,9 +19,11 @@ setup_ruby:
 run_tests:
   stage: test
   image: ruby:${RUBY_VERSION}
-  script:
+  before_script:
+    - apt-get update -qq && apt-get install -y -qq chromium chromium-driver
     - mkdir -p allure-results
-    - <%- if framework == 'cucumber' -%> cucumber features --format pretty <%- else -%> bundle exec rspec spec --format documentation <%- end%>
+  script:
+    - <%- if framework == 'cucumber' -%>bundle exec cucumber features --format pretty<%- elsif minitest? -%>bundle exec ruby -Itest test/test_login_page.rb<%- else -%>bundle exec rspec spec --format documentation<%- end %>
   artifacts:
     paths:
       - allure-results/

data/lib/generators/invoke_generators.rb

@@ -4,10 +4,9 @@ require_relative 'automation/automation_generator'
 require_relative 'common_generator'
 require_relative 'cucumber/cucumber_generator'
 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
 
@@ -15,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
@@ -31,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)