Ask the Community
Organize your Maestro tests on App Automate
Organize your Maestro test executions under projects on BrowserStack App Automate. Test your apps on a real device cloud.
Logically organize test executions under projects for better visibility and reporting:
-
Access related tests together in the App Automate dashboard.
-
Simplify test result retrieval via REST API.
How to organize tests?
Include the project parameter in your REST API request:
| Parameter | Description | Values |
|---|---|---|
project |
A unique identifier to logically group multiple test executions together | String Only letters (A-Z, a-z), digits (0-9), periods (.), colons (:), hyphens (-), square brackets ([]), forward slashes (/), at signs (@), ampersands (&), single quotes (‘), and underscores (_) are allowed. Default: Untitled Project |
buildTag |
A custom tag for your builds | String Only letters (A-Z, a-z), digits (0-9), periods (.), colons (:), hyphens (-), square brackets ([]), forward slashes (/), at signs (@), ampersands (&), single quotes (‘), and underscores (_) are allowed. Any other characters are ignored. |
customBuildName |
A custom name for your build | String Optional. Only letters (A-Z, a-z), digits (0-9), periods (.), colons (:), hyphens (-), square brackets ([]), forward slashes (/), at signs (@), ampersands (&), single quotes (‘), and underscores (_) are allowed, up to a maximum of 255 characters. Any other characters are ignored. If an invalid build name is passed, the capability is ignored and the system falls back to the default naming workflow. On the dashboard, the build name appears as Build #<number>: <customBuildName>, where <number> is a sequential build number that BrowserStack assigns to each build. Multiple builds can have the same customBuildName, and the build number increments with each build (for example, “Build #1: My Custom Build Name”, “Build #2: My Custom Build Name”, and so on). |
Example cURL requests :
Both the test executions shown below specify the same value for the project parameter. Accordingly, they will be grouped together under the same project Dashboard-v2
REST API request for Android:
curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST "https://api-cloud.browserstack.com/app-automate/maestro/v2/android/build" \
-d '{"project" : "Dashboard-v2", "devices": ["Samsung Galaxy S8-7.0"], "app": "bs://f7c874f21852ba57957a3fdc33f47514288c4ba4", "testSuite": "bs://e994db8333e32a5863938666c3c3491e778352ff", "customBuildName": "MyCustomBuildName" }' \
-H "Content-Type: application/json"
curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST "https://api-cloud.browserstack.com/app-automate/maestro/v2/android/build" \
-d '{"project" : "Dashboard-v2", "devices": ["Samsung Galaxy S10-9.0"], "app": "bs://12474f21852ba5233fdc33f47514288c4ba4", "testSuite": "bs://e994db8333e32a5863938666c3c3491e1231", "customBuildName": "MyCustomBuildName" }' \
-H "Content-Type: application/json"
Adding build tags
You can add a custom build tag to your builds using the buildTag capability. You can filter your builds according to the assigned tag on the App Automate dashboard.
Example cURL request for Android :
The following code shows how the buildTag capability is used to add a build tag:
curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST "https://api-cloud.browserstack.com/app-automate/maestro/v2/android/build" \
-d '{"project" : "Dashboard-v2", "devices": ["Samsung Galaxy S10-9.0"], "app": "bs://12474f21852ba5233fdc33f47514288c4ba4", "testSuite": "bs://e994db8333e32a5863938666c3c3491e1231", "networkLogs": "false", "disableAnimations": "true", "deviceLogs": "true", "video": "true", "project": "Sanity", "buildTag": "Laser Tag" }' \
-H "Content-Type: application/json"
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
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!