Filter Test Cases

By default, all the test cases from an XCUI test-suite are executed. However, you can specify selected classes or tests to be executed in any build. These options can be useful in multiple scenarios :

1. Run a quick smoke test to ensure the sanity of important functionality.
2. Run only those test cases that are relevant to a new bug fix.
3. Split a large test-suite into multiple shards and run them in parallel.

In order to do so, you need to pass relevant parameters in the API request to start the XCUI test execution. These parameters are outlined in the table below.

REST API endpoint :

POST /app-automate/xcuitest/v2/build

Example cURL requests :

Execute particular test cases(from your test-suite) belonging to any class or execute all test cases of a class :

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST "https://api-cloud.browserstack.com/app-automate/xcuitest/v2/build" \
-d '{"only-testing": ["SampleXCUITestsClass/testAlert", "SampleXCUITestsClass/testText"], "devices": ["iPhone 8 Plus-11.0"], "app": "bs://f5L3azt9pLzE995f49376eb1fa3c284dc321f8d", "testSuite": "bs://6eb1fa3c284ddbe9971b2d1aee0d52943b9c081"}' \
-H "Content-Type: application/json"

You can skip certain specific test cases(from your test-suite) belonging to any class or skip all the test cases of a class:

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST "https://api-cloud.browserstack.com/app-automate/xcuitest/v2/build" \
-d '{"skip-testing": ["SampleXCUITestsClass/testAlert"], "devices": ["iPhone 8-11.0"], "app": "bs://f5L3azt9pLzE995f49376eb1fa3c284dc321f8d", "testSuite": "bs://6eb1fa3c284ddbe9971b2d1aee0d52943b9c081"}' \
-H "Content-Type: application/json"

Related topics

• Manage your uploaded app or test suite using our upload app REST API and upload test suite REST API.

• Use the get app API endpoint and list test suites API endpoint to list your recently uploaded apps and test suites.

• Delete your uploaded app or test suite using the delete app API endpoint and delete test suite API endpoint.