Integrate Cucumber - Ruby test suite with App Accessibility testing

Upload your app

Upload your Android app (.apk, .aab, or .xapk file) or iOS app (.ipa file) to BrowserStack servers using REST API.

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/upload" \
-F "file=@/path/to/app/file/Application-debug.apk"

A sample response for the request is shown below:

{
    "app_url": "bs://c8ddcb5649a8800075bfd8f151115bba6b3",
    "custom_id": "SampleApp",
    "shareable_id": "tests/SampleApp"
}

Note the app_url value returned in the API response. You will use this value to set the app capability in your test configuration file.

Set your BrowserStack credentials

Save your BrowserStack credentials as environment variables to make it easier to run your test suite from your local or CI environment.

Add the BrowserStack Ruby SDK dependency

1. Navigate to the Gemfile in your Cucumber - Ruby test suite and add the BrowserStack Ruby SDK dependency:

    gem 'browserstack-ruby-sdk'
   

2. Install the BrowserStack Ruby SDK and other gems from your Gemfile:

    bundle install
   

Create the browserstack.yml configuration file

Use the BrowserStack Capability Generator to create a browserstack.yml file and save it in the same directory as your Gemfile.
The browserstack.yml configuration file defines the required capabilities to run tests on BrowserStack. If you are testing on both Android and iOS devices, you must create separate configuration files for each platform.

Modify the configuration file

Modify the browserstack.yml file to include the accessibility testing capabilities.

1. Open the browserstack.yml file.
2. Set your BrowserStack username and access_key.
3. Update the app value with the app_url from step 1.
4. Add the accessibility flag and set its value to true.
5. Configure the accessibilityOptions property to set various accessibility testing options. For details, see Configuration options.
6. Save the file.

Run the sample test

From the directory containing your features/ folder, run:

  browserstack-sdk exec cucumber features/<feature-file>.feature

The SDK will automatically use the browserstack.yml file in your current working directory.

To use a different config file, specify it with --browserstackConfigFile:

  browserstack-sdk exec --browserstackConfigFile=<path/to/config/file.yml>

View the accessibility test report

After the test completes, view the report in your project folder on the App Accessibility dashboard.

Visit App Accessibility dashboard