testa_appium_driver 0.1.21 → 0.1.22

data/lib/testa_appium_driver/driver.rb

@@ -0,0 +1,338 @@
+# frozen_string_literal: true
+
+#require 'em/pure_ruby'
+require 'appium_lib_core'
+
+require_relative 'common/bounds'
+require_relative 'common/exceptions/strategy_mix_exception'
+require_relative 'common/helpers'
+require_relative 'common/locator'
+require_relative 'common/scroll_actions'
+require_relative 'common/selenium_element'
+
+module ::TestaAppiumDriver
+  class Driver
+    include Helpers
+
+    # @return [::Appium::Core::Base::Driver] the ruby_lib_core appium driver
+    attr_accessor :driver
+
+    # @return [String] iOS or Android
+    attr_reader :device
+
+    # @return [String] driver automation name (uiautomator2 or xcuitest)
+    attr_reader :automation_name
+
+    # custom options
+    # - default_find_strategy: default strategy to be used for finding elements. Available strategies :uiautomator or :xpath
+    # - default_scroll_strategy: default strategy to be used for scrolling. Available strategies: :uiautomator(android only), :w3c
+    def initialize(opts = {})
+      @testa_opts = opts[:testa_appium_driver] || {}
+
+      core = Appium::Core.for(opts)
+      @driver = core.start_driver
+      @automation_name = @driver.capabilities["automationName"].downcase.to_sym
+      @device = @driver.capabilities.platform_name.downcase.to_sym
+
+      extend_for(@device, @automation_name)
+
+      handle_testa_opts
+
+      invalidate_cache
+
+      #disable_wait_for_idle
+      #disable_implicit_wait
+
+      ::Appium::Core::Element.set_driver(self, @driver.capabilities["udid"])
+    end
+
+
+    # invalidates current find_element cache
+    def invalidate_cache
+      @cache = {
+        strategy: nil,
+        selector: nil,
+        element: nil,
+        from_element: nil,
+        time: Time.at(0)
+      }
+    end
+
+
+
+
+    # Executes the find_element with the resolved locator strategy and selector. Find_element might be skipped if cache is hit.
+    # Cache stores last executed find_element with given selector, strategy and from_element. If given values are the same within
+    # last 5 seconds element is retrieved from cache.
+    # @param [TestaAppiumDriver::Locator, TestaAppiumDriver::Driver] from_element element from which start the search
+    # @param [Boolean] single fetch single or multiple results
+    # @param [Array<Hash>] strategies_and_selectors array of usable strategies and selectors
+    # @param [Boolean] skip_cache to skip checking and storing cache
+    # @return [Selenium::WebDriver::Element, Array] element is returned if single is true, array otherwise
+    def execute(from_element, single, strategies_and_selectors, skip_cache: false, ignore_implicit_wait: false)
+
+      # if user wants to wait for element to exist, he can use wait_until_present
+      start_time = Time.now.to_f
+      ss_index = 0
+
+
+
+
+      # resolve from_element unique id, so that we can cache it properly
+      from_element_id = from_element.instance_of?(TestaAppiumDriver::Locator) ? from_element.strategies_and_selectors : nil
+
+      begin
+        begin
+          ss = strategies_and_selectors[ss_index % strategies_and_selectors.count]
+        rescue ZeroDivisionError
+          puts "aa"
+        end
+        ss_index +=1
+
+        puts "Executing #{from_element_id ? "from #{from_element.strategy}: #{from_element.strategies_and_selectors} => " : ""}#{ss.keys[0]}: #{ss.values[0]}"
+
+        if @cache[:selector] != ss.values[0] || # cache miss, selector is different
+          @cache[:time] + 5 <= Time.now || # cache miss, older than 5 seconds
+          @cache[:strategy] != ss.keys[0] || # cache miss, different find strategy
+          @cache[:from_element_id] != from_element_id || # cache miss, search is started from different element
+          skip_cache # cache is skipped
+
+          if ss.keys[0] == FIND_STRATEGY_IMAGE
+            set_find_by_image_settings(ss.values[0].dup)
+            if single
+              execute_result = from_element.find_element_by_image(ss.values[0][:image])
+            else
+              execute_result = from_element.find_elements_by_image(ss.values[0][:image])
+            end
+            restore_set_by_image_settings
+          else
+            if single
+              execute_result = from_element.find_element(ss)
+            else
+              execute_result = from_element.find_elements(ss)
+            end
+          end
+
+
+
+          unless skip_cache
+            @cache[:selector] = ss.values[0]
+            @cache[:strategy] = ss.keys[0]
+            @cache[:time] = Time.now
+            @cache[:from_element_id] = from_element_id
+            @cache[:element] = execute_result
+          end
+        else
+          # this is a cache hit, use the element from cache
+          execute_result = @cache[:element]
+          puts "Using cache from #{@cache[:time].strftime("%H:%M:%S.%L")}, strategy: #{@cache[:strategy]}"
+        end
+      rescue => e
+        #if (start_time + @implicit_wait_ms/1000 < Time.now.to_f && !ignore_implicit_wait) || ss_index < strategies_and_selectors.count
+        if ss_index < strategies_and_selectors.count
+          sleep EXISTS_WAIT if ss_index >= strategies_and_selectors.count
+          retry
+        else
+          raise e
+        end
+      end
+
+      execute_result
+    end
+
+    # method missing is used to forward methods to the actual appium driver
+    # after the method is executed, find element cache is invalidated
+    def method_missing(method, *args, &block)
+      r = @driver.send(method, *args, &block)
+      invalidate_cache
+      r
+    end
+
+    # disables implicit wait
+    def disable_implicit_wait
+      @implicit_wait_ms = @driver.get_timeouts["implicit"].to_i
+      @implicit_wait_ms = @implicit_wait_ms/1000 if @implicit_wait_ms > 100000
+      @implicit_wait_uiautomator_ms = @driver.get_settings["waitForSelectorTimeout"]
+      @driver.manage.timeouts.implicit_wait = 0
+      @driver.update_settings({waitForSelectorTimeout: 0})
+    end
+
+    # disables wait for idle, only executed for android devices
+    def disable_wait_for_idle
+      if @device == :android
+        @wait_for_idle_timeout = @driver.settings.get["waitForIdleTimeout"]
+        @driver.update_settings({waitForIdleTimeout: 0})
+      end
+    end
+
+
+    def set_find_by_image_settings(settings)
+      settings.delete(:image)
+      @default_find_image_settings = {}
+      old_settings = @driver.get_settings
+      @default_find_image_settings[:imageMatchThreshold] = old_settings["imageMatchThreshold"]
+      @default_find_image_settings[:fixImageFindScreenshotDims] = old_settings["fixImageFindScreenshotDims"]
+      @default_find_image_settings[:fixImageTemplateSize] = old_settings["fixImageTemplateSize"]
+      @default_find_image_settings[:fixImageTemplateScale] = old_settings["fixImageTemplateScale"]
+      @default_find_image_settings[:defaultImageTemplateScale] = old_settings["defaultImageTemplateScale"]
+      @default_find_image_settings[:checkForImageElementStaleness] = old_settings["checkForImageElementStaleness"]
+      @default_find_image_settings[:autoUpdateImageElementPosition] = old_settings["autoUpdateImageElementPosition"]
+      @default_find_image_settings[:imageElementTapStrategy] = old_settings["imageElementTapStrategy"]
+      @default_find_image_settings[:getMatchedImageResult] = old_settings["getMatchedImageResult"]
+
+      @driver.update_settings(settings)
+    end
+
+    def restore_set_by_image_settings
+      @driver.update_settings(@default_find_image_settings) if @default_find_image_settings
+    end
+
+
+    # @@return [String] current package under test
+    def current_package
+      @driver.current_package
+    end
+
+
+    def window_size
+      @driver.window_size
+    end
+
+    def back
+      @driver.back
+    end
+
+
+    def is_keyboard_shown?
+      @driver.is_keyboard_shown
+    end
+
+    def hide_keyboard
+      @driver.hide_keyboard
+    end
+
+    def home_key
+      @driver.press_keycode(3)
+    end
+
+    def tab_key
+      @driver.press_keycode(61)
+    end
+
+    def dpad_up_key
+      @driver.press_keycode(19)
+    end
+
+    def dpad_down_key
+      @driver.press_keycode(20)
+    end
+
+    def dpad_right_key
+      @driver.press_keycode(22)
+    end
+
+    def dpad_left_key
+      @driver.press_keycode(23)
+    end
+
+    def enter_key
+      @driver.press_keycode(66)
+    end
+
+    def press_keycode(code)
+      @driver.press_keycode(code)
+    end
+
+    def long_press_keycode(code)
+      @driver.long_press_keycode(code)
+    end
+
+    def click(x, y, double: false)
+      ws = driver.window_size
+      window_width = ws.width.to_i
+      window_height = ws.height.to_i
+      if x.kind_of?(Integer)
+        if x < 0
+          x = window_width + x
+        end
+      elsif x.kind_of?(Float) && x <= 1.0 && x >= 0
+        x = window_width*x
+      else
+        raise "x value #{x} not supported. Use integer as pixel or float (0..1) as percentage of screen"
+      end
+
+      if y.kind_of?(Integer)
+        if y < 0
+          y = window_height + y
+        end
+      elsif y.kind_of?(Float) && y <= 1.0 && y >= 0
+        y = window_height*y
+      else
+        raise "y value #{x} not supported. Use integer as pixel or float (0..1) as percentage of screen"
+      end
+
+
+      action_builder = @driver.action
+      f1 = action_builder.add_pointer_input(:touch, "finger1")
+      f1.create_pointer_move(duration: 0, x: x, y: y, origin: ::Selenium::WebDriver::Interactions::PointerMove::VIEWPORT)
+      f1.create_pointer_down(:left)
+      f1.create_pointer_up(:left)
+      if double
+        f1.create_pause(0.1)
+        f1.create_pointer_down(:left)
+        f1.create_pointer_up(:left)
+      end
+      @driver.perform_actions [f1]
+    end
+
+    def double_click(x,y)
+      click(x,y, double: true)
+    end
+
+
+
+    # @return [Array<Selenium::WebDriver::Element] array of 2 elements, the first element without children and the last element without children in the current page
+    def first_and_last_leaf(from_element = @driver)
+      elements = from_element.find_elements(xpath: ".//*[not(*)]")
+      return nil if elements.count == 0
+      [elements[0], elements[-1]]
+    end
+
+    def first_and_last_child(from_element = @driver)
+      elements = from_element.find_elements(xpath: "./*")
+      return nil if elements.count == 0
+
+      [elements[0], elements[-1]]
+    end
+
+    def android?
+      device == :android
+    end
+
+    def ios?
+      device == :ios
+    end
+
+    private
+    def extend_for(device, automation_name)
+      case device
+      when :android
+        case automation_name
+        when :uiautomator2, :espresso, :Espresso
+          require_relative 'android/driver'
+        else
+          raise "Testa appium driver not supported for #{automation_name} automation"
+        end
+      when :ios, :tvos
+        case automation_name
+        when :xcuitest
+          require_relative 'ios/driver'
+        else
+          raise "Testa appium driver not supported for #{automation_name} automation"
+        end
+      else
+        raise "Unknown device #{device}, should be either android, ios or tvos"
+      end
+    end
+  end
+end

data/lib/testa_appium_driver/ios/driver.rb

@@ -0,0 +1,49 @@
+require_relative 'type_selectors'
+require_relative 'locator'
+require_relative 'selenium_element'
+
+module TestaAppiumDriver
+  class Driver
+    include TypeSelectors
+
+
+
+    # @param params [Hash]
+    # @return [TestaAppiumDriver::Locator] first scrollable element
+    def scrollable(params = {})
+      scroll_view(params)
+    end
+
+    # @param params [Hash]
+    # @return [TestaAppiumDriver::Locator] first scrollable element
+    def scrollables(params = {})
+      scroll_views(params)
+    end
+
+    private
+    def handle_testa_opts
+      if @testa_opts[:default_find_strategy].nil?
+        @default_find_strategy = DEFAULT_IOS_FIND_STRATEGY
+      else
+        case @testa_opts[:default_find_strategy].to_sym
+        when FIND_STRATEGY_XPATH
+          @default_find_strategy = @testa_opts[:default_find_strategy].to_sym
+        else
+          raise "Default find strategy #{@testa_opts[:default_find_strategy]} not supported for iOS"
+        end
+      end
+
+
+      if @testa_opts[:default_scroll_strategy].nil?
+        @default_scroll_strategy = DEFAULT_IOS_SCROLL_STRATEGY
+      else
+        case @testa_opts[:default_scroll_strategy].to_sym
+        when SCROLL_STRATEGY_W3C
+          @default_scroll_strategy = @testa_opts[:default_scroll_strategy].to_sym
+        else
+          raise "Default scroll strategy #{@testa_opts[:default_scroll_strategy]} not supported for iOS"
+        end
+      end
+    end
+  end
+end

data/lib/testa_appium_driver/ios/locator/attributes.rb

@@ -0,0 +1,89 @@
+module TestaAppiumDriver
+  module Attributes
+
+    #noinspection RubyNilAnalysis
+    def testa_attribute(name, *args)
+
+      if self.instance_of?(::Selenium::WebDriver::Element) || self.instance_of?(::Appium::Core::Element)
+        @driver = get_driver
+        elements = self
+      else
+        elements = execute(*args)
+      end
+
+
+      if elements.instance_of?(::Selenium::WebDriver::Element) || elements.instance_of?(::Appium::Core::Element)
+        r = elements.send(:attribute, name.to_s)
+        r = TestaAppiumDriver::Bounds.from_ios(r, @driver) if name.to_s == "rect"
+      else
+        r = elements.map { |e| e.send(:attribute, name.to_s) }
+        r.map! { |b| TestaAppiumDriver::Bounds.from_ios(b, @driver) } if name.to_s == "rect"
+      end
+      r
+    end
+
+
+    def accessibility_container(*args)
+      testa_attribute("accessibilityContainer", *args)
+    end
+
+    def accessible?(*args)
+      testa_attribute("accessible", *args).to_s == "true"
+    end
+
+
+    def class_name(*args)
+      testa_attribute("class", *args)
+    end
+
+    def enabled?(*args)
+      testa_attribute("enabled", *args).to_s == "true"
+    end
+
+    def frame(*args)
+      testa_attribute("frame", *args)
+    end
+
+    def index(*args)
+      index = testa_attribute("index", *args)
+      index = "1" if index == "true"
+      index = "0" if index == "false"
+
+      index
+    end
+
+    def label(*args)
+      testa_attribute("label", *args)
+    end
+
+    def name(*args)
+      testa_attribute("name", *args)
+    end
+
+
+    def rect(*args)
+      testa_attribute("rect", *args)
+    end
+
+    def selected?(*args)
+      testa_attribute("selected", *args).to_s == "true"
+    end
+
+    def type(*args)
+      testa_attribute("type", *args)
+    end
+
+    def value(*args)
+      testa_attribute("value", *args)
+    end
+
+    def visible?(*args)
+      testa_attribute("visible", *args).to_s == "true"
+    end
+
+
+    alias_method :bounds, :rect
+    alias_method :text, :label
+  end
+
+end

data/lib/testa_appium_driver/ios/locator.rb

@@ -0,0 +1,73 @@
+require_relative 'locator/attributes'
+
+module ::TestaAppiumDriver
+  class Locator
+    include TypeSelectors
+    include Attributes
+    attr_accessor :class_chain_selector
+
+    def init(params, selectors, single)
+      if is_scrollable_selector?(selectors, single)
+        @scroll_orientation = :vertical
+
+        if !params[:top].nil? || !params[:bottom].nil? || !params[:right].nil? || !params[:left].nil?
+          @scroll_deadzone = {}
+          @scroll_deadzone[:top] = params[:top].to_f unless params[:top].nil?
+          @scroll_deadzone[:bottom] = params[:bottom].to_f unless params[:bottom].nil?
+          @scroll_deadzone[:right] = params[:right].to_f unless params[:right].nil?
+          @scroll_deadzone[:left] = params[:left].to_f unless params[:left].nil?
+        end
+
+        params[:scrollable_locator] = self.dup
+      end
+
+      @class_chain_selector = hash_to_class_chain(selectors, single)
+
+
+      @scrollable_locator = params[:scrollable_locator] if params[:scrollable_locator]
+    end
+
+
+    # @return [Array] returns 2 elements. The first is the resolved find element strategy and the second is the resolved selector
+    def strategies_and_selectors
+      ss = []
+      if @can_use_id_strategy
+        ss.push({"#{FIND_STRATEGY_NAME}": @can_use_id_strategy})
+      end
+      ss.push({"#{FIND_STRATEGY_CLASS_CHAIN}": @class_chain_selector}) if @strategy.nil? || @strategy == FIND_STRATEGY_CLASS_CHAIN
+      ss.push({"#{FIND_STRATEGY_XPATH}": @xpath_selector}) if @strategy.nil? || @strategy == FIND_STRATEGY_XPATH
+      ss.push({"#{FIND_STRATEGY_IMAGE}": @image_selector}) if @strategy == FIND_STRATEGY_IMAGE
+      ss
+    end
+
+
+
+    # @return [Locator] new child locator element
+    def add_child_selector(params)
+      params, selectors = extract_selectors_from_params(params)
+      single = params[:single]
+      raise "Cannot add child selector to Array" if single && !@single
+
+      locator = self.dup
+      locator.can_use_id_strategy = false
+      add_xpath_child_selectors(locator, selectors, single)
+      if @strategy.nil? || @strategy == FIND_STRATEGY_CLASS_CHAIN
+        add_class_chain_child_selectors(locator, selectors, single)
+      end
+
+      if is_scrollable_selector?(selectors, single)
+        locator.scrollable_locator.scroll_orientation = :vertical
+        locator.scrollable_locator = locator
+      end
+
+      locator.last_selector_adjacent = false
+      locator
+    end
+
+
+    def add_class_chain_child_selectors(locator, selectors, single)
+      locator.single = false unless single # switching from single result to multiple
+      locator.class_chain_selector += "/" + hash_to_class_chain(selectors, single)
+    end
+  end
+end

data/lib/testa_appium_driver/ios/selenium_element.rb

@@ -0,0 +1,8 @@
+module ::Appium
+  module Core
+    class Element
+      include TestaAppiumDriver::TypeSelectors
+      include TestaAppiumDriver::Attributes
+    end
+  end
+end