Integrate XCUI tests with App Accessibility testing

Add the BrowserStack Swift SDK as a dependency

1. Open your project in Xcode.
2. Go to File > Add Package Dependencies.
3. Search for BrowserStack Swift SDK or click Add Local to add the SDK as a local path.
4. Click Add Package.
5. Assign the SDK to the test target that will run UI tests.

Configure the test target to invoke the SDK

1. In your test target, open the Info.plist file.
2. Add the following key to ensure the SDK is invoked when the test bundle loads.

        ...
        <key>NSPrincipalClass</key>
        <string>BrowserstackSwiftSDK.BrowserstackSwiftSDK</string>
   

Build your project

1. Build both the main app and the test app (test bundle) in Xcode.
2. Ensure the minimum supported Swift version is 5.4 and the minimum iOS version is 14.0.

Upload the app

Upload the sample app (.ipa) to the BrowserStack servers using a REST API request.

The following sample cURL command demonstrates how to upload an app:

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST "https://api-cloud.browserstack.com/app-automate/xcuitest/v2/app" \
-F "file=@/path/to/app/file/App.ipa"

A sample response for the request is shown below:

{
    "app_name":"Application-debug.ipa",
    "app_url":"bs://j3c874f852ea50957a3fdc33f47514288c4ba4",
    "app_version":"1.0",
    "app_id":"j3c874f852ea50957a3fdc33f47514288c4ba4",
    "uploaded_at":"2022-05-12 07:27:54 UTC",
    "expiry":"2022-06-11 07:27:54 UTC"
}

Use the app_id parameter to identify the application when you run XCUI tests.

Upload the test suite

Upload the sample test suite (.zip file) to the BrowserStack servers using a REST API request.

The following sample cURL command demonstrates how to upload a test suite:

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST "https://api-cloud.browserstack.com/app-automate/xcuitest/v2/test-suite" \
-F "file=@/path/to/app/file/Application-debug-test.zip"

A sample response for the request is shown below:

{
    "test_suite_name":"Application-debug-test.zip",
    "test_suite_url":"bs://f7c874f21852ba57957a3e31f47514288c4ba4",
    "test_suite_id":"f7c874f21852ba57957a3e31f47514288c4ba4",
    "uploaded_at":"2022-05-12 07:32:41 UTC",
    "expiry":"2022-06-11 07:32:41 UTC",
    "framework":"xcuit"
}

Use the test_suite_id parameter to identify the test suite when you run XCUI tests.

Run XCUI tests

In a cURL command, include the following parameters and send the API request to run the test.

• app: specify the app_id, which is the unique identifier of the application that you want to test. The app_id is generated when you upload the app to BrowserStack, see Upload the app.
• testSuite: specify the test_suite_id, which is the unique identifier of the test suite you want to run. The test_suite_id is generated when you upload your test suite to BrowserStack, see Upload the test suite.
• devices: specify a list of iOS devices on which you want to test your app. For more information, see Specify devices.
• accessibility: enable accessibility checks.
• accessibilityOptions: Configure the accessibilityOptions parameter to set various accessibility testing options. For a list of available accessibility options that you can use to configure your tests, see Configuration options.

curl -u "USERNAME:ACCESS_KEY" \
-X POST "https://api-cloud.browserstack.com/app-automate/xcuitest/v2/build" \
-d "{
    \"app\": \"bs://$app_id\",
    \"testSuite\": \"bs://$test_suite_id\",
    \"devices\": ["iPhone 15 Pro Max-26"]
    \"deviceLogs\": true,
    \"project\": \"$PROJECT_NAME\",
    \"accessibility\": true,
    }
}" \
-H "Content-Type: application/json"

Response

A sample response for the request is shown below:

{
    "message" : "Success",
    "build_id" : "4d2b4deb810af077dd98f479bfdd2e64f36c3"
}

The build_id uniquely identifies your build in App Automate. Each test build is an execution of the XCUI test suite on all selected devices.

View test results

After you run the test using the REST API, visit the App Accessibility dashboard to view your test results, debugging logs, and overall test details.

Visit App Accessibility dashboard

You can also use API requests to view the test results.