testcentricity_web 3.3.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3d97b7e502a92925e73d36a13871155d113fa873cc6edc8832adf0036435d65
-  data.tar.gz: 98ae195b6766c2872d548d07b9b79f7b028132815afd2e84f947e0f3d4b22fa2
+  metadata.gz: df556101ef2de8b85dae896e6d943d621e220a452101257a8c36aa4f32a6db51
+  data.tar.gz: 324e34cc74ccd75892e7cbba3f11ab6e4ada25699c94b8a5c9d49dda411866a7
 SHA512:
-  metadata.gz: c01dcd0570c1af0b58f86c15dacc86cdd99caccc5f0f5bd750f9dbc1875447860cb30204939071468078426a3823ffc12a6ef9936d858509e2e471492be07b8a
-  data.tar.gz: ed1919d60dfef160d4e59a2b40a3405dfd08b0632930f69ea2a0e068fcc51210d01fd003a549ec377929feae3de03463ac4754b47df3fcda317cc02018f70569
+  metadata.gz: 88a64d973f5dc89fee73245eb888c41c3d8fc673b83548e11798f5d4bc80679176a2abe0a5cde655e8d5c67a1d1887fa9963ecef92eeb2521e8dc6367d8bc3e6
+  data.tar.gz: 2f7a3967eadac906420d7175a0d8c0d915b6f70240aaee0a333bf332f6ed5b08a376464af7a7cc6a472f46540000e7e607dd4ac99b000c3f81e53c43488956d7

data/CHANGELOG.md

@@ -1,6 +1,35 @@
 # CHANGELOG
 All notable changes to this project will be documented in this file.
 
+## [4.0.0] - 25-MAR-2021
+
+### Changed
+* `WebDriverConnect.initialize_web_driver` method now accepts an `options` hash as an optional parameter, which can be used to
+  specify an optional base host URL and/or the desired Selenium-Webdriver capabilities required to establish a connection with
+  a cloud hosted target web browser.
+* User defined mobile device profiles can be specified in a `device.yml` file for testing locally hosted emulated mobile
+  web browsers running in an instance of the Chrome desktop browser. The user specified device profiles must be located at 
+  `config/data/devices/devices.yml`. Refer to the **User defined mobile device profiles** section of the {file:README.md README} file.
+
+### Removed
+* Removed support for the following legacy UI elements:
+  * `CellElement`
+  * `CellButton`
+  * `CellCheckBox`
+  * `CellRadio`
+  * `CellImage`
+  * `ListElement`
+  * `ListButton`
+  * `ListCheckBox`
+* Removed support for Siebel Open UI objects. This includes removal of the following legacy methods:
+  * `CheckBox.set_siebel_checkbox_state`
+  * `SelectList.choose_siebel_option`
+  * `SelectList.get_siebel_options`
+  * `SelectList.verify_siebel_options`
+  * `SelectList.read_only?`
+  * `UIElement.invoke_siebel_dialog`
+  * `UIElement.invoke_siebel_popup`
+  * `UIElement.get_siebel_object_type`
 
 ## [3.3.0] - 14-MAR-2021
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    testcentricity_web (3.3.0)
+    testcentricity_web (4.0.0.a1)
       appium_lib
       browserstack-local
       capybara (>= 3.1, < 4)
@@ -25,7 +25,7 @@ GEM
       appium_lib_core (~> 4.1)
       nokogiri (~> 1.8, >= 1.8.1)
       tomlrb (~> 1.1)
-    appium_lib_core (4.4.1)
+    appium_lib_core (4.5.0)
       faye-websocket (~> 0.11.0)
       selenium-webdriver (~> 3.14, >= 3.14.1)
     axiom-types (0.1.1)
@@ -51,17 +51,19 @@ GEM
       thread_safe (~> 0.3, >= 0.3.1)
     equalizer (0.0.11)
     eventmachine (1.2.7)
-    faker (2.16.0)
+    faker (2.17.0)
       i18n (>= 1.6, < 2)
     faye-websocket (0.11.0)
       eventmachine (>= 0.12.0)
       websocket-driver (>= 0.5.1)
     ffi (1.15.0)
-    i18n (1.8.9)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
-    mini_mime (1.0.2)
-    nokogiri (1.11.2-x86_64-darwin)
+    mini_mime (1.1.0)
+    mini_portile2 (2.5.0)
+    nokogiri (1.11.3)
+      mini_portile2 (~> 2.5.0)
       racc (~> 1.4)
     os (1.1.1)
     power_assert (2.0.0)
@@ -80,7 +82,7 @@ GEM
       rubyzip (>= 1.2.2)
     spreadsheet (1.1.7)
       ruby-ole (>= 1.0)
-    test-unit (3.4.0)
+    test-unit (3.4.1)
       power_assert
     thread_safe (0.3.6)
     tomlrb (1.3.0)

data/README.md

@@ -23,7 +23,6 @@ The TestCentricity™ Web gem supports running automated tests against the follo
   * [Gridlastic](https://www.gridlastic.com/test-environments.html)
   * [LambdaTest](https://www.lambdatest.com/selenium-automation)
 * web portals utilizing JavaScript front end application frameworks like Ember, React, Angular, and GWT
-* enterprise web portals built using Siebel Open UI
 * web pages containing HTML5 Video and Audio objects
 
 
@@ -483,6 +482,7 @@ With TestCentricity, all UI elements are based on the **UIElement** class, and i
     element.click_at(x, y)
     element.hover
     element.hover_at(x, y)
+    element.scroll_to(position)
     element.drag_by(right_offset, down_offset)
     element.drag_and_drop(target, right_offset, down_offset)
 
@@ -638,11 +638,11 @@ navigated to by clicking associated links. One such Cucumber navigation scenario
 
     Scenario Outline:  Verify Home page navigation links
       Given I am on the Home page
-      When I click the <page_name> navigation link
-      Then I expect the <page_name> page to be correctly displayed
+      When I click the <page name> navigation link
+      Then I expect the <page name> page to be correctly displayed
     
       Examples:
-        |page_name          |
+        |page name          |
         |Registration       |
         |My Account         |
         |Terms & Conditions |
@@ -653,17 +653,17 @@ navigated to by clicking associated links. One such Cucumber navigation scenario
 In the above example, the step definitions associated with the 3 steps might be implemented using a `page_dispatcher` method using a
 `case` statement to parse the `page` parameter as in the example below:
 
-    Given(/^I am on the ([^\"]*) page$/) do |page_name|
+    Given(/^I am on the (.*) page$/) do |page_name|
       target_page = page_dispatcher(page_name)
       target_page.load_page
     end
     
-    When(/^I click the ([^\"]*) navigation link$/) do |link_name|
+    When(/^I click the (.*) navigation link$/) do |link_name|
       target_page = page_dispatcher(link_name)
       target_page.navigate_to
     end
     
-    Then(/^I expect the ([^\"]*) page to be correctly displayed$/) do |page_name|
+    Then(/^I expect the (.*) page to be correctly displayed$/) do |page_name|
       target_page = page_dispatcher(page_name)
       target_page.verify_page_exists
       target_page.verify_page_ui
@@ -701,22 +701,22 @@ To use these **PageManager** methods, include the step definitions and code belo
 
     include TestCentricity
     
-    Given(/^I am on the ([^\"]*) page$/) do |page_name|
+    Given(/^I am on the (.*) page$/) do |page_name|
       target_page = PageManager.find_page(page_name)
       target_page.load_page
     end
     
-    When(/^I click the ([^\"]*) navigation link$/) do |page_name|
+    When(/^I click the (.*) navigation link$/) do |page_name|
       target_page = PageManager.find_page(page_name)
       target_page.navigate_to
     end
     
-    Then(/^I expect to see the ([^\"]*) page$/) do |page_name|
+    Then(/^I expect to see the (.*) page$/) do |page_name|
       target_page = PageManager.find_page(page_name)
       target_page.verify_page_exists
     end
     
-    Then(/^I expect the ([^\"]*) page to be correctly displayed$/) do |page_name|
+    Then(/^I expect the (.*) page to be correctly displayed$/) do |page_name|
       target_page = PageManager.find_page(page_name)
       target_page.verify_page_exists
       target_page.verify_page_ui
@@ -870,6 +870,38 @@ To use a local instance of the Chrome desktop browser to host the emulated mobil
 to `chrome`.
 
 
+#### User defined mobile device profiles
+
+User defined mobile device profiles can be specified in a `device.yml` file for testing locally hosted emulated mobile web browsers running in an instance
+of the Chrome desktop browser. The user specified device profiles must be located at `config/data/devices/devices.yml` as depicted below:
+
+    my_automation_project
+        ├── config
+        │   ├── data
+        │   │   └── devices
+        │   │       └── devices.yml
+        │   ├── locales
+        │   └── cucumber.yml
+        ├── downloads
+        ├── features
+        │   ├── step_definitions
+        │   ├── support
+        │   └── test_data
+        ├── Gemfile
+        └── README.md
+
+The format for a new device profile is:
+```
+  :new_device_profile:
+    :name: "New Device Name"
+    :os: (ios, android, kindle, or blackberry)
+    :type: (phone or tablet)
+    :css_width: css width in pixels
+    :css_height: css height in pixels
+    :default_orientation: (portrait or landscape)
+    :user_agent: "user agent string"
+```
+
 ### Selenium Grid and Dockerized Selenium Grid hosted desktop and emulated mobile web browsers
 
 For desktop and emulated mobile web browsers running on Selenium Grid or Dockerized Selenium Grid environments ([like Zalenium](https://opensource.zalando.com/zalenium/)), the following **Environment Variables** must be set
@@ -877,7 +909,7 @@ as described in the table below.
 
 **Environment Variable** | **Description**
 ---------------   | ----------------
-`WEB_BROWSER`     | Must be set to one of the following desktop browsers - `chrome`, `chrome_headless`, `firefox`, `ie`, `edge`, or `safari` or any of the mobile web browsers described above.
+`WEB_BROWSER`     | Must be set to one of the following desktop browsers - `chrome`, `chrome_headless`, or `firefox`, or any of the mobile web browsers described above.
 `SELENIUM`        | Must be set to `remote`
 `REMOTE_ENDPOINT` | Must be set to the URL of the Grid hub, which is usually `http://localhost:4444/wd/hub`
 

data/lib/testcentricity_web.rb

@@ -35,16 +35,6 @@ require 'testcentricity_web/web_elements/range'
 require 'testcentricity_web/web_elements/media'
 require 'testcentricity_web/web_elements/audio'
 require 'testcentricity_web/web_elements/video'
-require 'testcentricity_web/web_elements/cell_element'
-require 'testcentricity_web/web_elements/cell_button'
-require 'testcentricity_web/web_elements/cell_checkbox'
-require 'testcentricity_web/web_elements/cell_radio'
-require 'testcentricity_web/web_elements/cell_image'
-require 'testcentricity_web/web_elements/list_element'
-require 'testcentricity_web/web_elements/list_button'
-require 'testcentricity_web/web_elements/list_checkbox'
-require 'testcentricity_web/web_elements/list_radio'
-require 'testcentricity_web/web_elements/siebel_open_ui_helper'
 
 
 module TestCentricity

data/lib/testcentricity_web/browser_helper.rb

@@ -2,9 +2,11 @@ require 'yaml'
 
 
 module TestCentricity
-  module Browsers
+  class Browsers
     include Capybara::DSL
 
+    @devices = {}
+
     # Sets the size of the browser window.
     #
     # @param resolution [Array] the desired [width, height]
@@ -73,8 +75,8 @@ module TestCentricity
 
     def self.close_all_browser_instances
       Capybara.page.driver.browser.window_handles.each do |handle|
-        page.driver.browser.switch_to.window(handle)
-        page.driver.browser.close
+        Capybara.page.driver.browser.switch_to.window(handle)
+        Capybara.page.driver.browser.close
       end
     end
 
@@ -126,17 +128,15 @@ module TestCentricity
       end
     end
 
-    def self.mobile_device_agent(device)
-      device_name = device.gsub(/\s+/, '').downcase.to_sym
-      device = get_devices[device_name]
+    def self.mobile_device_agent(browser)
+      device = get_device(browser)
       agent_string = device[:user_agent]
       raise "Device '#{device}' is not defined" unless agent_string
       agent_string
     end
 
-    def self.mobile_device_name(device)
-      device_name = device.gsub(/\s+/, '').downcase.to_sym
-      device = get_devices[device_name]
+    def self.mobile_device_name(browser)
+      device = get_device(browser)
       name = device[:name]
       raise "Device '#{device}' is not defined" unless name
       Environ.device_os = device[:os]
@@ -145,8 +145,7 @@ module TestCentricity
     end
 
     def self.browser_size(browser, orientation)
-      device_name = browser.gsub(/\s+/, '').downcase.to_sym
-      device = get_devices[device_name]
+      device = get_device(browser)
       if device
         width = device[:css_width]
         height = device[:css_height]
@@ -170,8 +169,17 @@ module TestCentricity
 
     private
 
-    def self.get_devices
-      YAML.load_file File.expand_path('../../devices/devices.yml', __FILE__)
+    def self.get_device(device)
+      if @devices.blank?
+        @devices = YAML.load_file File.expand_path('../../devices/devices.yml', __FILE__)
+        # read in user defined list of devices
+        external_device_file = 'config/data/devices/devices.yml'
+        unless File.size?(external_device_file).nil?
+          ext_devices = YAML.load_file(external_device_file)
+          @devices = @devices.merge(ext_devices)
+        end
+      end
+      @devices[device.gsub(/\s+/, '').downcase.to_sym]
     end
   end
 end

data/lib/testcentricity_web/data_objects/data_objects_helper.rb

@@ -5,8 +5,8 @@ require 'virtus'
 
 module TestCentricity
 
-  XL_PRIMARY_DATA_PATH ||= 'features/test_data/'
-  XL_PRIMARY_DATA_FILE ||= "#{XL_PRIMARY_DATA_PATH}data.xls"
+  PRIMARY_DATA_PATH ||= 'features/test_data/'
+  XL_PRIMARY_DATA_FILE ||= "#{PRIMARY_DATA_PATH}data.xls"
 
 
   class DataObject
@@ -81,7 +81,7 @@ module TestCentricity
     attr_accessor :node
 
     def read_yaml_node_data(file_name, node_name)
-      @file_path = "#{XL_PRIMARY_DATA_PATH}#{file_name}"
+      @file_path = "#{PRIMARY_DATA_PATH}#{file_name}"
       @node = node_name
       data = YAML.load_file(@file_path)
       data[node_name]
@@ -94,7 +94,7 @@ module TestCentricity
     end
 
     def read_json_node_data(file_name, node_name)
-      @file_path = "#{XL_PRIMARY_DATA_PATH}#{file_name}"
+      @file_path = "#{PRIMARY_DATA_PATH}#{file_name}"
       @node = node_name
       raw_data = File.read(@file_path)
       data = JSON.parse(raw_data)
@@ -117,7 +117,7 @@ module TestCentricity
       @worksheet = sheet
       if ENV['TEST_ENVIRONMENT']
         environment = ENV['TEST_ENVIRONMENT']
-        data_file = "#{XL_PRIMARY_DATA_PATH}#{environment}_data.xls"
+        data_file = "#{PRIMARY_DATA_PATH}#{environment}_data.xls"
         data_file = XL_PRIMARY_DATA_FILE unless ExcelData.row_spec_exists?(data_file, @worksheet, row_spec)
       else
         data_file = XL_PRIMARY_DATA_FILE

data/lib/testcentricity_web/version.rb

@@ -1,3 +1,3 @@
 module TestCentricityWeb
-  VERSION = '3.3.0'
+  VERSION = '4.0.0'
 end

data/lib/testcentricity_web/web_core/page_object.rb

@@ -5,8 +5,7 @@ module TestCentricity
     # @param element_name [Symbol] name of UI object (as a symbol)
     # @param locator [String] CSS selector or XPath expression that uniquely identifies object
     # @example
-    #   element :siebel_view,  'div#_sweview'
-    #   element :siebel_busy,  "//html[contains(@class, 'siebui-busy')]"
+    #   element :settings_item, 'a#userPreferencesTrigger'
     #
     def self.element(element_name, locator)
       define_page_element(element_name, TestCentricity::UIElement, locator)
@@ -288,97 +287,6 @@ module TestCentricity
       element_hash.each(&method(:filefield))
     end
 
-    # Declare and instantiate a cell button in a table column on this page object.
-    #
-    # @param element_name [Symbol] name of cell button object (as a symbol)
-    # @param locator [String] XPath expression that uniquely identifies cell button within row and column of parent table object
-    # @param table [Symbol] Name (as a symbol) of parent table object
-    # @param column [Integer] 1-based index of table column that contains the cell button object
-    # @example
-    #   cell_button  :show_button, "a[@class='show']", :data_table, 5
-    #   cell_button  :edit_button, "a[@class='edit']", :data_table, 5
-    #
-    def self.cell_button(element_name, locator, table, column)
-      class_eval(%(def #{element_name};@#{element_name} ||= TestCentricity::CellButton.new("#{element_name}", self, "#{locator}", :page, #{table}, #{column});end))
-    end
-
-    # Declare and instantiate a cell checkbox in a table column on this page object.
-    #
-    # @param element_name [Symbol] name of cell checkbox object (as a symbol)
-    # @param locator [String] XPath expression that uniquely identifies cell checkbox within row and column of parent table object
-    # @param table [Symbol] Name (as a symbol) of parent table object
-    # @param column [Integer] 1-based index of table column that contains the cell checkbox object
-    # @example
-    #   cell_checkbox  :is_registered_check, "a[@class='registered']", :data_table, 4
-    #
-    def self.cell_checkbox(element_name, locator, table, column, proxy = nil)
-      class_eval(%(def #{element_name};@#{element_name} ||= TestCentricity::CellCheckBox.new("#{element_name}", self, "#{locator}", :page, #{table}, #{column}, #{proxy});end))
-    end
-
-    # Declare and instantiate a cell radio in a table column on this page object.
-    #
-    # @param element_name [Symbol] name of cell radio object (as a symbol)
-    # @param locator [String] XPath expression that uniquely identifies cell radio within row and column of parent table object
-    # @param table [Symbol] Name (as a symbol) of parent table object
-    # @param column [Integer] 1-based index of table column that contains the cell radio object
-    # @example
-    #   cell_radio  :track_a_radio, "a[@class='track_a']", :data_table, 8
-    #
-    def self.cell_radio(element_name, locator, table, column, proxy = nil)
-      class_eval(%(def #{element_name};@#{element_name} ||= TestCentricity::CellRadio.new("#{element_name}", self, "#{locator}", :page, #{table}, #{column}, #{proxy});end))
-    end
-
-    # Declare and instantiate a cell image in a table column on this page object.
-    #
-    # @param element_name [Symbol] name of cell image object (as a symbol)
-    # @param locator [String] XPath expression that uniquely identifies cell image within row and column of parent table object
-    # @param table [Symbol] Name (as a symbol) of parent table object
-    # @param column [Integer] 1-based index of table column that contains the cell image object
-    # @example
-    #   cell_image  :ready_icon, "img[@class='ready']", :data_table, 3
-    #   cell_image  :send_icon, "img[@class='send']", :data_table, 3
-    #
-    def self.cell_image(element_name, locator, table, column)
-      class_eval(%(def #{element_name};@#{element_name} ||= TestCentricity::CellImage.new("#{element_name}", self, "#{locator}", :page, #{table}, #{column});end))
-    end
-
-    # Declare and instantiate a list button in a row of a list object on this page object.
-    #
-    # @param element_name [Symbol] name of list button object (as a symbol)
-    # @param locator [String] XPath expression that uniquely identifies list button within row of parent list object
-    # @param list [Symbol] Name (as a symbol) of parent list object
-    # @example
-    #   list_button  :delete_button, "a[@class='delete']", :icon_list
-    #   list_button  :edit_button, "a[@class='edit']", :icon_list
-    #
-    def self.list_button(element_name, locator, list)
-      class_eval(%(def #{element_name};@#{element_name} ||= TestCentricity::ListButton.new("#{element_name}", self, "#{locator}", :page, #{list});end))
-    end
-
-    # Declare and instantiate a list checkbox in a row of a list object on this page object.
-    #
-    # @param element_name [Symbol] name of list checkbox object (as a symbol)
-    # @param locator [String] XPath expression that uniquely identifies list checkbox within row of parent list object
-    # @param list [Symbol] Name (as a symbol) of parent list object
-    # @example
-    #   list_checkbox  :is_registered_check, "a[@class='registered']", :data_list
-    #
-    def self.list_checkbox(element_name, locator, list, proxy = nil)
-      class_eval(%(def #{element_name};@#{element_name} ||= TestCentricity::ListCheckBox.new("#{element_name}", self, "#{locator}", :page, #{list}, #{proxy});end))
-    end
-
-    # Declare and instantiate a list radio in a row of a list object on this page object.
-    #
-    # @param element_name [Symbol] name of list radio object (as a symbol)
-    # @param locator [String] XPath expression that uniquely identifies list radio within row of parent list object
-    # @param list [Symbol] Name (as a symbol) of parent list object
-    # @example
-    #   list_radio  :sharing_radio, "a[@class='sharing']", :data_list
-    #
-    def self.list_radio(element_name, locator, list, proxy = nil)
-      class_eval(%(def #{element_name};@#{element_name} ||= TestCentricity::ListRadio.new("#{element_name}", self, "#{locator}", :page, #{list}, #{proxy});end))
-    end
-
     # Instantiate a single PageSection object for this page object.
     #
     # @param section_name [Symbol] name of PageSection object (as a symbol)