ruby_raider 1.1.4 → 2.0.0

data/lib/commands/adopt_commands.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'thor'
+require_relative '../adopter/adopt_menu'
+
+# :reek:FeatureEnvy { enabled: false }
+class AdoptCommands < Thor
+  desc 'project [SOURCE_PATH]', 'Adopts an existing test project into Ruby Raider conventions'
+  option :parameters,
+         type: :hash, required: false,
+         desc: 'Parameters to bypass the menu (output_path, target_automation, target_framework, ci_platform)',
+         aliases: 'p'
+
+  def project(source_path)
+    params = options[:parameters]
+    if params
+      parsed = params.transform_keys(&:to_sym)
+      parsed[:source_path] = source_path
+      result = Adopter::AdoptMenu.adopt(parsed)
+      print_programmatic_results(result)
+    else
+      Adopter::AdoptMenu.new.run
+    end
+  rescue Adopter::MobileProjectError => e
+    puts "Error: #{e.message}"
+    exit 1
+  rescue ArgumentError => e
+    puts "Invalid parameters: #{e.message}"
+    exit 1
+  end
+
+  private
+
+  def print_programmatic_results(result)
+    plan = result[:plan]
+    results = result[:results]
+    puts "Adoption complete: #{results[:pages]} pages, #{results[:tests]} tests, " \
+         "#{results[:features]} features, #{results[:steps]} steps"
+    puts "Warnings: #{plan.warnings.join('; ')}" unless plan.warnings.empty?
+    puts "Errors: #{results[:errors].join('; ')}" unless results[:errors].empty?
+    puts "Output: #{plan.output_path}"
+  end
+end

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

@@ -1,5 +1,9 @@
-<%- if selenium_based? -%>
-<%=- ERB.new(File.read(File.expand_path('./partials/selenium_account.tt', __dir__)), trim_mode: '-').result(binding) -%>
-<%- elsif watir? -%>
-<%=- ERB.new(File.read(File.expand_path('./partials/watir_account.tt', __dir__)), trim_mode: '-').result(binding) -%>
-<%- end -%>
+# frozen_string_literal: true
+
+require_relative '../abstract/page'
+
+class Account < Page
+  def url(_page)
+    'index.php?rt=account/account'
+  end
+end

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/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,4 +1,6 @@
-<% if watir? %>
+<% if capybara? %>
+  include Capybara::DSL
+<% elsif watir? %>
   attr_reader :browser
 
   def initialize(browser)

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/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/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/partials/capybara_env.tt

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'rspec'
+require 'tmpdir'
+require_relative '../../helpers/allure_helper'
+require_relative '../../helpers/capybara_helper'
+
+CapybaraHelper.configure
+
+Before do
+  Capybara.current_session.driver.browser.manage.window.maximize
+end
+
+After do |scenario|
+  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/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/web_steps.tt

@@ -5,8 +5,8 @@ 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
@@ -20,10 +20,11 @@ Then('the page should be axe clean') do
 end
 <%- else -%>
 Then("I'm logged in") do
-  account_page = Account.new(<% if watir? %>browser<% else %>driver<% end %>)
+  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

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/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,12 @@
 # frozen_string_literal: true
 
 require 'thor'
+require_relative 'template_renderer'
 
+# :reek:TooManyMethods { enabled: false }
 class Generator < Thor::Group
   include Thor::Actions
+  include TemplateRenderer
 
   argument :automation
   argument :framework
@@ -12,7 +15,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,10 +52,18 @@ class Generator < Thor::Group
     args.include?('rspec')
   end
 
+  def minitest?
+    args.include?('minitest')
+  end
+
   def selenium?
     args.include?('selenium')
   end
 
+  def capybara?
+    args.include?('capybara')
+  end
+
   def visual?
     args.include?('applitools')
   end
@@ -61,7 +73,7 @@ class Generator < Thor::Group
   end
 
   def web?
-    (args & (%w[selenium watir axe applitools])).count.positive?
+    (args & %w[selenium watir axe applitools capybara]).count.positive?
   end
 
   def axe?

data/lib/generators/helper_generator.rb

@@ -6,12 +6,15 @@ class HelpersGenerator < Generator
   def generate_helpers
     generate_browser_helper
     generate_driver_helper
+    generate_capybara_helper
     generate_appium_helper
     generate_allure_helper
 
     if visual?
       generate_visual_helper
       generate_visual_spec_helper
+    elsif minitest?
+      generate_test_helper
     else
       generate_spec_helper
     end
@@ -24,29 +27,39 @@ class HelpersGenerator < Generator
   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_visual_helper
     template('helpers/visual_helper.tt', "#{name}/helpers/visual_helper.rb")
   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
           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