appium_lib 8.2.1 → 9.0.0

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

@@ -4,28 +4,44 @@ module Appium
     # @param value [String] the value to search for
     # @return [Element]
     def find(value)
-      ele_by_json_visible_contains '*', value
+      if automation_name_is_xcuitest?
+        find_ele_by_attr_include '*', '*', value
+      else
+        ele_by_json_visible_contains '*', value
+      end
     end
 
     # Find all elements containing value
     # @param value [String] the value to search for
     # @return [Array<Element>]
     def finds(value)
-      eles_by_json_visible_contains '*', value
+      if automation_name_is_xcuitest?
+        find_eles_by_attr_include '*', '*', value
+      else
+        eles_by_json_visible_contains '*', value
+      end
     end
 
     # Find the first element exactly matching value
     # @param value [String] the value to search for
     # @return [Element]
     def find_exact(value)
-      ele_by_json_visible_exact '*', value
+      if automation_name_is_xcuitest?
+        find_ele_by_attr '*', '*', value
+      else
+        ele_by_json_visible_exact '*', value
+      end
     end
 
     # Find all elements exactly matching value
     # @param value [String] the value to search for
     # @return [Array<Element>]
     def finds_exact(value)
-      eles_by_json_visible_exact '*', value
+      if automation_name_is_xcuitest?
+        find_ele_by_attr '*', '*', value
+      else
+        eles_by_json_visible_exact '*', value
+      end
     end
   end # module Ios
 end # module Appium

data/lib/appium_lib/ios/element/text.rb

@@ -1,50 +1,74 @@
-# UIAStaticText methods
+# UIAStaticText|XCUIElementTypeStaticText methods
 module Appium
   module Ios
-    UIAStaticText = 'UIAStaticText'
+    IAStaticText = 'UIAStaticText'.freeze
+    XCUIElementTypeStaticText = 'XCUIElementTypeStaticText'.freeze
 
-    # Find the first UIAStaticText that contains value or by index.
+    # @return [String] Class name for text
+    def static_text_class
+      automation_name_is_xcuitest? ? XCUIElementTypeStaticText : IAStaticText
+    end
+
+    # Find the first UIAStaticText|XCUIElementTypeStaticText that contains value or by index.
     # @param value [String, Integer] the value to find.
-    # If int then the UIAStaticText at that index is returned.
-    # @return [UIAStaticText]
+    # If int then the UIAStaticText|XCUIElementTypeStaticText at that index is returned.
+    # @return [UIAStaticText|XCUIElementTypeStaticText]
     def text(value)
-      return ele_index UIAStaticText, value if value.is_a? Numeric
-      ele_by_json_visible_contains UIAStaticText, value
+      return ele_index static_text_class, value if value.is_a? Numeric
+
+      if automation_name_is_xcuitest?
+        find_ele_by_attr_include static_text_class, '*', value
+      else
+        ele_by_json_visible_contains static_text_class, value
+      end
     end
 
-    # Find all UIAStaticText containing value.
-    # If value is omitted, all UIAStaticTexts are returned
+    # Find all UIAStaticTexts|XCUIElementTypeStaticTexts containing value.
+    # If value is omitted, all UIAStaticTexts|XCUIElementTypeStaticTexts are returned
     # @param value [String] the value to search for
-    # @return [Array<UIAStaticText>]
+    # @return [Array<UIAStaticText|XCUIElementTypeStaticText>]
     def texts(value = false)
-      return tags UIAStaticText unless value
-      eles_by_json_visible_contains UIAStaticText, value
+      return tags static_text_class unless value
+
+      if automation_name_is_xcuitest?
+        find_eles_by_attr_include static_text_class, '*', value
+      else
+        eles_by_json_visible_contains static_text_class, value
+      end
     end
 
-    # Find the first UIAStaticText.
-    # @return [UIAStaticText]
+    # Find the first UIAStaticText|XCUIElementTypeStaticText.
+    # @return [UIAStaticText|XCUIElementTypeStaticText]
     def first_text
-      first_ele UIAStaticText
+      first_ele static_text_class
     end
 
-    # Find the last UIAStaticText.
-    # @return [UIAStaticText]
+    # Find the last UIAStaticText|XCUIElementTypeStaticText.
+    # @return [UIAStaticText|XCUIElementTypeStaticText]
     def last_text
-      last_ele UIAStaticText
+      last_ele static_text_class
     end
 
-    # Find the first UIAStaticText that exactly matches value.
+    # Find the first UIAStaticText|XCUIElementTypeStaticText that exactly matches value.
     # @param value [String] the value to match exactly
-    # @return [UIAStaticText]
+    # @return [UIAStaticText|XCUIElementTypeStaticText]
     def text_exact(value)
-      ele_by_json_visible_exact UIAStaticText, value
+      if automation_name_is_xcuitest?
+        find_ele_by_attr static_text_class, '*', value
+      else
+        ele_by_json_visible_exact static_text_class, value
+      end
     end
 
-    # Find all UIAStaticTexts that exactly match value.
+    # Find all UIAStaticTexts|XCUIElementTypeStaticTexts that exactly match value.
     # @param value [String] the value to match exactly
-    # @return [Array<UIAStaticText>]
+    # @return [Array<UIAStaticText|XCUIElementTypeStaticText>]
     def texts_exact(value)
-      eles_by_json_visible_exact UIAStaticText, value
+      if automation_name_is_xcuitest?
+        find_eles_by_attr static_text_class, '*', value
+      else
+        eles_by_json_visible_exact static_text_class, value
+      end
     end
   end # module Ios
 end # module Appium

data/lib/appium_lib/ios/element/textfield.rb

@@ -1,68 +1,87 @@
 module Appium
   module Ios
-    UIATextField       = 'UIATextField'
-    UIASecureTextField = 'UIASecureTextField'
+    UIATextField = 'UIATextField'.freeze
+    UIASecureTextField = 'UIASecureTextField'.freeze
+
+    XCUIElementTypeTextField = 'XCUIElementTypeTextField'.freeze
+    XCUIElementTypeSecureTextField = 'XCUIElementTypeSecureTextField'.freeze
+
+    # @return [String] Class name for text field
+    def text_field_class
+      automation_name_is_xcuitest? ? XCUIElementTypeTextField : UIATextField
+    end
+
+    # @return [String] Class name for secure text field
+    def secure_text_field_class
+      automation_name_is_xcuitest? ? XCUIElementTypeSecureTextField : UIASecureTextField
+    end
 
     private
 
     # @private
-    def _textfield_visible
-      {
-        typeArray:   [UIATextField, UIASecureTextField],
-        onlyVisible: true
-      }
+    # for XCUITest
+    def _textfields
+      %(#{text_field_class} | //#{secure_text_field_class})
     end
 
     # @private
+    # for XCUITest
+    def _textfield_with_xpath
+      xpath "//#{_textfields}"
+    end
+
+    # @private
+    # for XCUITest
+    def _textfields_with_xpath
+      xpaths "//#{_textfields}"
+    end
+
+    # Appium
+    def _textfield_visible
+      { typeArray: [UIATextField, UIASecureTextField], onlyVisible: true }
+    end
+
+    # Appium
     def _textfield_exact_string(value)
-      exact     = {
-        target:      value,
-        substring:   false,
-        insensitive: false
-      }
-      exact_obj = {
-        name:  exact,
-        label: exact,
-        value: exact
-      }
+      exact = { target: value, substring: false, insensitive: false }
+      exact_obj = { name:  exact, label: exact, value: exact }
       _textfield_visible.merge(exact_obj)
     end
 
-    # @private
+    # Appium
     def _textfield_contains_string(value)
-      contains     = {
-        target:      value,
-        substring:   true,
-        insensitive: true
-      }
-      contains_obj = {
-        name:  contains,
-        label: contains,
-        value: contains
-      }
+      contains = { target: value, substring: true, insensitive: true }
+      contains_obj = { name: contains, label: contains, value: contains }
       _textfield_visible.merge(contains_obj)
     end
 
     public
 
     # Find the first TextField that contains value or by index.
+    # Note: Uses XPath
     # @param value [String, Integer] the text to match exactly.
     # If int then the TextField at that index is returned.
     # @return [TextField]
     def textfield(value)
-      # Don't use ele_index because that only works on one element type.
-      # iOS needs to combine textfield and secure to match Android.
       if value.is_a? Numeric
         index = value
         fail "#{index} is not a valid index. Must be >= 1" if index <= 0
-        index -= 1 # eles_by_json is 0 indexed.
-
-        result = eles_by_json(_textfield_visible)[index]
+        index -= 1 # eles_by_json and _textfields_with_xpath is 0 indexed.
+        result = if automation_name_is_xcuitest?
+                   _textfields_with_xpath[index]
+                 else
+                   eles_by_json(_textfield_visible)[index]
+                 end
         fail _no_such_element if result.nil?
         return result
+
       end
 
-      ele_by_json _textfield_contains_string value
+      if automation_name_is_xcuitest?
+        find_ele_by_attr_include _textfields, '*', value
+      else
+        ele_by_json _textfield_contains_string value
+      end
     end
 
     # Find all TextFields containing value.
@@ -70,20 +89,33 @@ module Appium
     # @param value [String] the value to search for
     # @return [Array<TextField>]
     def textfields(value = false)
-      return eles_by_json _textfield_visible unless value
-      eles_by_json _textfield_contains_string value
+      if automation_name_is_xcuitest?
+        return _textfields_with_xpath unless value
+        find_eles_by_attr_include _textfields, '*', value
+      else
+        return eles_by_json _textfield_visible unless value
+        eles_by_json _textfield_contains_string value
+      end
     end
 
     # Find the first TextField.
     # @return [TextField]
     def first_textfield
-      ele_by_json _textfield_visible
+      if automation_name_is_xcuitest?
+        _textfield_with_xpath
+      else
+        ele_by_json _textfield_visible
+      end
     end
 
     # Find the last TextField.
     # @return [TextField]
     def last_textfield
-      result = eles_by_json(_textfield_visible).last
+      result = if automation_name_is_xcuitest?
+                 _textfields_with_xpath.last
+               else
+                 eles_by_json(_textfield_visible).last
+               end
       fail _no_such_element if result.nil?
       result
     end
@@ -92,14 +124,22 @@ module Appium
     # @param value [String] the value to match exactly
     # @return [TextField]
     def textfield_exact(value)
-      ele_by_json _textfield_exact_string value
+      if automation_name_is_xcuitest?
+        find_ele_by_attr _textfields, '*', value
+      else
+        ele_by_json _textfield_exact_string value
+      end
     end
 
     # Find all TextFields that exactly match value.
     # @param value [String] the value to match exactly
     # @return [Array<TextField>]
     def textfields_exact(value)
-      eles_by_json _textfield_exact_string value
+      if automation_name_is_xcuitest?
+        find_eles_by_attr _textfields, '*', value
+      else
+        eles_by_json _textfield_exact_string value
+      end
     end
   end # module Ios
 end # module Appium

data/lib/appium_lib/ios/helper.rb

@@ -1,5 +1,41 @@
 module Appium
   module Ios
+    class UITestElementsPrinter < Nokogiri::XML::SAX::Document
+      attr_accessor :filter
+
+      def start_element(type, attrs = [])
+        return if filter && !filter.eql?(type)
+        page = attrs.inject({}) do |hash, attr|
+          hash[attr[0]] = attr[1] if %w(name label value hint).include?(attr[0])
+          hash
+        end
+        _print_attr(type, page['name'], page['label'], page['value'], page['hint'])
+      end
+
+      def _print_attr(type, name, label, value, hint)
+        if name == label && name == value
+          puts "#{type}" if name || label || value || hint
+          puts "   name, label, value: #{name}" if name
+          puts "   hint: #{hint}" if hint
+        elsif name == label
+          puts "#{type}" if name || label || value || hint
+          puts "   name, label: #{name}" if name
+          puts "   value: #{value}" if value
+          puts "   hint: #{hint}" if hint
+        elsif name == value
+          puts "#{type}" if name || label || value || hint
+          puts "   name, value: #{name}" if name
+          puts "  label: #{label}" if label
+          puts "   hint: #{hint}" if hint
+        else
+          puts "#{type}" if name || label || value || hint
+          puts "   name: #{name}" if name
+          puts "  label: #{label}" if label
+          puts "  value: #{value}" if value
+          puts "   hint: #{hint}" if hint
+        end
+      end
+    end
     # iOS only. On Android uiautomator always returns an empty string for EditText password.
     #
     # Password character returned from value of UIASecureTextField
@@ -143,14 +179,13 @@ module Appium
         parser.parse s
         parser.document.result
       else
-        if window_number == -1
-          # if the 0th window has no children, find the next window that does.
-          target_window = source_window 0
-          target_window = source_window 1 if target_window['children'].empty?
-          get_page target_window, class_name
-        else
-          get_page source_window(window_number || 0), class_name
+
+        s = source_window(window_number || 0)
+        parser = Nokogiri::XML::SAX::Parser.new(UITestElementsPrinter.new)
+        if class_name
+          parser.document.filter = class_name.is_a?(Symbol) ? class_name.to_s : class_name
         end
+        parser.parse s
         nil
       end
     end
@@ -158,12 +193,13 @@ module Appium
     # Gets the JSON source of window number
     # @param window_number [Integer] the int index of the target window
     # @return [JSON]
-    def source_window(window_number = 0)
+    def source_window(_window_number = 0)
+      # TODO: update comments
       # appium 1.0 still returns JSON when getTree() is invoked so this
       # doesn't need to change to XML. If getTree() is removed then
       # source_window will need to parse the elements of getTreeForXML()\
       # https://github.com/appium/appium-uiauto/blob/247eb71383fa1a087ff8f8fc96fac25025731f3f/uiauto/appium/element.js#L145
-      execute_script "UIATarget.localTarget().frontMostApp().windows()[#{window_number}].getTree()"
+      get_source
     end
 
     # Prints parsed page source to console.
@@ -181,14 +217,18 @@ module Appium
     # @param id [String] the id to search for
     # @return [Element]
     def id(id)
-      find_element :id, id
+      find_element(:id, id)
     end
 
     # Return the iOS version as an array of integers
     # @return [Array<Integer>]
     def ios_version
-      ios_version = execute_script 'UIATarget.localTarget().systemVersion()'
-      ios_version.split('.').map(&:to_i)
+      if automation_name_is_xcuitest?
+        @driver.capabilities['platformVersion']
+      else
+        ios_version = execute_script 'UIATarget.localTarget().systemVersion()'
+        ios_version.split('.').map(&:to_i)
+      end
     end
 
     # Get the element of type class_name at matching index.
@@ -213,7 +253,15 @@ module Appium
 
     # @private
     def string_attr_exact(class_name, attr, value)
-      %(//#{class_name}[@visible="true" and @#{attr}='#{value}'])
+      if automation_name_is_xcuitest?
+        if attr == '*'
+          %((//#{class_name})[@*[.='#{value}']])
+        else
+          %((//#{class_name})[@#{attr}='#{value}'])
+        end
+      else
+        %(//#{class_name}[@visible="true" and @#{attr}='#{value}'])
+      end
     end
 
     # Find the first element exactly matching class and attribute value.
@@ -238,7 +286,15 @@ module Appium
 
     # @private
     def string_attr_include(class_name, attr, value)
-      %(//#{class_name}[@visible="true" and contains(translate(@#{attr},'#{value.upcase}', '#{value}'), '#{value}')])
+      if automation_name_is_xcuitest?
+        if attr == '*'
+          %((//#{class_name})[@*[contains(translate(., '#{value.upcase}', '#{value}'), '#{value}')]])
+        else
+          %((//#{class_name})[contains(translate(@#{attr}, '#{value.upcase}', '#{value}'), '#{value}')])
+        end
+      else
+        %(//#{class_name}[@visible="true" and contains(translate(@#{attr},'#{value.upcase}', '#{value}'), '#{value}')])
+      end
     end
 
     # Get the first tag by attribute that exactly matches value.
@@ -265,15 +321,24 @@ module Appium
     # @param class_name [String] the tag to match
     # @return [Element]
     def first_ele(class_name)
-      # XPath index starts at 1
-      ele_index class_name, 1
+      if automation_name_is_xcuitest?
+        @driver.find_element :class, class_name
+      else
+        ele_index class_name, 1
+      end
     end
 
     # Get the last tag that matches class_name
     # @param class_name [String] the tag to match
     # @return [Element]
     def last_ele(class_name)
-      ele_index class_name, 'last()'
+      if automation_name_is_xcuitest?
+        result = @driver.find_elements :xpath, "(//#{class_name})"
+        fail _no_such_element if result.empty?
+        result.last
+      else
+        ele_index class_name, 'last()'
+      end
     end
 
     # Returns the first visible element matching class_name
@@ -281,10 +346,11 @@ module Appium
     # @param class_name [String] the class_name to search for
     # @return [Element]
     def tag(class_name)
-      ele_by_json(
-        typeArray:   [class_name],
-        onlyVisible: true
-      )
+      if automation_name_is_xcuitest?
+        first_ele(class_name)
+      else
+        ele_by_json(typeArray: [class_name], onlyVisible: true)
+      end
     end
 
     # Returns all visible elements matching class_name
@@ -292,10 +358,11 @@ module Appium
     # @param class_name [String] the class_name to search for
     # @return [Element]
     def tags(class_name)
-      eles_by_json(
-        typeArray:   [class_name],
-        onlyVisible: true
-      )
+      if automation_name_is_xcuitest?
+        @driver.find_elements :class, class_name
+      else
+        eles_by_json(typeArray: [class_name], onlyVisible: true)
+      end
     end
 
     # @private
@@ -322,7 +389,8 @@ module Appium
       }
     end
 
-    # Find the first element that contains value
+    # Find the first element that contains value.
+    # For Appium(automation name), not XCUITest
     # @param element [String] the class name for the element
     # @param value [String] the value to search for
     # @return [Element]
@@ -331,6 +399,7 @@ module Appium
     end
 
     # Find all elements containing value
+    # For Appium(automation name), not XCUITest
     # @param element [String] the class name for the element
     # @param value [String] the value to search for
     # @return [Array<Element>]
@@ -360,6 +429,7 @@ module Appium
     end
 
     # Find the first element exactly matching value
+    # For Appium(automation name), not XCUITest
     # @param element [String] the class name for the element
     # @param value [String] the value to search for
     # @return [Element]
@@ -368,6 +438,7 @@ module Appium
     end
 
     # Find all elements exactly matching value
+    # For Appium(automation name), not XCUITest
     # @param element [String] the class name for the element
     # @param value [String] the value to search for
     # @return [Element]
@@ -376,6 +447,7 @@ module Appium
     end
 
     # @private
+    # For Appium(automation name), not XCUITest
     # If there's no keyboard, then do nothing.
     # If there's no close key, fallback to window tap.
     # If close key is present then tap it.
@@ -489,6 +561,7 @@ module Appium
       end
     end
 
+    # For Appium(automation name), not XCUITest
     # typeArray - array of string types to search for. Example: ["UIAStaticText"]
     # onlyFirst - boolean. returns only the first result if true. Example: true
     # onlyVisible - boolean. returns only visible elements if true. Example: true
@@ -539,15 +612,15 @@ module Appium
       # $._elementOrElementsByType will validate that the window isn't nil
       element_or_elements_by_type = <<-JS
         (function() {
-        var opts = #{opts.to_json};
-        var result = false;
+          var opts = #{opts.to_json};
+          var result = false;
 
-        try {
-          result = $._elementOrElementsByType($.mainWindow(), opts);
-        } catch (e) {
-        }
+          try {
+            result = $._elementOrElementsByType($.mainWindow(), opts);
+          } catch (e) {
+          }
 
-        return result;
+          return result;
         })();
       JS
 
@@ -555,6 +628,7 @@ module Appium
       res ? res : fail(Selenium::Client::CommandError, 'mainWindow is nil')
     end
 
+    # For Appium(automation name), not XCUITest
     # example usage:
     #
     # eles_by_json({