testcentricity_web 3.3.0 → 4.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3d97b7e502a92925e73d36a13871155d113fa873cc6edc8832adf0036435d65
-  data.tar.gz: 98ae195b6766c2872d548d07b9b79f7b028132815afd2e84f947e0f3d4b22fa2
+  metadata.gz: d93f63b0f93fc833deb465d8588ef93e30db5b171929da48ef8e4449450b8c7a
+  data.tar.gz: 1a73bbf1521c29b0b80ca2163461795cb24e24f65107c671b5aa581b17c55d20
 SHA512:
-  metadata.gz: c01dcd0570c1af0b58f86c15dacc86cdd99caccc5f0f5bd750f9dbc1875447860cb30204939071468078426a3823ffc12a6ef9936d858509e2e471492be07b8a
-  data.tar.gz: ed1919d60dfef160d4e59a2b40a3405dfd08b0632930f69ea2a0e068fcc51210d01fd003a549ec377929feae3de03463ac4754b47df3fcda317cc02018f70569
+  metadata.gz: a250df9034b5246bc99bc9f395d8b461405a5900302814069afd1a50528bc773ba3842e53ab1b2f85fd216522f0b758a533077bfa0ec360edc25570dc6bdd02c
+  data.tar.gz: 856f31ba5173274eaec57ac27806a3308e939245c43fc21d5a05e62a959aece056db237b2cb5fbc67275ee6ce1edfe44eb146a0c6d3c2da40339336aa101ceba

data/CHANGELOG.md

@@ -1,6 +1,43 @@
 # CHANGELOG
 All notable changes to this project will be documented in this file.
 
+## [4.0.3] - 30-DEC-2021
+
+### Changed
+* Primary test data path has been changed from `features/test_data/` to `config/test_data/`.
+
+### Fixed
+* No longer throws a `NoMethodError: undefined method 'World' for main:Object` error when using RSpec.
+
+## [4.0.0] - 18-APR-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.2)
       appium_lib
       browserstack-local
       capybara (>= 3.1, < 4)
@@ -19,13 +19,13 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     appium_lib (11.2.0)
       appium_lib_core (~> 4.1)
       nokogiri (~> 1.8, >= 1.8.1)
       tomlrb (~> 1.1)
-    appium_lib_core (4.4.1)
+    appium_lib_core (4.7.1)
       faye-websocket (~> 0.11.0)
       selenium-webdriver (~> 3.14, >= 3.14.1)
     axiom-types (0.1.1)
@@ -46,61 +46,59 @@ GEM
     chronic (0.10.2)
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.9)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
-    equalizer (0.0.11)
     eventmachine (1.2.7)
-    faker (2.16.0)
+    faker (2.19.0)
       i18n (>= 1.6, < 2)
-    faye-websocket (0.11.0)
+    faye-websocket (0.11.1)
       eventmachine (>= 0.12.0)
       websocket-driver (>= 0.5.1)
-    ffi (1.15.0)
-    i18n (1.8.9)
+    ffi (1.15.4)
+    i18n (1.8.11)
       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.2)
+    nokogiri (1.12.5-x86_64-darwin)
       racc (~> 1.4)
-    os (1.1.1)
-    power_assert (2.0.0)
+    os (1.1.4)
+    power_assert (2.0.1)
     public_suffix (4.0.6)
-    racc (1.5.2)
+    racc (1.6.0)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rake (13.0.1)
-    redcarpet (3.5.0)
-    regexp_parser (2.1.1)
+    rake (13.0.6)
+    redcarpet (3.5.1)
+    regexp_parser (2.2.0)
     ruby-ole (1.2.12.2)
-    rubyzip (2.3.0)
+    rubyzip (2.3.2)
     selenium-webdriver (3.142.7)
       childprocess (>= 0.5, < 4.0)
       rubyzip (>= 1.2.2)
     spreadsheet (1.1.7)
       ruby-ole (>= 1.0)
-    test-unit (3.4.0)
+    test-unit (3.5.3)
       power_assert
     thread_safe (0.3.6)
     tomlrb (1.3.0)
-    virtus (1.0.5)
+    virtus (2.0.0)
       axiom-types (~> 0.1)
       coercible (~> 1.0)
       descendants_tracker (~> 0.0, >= 0.0.3)
-      equalizer (~> 0.0, >= 0.0.9)
-    webdrivers (4.6.0)
+    webdrivers (4.6.1)
       nokogiri (~> 1.6)
       rubyzip (>= 1.3.0)
       selenium-webdriver (>= 3.0, < 4.0)
-    websocket-driver (0.7.3)
+    websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
     xpath (3.2.0)
       nokogiri (~> 1.8)
 
 PLATFORMS
-  ruby
+  x86_64-darwin-21
 
 DEPENDENCIES
   bundler
@@ -109,4 +107,4 @@ DEPENDENCIES
   testcentricity_web!
 
 BUNDLED WITH
-   2.1.4
+   2.2.1

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,41 +653,42 @@ 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
     end
     
     # this method takes a page name as a parameter and returns an instance of the associated Page Object
-    def page_dispatcher(page_name)
-      case page_name
-      when 'Registration'
-        page = registration_page
-      when 'My Account'
-        page = my_account_page
-      when 'Terms & Conditions'
-        page = terms_conditions_page
-      when 'Privacy Policy'
-        page = privacy_policy_page
-      when 'Contact Us'
-        page = contact_us_page
-      when 'FAQs'
-        page = faqs_page
+      def page_dispatcher(page_name)
+        page = case page_name
+               when 'Registration'
+                 registration_page
+               when 'My Account'
+                 my_account_page
+               when 'Terms & Conditions'
+                 terms_conditions_page
+               when 'Privacy Policy'
+                 privacy_policy_page
+               when 'Contact Us'
+                 contact_us_page
+               when 'FAQs'
+                 faqs_page
+               end
+        raise "No page object defined for page named '#{page_name}'" unless page
+        page
       end
-      raise "No page object defined for page named '#{page_name}'" unless page
-      page
-    end
+
 
 
 While this approach may be effective for small web applications with only a few pages (and hence few **Page Objects**), it quickly becomes
@@ -701,22 +702,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
@@ -767,11 +768,11 @@ a `/downloads` folder at the same level as the `/config` and `/features` folders
 
     my_automation_project
         ├── config
+        │   └── test_data
         ├── downloads
         ├── features
         │   ├── step_definitions
-        │   ├── support
-        │   └── test_data
+        │   └── support
         ├── Gemfile
         └── README.md
 
@@ -782,6 +783,7 @@ test thread. This is to ensure that files downloaded in each test thread are iso
 
     my_automation_project
         ├── config
+        │   └── test_data
         ├── downloads
         │   ├── 1
         │   ├── 2
@@ -789,8 +791,7 @@ test thread. This is to ensure that files downloaded in each test thread are iso
         │   └── 4
         ├── features
         │   ├── step_definitions
-        │   ├── support
-        │   └── test_data
+        │   └── support
         ├── Gemfile
         └── README.md
 
@@ -870,6 +871,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
+        │   ├── test_data
+        │   └── cucumber.yml
+        ├── downloads
+        ├── features
+        │   ├── step_definitions
+        │   └── support
+        ├── 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 +910,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/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

@@ -1,12 +1,18 @@
 require 'yaml'
 require 'json'
 require 'virtus'
+require 'time'
+require 'chronic'
+require 'faker'
 
 
 module TestCentricity
 
-  XL_PRIMARY_DATA_PATH ||= 'features/test_data/'
-  XL_PRIMARY_DATA_FILE ||= "#{XL_PRIMARY_DATA_PATH}data.xls"
+  PRIMARY_DATA_PATH ||= 'config/test_data/'
+  PRIMARY_DATA_FILE ||= "#{PRIMARY_DATA_PATH}data."
+  XL_PRIMARY_DATA_FILE   ||= "#{PRIMARY_DATA_FILE}xls"
+  YML_PRIMARY_DATA_FILE  ||= "#{PRIMARY_DATA_FILE}yml"
+  JSON_PRIMARY_DATA_FILE ||= "#{PRIMARY_DATA_FILE}json"
 
 
   class DataObject
@@ -81,7 +87,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 +100,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)
@@ -106,6 +112,28 @@ module TestCentricity
       data[node_name] = node_data
       File.write(@file_path, data.to_json)
     end
+
+    private
+
+    def self.calculate_dynamic_value(value)
+      test_value = value.split('!', 2)
+      parameter = test_value[1].split('.', 2)
+      case parameter[0]
+      when 'Date'
+        result = eval("Chronic.parse('#{parameter[1]}')")
+      when 'FormattedDate', 'FormatDate'
+        date_time_params = parameter[1].split(' format! ', 2)
+        date_time = eval("Chronic.parse('#{date_time_params[0].strip}')")
+        result = date_time.to_s.format_date_time("#{date_time_params[1].strip}")
+      else
+        result = if Faker.constants.include?(parameter[0].to_sym)
+                   eval("Faker::#{parameter[0]}.#{parameter[1]}")
+                 else
+                   eval(test_value[1])
+                 end
+      end
+      result.to_s
+    end
   end
 
 
@@ -117,7 +145,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
@@ -147,3 +175,4 @@ module TestCentricity
     end
   end
 end
+

data/lib/testcentricity_web/data_objects/environment.rb

@@ -1,21 +1,45 @@
 module TestCentricity
   class EnvironData < TestCentricity::ExcelDataSource
     attr_accessor	:current
+    attr_accessor	:generic_data
+    attr_accessor	:environ_specific_data
 
-    WKS_ENVIRONS ||= 'Environments'
-
-    def find_environ(environ_name, source_type = :excel)
+    def self.find_environ(environ_name, source_type = :excel)
       data = case source_type
              when :excel
-               ExcelData.read_row_data(XL_PRIMARY_DATA_FILE, WKS_ENVIRONS, environ_name)
+               ExcelData.read_row_data(XL_PRIMARY_DATA_FILE, 'Environments', environ_name)
              when :yaml
-               read_yaml_node_data('environments.yml', environ_name)
+               # read generic test data from data.yml file
+               @generic_data ||= YAML.load_file(YML_PRIMARY_DATA_FILE)
+               # read environment specific test data
+               data_file = "#{PRIMARY_DATA_PATH}#{environ_name}_data.yml"
+               @environ_specific_data ||= YAML.load_file(data_file)
+
+               read('Environments', environ_name)
              when :json
                read_json_node_data('environments.json', environ_name)
              end
       @current = Environ.new(data)
       Environ.current = @current
     end
+
+    def self.read(key_name, node_name)
+      if @environ_specific_data.key?(key_name) && @environ_specific_data[key_name].key?(node_name)
+        node_data = @environ_specific_data[key_name][node_name]
+      else
+        raise "No key named #{key_name} in generic and environment-specific data" unless @generic_data.key?(key_name)
+        raise "No node named #{node_name} in #{key_name} section of generic and environment-specific data" unless @generic_data[key_name].key?(node_name)
+
+        node_data = @generic_data[key_name][node_name]
+      end
+
+      if node_data.is_a?(Hash)
+        node_data.each do |key, value|
+          node_data[key] = calculate_dynamic_value(value) if value.to_s.start_with?('eval!')
+        end
+      end
+      node_data
+    end
   end
 
 
@@ -355,3 +379,4 @@ module TestCentricity
     end
   end
 end
+

data/lib/testcentricity_web/data_objects/excel_helper.rb

@@ -1,6 +1,3 @@
-require 'time'
-require 'chronic'
-require 'faker'
 require 'spreadsheet'
 
 
@@ -273,27 +270,6 @@ module TestCentricity
       # rename new Excel document, replacing the original
       File.rename(outfile, file)
     end
-
-    private
-
-    def self.calculate_dynamic_value(value)
-      test_value = value.split('!', 2)
-      parameter = test_value[1].split('.', 2)
-      case parameter[0]
-      when 'Date'
-        result = eval("Chronic.parse('#{parameter[1]}')")
-      when 'FormattedDate', 'FormatDate'
-        date_time_params = parameter[1].split(' format! ', 2)
-        date_time = eval("Chronic.parse('#{date_time_params[0].strip}')")
-        result = date_time.to_s.format_date_time("#{date_time_params[1].strip}")
-      else
-        result = if Faker.constants.include?(parameter[0].to_sym)
-                   eval("Faker::#{parameter[0]}.#{parameter[1]}")
-                 else
-                   eval(test_value[1])
-                 end
-      end
-      result.to_s
-    end
   end
 end
+

data/lib/testcentricity_web/version.rb

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