testcentricity_web 4.3.1 → 4.4.0

data/lib/testcentricity_web/data_objects/environment.rb

@@ -84,8 +84,10 @@ module TestCentricity
     attr_accessor :device_os
     attr_accessor :device_os_version
     attr_accessor :device_orientation
+    attr_accessor :screen_size
     attr_accessor :platform
     attr_accessor :driver
+    attr_accessor :driver_name
     attr_accessor :grid
     attr_accessor :tunneling
     attr_accessor :locale
@@ -98,7 +100,6 @@ module TestCentricity
     attr_accessor :portal_status
     attr_accessor :portal_context
     attr_accessor :external_page
-
     attr_accessor :a11y_standard
 
     attr_accessor :protocol
@@ -116,6 +117,13 @@ module TestCentricity
     attr_accessor :dns
     attr_accessor :db_username
     attr_accessor :db_password
+    attr_accessor :ios_app_path
+    attr_accessor :ios_ipa_path
+    attr_accessor :android_apk_path
+    attr_accessor :default_max_wait_time
+    attr_accessor :deep_link_prefix
+    attr_accessor :ios_bundle_id
+    attr_accessor :android_app_id
 
     def initialize(data)
       @protocol      = data['PROTOCOL']
@@ -133,6 +141,12 @@ module TestCentricity
       @dns	         = data['DNS']
       @db_username   = data['DB_USERNAME']
       @db_password   = data['DB_PASSWORD']
+      @ios_app_path  = data['IOS_APP_PATH']
+      @ios_ipa_path  = data['IOS_IPA_PATH']
+      @android_apk_path = data['ANDROID_APK_PATH']
+      @deep_link_prefix = data['DEEP_LINK_PREFIX']
+      @ios_bundle_id    = data['IOS_BUNDLE_ID']
+      @android_app_id   = data['ANDROID_APP_ID']
 
       url = @hostname.blank? ? "#{@base_url}#{@append}" : "#{@hostname}/#{@base_url}#{@append}"
       @app_host = if @user_id.blank? || @password.blank?
@@ -144,6 +158,45 @@ module TestCentricity
       super
     end
 
+    def self.driver_state
+      {
+        driver_name:        @driver_name,
+        driver:             @driver,
+        app_host:           @app_host,
+        browser:            @browser,
+        browser_size:       @browser_size,
+        headless:           @headless,
+        os:                 @os,
+        device:             @device,
+        device_name:        @device_name,
+        device_type:        @device_type,
+        device_os:          @device_os,
+        device_os_version:  @device_os_version,
+        device_orientation: @device_orientation,
+        platform:           @platform,
+        grid:               @grid,
+        tunneling:          @tunneling
+      }
+    end
+
+    def self.restore_driver_state(driver_state)
+      @driver = driver_state[:driver]
+      @app_host = driver_state[:app_host]
+      @browser = driver_state[:browser]
+      @browser_size = driver_state[:browser_size]
+      @headless = driver_state[:headless]
+      @os = driver_state[:os]
+      @device = driver_state[:device]
+      @device_name = driver_state[:device_name]
+      @device_type = driver_state[:device_type]
+      @device_os = driver_state[:device_os]
+      @device_os_version = driver_state[:device_os_version]
+      @device_orientation = driver_state[:device_orientation]
+      @platform = driver_state[:platform]
+      @grid = driver_state[:grid]
+      @tunneling = driver_state[:tunneling]
+    end
+
     def self.app_host
       @app_host
     end
@@ -188,6 +241,16 @@ module TestCentricity
       end
     end
 
+    def self.default_max_wait_time=(timeout)
+      @default_max_wait_time = timeout
+
+      Capybara.default_max_wait_time = timeout if driver == :webdriver
+    end
+
+    def self.default_max_wait_time
+      @default_max_wait_time
+    end
+
     def self.browser=(browser)
       @browser = browser.downcase.to_sym
     end
@@ -249,7 +312,8 @@ module TestCentricity
     end
 
     def self.device_type=(type)
-      @device_type = type.downcase.to_sym
+      type = type.downcase.to_sym if type.is_a?(String)
+      @device_type = type
     end
 
     def self.device_type
@@ -265,7 +329,8 @@ module TestCentricity
     end
 
     def self.device_os=(os)
-      @device_os = os.downcase.to_sym
+      os = os.downcase.to_sym if os.is_a?(String)
+      @device_os = os
     end
 
     def self.device_os
@@ -289,13 +354,22 @@ module TestCentricity
     end
 
     def self.device_orientation=(orientation)
-      @device_orientation = orientation.downcase.to_sym
+      orientation = orientation.downcase.to_sym if orientation.is_a?(String)
+      @device_orientation = orientation
     end
 
     def self.device_orientation
       @device_orientation
     end
 
+    def self.screen_size=(size)
+      @screen_size = size
+    end
+
+    def self.screen_size
+      @screen_size
+    end
+
     def self.driver=(type)
       @driver = type
     end
@@ -304,6 +378,15 @@ module TestCentricity
       @driver
     end
 
+    def self.driver_name=(name)
+      name = name.downcase.to_sym if name.is_a?(String)
+      @driver_name = name
+    end
+
+    def self.driver_name
+      @driver_name
+    end
+
     def self.grid=(type)
       @grid = type
     end
@@ -398,15 +481,15 @@ module TestCentricity
 
     def self.report_header
       report_header = "\n<b><u>TEST ENVIRONMENT</u>:</b> #{ENV['TEST_ENVIRONMENT']}\n"\
-      "  <b>Browser:</b>\t #{Environ.browser.capitalize}\n"
-      report_header = "#{report_header}  <b>Device:</b>\t #{Environ.device_name}\n" if Environ.device_name
-      report_header = "#{report_header}  <b>Device OS:</b>\t #{Environ.device_os} #{Environ.device_os_version}\n" if Environ.device_os
-      report_header = "#{report_header}  <b>Device type:</b>\t #{Environ.device_type}\n" if Environ.device_type
-      report_header = "#{report_header}  <b>Driver:</b>\t #{Environ.driver}\n" if Environ.driver
-      report_header = "#{report_header}  <b>Grid:</b>\t\t #{Environ.grid}\n" if Environ.grid
-      report_header = "#{report_header}  <b>OS:</b>\t\t #{Environ.os}\n" if Environ.os
-      report_header = "#{report_header}  <b>Locale:</b>\t #{Environ.locale}\n" if Environ.locale
-      report_header = "#{report_header}  <b>Language:</b>\t #{Environ.language}\n" if Environ.language
+      "  <b>Browser:</b>\t #{@browser.capitalize}\n"
+      report_header = "#{report_header}  <b>Device:</b>\t #{@device_name}\n" if @device_name
+      report_header = "#{report_header}  <b>Device OS:</b>\t #{@device_os} #{@device_os_version}\n" if @device_os
+      report_header = "#{report_header}  <b>Device type:</b>\t #{@device_type}\n" if @device_type
+      report_header = "#{report_header}  <b>Driver:</b>\t #{@driver}\n" if @driver
+      report_header = "#{report_header}  <b>Grid:</b>\t\t #{@grid}\n" if @grid
+      report_header = "#{report_header}  <b>OS:</b>\t\t #{@os}\n" if @os
+      report_header = "#{report_header}  <b>Locale:</b>\t #{@locale}\n" if @locale
+      report_header = "#{report_header}  <b>Language:</b>\t #{@language}\n" if @language
       report_header = "#{report_header}  <b>Country:</b>\t #{ENV['COUNTRY']}\n" if ENV['COUNTRY']
       report_header = "#{report_header}  <b>WCAG Accessibility Standard:</b>\t #{ENV['ACCESSIBILITY_STANDARD']}\n" if ENV['ACCESSIBILITY_STANDARD']
       "#{report_header}\n\n"

data/lib/testcentricity_web/exception_queue_helper.rb

@@ -102,6 +102,8 @@ module TestCentricity
                          "#{expected.split.each{ |expected| expected.capitalize! }.join(' ')}"
                        end
             enqueue_assert_equal(expected, actual, error_msg)
+          else
+            raise "#{key} is not a valid comparison key"
           end
         end
       else
@@ -119,17 +121,14 @@ module TestCentricity
       timestamp = Time.now.strftime('%Y%m%d%H%M%S%L')
       filename = "Screenshot-#{timestamp}.png"
       path = File.join Dir.pwd, 'reports/screenshots/', filename
-      # highlight the active UI element prior to taking a screenshot
+      # scroll into view and highlight the active UI element prior to taking a screenshot
       unless @active_ui_element.nil? || @mru_ui_element == @active_ui_element
+        @active_ui_element.scroll_to(:bottom)
         @active_ui_element.highlight(0)
         @mru_ui_element = @active_ui_element
       end
       # take screenshot
-      if Environ.driver == :appium
-        AppiumConnect.take_screenshot(path)
-      else
-        Capybara.save_screenshot path
-      end
+      Capybara.save_screenshot path
       # unhighlight the active UI element
       @mru_ui_element.unhighlight unless @mru_ui_element.blank?
       # add screenshot to queue

data/lib/testcentricity_web/version.rb

@@ -1,3 +1,3 @@
 module TestCentricityWeb
-  VERSION = '4.3.1'
+  VERSION = '4.4.0'
 end

data/lib/testcentricity_web/web_core/page_object.rb

@@ -12,19 +12,19 @@ module TestCentricity
     #   element :settings_item, 'a#userPreferencesTrigger'
     #
     def self.element(element_name, locator)
-      define_page_element(element_name, TestCentricity::UIElement, locator)
+      define_page_element(element_name, TestCentricity::Elements::UIElement, locator)
     end
 
     # Declare and instantiate a collection of generic UI Elements for this page object.
     #
     # @param element_hash [Hash] names of UI objects (as a symbol) and CSS selectors or XPath expressions that uniquely identifies objects
     # @example
-    #   elements  profile_item:  'a#profile',
-    #             settings_item: 'a#userPreferencesTrigger',
-    #             log_out_item:  'a#logout'
+    #   elements profile_item:  'a#profile',
+    #            settings_item: 'a#userPreferencesTrigger',
+    #            log_out_item:  'a#logout'
     #
     def self.elements(element_hash)
-      element_hash.each(&method(:element))
+      element_hash.each_pair { |element_name, locator| element(element_name, locator) }
     end
 
     # Declare and instantiate a single button UI Element for this page object.
@@ -36,7 +36,7 @@ module TestCentricity
     #   button :login_button,    "//input[@id='submit_button']"
     #
     def self.button(element_name, locator)
-      define_page_element(element_name, TestCentricity::Button, locator)
+      define_page_element(element_name, TestCentricity::Elements::Button, locator)
     end
 
     # Declare and instantiate a collection of buttons for this page object.
@@ -48,7 +48,7 @@ module TestCentricity
     #             cancel_button:      'button#cancel'
     #
     def self.buttons(element_hash)
-      element_hash.each(&method(:button))
+      element_hash.each_pair { |element_name, locator| button(element_name, locator) }
     end
 
     # Declare and instantiate a single text field UI Element for this page object.
@@ -60,21 +60,20 @@ module TestCentricity
     #   textfield :password_field, 'input#consumer_password'
     #
     def self.textfield(element_name, locator)
-      define_page_element(element_name, TestCentricity::TextField, locator)
+      define_page_element(element_name, TestCentricity::Elements::TextField, locator)
     end
 
     # Declare and instantiate a collection of text fields for this page object.
     #
     # @param element_hash [Hash] names of text fields (as a symbol) and CSS selectors or XPath expressions that uniquely identifies text fields
     # @example
-    #       textfields  name_field:  'input#Name',
-    #                   title_field: 'input#Title',
-    #                   phone_field: 'input#PhoneNumber',
-    #                   fax_field:   'input#FaxNumber',
-    #                   email_field: 'input#Email'
+    #       textfields name_field:  'input#Name',
+    #                  title_field: 'input#Title',
+    #                  phone_field: 'input#PhoneNumber',
+    #                  email_field: 'input#Email'
     #
     def self.textfields(element_hash)
-      element_hash.each(&method(:textfield))
+      element_hash.each_pair { |element_name, locator| textfield(element_name, locator) }
     end
 
     # Declare and instantiate a single range input UI Element for this page object.
@@ -86,7 +85,7 @@ module TestCentricity
     #   range :points_slider, 'input#points'
     #
     def self.range(element_name, locator)
-      define_page_element(element_name, TestCentricity::Range, locator)
+      define_page_element(element_name, TestCentricity::Elements::Range, locator)
     end
 
     # Declare and instantiate a collection of range inputs for this page object.
@@ -97,7 +96,7 @@ module TestCentricity
     #              risk_slider:   'input#risk_percentage'
     #
     def self.ranges(element_hash)
-      element_hash.each(&method(:range))
+      element_hash.each_pair { |element_name, locator| range(element_name, locator) }
     end
 
     # Declare and instantiate a single checkbox UI Element for this page object.
@@ -109,20 +108,20 @@ module TestCentricity
     #   checkbox :accept_terms_checkbox, 'input#accept_terms_conditions'
     #
     def self.checkbox(element_name, locator)
-      define_page_element(element_name, TestCentricity::CheckBox, locator)
+      define_page_element(element_name, TestCentricity::Elements::CheckBox, locator)
     end
 
     # Declare and instantiate a collection of checkboxes for this page object.
     #
     # @param element_hash [Hash] names of checkboxes (as a symbol) and CSS selectors or XPath expressions that uniquely identifies checkboxes
     # @example
-    #       checkboxes  hazmat_certified_check: 'input#hazmatCertified',
-    #                   epa_certified_check:    'input#epaCertified',
-    #                   dhs_certified_check:    'input#homelandSecurityCertified',
-    #                   carb_compliant_check:   'input#carbCompliant'
+    #       checkboxes hazmat_certified_check: 'input#hazmatCertified',
+    #                  epa_certified_check:    'input#epaCertified',
+    #                  dhs_certified_check:    'input#homelandSecurityCertified',
+    #                  carb_compliant_check:   'input#carbCompliant'
     #
     def self.checkboxes(element_hash)
-      element_hash.each(&method(:checkbox))
+      element_hash.each_pair { |element_name, locator| checkbox(element_name, locator) }
     end
 
     # Declare and instantiate a single radio button UI Element for this page object.
@@ -134,20 +133,20 @@ module TestCentricity
     #   radio :decline_terms_radio, '#decline_terms_conditions'
     #
     def self.radio(element_name, locator)
-      define_page_element(element_name, TestCentricity::Radio, locator)
+      define_page_element(element_name, TestCentricity::Elements::Radio, locator)
     end
 
     # Declare and instantiate a collection of radio buttons for this page object.
     #
     # @param element_hash [Hash] names of radio buttons (as a symbol) and CSS selectors or XPath expressions that uniquely identifies radio buttons
     # @example
-    #       radios  visa_radio:       'input#payWithVisa',
-    #               mastercard_radio: 'input#payWithMastercard',
-    #               discover_radio:   'input#payWithDiscover',
-    #               amex_radio:       'input#payWithAmEx'
+    #       radios visa_radio:       'input#payWithVisa',
+    #              mastercard_radio: 'input#payWithMastercard',
+    #              discover_radio:   'input#payWithDiscover',
+    #              amex_radio:       'input#payWithAmEx'
     #
     def self.radios(element_hash)
-      element_hash.each(&method(:radio))
+      element_hash.each_pair { |element_name, locator| radio(element_name, locator) }
     end
 
     # Declare and instantiate a single label UI Element for this page object.
@@ -159,11 +158,18 @@ module TestCentricity
     #   label :rollup_price_label, "//div[contains(@id, 'Rollup Item Price')]"
     #
     def self.label(element_name, locator)
-      define_page_element(element_name, TestCentricity::Label, locator)
+      define_page_element(element_name, TestCentricity::Elements::Label, locator)
     end
 
+    # Declare and instantiate a collection of labels for this page object.
+    #
+    # @param element_hash [Hash] names of labels (as a symbol) and CSS selectors or XPath expressions that uniquely identifies labels
+    # @example
+    #       labels username_label: 'label#username',
+    #              password_label: 'label#password'
+    #
     def self.labels(element_hash)
-      element_hash.each(&method(:label))
+      element_hash.each_pair { |element_name, locator| label(element_name, locator) }
     end
 
     # Declare and instantiate a single link UI Element for this page object.
@@ -175,11 +181,11 @@ module TestCentricity
     #   link :shopping_basket_link, "//a[@href='shopping_basket']"
     #
     def self.link(element_name, locator)
-      define_page_element(element_name, TestCentricity::Link, locator)
+      define_page_element(element_name, TestCentricity::Elements::Link, locator)
     end
 
     def self.links(element_hash)
-      element_hash.each(&method(:link))
+      element_hash.each_pair { |element_name, locator| link(element_name, locator) }
     end
 
     # Declare and instantiate a single table UI Element for this page object.
@@ -190,11 +196,11 @@ module TestCentricity
     #   table :payments_table, "//table[@class='payments_table']"
     #
     def self.table(element_name, locator)
-      define_page_element(element_name, TestCentricity::Table, locator)
+      define_page_element(element_name, TestCentricity::Elements::Table, locator)
     end
 
     def self.tables(element_hash)
-      element_hash.each(&method(:table))
+      element_hash.each_pair { |element_name, locator| table(element_name, locator) }
     end
 
     # Declare and instantiate a single select list UI Element for this page object.
@@ -206,11 +212,11 @@ module TestCentricity
     #   selectlist :gender_select,     "//select[@id='customer_gender']"
     #
     def self.selectlist(element_name, locator)
-      define_page_element(element_name, TestCentricity::SelectList, locator)
+      define_page_element(element_name, TestCentricity::Elements::SelectList, locator)
     end
 
     def self.selectlists(element_hash)
-      element_hash.each(&method(:selectlist))
+      element_hash.each_pair { |element_name, locator| selectlist(element_name, locator) }
     end
 
     # Declare and instantiate a single list UI Element for this page object.
@@ -221,11 +227,11 @@ module TestCentricity
     #   list :x_axis_list, 'g.x-axis'
     #
     def self.list(element_name, locator)
-      define_page_element(element_name, TestCentricity::List, locator)
+      define_page_element(element_name, TestCentricity::Elements::List, locator)
     end
 
     def self.lists(element_hash)
-      element_hash.each(&method(:list))
+      element_hash.each_pair { |element_name, locator| list(element_name, locator) }
     end
 
     # Declare and instantiate an single image UI Element for this page object.
@@ -237,11 +243,11 @@ module TestCentricity
     #   image :corporate_logo_image, "//img[@alt='MyCompany_logo']"
     #
     def self.image(element_name, locator)
-      define_page_element(element_name, TestCentricity::Image, locator)
+      define_page_element(element_name, TestCentricity::Elements::Image, locator)
     end
 
     def self.images(element_hash)
-      element_hash.each(&method(:image))
+      element_hash.each_pair { |element_name, locator| image(element_name, locator) }
     end
 
     # Declare and instantiate a single HTML5 video UI Element for this page object.
@@ -252,11 +258,11 @@ module TestCentricity
     #   video :video_player, 'video#my_video_player'
     #
     def self.video(element_name, locator)
-      define_page_element(element_name, TestCentricity::Video, locator)
+      define_page_element(element_name, TestCentricity::Elements::Video, locator)
     end
 
     def self.videos(element_hash)
-      element_hash.each(&method(:video))
+      element_hash.each_pair { |element_name, locator| video(element_name, locator) }
     end
 
     # Declare and instantiate a single HTML5 audio UI Element for this page object.
@@ -267,11 +273,11 @@ module TestCentricity
     #   audio :audio_player, 'audio#my_audio_player'
     #
     def self.audio(element_name, locator)
-      define_page_element(element_name, TestCentricity::Audio, locator)
+      define_page_element(element_name, TestCentricity::Elements::Audio, locator)
     end
 
     def self.audios(element_hash)
-      element_hash.each(&method(:audio))
+      element_hash.each_pair { |element_name, locator| audio(element_name, locator) }
     end
 
     # Declare and instantiate a single File Field UI Element for this page object.
@@ -282,11 +288,11 @@ module TestCentricity
     #   filefield :attach_file, 's_SweFileName'
     #
     def self.filefield(element_name, locator)
-      define_page_element(element_name, TestCentricity::FileField, locator)
+      define_page_element(element_name, TestCentricity::Elements::FileField, locator)
     end
 
     def self.filefields(element_hash)
-      element_hash.each(&method(:filefield))
+      element_hash.each_pair { |element_name, locator| filefield(element_name, locator) }
     end
 
     # Instantiate a single PageSection object for this page object.
@@ -306,9 +312,7 @@ module TestCentricity
     end
 
     def self.sections(section_hash)
-      section_hash.each do |section_name, class_name|
-        section(section_name, class_name)
-      end
+      section_hash.each_pair { |section_name, class_name| section(section_name, class_name) }
     end
 
     def open_portal

data/lib/testcentricity_web/web_core/page_objects_helper.rb

@@ -163,26 +163,27 @@ module TestCentricity
                      ui_object.get_group_count
                    when :group_headings
                      ui_object.get_group_headings
-                   when :all_items, :all_list_items
-                     ui_object.get_all_list_items
-                   when :all_items_count
-                     ui_object.get_all_items_count
                    when :column_headers
                      ui_object.get_header_columns
                    when :count, :count_visible
                      ui_object.count(visible = true)
-                   when :count_all
-                     ui_object.count(visible = :all)
+                   when :all_items, :all_list_items
+                     ui_object.get_all_list_items
+                   when :all_items_count
+                     ui_object.get_all_items_count
                    when :style
                      ui_object.style
                    when :href
                      ui_object.href
                    when :role
                      ui_object.role
-                   when :aria_label
-                     ui_object.aria_label
                    when :aria_disabled
                      ui_object.aria_disabled?
+                   # :nocov:
+                   when :count_all
+                     ui_object.count(visible = :all)
+                   when :aria_label
+                     ui_object.aria_label
                    when :tabindex
                      ui_object.tabindex
                    when :aria_labelledby
@@ -243,6 +244,7 @@ module TestCentricity
                      ui_object.aria_multiselectable?
                    when :content_editable
                      ui_object.content_editable?
+                   # :nocov:
                    when :validation_message
                      ui_object.validation_message
                    when :badInput
@@ -283,8 +285,12 @@ module TestCentricity
                            ui_object.get_attribute(value)
                          when :native_attribute
                            ui_object.get_native_attribute(value)
+                         else
+                           raise "#{key} is not a valid property key"
                          end
                        end
+                     else
+                       raise "#{property} is not a valid property"
                      end
                    end
           error_msg = if ui_object.respond_to?(:get_name)
@@ -295,8 +301,8 @@ module TestCentricity
           ExceptionQueue.enqueue_comparison(ui_object, state, actual, error_msg)
         end
       end
-    rescue ObjectNotFoundError => e
-      ExceptionQueue.enqueue_exception(e.message)
+    rescue ObjectNotFoundError => error
+      ExceptionQueue.enqueue_exception(error.message)
     ensure
       error_msg = "#{fail_message}\nPage URL = #{URI.parse(current_url)}"
       ExceptionQueue.post_exceptions(error_msg)
@@ -388,8 +394,11 @@ module TestCentricity
       page.driver.browser.action.send_keys(key).perform
       sleep(0.5)
       focused_obj = page.driver.browser.switch_to.active_element
+      expected_element.reset_mru_cache
       expected_obj, = expected_element.find_element(visible = :all)
-      raise "Expected element '#{expected_element.get_name}' to have focus but found '#{focused_obj[:id]} is focused instead'" unless focused_obj == expected_obj.native
+      unless focused_obj == expected_obj.native
+        raise "Expected element '#{expected_element.get_name}' to have focus but found '#{focused_obj[:id]} is focused instead'"
+      end
 
       puts "Element '#{expected_element.get_name}' is focused as expected"
       end