Integrate Maestro test suite with App Accessibility testing

Upload your app

Upload the sample app 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/maestro/v2/app" \
-F "file=@/path/to/app/file/debug.apk" \
-F "custom_id=SampleApp"

A sample response for the request is shown below:

{
    "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"
}

Note the app_url key to identify your uploaded app when you run Maestro tests.

Upload your test suite

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

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

A sample response for the request is shown below:

{
    "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"
}

Note the test_suite_url key to identify your uploaded test suite when you run Maestro tests.

Run your Maestro tests

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

• app: specify the app_url, which is the unique identifier of the application that you want to test. The app_url is generated when you upload the app to BrowserStack, see Upload your app.
• testSuite: specify the test_suite_url, which is the unique identifier of the test suite you want to run. The test_suite_url is generated when you upload your test suite to BrowserStack, see Upload your test suite.
• devices: specify a list of Android or iOS devices on which you want to test your app.
• testObservability: enable test observability.
• 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 "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST "https://api-cloud.browserstack.com/app-automate/maestro/v2/android/build" \
-H "Content-Type: application/json" \
-d "{
    \"app\": \"$app_url\",
    \"testSuite\": \"$test_suite_url\",
    \"project\": \"$PROJECT_NAME\",
    \"devices\": [\"Samsung Galaxy S24-14.0\", \"Google Pixel 8-14.0\", \"Samsung Galaxy S21-11.0\"],
    \"testObservability\": true,
    \"accessibility\": true,
    \"accessibilityOptions\": {
        \"wcagVersion\": \"wcag21aa\",
        \"includeIssueType\": {
            \"bestPractice\": true,
            \"needsReview\": false
        },
        \"includeTagsInTestingScope\": [\"TAG_1\"],
        \"excludeTagsInTestingScope\": [\"TAG_2\"]
    }
  }"

Response

A sample response for the request is shown below:

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

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

View test results

After you run the test using the REST API, visit the App Automate 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.