Integrate JUnit 4 test suite with App Accessibility testing

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.

export BROWSERSTACK_USERNAME=YOUR_USERNAME
export BROWSERSTACK_ACCESS_KEY=YOUR_ACCESS_KEY

setx BROWSERSTACK_USERNAME "YOUR_USERNAME"
setx BROWSERSTACK_ACCESS_KEY "YOUR_ACCESS_KEY"
set BROWSERSTACK_USERNAME=YOUR_USERNAME
set BROWSERSTACK_ACCESS_KEY=YOUR_ACCESS_KEY

Install BrowserStack SDK using Maven archetype

Run the following command in your terminal or command line to add the browserstack-java-sdk dependency and the browserstack.yml file to your project.
Replace the placeholder values with your BrowserStack credentials and the path to your app in the following commands.

mvn archetype:generate -B -DarchetypeGroupId=com.browserstack \
-DarchetypeArtifactId="browserstack-sdk-archetype-setup" -DarchetypeVersion=1.1 \
-DgroupId=com.browserstack -DartifactId=junit-appium-app-browserstack -Dversion=1.0 \
-DBROWSERSTACK_USERNAME=YOUR_USERNAME -DBROWSERSTACK_ACCESS_KEY=YOUR_ACCESS_KEY -DBROWSERSTACK_PROJECT_REPO=junit-appium-app-browserstack/junit-4:sdk

mvn archetype:generate -B -DarchetypeGroupId="com.browserstack" -DarchetypeArtifactId="browserstack-sdk-archetype-setup" -DarchetypeVersion="1.1" -DgroupId="com.browserstack" -DartifactId="junit-appium-app-browserstack" -Dversion="1.0" -DBROWSERSTACK_USERNAME="YOUR_USERNAME" -DBROWSERSTACK_ACCESS_KEY="YOUR_ACCESS_KEY" -DBROWSERSTACK_PROJECT_REPO="junit-appium-app-browserstack/junit-4:sdk"

Navigate to the platform folder

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

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.
2. Set your BrowserStack userName and accessKey.
3. Set your projectName and buildName.
4. Set the framework to junit4.
5. Set the accessibility flag to true. The default value is false.
6. Configure the accessibilityOptions property to set various accessibility testing options. For details, see Configuration options.
7. Add the relative or absolute path of the app you want to test in the app property. For example, app: ./examples/BStackSampleApp.apk.
   You can upload an Android app (.apk or .aab file) or an iOS app (.ipa file) from your local filesystem.
8. Specify all the device, OS, and OS version combinations that you want to test in the platforms section.
9. Save the file.

Run the automated test

From your platform folder (Android or iOS), run the following command:

mvn clean
mvn verify -P sample-test

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

Add the BrowserStack SDK

The BrowserStack SDK runs the accessibility scan and publishes the report, even in a non-SDK setup. Add the browserstack-java-sdk dependency to your pom.xml file:

Run the following command from your test suite folder to install the SDK:

Configure browserstack.yml

The browserstack.yml file configures the BrowserStack SDK to scan your session without controlling your driver. Add all keys at the top level of the file, not under accessibilityOptions.

To configure the file, follow these steps:

1. Create or open the browserstack.yml file in the root directory of your project.
2. Set the userName and accessKey.
3. Set the framework to junit4.
4. Set browserstackAutomation to false. By default, the flag is set to true.
5. Set accessibility to true.
6. Add your app ID to app. If your tests already specify the app in their own capabilities and you don’t want to set an app ID in browserstack.yml, set skipAppOverride to true instead.
7. Save the file.

The following configuration runs App Accessibility scans on a JUnit 4 suite. Your tests select the device through their own capabilities.

Run your build

Your test command doesn’t change. Run your test suite from the root directory of your project:

If your suite uses a different command or a Maven profile, continue using that command.

View the App Accessibility report

After the build finishes, confirm both of the following:

• The App Automate dashboard shows your session with accessibility scans.
• The App Accessibility dashboard shows a report for that build.