testa_appium_driver 0.1.4 → 0.1.8

data/lib/testa_appium_driver/common/locator.rb

@@ -17,6 +17,8 @@ module TestaAppiumDriver
     attr_accessor :last_selector_adjacent
     attr_accessor :can_use_id_strategy
 
+    attr_accessor :image_selector
+
     attr_accessor :from_element
     attr_accessor :scroll_orientation
     attr_accessor :scroll_deadzone
@@ -25,6 +27,8 @@ module TestaAppiumDriver
     attr_accessor :default_find_strategy
     attr_accessor :default_scroll_strategy
 
+    attr_accessor :index_for_multiple
+
 
     # locator parameters are:
     #   single: true or false
@@ -38,12 +42,22 @@ module TestaAppiumDriver
     def initialize(driver, from_element, params = {})
       # @type [TestaAppiumDriver::Driver]
       @driver = driver
+      @index_for_multiple = nil
+      @image_selector = nil
 
       params, selectors = extract_selectors_from_params(params)
       single = params[:single]
 
       @single = single
 
+      if selectors[:image].nil?
+        if from_element.instance_of?(TestaAppiumDriver::Locator) && !from_element.image_selector.nil?
+          raise "Cannot chain non-image selectors to image selectors"
+        end
+      else
+        handle_image_selector(selectors, params)
+      end
+
       selectors[:id] = selectors[:name] unless selectors[:name].nil?
       if from_element.instance_of?(Selenium::WebDriver::Element)
         @xpath_selector = "//*" # to select current element
@@ -57,7 +71,8 @@ module TestaAppiumDriver
       @default_find_strategy = params[:default_find_strategy]
       @default_scroll_strategy = params[:default_scroll_strategy]
 
-      @can_use_id_strategy = selectors.keys.count == 1 && !selectors[:id].nil?
+
+      @can_use_id_strategy = is_only_id_selector?(selectors)
       if @can_use_id_strategy
         if @driver.device == :android
           @can_use_id_strategy = resolve_id(selectors[:id])
@@ -76,33 +91,70 @@ module TestaAppiumDriver
     end
 
 
+
+
+    def is_only_id_selector?(selectors)
+      # since, name and id is the same thing for iOS,
+      if @driver.device == :android
+        selectors.keys.count == 1 && !selectors[:id].nil?
+      else
+        # if it iOS we assign the name to id
+        selectors.keys.count == 2 && !selectors[:id].nil? && selectors[:id] == selectors[:name]
+      end
+    end
+
+
     # method missing is used to fetch the element before executing additional commands like click, send_key, count
     def method_missing(method, *args, &block)
-      execute.send(method, *args, &block)
+      r = execute.send(method, *args, &block)
       @driver.invalidate_cache
+      r
     end
 
 
     # @param [Boolean] skip_cache if true it will skip cache check and store
     # @param [Selenium::WebDriver::Element] force_cache_element, for internal use where we have already the element, and want to execute custom locator methods on it
     # @return [Selenium::WebDriver::Element, Array]
-    def execute(skip_cache: false, force_cache_element: nil)
+    def execute(skip_cache: false, force_cache_element: nil, ignore_implicit_wait: false)
       return force_cache_element unless force_cache_element.nil?
       # if we are looking for current element, then return from_element
       # for example when we have driver.element.elements[1].click
       # elements[2] will be resolved with xpath because we are looking for multiple elements from element
       # and since we are looking for instance 2, [](instance) method will return new "empty locator"
       # we are executing click on that "empty locator" so we have to return the instance 2 of elements for the click
-      if @xpath_selector == "//*/*[1]" && @from_element.instance_of?(Selenium::WebDriver::Element)
+      if @xpath_selector == "//*[1]" && !@from_element.nil? && @image_selector.nil?
+        return @from_element if @from_element.instance_of?(Selenium::WebDriver::Element)
+        return @from_element.execute(skip_cache: skip_cache, force_cache_element: force_cache_element, ignore_implicit_wait: ignore_implicit_wait) if @from_element.instance_of?(TestaAppiumDriver::Locator)
         return @from_element
       end
 
 
 
-      strategy, selector = strategy_and_selector
 
 
-      @driver.execute(@from_element, selector, @single, strategy, @default_find_strategy, skip_cache)
+
+      r = @driver.execute(@from_element, @single, strategies_and_selectors, skip_cache: skip_cache, ignore_implicit_wait: ignore_implicit_wait)
+      r = r[@index_for_multiple] if !@index_for_multiple.nil? && !@single
+      r
+    end
+
+    def when_exists(timeout = nil, &block)
+      timeout = @driver.get_timeouts["implicit"] / 1000 if timeout.nil?
+      found = false
+      begin
+        wait_until_exists(timeout)
+        found = true
+      rescue
+        #ignored
+      end
+      if found
+        if block_given? # block is given
+          block.call(self) # use call to execute the block
+        else # the value of block_argument becomes nil if you didn't give a block
+          # block was not given
+        end
+      end
+      self
     end
 
 
@@ -110,12 +162,8 @@ module TestaAppiumDriver
     # @return [TestaAppiumDriver::Locator]
     def wait_until_exists(timeout = nil)
       timeout = @driver.get_timeouts["implicit"] / 1000 if timeout.nil?
-      start_time = Time.now.to_f
-      until exists?
-        raise "wait until exists timeout exceeded" if start_time + timeout < Time.now.to_f
-        sleep EXISTS_WAIT
-      end
-      self
+      args = {timeout: timeout}
+      _wait(:until, args)
     end
 
 
@@ -123,28 +171,31 @@ module TestaAppiumDriver
     # @return [TestaAppiumDriver::Locator]
     def wait_while_exists(timeout = nil)
       timeout = @driver.get_timeouts["implicit"] / 1000 if timeout.nil?
-      start_time = Time.now.to_f
-      while exists?
-        raise "wait until exists timeout exceeded" if start_time + timeout < Time.now.to_f
-        sleep EXISTS_WAIT
-      end
-      self
+      args = {timeout: timeout}
+      _wait(:while, args)
+    end
+
+
+    def wait_while(timeout = nil, args = {})
+      args[:timeout] = timeout
+      _wait(:while, args)
+    end
+
+    def wait_until(timeout = nil, args = {})
+      args[:timeout] = timeout
+      _wait(:until, args)
     end
 
 
     # all timeouts are disabled before check, and enabled after check
     # @return [boolean] true if it exists in the page regardless if visible or not
     def exists?
-      @driver.disable_wait_for_idle
-      @driver.disable_implicit_wait
       found = true
       begin
-        execute(skip_cache: true)
+        execute(skip_cache: true, ignore_implicit_wait: true)
       rescue StandardError
         found = false
       end
-      @driver.enable_implicit_wait
-      @driver.enable_wait_for_idle
       found
     end
 
@@ -170,15 +221,23 @@ module TestaAppiumDriver
 
     def [](instance)
       raise "Cannot add index selector to non-Array" if @single
-      if ((@strategy.nil? && !@last_selector_adjacent) || @strategy == FIND_STRATEGY_UIAUTOMATOR) && instance >= 0
+      if ((@strategy.nil? && !@last_selector_adjacent && @driver.device == :android) || @strategy == FIND_STRATEGY_UIAUTOMATOR) && instance >= 0
         locator = self.dup
         locator.strategy = FIND_STRATEGY_UIAUTOMATOR
         locator.ui_selector = "#{@ui_selector}.instance(#{instance})"
         locator.single = true
         locator.can_use_id_strategy = false
         locator
+      elsif (@driver.device == :ios && !@last_selector_adjacent && @strategy.nil?) || @strategy == FIND_STRATEGY_CLASS_CHAIN
+        locator = self.dup
+        locator.strategy = FIND_STRATEGY_CLASS_CHAIN
+        locator.class_chain_selector += "[#{instance + 1}]"
+        locator.single = true
+        locator.can_use_id_strategy = false
+        locator
       else
-        from_element = self.execute[instance]
+        from_element = self.dup
+        from_element.index_for_multiple = instance
         params = {}.merge({single: true, scrollable_locator: @scrollable_locator})
         #params[:strategy] = FIND_STRATEGY_XPATH
         #params[:strategy_reason] = "retrieved instance of a array"
@@ -215,7 +274,8 @@ module TestaAppiumDriver
           xpath: @xpath_selector,
           scrollable: @scrollable_locator.nil? ? nil : @scrollable_locator.to_s,
           scroll_orientation: @scroll_orientation,
-          resolved: strategy_and_selector
+          resolved: strategies_and_selectors,
+          index_for_multiple: @index_for_multiple
       }
     end
 
@@ -253,7 +313,15 @@ module TestaAppiumDriver
     end
 
     def click
-      perform_driver_method(:click)
+      if @driver.device == :android
+        perform_driver_method(:click)
+      else
+        # on ios, if element is not visible, first click will scroll to it
+        # then on second click actually perform the click
+        visible = visible?
+        perform_driver_method(:click)
+        perform_driver_method(:click) unless visible rescue nil
+      end
     end
 
     def send_key(*args)
@@ -283,15 +351,20 @@ module TestaAppiumDriver
     # @return [TestaAppiumDriver::Locator]
     def children
       raise "Cannot add children selector to array" unless @single
-      raise StrategyMixException.new(@strategy, @strategy_reason, FIND_STRATEGY_XPATH, "children") if @strategy != FIND_STRATEGY_XPATH && !@strategy.nil?
+      raise StrategyMixException.new(@strategy, @strategy_reason, FIND_STRATEGY_XPATH, "children") if @strategy != FIND_STRATEGY_XPATH &&  @strategy != FIND_STRATEGY_CLASS_CHAIN && !@strategy.nil?
 
       locator = self.dup
-      locator.strategy = FIND_STRATEGY_XPATH
       locator.strategy_reason = "children"
       locator.xpath_selector += "/*"
       locator.single = false
       locator.last_selector_adjacent = true
       locator.can_use_id_strategy = false
+
+      if @driver.device == :android
+        locator.strategy = FIND_STRATEGY_XPATH
+      else
+        locator.class_chain_selector += "/*"
+      end
       locator
     end
 
@@ -300,14 +373,20 @@ module TestaAppiumDriver
     # @return [TestaAppiumDriver::Locator]
     def child
       raise "Cannot add children selector to array" unless @single
-      raise StrategyMixException.new(@strategy, @strategy_reason, FIND_STRATEGY_XPATH, "child") if @strategy != FIND_STRATEGY_XPATH && !@strategy.nil?
+      raise StrategyMixException.new(@strategy, @strategy_reason, FIND_STRATEGY_XPATH, "child") if @strategy != FIND_STRATEGY_XPATH && @strategy != FIND_STRATEGY_CLASS_CHAIN && !@strategy.nil?
 
       locator = self.dup
-      locator.strategy = FIND_STRATEGY_XPATH
+
       locator.strategy_reason = "child"
       locator.xpath_selector += "/*[1]"
       locator.single = true
       locator.can_use_id_strategy = false
+
+      if @driver.device == :android
+        locator.strategy = FIND_STRATEGY_XPATH
+      else
+        locator.class_chain_selector += "/*[1]"
+      end
       locator
     end
 
@@ -400,6 +479,51 @@ module TestaAppiumDriver
 
     private
 
+    def _wait(type, args)
+      interval = EXISTS_WAIT
+      interval = args[:interval] unless args[:interval].nil?
+
+      message = "wait #{type} exists timeout exceeded"
+      message = args[:message] unless args[:message].nil?
+
+      if args[:timeout].nil?
+        timeout = @driver.get_timeouts["implicit"] / 1000
+      else
+        timeout = args[:timeout]
+      end
+
+      args.delete(:message)
+      args.delete(:interval)
+      args.delete(:timeout)
+
+
+
+      start_time = Time.now.to_f
+      if type ==  :while
+        while exists? && _attributes_match(args)
+          raise message if start_time + timeout < Time.now.to_f
+          sleep interval
+        end
+      else
+        until exists? && _attributes_match(args)
+          raise message if start_time + timeout < Time.now.to_f
+          sleep interval
+        end
+      end
+      self
+    end
+
+    def _attributes_match(attributes)
+      all_match = true
+      attributes.each do |key, value|
+        unless attribute(key) == value
+          all_match = false
+          break
+        end
+      end
+      all_match
+    end
+
     #noinspection RubyNilAnalysis
     def perform_driver_method(name, *args)
       elements = execute
@@ -414,6 +538,42 @@ module TestaAppiumDriver
       locator.single = false unless single # switching from single result to multiple
       locator.xpath_selector += hash_to_xpath(@driver.device, selectors, single)
     end
+
+
+    def handle_image_selector(selectors, params)
+      image_match_threshold = 0.4
+      image_match_threshold = params[:imageMatchThreshold] unless params[:imageMatchThreshold].nil?
+      image_match_threshold = params[:threshold] unless params[:threshold].nil?
+      fix_image_find_screenshot_dims = true
+      fix_image_find_screenshot_dims = params[:fixImageFindScreenshotDims] unless params[:fixImageFindScreenshotDims].nil?
+      fix_image_template_size = false
+      fix_image_template_size = params[:fixImageTemplateSize] unless params[:fixImageTemplateSize].nil?
+      fix_image_template_scale = false
+      fix_image_template_scale = params[:fixImageTemplateScale] unless params[:fixImageTemplateScale].nil?
+      default_image_template_scale = 1.0
+      default_image_template_scale = params[:defaultImageTemplateScale] unless params[:defaultImageTemplateScale].nil?
+      check_for_image_element_staleness = true
+      check_for_image_element_staleness = params[:checkForImageElementStaleness] unless params[:checkForImageElementStaleness].nil?
+      auto_update_image_element_position = false
+      auto_update_image_element_position = params[:autoUpdateImageElementPosition] unless params[:autoUpdateImageElementPosition].nil?
+      image_element_tap_strategy = "w3cActions"
+      image_element_tap_strategy = params[:imageElementTapStrategy] unless params[:imageElementTapStrategy].nil?
+      get_matched_image_result = false
+      get_matched_image_result = params[:getMatchedImageResult] unless params[:getMatchedImageResult].nil?
+
+      @image_selector = {
+        image: selectors[:image],
+        imageMatchThreshold: image_match_threshold,
+        fixImageFindScreenshotDims: fix_image_find_screenshot_dims,
+        fixImageTemplateSize: fix_image_template_size,
+        fixImageTemplateScale: fix_image_template_scale,
+        defaultImageTemplateScale: default_image_template_scale,
+        checkForImageElementStaleness: check_for_image_element_staleness,
+        autoUpdateImageElementPosition: auto_update_image_element_position,
+        imageElementTapStrategy: image_element_tap_strategy,
+        getMatchedImageResult: get_matched_image_result,
+      }
+    end
   end
 
 end

data/lib/testa_appium_driver/common/scroll_actions/w3c_scroll_actions.rb

@@ -6,8 +6,6 @@ module TestaAppiumDriver
     def w3c_each(direction, &block)
       elements = []
       begin
-        @driver.disable_wait_for_idle
-        @driver.disable_implicit_wait
         default_deadzone!
 
         iterations = 0
@@ -25,6 +23,7 @@ module TestaAppiumDriver
         until is_end_of_scroll?
           matches = @locator.execute(skip_cache: true)
           matches.each_with_index do |m|
+            next if elements.include?(m)
             elements << m
             if block_given? # block is given
               block.call(m) # use call to execute the block
@@ -38,15 +37,12 @@ module TestaAppiumDriver
         end
       rescue => e
         raise e
-      ensure
-        @driver.enable_implicit_wait
-        @driver.enable_wait_for_idle
+
       end
       elements
     end
 
     def w3c_align(with, scroll_to_find)
-      @driver.disable_wait_for_idle
       default_deadzone!
 
 
@@ -54,20 +50,6 @@ module TestaAppiumDriver
       @locator.scroll_to if scroll_to_find
 
       element = @locator.execute
-      @driver.disable_implicit_wait
-
-      case with
-      when :top
-        page_down if is_aligned?(with, element)
-      when :bottom
-        page_up if is_aligned?(with, element)
-      when :right
-        page_right if is_aligned?(with, element)
-      when :left
-        page_left if is_aligned?(with, element)
-      else
-        raise "Unsupported align with option: #{with}"
-      end
 
       timeout = 0
       until is_aligned?(with, element) || timeout == 3
@@ -75,8 +57,6 @@ module TestaAppiumDriver
         timeout += 1
       end
 
-      @driver.enable_implicit_wait
-      @driver.enable_wait_for_idle
     end
 
 
@@ -150,8 +130,6 @@ module TestaAppiumDriver
     end
 
     def w3c_scroll_to_start_or_end(type)
-      @driver.disable_wait_for_idle
-      @driver.disable_implicit_wait
       default_deadzone!
 
       @previous_elements = nil
@@ -179,15 +157,10 @@ module TestaAppiumDriver
 
       # reset the flag for end of scroll elements
       @previous_elements = nil
-
-      @driver.enable_implicit_wait
-      @driver.enable_wait_for_idle
     end
 
 
     def w3c_page_or_fling(type, direction)
-      @driver.disable_wait_for_idle
-      @driver.disable_implicit_wait
       default_deadzone!
 
       if direction == :down || direction == :up
@@ -216,8 +189,6 @@ module TestaAppiumDriver
 
       w3c_action(x0, y0, x1, y1, type)
 
-      @driver.enable_implicit_wait
-      @driver.enable_wait_for_idle
     end
 
 
@@ -258,10 +229,8 @@ module TestaAppiumDriver
 
 
 
-    def drag_to(x, y)
-      x0 = @bounds.center.x
-      y0 = @bounds.center.y
-      w3c_action(x0, y0, x, y, SCROLL_ACTION_TYPE_DRAG)
+    def w3c_drag_to(x0, y0, x1, y1)
+      w3c_action(x0, y0, x1, y1, SCROLL_ACTION_TYPE_DRAG)
     end
 
   end

data/lib/testa_appium_driver/common/scroll_actions.rb

@@ -1,7 +1,6 @@
 require_relative 'scroll_actions/json_wire_scroll_actions'
 require_relative 'scroll_actions/w3c_scroll_actions'
 
-
 module TestaAppiumDriver
 
   # Class for handling scroll actions
@@ -21,7 +20,6 @@ module TestaAppiumDriver
       @default_scroll_strategy = params[:default_scroll_strategy]
       @driver = @locator.driver
 
-
       if @scrollable.nil?
         # if we dont have a scrollable element or if we do have it, but it is not compatible with uiautomator
         # then find first scrollable in document
@@ -30,16 +28,14 @@ module TestaAppiumDriver
 
       @strategy = nil
       if @scrollable.strategy == FIND_STRATEGY_XPATH || # uiautomator cannot resolve scrollable from a xpath locator
-          !@deadzone.nil? ||
-          !@scrollable.from_element.instance_of?(TestaAppiumDriver::Driver) # uiautomator cannot resolve nested scrollable
+        !@deadzone.nil? ||
+        !@scrollable.from_element.instance_of?(TestaAppiumDriver::Driver) # uiautomator cannot resolve nested scrollable
         @strategy = SCROLL_STRATEGY_W3C
       end
 
-
       @bounds = @scrollable.bounds
     end
 
-
     def align(with, scroll_to_find)
       w3c_align(with, scroll_to_find)
       @locator
@@ -66,7 +62,6 @@ module TestaAppiumDriver
       w3c_each(:left, &block)
     end
 
-
     def resolve_strategy
       if @strategy.nil?
         @default_scroll_strategy
@@ -75,7 +70,6 @@ module TestaAppiumDriver
       end
     end
 
-
     def scroll_to
       if @locator.strategy != FIND_STRATEGY_XPATH && resolve_strategy == SCROLL_STRATEGY_UIAUTOMATOR
         uiautomator_scroll_to
@@ -116,7 +110,6 @@ module TestaAppiumDriver
       end
     end
 
-
     def page_down
       if resolve_strategy == SCROLL_STRATEGY_UIAUTOMATOR
         uiautomator_page_or_fling(SCROLL_ACTION_TYPE_SCROLL, :down)
@@ -149,10 +142,10 @@ module TestaAppiumDriver
       end
     end
 
-
     def scroll_to_start
       if resolve_strategy == SCROLL_STRATEGY_UIAUTOMATOR
         uiautomator_scroll_to_start_or_end(:start)
+
       elsif resolve_strategy == SCROLL_STRATEGY_W3C
         w3c_scroll_to_start_or_end(:start)
       end
@@ -198,11 +191,10 @@ module TestaAppiumDriver
       end
     end
 
-    def drag_to(x, y)
-      w3c_drag_to(x, y)
+    def drag_to(x0, y0, x1, y1)
+      w3c_drag_to(x0, y0, x1, y1)
     end
 
-
     private
 
     def is_end_of_scroll?
@@ -211,7 +203,6 @@ module TestaAppiumDriver
       old_elements == @previous_elements
     end
 
-
     def default_deadzone!
       @deadzone = {} if @deadzone.nil?
       if @deadzone[:top].nil?