appium_lib 8.2.1 → 9.0.0

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

@@ -3,18 +3,18 @@ describe 'ios/element/alert' do
   def nav_once
     screen.must_equal catalog
     wait_true do
-      text('alerts').click
-      tag('UIANavigationBar').name == 'Alerts' # wait for true
+      UI::Inventory.xcuitest? ? find_element(:name, 'Alerts').click : text('alerts').click
+      tag(UI::Inventory.navbar).name == 'Alerts' # wait for true
     end
 
-    tag('UIANavigationBar').name.must_equal 'Alerts'
-
     # redefine method as no-op after it's invoked once
     self.class.send :define_method, :nav_once, proc {}
   end
 
   def after_last
-    alert_accept if exists { text('UIActionSheet <title>') }
+    alert_accept if exists do
+      UI::Inventory.xcuitest? ? find_elements(:name, 'UIActionSheet <title>') : text('UIActionSheet <title>')
+    end
     back_click
     screen.must_equal catalog
     sleep 1
@@ -27,9 +27,13 @@ describe 'ios/element/alert' do
 
   def open_alert
     wait_true do
-      return true if exists { text('UIActionSheet <title>') }
-      text('Show OK-Cancel').click
-      text('UIActionSheet <title>').displayed?
+      if  UI::Inventory.xcuitest?
+        find_element(:name, 'Show OK-Cancel').click
+        find_element(:name, 'UIActionSheet <title>').displayed?
+      else
+        text('Show OK-Cancel').click
+        text('UIActionSheet <title>').displayed?
+      end
     end
   end
 

data/ios_tests/lib/ios/specs/ios/element/button.rb

@@ -3,7 +3,7 @@ describe 'ios/element/button' do
   def before_first
     screen.must_equal catalog
     # nav to buttons activity
-    wait { text('buttons').click }
+    wait { UI::Inventory.xcuitest? ? find_element(:name, 'Buttons').click : text('buttons').click }
   end
 
   def after_last
@@ -21,7 +21,7 @@ describe 'ios/element/button' do
 
   t 'button' do
     # by index
-    button(3).name.must_equal gray
+    button(3).name.must_equal gray # or UIButtonTypeInfoDark in XCUITest
 
     # by name contains
     button('ray').name.must_equal gray
@@ -29,6 +29,8 @@ describe 'ios/element/button' do
 
   t 'buttons' do
     exp = ['Back', 'Back', 'Gray', 'Right pointing arrow']
+    exp.concat ['Custom Text', 'More info', 'More info', 'More info', 'Add contact'] if UI::Inventory.xcuitest?
+
     target_buttons = buttons('a')
     target_buttons.map(&:name).must_equal exp
     target_buttons.length.must_equal exp.length
@@ -39,7 +41,8 @@ describe 'ios/element/button' do
   end
 
   t 'last_button' do
-    last_button.name.must_equal 'Rounded'
+    expected = UI::Inventory.xcuitest? ? 'Add contact' : 'Rounded'
+    last_button.name.must_equal expected
   end
 
   t 'button_exact' do

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

@@ -23,8 +23,10 @@ describe 'ios/element/text' do
   end
 
   t 'last_text' do
-    last_text.text.must_equal uiview_transitions
-    last_text.name.must_equal uiview_transitions
+    expected = UI::Inventory.xcuitest? ? 'Shows UIViewAnimationTransitions' : 'Transitions'
+
+    last_text.text.must_equal expected
+    last_text.name.must_equal expected
   end
 
   t 'text' do
@@ -35,7 +37,7 @@ describe 'ios/element/text' do
 
   t 'texts' do
     exp = ['Controls', 'Various uses of UIControl', 'Various uses of UISegmentedControl']
-    texts.length.must_equal 24
+    texts.length.must_equal(UI::Inventory.xcuitest? ? 25 : 24)
     texts('trol').map(&:name).must_equal exp
     texts('uses').length.must_equal 7
   end

data/ios_tests/lib/ios/specs/ios/element/textfield.rb

@@ -34,6 +34,8 @@ describe 'ios/element/textfield' do
   end
 
   t 'predicate textfields' do
+    fail NotImplementedError, "XCUITest(Appium1.6.2) doesn't support UIAutomation script" if UI::Inventory.xcuitest?
+
     textfield_count = execute_script(%(au.mainApp().getAllWithPredicate("type contains[c] 'textfield'", true))).length
     textfield_count.must_equal 4
   end
@@ -68,15 +70,17 @@ describe 'ios/element/textfield' do
 
   t 'textfield type' do
     # Regular send keys triggers the keyboard and doesn't dismiss
-    keyboard_must_not_exist
+    keyboard_must_not_exist unless UI::Inventory.xcuitest? # xcuitest doesn't support JS command
     textfield(1).send_keys 'ok'
-    keyboard_must_exist
-
-    # type should not dismiss the keyboard
-    message = 'type test type'
-    textfield(1).type message
-    keyboard_must_exist
-    textfield(1).text.must_equal message
+    keyboard_must_exist unless UI::Inventory.xcuitest? # xcuitest doesn't support JS command
+
+    unless UI::Inventory.xcuitest?
+      # type should not dismiss the keyboard
+      message = 'type test type'
+      textfield(1).type message
+      keyboard_must_exist
+      textfield(1).text.must_equal message
+    end
   end
 
   def must_raise_no_element(&block)

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

@@ -18,10 +18,16 @@ describe 'ios/helper' do
   # t 'page' do # writes to std out
 
   t 'source_window' do
-    source_window.length.must_equal 11
+    source_window.length.must_be :>=, 14_000
   end
 
   # TODO: t 'page_window' do
-  # TODO: t 'id' do
-  # TODO: t 'ios_version' do
+
+  t 'id' do
+    id 'Buttons' # 'Various uses of UIButton'
+  end
+
+  t 'ios_version' do
+    ios_version.wont_be_empty
+  end
 end

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

@@ -13,13 +13,21 @@ describe 'ios/patch' do
     before_first
   end
 
-  # TODO: test 'label'
+  t 'label' do
+    if UI::Inventory.xcuitest?
+      # Order of the elements are: Normal, Rounded, Secure, Check
+      find_element(:name, '<enter text>').label.must_equal 'Normal'
+    else
+      textfield('<enter text>').label.must_equal 'Rounded'
+    end
+  end
 
   t 'type' do
     # nav to textfield
     text('textfields').click
 
     ele = first_textfield
+
     ele.type 'ok'
     ele.text.must_equal 'ok'
   end

data/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)
 

data/lib/appium_lib/common/error.rb

@@ -0,0 +1,5 @@
+module Appium
+  module Error
+    class NotSupportedAppiumServer < RuntimeError; end
+  end
+end

data/lib/appium_lib/common/version.rb

@@ -1,5 +1,5 @@
 module Appium
   # Version and Date are defined on the 'Appium' module, not 'Appium::Common'
-  VERSION = '8.2.1' unless defined? ::Appium::VERSION
-  DATE    = '2016-11-29' unless defined? ::Appium::DATE
+  VERSION = '9.0.0' unless defined? ::Appium::VERSION
+  DATE    = '2016-12-09' unless defined? ::Appium::DATE
 end

data/lib/appium_lib/device/device.rb

@@ -212,7 +212,13 @@ module Appium
             end
 
             close_key ||= 'Done' # default to Done key.
-            $driver.hide_ios_keyboard close_key
+            if $driver.automation_name_is_xcuitest?
+              # strategy is not implemented in the following
+              # https://github.com/appium/appium-xcuitest-driver/blob/v2.2.0/lib/commands/general.js#L51
+              execute :hide_keyboard, {}, strategy: :grouped, key: close_key
+            else
+              $driver.hide_ios_keyboard close_key
+            end
           end
         end
 

data/lib/appium_lib/device/multi_touch.rb

@@ -29,13 +29,21 @@ module Appium
         fail ArgumentError("Can't pinch to greater than screen size.") if percentage > 100
 
         p = Float(percentage) / 100
-        i = 1 - p
 
-        top = TouchAction.new
-        top.swipe start_x: 1.0, start_y: 0.0, delta_x: i, delta_y: i, duration: 1
+        if $driver.automation_name_is_xcuitest?
+          ele = $driver.find_element :class, 'XCUIElementTypeApplication'
+          top = TouchAction.new
+          top.swipe({ start_x: 1.0, start_y: 0.0, delta_x: -p, delta_y: p }, ele)
+
+          bottom = TouchAction.new
+          bottom.swipe({ start_x: 0.0, start_y: 1.0, delta_x: p, delta_y: -p }, ele)
+        else
+          top = TouchAction.new
+          top.swipe start_x: 1.0, start_y: 0.0, delta_x: -p, delta_y: p, duration: 1
 
-        bottom = TouchAction.new
-        bottom.swipe(start_x: 0.0, start_y: 1.0, delta_x: p, delta_y: p, duration: 1)
+          bottom = TouchAction.new
+          bottom.swipe start_x: 0.0, start_y: 1.0, delta_x: p, delta_y: -p, duration: 1
+        end
 
         pinch = MultiTouch.new
         pinch.add top
@@ -59,11 +67,21 @@ module Appium
         p = 100 / Float(percentage)
         i = 1 - p
 
-        top = TouchAction.new
-        top.swipe start_x: i, start_y: i, delta_x: 1, delta_y: 1, duration: 1
+        if $driver.automation_name_is_xcuitest?
+          ele = $driver.find_element :class, 'XCUIElementTypeApplication'
+
+          top = TouchAction.new
+          top.swipe({ start_x: p, start_y: i, delta_x: i, delta_y: -i }, ele)
+
+          bottom = TouchAction.new
+          bottom.swipe({ start_x: i, start_y: p, delta_x: -i, delta_y: i }, ele)
+        else
+          top = TouchAction.new
+          top.swipe start_x: p, start_y: i, delta_x: i, delta_y: -i, duration: 1
 
-        bottom = TouchAction.new
-        bottom.swipe start_x: p, start_y: p, delta_x: 1, delta_y: 1, duration: 1
+          bottom = TouchAction.new
+          bottom.swipe start_x: i, start_y: p, delta_x: -i, delta_y: i, duration: 1
+        end
 
         zoom = MultiTouch.new
         zoom.add top

data/lib/appium_lib/device/touch_actions.rb

@@ -124,7 +124,7 @@ module Appium
     # @option opts [int] :delta_y The distance from start to move, on the y axis.  Default 0.
     # @option opts [int] :duration How long the actual swipe takes to complete in milliseconds. Default 200.
     # @deprecated Please do not use end_x, end_y anymore
-    def swipe(opts)
+    def swipe(opts, ele = nil)
       start_x  = opts.fetch :start_x, 0
       start_y  = opts.fetch :start_y, 0
       delta_x  = opts.fetch :delta_x, nil
@@ -144,10 +144,17 @@ module Appium
 
       duration = opts.fetch :duration, 200
 
-      press x: start_x, y: start_y
-      wait(duration) if duration
-      move_to x: start_x + delta_x, y: start_y + delta_y
-      release
+      if ele # pinch/zoom for XCUITest
+        press x: start_x, y: start_y, element: ele
+        move_to x: start_x + delta_x, y: start_y + delta_y, element: ele
+        release
+      else
+        press x: start_x, y: start_y
+        wait(duration) if duration
+        move_to x: start_x + delta_x, y: start_y + delta_y
+        release
+      end
+
       self
     end
 

data/lib/appium_lib/driver.rb

@@ -9,6 +9,7 @@ require_relative 'common/helper'
 require_relative 'common/wait'
 require_relative 'common/patch'
 require_relative 'common/version'
+require_relative 'common/error'
 require_relative 'common/element/window'
 
 # ios
@@ -50,6 +51,8 @@ module Minitest
 end
 
 module Appium
+  REQUIRED_VERSION_XCUITEST = '1.6.0'.freeze
+
   # Load arbitrary text (toml format)
   #
   # ```
@@ -265,11 +268,14 @@ module Appium
     attr_accessor :appium_port
     # Device type to request from the appium server
     attr_accessor :appium_device
+    # Automation name sent to appium server
+    attr_reader :automation_name
+    # Appium's server version
+    attr_reader :appium_server_version
     # Boolean debug mode for the Appium Ruby bindings
     attr_accessor :appium_debug
     # instance of AbstractEventListener for logging support
     attr_accessor :listener
-
     # Returns the driver
     # @return [Driver] the driver
     attr_reader :driver
@@ -329,6 +335,8 @@ module Appium
       @appium_device = @caps[:platformName]
       @appium_device = @appium_device.is_a?(Symbol) ? @appium_device : @appium_device.downcase.strip.intern if @appium_device
 
+      @automation_name = @caps[:automationName] if @caps[:automationName]
+
       # load common methods
       extend Appium::Common
       extend Appium::Device
@@ -386,6 +394,22 @@ module Appium
       @appium_device == :android
     end
 
+    # Return true if automationName is 'XCUITest'
+    # @return [Boolean]
+    def automation_name_is_xcuitest?
+      !@automation_name.nil? && @automation_name.downcase == 'xcuitest'
+    end
+
+    # Return true if the target Appium server is over REQUIRED_VERSION_XCUITEST.
+    # If the Appium server is under REQUIRED_VERSION_XCUITEST, then error is raised.
+    # @return [Boolean]
+    def check_server_version_xcuitest
+      if automation_name_is_xcuitest? && (@appium_server_version['build']['version'] <= REQUIRED_VERSION_XCUITEST)
+        fail Appium::Error::NotSupportedAppiumServer, "XCUITest requires over Appium #{REQUIRED_VERSION_XCUITEST}"
+      end
+      true
+    end
+
     # Returns the server's version info
     #
     # ```ruby
@@ -508,6 +532,10 @@ module Appium
         raise "ERROR: Unable to connect to Appium. Is the server running on #{server_url}?"
       end
 
+      @appium_server_version = appium_server_version
+
+      check_server_version_xcuitest
+
       @driver.manage.timeouts.implicit_wait = @default_wait
 
       @driver

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

@@ -1,51 +1,77 @@
-# UIAButton methods
+# XCUIElementTypeButton methods
 module Appium
   module Ios
-    UIAButton = 'UIAButton'
+    UIAButton = 'UIAButton'.freeze
+    XCUIElementTypeButton = 'XCUIElementTypeButton'.freeze
 
-    # Find the first UIAButton that contains value or by index.
+    # @return [String] Class name for button
+    def button_class
+      automation_name_is_xcuitest? ? XCUIElementTypeButton : UIAButton
+    end
+
+    # Find the first UIAButton|XCUIElementTypeButton that contains value or by index.
     # @param value [String, Integer] the value to exactly match.
-    # If int then the UIAButton at that index is returned.
-    # @return [UIAButton]
+    # If int then the UIAButton|XCUIElementTypeButton at that index is returned.
+    # @return [UIAButton|XCUIElementTypeButton]
     def button(value)
       # return button at index.
-      return ele_index UIAButton, value if value.is_a? Numeric
-      ele_by_json_visible_contains UIAButton, value
+      return ele_index button_class, value if value.is_a? Numeric
+
+      if automation_name_is_xcuitest?
+        find_ele_by_attr_include button_class, '*', value
+      else
+        ele_by_json_visible_contains button_class, value
+      end
     end
 
-    # Find all UIAButtons containing value.
-    # If value is omitted, all UIAButtons are returned.
+    # Find all UIAButtons|XCUIElementTypeButtons containing value.
+    # If value is omitted, all UIAButtons|XCUIElementTypeButtons are returned.
     # @param value [String] the value to search for
-    # @return [Array<UIAButton>]
+    # @return [Array<UIAButton|XCUIElementTypeButton>]
     def buttons(value = false)
-      return tags UIAButton unless value
-      eles_by_json_visible_contains UIAButton, value
+      return tags button_class unless value
+
+      if automation_name_is_xcuitest?
+        find_eles_by_attr_include button_class, '*', value
+      else
+        eles_by_json_visible_contains button_class, value
+      end
     end
 
-    # Find the first UIAButton.
-    # @return [UIAButton]
+    # Find the first UIAButton|XCUIElementTypeButton.
+    # @return [UIAButton|XCUIElementTypeButton]
     def first_button
-      first_ele UIAButton
+      first_ele button_class
     end
 
-    # Find the last UIAButton.
-    # @return [UIAButton]
+    # TODO: add documentation regarding previous element.
+    #       Previous UIAElement is differ from UIAButton|XCUIElementTypeButton. So, the results are different.
+    # Find the last UIAButton|XCUIElementTypeButton.
+    # @return [UIAButton|XCUIElementTypeButton]
     def last_button
-      last_ele UIAButton
+      last_ele button_class
     end
 
-    # Find the first UIAButton that exactly matches value.
+    # Find the first UIAButton|XCUIElementTypeButton that exactly matches value.
     # @param value [String] the value to match exactly
-    # @return [UIAButton]
+    # @return [UIAButton|XCUIElementTypeButton]
     def button_exact(value)
-      ele_by_json_visible_exact UIAButton, value
+      if automation_name_is_xcuitest?
+        find_ele_by_attr button_class, '*', value
+      else
+        ele_by_json_visible_exact button_class, value
+      end
     end
 
-    # Find all UIAButtons that exactly match value.
+    # Find all UIAButtons|XCUIElementTypeButtons that exactly match value.
     # @param value [String] the value to match exactly
-    # @return [Array<UIAButton>]
+    # @return [Array<UIAButton|XCUIElementTypeButton>]
     def buttons_exact(value)
-      eles_by_json_visible_exact UIAButton, value
+      if automation_name_is_xcuitest?
+        find_eles_by_attr button_class, '*', value
+      else
+        eles_by_json_visible_exact button_class, value
+      end
     end
   end # module Ios
 end # module Appium