testcentricity_web 4.1.5 → 4.1.8

data/docker-compose-v3.yml

@@ -0,0 +1,48 @@
+# To execute this docker-compose yml file use `docker-compose -f docker-compose-v3.yml up`
+# Add the `-d` flag at the end for detached execution
+# To stop the execution, hit Ctrl+C, and then `docker-compose -f docker-compose-v3.yml down`
+version: "3"
+services:
+  chrome:
+    image: selenium/node-chrome:4.1.2-20220217
+    shm_size: 2gb
+    depends_on:
+      - selenium-hub
+    environment:
+      - SE_EVENT_BUS_HOST=selenium-hub
+      - SE_EVENT_BUS_PUBLISH_PORT=4442
+      - SE_EVENT_BUS_SUBSCRIBE_PORT=4443
+      - SE_NODE_MAX_SESSIONS=4
+      - SE_NODE_OVERRIDE_MAX_SESSIONS=true
+
+  edge:
+    image: selenium/node-edge:4.1.2-20220217
+    shm_size: 2gb
+    depends_on:
+      - selenium-hub
+    environment:
+      - SE_EVENT_BUS_HOST=selenium-hub
+      - SE_EVENT_BUS_PUBLISH_PORT=4442
+      - SE_EVENT_BUS_SUBSCRIBE_PORT=4443
+      - SE_NODE_MAX_SESSIONS=4
+      - SE_NODE_OVERRIDE_MAX_SESSIONS=true
+
+  firefox:
+    image: selenium/node-firefox:4.1.2-20220217
+    shm_size: 2gb
+    depends_on:
+      - selenium-hub
+    environment:
+      - SE_EVENT_BUS_HOST=selenium-hub
+      - SE_EVENT_BUS_PUBLISH_PORT=4442
+      - SE_EVENT_BUS_SUBSCRIBE_PORT=4443
+      - SE_NODE_MAX_SESSIONS=4
+      - SE_NODE_OVERRIDE_MAX_SESSIONS=true
+
+  selenium-hub:
+    image: selenium/hub:4.1.2-20220217
+    container_name: selenium-hub
+    ports:
+      - "4442:4442"
+      - "4443:4443"
+      - "4444:4444"

data/features/basic_form_page_css.feature

@@ -0,0 +1,39 @@
+Feature: Basic HTML Form Test Page using CSS locators
+  In order to ensure comprehensive support for HTML UI elements and forms
+  As a developer of the TestCentricity web gem
+  I expect to validate the interaction and verification capabilities of typical HTML form UI elements
+
+
+  Background:
+    Given I am on the Basic CSS Form page
+
+
+  Scenario: Validate verify_ui_states method and associated object state verification methods
+    Then I expect the Basic CSS Form page to be correctly displayed
+
+
+@!mobile @!firefox_headless
+  Scenario: Validate verify_focus_order method
+    Then I expect the tab order to be correct
+
+
+  Scenario: Validate populate_data_fields method and associated object action methods
+    When I populate the form fields
+    Then I expect the form fields to be correctly populated
+    When I cancel my changes
+    Then I expect the Basic CSS Form page to be correctly displayed
+
+
+  Scenario Outline:  Verify functionality of navigation tabs and browser back/forward
+    When I click the <target_page> navigation tab
+    Then I expect the <target_page> page to be correctly displayed
+    When I navigate back
+    Then I should be on the Basic CSS Form page
+    When I navigate forward
+    Then I should be on the <target_page> page
+
+    Examples:
+      |target_page      |
+      |Media Test       |
+      |Indexed Sections |
+      |Custom Controls  |

data/features/basic_form_page_xpath.feature

@@ -0,0 +1,26 @@
+@!grid @!mobile @!headless
+
+
+Feature: Basic HTML Form Test Page using Xpath locators
+  In order to ensure comprehensive support for HTML UI elements and forms
+  As a developer of the TestCentricity web gem
+  I expect to validate the interaction and verification capabilities of typical HTML form UI elements
+
+
+  Background:
+    Given I am on the Basic Xpath Form page
+
+
+  Scenario: Validate verify_ui_states method and associated object state verification methods
+    Then I expect the Basic Xpath Form page to be correctly displayed
+
+
+  Scenario: Validate verify_focus_order method
+    Then I expect the tab order to be correct
+
+
+  Scenario: Validate populate_data_fields method and associated object action methods
+    When I populate the form fields
+    Then I expect the form fields to be correctly populated
+    When I cancel my changes
+    Then I expect the Basic Xpath Form page to be correctly displayed

data/features/media_players.feature

@@ -0,0 +1,84 @@
+Feature: HTML5 Audio/Video Test Page using CSS locators
+  In order to ensure comprehensive support for HTML5 Audio and Video media elements
+  As a developer of the TestCentricity web gem
+  I expect to validate the interaction and verification capabilities of media UI elements
+
+
+  Background:
+    Given I am on the Media Test page
+
+
+  Scenario:  Verify video player play and pause controls
+    When I play the video media
+    Then the video should be playing
+    When I pause the video media
+    Then the video should be paused
+
+
+  Scenario:  Verify audio player play and pause controls
+    When I play the audio media
+    Then the audio should be playing
+    When I pause the audio media
+    Then the audio should be paused
+
+
+  Scenario:  Verify video player mute control
+    When I mute the video media
+    Then the video should be muted
+    When I unmute the video media
+    Then the video should be unmuted
+
+
+  Scenario:  Verify audio player mute control
+    When I mute the audio media
+    Then the audio should be muted
+    When I unmute the audio media
+    Then the audio should be unmuted
+
+
+  Scenario:  Verify video player volume control
+    When I set the volume of the video to .5
+    Then the video should have a volume of .5
+
+
+  Scenario:  Verify audio player volume control
+    When I set the volume of the audio to .5
+    Then the audio should have a volume of .5
+
+
+  Scenario:  Verify video playback speed settings
+    When I play the video with a playback speed of 2x
+    Then the video should play at 2x speed
+    When I play the video with a playback speed of 0.25x
+    Then the video should play at 0.25x speed
+    When I play the video with a playback speed of 1.75x
+    Then the video should play at 1.75x speed
+    When I play the video with a playback speed of 0.5x
+    Then the video should play at 0.5x speed
+    When I play the video with a playback speed of 1.5x
+    Then the video should play at 1.5x speed
+    When I play the video with a playback speed of 0.75x
+    Then the video should play at 0.75x speed
+    When I play the video with a playback speed of 1.25x
+    Then the video should play at 1.25x speed
+    When I play the video with a playback speed of 1x
+    Then the video should play at 1x speed
+
+
+  Scenario:  Verify audio playback speed settings
+    When I play the audio with a playback speed of 2x
+    Then the audio should play at 2x speed
+    When I play the audio with a playback speed of 0.25x
+    Then the audio should play at 0.25x speed
+    When I play the audio with a playback speed of 1.75x
+    Then the audio should play at 1.75x speed
+    When I play the audio with a playback speed of 0.5x
+    Then the audio should play at 0.5x speed
+    When I play the audio with a playback speed of 1.5x
+    Then the audio should play at 1.5x speed
+    When I play the audio with a playback speed of 0.75x
+    Then the audio should play at 0.75x speed
+    When I play the audio with a playback speed of 1.25x
+    Then the audio should play at 1.25x speed
+    When I play the audio with a playback speed of 1x
+    Then the audio should play at 1x speed

data/features/step_definitions/generic_steps.rb.rb

@@ -0,0 +1,109 @@
+include TestCentricity
+
+
+Given(/^I am (?:on|viewing) the (.*) page$/) do |page_name|
+  # find and load the specified target page
+  target_page = PageManager.find_page(page_name)
+  target_page.load_page
+end
+
+
+Then(/^I expect the (.*) page to be correctly displayed$/) do |page_name|
+  # find and verify that the specified target page is loaded
+  target_page = PageManager.find_page(page_name)
+  target_page.verify_page_exists
+  # verify that target page is correctly displayed
+  target_page.verify_page_ui
+end
+
+
+When(/^I populate the form fields$/) do
+  PageManager.current_page.populate_form
+end
+
+
+Then(/^I expect the form fields to be correctly populated$/) do
+  PageManager.current_page.verify_form_data
+end
+
+
+When(/^I (.*) my changes$/) do | action|
+  PageManager.current_page.perform_action(action.downcase.to_sym)
+end
+
+
+Then(/^I expect the tab order to be correct$/) do
+  PageManager.current_page.verify_tab_order
+end
+
+
+When(/^I click the (.*) navigation (?:tab|link)$/) do |page_name|
+  # find and navigate to the specified target page
+  target_page = PageManager.find_page(page_name)
+  target_page.navigate_to
+end
+
+
+Then(/^I should (?:see|be on) the (.*) page$/) do |page_name|
+  # find and verify that the specified target page is loaded
+  target_page = PageManager.find_page(page_name)
+  target_page.verify_page_exists
+end
+
+
+Then(/^I expect the (.*) page to be correctly displayed in a new browser tab$/) do |page_name|
+  Browsers.switch_to_new_browser_instance
+  Environ.set_external_page(true)
+  TestCentricity::WebDriverConnect.initialize_browser_size if Environ.headless
+  # find and verify that the specified target page is loaded
+  target_page = PageManager.find_page(page_name)
+  target_page.verify_page_exists
+  # verify that target page is correctly displayed
+  target_page.verify_page_ui
+end
+
+
+When(/^I (?:access|switch to) the new browser tab$/) do
+  Browsers.switch_to_new_browser_instance
+end
+
+
+When(/^I close the current browser window$/) do
+  Browsers.close_current_browser_window
+  # intercept and accept any JavaScript system or browser modals that may appear
+  begin
+    page.driver.browser.switch_to.alert.accept
+    switch_to_new_browser_instance
+  rescue
+  end
+end
+
+
+When(/^I close the previous browser window$/) do
+  Browsers.close_old_browser_instance
+end
+
+
+When(/^I refresh the current page$/) do
+  Browsers.refresh_browser unless Environ.driver == :appium
+end
+
+
+When(/^I navigate back$/) do
+  Browsers.navigate_back
+end
+
+
+When(/^I navigate forward$/) do
+  Browsers.navigate_forward
+end
+
+
+When(/^I delete all cookies$/) do
+  Browsers.delete_all_cookies
+end
+
+
+When(/^I set device orientation to (.*)$/) do |orientation|
+  Browsers.set_device_orientation(orientation.downcase.to_sym)
+end

data/features/step_definitions/media_steps.rb

@@ -0,0 +1,30 @@
+
+
+When(/^I (.*) the (.*) media$/) do |action, media_type|
+  media_test_page.perform_action(media_type, action)
+end
+
+
+Then(/^the (.*) should be (.*)$/) do |media_type, state|
+  media_test_page.verify_media_state(media_type, state)
+end
+
+
+When(/^I play the (.*) with a playback speed of (.*)x$/) do |media_type, rate|
+  media_test_page.set_playback_rate(media_type, rate)
+end
+
+
+Then(/^the (.*) should play at (.*)x speed$/) do |media_type, rate|
+  media_test_page.verify_playback_rate(media_type, rate)
+end
+
+
+When(/^I set the volume of the (.*) to (.*)$/) do |media_type, volume|
+  media_test_page.set_volume(media_type, volume)
+end
+
+
+Then(/^the (.*) should have a volume of (.*)$/) do |media_type, volume|
+  media_test_page.verify_volume(media_type, volume)
+end

data/features/support/data/form_data.rb

@@ -0,0 +1,43 @@
+class FormDataSource < TestCentricity::ExcelDataSource
+  def read_form_data
+    form_data = case ENV['DATA_SOURCE'].downcase.to_sym
+                  when :excel
+                    read_excel_row_data('Form_data', 'primary')
+                  when :yaml, :json
+                    environs.read('Form_data', 'primary')
+                  else
+                    raise "#{ENV['DATA_SOURCE']} is not a valid data source"
+                end
+    FormData.current = FormData.new(form_data)
+  end
+
+  def map_form_data(form_data)
+    FormData.current = FormData.new(form_data)
+  end
+end
+
+
+class FormData < TestCentricity::DataPresenter
+  attribute :username, String
+  attribute :password, String
+  attribute :image_filename, String
+  attribute :multi_select, String
+  attribute :drop_down_item, String
+  attribute :check1, Boolean, default: false
+  attribute :check2, Boolean, default: false
+  attribute :check3, Boolean, default: false
+  attribute :radio_select, Integer
+
+  def initialize(data)
+    @username       = data[:username]
+    @password       = data[:password]
+    @image_filename = data[:image_filename]
+    @multi_select   = data[:multi_select]
+    @drop_down_item = data[:drop_down_item]
+    @check1         = data[:check1]
+    @check2         = data[:check2]
+    @check3         = data[:check3]
+    @radio_select   = data[:radio_select]
+    super
+  end
+end

data/features/support/env.rb

@@ -0,0 +1,50 @@
+require 'capybara/cucumber'
+require 'parallel_tests'
+require 'appium_capybara'
+require 'require_all'
+require 'simplecov'
+require 'testcentricity_web'
+
+include TestCentricity
+
+SimpleCov.command_name("features-#{ENV['WEB_BROWSER']}-#{ENV['SELENIUM']}" + (ENV['TEST_ENV_NUMBER'] || ''))
+
+require_relative 'world_data'
+require_relative 'world_pages'
+
+require_rel 'data'
+require_rel 'sections'
+require_rel 'pages'
+
+$LOAD_PATH << './lib'
+
+# set Capybara's default max wait time to 20 seconds
+Capybara.default_max_wait_time = 20
+
+# set the default locale and auto load all translations from config/locales/*.rb,yml.
+ENV['LOCALE'] = 'en-US' unless ENV['LOCALE']
+I18n.load_path += Dir['config/locales/*.{rb,yml}']
+I18n.default_locale = ENV['LOCALE']
+I18n.locale = ENV['LOCALE']
+Faker::Config.locale = ENV['LOCALE']
+
+# instantiate all data objects and target test environment
+include WorldData
+ENV['DATA_SOURCE'] = 'yaml' unless ENV['DATA_SOURCE']
+environs.find_environ(ENV['TEST_ENVIRONMENT'], ENV['DATA_SOURCE'].downcase.to_sym)
+WorldData.instantiate_data_objects
+
+# instantiate all page objects
+include WorldPages
+WorldPages.instantiate_page_objects
+
+# establish connection to WebDriver and target web browser
+Webdrivers.cache_time = 86_400
+
+
+url = if ENV['TEST_ENVIRONMENT'].downcase == 'local'
+        "file://#{File.dirname(__FILE__)}/../../test_site"
+      else
+        Environ.current.app_host
+      end
+WebDriverConnect.initialize_web_driver(app_host: url)

data/features/support/hooks.rb

@@ -0,0 +1,265 @@
+
+BeforeAll do
+  # start Appium Server if command line option was specified and target browser is mobile simulator or device
+  if ENV['APPIUM_SERVER'] == 'run' && Environ.driver == :appium
+    $server = TestCentricity::AppiumServer.new
+    $server.start
+  end
+end
+
+
+AfterAll do
+  # terminate Appium Server if command line option was specified and target browser is mobile simulator or device
+  if ENV['APPIUM_SERVER'] == 'run' && Environ.driver == :appium && $server.running?
+    $server.stop
+  end
+  # close driver
+  terminate_session
+end
+
+
+Before do |scenario|
+  # if executing tests in parallel concurrent threads, print thread number with scenario name
+  message = Environ.parallel ? "Thread ##{Environ.process_num} | Scenario:  #{scenario.name}" : "Scenario:  #{scenario.name}"
+  log message
+  $initialized ||= false
+  unless $initialized
+    $initialized = true
+    $test_start_time = Time.now
+    # HTML report header information if reporting is enabled
+    log Environ.report_header if ENV['REPORTING']
+  end
+end
+
+
+After do |scenario|
+  # process and embed any screenshots recorded during execution of scenario
+  process_embed_screenshots(scenario)
+  # clear out any queued screenshots
+  Environ.reset_contexts
+  # close any external pages that may have been opened
+  if Environ.external_page
+    Browsers.close_current_browser_instance
+    begin
+      page.driver.browser.switch_to.alert.accept
+      Browsers.switch_to_new_browser_instance
+    rescue
+    end
+    Environ.set_external_page(false)
+  end
+  # block any JavaScript modals that may appear as a result of ending the session
+  Browsers.suppress_js_leave_page_modal
+  # close Capybara Appium driver if it was opened
+  Capybara.page.driver.quit if Capybara.default_driver == :appium
+
+  if ENV['QUIT_DRIVER']
+    terminate_session
+  elsif Environ.grid == :browserstack
+    # restart BrowserStack test sessions if test duration exceeds 110 minutes to avoid the 2 hour test limit
+    test_elapsed_time = Time.now - $test_start_time
+    if test_elapsed_time > 6600
+      terminate_session
+      log 'Restarting BrowserStack test session'
+      $test_start_time = Time.now
+    else
+      Capybara.reset_sessions!
+    end
+  end
+end
+
+
+# exclusionary Around hooks to prevent running feature/scenario on unsupported browsers, devices, or
+# cloud remote browser hosting platforms. Use the following tags to block test execution:
+#   desktop web browsers:      @!safari, @!ie, @!firefox, @!chrome, @!edge
+#   mobile devices:            @!ipad, @!iphone
+#   remotely hosted browsers:  @!browserstack, @!saucelabs
+
+# block feature/scenario execution if running against Safari browser
+Around('@!safari') do |scenario, block|
+  qualify_browser(:safari, 'Safari', scenario, block)
+end
+
+
+# block feature/scenario execution if running against Internet Explorer browser
+Around('@!ie') do |scenario, block|
+  qualify_browser(:ie, 'Internet Explorer', scenario, block)
+end
+
+
+# block feature/scenario execution if running against Microsoft Edge browser
+Around('@!edge') do |scenario, block|
+  qualify_browser(:edge, 'Edge', scenario, block)
+end
+
+
+# block feature/scenario execution if running against Chrome browser
+Around('@!chrome') do |scenario, block|
+  qualify_browser(:chrome, 'Chrome', scenario, block)
+end
+
+
+# block feature/scenario execution if running against Firefox browser
+Around('@!firefox') do |scenario, block|
+  qualify_browser(:firefox, 'Firefox', scenario, block)
+end
+
+
+# block feature/scenario execution if running against iPad mobile browser
+Around('@!ipad') do |scenario, block|
+  qualify_device('ipad', scenario, block)
+end
+
+
+# block feature/scenario execution if running against iPhone mobile browser
+Around('@!iphone') do |scenario, block|
+  qualify_device('iphone', scenario, block)
+end
+
+
+# block feature/scenario execution if running on Selenium Grid or cloud-hosted services
+Around('@!grid') do |scenario, block|
+  if !Environ.grid
+    block.call
+  else
+    log "Scenario '#{scenario.name}' cannot be executed on Selenium Grid or cloud-hosted services."
+    skip_this_scenario
+  end
+end
+
+
+# block feature/scenario execution if running against Browserstack cloud-hosted service
+Around('@!browserstack') do |scenario, block|
+  if Environ.grid != :browserstack
+    block.call
+  else
+    log "Scenario '#{scenario.name}' cannot be executed on the BrowserStack service."
+    skip_this_scenario
+  end
+end
+
+
+# block feature/scenario execution if running against Sauce Labs cloud-hosted service
+Around('@!saucelabs') do |scenario, block|
+  if Environ.grid != :saucelabs
+    block.call
+  else
+    log "Scenario '#{scenario.name}' cannot be executed on the SauceLabs service."
+    skip_this_scenario
+  end
+end
+
+
+# block feature/scenario execution if running against a physical or emulated mobile device
+Around('@!device') do |scenario, block|
+  if Environ.is_device?
+    log "Scenario '#{scenario.name}' cannot be executed on physical or emulated devices."
+    skip_this_scenario
+  else
+    block.call
+  end
+end
+
+
+Around('@!ios') do |scenario, block|
+  if Environ.device_os == :android
+    block.call
+  else
+    log "Scenario '#{scenario.name}' can not be executed on iOS devices."
+    skip_this_scenario
+  end
+end
+
+
+Around('@!android') do |scenario, block|
+  if Environ.device_os == :ios
+    block.call
+  else
+    log "Scenario '#{scenario.name}' can not be executed on Android devices."
+    skip_this_scenario
+  end
+end
+
+
+Around('@!mobile') do |scenario, block|
+  if Environ.platform == :mobile
+    log "Scenario '#{scenario.name}' is not executed on mobile devices or simulators."
+    skip_this_scenario
+  else
+    block.call
+  end
+end
+
+
+Around('@!headless') do |scenario, block|
+  if Environ.headless
+    log "Scenario '#{scenario.name}' is not executed on headless browsers."
+    skip_this_scenario
+  else
+    block.call
+  end
+end
+
+
+Around('@!firefox_headless') do |scenario, block|
+  if Environ.browser == :firefox_headless
+    log "Scenario '#{scenario.name}' can not be executed on headless Firefox browsers."
+    skip_this_scenario
+  else
+    block.call
+  end
+end
+
+
+# supporting methods
+
+def qualify_browser(browser_type, browser_name, scenario, block)
+  if Environ.browser != browser_type && ENV['HOST_BROWSER'] != browser_name.downcase
+    block.call
+  else
+    log "Scenario '#{scenario.name}' cannot be executed with the #{browser_name} browser."
+    skip_this_scenario
+  end
+end
+
+def qualify_device(device, scenario, block)
+  if Environ.is_device?
+    if Environ.device_type.include? device
+      log "Scenario '#{scenario.name}' cannot be executed on #{device} devices."
+      skip_this_scenario
+    else
+      block.call
+    end
+  else
+    block.call
+  end
+end
+
+def terminate_session
+  Capybara.page.driver.quit
+  Capybara.reset_sessions!
+  Environ.session_state = :quit
+  $driver_scenario_count = 0
+end
+
+def screen_shot_and_save_page(scenario)
+  timestamp = Time.now.strftime('%Y%m%d%H%M%S%L')
+  filename = scenario.nil? ? "Screenshot-#{timestamp}.png" : "Screenshot-#{scenario.__id__}-#{timestamp}.png"
+  path = File.join Dir.pwd, 'reports/screenshots/', filename
+  save_screenshot path
+  log "Screenshot saved at #{path}"
+  screen_shot = { path: path, filename: filename }
+  Environ.save_screen_shot(screen_shot)
+  attach(path, 'image/png') unless scenario.nil?
+end
+
+def process_embed_screenshots(scenario)
+  screen_shots = Environ.get_screen_shots
+  if screen_shots.count > 0
+    screen_shots.each do |row|
+      path = row[:path]
+      attach(path, 'image/png')
+    end
+  else
+    screen_shot_and_save_page(scenario) if scenario.failed?
+  end
+end