appium_lib 8.2.1 → 9.0.0

data/docs/ios_xcuitest.md

@@ -0,0 +1,25 @@
+## XCUITest
+- Over Appium1.6.0 provides `XCUITest` automation name based on WebDriverAgent.
+    - [appium-xcuitest-driver](https://github.com/appium/appium-xcuitest-driver)
+    - [WebDriverAgent](https://github.com/facebook/WebDriverAgent)
+- How to migrate XCUITest from UIAutomation
+    - [Migrating your iOS tests from UIAutomation](https://github.com/appium/appium/blob/v1.6.2/docs/en/advanced-concepts/migrating-to-xcuitest.md)
+
+
+### Elements
+- supported elements by find_element is:
+    - [appium-xcuitest-driver](https://github.com/appium/appium-xcuitest-driver/blob/master/lib/commands/find.js#L17)
+    - [WebDriverAgent](https://github.com/facebook/WebDriverAgent/blob/8346199212bffceab24192e81bc0118d65132466/WebDriverAgentLib/Commands/FBFindElementCommands.m#L111)
+- Mapping
+    - https://github.com/facebook/WebDriverAgent/blob/master/WebDriverAgentLib/Utilities/FBElementTypeTransformer.m#L19
+
+### XPath
+- It is better to avoid XPath strategy.
+    - https://github.com/appium/appium/blob/v1.6.2/docs/en/advanced-concepts/migrating-to-xcuitest.md#xpath-locator-strategy
+      > Try not to use XPath locators unless there is absolutely no other alternatives. In general, xpath locators might be times slower, than other types of locators like accessibility id, class name and predicate (up to 100 times slower in some special cases). They are so slow, because xpath location is not natively supported by Apple's XCTest framework.
+    - Improved performance a bit
+        - https://github.com/appium/appium/issues/6842
+        - https://github.com/facebook/WebDriverAgent/issues/306
+- XPath in WebDriverAgent
+    - https://github.com/facebook/WebDriverAgent/blob/2158a8d0f305549532f1338fe1e4628cfbd53cd9/WebDriverAgentLib/Categories/XCElementSnapshot%2BFBHelpers.m#L57
+

data/ios_tests/Gemfile

@@ -1,2 +1,4 @@
 source 'https://rubygems.org'
 gemspec path: File.expand_path('../../', __FILE__) # __dir__ fails on 1.9
+
+gem 'appium_console'

data/ios_tests/appium.txt

@@ -1,7 +1,8 @@
 [caps]
 platformName = "ios"
-platformVersion = "9.3"
+platformVersion = "10.1"
 deviceName ="iPhone Simulator"
+automationName = 'XCUITest'
 app = "./UICatalog.app"
 
 [appium_lib]

data/ios_tests/lib/common.rb

@@ -18,17 +18,111 @@ end
 def go_to_textfields
   screen.must_equal catalog
   wait_true do
-    text('textfield').click
+    UI::Inventory.xcuitest? ? find_element(:name, 'TextFields').click : text('textfield').click
     screen == 'TextFields' # wait for screen transition
   end
-
-  screen.must_equal 'TextFields'
 end
 
 def screen
-  $driver.find_element(:class, 'UIANavigationBar').name
+  $driver.find_element(:class, UI::Inventory.navbar).name
 end
 
 def catalog
   'UICatalog'
 end
+
+module UI
+  module Inventory
+    def self.xcuitest?
+      $driver.automation_name_is_xcuitest?
+    end
+
+    def self.navbar
+      if xcuitest?
+        'XCUIElementTypeNavigationBar'
+      else
+        'UIANavigationBar'
+      end
+    end
+
+    def self.button
+      if xcuitest?
+        'XCUIElementTypeButton'
+      else
+        'UIAButton'
+      end
+    end
+
+    def self.static_text
+      if xcuitest?
+        'XCUIElementTypeStaticText'
+      else
+        'UIAStaticText'
+      end
+    end
+
+    def self.text_field
+      if xcuitest?
+        'XCUIElementTypeTextField'
+      else
+        'UIATextField'
+      end
+    end
+
+    def self.secure_text_field
+      if xcuitest?
+        'XCUIElementTypeSecureTextField'
+      else
+        'UIASecureTextField'
+      end
+    end
+
+    def self.picker
+      if xcuitest?
+        'XCUIElementTypePicker'
+      else
+        'UIAPicker'
+      end
+    end
+
+    def self.action_sheet
+      if xcuitest?
+        'XCUIElementTypeActionSheet'
+      else
+        'UIActionSheet'
+      end
+    end
+
+    def self.table
+      if xcuitest?
+        'XCUIElementTypeTable'
+      else
+        'UIATable'
+      end
+    end
+
+    def self.table_cell
+      if xcuitest?
+        'XCUIElementTypeCell'
+      else
+        'UIATableCell'
+      end
+    end
+
+    def self.other
+      if xcuitest?
+        'XCUIElementTypeOther'
+      else
+        fail 'unknown UIA element: other'
+      end
+    end
+
+    def self.status_bar
+      if xcuitest?
+        'XCUIElementTypeStatusBar'
+      else
+        'UIAStatusBar'
+      end
+    end
+  end
+end

data/ios_tests/lib/ios/specs/common/helper.rb

@@ -70,18 +70,18 @@ describe 'common/helper.rb' do
 
   t 'back' do
     # start page
-    tag('UIANavigationBar').name.must_equal 'UICatalog'
+    tag(UI::Inventory.navbar).name.must_equal 'UICatalog'
     # nav to new page.
     wait_true do
       text('buttons').click
-      tag('UIANavigationBar').name == 'Buttons'
+      tag(UI::Inventory.navbar).name == 'Buttons'
     end
 
-    tag('UIANavigationBar').name.must_equal 'Buttons'
+    tag(UI::Inventory.navbar).name.must_equal 'Buttons'
     # go back
     back_click
     # start page
-    tag('UIANavigationBar').name.must_equal 'UICatalog'
+    tag(UI::Inventory.navbar).name.must_equal 'UICatalog'
   end
 
   t 'session_id' do
@@ -90,11 +90,11 @@ describe 'common/helper.rb' do
   end
 
   t 'xpath' do
-    xpath('//UIAStaticText').name.must_equal 'UICatalog'
+    xpath("//#{UI::Inventory.static_text}").name.must_equal 'UICatalog'
   end
 
   t 'xpaths' do
-    xpaths('//UIAStaticText').length.must_equal 25
+    xpaths("//#{UI::Inventory.static_text}").length.must_equal 25
   end
 
   def uibutton_text
@@ -102,13 +102,13 @@ describe 'common/helper.rb' do
   end
 
   t 'ele_index' do
-    ele_index('UIAStaticText', 2).name.must_equal uibutton_text
+    ele_index(UI::Inventory.static_text, 2).name.must_equal uibutton_text
   end
 
   # TODO: 'string_attr_exact'
 
   t 'find_ele_by_attr' do
-    el_id = find_ele_by_attr('UIAStaticText', 'name', uibutton_text).instance_variable_get :@id
+    el_id = find_ele_by_attr(UI::Inventory.static_text, 'name', uibutton_text).instance_variable_get :@id
     el_id.must_match(/\d+/)
   end
 
@@ -117,10 +117,10 @@ describe 'common/helper.rb' do
     # no space after the !
     set_wait 1
     # empty array returned when no match
-    found = !find_eles_by_attr('UIAStaticText', 'name', uibutton_text).empty?
+    found = !find_eles_by_attr(UI::Inventory.static_text, 'name', uibutton_text).empty?
     found.must_equal true
 
-    found = !find_eles_by_attr('UIAStaticText', 'name', 'zz').empty?
+    found = !find_eles_by_attr(UI::Inventory.static_text, 'name', 'zz').empty?
     found.must_equal false
     set_wait
   end
@@ -128,26 +128,29 @@ describe 'common/helper.rb' do
   # TODO: 'string_attr_include'
 
   t 'find_ele_by_attr_include' do
-    el_text = find_ele_by_attr_include('UIAStaticText', :name, 'button').text
+    el_text = find_ele_by_attr_include(UI::Inventory.static_text, :name, 'button').text
     el_text.must_equal uibutton_text
 
-    el_name = find_ele_by_attr_include('UIAStaticText', :name, 'button').name
+    el_name = find_ele_by_attr_include(UI::Inventory.static_text, :name, 'button').name
     el_name.must_equal uibutton_text
   end
 
   t 'find_eles_by_attr_include' do
-    ele_count = find_eles_by_attr_include('UIAStaticText', :name, 'e').length
-    ele_count.must_equal 19
+    ele_count = find_eles_by_attr_include(UI::Inventory.static_text, :name, 'e').length
+    expected = UI::Inventory.xcuitest? ? 20 : 19
+    ele_count.must_equal expected
   end
 
   t 'first_ele' do
-    first_ele('UIAStaticText').name.must_equal 'UICatalog'
+    first_ele(UI::Inventory.static_text).name.must_equal 'UICatalog'
   end
 
   t 'last_ele' do
-    el = last_ele('UIAStaticText')
-    el.text.must_equal 'Transitions'
-    el.name.must_equal 'Transitions'
+    expected = UI::Inventory.xcuitest? ? 'Shows UIViewAnimationTransitions' : 'Transitions'
+
+    el = last_ele(UI::Inventory.static_text)
+    el.text.must_equal expected
+    el.name.must_equal expected
   end
 
   # t 'source' do # tested by get_source
@@ -156,10 +159,6 @@ describe 'common/helper.rb' do
     get_source.class.must_equal String
   end
 
-  t 'id' do
-    id 'ButtonsExplain' # 'Various uses of UIButton'
-  end
-
   t 'invalid id should error' do
     proc { id 'does not exist' }.must_raise Selenium::WebDriver::Error::NoSuchElementError
 
@@ -168,15 +167,15 @@ describe 'common/helper.rb' do
   end
 
   t 'tag' do
-    tag('UIATableCell').name.must_equal uibutton_text
+    tag(UI::Inventory.navbar).name.must_equal 'UICatalog'
   end
 
   t 'tags' do
-    tags('UIATableCell').length.must_equal 12
+    tags(UI::Inventory.table_cell).length.must_equal 12
   end
 
   t 'find_eles_by_attr_include' do
-    find_eles_by_attr_include('UIAStaticText', 'name', 'Use').length.must_equal 7
+    find_eles_by_attr_include(UI::Inventory.static_text, 'name', 'Use').length.must_equal 7
   end
 
   t 'get_page_class' do
@@ -185,10 +184,7 @@ describe 'common/helper.rb' do
   end
 
   # TODO: write tests
-  # get_page_class
   # page_class
-  # tag
-  # tags
   # px_to_window_rel
   # lazy_load_strings
   # xml_keys

data/ios_tests/lib/ios/specs/common/patch.rb

@@ -48,7 +48,7 @@ describe 'common/patch.rb' do
       ensure
         set_wait
       end
-      value.must_equal 'Invalid locator strategy: css selector'
+      value.must_equal "Locator Strategy 'css selector' is not supported for this session"
     end
   end
 end

data/ios_tests/lib/ios/specs/device/device.rb

@@ -18,8 +18,10 @@ describe 'device/device' do
   end
 
   t 'lock' do
+    fail NotImplementedError, "XCUITest(Appium1.6.2) doesn't support yet" if UI::Inventory.xcuitest?
+
     lock 5
-    tag('UIAButton').name.must_equal 'SlideToUnlock'
+    tag(UI::Inventory.button).name.must_equal 'SlideToUnlock'
 
     # It appears that lockForDuration doesn't.
     close_app
@@ -32,18 +34,22 @@ describe 'device/device' do
   end
 
   t 'app_installed' do
+    fail NotImplementedError, "XCUITest(Appium1.6.2) doesn't support yet" if UI::Inventory.xcuitest?
+
     installed = app_installed? 'Derrp'
     installed.must_equal false
   end
 
   t 'shake' do
+    fail NotImplementedError, "XCUITest(Appium1.6.2) doesn't support yet" if UI::Inventory.xcuitest?
+
     shake
   end
 
   t 'close and launch' do
     close_app
     launch_app
-    tag('UIANavigationBar').name.must_equal 'UICatalog'
+    tag(UI::Inventory.navbar).name.must_equal 'UICatalog'
   end
 
   t 'reset' do
@@ -75,23 +81,23 @@ describe 'device/device' do
   end
 
   t 'swipe' do
-    swipe start_x: 75, start_y: 500, delta_x: 75, delta_y: 0, duration: 800
-  end
-
-  t 'pinch & zoom' do
-    wait { id('ImagesExplain').click }
-    # both of these appear to do nothing on iOS 8
-    zoom 200
-    pinch 75
-    go_back
+    swipe start_x: 75, start_y: 500, delta_x: 0, delta_y: -500, duration: 800
   end
 
   t 'pull_file' do
+    # Selenium::WebDriver::Error::UnknownError: An unknown server-side error occurred while processing the command.
+    # Original error: Cannot read property 'getDir' of undefined
+    fail NotImplementedError, "XCUITest(Appium1.6.2) doesn't support yet" if UI::Inventory.xcuitest?
+
     read_file = pull_file 'Library/AddressBook/AddressBook.sqlitedb'
     read_file.start_with?('SQLite format').must_equal true
   end
 
   t 'pull_folder' do
+    # Selenium::WebDriver::Error::UnknownError: An unknown server-side error occurred while processing the command.
+    # Original error: Cannot read property 'getDir' of undefined
+    fail NotImplementedError, "XCUITest(Appium1.6.2) doesn't support yet" if UI::Inventory.xcuitest?
+
     data = pull_folder 'Library/AddressBook'
     data.length.must_be :>, 1
   end

data/ios_tests/lib/ios/specs/device/multi_touch.rb

@@ -1,5 +1,26 @@
+# rake ios[device/multi_touch]
 describe 'device/multi_touch' do
-  t {} # place holder test
+  def before_first
+    screen.must_equal catalog
+  end
+
+  # go back to the main page
+  def go_back
+    back
+    wait { !exists { id 'ArrowButton'  } } # successfully transitioned back
+  end
+
+  t 'before_first' do
+    before_first
+  end
+
+  t 'pinch & zoom' do
+    wait { id('Images').click }
+    # both of these appear to do nothing on iOS 8
+    zoom 200
+    pinch 75
+    go_back
+  end
 end
 
 # TODO: write tests

data/ios_tests/lib/ios/specs/device/touch_actions.rb

@@ -1,18 +1,27 @@
+# rake ios[device/touch_actions]
 describe 'device/touch_actions' do
+  def after_last
+    back_click
+  end
+
   t 'swipe_default_duration' do
     wait_true do
-      text('pickers').click
+      wait { UI::Inventory.xcuitest? ? find_element(:name, 'Pickers').click : text('pickers').click }
       screen == 'Pickers'
     end
 
-    ele_index('UIAStaticText', 2).text.must_equal 'John Appleseed - 0'
-    picker = ele_index('UIAPicker', 1)
+    ele_index(UI::Inventory.static_text, 2).text.must_equal 'John Appleseed - 0'
+    picker = ele_index(UI::Inventory.picker, 1)
     loc = picker.location.to_h
     size = picker.size.to_h
     start_x = loc[:x] + size[:width] / 2
     start_y = loc[:y] + size[:height] / 2
-    swipe start_x: start_x, start_y: start_y, delta_x: start_x, delta_y: - 50
-    ele_index('UIAStaticText', 2).text.must_equal 'Chris Armstrong - 0'
+    swipe start_x: start_x, start_y: start_y, delta_x: 0, delta_y: - 50
+    ele_index(UI::Inventory.static_text, 2).text.must_equal 'Chris Armstrong - 0'
+  end
+
+  t 'after_last' do
+    after_last
   end
 end
 

data/ios_tests/lib/ios/specs/driver.rb

@@ -36,7 +36,8 @@ describe 'driver' do
       actual              = driver_attributes
       actual[:caps][:app] = File.basename actual[:caps][:app]
       expected            = { caps:             { platformName: 'ios',
-                                                  platformVersion: '9.3',
+                                                  platformVersion: '10.1',
+                                                  automationName: 'XCUITest',
                                                   deviceName:   'iPhone Simulator',
                                                   app:          'UICatalog.app' },
                               custom_url:       false,
@@ -145,7 +146,11 @@ describe 'driver' do
     end
 
     t 'driver' do
-      driver.browser.must_equal :iOS
+      driver.browser.must_be_empty
+    end
+
+    t 'automation_name_is_xcuitest?' do
+      automation_name_is_xcuitest?.must_equal UI::Inventory.xcuitest?
     end
 
     #
@@ -188,30 +193,29 @@ describe 'driver' do
 
     # simple integration sanity test to check for unexpected exceptions
     t 'set_location' do
+      fail NotImplementedError, "XCUITest(Appium1.6.2) doesn't support yet" if UI::Inventory.xcuitest?
       set_location latitude: 55, longitude: -72, altitude: 33
     end
 
-    # any script
-    t 'execute_script' do
-      execute_script %q(au.mainApp().getFirstWithPredicate("name contains[c] 'button'");)
-    end
-
     # any elements
     t 'find_elements' do
-      find_elements(:class, 'UIATableCell').length.must_equal 12
+      find_elements(:class, UI::Inventory.table_cell).length.must_equal 12
     end
 
     # any element
     t 'find_element' do
-      find_element(:class, 'UIAStaticText').class.must_equal Selenium::WebDriver::Element
+      find_element(:class, UI::Inventory.static_text).class.must_equal Selenium::WebDriver::Element
     end
 
     # settings
     t 'get settings' do
+      fail NotImplementedError, "XCUITest(Appium1.6.2) doesn't support yet" if UI::Inventory.xcuitest?
       get_settings.wont_be_nil
     end
 
     t 'update settings' do
+      fail NotImplementedError, "XCUITest(Appium1.6.2) doesn't support yet" if UI::Inventory.xcuitest?
+
       update_settings cyberdelia: 'open'
       get_settings['cyberdelia'].must_equal 'open'
     end