Feature/xcuitest (#388)

* swipe proffers use of delta_x, delta_y instead of end_x, end_y which are marked as deprecated

* stylistic compliance

* support for xcuitest backend driver

* cleaned up dependencies a little

* fixes for page command

* fix rubocop offences

* first passsupport both XCUITest and  UIAutomation automationName

* some xpath query fixes

* fix more rubocop offences

* rspec tests can target UIAutomation and XCUITest backends

* rubocop fix

* replace uiautomation SearchContext

* XCUITest => xcuitest

* use downcase to ensure XCUITest => ucuitest

Author: montdidier

appium_lib.gemspec

@@ -18,11 +18,11 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'awesome_print', '~> 1.6'
   s.add_runtime_dependency 'json', '~> 1.8'
   s.add_runtime_dependency 'tomlrb', '~> 1.1'
-  s.add_runtime_dependency 'nokogiri', '~> 1.6.6'
+  s.add_runtime_dependency 'nokogiri', '~> 1.6', '>= 1.6.6'
 
   s.add_development_dependency 'posix-spawn', '~> 0.3'
   s.add_development_dependency 'hashdiff', '~> 0.2.2'
-  s.add_development_dependency 'spec', '~> 5.3.4'
+  s.add_development_dependency 'spec', '~> 5.3', '>= 5.3.4'
   s.add_development_dependency 'fakefs', '~> 0.6.7'
 
   s.add_development_dependency 'rake', '~> 10.4'

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'

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]

ios_tests/lib/common.rb

@@ -32,3 +32,103 @@ def screen
 def catalog
   'UICatalog'
 end
+
+module UI
+  module Inventory
+    private
+
+    def self.xcuitest?
+      $driver.automation_name && $driver.automation_name == 'xcuitest'
+    end
+
+    public
+
+    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

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

@@ -70,18 +70,18 @@ def before_first
 
   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,25 +90,25 @@ def before_first
   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
     'Buttons'
   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,37 +117,37 @@ def uibutton_text
     # 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
 
   # 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
+    ele_count.must_equal 20
   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'
+    el = last_ele(UI::Inventory.static_text)
+    el.text.must_equal 'Shows UIViewAnimationTransitions'
+    el.name.must_equal 'Shows UIViewAnimationTransitions'
   end
 
   # t 'source' do # tested by get_source
@@ -156,10 +156,6 @@ def uibutton_text
     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 +164,15 @@ def uibutton_text
   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

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

@@ -48,7 +48,7 @@ def before_first
       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

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

@@ -19,7 +19,7 @@ def go_back
 
   t 'lock' do
     lock 5
-    tag('UIAButton').name.must_equal 'SlideToUnlock'
+    tag(UI::Inventory.button).name.must_equal 'SlideToUnlock'
 
     # It appears that lockForDuration doesn't.
     close_app
@@ -43,7 +43,7 @@ def go_back
   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

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

@@ -5,14 +5,14 @@
       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'
+    ele_index(UI::Inventory.static_text, 2).text.must_equal 'Chris Armstrong - 0'
   end
 end
 

ios_tests/lib/ios/specs/driver.rb

@@ -36,7 +36,8 @@ def sauce?
       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,
@@ -191,19 +192,14 @@ def sauce?
       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

ios_tests/lib/ios/specs/ios/element/alert.rb

@@ -4,10 +4,10 @@ def nav_once
     screen.must_equal catalog
     wait_true do
       text('alerts').click
-      tag('UIANavigationBar').name == 'Alerts' # wait for true
+      tag(UI::Inventory.navbar).name == 'Alerts' # wait for true
     end
 
-    tag('UIANavigationBar').name.must_equal 'Alerts'
+    tag(UI::Inventory.navbar).name.must_equal 'Alerts'
 
     # redefine method as no-op after it's invoked once
     self.class.send :define_method, :nav_once, proc {}

ios_tests/lib/ios/specs/ios/element/text.rb

@@ -23,8 +23,8 @@ def before_first
   end
 
   t 'last_text' do
-    last_text.text.must_equal uiview_transitions
-    last_text.name.must_equal uiview_transitions
+    last_text.text.must_equal 'Shows UIViewAnimationTransitions'
+    last_text.name.must_equal 'Shows UIViewAnimationTransitions'
   end
 
   t 'text' do
@@ -35,7 +35,7 @@ def before_first
 
   t 'texts' do
     exp = ['Controls', 'Various uses of UIControl', 'Various uses of UISegmentedControl']
-    texts.length.must_equal 24
+    texts.length.must_equal 25
     texts('trol').map(&:name).must_equal exp
     texts('uses').length.must_equal 7
   end

ios_tests/readme.md

@@ -12,12 +12,13 @@ ruby_lib's iOS tests. Requires `Ruby 1.9.3` or better.
 
 `UICatalog6.1` is from [appium/appium](https://github.com/appium/appium/blob/master/assets/UICatalog6.1.app.zip)
 
-The tests are now run against `iPhone 6 Simulator 9.3 (12F69)`
+There are two backend drivers available for iOS (automationName). UIAutomation which is supported up-to iOS 9.3 and XCUITest which is supported from 10.0 on. UIAutomation is deprecated but will continue to be supported for the time being.
 
+By default, the tests are now run against `iPhone 6 Simulator 10.1 (14A345)`
 #### Documentation
 
 - [Installing Appium on OS X](https://github.com/appium/ruby_console/blob/master/osx.md)
-- [Overview](https://github.com/appium/ruby_lib/blob/master/docs/docs.md) 
+- [Overview](https://github.com/appium/ruby_lib/blob/master/docs/docs.md)
 - [iOS methods](https://github.com/appium/ruby_lib/blob/master/docs/ios_docs.md)
 - [Minitest Expectations](http://ruby-doc.org/stdlib-1.9.3/libdoc/minitest/spec/rdoc/MiniTest/Expectations.html)