Test localhost and staging websites that are not publicly accessible

BrowserStack can integrate with test suites pointing to your localhost URL, staging environment, and even websites behind one or more proxies/firewalls. This is done using BrowserStack Local - a tunneling feature that establishes a secure connection between your machine and the BrowserStack Cloud.

Select your integration method

BrowserStack SDK (Recommended)

Plug-n-play solution that takes care of all the integration steps for you
Legacy integration

Start and stop the BrowserStack Local tunnel within your test suite manually

Prerequisites

If you have already run your first test, you can skip the 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.
Maven is installed on your machine, Maven environment variables are set, and Maven bin is added to system path, $PATH.

Run your first local test

Configure your JUnit tests for Local Testing using the following steps:

Clone the junit-browserstack sample repo on GitHub using the following command:

Copy snippet

Verify that the browserstackLocal dependency is added in the pom.xml file:

Copy snippet

Compile the source code of the project by running the following command in your terminal/command-line:

Copy snippet

Update your config file in your sample repository to set your BrowserStack Username and Access Key.

Verify that the BrowserstackLocal capability is set to true:

Copy snippet

Run your JUnit test using BrowserStack Local with the following command:

Copy snippet

View your tests on BrowserStack on the BrowserStack Automate Dashboard.

Protip: You can refer to Playwright supported capabilities and select from a wide range of custom capabilities that BrowserStack supports.

Understand your local test script

When you run the mvn test -P sample-local-test command, the LocalTest.java file within the java-playwright-browserstack/src/test/java/tests/LocalTest.java directory is executed.

When the test is triggered, it:

Opens the http://bs-local.com:45454/check website.
Checks whether the web page displays the Up and running text.
Marks the test as passed or failed based on whether the text is displayed on the web page.