ruby_raider 1.1.4 → 3.0.0

data/lib/generators/automation/templates/appium_caps.tt

@@ -1,7 +1,61 @@
-<% if ios? %>
-<%= ERB.new(File.read(File.expand_path('./partials/ios_caps.tt', __dir__))).result(binding) -%>
-<% elsif android? %>
-<%= ERB.new(File.read(File.expand_path('./partials/android_caps.tt', __dir__))).result(binding) -%>
-<% else %>
-<%= ERB.new(File.read(File.expand_path('./partials/cross_platform_caps.tt', __dir__))).result(binding) -%>
+<% if cross_platform? %>android:
+  platformName: Android
+  appium:options:
+    platformVersion: '14'
+    automationName: UiAutomator2
+    deviceName: Pixel 8 API 34
+    app: app-release.apk
+ios:
+  platformName: iOS
+  appium:options:
+    platformVersion: '17.0'
+    deviceName: iPhone 15
+    automationName: XCUITest
+    app: RaiderTestApp.app
+    autoDismissAlerts: true
+
+browserstack:
+  platformName: Android
+  os_version: '9.0'
+  deviceName: Google Pixel 3
+  app: app: <%= ENV['APP_URL'] %>
+  browserstack.user: <%= ENV['BROWSERSTACK_USER'] %>
+  browserstack.key: <%= ENV['BROWSERSTACK_KEY'] %>
+  project: 'RaiderTestApp'
+  name: 'RaiderTestApp-Android'
+<% elsif ios? %>platformName: iOS
+appium:options:
+  url: http://localhost:4723/wd/hub
+  platformVersion: '17.0'
+  deviceName: iPhone 15
+  automationName: XCUITest
+  app: RaiderTestApp.app
+  autoDismissAlerts: true
+
+browserstack:
+  platformName: iOS
+  os_version: '17.5.1'
+  deviceName: iPhone 15
+  app: <%= ENV['APP_URL'] %>
+  browserstack.user: <%= ENV['BROWSERSTACK_USER'] %>
+  browserstack.key: <%= ENV['BROWSERSTACK_KEY'] %>
+  project: 'RaiderTestApp'
+  name: 'RaiderTestApp-IOS'
+<% elsif android? %>platformName: Android
+appium:options:
+  url: http://localhost:4723/wd/hub
+  platformVersion: '14'
+  automationName: UiAutomator2
+  deviceName: Pixel 8 API 34
+  app: app-release.apk
+
+browserstack:
+  platformName: Android
+  os_version: '9.0'
+  deviceName: Google Pixel 3
+  app: app: <%= ENV['APP_URL'] %>
+  browserstack.user: <%= ENV['BROWSERSTACK_USER'] %>
+  browserstack.key: <%= ENV['BROWSERSTACK_KEY'] %>
+  project: 'RaiderTestApp'
+  name: 'RaiderTestApp-Android'
 <% end %>

data/lib/generators/automation/templates/home.tt

@@ -6,15 +6,15 @@ class Home < Page
 
   # Actions
 
-  def go_to_backpack_pdp
-    driver.wait { backpack_image }.click
+  def go_to_product_detail
+    driver.wait { first_product }.click
   end
 
   private
 
   # Elements
 
-  def backpack_image
-    <%= ERB.new(File.read(File.expand_path('./partials/home_page_selector.tt', __dir__)), trim_mode: '-').result(binding) -%>
+  def first_product
+    <%= partial('home_page_selector') -%>
   end
 end

data/lib/generators/automation/templates/login.tt

@@ -1,5 +1,62 @@
+# frozen_string_literal: true
+
+require_relative '../abstract/page'
+
+class Login < Page
+  def url(_page)
+    'index.php?rt=account/login'
+  end
+
+  # Actions
+
+<%- if capybara? -%>
+  def login(username, password)
+    fill_in 'loginFrm_loginname', with: username
+    fill_in 'loginFrm_password', with: password
+    click_button 'Login'
+  end
+<%- elsif selenium_based? -%>
+  def login(username, password)
+    username_field.send_keys username
+    password_field.send_keys password
+    login_button.click
+  end
+  alias log_as login
+<%- else -%>
+  def login(username, password)
+    username_field.set username
+    password_field.set password
+    login_button.click
+  end
+<%- end -%>
+<%- unless capybara? -%>
+
+  private
+
+  # Elements
+
+  def username_field
 <%- if selenium_based? -%>
-<%=- ERB.new(File.read(File.expand_path('./partials/selenium_login.tt', __dir__)), trim_mode: '-').result(binding) -%>
-<%- elsif watir? -%>
-<%=- ERB.new(File.read(File.expand_path('./partials/watir_login.tt', __dir__)), trim_mode: '-').result(binding) -%>
-<%- end -%>
+    driver.find_element(id: 'loginFrm_loginname')
+<%- else -%>
+    browser.text_field(id: 'loginFrm_loginname')
+<%- end -%>
+  end
+
+  def password_field
+<%- if selenium_based? -%>
+    driver.find_element(id: 'loginFrm_password')
+<%- else -%>
+    browser.text_field(id: 'loginFrm_password')
+<%- end -%>
+  end
+
+  def login_button
+<%- if selenium_based? -%>
+    driver.find_element(xpath: "//button[@title='Login']")
+<%- else -%>
+    browser.button(xpath: "//button[@title='Login']")
+<%- end -%>
+  end
+<%- end -%>
+end

data/lib/generators/automation/templates/page.tt

@@ -6,25 +6,31 @@ class Page
 <%- if cross_platform? -%>
   include AppiumHelper
 <%- end -%>
-<%=- ERB.new(File.read(File.expand_path('./partials/initialize_selector.tt', __dir__))).result(binding) -%>
-<%=- ERB.new(File.read(File.expand_path('./partials/visit_method.tt', __dir__))).result(binding) -%>
-<%=- ERB.new(File.read(File.expand_path('./partials/url_methods.tt', __dir__))).result(binding) -%>
+<%=- partial('initialize_selector', trim: false) -%>
+<%=- partial('visit_method', trim: false) -%>
+<%=- partial('url_methods', trim: false) -%>
 
   def to_s
     self.class.to_s.sub('Page', ' Page')
   end
 
-  <%- if selenium_based?  -%>
+  <%- if capybara? -%>
   # Components
 
   def header
-    Header.new(driver.find_element(id: 'customer_menu_top'))
+    Header.new(find('.welcome-msg'))
   end
-  <%- elsif watir?  -%>
+  <%- elsif selenium_based? -%>
   # Components
 
   def header
-    Header.new(browser.element(id: 'customer_menu_top'))
+    Header.new(driver.find_element(css: '.welcome-msg'))
+  end
+  <%- elsif watir? -%>
+  # Components
+
+  def header
+    Header.new(browser.element(css: '.welcome-msg'))
   end
   <%- end -%>
 end

data/lib/generators/automation/templates/partials/element.tt

@@ -1,4 +1,4 @@
-<% if %w[selenium axe applitools appium_ios appium_android].include?(automation) -%>
+<% if %w[selenium appium_ios appium_android].include?(automation) -%>
   driver.find_element
 <% else -%>
   browser.element

data/lib/generators/automation/templates/partials/home_page_selector.tt

@@ -1,8 +1,8 @@
 <%- if ios? -%>
-driver.find_element(predicate: 'label == "Sauce Labs Backpack"')
+driver.find_element(accessibility_id: 'product-item-1')
 <%- elsif android? -%>
-driver.find_element(xpath: '(//android.view.ViewGroup[@content-desc="store item"])[1]/android.view.ViewGroup[1]')
+driver.find_element(accessibility_id: 'product-item-1')
 <%- else -%>
-element(ios: { predicate: 'label == "Sauce Labs Backpack"' },
-            android: { xpath: '(//android.view.ViewGroup[@content-desc="store item"])[1]/android.view.ViewGroup[1]' })
+element(ios: { accessibility_id: 'product-item-1' },
+            android: { accessibility_id: 'product-item-1' })
 <%- end -%>

data/lib/generators/automation/templates/partials/initialize_selector.tt

@@ -1,16 +1,11 @@
-<% if watir? %>
+<% if capybara? %>
+  include Capybara::DSL
+<% elsif watir? %>
   attr_reader :browser
 
   def initialize(browser)
     @browser = browser
   end
-<% elsif axe? %>
-  attr_reader :driver
-  alias page driver
-
-  def initialize(driver)
-    @driver = driver
-  end
 <% else %>
   attr_reader :driver
 

data/lib/generators/automation/templates/partials/pdp_page_selector.tt

@@ -1,8 +1,8 @@
 <%- if ios? -%>
-driver.find_element(accessibility_id: 'Add To Cart button')
+driver.find_element(accessibility_id: 'add-to-cart-button')
 <%- elsif android? -%>
-driver.find_element(xpath: '//android.view.ViewGroup[@content-desc="Add To Cart button"]/android.widget.TextView')
+driver.find_element(accessibility_id: 'add-to-cart-button')
 <%- else -%>
-element(ios: { accessibility_id: 'Add To Cart button' },
-            android: { xpath: '//android.view.ViewGroup[@content-desc="Add To Cart button"]/android.widget.TextView' })
+element(ios: { accessibility_id: 'add-to-cart-button' },
+            android: { accessibility_id: 'add-to-cart-button' })
 <%- end -%>

data/lib/generators/automation/templates/partials/url_methods.tt

@@ -3,7 +3,6 @@
     "#{base_url}#{url(*page)}"
   end
 
-  # :reek:UtilityFunction
   def base_url
     YAML.load_file('config/config.yml')['url']
   end

data/lib/generators/automation/templates/partials/visit_method.tt

@@ -1,5 +1,15 @@
 <% if web? %>
+<% if capybara? %>
+  def visit_page(*page)
+    Capybara.visit full_url(page.first)
+  end
+<% elsif selenium_based? %>
+  def visit(*page)
+    @driver.navigate.to full_url(page.first)
+  end
+<% else %>
   def visit(*page)
-    <% if selenium_based? %>@driver.navigate.to full_url(page.first) <% else %>@browser.goto full_url(page.first)<% end %>
+    @browser.goto full_url(page.first)
   end
+<% end %>
 <% end %>

data/lib/generators/automation/templates/pdp.tt

@@ -13,6 +13,6 @@ class Pdp < Page
   # Elements
 
   def add_to_cart_button
-    <%= ERB.new(File.read(File.expand_path('./partials/pdp_page_selector.tt', __dir__)), trim_mode: '-').result(binding) -%>
+    <%= partial('pdp_page_selector') -%>
   end
 end

data/lib/generators/common_generator.rb

@@ -17,6 +17,10 @@ class CommonGenerator < Generator
     template('common/rakefile.tt', "#{name}/Rakefile")
   end
 
+  def generate_ruby_version_file
+    template('common/ruby_version.tt', "#{name}/.ruby-version")
+  end
+
   def generate_gemfile
     template('common/gemfile.tt', "#{name}/Gemfile")
   end
@@ -33,7 +37,15 @@ class CommonGenerator < Generator
     template('common/git_ignore.tt', "#{name}/.gitignore")
   end
 
+  def generate_rspec_file
+    return unless rspec?
+
+    template('common/rspec.tt', "#{name}/.rspec")
+  end
+
   def create_allure_folder
+    return unless allure_reporter?
+
     empty_directory "#{name}/allure-results"
   end
 end

data/lib/generators/cucumber/cucumber_generator.rb

@@ -27,6 +27,42 @@ class CucumberGenerator < Generator
     template('cucumber.tt', "#{name}/cucumber.yml")
   end
 
+  def generate_visual_feature
+    return unless visual_addon? && web?
+
+    template('visual_feature.tt', "#{name}/features/visual.feature")
+  end
+
+  def generate_visual_steps
+    return unless visual_addon? && web?
+
+    template('visual_steps.tt', "#{name}/features/step_definitions/visual_steps.rb")
+  end
+
+  def generate_accessibility_feature
+    return unless axe_addon? && web?
+
+    template('accessibility_feature.tt', "#{name}/features/accessibility.feature")
+  end
+
+  def generate_accessibility_steps
+    return unless axe_addon? && web?
+
+    template('accessibility_steps.tt', "#{name}/features/step_definitions/accessibility_steps.rb")
+  end
+
+  def generate_performance_feature
+    return unless lighthouse_addon? && web?
+
+    template('performance_feature.tt', "#{name}/features/performance.feature")
+  end
+
+  def generate_performance_steps
+    return unless lighthouse_addon? && web?
+
+    template('performance_steps.tt', "#{name}/features/step_definitions/performance_steps.rb")
+  end
+
   def template_name
     @template_name ||= (@_initializer.first & %w[android ios cross_platform]).empty? ? 'login' : 'home'
   end

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

@@ -0,0 +1,5 @@
+Feature: Accessibility
+
+Scenario: Page has no accessibility violations
+    Given I am on the home page
+    Then the page should be accessible

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/env.tt

@@ -1,7 +1,9 @@
-<%- if selenium_based? -%>
-  <%= ERB.new(File.read(File.expand_path('./partials/selenium_env.tt', __dir__)), trim_mode: '-').result(binding) -%>
+<%- if capybara? -%>
+  <%= partial('capybara_env') -%>
+<%- elsif selenium_based? -%>
+  <%= partial('selenium_env') -%>
 <%- elsif mobile? -%>
-  <%= ERB.new(File.read(File.expand_path('./partials/appium_env.tt', __dir__)), trim_mode: '-').result(binding) -%>
+  <%= partial('appium_env') -%>
 <%- else -%>
-  <%= ERB.new(File.read(File.expand_path('./partials/watir_env.tt', __dir__)), trim_mode: '-').result(binding) -%>
+  <%= partial('watir_env') -%>
 <%- 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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+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
+  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)
+  end
+  Capybara.reset_sessions!
+end

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

@@ -0,0 +1,6 @@
+require 'capybara/dsl'
+require_relative '../../helpers/capybara_helper'
+require_relative '../../models/user_factory'
+
+CapybaraHelper.configure
+World(Capybara::DSL)

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/mobile_steps.tt

@@ -11,10 +11,10 @@ Given("I'm an anonymous user on the home page") do
 end
 
 When('I select one of the products') do
-  @home_page.go_to_backpack_pdp
+  @home_page.go_to_product_detail
 end
 
 Then("I'm redirected to the product details page") do
   pdp_page = Pdp.new(driver)
-  expect(pdp_page.add_to_cart_text).to eq 'Add To Cart'
+  expect(pdp_page.add_to_cart_text).to eq 'Add to Cart'
 end

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)