getting started
Playwright with JUnit
Your guide to running tests using JUnit SDK on BrowserStack’s Playwright Grid of 100+ browser-OS combinations.
This section covers running your first build with BrowserStack’s sample repo. To run builds with your existing test suite(s), skip to integrate your test suite.
Onboard faster with Test Companion
Launch in your IDE. Chat with the AI assistant to configure and run your first build instantly.
Prerequisites
- BrowserStack Username and Access key. You can find this in your account profile. If you have not created an account yet, you can sign up for a Free Trial.
- JUnit, Java v8+ is installed on your machine.
- If you are using CLI for running tests, ensure that Maven is installed on your machine, Maven environment variables are set, and Maven bin is added to system path,
$PATH.
Run a sample build
Clone sample repository
Clone our sample Git repository using the following command:
# clone sample junit repository
git clone https://github.com/browserstack/java-playwright-browserstack.git
cd java-playwright-browserstack
Compile the project
Compile the source code of the project by running the following command in your terminal/command-line:
mvn compile
Configure your browserstack.yml config file
The browserstack.yml file holds all the required capabilities to run your tests on BrowserStack
Set access credentials
Set userName and accessKey properties in browserstack.yml to authenticate your tests on BrowserStack.
Specify platforms to test on
Set the browsers/OS you want to test under the platforms object. Select over 100+ browsers-OS combinations from the list of supported browsers and OS
Update the browserstack.yml config file
Copy and replace the following config in the browserstack.yml file available in the root directory of the project.
userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
platforms:
- YOUR_FIRST_OS_TYPE: YOUR_FIRST_OS
YOUR_FIRST_OS_VERSION_TYPE: YOUR_FIRST_OS_VERSION
YOUR_FIRST_BROWSER_TYPE: YOUR_FIRST_BROWSER
YOUR_FIRST_BROWSER_VERSION_TYPE: YOUR_FIRST_BROWSER_VERSION
- YOUR_SECOND_OS_TYPE: YOUR_SECOND_OS
YOUR_SECOND_OS_VERSION_TYPE: YOUR_SECOND_OS_VERSION
YOUR_SECOND_BROWSER_TYPE: YOUR_SECOND_BROWSER
YOUR_SECOND_BROWSER_VERSION_TYPE: YOUR_SECOND_BROWSER_VERSION
- YOUR_THIRD_OS_TYPE: YOUR_THIRD_OS
YOUR_THIRD_OS_VERSION_TYPE: YOUR_THIRD_OS_VERSION
YOUR_THIRD_BROWSER_TYPE: YOUR_THIRD_BROWSER
YOUR_THIRD_BROWSER_VERSION_TYPE: YOUR_THIRD_BROWSER_VERSION
selfHeal: YOUR_SELF_HEAL
Execute build on BrowserStack
You are now ready to run your build on BrowserStack. From the root directory of the project, run the following command.
mvn test -P sample-test
View test results
View your tests on the BrowserStack Automate dashboard. To learn more about the dashboard, check the view test results document.
Next steps
After you have successfully run your first test on BrowserStack, try integrating your test suite with BrowserStack.