Skip to main content
Transform your testing process with: Real Device Features, Company-wide Licences, & App Percy

Single runner invocation

Note: This feature is currently in Beta and may involve further changes.

By default, each XCUI test case is invoked separately in a different process to produce segregated debugging logs for each test case. However, this process increases overall execution time for your build as each test case run spawns a new process. Alternatively, you can disable this behavior and execute all test cases together (on each device) in one process and still get segregated logs for individual test cases. This can help significantly speed up the test execution time and ensure improved consistency in execution times. To do so, you can use the singleRunnerInvocation parameter in the REST API request for XCUI tests or REST API request for XCTestPlan tests to start your test execution.

REST API endpoints:

POST /app-automate/xcuitest/v2/build
POST /app-automate/xcuitest/v2/xctestrun-build
Parameter Description Values
singleRunnerInvocation Execute test cases together in a single process. true / false.
Default: : false

Example cURL request to start the execution of your XCUI tests:

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST "https://api-cloud.browserstack.com/app-automate/xcuitest/v2/build" \
-d '{"singleRunnerInvocation": "true", "devices": ["iPhone 14-16"], "app": "bs://f7c874f21852ba57957a3fdc33f47514288c4ba4", "testSuite": "bs://e994db8333e32a5863938666c3c3491e778352ff"}' \
-H "Content-Type: application/json"

Example cURL request to start the execution of your XCTestPlan tests:

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST "https://api-cloud.browserstack.com/app-automate/xcuitest/v2/xctestrun-build" \
-d '{"singleRunnerInvocation": "true", "devices": ["iPhone 14-16"], "app": "bs://f7c874f21852ba57957a3fdc33f47514288c4ba4", "testSuite": "bs://e994db8333e32a5863938666c3c3491e778352ff"}' \
-H "Content-Type: application/json"
Note: Test Sharding is not yet supported with single runner invocation.

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked






Thank you for your valuable feedback

Is this page helping you?

Yes
No

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked






Thank you for your valuable feedback!

Talk to an Expert
Download Copy