appium_lib 9.7.2 → 9.7.3

data/docs/ios_xcuitest.md

@@ -8,10 +8,6 @@
     - [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/docs/parallel.md

@@ -0,0 +1,8 @@
+Appium 1.7.0+ supports single server and multiple sessions, and it requires Xcode 9 for iOS.
+
+# Example
+## 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
+    - Thread programming: TestParallelRunThread
+    - Process programming: TestParallelRunProcess

data/lib/appium_lib/android/android.rb

@@ -9,6 +9,9 @@ require_relative 'element/text'
 # android - uiautomator2
 require_relative 'uiautomator2'
 
+# android - espresso
+require_relative 'espresso'
+
 module Appium
   module Android
     class Bridge

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

@@ -122,6 +122,9 @@ module Appium
     # "mFocusedApp=AppWindowToken{b1420058 token=Token{b128add0
     #  ActivityRecord{b1264d10 u0 com.example.android.apis/.ApiDemos t23}}}"
     def current_app
+      warn '[DEPRECATION] current_app will be removed since it work only local.' \
+             'Please use current_activity and current_app to know package and activity for current app'
+
       line = `adb shell dumpsys window windows`.each_line.grep(/mFocusedApp/).first.strip
 
       _parse_current_app_line line

data/lib/appium_lib/android/espresso.rb

@@ -0,0 +1,9 @@
+require_relative 'espresso/bridge'
+
+module Appium
+  module Android
+    module Espresso
+      # parent
+    end # module Uiautomator2
+  end # module Android
+end # module Appium

data/lib/appium_lib/android/espresso/bridge.rb

@@ -0,0 +1,14 @@
+require_relative '../android'
+
+module Appium
+  module Android
+    module Espresso
+      class Bridge
+        def self.for(target)
+          target.extend Appium::Android
+          target.extend Appium::Android::Espresso
+        end
+      end
+    end
+  end
+end

data/lib/appium_lib/common/multi_touch.rb

@@ -23,7 +23,7 @@ module Appium
   #   multi_touch_action.add action_2
   #   multi_touch_action.perform
   #
-  class MultiTouch < ::Appium::Core::MultiTouch
+  class MultiTouch
     class << self
       # Convenience method for pinching the screen.
       # Places two fingers at the edges of the screen and brings them together.
@@ -49,7 +49,23 @@ module Appium
       #   pinch 75, true, driver #=> Pinch the screen from the top right and bottom left corners
       #
       def pinch(percentage = 25, auto_perform = true, driver = $driver)
-        ::Appium::Core::MultiTouch.pinch percentage: percentage, auto_perform: auto_perform, driver: driver
+        raise ArgumentError("Can't pinch to greater than screen size.") if percentage > 100
+
+        rate = Float(percentage) / 100
+        pinch = MultiTouch.new(driver)
+
+        if driver.automation_name_is_xcuitest?
+          top, bottom = pinch_for_xcuitest(rate, pinch.driver)
+        elsif driver.device_is_android?
+          top, bottom = pinch_android(rate, pinch.driver)
+        else
+          top, bottom = pinch_ios(rate, pinch.driver)
+        end
+
+        pinch.add top
+        pinch.add bottom
+        return pinch unless auto_perform
+        pinch.perform
       end
 
       # Convenience method for zooming the screen.
@@ -77,12 +93,143 @@ module Appium
       #   pinch 200, true, driver #=> Zoom in the screen from the center until it doubles in size.
       #
       def zoom(percentage = 200, auto_perform = true, driver = $driver)
-        ::Appium::Core::MultiTouch.zoom percentage: percentage, auto_perform: auto_perform, driver: driver
+        raise ArgumentError("Can't zoom to smaller then screen size.") if percentage < 100
+
+        rate = 100 / Float(percentage)
+        zoom = MultiTouch.new(driver)
+
+        if driver.automation_name_is_xcuitest?
+          top, bottom = zoom_for_xcuitest(rate, zoom.driver)
+        elsif driver.device_is_android?
+          top, bottom = zoom_android(rate, zoom.driver)
+        else
+          top, bottom = zoom_ios(rate, zoom.driver)
+        end
+
+        zoom.add top
+        zoom.add bottom
+        return zoom unless auto_perform
+        zoom.perform
+      end
+
+      private
+
+      # @private
+      def pinch_android(rate, driver)
+        height = 100
+        offset = 100
+
+        top = ::Appium::Core::TouchAction.new(driver)
+        top.swipe start_x: offset, start_y: 1.0 * height + offset,
+                  offset_x: 0.0, offset_y: (rate - 1) * height, duration: 1_000
+
+        bottom = ::Appium::Core::TouchAction.new(driver)
+        bottom.swipe start_x: offset, start_y: 0.0 + offset,
+                     offset_x: 0.0, offset_y: (1 - rate) * height, duration: 1_000
+
+        [top, bottom]
+      end
+
+      # @private
+      def pinch_for_xcuitest(rate, driver)
+        height = 100
+        offset = 100
+
+        ele = driver.find_element :class, 'XCUIElementTypeApplication'
+        top = ::Appium::Core::TouchAction.new(driver)
+        top.swipe({ start_x: 0.5, start_y: 0.0 + offset,
+                    offset_x: 0.0, offset_y: (1 - rate) * height }, ele)
+
+        bottom = ::Appium::Core::TouchAction.new(driver)
+        bottom.swipe({ start_x: 0.5, start_y: 1.0 + offset,
+                       offset_x: 0.0, offset_y: rate * height }, ele)
+
+        [top, bottom]
+      end
+
+      # @private
+      def pinch_ios(rate, driver)
+        height = 100
+        offset = 100
+
+        top = ::Appium::Core::TouchAction.new(driver)
+        top.swipe start_x: 0.5, start_y: 0.0 + offset,
+                  offset_x: 0.0, offset_y: (1 - rate) * height, duration: 1_000
+
+        bottom = ::Appium::Core::TouchAction.new(driver)
+        bottom.swipe start_x: 0.5, start_y: 1.0 + offset,
+                     offset_x: 0.0, offset_y: rate * height, duration: 1_000
+
+        [top, bottom]
+      end
+
+      # @private
+      def zoom_android(rate, driver)
+        height = 100
+        offset = 100
+
+        top = ::Appium::Core::TouchAction.new(driver)
+        top.swipe start_x: offset, start_y: (1.0 - rate) * height + offset,
+                  offset_x: 0.0, offset_y: (rate - 1.0) * height, duration: 1_000
+
+        bottom = ::Appium::Core::TouchAction.new(driver)
+        bottom.swipe start_x: offset, start_y: rate * height + offset,
+                     offset_x: 0.0, offset_y: (1.0 - rate) * height, duration: 1_000
+
+        [top, bottom]
+      end
+
+      # @private
+      def zoom_for_xcuitest(rate, driver)
+        height = 100
+        offset = 100
+
+        ele = driver.find_element :class, 'XCUIElementTypeApplication'
+        top = ::Appium::Core::TouchAction.new(driver)
+        top.swipe({ start_x: 0.5, start_y: (1 - rate) * height + offset,
+                    offset_x: 0.0, offset_y: - (1 - rate) * height }, ele)
+
+        bottom = ::Appium::Core::TouchAction.new(driver)
+        bottom.swipe({ start_x: 0.5, start_y: rate * height + offset,
+                       offset_x: 0.0, offset_y: (1 - rate) * height }, ele)
+
+        [top, bottom]
+      end
+
+      # @private
+      def zoom_ios(rate, driver)
+        height = 100
+        offset = 100
+
+        top = ::Appium::Core::TouchAction.new(driver)
+        top.swipe start_x: 0.5, start_y: (1 - rate) * height + offset,
+                  offset_x: 0.0, offset_y: - (1 - rate) * height, duration: 1_000
+
+        bottom = ::Appium::Core::TouchAction.new(driver)
+        bottom.swipe start_x: 0.5, start_y: rate * height + offset,
+                     offset_x: 0.0, offset_y: (1 - rate) * height, duration: 1_000
+
+        [top, bottom]
       end
     end # self
 
+    attr_reader :driver
+
     def initialize(driver = $driver)
-      super driver
+      @actions = []
+      @driver = driver
+    end
+
+    # Add a touch_action to be performed
+    # @param chain (TouchAction) The action to add to the chain
+    def add(chain)
+      @actions << chain.actions
+    end
+
+    # Ask Appium to perform the actions
+    def perform
+      @driver.multi_touch @actions
+      @actions.clear
     end
   end # class MultiTouch
 end # module Appium

data/lib/appium_lib/common/touch_actions.rb

@@ -47,5 +47,26 @@ module Appium
     def initialize(driver = $driver)
       super driver
     end
+
+    def swipe(opts, ele = nil)
+      start_x  = opts.fetch :start_x, 0
+      start_y  = opts.fetch :start_y, 0
+      offset_x = opts.fetch :offset_x, nil
+      offset_y = opts.fetch :offset_y, nil
+      end_x    = opts.fetch :end_x, nil
+      end_y    = opts.fetch :end_y, nil
+      duration = opts.fetch :duration, 200
+
+      if end_x || end_y
+        warn '[DEPRECATION] end_x and end_y will be removed. Please use offset_x and offset_y for all platform.'
+        end_x ||= 0
+        end_y ||= 0
+
+        offset_x = end_x - start_x
+        offset_y = end_y - start_y
+      end
+
+      super(start_x: start_x, start_y: start_y, offset_x: offset_x, offset_y: offset_y, duration: duration, ele: ele)
+    end
   end # class TouchAction
 end # module Appium

data/lib/appium_lib/common/wait.rb

@@ -8,14 +8,6 @@ module Appium
       end
     end
 
-    # process opts before calling _generic_wait
-    # @private
-    def _process_wait_opts(opts)
-      opts = { timeout: opts } if opts.is_a?(Numeric)
-      raise 'opts must be a hash' unless opts.is_a? Hash
-      opts
-    end
-
     # Check every interval seconds to see if yield returns a truthy value.
     # Note this isn't a strict boolean true, any truthy value is accepted.
     # false and nil are considered failures.
@@ -32,13 +24,7 @@ module Appium
     # @option opts [String] :message Exception message if timed out.
     # @option opts [Array, Exception] :ignore Exceptions to ignore while polling (default: Exception)
     def wait_true(opts = {})
-      opts = _process_wait_opts(opts).merge(return_if_true: true)
-
-      opts[:timeout]  ||= @core.wait_timeout
-      opts[:interval] ||= @core.wait_interval
-
-      wait = ::Appium::Common::Wait.new opts
-      wait.until { yield }
+      @core.wait_true(opts) { yield }
     end
 
     # Check every interval seconds to see if yield doesn't raise an exception.
@@ -55,13 +41,7 @@ module Appium
     # @option opts [String] :message Exception message if timed out.
     # @option opts [Array, Exception] :ignore Exceptions to ignore while polling (default: Exception)
     def wait(opts = {})
-      opts = _process_wait_opts(opts).merge(return_if_true: false)
-
-      opts[:timeout]  ||= @core.wait_timeout
-      opts[:interval] ||= @core.wait_interval
-
-      wait = ::Appium::Common::Wait.new opts
-      wait.until { yield }
+      @core.wait(opts) { yield }
     end
   end
 end

data/lib/appium_lib/core/android.rb

@@ -1,4 +1,5 @@
 # loaded in common/driver.rb
 require_relative 'android/search_context'
 require_relative 'android/device'
+require_relative 'android/touch'
 require_relative 'android/uiautomator1/bridge'

data/lib/appium_lib/core/android/espresso/bridge.rb

@@ -0,0 +1,18 @@
+require_relative '../../android_espresso'
+
+module Appium
+  module Core
+    module Android
+      module Espresso
+        module Bridge
+          def self.for(target)
+            target.extend Appium::Android::Device
+            Core::Android::SearchContext.extend
+
+            Core::Android::Touch.extend_touch_actions
+          end
+        end
+      end
+    end
+  end
+end

data/lib/appium_lib/core/android/touch.rb

@@ -0,0 +1,15 @@
+module Appium
+  module Core
+    module Android
+      module Touch
+        def self.extend_touch_actions
+          ::Appium::Core::TouchAction.class_eval do
+            def swipe_coordinates(start_x: 0, start_y: 0, offset_x: 0, offset_y: 0)
+              { offset_x: (start_x + offset_x), offset_y: (start_y + offset_y) }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/appium_lib/core/android/uiautomator1/bridge.rb

@@ -7,7 +7,9 @@ module Appium
         module Bridge
           def self.for(target)
             target.extend Appium::Android::Device
-            ::Appium::Core::Android::SearchContext.extend
+            Core::Android::SearchContext.extend
+
+            Core::Android::Touch.extend_touch_actions
           end
         end
       end

data/lib/appium_lib/core/android/uiautomator2/bridge.rb

@@ -7,7 +7,9 @@ module Appium
         module Bridge
           def self.for(target)
             target.extend Appium::Android::Device
-            ::Appium::Core::Android::SearchContext.extend
+            Core::Android::SearchContext.extend
+
+            Core::Android::Touch.extend_touch_actions
           end
         end
       end

data/lib/appium_lib/core/android_espresso.rb

@@ -0,0 +1,5 @@
+# loaded in common/driver.rb
+require_relative 'android/search_context'
+require_relative 'android/device'
+require_relative 'android/touch'
+require_relative 'android/espresso/bridge'

data/lib/appium_lib/core/android_uiautomator2.rb

@@ -1,4 +1,5 @@
 # loaded in common/driver.rb
 require_relative 'android/search_context'
 require_relative 'android/device'
+require_relative 'android/touch'
 require_relative 'android/uiautomator2/bridge'

data/lib/appium_lib/core/core.rb

@@ -6,10 +6,10 @@ require_relative 'driver'
 
 # for multi touch related methods
 require_relative 'device/touch_actions'
-require_relative 'device/multi_touch'
 
 require_relative 'android'
 require_relative 'android_uiautomator2'
+require_relative 'android_espresso'
 
 require_relative 'ios'
 require_relative 'ios_xcuitest'

data/lib/appium_lib/core/device/touch_actions.rb

@@ -128,21 +128,17 @@ module Appium
       #
       # @option opts [int] :start_x Where to start swiping, on the x axis.  Default 0.
       # @option opts [int] :start_y Where to start swiping, on the y axis.  Default 0.
-      # @option opts [int] :offset_x For iOS. Offset, on the x axis.  Default 0.
-      # @option opts [int] :offset_y For iOS. Offset, on the y axis.  Default 0.
-      # @option opts [int] :end_x For Android. Where to end swiping, on the x axis.  Default 0.
-      # @option opts [int] :end_y For Android. Where to end swiping, on the y axis.  Default 0.
+      # @option opts [int] :offset_x Offset, on the x axis.  Default 0.
+      # @option opts [int] :offset_y Offset, on the y axis.  Default 0.
       # @option opts [int] :duration How long the actual swipe takes to complete in milliseconds. Default 200.
       def swipe(opts, ele = nil)
         start_x  = opts.fetch :start_x, 0
         start_y  = opts.fetch :start_y, 0
-        offset_x = opts.fetch :offset_x, nil
-        offset_y = opts.fetch :offset_y, nil
-        end_x    = opts.fetch :end_x, nil
-        end_y    = opts.fetch :end_y, nil
+        offset_x = opts.fetch :offset_x, 0
+        offset_y = opts.fetch :offset_y, 0
         duration = opts.fetch :duration, 200
 
-        coordinates = swipe_coordinates(end_x: end_x, end_y: end_y, offset_x: offset_x, offset_y: offset_y)
+        coordinates = swipe_coordinates(start_x: start_x, start_y: start_y, offset_x: offset_x, offset_y: offset_y)
 
         if ele # pinch/zoom for XCUITest
           press x: start_x, y: start_y, element: ele
@@ -173,20 +169,9 @@ module Appium
 
       # Visible for testing
       # @private
-      def swipe_coordinates(end_x: nil, end_y: nil, offset_x: nil, offset_y: nil)
-        if @driver.device_is_android?
-          puts 'end_x and end_y are used for Android. Not offset_x and offset_y.' if end_x.nil? || end_y.nil?
-          end_x ||= 0
-          end_y ||= 0
-          return { offset_x: end_x, offset_y: end_y }
-        elsif offset_x.nil? || offset_y.nil?
-          puts 'offset_x and offset_y are used for iOS. Not end_x and end_y point.'
-        end
-
-        offset_x ||= 0
-        offset_y ||= 0
-
-        { offset_x: offset_x, offset_y: offset_y }
+      def swipe_coordinates(start_x: 0, start_y: 0, offset_x: 0, offset_y: 0)
+        raise NotImplementedError,
+              "Please define swipe_coordinates with #{start_x}, #{start_y}, #{offset_x}, #{offset_y}"
       end
 
       private