testcentricity 2.3.13

data/lib/testcentricity/app_elements/app_element_helper.rb

@@ -0,0 +1,293 @@
+require 'test/unit'
+
+module TestCentricity
+  class AppUIElement
+    include Test::Unit::Assertions
+
+    attr_reader   :parent, :strategy, :locator, :context, :type, :name
+    attr_accessor :mru_element, :mru_name
+
+    def initialize(name, parent, strategy, locator, context)
+      @name        = name
+      @parent      = parent
+      @strategy    = strategy.to_sym
+      @locator     = locator
+      @context     = context
+      @type        = nil
+    end
+
+    def get_object_type
+      @type
+    end
+
+    def get_locator
+      [@strategy.to_sym, @locator]
+    end
+
+    def get_name
+      @name
+    end
+
+    def click
+      obj = element
+      object_not_found_exception(obj)
+      obj.click
+    end
+
+    def tap
+      obj = element
+      object_not_found_exception(obj)
+      x = obj.location.x
+      y = obj.location.y
+      tap_action = Appium::TouchAction.new.tap(element: obj, x: x, y: y)
+      tap_action.perform
+    end
+
+    def double_tap
+      obj = element
+      object_not_found_exception(obj)
+      x = obj.location.x
+      y = obj.location.y
+      tap_action = Appium::TouchAction.new.double_tap(element: obj, x: x, y: y)
+      tap_action.perform
+    end
+
+    def set(value)
+      obj = element
+      object_not_found_exception(obj)
+      if value.is_a?(Array)
+        obj.send_keys(value[0])
+        obj.send_keys(value[1])
+      elsif value.is_a?(String)
+        obj.send_keys(value)
+      end
+    end
+
+    def send_keys(value)
+      obj = element
+      object_not_found_exception(obj)
+      obj.send_keys(value)
+    end
+
+    def clear
+      obj = element
+      object_not_found_exception(obj)
+      obj.clear
+    end
+
+    def get_value
+      obj = element
+      object_not_found_exception(obj)
+      obj.value
+    end
+
+    def get_caption
+      obj = element
+      object_not_found_exception(obj)
+      if obj.tag_name == 'XCUIElementTypeNavigationBar'
+        obj.attribute('name')
+      else
+        obj.attribute('label')
+      end
+    end
+
+    def exists?
+      begin
+        element.displayed?
+      rescue
+        false
+      end
+    end
+
+    def visible?
+      if exists?
+        element.displayed?
+      else
+        false
+      end
+    end
+
+    def hidden?
+      !visible?
+    end
+
+    def enabled?
+      obj = element
+      object_not_found_exception(obj)
+      obj.enabled?
+    end
+
+    def disabled?
+      !enabled?
+    end
+
+    def selected?
+      obj = element
+      object_not_found_exception(obj)
+      obj.selected?
+    end
+
+    def tag_name
+      obj = element
+      object_not_found_exception(obj)
+      obj.tag_name
+    end
+
+    def get_attribute(attrib)
+      obj = element
+      object_not_found_exception(obj)
+      obj.attribute(attrib)
+    end
+
+    # Wait until the object exists, or until the specified wait time has expired. If the wait time is nil, then the wait
+    # time will be Environ.default_max_wait_time.
+    #
+    # @param seconds [Integer or Float] wait time in seconds
+    # @example
+    #   run_button.wait_until_exists(0.5)
+    #
+    def wait_until_exists(seconds = nil)
+      timeout = seconds.nil? ? Environ.default_max_wait_time : seconds
+      wait = Selenium::WebDriver::Wait.new(timeout: timeout)
+      wait.until { exists? }
+    rescue
+      raise "Could not find UI #{object_ref_message} after #{timeout} seconds" unless exists?
+    end
+
+    # Wait until the object no longer exists, or until the specified wait time has expired. If the wait time is nil, then
+    # the wait time will be Environ.default_max_wait_time.
+    #
+    # @param seconds [Integer or Float] wait time in seconds
+    # @example
+    #   logout_button.wait_until_gone(5)
+    #
+    def wait_until_gone(seconds = nil)
+      timeout = seconds.nil? ? Environ.default_max_wait_time : seconds
+      wait = Selenium::WebDriver::Wait.new(timeout: timeout)
+      wait.until { !exists? }
+    rescue
+      raise "UI #{object_ref_message} remained visible after #{timeout} seconds" if exists?
+    end
+
+    # Wait until the object is visible, or until the specified wait time has expired. If the wait time is nil, then the
+    # wait time will be Environ.default_max_wait_time.
+    #
+    # @param seconds [Integer or Float] wait time in seconds
+    # @example
+    #   run_button.wait_until_visible(0.5)
+    #
+    def wait_until_visible(seconds = nil)
+      timeout = seconds.nil? ? Environ.default_max_wait_time : seconds
+      wait = Selenium::WebDriver::Wait.new(timeout: timeout)
+      wait.until { visible? }
+    rescue
+      raise "Could not find UI #{object_ref_message} after #{timeout} seconds" unless visible?
+    end
+
+    # Wait until the object is hidden, or until the specified wait time has expired. If the wait time is nil, then the
+    # wait time will be Environ.default_max_wait_time.
+    #
+    # @param seconds [Integer or Float] wait time in seconds
+    # @example
+    #   run_button.wait_until_hidden(10)
+    #
+    def wait_until_hidden(seconds = nil)
+      timeout = seconds.nil? ? Environ.default_max_wait_time : seconds
+      wait = Selenium::WebDriver::Wait.new(timeout: timeout)
+      wait.until { hidden? }
+    rescue
+      raise "UI #{object_ref_message} remained visible after #{timeout} seconds" if visible?
+    end
+
+    # Wait until the object's value equals the specified value, or until the specified wait time has expired. If the wait
+    # time is nil, then the wait time will be Environ.default_max_wait_time.
+    #
+    # @param seconds [Integer or Float] wait time in seconds
+    # @example
+    #   card_authorized_label.wait_until_value_is(5, 'Card authorized')
+    #
+    def wait_until_value_is(value, seconds = nil)
+      timeout = seconds.nil? ? Environ.default_max_wait_time : seconds
+      wait = Selenium::WebDriver::Wait.new(timeout: timeout)
+      wait.until { get_value == value }
+    rescue
+      raise "Value of UI #{object_ref_message} failed to equal '#{value}' after #{timeout} seconds" unless get_value == value
+    end
+
+    # Wait until the object's value changes to a different value, or until the specified wait time has expired. If the
+    # wait time is nil, then the wait time will be Environ.default_max_wait_time.
+    #
+    # @param seconds [Integer or Float] wait time in seconds
+    # @example
+    #   basket_grand_total_label.wait_until_value_changes(5)
+    #
+    def wait_until_value_changes(seconds = nil)
+      value = get_value
+      timeout = seconds.nil? ? Environ.default_max_wait_time : seconds
+      wait = Selenium::WebDriver::Wait.new(timeout: timeout)
+      wait.until { get_value != value }
+    rescue
+      raise "Value of UI #{object_ref_message} failed to change from '#{value}' after #{timeout} seconds" if get_value == value
+    end
+
+
+    def scroll_into_view
+      scroll(:down) unless visible?
+    end
+
+    def scroll(direction)
+      execute_script('mobile: scroll', direction: direction.to_s)
+    end
+
+    def swipe(direction)
+      execute_script('mobile: swipe', direction: direction.to_s)
+    end
+
+
+    private
+
+    def element
+      parent_section = @context == :section
+      parent_section ? tries ||= 2 : tries ||= 1
+
+      if parent_section && tries > 1
+        parent_obj = nil
+        locators = @parent.get_locator
+        locators.each do |parent_locator|
+          if parent_obj.nil?
+            parent_obj = find_element(parent_locator[0], parent_locator[1])
+          else
+            parent_obj = parent_obj.find_element(parent_locator[0], parent_locator[1])
+          end
+        end
+
+        puts "Found parent object '#{@parent.get_name}' - #{@parent.get_locator}" if ENV['DEBUG']
+
+
+        obj = parent_obj.find_element(@strategy, @locator)
+
+        puts "Found object '#{@name}' - [:#{@strategy}, #{@locator}]" if ENV['DEBUG']
+
+        obj
+      else
+        obj = find_element(@strategy, @locator)
+
+        puts "Found object '#{@name}' - [:#{@strategy}, #{@locator}]" if ENV['DEBUG']
+
+        obj
+      end
+    rescue
+      retry if (tries -= 1) > 0
+      nil
+    end
+
+    def object_not_found_exception(obj)
+      @type.nil? ? object_type = 'Object' : object_type = @type
+      raise "#{object_type} named '#{@name}' (#{get_locator}) not found" unless obj
+    end
+
+    def object_ref_message
+      "object '#{@name}' (#{get_locator})"
+    end
+  end
+end

data/lib/testcentricity/app_elements/button.rb

@@ -0,0 +1,8 @@
+module TestCentricity
+  class AppButton < AppUIElement
+    def initialize(name, parent, strategy, locator, context)
+      super
+      @type = :button
+    end
+  end
+end

data/lib/testcentricity/app_elements/checkbox.rb

@@ -0,0 +1,20 @@
+module TestCentricity
+  class AppCheckBox < AppUIElement
+    def initialize(name, parent, strategy, locator, context)
+      super
+      @type = :checkbox
+    end
+
+    def checked?
+      element.attribute('checked') == 'true'
+    end
+
+    def check
+      element.click unless checked?
+    end
+
+    def uncheck
+      element.click if checked?
+    end
+  end
+end

data/lib/testcentricity/app_elements/label.rb

@@ -0,0 +1,8 @@
+module TestCentricity
+  class AppLabel < AppUIElement
+    def initialize(name, parent, strategy, locator, context)
+      super
+      @type = :label
+    end
+  end
+end

data/lib/testcentricity/app_elements/list.rb

@@ -0,0 +1,25 @@
+module TestCentricity
+  class AppList < AppUIElement
+    def initialize(name, parent, strategy, locator, context)
+      super
+      @type = :list
+    end
+
+    def get_item_count
+      if Environ.device_os == :ios
+        items = find_elements(class: 'XCUIElementTypeCell')
+      else
+        items = find_elements(class: 'android.widget.FrameLayout')
+      end
+      items.size
+    end
+
+    def get_list_items
+
+    end
+
+    def get_list_item(index)
+
+    end
+  end
+end

data/lib/testcentricity/app_elements/switch.rb

@@ -0,0 +1,20 @@
+module TestCentricity
+  class AppSwitch < AppUIElement
+    def initialize(name, parent, strategy, locator, context)
+      super
+      @type = :switch
+    end
+
+    def on?
+      element.get_value == 1
+    end
+
+    def on
+      element.click unless on?
+    end
+
+    def off
+      element.click if on?
+    end
+  end
+end

data/lib/testcentricity/app_elements/textfield.rb

@@ -0,0 +1,12 @@
+module TestCentricity
+  class AppTextField < AppUIElement
+    def initialize(name, parent, strategy, locator, context)
+      super
+      @type = :textfield
+    end
+
+    def get_placeholder
+      element.text
+    end
+  end
+end

data/lib/testcentricity/browser_helper.rb

@@ -0,0 +1,174 @@
+require 'yaml'
+
+
+module TestCentricity
+  module Browsers
+    include Capybara::DSL
+
+    # Sets the size of the browser window.
+    #
+    # @param resolution [Array] the desired [width, height]
+    # @example
+    #   Browsers.set_browser_window_size([1024, 768])
+    #
+    def self.set_browser_window_size(resolution)
+      resolution = resolution.split(',') if resolution.is_a?(String)
+      window = Capybara.current_session.driver.browser.manage.window
+      window.resize_to(resolution[0], resolution[1])
+      Environ.browser_size = [resolution[0].to_i, resolution[1].to_i]
+    end
+
+    # Maximizes the selenium browser window.
+    #
+    # @example
+    #   Browsers.maximize_browser
+    #
+    def self.maximize_browser
+      window = Capybara.current_session.driver.browser.manage.window
+      window.maximize
+    end
+    # Sets the position of the browser window.
+    #
+    # @param x [Integer] the desired x coordinate
+    # @param y [Integer] the desired y coordinate
+    # @example
+    #   Browsers.set_browser_window_position([100, 300])
+    #
+    def self.set_browser_window_position(x, y)
+      window = Capybara.current_session.driver.browser.manage.window
+      window.move_to(x, y)
+    end
+
+    # Refreshes the selenium browser.
+    #
+    # @example
+    #   Browsers.refresh_browser
+    #
+    def self.refresh_browser
+      Capybara.page.driver.browser.navigate.refresh
+    end
+
+    # Emulates clicking the web browser's Back button. Navigates back by one page on the browser’s history.
+    #
+    # @example
+    #   Browsers.navigate_back
+    #
+    def self.navigate_back
+      Capybara.page.driver.browser.navigate.back
+    end
+
+    # Emulates clicking the web browser's Forward button. Navigates forward by one page on the browser’s history.
+    #
+    # @example
+    #   Browsers.navigate_forward
+    #
+    def self.navigate_forward
+      Capybara.page.driver.browser.navigate.forward
+    end
+
+    def self.switch_to_new_browser_instance
+      Capybara.page.driver.browser.switch_to.window(Capybara.page.driver.browser.window_handles.last)
+    end
+
+    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
+      end
+    end
+
+    def self.num_browser_instances
+      Capybara.page.driver.browser.window_handles.count
+    end
+
+    def self.close_current_browser_instance
+      Capybara.page.driver.browser.close
+      Capybara.page.driver.browser.switch_to.window(Capybara.page.driver.browser.window_handles.last)
+    end
+
+    def self.close_old_browser_instance
+      Capybara.page.driver.browser.switch_to.window(Capybara.page.driver.browser.window_handles.first)
+      Capybara.page.driver.browser.close
+      Capybara.page.driver.browser.switch_to.window(Capybara.page.driver.browser.window_handles.last)
+    end
+
+    def self.close_named_browser_instance(name)
+      Capybara.page.driver.browser.switch_to.window(Capybara.page.driver.find_window(name))
+      Capybara.page.driver.browser.close
+      Capybara.page.driver.browser.switch_to.window(Capybara.page.driver.browser.window_handles.last)
+    end
+
+    def self.suppress_js_alerts
+      Capybara.page.execute_script('window.alert = function() {}')
+    end
+
+    def self.suppress_js_leave_page_modal
+      Capybara.page.execute_script('window.onbeforeunload = null')
+    end
+
+    def self.delete_all_cookies
+      if Capybara.current_driver == :selenium
+        browser = Capybara.current_session.driver.browser
+        if browser.respond_to?(:manage) && browser.manage.respond_to?(:delete_all_cookies)
+          browser.manage.delete_all_cookies
+        else
+          raise 'Could not clear cookies.'
+        end
+      end
+    end
+
+    def self.set_device_orientation(orientation)
+      if Environ.is_mobile? && !Environ.is_device?
+        Browsers.set_browser_window_size(Browsers.browser_size(Environ.browser.to_s, orientation))
+      else
+        puts '***** Cannot change device orientation of desktop web browsers or remote devices *****'
+      end
+    end
+
+    def self.mobile_device_agent(device)
+      device_name = device.gsub(/\s+/, '').downcase.to_sym
+      device = get_devices[device_name]
+      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]
+      name = device[:name]
+      raise "Device '#{device}' is not defined" unless name
+      Environ.device_os = device[:os]
+      Environ.device_type = device[:type]
+      name
+    end
+
+    def self.browser_size(browser, orientation)
+      device_name = browser.gsub(/\s+/, '').downcase.to_sym
+      device = get_devices[device_name]
+      if device
+        width = device[:css_width]
+        height = device[:css_height]
+        default_orientation = device[:default_orientation].to_sym
+        if orientation
+          Environ.device_orientation = orientation
+          orientation.downcase.to_sym == default_orientation ?
+              size = [width, height] :
+              size = [height, width]
+        else
+          Environ.device_orientation = device[:default_orientation]
+          size = [width, height]
+        end
+      else
+        size = [1650, 1000]
+      end
+      size
+    end
+
+    private
+
+    def self.get_devices
+      YAML.load_file File.expand_path('../../devices/devices.yml', __FILE__)
+    end
+  end
+end