Run accessibility checks on a Robot sample repo

Download or clone the sample test repository

Get our sample project using one of the following options:

• Option 1:
  Download the sample test repository.
• Option 2:
  Clone the sample Git repository using the following commands.

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

  Copy

Set up the Python virtual environment

Run the following command in your terminal or command-line:

python3 -m venv env
source env/bin/activate
pip3 install -r requirements.txt

python3 -m venv env
.\env\Scripts\Activate.ps1
pip3 install -r requirements.txt

Set up the dependencies

1. Install BrowserStack Robot SDK.

   python3 -m pip install browserstack-sdk
   browserstack-sdk setup --framework "robot" --username "YOUR_USERNAME" --key "YOUR_ACCESS_KEY"
   

   Copy
2. Update Browserstack SDK to the latest version.

   pip install --upgrade browserstack-sdk
   

   Copy
3. Install robot framework, pabot, selenium library, and appium library.

   pip install robotframework robotframework-pabot robotframework-seleniumlibrary robotframework-appiumlibrary
   

   Copy

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

cd robot-appium-app-browserstack/Tests/android

cd robot-appium-app-browserstack/Tests/ios

Configure the browserstack.yml file

The browserstack.yml file contains the necessary capabilities to run your tests on BrowserStack. This file is platform-specific, ensure you make changes to the file corresponding to your testing platform (Android or iOS).

1. Open the browserstack.yml file in an editor.
2. Add your userName and accessKey.
3. Set the accessibility flag to true. By default, the flag is set to false.
4. Set the framework as robot.

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:

source env/bin/activate
cd Tests/android
browserstack-sdk robot SingleTestAndroid.robot

source env/bin/activate
cd Tests/ios
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