ruby_raider 0.9.3 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02747aaf5daa92a26aec43eefd65d6e3a9d84b3b83a0c0b678174f7f93d3725a
-  data.tar.gz: 3b754cbe2bb76ade7f7c37f5d7cee232c08432a9b4a3bf148fc9ec046a379a39
+  metadata.gz: 279c26bb0d8d1a27d95b0510587e6828e2164c84a334c41b84b57db98f04867c
+  data.tar.gz: c024426fe0bbb58b912ac6bf07a0867110dc340c4946d4e3eab499e25a38b2ce
 SHA512:
-  metadata.gz: 3831dcce4173d9612da9a8710401c0f532b61f5811c4ef4f3fa3215329fcdb5768a256e61c6de33bb666ffba3745b078119dcef7feeea6173e94f396a9280c4c
-  data.tar.gz: 0e56906c04bdbea1f0925e7bb91ba4d799ec91fa47550cec9ba540960c1d4512c5c2f57f25e3ddda9fc79bbd5c3273187ad27c41e8dde3a541ee1cda6fd43f37
+  metadata.gz: '028fcaca7bd181054203e2d50d54fa2399608725379ffd63e003f2efd43f9b6274fa9a014e7ffb0da28eff2f077b48fb4d4d6ae5c53f3db9f14f1958f4e451e4'
+  data.tar.gz: 9ef33293321c2f08b1942c2c82d2bc0be57f9245335be00bcefe4d145a5c7abb842e5274ba313e21dec17e756cbf6fc4f9fa7f4d74887e630791a4ae0adbde91

data/.github/workflows/integration.yml

@@ -8,13 +8,13 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
       - name: Set up Ruby
-        uses: ruby/setup-ruby@f20f1eae726df008313d2e0d78c5e602562a1bcf
+        uses: ruby/setup-ruby@v1
         with:
-          ruby-version: head
-
-      - name: Checkout repository
-        uses: actions/checkout@v3
+          ruby-version: 3.1.0
 
       - name: Install gems
         run: bundle install

data/.github/workflows/selenium.yml

@@ -0,0 +1,22 @@
+name: Selenium Tests on Ubuntu
+on: [ pull_request ]
+
+jobs:
+  build:
+    name: Selenium based frameworks pipeline
+    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.1.0
+
+      - name: Install gems
+        run: bundle install
+
+      - name: Build and run system tests
+        run: rspec spec/system/selenium_spec.rb

data/.github/workflows/watir.yml

@@ -0,0 +1,22 @@
+name: Watir Tests on Ubuntu
+on: [ pull_request ]
+
+jobs:
+  build:
+    name: Watir based frameworks pipeline
+    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.1.0
+
+      - name: Install gems
+        run: bundle install
+
+      - name: Build and run system tests
+        run: rspec spec/system/watir_spec.rb

data/README.md

@@ -33,21 +33,25 @@
 Ruby Raider is a generator and scaffolding gem to make UI test automation easier
 
 ### At the moment Ruby Raider supports generating the following frameworks:
-| Web Testing Framework      | Visual Testing Framework                    | Mobile Testing Framework                  |
-|----------------------------|---------------------------------------------|-------------------------------------------|
-| Cucumber and Selenium      | Cucumber, Applitools and Selenium           | Cucumber and Appium for IOS               |
-| Rspec and Selenium         | Rspec, Applitools and Selenium              | Rspec and Appium for IOS                  |
-| Cucumber and Watir         |                                             | Cucumber and Appium for Android           |
-| Rspec and Watir            |                                             | Rspec and Appium for Android              |
-|                            |                                             | Cucumber and Appium Cross-platform        |
-|                            |                                             | Rspec and Appium Cross-platform           |
+
+| Web Testing Framework | Visual Testing Framework          | Mobile Testing Framework           | Accessibility Testing Framework |
+|-----------------------|-----------------------------------|------------------------------------|---------------------------------|
+| Cucumber and Selenium | Cucumber, Applitools and Selenium | Cucumber and Appium for IOS        | Cucumber and Axe for web        |
+| Rspec and Selenium    | Rspec, Applitools and Selenium    | Rspec and Appium for IOS           | Rspec and Axe for web           |
+| Cucumber and Watir    |                                   | Cucumber and Appium for Android    |                                 |
+| Rspec and Watir       |                                   | Rspec and Appium for Android       |                                 |
+|                       |                                   | Cucumber and Appium Cross-platform |                                 |
+|                       |                                   | Rspec and Appium Cross-platform    |                                 |
 
 ***In order to run the Appium tests, download the example [app](https://github.com/saucelabs/my-demo-app-rn).***
-***Remember to use the full path of the app that you download in the capabilities file and start the server using one of the commands below:***
+***Remember to use the full path of the app that you download in the capabilities file and start the server using one of
+the commands below:***
+
 ```ruby
 raider u start_appium
-appium  --base-path /wd/hub  
+appium --base - path /wd/ hub  
 ```
+
 ***In order to run the visual tests with applitools, you need to create an account and get your api key, you can read
 more [here](https://applitools.com/docs/topics/overview/obtain-api-key.html#:~:text=If%20you%20already%20have%20an,Your%20key%20will%20be%20displayed.)
 .***
@@ -81,13 +85,13 @@ Select the ones you will like to work with.
 If you already know which frameworks you want to use, you can do:
 
 ```ruby
-raider new [name_of_project] -p framework:[framework] automation:[automation_type] visual:[boolean] axe:[boolean]
+raider new [name_of_project] - p framework : [framework] automation : [automation_type] visual : [boolean] axe : [boolean]
 ```
 
 An example of the command above would be:
 
 ```ruby
-raider new test_project -p framework:rspec automation:selenium visual:false axe:true
+raider new test_project -p framework : rspec automation: selenium visual : false axe : true
 ```
 
 Where [frameworks] is a comma separated list of the frameworks you want to use.
@@ -97,12 +101,12 @@ Where [frameworks] is a comma separated list of the frameworks you want to use.
 ###### Anything between square brackets([...]) is where your imput goes
 
 ```ruby
-Commands:
+Commands :
   raider generate # Provides access to all the scaffolding commands
-  raider help [COMMAND] # Describe available commands or one specific command
-  raider new [PROJECT_NAME] # Creates a new framework based on settings picked
-  raider utility # Provides access to all the utility commands 
-  raider version # It shows the version of Ruby Raider you are currently using
+raider help [COMMAND] # Describe available commands or one specific command
+raider new [PROJECT_NAME] # Creates a new framework based on settings picked
+raider utility # Provides access to all the utility commands 
+raider version # It shows the version of Ruby Raider you are currently using
 ```
 
 All the basic commands have their corresponding shortcut:
@@ -113,6 +117,7 @@ All the basic commands have their corresponding shortcut:
 * v for version
 
 ### Scaffolding Commands
+
 Ruby Raider also supports scaffolding:
 
 * To create a new page object you do: ```raider g page [PAGE_NAME]```
@@ -134,9 +139,10 @@ raider u path [PATH_NAME] - -helper or -h
 
 If you don't specify an option, path will assume you want to change the default path for pages.
 
-
 ### Appium Server Command
+
 To initialise Appium server run this command:
+
 ```ruby
 raider u start_appium
 ```

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

@@ -1,5 +1,5 @@
-<%- if automation == 'selenium' -%>
+<%- if selenium_based? -%>
 <%=- ERB.new(File.read(File.expand_path('./partials/selenium_account.tt', __dir__)), trim_mode: '-').result(binding) -%>
-<%- elsif automation == 'watir' -%>
+<%- elsif watir? -%>
 <%=- ERB.new(File.read(File.expand_path('./partials/watir_account.tt', __dir__)), trim_mode: '-').result(binding) -%>
 <%- end -%>

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

@@ -1,6 +1,6 @@
-<% if automation.include?('ios') %>
+<% if ios? %>
 <%= ERB.new(File.read(File.expand_path('./partials/ios_caps.tt', __dir__))).result(binding) -%>
-<% elsif automation == 'android' %>
+<% 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) -%>

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../abstract/page'
+
 class Home < Page
 
   # Actions
@@ -14,6 +15,6 @@ class Home < Page
   # Elements
 
   def backpack_image
-    <%= ERB.new(File.read(File.expand_path('./partials/home_page_selector.tt', __dir__)), trim_mode: '-').result(binding) %>
+    <%= ERB.new(File.read(File.expand_path('./partials/home_page_selector.tt', __dir__)), trim_mode: '-').result(binding) -%>
   end
-end
+end

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

@@ -1,5 +1,5 @@
-<%- if automation == 'selenium' -%>
+<%- if selenium_based? -%>
 <%=- ERB.new(File.read(File.expand_path('./partials/selenium_login.tt', __dir__)), trim_mode: '-').result(binding) -%>
-<%- elsif automation == 'watir' -%>
+<%- elsif watir? -%>
 <%=- ERB.new(File.read(File.expand_path('./partials/watir_login.tt', __dir__)), trim_mode: '-').result(binding) -%>
 <%- end -%>

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

@@ -3,7 +3,7 @@ require_relative '../components/header'
 <%- end -%>
 
 class Page
-<%- if automation == 'cross_platform' -%>
+<%- if cross_platform? -%>
   include AppiumHelper
 <%- end -%>
 <%=- ERB.new(File.read(File.expand_path('./partials/initialize_selector.tt', __dir__))).result(binding) -%>
@@ -14,17 +14,17 @@ class Page
     self.class.to_s.sub('Page', ' Page')
   end
 
-  <%- if automation == 'selenium'  -%>
+  <%- if selenium_based?  -%>
   # Components
 
   def header
     Header.new(driver.find_element(id: 'customer_menu_top'))
   end
-  <%- elsif automation == 'watir'  -%>
+  <%- elsif watir?  -%>
   # Components
 
   def header
     Header.new(browser.element(id: 'customer_menu_top'))
   end
   <%- end -%>
-end
+end

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

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

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

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

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

@@ -1,4 +1,4 @@
-<% if automation == 'watir' %>
+<% if watir? %>
   attr_reader :browser
 
   def initialize(browser)

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

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

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

@@ -31,4 +31,4 @@ class Login < Page
   def login_button
     driver.find_element(xpath: "//button[@title='Login']")
   end
-end
+end

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

@@ -1,4 +1,4 @@
-<% if %w[selenium watir].include?(automation) %>
+<% if web? %>
   def full_url(*page)
     "#{base_url}#{url(*page)}"
   end

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

@@ -1,5 +1,5 @@
-<% if %w[selenium watir].include? automation %>
+<% if web? %>
   def visit(*page)
-    <% if automation == 'selenium' %>@driver.navigate.to full_url(page.first) <% else %>@browser.goto full_url(page.first)<% end %>
+    <% if selenium_based? %>@driver.navigate.to full_url(page.first) <% else %>@browser.goto full_url(page.first)<% end %>
   end
 <% end %>

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

@@ -1,4 +1,5 @@
 require_relative '../abstract/page'
+
 class Pdp < Page
 
   # Actions
@@ -12,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) %>
+    <%= ERB.new(File.read(File.expand_path('./partials/pdp_page_selector.tt', __dir__)), trim_mode: '-').result(binding) -%>
   end
-end
+end

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

@@ -1,8 +1,7 @@
-<%- case automation
- when 'selenium' -%>
-<%=- ERB.new(File.read(File.expand_path('./partials/selenium_env.tt', __dir__)), trim_mode: '-').result(binding) -%>
-<%- when 'watir' -%>
-<%=- ERB.new(File.read(File.expand_path('./partials/watir_env.tt', __dir__)), trim_mode: '-').result(binding) -%>
+<%- if selenium_based? -%>
+  <%= ERB.new(File.read(File.expand_path('./partials/selenium_env.tt', __dir__)), trim_mode: '-').result(binding) -%>
+<%- elsif mobile? -%>
+  <%= ERB.new(File.read(File.expand_path('./partials/appium_env.tt', __dir__)), trim_mode: '-').result(binding) -%>
 <%- else -%>
-<%=- ERB.new(File.read(File.expand_path('./partials/appium_env.tt', __dir__)), trim_mode: '-').result(binding) -%>
-<%- end -%>
+  <%= ERB.new(File.read(File.expand_path('./partials/watir_env.tt', __dir__)), trim_mode: '-').result(binding) -%>
+<%- end -%>

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

@@ -1,16 +1,20 @@
-<% if %w[selenium watir].include? automation -%>
+<%- if web? -%>
 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 -%>
+<%- else -%>
 Feature: Home Page
 
 Scenario: A user can go to the product details page
     Given I'm an anonymous user on the home page
     When I select one of the products
     Then I'm redirected to the product details page
-<% end %>
+<%- end %>

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

@@ -1,8 +1,5 @@
 require 'tmpdir'
 require_relative '../../helpers/allure_helper'
-require_relative '../../helpers/driver_helper'
-
-include DriverHelper
 
 Before do
   AllureHelper.configure
@@ -15,4 +12,4 @@ After do |scenario|
     AllureHelper.add_screenshot(scenario.name, screenshot)
   end
   driver.quit_driver
-end
+end

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

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

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

@@ -1,20 +1,20 @@
 # frozen_string_literal: true
 
-<% if automation == 'cross_platform' -%>
+<%- if cross_platform? -%>
 require_relative '../../helpers/appium_helper'
 <%- end -%>
 require_relative '../../page_objects/pages/home'
 require_relative '../../page_objects/pages/pdp'
 
 Given("I'm an anonymous user on the home page") do
-    @home_page = Home.new(driver)
+  @home_page = Home.new(driver)
 end
 
 When('I select one of the products') do
-    @home_page.go_to_backpack_pdp
+  @home_page.go_to_backpack_pdp
 end
 
-When("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'
-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'
+end

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

@@ -1,5 +1,5 @@
-<%- if visual_automation -%>
 # frozen_string_literal: true
+<%- if visual? -%>
 
 require 'tmpdir'
 require_relative '../../helpers/allure_helper'
@@ -30,14 +30,14 @@ After do |scenario|
 end
 
 <%- else -%>
-# frozen_string_literal: true
 
+<%- if axe? && cucumber? -%>
+require 'axe-rspec'
+<%- end -%>
+require 'rspec'
 require 'tmpdir'
-require_relative '../../helpers/driver_helper'
 require_relative '../../helpers/allure_helper'
 
-include DriverHelper
-
 Before do
   driver.manage.window.maximize
 end
@@ -49,4 +49,4 @@ After do |scenario|
   end
   driver.quit
 end
-<%- end -%>
+<%- end -%>

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

@@ -2,9 +2,6 @@
 
 require 'tmpdir'
 require_relative '../../helpers/allure_helper'
-require_relative '../../helpers/browser_helper'
-
-include BrowserHelper
 
 Before do
   browser.window.maximize
@@ -16,4 +13,4 @@ After do |scenario|
     AllureHelper.add_screenshot(scenario.name, screenshot)
   end
   browser.quit
-end
+end

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

@@ -5,7 +5,7 @@ require_relative '../../page_objects/pages/login'
 
 Given("I'm a {user} on the login page") do |user|
   @user = user
-  @login_page = Login.new(<% if automation == 'watir' %>browser<% else %>driver<% end %>)
+  @login_page = Login.new(<% if watir? %>browser<% else %>driver<% end %>)
   @login_page.visit
 end
 
@@ -13,11 +13,18 @@ When('I login with my credentials') do
   @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 automation == 'watir' %>browser<% else %>driver<% end %>)
-  <%- if visual_automation == true -%>
+  account_page = Account.new(<% if watir? %>browser<% else %>driver<% end %>)
+  <%- if visual? -%>
   check_page account_page
   <%- else -%>
   expect(account_page.header.customer_name).to eq "Welcome back #{@user['name']}"
   <%- end -%>
 end
+<%- end -%>

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

@@ -1,5 +1,5 @@
-<% if %w[selenium watir].include? automation -%>
+<%- if web? -%>
 <%= ERB.new(File.read(File.expand_path('./partials/web_steps.tt', __dir__)), trim_mode: '-').result(binding).strip! -%>
-<% else -%>
+<%- else -%>
 <%= ERB.new(File.read(File.expand_path('./partials/mobile_steps.tt', __dir__)), trim_mode: '-').result(binding).strip! -%>
-<% end -%>
+<%- end -%>

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

@@ -1,4 +1,4 @@
-<%- if automation == 'watir' -%>
+<%- if watir? -%>
 <%=- ERB.new(File.read(File.expand_path('./partials/watir_world.tt', __dir__)), trim_mode: '-').result(binding).strip! -%>
 <%- else -%>
 <%=- ERB.new(File.read(File.expand_path('./partials/driver_world.tt', __dir__)), trim_mode: '-').result(binding).strip! -%>

data/lib/generators/generator.rb

@@ -8,8 +8,6 @@ class Generator < Thor::Group
   argument :automation
   argument :framework
   argument :name
-  argument :visual_automation, optional: true
-  argument :axe_support, optional: true
 
   def self.source_paths
     base_path = File.dirname(__FILE__)
@@ -38,6 +36,14 @@ class Generator < Thor::Group
     (args & %w[android ios]).count.positive?
   end
 
+  def ios?
+    args.include?('ios')
+  end
+
+  def android?
+    args.include?('android')
+  end
+
   def rspec?
     args.include?('rspec')
   end
@@ -47,7 +53,7 @@ class Generator < Thor::Group
   end
 
   def visual?
-    args[3]
+    args.include?('applitools')
   end
 
   def watir?
@@ -55,11 +61,15 @@ class Generator < Thor::Group
   end
 
   def web?
-    (args & (%w[selenium watir])).count.positive?
+    (args & (%w[selenium watir axe applitools])).count.positive?
   end
 
   def axe?
-    args.last
+    args.include?('axe')
+  end
+
+  def selenium_based?
+    (args & %w[selenium axe applitools]).count.positive?
   end
 
   private

data/lib/generators/helper_generator.rb

@@ -24,7 +24,7 @@ class HelpersGenerator < Generator
   end
 
   def generate_browser_helper
-    return if selenium? || mobile?
+    return if selenium_based? || mobile?
 
     template('helpers/browser_helper.tt', "#{name}/helpers/browser_helper.rb")
   end

data/lib/generators/invoke_generators.rb

@@ -19,9 +19,7 @@ module InvokeGenerators
                          automation: structure[:automation],
                          framework:,
                          generator:,
-                         name: structure[:name],
-                         visual: to_bool(structure[:visual]),
-                         axe_support: to_bool(structure[:axe_support])
+                         name: structure[:name]
                        })
     end
   end
@@ -34,9 +32,7 @@ module InvokeGenerators
     Object.const_get("#{structure[:generator]}Generator")
           .new([structure[:automation],
                 structure[:framework],
-                structure[:name],
-                structure[:visual],
-                structure[:axe_support]]).invoke_all
+                structure[:name]]).invoke_all
   end
 
   def to_bool(string)