testa_appium_driver 0.1.8 → 0.1.12

data/lib/testa_appium_driver/android/driver.rb

@@ -1,70 +1,70 @@
-require_relative 'class_selectors'
-require_relative 'locator'
-require_relative 'scroll_actions/uiautomator_scroll_actions'
-require_relative 'selenium_element'
-
-module TestaAppiumDriver
-  class Driver
-    include ClassSelectors
-
-
-    # executes shell command
-    # @param [String] command Shell command name to execute for example echo or rm
-    # @param [Array<String>] args Array of command arguments, example: ['-f', '/sdcard/my_file.txt']
-    # @param [Integer] timeout Command timeout in milliseconds. If the command blocks for longer than this timeout then an exception is going to be thrown. The default timeout is 20000 ms
-    # @param [Boolean] includeStderr 	Whether to include stderr stream into the returned result.
-    def shell(command, args: nil, timeout: nil, includeStderr: true)
-      params = {
-          command: command,
-          includeStderr: includeStderr
-      }
-      params[:args] = args unless args.nil?
-      params[:timeout] = timeout unless timeout.nil?
-      @driver.execute_script("mobile: shell", params)
-    end
-
-
-    def scrollable
-      locator = Locator.new(self, self, {single: true})
-      locator.xpath_selector = "//androidx.recyclerview.widget.RecyclerView|//android.widget.ScrollView|//android.widget.ListView|//android.widget.HorizontalScrollView"
-      locator.ui_selector = "new UiSelector().scrollable(true).instance(0)"
-      locator
-    end
-
-
-    def scrollables
-      locator = Locator.new(self, self, {single: false})
-      locator.xpath_selector = "//androidx.recyclerview.widget.RecyclerView|//android.widget.ScrollView|//android.widget.ListView|//android.widget.HorizontalScrollView"
-      locator.ui_selector = "new UiSelector().scrollable(true)"
-      locator
-    end
-
-
-
-    private
-    def handle_testa_opts
-      if @testa_opts[:default_find_strategy].nil?
-        @default_find_strategy = DEFAULT_ANDROID_FIND_STRATEGY
-      else
-        case @testa_opts[:default_find_strategy].to_sym
-        when FIND_STRATEGY_UIAUTOMATOR, 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 Android"
-        end
-      end
-
-
-      if @testa_opts[:default_scroll_strategy].nil?
-        @default_scroll_strategy = DEFAULT_ANDROID_SCROLL_STRATEGY
-      else
-        case @testa_opts[:default_scroll_strategy].to_sym
-        when SCROLL_STRATEGY_W3C, SCROLL_STRATEGY_UIAUTOMATOR
-          @default_scroll_strategy = @testa_opts[:default_scroll_strategy].to_sym
-        else
-          raise "Default scroll strategy #{@testa_opts[:default_scroll_strategy]} not supported for Android"
-        end
-      end
-    end
-  end
+require_relative 'class_selectors'
+require_relative 'locator'
+require_relative 'scroll_actions/uiautomator_scroll_actions'
+require_relative 'selenium_element'
+
+module TestaAppiumDriver
+  class Driver
+    include ClassSelectors
+
+
+    # executes shell command
+    # @param [String] command Shell command name to execute for example echo or rm
+    # @param [Array<String>] args Array of command arguments, example: ['-f', '/sdcard/my_file.txt']
+    # @param [Integer] timeout Command timeout in milliseconds. If the command blocks for longer than this timeout then an exception is going to be thrown. The default timeout is 20000 ms
+    # @param [Boolean] includeStderr 	Whether to include stderr stream into the returned result.
+    def shell(command, args: nil, timeout: nil, includeStderr: true)
+      params = {
+          command: command,
+          includeStderr: includeStderr
+      }
+      params[:args] = args unless args.nil?
+      params[:timeout] = timeout unless timeout.nil?
+      @driver.execute_script("mobile: shell", params)
+    end
+
+
+    def scrollable
+      locator = Locator.new(self, self, {single: true})
+      locator.xpath_selector = "//androidx.recyclerview.widget.RecyclerView|//android.widget.ScrollView|//android.widget.ListView|//android.widget.HorizontalScrollView"
+      locator.ui_selector = "new UiSelector().scrollable(true).instance(0)"
+      locator
+    end
+
+
+    def scrollables
+      locator = Locator.new(self, self, {single: false})
+      locator.xpath_selector = "//androidx.recyclerview.widget.RecyclerView|//android.widget.ScrollView|//android.widget.ListView|//android.widget.HorizontalScrollView"
+      locator.ui_selector = "new UiSelector().scrollable(true)"
+      locator
+    end
+
+
+
+    private
+    def handle_testa_opts
+      if @testa_opts[:default_find_strategy].nil?
+        @default_find_strategy = DEFAULT_ANDROID_FIND_STRATEGY
+      else
+        case @testa_opts[:default_find_strategy].to_sym
+        when FIND_STRATEGY_UIAUTOMATOR, 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 Android"
+        end
+      end
+
+
+      if @testa_opts[:default_scroll_strategy].nil?
+        @default_scroll_strategy = DEFAULT_ANDROID_SCROLL_STRATEGY
+      else
+        case @testa_opts[:default_scroll_strategy].to_sym
+        when SCROLL_STRATEGY_W3C, SCROLL_STRATEGY_UIAUTOMATOR
+          @default_scroll_strategy = @testa_opts[:default_scroll_strategy].to_sym
+        else
+          raise "Default scroll strategy #{@testa_opts[:default_scroll_strategy]} not supported for Android"
+        end
+      end
+    end
+  end
 end

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

@@ -1,114 +1,114 @@
-module TestaAppiumDriver
-  module Attributes
-
-    #noinspection RubyNilAnalysis
-    def attribute(name, *args)
-      elements = execute(*args)
-
-      @driver = get_driver if self.instance_of?(Selenium::WebDriver::Element)
-
-      if elements.kind_of?(Selenium::WebDriver::Element)
-        r = elements.send(:attribute, name.to_s)
-        r = TestaAppiumDriver::Bounds.from_android(r, @driver) if name.to_s == "bounds"
-      else
-        r = elements.map { |e| e.send(:attribute, name.to_s) }
-        r.map! { |b| TestaAppiumDriver::Bounds.from_android(b, @driver) } if name.to_s == "bounds"
-      end
-      r
-    end
-
-    def text(*args)
-      attribute("text", *args)
-    end
-
-    def package(*args)
-      attribute("package", *args)
-    end
-
-    def class_name(*args)
-      attribute("className", *args)
-    end
-
-    def checkable?(*args)
-      attribute("checkable", *args).to_s == "true"
-    end
-
-    def checked?(*args)
-      attribute("checked", *args).to_s == "true"
-    end
-
-    def clickable?(*args)
-      attribute("clickable", *args).to_s == "true"
-    end
-
-    def desc(*args)
-      attribute("contentDescription", *args)
-    end
-
-    def enabled?(*args)
-      attribute("enabled", *args).to_s == "true"
-    end
-
-    def focusable?(*args)
-      attribute("focusable", *args).to_s == "true"
-    end
-
-    def focused?(*args)
-      attribute("focused", *args).to_s == "true"
-    end
-
-    def long_clickable?(*args)
-      attribute("longClickable", *args).to_s == "true"
-    end
-
-    def password?(*args)
-      attribute("password", *args).to_s == "true"
-    end
-
-    def id(*args)
-      attribute("resourceId", *args)
-    end
-
-    def scrollable?(*args)
-      attribute("scrollable", *args).to_s == "true"
-    end
-
-    def selected?(*args)
-      attribute("selected", *args).to_s == "true"
-    end
-
-    def displayed?(*args)
-      attribute("displayed", *args).to_s == "true"
-    end
-
-    def selection_start(*args)
-      attribute("selection-start", *args)
-    end
-
-    def selection_end(*args)
-      attribute("selection-end", *args)
-    end
-
-    def bounds(*args)
-      attribute("bounds", *args)
-    end
-
-  end
-
-  class Locator
-    include TestaAppiumDriver::Attributes
-
-
-    # element index in parent element, starts from 0
-    #noinspection RubyNilAnalysis,RubyYardReturnMatch
-    # @return [Integer, nil] index of element
-    def index(*args)
-      raise "Index not supported for uiautomator strategy" if @strategy == FIND_STRATEGY_UIAUTOMATOR
-      this = execute(*args)
-      children = self.dup.parent.children.execute
-      index = children.index(this)
-      raise "Index not found" if index.nil?
-      index.to_i
-    end
-  end
+module TestaAppiumDriver
+  module Attributes
+
+    #noinspection RubyNilAnalysis
+    def attribute(name, *args)
+      elements = execute(*args)
+
+      @driver = get_driver if self.instance_of?(Selenium::WebDriver::Element)
+
+      if elements.kind_of?(Selenium::WebDriver::Element)
+        r = elements.send(:attribute, name.to_s)
+        r = TestaAppiumDriver::Bounds.from_android(r, @driver) if name.to_s == "bounds"
+      else
+        r = elements.map { |e| e.send(:attribute, name.to_s) }
+        r.map! { |b| TestaAppiumDriver::Bounds.from_android(b, @driver) } if name.to_s == "bounds"
+      end
+      r
+    end
+
+    def text(*args)
+      attribute("text", *args)
+    end
+
+    def package(*args)
+      attribute("package", *args)
+    end
+
+    def class_name(*args)
+      attribute("className", *args)
+    end
+
+    def checkable?(*args)
+      attribute("checkable", *args).to_s == "true"
+    end
+
+    def checked?(*args)
+      attribute("checked", *args).to_s == "true"
+    end
+
+    def clickable?(*args)
+      attribute("clickable", *args).to_s == "true"
+    end
+
+    def desc(*args)
+      attribute("contentDescription", *args)
+    end
+
+    def enabled?(*args)
+      attribute("enabled", *args).to_s == "true"
+    end
+
+    def focusable?(*args)
+      attribute("focusable", *args).to_s == "true"
+    end
+
+    def focused?(*args)
+      attribute("focused", *args).to_s == "true"
+    end
+
+    def long_clickable?(*args)
+      attribute("longClickable", *args).to_s == "true"
+    end
+
+    def password?(*args)
+      attribute("password", *args).to_s == "true"
+    end
+
+    def id(*args)
+      attribute("resourceId", *args)
+    end
+
+    def scrollable?(*args)
+      attribute("scrollable", *args).to_s == "true"
+    end
+
+    def selected?(*args)
+      attribute("selected", *args).to_s == "true"
+    end
+
+    def displayed?(*args)
+      attribute("displayed", *args).to_s == "true"
+    end
+
+    def selection_start(*args)
+      attribute("selection-start", *args)
+    end
+
+    def selection_end(*args)
+      attribute("selection-end", *args)
+    end
+
+    def bounds(*args)
+      attribute("bounds", *args)
+    end
+
+  end
+
+  class Locator
+    include TestaAppiumDriver::Attributes
+
+
+    # element index in parent element, starts from 0
+    #noinspection RubyNilAnalysis,RubyYardReturnMatch
+    # @return [Integer, nil] index of element
+    def index(*args)
+      raise "Index not supported for uiautomator strategy" if @strategy == FIND_STRATEGY_UIAUTOMATOR
+      this = execute(*args)
+      children = self.dup.parent.children.execute
+      index = children.index(this)
+      raise "Index not found" if index.nil?
+      index.to_i
+    end
+  end
 end

data/lib/testa_appium_driver/android/locator.rb

@@ -1,142 +1,142 @@
-require_relative 'locator/attributes'
-
-module TestaAppiumDriver
-  #noinspection RubyTooManyInstanceVariablesInspection
-  class Locator
-    attr_accessor :closing_parenthesis
-    include ClassSelectors
-
-    def init(params, selectors, single)
-      @closing_parenthesis = 0
-
-
-      @ui_selector = hash_to_uiautomator(selectors, single)
-
-
-      if is_scrollable_selector?(selectors, single)
-        if selectors[:class] == "android.widget.HorizontalScrollView"
-          @scroll_orientation = :horizontal
-        else
-          @scroll_orientation = :vertical
-        end
-
-        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
-
-      @scrollable_locator = params[:scrollable_locator] if params[:scrollable_locator]
-    end
-
-
-    # resolve selector which will be used for finding element
-    def strategies_and_selectors
-      ss = []
-      if @can_use_id_strategy
-        ss.push({"#{FIND_STRATEGY_ID}": @can_use_id_strategy})
-      end
-      if @strategy.nil? || @strategy == FIND_STRATEGY_UIAUTOMATOR
-        ss.push({"#{FIND_STRATEGY_UIAUTOMATOR}": ui_selector})
-      end
-
-      if @strategy.nil? || @strategy == FIND_STRATEGY_XPATH
-        ss.push({"#{FIND_STRATEGY_XPATH}": @xpath_selector})
-      end
-
-      if @strategy == FIND_STRATEGY_IMAGE
-        ss.push({"#{FIND_STRATEGY_IMAGE}": @image_selector})
-      end
-      ss
-    end
-
-
-    # @param [Boolean] include_semicolon should the semicolon be included at the end
-    # @return ui_selector for uiautomator find strategy
-    def ui_selector(include_semicolon = true)
-      @ui_selector + ")" * @closing_parenthesis + (include_semicolon ? ";" : "");
-    end
-
-    def ui_selector=(value)
-      @ui_selector = value
-    end
-
-
-
-
-    # @return [TestaAppiumDriver::Locator]
-    def from_parent(selectors = {})
-      raise "Cannot add from_parent selector to array" unless @single
-      raise StrategyMixException.new(@strategy, @strategy_reason, FIND_STRATEGY_UIAUTOMATOR, "from_parent") if @strategy != FIND_STRATEGY_UIAUTOMATOR
-
-      locator = self.dup
-      locator.strategy = FIND_STRATEGY_UIAUTOMATOR
-      locator.strategy_reason = "from_parent"
-      locator.closing_parenthesis += 1
-      locator.ui_selector = "#{locator.ui_selector}.fromParent(#{hash_to_uiautomator(selectors)}"
-      locator
-    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
-      if (@strategy.nil? && !single) || @strategy == FIND_STRATEGY_XPATH
-        locator.strategy = FIND_STRATEGY_XPATH
-        locator.strategy_reason = "multiple child selector"
-        add_xpath_child_selectors(locator, selectors, single)
-      elsif @strategy == FIND_STRATEGY_UIAUTOMATOR
-        locator = add_uiautomator_child_selector(locator, selectors, single)
-      elsif @strategy == FIND_STRATEGY_IMAGE
-        locator = add_image_child_selector(locator, selectors, single)
-      else
-        # both paths are valid
-        add_xpath_child_selectors(locator, selectors, single)
-        locator = add_uiautomator_child_selector(locator, selectors, single)
-      end
-
-      if is_scrollable_selector?(selectors, single)
-        locator.scrollable_locator = locator
-        if selectors[:class] == "android.widget.HorizontalScrollView"
-          locator.scrollable_locator.scroll_orientation = :horizontal
-        else
-          locator.scrollable_locator.scroll_orientation = :vertical
-        end
-      end
-
-      locator.last_selector_adjacent = false
-      locator
-    end
-
-
-    private
-    def add_uiautomator_child_selector(locator, selectors, single)
-      if locator.single && !single
-        # current locator stays single, the child locator looks for multiple
-        params = selectors.merge({single: single, scrollable_locator: locator.scrollable_locator})
-        params[:default_find_strategy] = locator.default_find_strategy
-        params[:default_scroll_strategy] = locator.default_scroll_strategy
-        Locator.new(@driver, self, params)
-      else
-        locator.single = true
-        locator.ui_selector = "#{locator.ui_selector(false)}.childSelector(#{hash_to_uiautomator(selectors, single)})"
-        locator
-      end
-    end
-
-    def add_image_child_selector(locator, selectors, single)
-      params = selectors.merge({single: single, scrollable_locator: locator.scrollable_locator})
-      Locator.new(@driver, self, params)
-    end
-  end
+require_relative 'locator/attributes'
+
+module TestaAppiumDriver
+  #noinspection RubyTooManyInstanceVariablesInspection
+  class Locator
+    attr_accessor :closing_parenthesis
+    include ClassSelectors
+
+    def init(params, selectors, single)
+      @closing_parenthesis = 0
+
+
+      @ui_selector = hash_to_uiautomator(selectors, single)
+
+
+      if is_scrollable_selector?(selectors, single)
+        if selectors[:class] == "android.widget.HorizontalScrollView"
+          @scroll_orientation = :horizontal
+        else
+          @scroll_orientation = :vertical
+        end
+
+        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
+
+      @scrollable_locator = params[:scrollable_locator] if params[:scrollable_locator]
+    end
+
+
+    # resolve selector which will be used for finding element
+    def strategies_and_selectors
+      ss = []
+      if @can_use_id_strategy
+        ss.push({"#{FIND_STRATEGY_ID}": @can_use_id_strategy})
+      end
+      if @strategy.nil? || @strategy == FIND_STRATEGY_UIAUTOMATOR
+        ss.push({"#{FIND_STRATEGY_UIAUTOMATOR}": ui_selector})
+      end
+
+      if @strategy.nil? || @strategy == FIND_STRATEGY_XPATH
+        ss.push({"#{FIND_STRATEGY_XPATH}": @xpath_selector})
+      end
+
+      if @strategy == FIND_STRATEGY_IMAGE
+        ss.push({"#{FIND_STRATEGY_IMAGE}": @image_selector})
+      end
+      ss
+    end
+
+
+    # @param [Boolean] include_semicolon should the semicolon be included at the end
+    # @return ui_selector for uiautomator find strategy
+    def ui_selector(include_semicolon = true)
+      @ui_selector + ")" * @closing_parenthesis + (include_semicolon ? ";" : "");
+    end
+
+    def ui_selector=(value)
+      @ui_selector = value
+    end
+
+
+
+
+    # @return [TestaAppiumDriver::Locator]
+    def from_parent(selectors = {})
+      raise "Cannot add from_parent selector to array" unless @single
+      raise StrategyMixException.new(@strategy, @strategy_reason, FIND_STRATEGY_UIAUTOMATOR, "from_parent") if @strategy != FIND_STRATEGY_UIAUTOMATOR
+
+      locator = self.dup
+      locator.strategy = FIND_STRATEGY_UIAUTOMATOR
+      locator.strategy_reason = "from_parent"
+      locator.closing_parenthesis += 1
+      locator.ui_selector = "#{locator.ui_selector}.fromParent(#{hash_to_uiautomator(selectors)}"
+      locator
+    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
+      if (@strategy.nil? && !single) || @strategy == FIND_STRATEGY_XPATH
+        locator.strategy = FIND_STRATEGY_XPATH
+        locator.strategy_reason = "multiple child selector"
+        add_xpath_child_selectors(locator, selectors, single)
+      elsif @strategy == FIND_STRATEGY_UIAUTOMATOR
+        locator = add_uiautomator_child_selector(locator, selectors, single)
+      elsif @strategy == FIND_STRATEGY_IMAGE
+        locator = add_image_child_selector(locator, selectors, single)
+      else
+        # both paths are valid
+        add_xpath_child_selectors(locator, selectors, single)
+        locator = add_uiautomator_child_selector(locator, selectors, single)
+      end
+
+      if is_scrollable_selector?(selectors, single)
+        locator.scrollable_locator = locator
+        if selectors[:class] == "android.widget.HorizontalScrollView"
+          locator.scrollable_locator.scroll_orientation = :horizontal
+        else
+          locator.scrollable_locator.scroll_orientation = :vertical
+        end
+      end
+
+      locator.last_selector_adjacent = false
+      locator
+    end
+
+
+    private
+    def add_uiautomator_child_selector(locator, selectors, single)
+      if locator.single && !single
+        # current locator stays single, the child locator looks for multiple
+        params = selectors.merge({single: single, scrollable_locator: locator.scrollable_locator})
+        params[:default_find_strategy] = locator.default_find_strategy
+        params[:default_scroll_strategy] = locator.default_scroll_strategy
+        Locator.new(@driver, self, params)
+      else
+        locator.single = true
+        locator.ui_selector = "#{locator.ui_selector(false)}.childSelector(#{hash_to_uiautomator(selectors, single)})"
+        locator
+      end
+    end
+
+    def add_image_child_selector(locator, selectors, single)
+      params = selectors.merge({single: single, scrollable_locator: locator.scrollable_locator})
+      Locator.new(@driver, self, params)
+    end
+  end
 end