appium_lib 9.5.0 → 9.6.0

data/docs/ios_xcuitest.md

@@ -8,6 +8,10 @@
     - [ios-xctest-mobile-gestures](https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/ios-xctest-mobile-gestures.md)
     - Required Appium1.6.4+
 
+## Run tests on Multiple Simulators with Xcode 9
+- https://github.com/appium/appium-xcuitest-driver/tree/master/test/functional/parallel
+- https://github.com/appium/ruby_lib/tree/master/ios_tests/parallel
+
 ## find elements
 - supported elements by find_element are:
     - [appium-xcuitest-driver](https://github.com/appium/appium-xcuitest-driver/blob/master/lib/commands/find.js#L17)

data/lib/appium_lib/android/device.rb

@@ -0,0 +1,39 @@
+require 'base64'
+
+module Appium
+  module Android
+    module Device
+      extend Forwardable
+
+      # @!method hide_keyboard
+      #   Hide the onscreen keyboard
+      #   @param [String] close_key The name of the key which closes the keyboard.
+      #     Defaults to 'Done' for iOS(except for XCUITest).
+      #   @param [Symbol] strategy The symbol of the strategy which closes the keyboard.
+      #     XCUITest ignore this argument.
+      #     Default for iOS is `:pressKey`. Default for Android is `:tapOutside`.
+      #  ```ruby
+      #  hide_keyboard # Close a keyboard with the 'Done' button
+      #  hide_keyboard('Finished') # Close a keyboard with the 'Finished' button
+      #  hide_keyboard(nil, :tapOutside) # Close a keyboard with tapping out side of keyboard
+      #  ```
+
+      class << self
+        def extended(_mod)
+          ::Appium::Device.extend_webdriver_with_forwardable
+
+          ::Appium::Device.add_endpoint_method(:hide_keyboard) do
+            def hide_keyboard(close_key = nil, strategy = nil)
+              option = {}
+
+              option[:key] = close_key if close_key
+              option[:strategy] = strategy || :tapOutside # default to pressKey
+
+              execute :hide_keyboard, {}, option
+            end
+          end
+        end
+      end # class << self
+    end # module Device
+  end # module Android
+end # module Appium

data/lib/appium_lib/android/element/button.rb

@@ -1,38 +1,8 @@
-# UIAButton methods
 module Appium
   module Android
     Button      = 'android.widget.Button'.freeze
     ImageButton = 'android.widget.ImageButton'.freeze
 
-    private
-
-    def _button_visible_selectors(opts = {})
-      button_index       = opts.fetch :button_index, false
-      image_button_index = opts.fetch :image_button_index, false
-
-      if button_index && image_button_index
-        "new UiSelector().className(#{Button}).instance(#{button_index});" \
-        "new UiSelector().className(#{ImageButton}).instance(#{image_button_index});"
-      else
-        "new UiSelector().className(#{Button});" \
-        "new UiSelector().className(#{ImageButton});"
-      end
-    end
-
-    def _button_exact_string(value)
-      button       = string_visible_exact Button, value
-      image_button = string_visible_exact ImageButton, value
-      button + image_button
-    end
-
-    def _button_contains_string(value)
-      button       = string_visible_contains Button, value
-      image_button = string_visible_contains ImageButton, value
-      button + image_button
-    end
-
-    public
-
     # Find the first button that contains value or by index.
     # @param value [String, Integer] the value to exactly match.
     # If int then the button at that index is returned.
@@ -44,21 +14,10 @@ module Appium
         index = value
         raise "#{index} is not a valid index. Must be >= 1" if index <= 0
 
-        unless automation_name_is_uiautomator2?
-          return find_element :uiautomator, _button_visible_selectors(index: index)
-        end
-
-        result = find_elements :uiautomator, _button_visible_selectors(index: index)
-        raise _no_such_element if result.empty?
-        return result[value - 1]
+        return find_element :uiautomator, _button_visible_selectors(index: index)
       end
 
-      if automation_name_is_uiautomator2?
-        elements = find_elements :uiautomator, _button_contains_string(value)
-        raise_no_such_element_if_empty(elements)
-      else
-        find_element :uiautomator, _button_contains_string(value)
-      end
+      find_element :uiautomator, _button_contains_string(value)
     end
 
     # Find all buttons containing value.
@@ -73,12 +32,7 @@ module Appium
     # Find the first button.
     # @return [Button]
     def first_button
-      if automation_name_is_uiautomator2?
-        elements = find_elements :uiautomator, _button_visible_selectors(button_index: 0, image_button_index: 0)
-        raise_no_such_element_if_empty(elements)
-      else
-        find_element :uiautomator, _button_visible_selectors(button_index: 0, image_button_index: 0)
-      end
+      find_element :uiautomator, _button_visible_selectors(button_index: 0, image_button_index: 0)
     end
 
     # Find the last button.
@@ -91,28 +45,16 @@ module Appium
       image_button_index = tags(ImageButton).length
       image_button_index -= 1 if image_button_index > 0
 
-      if automation_name_is_uiautomator2?
-        elements = find_elements :uiautomator,
-                                 _button_visible_selectors(button_index: button_index,
-                                                           image_button_index: image_button_index)
-        raise_no_such_element_if_empty(elements)
-      else
-        find_element :uiautomator,
-                     _button_visible_selectors(button_index: button_index,
-                                               image_button_index: image_button_index)
-      end
+      find_element :uiautomator,
+                   _button_visible_selectors(button_index: button_index,
+                                             image_button_index: image_button_index)
     end
 
     # Find the first button that exactly matches value.
     # @param value [String] the value to match exactly
     # @return [Button]
     def button_exact(value)
-      if automation_name_is_uiautomator2?
-        elements = find_elements :uiautomator, _button_exact_string(value)
-        raise_no_such_element_if_empty(elements)
-      else
-        find_element :uiautomator, _button_exact_string(value)
-      end
+      find_element :uiautomator, _button_exact_string(value)
     end
 
     # Find all buttons that exactly match value.
@@ -124,9 +66,38 @@ module Appium
 
     private
 
+    # @private
     def raise_no_such_element_if_empty(elements)
       raise _no_such_element if elements.empty?
       elements.first
     end
+
+    # @private
+    def _button_visible_selectors(opts = {})
+      button_index       = opts.fetch :button_index, false
+      image_button_index = opts.fetch :image_button_index, false
+
+      if button_index && image_button_index
+        "new UiSelector().className(#{Button}).instance(#{button_index});" \
+        "new UiSelector().className(#{ImageButton}).instance(#{image_button_index});"
+      else
+        "new UiSelector().className(#{Button});" \
+        "new UiSelector().className(#{ImageButton});"
+      end
+    end
+
+    # @private
+    def _button_exact_string(value)
+      button       = string_visible_exact Button, value
+      image_button = string_visible_exact ImageButton, value
+      button + image_button
+    end
+
+    # @private
+    def _button_contains_string(value)
+      button       = string_visible_contains Button, value
+      image_button = string_visible_contains ImageButton, value
+      button + image_button
+    end
   end # module Android
 end # module Appium

data/lib/appium_lib/android/element/generic.rb

@@ -39,12 +39,16 @@ module Appium
     # @return [Element] the element scrolled to
     def scroll_to(text, scrollable_index = 0)
       text = %("#{text}")
-
-      args = scroll_uiselector("new UiSelector().textContains(#{text})", scrollable_index) +
-             scroll_uiselector("new UiSelector().descriptionContains(#{text})", scrollable_index) +
-             scroll_uiselector(resource_id(text, "new UiSelector().resourceId(#{text});"), scrollable_index)
-
-      find_element :uiautomator, args
+      rid  = resource_id(text, "new UiSelector().resourceId(#{text});")
+      args = rid.empty? ? ["new UiSelector().textContains(#{text})", "new UiSelector().descriptionContains(#{text})"] : [rid]
+      args.each_with_index do |arg, index|
+        begin
+          elem = find_element :uiautomator, scroll_uiselector(arg, scrollable_index)
+          return elem
+        rescue => e
+          raise e if index == args.size - 1
+        end
+      end
     end
 
     # Scroll to the first element with the exact target text or description.
@@ -53,12 +57,16 @@ module Appium
     # @return [Element] the element scrolled to
     def scroll_to_exact(text, scrollable_index = 0)
       text = %("#{text}")
-
-      args = scroll_uiselector("new UiSelector().text(#{text})", scrollable_index) +
-             scroll_uiselector("new UiSelector().description(#{text})", scrollable_index) +
-             scroll_uiselector(resource_id(text, "new UiSelector().resourceId(#{text});"), scrollable_index)
-
-      find_element :uiautomator, args
+      rid  = resource_id(text, "new UiSelector().resourceId(#{text});")
+      args = rid.empty? ? ["new UiSelector().text(#{text})", "new UiSelector().description(#{text})"] : [rid]
+      args.each_with_index do |arg, index|
+        begin
+          elem = find_element :uiautomator, scroll_uiselector(arg, scrollable_index)
+          return elem
+        rescue => e
+          raise e if index == args.size - 1
+        end
+      end
     end
   end # module Android
 end # module Appium

data/lib/appium_lib/android/helper.rb

@@ -23,7 +23,7 @@ module Appium
       end
 
       # http://nokogiri.org/Nokogiri/XML/SAX/Document.html
-      def start_element(name, attrs = [])
+      def start_element(name, attrs = [], driver = $driver)
         return if filter && !name.downcase.include?(filter)
 
         attributes = {}
@@ -34,7 +34,7 @@ module Appium
 
         # scoped to: text resource-id content-desc
         attributes_values = attributes.values
-        strings           = $driver.lazy_load_strings
+        strings           = driver.lazy_load_strings
         id_matches = strings.empty? ? [] : strings.select { |_key, value| attributes_values.include? value }
 
         string_ids = nil
@@ -285,13 +285,7 @@ module Appium
     # @param value [String] the value to search for
     # @return [Element]
     def complex_find_contains(class_name, value)
-      if automation_name_is_uiautomator2?
-        elements = find_elements :uiautomator, string_visible_contains(class_name, value)
-        raise _no_such_element if elements.empty?
-        elements.first
-      else
-        find_element :uiautomator, string_visible_contains(class_name, value)
-      end
+      find_element :uiautomator, string_visible_contains(class_name, value)
     end
 
     # Find all elements containing value
@@ -343,13 +337,7 @@ module Appium
     # @param value [String] the value to search for
     # @return [Element]
     def complex_find_exact(class_name, value)
-      if automation_name_is_uiautomator2?
-        elements = find_elements :uiautomator, string_visible_exact(class_name, value)
-        raise _no_such_element if elements.empty?
-        elements.first
-      else
-        find_element :uiautomator, string_visible_exact(class_name, value)
-      end
+      find_element :uiautomator, string_visible_exact(class_name, value)
     end
 
     # Find all elements exactly matching value

data/lib/appium_lib/android/uiautomator2/element/button.rb

@@ -0,0 +1,110 @@
+module Appium
+  module Android
+    module Uiautomator2
+      module Element
+        # Find the first button that contains value or by index.
+        # @param value [String, Integer] the value to exactly match.
+        # If int then the button at that index is returned.
+        # @return [Button]
+        def button(value)
+          # Don't use ele_index because that only works on one element type.
+          # Android needs to combine button and image button to match iOS.
+          if value.is_a? Numeric
+            index = value
+            raise "#{index} is not a valid index. Must be >= 1" if index <= 0
+
+            result = find_elements :uiautomator, _button_visible_selectors(index: index)
+            raise _no_such_element if result.empty?
+            return result[value - 1]
+          end
+
+          elements = find_elements :uiautomator, _button_contains_string(value)
+          raise_no_such_element_if_empty(elements)
+        end
+
+        # Find all buttons containing value.
+        # If value is omitted, all buttons are returned.
+        # @param value [String] the value to search for
+        # @return [Array<Button>]
+        def buttons(value = false)
+          return find_elements :uiautomator, _button_visible_selectors unless value
+          find_elements :uiautomator, _button_contains_string(value)
+        end
+
+        # Find the first button.
+        # @return [Button]
+        def first_button
+          elements = find_elements :uiautomator, _button_visible_selectors(button_index: 0, image_button_index: 0)
+          raise_no_such_element_if_empty(elements)
+        end
+
+        # Find the last button.
+        # @return [Button]
+        def last_button
+          # uiautomator index doesn't support last
+          # and it's 0 indexed
+          button_index = tags(::Appium::Android::Button).length
+          button_index -= 1 if button_index > 0
+          image_button_index = tags(::Appium::Android::ImageButton).length
+          image_button_index -= 1 if image_button_index > 0
+
+          elements = find_elements :uiautomator,
+                                   _button_visible_selectors(button_index: button_index,
+                                                             image_button_index: image_button_index)
+          raise_no_such_element_if_empty(elements)
+        end
+
+        # Find the first button that exactly matches value.
+        # @param value [String] the value to match exactly
+        # @return [Button]
+        def button_exact(value)
+          elements = find_elements :uiautomator, _button_exact_string(value)
+          raise_no_such_element_if_empty(elements)
+        end
+
+        # Find all buttons that exactly match value.
+        # @param value [String] the value to match exactly
+        # @return [Array<Button>]
+        def buttons_exact(value)
+          find_elements :uiautomator, _button_exact_string(value)
+        end
+
+        private
+
+        # @private
+        def raise_no_such_element_if_empty(elements)
+          raise _no_such_element if elements.empty?
+          elements.first
+        end
+
+        # @private
+        def _button_visible_selectors(opts = {})
+          button_index       = opts.fetch :button_index, false
+          image_button_index = opts.fetch :image_button_index, false
+
+          if button_index && image_button_index
+            "new UiSelector().className(#{::Appium::Android::Button}).instance(#{button_index});" \
+        "new UiSelector().className(#{::Appium::Android::ImageButton}).instance(#{image_button_index});"
+          else
+            "new UiSelector().className(#{::Appium::Android::Button});" \
+        "new UiSelector().className(#{::Appium::Android::ImageButton});"
+          end
+        end
+
+        # @private
+        def _button_exact_string(value)
+          button       = string_visible_exact ::Appium::Android::Button, value
+          image_button = string_visible_exact ::Appium::Android::ImageButton, value
+          button + image_button
+        end
+
+        # @private
+        def _button_contains_string(value)
+          button       = string_visible_contains ::Appium::Android::Button, value
+          image_button = string_visible_contains ::Appium::Android::ImageButton, value
+          button + image_button
+        end
+      end # module Element
+    end # module Uiautomator2
+  end # module Android
+end # module Appium

data/lib/appium_lib/android/uiautomator2/helper.rb

@@ -0,0 +1,85 @@
+module Appium
+  module Android
+    module Uiautomator2
+      module Helper
+        # Returns a string that matches the first element that contains value
+        # For automationName is Appium
+        # example: string_visible_contains 'UIATextField', 'sign in'
+        # note for XPath: https://github.com/appium/ruby_lib/pull/561
+        #
+        # @param class_name [String] the class name for the element
+        # @param value [String] the value to search for
+        # @return [String]
+        def string_visible_contains(class_name, value)
+          value = %("#{value}")
+          if class_name == '*'
+            return (resource_id(value, "new UiSelector().resourceId(#{value});") +
+                "new UiSelector().descriptionContains(#{value});" \
+                "new UiSelector().textContains(#{value});")
+          end
+
+          class_name = %("#{class_name}")
+          resource_id(value, "new UiSelector().className(#{class_name}).resourceId(#{value});") +
+              "new UiSelector().className(#{class_name}).descriptionContains(#{value});" \
+              "new UiSelector().className(#{class_name}).textContains(#{value});"
+        end
+
+        # Find the first element that contains value
+        # @param class_name [String] the class name for the element
+        # @param value [String] the value to search for
+        # @return [Element]
+        def complex_find_contains(class_name, value)
+          elements = find_elements :uiautomator, string_visible_contains(class_name, value)
+          raise _no_such_element if elements.empty?
+          elements.first
+        end
+
+        # Find all elements containing value
+        # @param class_name [String] the class name for the element
+        # @param value [String] the value to search for
+        # @return [Array<Element>]
+        def complex_finds_contains(class_name, value)
+          find_elements :uiautomator, string_visible_contains(class_name, value)
+        end
+
+        # @private
+        # Create an string to exactly match the first element with target value
+        # @param class_name [String] the class name for the element
+        # @param value [String] the value to search for
+        # @return [String]
+        def string_visible_exact(class_name, value)
+          value = %("#{value}")
+
+          if class_name == '*'
+            return (resource_id(value, "new UiSelector().resourceId(#{value});") +
+                "new UiSelector().description(#{value});" \
+                "new UiSelector().text(#{value});")
+          end
+
+          class_name = %("#{class_name}")
+          resource_id(value, "new UiSelector().className(#{class_name}).resourceId(#{value});") +
+              "new UiSelector().className(#{class_name}).description(#{value});" \
+              "new UiSelector().className(#{class_name}).text(#{value});"
+        end
+
+        # Find the first element exactly matching value
+        # @param class_name [String] the class name for the element
+        # @param value [String] the value to search for
+        # @return [Element]
+        def complex_find_exact(class_name, value)
+          elements = find_elements :uiautomator, string_visible_exact(class_name, value)
+          raise _no_such_element if elements.empty?
+          elements.first
+        end
+
+        # Find all elements exactly matching value
+        # @param class_name [String] the class name for the element
+        # @param value [String] the value to search for
+        # @return [Element]
+        def complex_finds_exact(class_name, value)
+          find_elements :uiautomator, string_visible_exact(class_name, value)
+        end
+      end # module Helper
+    end # module Uiautomator2
+  end # module Android
+end # module Appium