appium_lib_core 5.0.0.rc7 → 5.0.0.rc8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86c326e32b6a255221e4eeb9c4636a2ad9862e33c536099fd926b5f75aa722ca
-  data.tar.gz: 42badc486fa895ccad392a404778cf59fc6bdf3ef8cd084e67375b757a6066ef
+  metadata.gz: 02c194c911952ee0560a5fd0ba8d96e918ac39147fad4d7e82cd788d20eff551
+  data.tar.gz: e59d43b74b1c2e01d481a16508b925eb55fbbb3dcd80d8ae8653a865e8f59f5d
 SHA512:
-  metadata.gz: 0e7d2d0a230bc1de4396276a7eebf7963e71253214d2f57910f3ff25f1f7ee6979f59c22d5d63874bf4dc6f4f68417710454b1fb8870060a0ad20db2b9c65048
-  data.tar.gz: e3bdca124e8d17d4452f1a9bfc98c7246c4de6ff8593c579a21849593715e112545bf8a934f4babd8da9332a53aba904f22ec4b20ffc320d6e8b5ca86e256858
+  metadata.gz: b078512d2f2597977d369be50649e32c98a832d64884bd60dfc529c3a07cd94e2d884e6d3674f5faa16c29420959ce3ff0e9e5b537abc825cc7639ba56c613c0
+  data.tar.gz: effa2edb3ab9460496ee43b464afa64ed0aec01ee4f933062e37b5622b5fa3d22dc3db90bc5e2ae8cc272936b90f9d3e1b217ac3b63115811a7afc8b6affcc74

data/CHANGELOG.md

@@ -14,29 +14,40 @@ Read `release_notes.md` for commit level details.
 
 ### Enhancements
 
-- Update base selenium webdriver version to `4.0.0`
-  - Support only W3C spec as following Selenium v4 client
+- Update base selenium webdriver version to `v4`
+  - Base Selenium Ruby binding is now v4
+  - Support only W3C WebDriver spec (and a few Appium specific commands)
   - Support Ruby 2.6+
-- `element.id` returns the element id instead of `element.ref`. `element.ref` now returns an array.
-- Removed `desired_capabilities` as capabilities for `Appium::Core#for`. Please use `capabilities` key name instead
-- Removals that already had _duplication_ mark
+- Add `driver#wait`, `driver#wait_until`, `driver#wait_true`, `driver#wait_until_true` syntaxes
+  - Can give `driver` instance as its block variable
+- `element.id` returns the element id instead of `element.ref`.
+  - `element.ref` now returns an array.
+- Removed `desired_capabilities` as capabilities for `Appium::Core#for`. Please use `capabilities` key name instead.
+  - e.g. `Appium::Core.for capabilities: {...}` instead of `Appium::Core.for desired_capabilities: {...}`
+- Removed methods that had _Deprecated_ mark
   - Removed `driver#screenshot`. Please use `driver#save_screenshot` instead
   - Removed `driver#send_keys` to send keys to an active element. Please use `driver.action.send_keys('happy testing').perform` instead
   - Removed `forceMjsonwp` to send only MJSONWP capabilities since Selenium cleint v4 no longer supports MJSONWP
-- No longer set default `timeouts` as `0`. ruby_lib_core calls `/timeouts` endpoint only when `appium_lib: { wait: 5 }` is provided explicitly
+- No longer set default `timeouts` as `0`
+  - ruby_lib_core calls `/timeouts` endpoint only when `appium_lib: { wait: 5 }` is provided explicitly
 - Raises `::Appium::Core::Error::ArgumentError` instead of `ArgumentError` for this library specific argument errors
-- Add `driver#wait`, `driver#wait_until`, `driver#wait_true`, `driver#wait_until_true` syntaxes
-  - Can give `driver` instance as its block variable
+- Removed Selendroid related methods
 
 ### Deprecations
 - `Appium::Core::TouchAction` and `Appium::Core::MultiTouch` are deprecated
     - Please use W3C actions instead http://appium.io/docs/en/commands/interactions/actions/
     - More working examples:
-        - test/functional/android/webdriver/w3c_actions_test.rb
-        - test/functional/ios/webdriver/w3c_actions_test.rb
-        - test/functional/common_w3c_actions.rb
+        - [test/functional/android/webdriver/w3c_actions_test.rb](test/functional/android/webdriver/w3c_actions_test.rb)
+        - [test/functional/ios/webdriver/w3c_actions_test.rb](test/functional/ios/webdriver/w3c_actions_test.rb)
+        - [test/functional/common_w3c_actions.rb](test/functional/common_w3c_actions.rb)
         - https://www.selenium.dev/documentation/support_packages/mouse_and_keyboard_actions_in_detail/
-- Removed Selendroid related methods
+        - https://www.youtube.com/watch?v=oAJ7jwMNFVU
+        - https://appiumpro.com/editions/30-ios-specific-touch-action-methods
+        - https://appiumpro.com/editions/29-automating-complex-gestures-with-the-w3c-actions-api
+- `launch_app`, `close_app` and `reset`. Please read [issues#15807](https://github.com/appium/appium/issues/15807) for more details.
+    - `activate_app` or a new session request can be alternatives of `launch_app`
+    - `terminate_app` or close the session request can be alternatives of `close_app`
+    - Close current session and creating a new session, or `terminate_app` and `launch_app` can be alternatives of `reset`
 
 ## [4.7.1] - 2021-09-26
 

data/README.md

@@ -13,6 +13,10 @@ This library wraps [selenium-webdriver](https://github.com/SeleniumHQ/selenium/w
 - http://www.rubydoc.info/github/appium/ruby_lib_core
     - You can find working API examples in test code, [test/functional](test/functional)
 
+# Migration from v4 to v5
+
+Please read `[5.0.0]` section in CHANGELOG.md
+
 # Related library
 - https://github.com/appium/ruby_lib
 

data/appium_lib_core.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'minitest-reporters', '~> 1.1'
   spec.add_development_dependency 'webmock', '~> 3.14.0'
-  spec.add_development_dependency 'rubocop', '1.22.2'
+  spec.add_development_dependency 'rubocop', '1.22.3'
   spec.add_development_dependency 'appium_thor', '~> 1.0'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'pry-byebug'

data/lib/appium_lib_core/common/base/driver.rb

@@ -52,6 +52,10 @@ module Appium
           @wait_timeout = opts.delete(:wait_timeout)
           @wait_interval = opts.delete(:wait_interval)
 
+          # For logging.
+          # TODO: Remove when appium core no longer uses this in this bridge.
+          @automation_name = opts.delete(:automation_name)
+
           super
         end
 
@@ -414,17 +418,9 @@ module Appium
         alias set_context context=
 
         # Place a file in a specific location on the device.
-        # On iOS, the server should have ifuse libraries installed and configured properly for this feature to work on
-        # real devices.
         # On Android, the application under test should be built with debuggable flag enabled in order to get access to
         # its container on the internal file system.
         #
-        # {https://github.com/libimobiledevice/ifuse iFuse GitHub page6}
-        #
-        # {https://github.com/osxfuse/osxfuse/wiki/FAQ osxFuse FAQ}
-        #
-        # {https://developer.android.com/studio/debug 'Debug Your App' developer article}
-        #
         # @param [String] path Either an absolute path OR, for iOS devices, a path relative to the app, as described.
         #                      If the path starts with application id prefix, then the file will be pushed to the root of
         #                      the corresponding application container.
@@ -441,18 +437,10 @@ module Appium
           @bridge.push_file(path, filedata)
         end
 
-        # Pull a file from the simulator/device.
-        # On iOS the server should have ifuse
-        # libraries installed and configured properly for this feature to work on real devices.
+        # Pull a file from the remote device.
         # On Android the application under test should be built with debuggable flag enabled in order to get access
         # to its container on the internal file system.
         #
-        # {https://github.com/libimobiledevice/ifuse iFuse GitHub page6}
-        #
-        # {https://github.com/osxfuse/osxfuse/wiki/FAQ osxFuse FAQ}
-        #
-        # {https://developer.android.com/studio/debug 'Debug Your App' developer article}
-        #
         # @param [String] path Either an absolute path OR, for iOS devices, a path relative to the app, as described.
         #                      If the path starts with application id prefix, then the file will be pulled from the root
         #                      of the corresponding application container.
@@ -461,7 +449,6 @@ module Appium
         #                      Only pulling files from application containers is supported for iOS Simulator.
         #                      Provide the remote path in format
         #                      <code>@bundle.identifier:container_type/relative_path_in_container</code>
-        #                      (Make sure this in ifuse doc)
         #
         # @return [Base64-decoded] Base64 decoded data
         #
@@ -478,18 +465,10 @@ module Appium
           @bridge.pull_file(path)
         end
 
-        # Pull a folder content from the simulator/device.
-        # On iOS the server should have ifuse libraries installed and configured properly for this feature to work
-        # on real devices.
+        # Pull a folder content from the remote device.
         # On Android the application under test should be built with debuggable flag enabled in order to get access to
         # its container on the internal file system.
         #
-        # {https://github.com/libimobiledevice/ifuse iFuse GitHub page6}
-        #
-        # {https://github.com/osxfuse/osxfuse/wiki/FAQ osxFuse FAQ}
-        #
-        # {https://developer.android.com/studio/debug 'Debug Your App' developer article}
-        #
         # @param [String] path Absolute path to the folder.
         #                      If the path starts with <em>@applicationId/</em> prefix, then the folder will be pulled
         #                      from the root of the corresponding application container.
@@ -498,7 +477,6 @@ module Appium
         #                      Only pulling files from application containers is supported for iOS Simulator.
         #                      Provide the remote path in format
         #                      <code>@bundle.identifier:container_type/relative_path_in_container</code>
-        #                      (Make sure this in ifuse doc)
         #
         # @return [Base64-decoded] Base64 decoded data which is zip archived
         #
@@ -556,6 +534,7 @@ module Appium
           @bridge.long_press_keycode(key, metastate: metastate, flags: flags)
         end
 
+        # @deprecated Except for Windows
         # Start the simulator and application configured with desired capabilities
         #
         # @example
@@ -563,9 +542,16 @@ module Appium
         #   @driver.launch_app
         #
         def launch_app
+          # TODO: Define only in Windows module when ruby_lib_core removes this method
+          if @automation_name != :windows
+            ::Appium::Logger.warn(
+              '[DEPRECATION] launch_app is deprecated. Please use activate_app instead.'
+            )
+          end
           @bridge.launch_app
         end
 
+        # @deprecated Except for Windows
         # Close an app on device
         #
         # @example
@@ -573,9 +559,16 @@ module Appium
         #   @driver.close_app
         #
         def close_app
+          # TODO: Define only in Windows module when ruby_lib_core removes this method
+          if @automation_name != :windows
+            ::Appium::Logger.warn(
+              '[DEPRECATION] close_app is deprecated. Please use terminate_app instead.'
+            )
+          end
           @bridge.close_app
         end
 
+        # @deprecated
         # Reset the device, relaunching the application.
         #
         # @example
@@ -583,6 +576,10 @@ module Appium
         #   @driver.reset
         #
         def reset
+          ::Appium::Logger.warn(
+            '[DEPRECATION] reset is deprecated. Please use terminate_app and activate_app, ' \
+            'or quit and create a new session instead.'
+          )
           @bridge.reset
         end
 
@@ -800,7 +797,7 @@ module Appium
         #
         # @example: Zoom
         #
-        #    f1 = @driver.action.add_pointer_input(:touch, 'finger1')
+        #    f1 = ::Selenium::WebDriver::Interactions.pointer(:touch, name: 'finger1')
         #    f1.create_pointer_move(duration: 1, x: 200, y: 500,
         #                           origin: ::Selenium::WebDriver::Interactions::PointerMove::VIEWPORT)
         #    f1.create_pointer_down(:left)
@@ -808,7 +805,7 @@ module Appium
         #                           origin: ::Selenium::WebDriver::Interactions::PointerMove::VIEWPORT)
         #    f1.create_pointer_up(:left)
         #
-        #    f2 = @driver.action.add_pointer_input(:touch, 'finger2')
+        #    f2 = ::Selenium::WebDriver::Interactions.pointer(:touch, name: 'finger2')
         #    f2.create_pointer_move(duration: 1, x: 200, y: 500,
         #                           origin: ::Selenium::WebDriver::Interactions::PointerMove::VIEWPORT)
         #    f2.create_pointer_down(:left)
@@ -821,6 +818,10 @@ module Appium
         def perform_actions(data)
           raise ::Appium::Core::Error::ArgumentError, "'#{data}' must be Array" unless data.is_a? Array
 
+          # NOTE: 'add_input' in Selenium Ruby implementation has additional 'pause'.
+          # This implementation is to avoid the additional pause.
+          # https://github.com/SeleniumHQ/selenium/blob/64447d4b03f6986337d1ca8d8b6476653570bcc1/rb/lib/selenium/webdriver/common/action_builder.rb#L207
+
           @bridge.send_actions data.map(&:encode).compact
           data.each(&:clear_actions)
           nil

data/lib/appium_lib_core/common/base/search_context.rb

@@ -32,6 +32,7 @@ module Appium
           predicate:            '-ios predicate string',
           class_chain:          '-ios class chain',
           # Windows with windows prefix
+          # @deprecated
           windows_uiautomation: '-windows uiautomation',
           # Tizen with Tizen prefix
           tizen_uiautomation:   '-tizen uiautomation'
@@ -122,6 +123,7 @@ module Appium
         #     e.tag_name #=> "XCUIElementTypeStaticText"
         #
         #     # For Windows
+        #     # @deprecated
         #     @driver.find_elements :windows_uiautomation, '....'
         #
         #     # For Tizen
@@ -158,6 +160,12 @@ module Appium
         private
 
         def _set_by_from_finders(how)
+          if how == :windows_uiautomation
+            ::Appium::Logger.warn(
+              '[DEPRECATION] :windows_uiautomation is deprecated. Please use other locators.'
+            )
+          end
+
           by = FINDERS[how.to_sym]
           unless by
             raise ::Appium::Core::Error::ArgumentError,

data/lib/appium_lib_core/common/touch_action/multi_touch.rb

@@ -24,6 +24,18 @@ module Appium
     # add to a new MultiTouch action.  When ready, call +prepare()+ and all
     # actions will be executed simultaneously.
     #
+    # Consider to use W3C spec touch action like the followings.
+    # https://www.selenium.dev/selenium/docs/api/rb/Selenium/WebDriver/PointerActions.html
+    # https://github.com/appium/ruby_lib_core/blob/master/test/functional/android/webdriver/w3c_actions_test.rb
+    # https://github.com/appium/ruby_lib_core/blob/master/test/functional/ios/webdriver/w3c_actions_test.rb
+    #
+    # About W3C actions
+    # https://www.youtube.com/watch?v=oAJ7jwMNFVU
+    # https://appiumpro.com/editions/30-ios-specific-touch-action-methods
+    # https://appiumpro.com/editions/29-automating-complex-gestures-with-the-w3c-actions-api
+    #
+    # Functional test code in ruby_lib_core repository also helps.
+    #
     # @example
     #
     #   @driver = Appium::Core.for(opts).start_driver

data/lib/appium_lib_core/common/touch_action/touch_actions.rb

@@ -27,6 +27,13 @@ module Appium
     # https://github.com/appium/ruby_lib_core/blob/master/test/functional/android/webdriver/w3c_actions_test.rb
     # https://github.com/appium/ruby_lib_core/blob/master/test/functional/ios/webdriver/w3c_actions_test.rb
     #
+    # About W3C actions
+    # https://www.youtube.com/watch?v=oAJ7jwMNFVU
+    # https://appiumpro.com/editions/30-ios-specific-touch-action-methods
+    # https://appiumpro.com/editions/29-automating-complex-gestures-with-the-w3c-actions-api
+    #
+    # Functional test code in ruby_lib_core repository also helps.
+    #
     # @example
     #
     #   @driver = Appium::Core.for(opts).start_driver

data/lib/appium_lib_core/driver.rb

@@ -320,7 +320,7 @@ module Appium
       #
       #     # Start iOS driver
       #     opts = {
-      #              caps: {
+      #              capabilities: {
       #                platformName: :ios,
       #                platformVersion: '11.0',
       #                deviceName: 'iPhone Simulator',
@@ -366,7 +366,8 @@ module Appium
                                                      capabilities: @caps, # ::Selenium::WebDriver::Remote::Capabilities
                                                      url: @custom_url,
                                                      wait_timeout: @wait_timeout,
-                                                     wait_interval: @wait_interval)
+                                                     wait_interval: @wait_interval,
+                                                     automation_name: @automation_name)
 
           if @direct_connect
             d_c = DirectConnections.new(@driver.capabilities)

data/lib/appium_lib_core/version.rb

@@ -14,7 +14,7 @@
 
 module Appium
   module Core
-    VERSION = '5.0.0.rc7' unless defined? ::Appium::Core::VERSION
-    DATE    = '2021-10-26' unless defined? ::Appium::Core::DATE
+    VERSION = '5.0.0.rc8' unless defined? ::Appium::Core::VERSION
+    DATE    = '2021-11-01' unless defined? ::Appium::Core::DATE
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 5.0.0.rc7
+  version: 5.0.0.rc8
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-26 00:00:00.000000000 Z
+date: 2021-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.22.2
+        version: 1.22.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.22.2
+        version: 1.22.3
 - !ruby/object:Gem::Dependency
   name: appium_thor
   requirement: !ruby/object:Gem::Requirement