Run accessibility checks on a Robot sample repo

Get the sample project

Get the BrowserStack sample project using one of the following options:

git clone -b sdk https://github.com/browserstack/robot-appium-app-browserstack

Set up the Python virtual environment

Navigate to the sample project directory and create a Python virtual environment.

cd robot-appium-app-browserstack
python3 -m venv env
source env/bin/activate
pip3 install -r requirements.txt

cd robot-appium-app-browserstack
python3 -m venv env
.\env\Scripts\Activate.ps1
pip3 install -r requirements.txt

Update the BrowserStack SDK

If you have not already done so, update the BrowserStack SDK to the latest version.

pip install --upgrade browserstack-sdk

Navigate to the platform directory

Based on your testing platform, navigate to the android or iOS directory.

cd Tests/android

cd Tests/ios

Modify the configuration file

The browserstack.yml file defines the required capabilities to run tests on BrowserStack. It is platform-specific and located in the corresponding platform folder (android/ or ios/). Make sure you modify the file that corresponds to your testing platform.

1. Open the browserstack.yml file in an editor.
2. Set your BrowserStack userName and accessKey.
3. Set the accessibility flag to true. The default value is false.
4. Set the framework to robot.
5. Save the file.

userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
projectName: BrowserStack Samples
buildName: browserstack build
buildIdentifier: '#${BUILD_NUMBER}'
app: ./BStackSampleApp.ipa
framework: robot
platforms:
  - deviceName: iPhone 14
    osVersion: 16
    platformName: ios
  - deviceName: iPhone 12
    osVersion: 17
    platformName: ios
parallelsPerPlatform: 2
accessibility: true
accessibilityOptions:
  wcagVersion: wcag21aa
  includeIssueType:
    bestPractice: false
  scannerProcessingTimeout: 10
browserstackLocal: false
debug: false
networkLogs: false
consoleLogs: errors

Run the sample test

In the Python virtual environment, navigate to the platform folder and run the following command to execute the sample test:

browserstack-sdk robot SingleTestAndroid.robot

browserstack-sdk robot SingleTestiOS.robot

View the Accessibility test report

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

Visit App Accessibility dashboard