Merge branch 'master' into appium3

Author: KazuCocoa

.github/workflows/functional-test.yml

@@ -20,27 +20,41 @@ jobs:
         test_targets:
           - target: test/functional/ios/driver_test.rb,test/functional/ios/patch_test.rb
             name: test1
+            platform: ios
+            wdaName: WebDriverAgentRunner-Runner.app
           - target: test/functional/ios/webdriver/create_session_test.rb,test/functional/ios/webdriver/w3c_actions_test.rb
             name: test2
+            platform: ios
+            wdaName: WebDriverAgentRunner-Runner.app
           - target: test/functional/ios/webdriver/device_test.rb
             name: test3
+            platform: ios
+            wdaName: WebDriverAgentRunner-Runner.app
           - target: test/functional/ios/ios/device_test.rb
             name: test4
+            platform: ios
+            wdaName: WebDriverAgentRunner-Runner.app
           - target: test/functional/ios/ios/device_wda_attachment_test.rb,test/functional/ios/ios/search_context_test.rb
             name: test5
+            platform: ios
+            wdaName: WebDriverAgentRunner-Runner.app
           - target: test/functional/ios/ios/image_comparison_test.rb
             name: test6
+            platform: ios
+            wdaName: WebDriverAgentRunner-Runner.app
           - target: test/functional/ios/tv_driver_test.rb
             name: test7
+            platform: tvOS
+            wdaName: WebDriverAgentRunner_tvOS-Runner.app
 
-    runs-on: macos-14
+    runs-on: macos-15
 
     # Please make sure the available Xcode versions and iOS versions
     # on the runner images. https://github.com/actions/runner-images
     env:
-      XCODE_VERSION: 15.3
-      IOS_VERSION: 17.4
-      IOS_DEVICE_NAME: iPhone 15 Plus
+      XCODE_VERSION: 16.4
+      IOS_VERSION: 18.5
+      IOS_DEVICE_NAME: iPhone 16 Plus
 
     steps:
     - uses: actions/checkout@v3
@@ -71,6 +85,10 @@ jobs:
         # nohup appium --use-plugins=images,execute-driver --relaxed-security --log-timestamp --log-no-colors 2>&1 > appium.log &
         nohup appium --relaxed-security --log-timestamp --log-no-colors 2>&1 > appium.log &
 
+    - run: |
+        appium driver run xcuitest download-wda-sim  --platform=${{matrix.test_targets.platform}} --outdir=${{ github.workspace }}/wda
+      name: Downloading prebuilt WDA
+
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
@@ -84,6 +102,7 @@ jobs:
       env:
         IGNORE_VERSION_SKIP: true
         CI: true
+        LOCAL_PREBUILT_WDA: ${{ github.workspace }}/wda/${{matrix.test_targets.wdaName}}
 
     - name: Save server output
       if: ${{ always() }}
@@ -95,7 +114,14 @@ jobs:
           test/report/
 
   ios_test_with_other_deps:
-    runs-on: macos-14
+    runs-on: macos-15
+
+    # Please make sure the available Xcode versions and iOS versions
+    # on the runner images. https://github.com/actions/runner-images
+    env:
+      XCODE_VERSION: 16.4
+      IOS_VERSION: 18.5
+      IOS_DEVICE_NAME: iPhone 16 Plus
 
     steps:
     - uses: actions/checkout@v3
@@ -135,6 +161,10 @@ jobs:
         # nohup appium --use-plugins=images,execute-driver --relaxed-security --log-timestamp --log-no-colors 2>&1 > appium.log &
         nohup appium --relaxed-security --log-timestamp --log-no-colors 2>&1 > appium.log &
 
+    - run: |
+        appium driver run xcuitest download-wda-sim  --platform=${{matrix.test_targets.platform}} --outdir=${{ github.workspace }}/wda
+      name: Downloading prebuilt WDA
+
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
@@ -147,6 +177,7 @@ jobs:
       env:
         IGNORE_VERSION_SKIP: true
         CI: true
+        LOCAL_PREBUILT_WDA: ${{ github.workspace }}/wda/WebDriverAgentRunner-Runner.app
 
     - name: Save server output
       if: ${{ always() }}

Gemfile

@@ -8,7 +8,7 @@ gem 'minitest', '~> 5.0'
 gem 'minitest-reporters', '~> 1.1'
 gem 'parallel_tests'
 gem 'rake', '~> 13.0'
-gem 'rubocop', '1.76.2'
+gem 'rubocop', '1.79.0'
 gem 'simplecov'
 gem 'steep', '~> 1.9.3'
 gem 'webmock', '~> 3.25.0'

README.md

@@ -156,6 +156,26 @@ attached_driver.page_source
 Read [Appium/Core/Driver](https://rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Driver) to catch up with available capabilities.
 Capabilities affect only ruby_lib is [Appium/Core/Options](https://rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Options).
 
+### Improvement ideas
+
+- for iOS
+
+```
+$ appium driver run xcuitest download-wda-sim --outdir=/path/to/download/prebuilt/wda/
+```
+
+Then, adding capabilities below:
+
+```json
+{
+  "appium:usePreinstalledWDA": true,
+  "appium:prebuiltWDAPath": "/path/to/download/prebuilt/wda/WebDriverAgentRunner-Runner.app"
+}
+```
+
+It will improve initial new session request performance for iOS simulator.
+
+`"appium:settings[respectSystemAlerts]" => true` for capability will also help to work with [permissions](https://appium.github.io/appium-xcuitest-driver/latest/guides/troubleshooting/#interact-with-dialogs-managed-by-comapplespringboard).
 
 ### Gives custom listener
 

test/functional/android/android/mobile_commands_test.rb

@@ -224,7 +224,7 @@ def test_webatom
         # Can use `atom` defined in https://developer.android.com/reference/android/support/test/espresso/web/webdriver/DriverAtoms
         # Locator: https://developer.android.com/reference/androidx/test/espresso/web/webdriver/Locator
         text = @driver.execute_script 'mobile: webAtoms', {
-          webviewElement: el.id,
+          webviewEl: el.id,
           forceJavascriptEnabled: true,
           methodChain: [{
             name: 'withElement',
@@ -238,7 +238,7 @@ def test_webatom
         # Raises an error if the method cannot find any DriverAtoms or necessary arguments
         error = assert_raises ::Selenium::WebDriver::Error::WebDriverError do
           @driver.execute_script 'mobile: webAtoms', {
-            webviewElement: el.id,
+            webviewEl: el.id,
             forceJavascriptEnabled: true,
             methodChain: [{
               name: 'withElement',

test/functional/ios/driver_test.rb

@@ -118,7 +118,7 @@ def test_default_keyboard_pref
         @@driver.find_element(:accessibility_id, 'Keyboard').click
 
         # to wait the animation
-        auto_correction_name = over_ios26? @@driver ? 'KeyboardAutocorrection' : 'Auto-Correction'
+        auto_correction_name = over_ios26?(@@driver) ? 'KeyboardAutocorrection' : 'Auto-Correction'
         @@driver.wait { |d| d.find_element :accessibility_id, auto_correction_name }
 
         auto_correction = @@driver.wait do |d|

test/test_helper.rb

@@ -131,7 +131,7 @@ def self.mac2
 
     # Require a simulator which OS version is 11.4, for example.
     def ios(platform_name = :ios)
-      platform_version = '17.4'
+      platform_version = ENV['IOS_VERSION'] || '18.5'
       wda_port = wda_local_port
 
       real_device = ENV['REAL'] || false
@@ -142,7 +142,7 @@ def ios(platform_name = :ios)
           automationName: ENV['APPIUM_DRIVER'] || 'XCUITest',
           # udid: 'auto',
           platformVersion: platform_version,
-          deviceName: device_name(platform_version, platform_name, wda_port),
+          deviceName: device_name(platform_name, wda_port),
           useNewWDA: false,
           eventTimings: true,
           someCapability: 'some_capability',
@@ -184,6 +184,11 @@ def ios(platform_name = :ios)
         cap = add_xctestrun(real_device, cap.dup, xcode_org_id)
       end
 
+      if ENV['LOCAL_PREBUILT_WDA']
+        cap[:caps][:usePreinstalledWDA] = true
+        cap[:caps][:prebuiltWDAPath] = ENV['LOCAL_PREBUILT_WDA']
+      end
+
       cap
     end
 
@@ -210,16 +215,11 @@ def test_app(os_version)
       end
     end
 
-    def device_name(os_version, platform_name, wda_local_port)
+    def device_name(platform_name, wda_local_port)
       if platform_name.downcase == :tvos
         'Apple TV'
       else
-        name = if over_ios13?(os_version)
-                 'iPhone 15 Plus'
-               else
-                 'iPhone 15 Pro Max'
-               end
-
+        name = ENV['IOS_DEVICE_NAME'] || 'iPhone 16 Plus'
         parallel? ? "#{name} - #{wda_local_port}" : name
       end
     end
@@ -315,7 +315,7 @@ def android(activity_name = nil)
         # https://developer.android.com/reference/androidx/test/uiautomator/Configurator#setActionAcknowledgmentTimeout(long)
         cap[:capabilities]['settings[actionAcknowledgmentTimeout]'] = 0
         # https://developer.android.com/reference/androidx/test/uiautomator/Configurator#setScrollAcknowledgmentTimeout(long)
-        cap[:capabilities]['settings[scrollAcknowledgmentTimeout]'] = 0
+        # cap[:capabilities]['settings[scrollAcknowledgmentTimeout]'] = 0
         cap[:capabilities]['settings[waitForIdleTimeout]'] = 0
         cap[:capabilities]['settings[waitForSelectorTimeout]'] = 0
       else