Execute tests

Upload app

Upload your Android (.apk) or iOS (.ipa) apps to BrowserStack servers using either the REST API or App Management UI (available only in the new dashboard).

{
    "app_name": "debug.apk",
    "app_url": "bs://c8ddcb5649a8280ca800075bfd8f151115bba6b3",
    "app_version": "1.2.0",
    "app_id": "c8ddcb5649a8280ca800075bfd8f151115bba6b3",
    "uploaded_at": "2020-05-05 14:52:54 UTC",
    "custom_id": "SampleApp",
    "shareable_id": "steve/SampleApp",
    "expiry" : "2020-06-05 14:52:54 UTC"
}

Also note the expiry date. It indicates that the app you uploaded gets deleted from the server after 30 days.

To manage your apps, refer to the documentation on managing apps using App Management UI.

Upload test suite

First, ensure your test suite is structured correctly. To avoid errors, it’s critical that your test suite is zipped correctly within a parent folder. For detailed instructions on structuring your test suite, see the prepare your Maestro test suite documentation.

Upload your Maestro test suite (.yml) file to BrowserStack servers using the following REST API request:

Here is a sample response:

{
    "test_suite_name": "Flows.zip",
    "test_suite_url": "bs://89c874f21852ba57957a3fdc33f47514288c4ba1",
    "test_suite_id": "89c874f21852ba57957a3fdc33f47514288c4ba1",
    "uploaded_at": "2020-09-09 15:35:00 UTC",
    "custom_id": "SampleTest",
    "shareable_id": "Steve/SampleTest",
    "framework": "maestro",
    "expiry": "2020-10-09 15:35:00 UTC"
}

Execute tests

You can execute tests on both Android and iOS devices.

Starting a build
To initiate test execution on BrowserStack, your API request must include:

• Application under test

• Maestro test-suite

• Target devices list

Optional parameters can customize test execution. Each build receives a unique build_id in the response. For more information on executing tests, refer to our REST API reference page.

To run the entire test suite, run the below request:

To run the a specific test suite, add the path to the specific test suite in the execute parameter and run the cURL request:

For an explanation of how to target specific files and folders, see the running your tests: the execute parameter documentation.

Here is a sample response:

{
    "message": "Success",
    "build_id": "5c5ab4338cec13aeb78f7a6977344556ac00bccd6"
}

If a test run stops due to a crash, you can stop the build by clicking the stop build button on the App Automate dashboard or using the REST API.

View test results

After initiating your Maestro test execution via the REST API:

• Navigate to your App Automate dashboard and select your test.

• You can access the following on the dashboard:

  • Live test results

  • Debugging logs (network, device, video etc.)

  • Comprehensive execution details