Integrate your test suite with BrowserStack

Set BrowserStack credentials

Save your BrowserStack credentials as environment variables. It simplifies running your test suite from your local or CI environment.

export BROWSERSTACK_USERNAME="YOUR_USERNAME"
export BROWSERSTACK_ACCESS_KEY="YOUR_ACCESS_KEY"

$env: BROWSERSTACK_USERNAME "YOUR_USERNAME"
$env: 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 NodeJS SDK

Execute the following commands to install BrowserStack NodeJS SDK for plug-and-play integration of your test suite with BrowserStack.

npm i -D browserstack-node-sdk@latest
npx setup --username "YOUR_USERNAME" --key "YOUR_ACCESS_KEY"

Update your BrowserStack config file

After you have installed the SDK, a browserstack.yml config file will be created at the root level of your project. This file holds all the required capabilities to run tests on BrowserStack.

Specify platforms to test on

Set the browsers/devices you want to test under the platforms object. Our configuration follows W3C-formatted capabilities.

Platform	Browser
Linux	Firefox
Linux	Chrome
Linux	Edge

.

Enable BrowserStack Local

Test localhost/internal servers in your network

True

False

Test localhost/staging websites that are not publicly accessible

BrowserStack’s Local Testing feature connects with test suites pointing to your localhost URL

Learn more

BrowserStack Local supports all advanced use cases and restricted networks. Contact our support team for assistance in configuring BrowserStack Local for your enterprise.

BrowserStack Reporting

You can leverage BrowserStack’s extensive reporting features using the following capabilities:

Build Name

Set a name to your build (usually the same as the build ID that’s on your CI/CD platform). Accepted characters: A-Z, a-z, 0-9, ., :, -, [], /, @, &, ‘, _. All other characters are ignored.
Character limit: 255

Project Name

Set a project name for your project.

sessionName is the name of your test sessions and is automatically picked from your test class/spec name. It doesn’t need to be set manually when using the BrowserStack SDK.

Use additional debugging features

BrowserStack offers session logs, screenshots of failed commands, and a video of the entire test, with additional options to enable.

Test Observability

Enables Test Observability, an advanced test reporting and debugging tool that helps you analyze test failures much faster. If enabled, Test Observability collects test data using the SDK. This capability is enabled (set to true) by default.

True

False

Visual logs

Enables screenshots for every selenium command ran

True

False

Video logs

Enables accurate video recordings of execution

True

False

Network logs

Enables network capture for the session in HAR format. Reduces session performance slightly

True

False

Console logs

Set the remote browser’s console log levels. Currently supported only on Chrome browsers (Desktop and Android)

Info

Info

Verbose

Debug

Warn

Error

Use Automate Turboscale

Turboscale

Enables Turboscale

True

False

Update browserstack.yml file with selected capabilities

Copy the following code snippet and replace contents of browserstack.yml file in the root folder of your test suite.

```yml userName: YOUR_USERNAME accessKey: YOUR_ACCESS_KEY platforms: - os: Linux browserName: playwright-firefox browserVersion: latest parallelsPerPlatform: 1 YOUR_LOCAL_CAPS_TYPE: YOUR_LOCAL_CAPS YOUR_BUILD_NAME_TYPE: YOUR_BUILD_NAME YOUR_BUILD_IDENTIFIER_KEY: YOUR_BUILD_IDENTIFIER_TYPE YOUR_PROJECT_NAME_TYPE: YOUR_PROJECT_NAME YOUR_TEST_OBSERVABILITY_CAPS_TYPE: YOUR_TEST_OBSERVABILITY_CAPS YOUR_NETWORK_CAPS_TYPE: YOUR_NETWORK_CAPS YOUR_CONSOLE_CAPS_TYPE: YOUR_CONSOLE_CAPS YOUR_TURBOSCALE_CAPS_TYPE: YOUR_TURBOSCALE_CAPS ```

browserstack.yml

Copy

userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
platforms:
  - os: Linux
    browserName: playwright-firefox
    browserVersion: latest
parallelsPerPlatform: 1
browserstackLocal: true
buildName: bstack-demo
buildIdentifier: ${BUILD_NUMBER}
projectName: BrowserStack Sample
testObservability: true
networkLogs: true
consoleLogs: info
turboScale: true

It is mandatory to set turboScale to true to use Automate Turboscale.

Run your test suite

Your test suite is now ready to run on BrowserStack. Use the following command to execute your tests on BrowserStack using the NodeJS SDK.

npx browserstack-node-sdk <Your existing command for running your test suite>

Set OS-browser combination to run test

We recommend running your build using a single browser like Chrome or Firefox to begin with. This will isolate issues during the migration phase and help with faster debugging. Refer the capabilities as shown to use Chrome. Once you’ve migrated your test cases or have achieved stability with Chrome or Firefox, you can set up cross-browser testing.

//Add the following options to your test script
projects: [
  {
    name: "chrome@latest:Windows 11@browserstack",
    use: {
      browserName: "chromium",
      channel: "chrome",
    },
  },
  {
    name: "playwright-webkit@latest:OSX Ventura@browserstack",
    use: {
      browserName: "chromium",
      channel: "chrome",
    },
  },
  {
    name: "chrome@Samsung Galaxy S22:13@browserstack-mobile",
    use: {
      baseURL: "https://www.bstackdemo.com/",
      browserName: "chromium",
      channel: "chrome",
    },
  },
],

Organize tests

Use the following capabilities for naming your tests and builds. This ensures effective debugging, test reporting, and build execution time analysis.

const caps = {
  name: "My playwright test",
  build: "playwright-build-1",
};

Mark test as passed or failed

To mark whether your test has passed or failed on BrowserStack, use the Javascript executor in your test script. You can mark a test as passed or failed based on your test assertions.

The arguments passed in the JavaScript method for setting the status and the corresponding reason of the test are status and reason.

• status accepts either passed or failed as the value
• reason accepts a string value

await page.evaluate((_) => {},
    `browserstack_executor: ${JSON.stringify({ action: "setSessionStatus", arguments: { status: "passed", reason: "Product added to cart" } })}`);
catch (e) {
    console.log(e);
    await page.evaluate((_) => {},
    `browserstack_executor: ${JSON.stringify({ action: "setSessionStatus", arguments: { status: "failed", reason: "Test failed" } })}`);
  }

Set up debugging capabilities

Use the following common debugging capabilities for your tests:

1. Set the debug capability to record video of the entire test execution
2. Console Logs with log level errors are enabled by default. Set the console capability to enable different log levels, such as warnings, info, verbose, errors, and disable.

const caps = {
    "debug" : "true",
    "networkLogs" : "true",
 }