Merge branch 'master' into dependabot/pip/pytest-cov-approx-eq-5.0

Author: KazuCocoa

.github/workflows/functional-test.yml

@@ -0,0 +1,79 @@
+name: Functional Tests
+
+on:
+  # Run by manual at this time
+  workflow_dispatch:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  ios_test:
+    strategy:
+      fail-fast: false
+      matrix:
+        test_targets:
+          - target: test/functional/ios/search_context/find_by_*.py test/functional/ios/remote_fs_tests.py test/functional/ios/safari_tests.py test/functional/ios/execute_driver_tests.py
+            name: func_test_ios1
+          - target: test/functional/ios/applications_tests.py test/functional/ios/hw_actions_tests.py test/functional/ios/keyboard_tests.py
+            name: func_test_ios2
+          - target: test/functional/ios/screen_record_tests.py test/functional/ios/webdriver_tests.py
+            name: func_test_ios3
+
+    runs-on: macos-14
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Install Node.js
+      uses: actions/setup-node@v3
+      with:
+        node-version: 'lts/*'
+
+    - name: Select Xcode
+      uses: maxim-lobanov/setup-xcode@v1
+      with:
+        xcode-version: 15.3
+    - run: defaults write com.apple.iphonesimulator PasteboardAutomaticSync -bool false
+
+    - uses: futureware-tech/simulator-action@v3
+      with:
+        # https://github.com/actions/runner-images/blob/main/images/macos/macos-14-arm64-Readme.md
+        model: 'iPhone 15 Plus'
+        os_version: '17.4'
+
+    # needed?
+    - run: brew install ffmpeg
+
+    # Start Appium
+    - run: npm install -g appium
+    - run: |
+        appium driver install xcuitest
+        appium plugin install images
+        appium plugin install execute-driver
+        nohup appium --use-plugins=images,execute-driver --relaxed-security --log-timestamp --log-no-colors > appium.log &
+
+    - name: Set up Python 3.9
+      uses: actions/setup-python@v3
+      with:
+        python-version: 3.9
+
+    - run: |
+        # Separate 'run' creates differnet pipenv env. Does them in one run for now.
+        pip install --upgrade pip
+        pip install --upgrade pipenv
+        pipenv lock --clear
+        pipenv install -d --system
+        pytest ${{ matrix.test_targets.target}} --doctest-modules --junitxml=junit/test-results.xml --cov=com --cov-report=xml --cov-report=html
+
+    - name: Save server output
+      if: ${{ always() }}
+      uses: actions/upload-artifact@master
+      with:
+        name: appium-ios-${{matrix.test_targets.name}}.log
+        path: appium.log

.github/workflows/pr-title.yml

@@ -8,7 +8,7 @@ jobs:
     name: https://www.conventionalcommits.org
     runs-on: ubuntu-latest
     steps:
-      - uses: beemojs/conventional-pr-action@v2
+      - uses: beemojs/conventional-pr-action@v3
         with:
           config-preset: angular
         env:

Pipfile

@@ -12,11 +12,11 @@ mock = "~=5.1"
 pre-commit = "~=2.21"
 pylint = "~=3.1.0"
 pylint-quotes = "~=0.2.3"
-pytest = "~=8.1"
+pytest = "~=8.2"
 pytest-cov = "~=5.0"
 python-dateutil = "~=2.9"
-tox = "~=4.14"
+tox = "~=4.15"
 types-python-dateutil = "~=2.9"
 
 [packages]
-selenium = "~=4.18"
+selenium = "~=4.20"

appium/webdriver/common/appiumby.py

@@ -17,7 +17,6 @@
 
 class AppiumBy(By):
     IOS_PREDICATE = '-ios predicate string'
-    IOS_UIAUTOMATION = '-ios uiautomation'
     IOS_CLASS_CHAIN = '-ios class chain'
     ANDROID_UIAUTOMATOR = '-android uiautomator'
     ANDROID_VIEWTAG = '-android viewtag'

appium/webdriver/webdriver.py

@@ -118,7 +118,7 @@ def test_command(self, argument):
                 def add_command(self):
                     return ('post', 'session/$sessionId/path/to/your/custom/url')
 
-            driver = webdriver.Remote('http://localhost:4723/wd/hub', desired_caps,
+            driver = webdriver.Remote('http://localhost:4723/wd/hub', options=options,
                 extensions=[YourCustomCommand])
 
             # Then, the driver sends a post request to `session/$sessionId/path/to/your/custom/url`
@@ -138,7 +138,7 @@ def custom_method_name(self, element_id):
                 def add_command(self):
                     return ('GET', 'session/$sessionId/path/to/your/custom/$id/url')
 
-            driver = webdriver.Remote('http://localhost:4723/wd/hub', desired_caps,
+            driver = webdriver.Remote('http://localhost:4723/wd/hub', options=options,
                 extensions=[YourCustomCommand])
             element = driver.find_elemeent(by=AppiumBy.ACCESSIBILITY_ID, value='id')
 
@@ -240,7 +240,6 @@ def __init__(
             self._update_command_executor(keep_alive=keep_alive)
 
         # add new method to the `find_by_*` pantheon
-        By.IOS_UIAUTOMATION = AppiumBy.IOS_UIAUTOMATION
         By.IOS_PREDICATE = AppiumBy.IOS_PREDICATE
         By.IOS_CLASS_CHAIN = AppiumBy.IOS_CLASS_CHAIN
         By.ANDROID_UIAUTOMATOR = AppiumBy.ANDROID_UIAUTOMATOR

ci-jobs/functional_test.yml

@@ -6,22 +6,6 @@ parameters:
   CI: true
 
 jobs:
-  - template: ./functional/run_ios_test.yml
-    parameters:
-      name: 'func_test_ios1'
-      vmImage: ${{ parameters.vmImage }}
-      pytestOpt: ${{ parameters.pytestOpt }}
-      testFiles: 'search_context/find_by_*.py remote_fs_tests.py safari_tests.py execute_driver_tests.py'
-      CI: ${{ parameters.ci }}
-      xcodeForIOS: ${{ parameters.xcodeForIOS }}
-  - template: ./functional/run_ios_test.yml
-    parameters:
-      name: 'func_test_ios2'
-      vmImage: ${{ parameters.vmImage }}
-      pytestOpt: ${{ parameters.pytestOpt }}
-      testFiles: 'applications_tests.py hw_actions_tests.py keyboard_tests.py screen_record_tests.py webdriver_tests.py'
-      CI: ${{ parameters.ci }}
-      xcodeForIOS: ${{ parameters.xcodeForIOS }}
   - template: ./functional/run_android_test.yml
     parameters:
       name: 'func_test_android1'

test/apps/UICatalog.app.zip

@@ -28,7 +28,7 @@ def get_desired_capabilities(app: Optional[str] = None) -> Dict[str, Any]:
     desired_caps: Dict[str, Any] = {
         'deviceName': iphone_device_name(),
         'platformName': 'iOS',
-        'platformVersion': '15.5',
+        'platformVersion': '17.4',
         'automationName': 'XCUITest',
         'allowTouchIdEnroll': True,
         'wdaLocalPort': wda_port(),
@@ -70,7 +70,7 @@ def wda_port() -> int:
 
 
 def iphone_device_name() -> str:
-    prefix = 'iPhone 12'
+    prefix = 'iPhone 15 Plus'
     if PytestXdistWorker.NUMBER == PytestXdistWorker.gw(0):
         return f'{prefix} - 8100'
     elif PytestXdistWorker.NUMBER == PytestXdistWorker.gw(1):

test/functional/ios/helper/desired_capabilities.py

@@ -24,6 +24,8 @@
 
 
 class BaseTestCase(object):
+    IOS_UICATALOG_APP_NAME = 'UIKitCatalog'
+
     def setup_method(self) -> None:
         desired_caps = desired_capabilities.get_desired_capabilities('UICatalog.app.zip')
         self.driver = webdriver.Remote(SERVER_URL_BASE, options=XCUITestOptions().load_capabilities(desired_caps))

test/functional/ios/helper/test_helper.py

@@ -24,18 +24,44 @@
 class TestSafari:
     def setup_method(self) -> None:
         caps = get_desired_capabilities()
-        caps.update({'browserName': 'safari', 'nativeWebTap': True, 'safariIgnoreFraudWarning': True})
+        caps.update(
+            {
+                'bundleId': 'com.apple.mobilesafari',
+                'nativeWebTap': True,
+                'safariIgnoreFraudWarning': True,
+                'webviewConnectTimeout': 100000,
+            }
+        )
         self.driver = webdriver.Remote(SERVER_URL_BASE, options=AppiumOptions().load_capabilities(caps))
 
+        # Fresh iOS 17.4 simulator may not show up the webview context with "safari"
+        # after a fresh simlator instance creation.
+        # Re-launch the process could be a workaround in my debugging.
+        self.driver.terminate_app('com.apple.mobilesafari')
+        self.driver.activate_app('com.apple.mobilesafari')
+
     def teardown_method(self) -> None:
         self.driver.quit()
 
     def test_context(self) -> None:
-        assert 'NATIVE_APP' == self.driver.contexts[0]
-        assert self.driver.contexts[1].startswith('WEBVIEW_')
+        contexts = self.driver.contexts
+        assert 'NATIVE_APP' == contexts[0]
+        assert contexts[1].startswith('WEBVIEW_')
+        self.driver.switch_to.context(contexts[1])
         assert 'WEBVIEW_' in self.driver.current_context
 
     def test_get(self) -> None:
+        ok = False
+        contexts = self.driver.contexts
+        for context in contexts:
+            if context.startswith('WEBVIEW_'):
+                self.driver.switch_to.context(context)
+                ok = True
+                break
+
+        if ok is False:
+            assert False, 'Could not set WEBVIEW context'
+
         self.driver.get('http://google.com')
         for _ in range(5):
             time.sleep(0.5)