Set BrowserStack credentials

Save your BrowserStack credentials as environment variables. It simplifies running your test suite from your local or CI environment. For Linux, set the values in your ~/.zprofile (zsh) or ~/.profile (bash).

$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

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

Add BrowserStack SDK as NuGet package

Steps to install BrowserStack SDK as a NuGet package:

1. On the Visual Studio toolbar, select Project > Manage NuGet Packages. A NuGet Package Manager Window opens.
2. In the Browse tab, search for BrowserStack.TestAdapter, and click Install.

Create your BrowserStack config file

After installing the SDK, create a browserstack.yml config file at the root level of your project. This file holds all the required capabilities to run tests on BrowserStack.

Set access credentials

Set userName and accessKey parameters in the browserstack.yml file, available in the root directory, to authenticate your tests on BrowserStack.

Set platforms on which to test

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

Platform	Browser
Linux	Firefox
Linux	Chrome
Linux	Edge

To dynamically configure platforms across different tests, you can comment out the platforms capability while still passing platform-specific capabilities.

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

Build Identifier

Select a dynamic build identifier that appends to the build name and generates a unique name on the BrowserStack dashboard

${BUILD_NUMBER}

${BUILD_NUMBER}

${DATE_TIME}

buildIdentifier	Description	Generated build name on dashboard
${BUILD_NUMBER} (Default)	If the build is triggered locally, an incremental counter is appended. If build is triggered with CI tools, CI-generated build number is appended.	bstack-demo 1 bstack-demo CI 1395
${DATE_TIME}	The timestamp of run time is appended to the build.	bstack-demo 29-Nov-20:44

Advanced use cases for build names

Custom formatting of build name

Prefix buildIdentifier with desired characters, for example, # or :

buildName: bstack-demo
buildIdentifier: '#${BUILD_NUMBER}'

Re-run tests in a build

In order to re-run your build, you need to ensure that your build name matches an existing build so that your tests get merged into the previously run build.
You can re-run selected tests from a build using any of the following options:

Option 1: Set the existing build name in the BROWSERSTACK_BUILD_NAME variable and prepend it to your test run command to re-run tests in the same build:

MacOS/Linux:

BROWSERSTACK_BUILD_NAME=“bstack-demo 123” dotnet test --filter "Category=sample-test"

Windows Powershell:

$env:BROWSERSTACK_BUILD_NAME=“bstack-demo 123”; dotnet test --filter "Category=sample-test"

Windows cmd:

set BROWSERSTACK_BUILD_NAME="bstack-demo 123" && dotnet test --filter "Category=sample-test"

Option 2: Set the build name as a combination of buildName and buildIdentifier, as seen on the dashboard, and set buildIdenitifier as null:

buildName: bstack-demo 123
buildIdentifier: null

Option 3: Set the buildIdentifier as the build number or time of the required build as seen on the dashboard:

buildName: bstack-demo
buildIdentifier: 123

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

Update browserstack.yml file

Update the browserstack.yml file in the root folder of your test suite and add the given code to it.

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

Run your test suite

The BrowserStack Test Adapter enables you to execute your test suite seamlessly, just as you did previously.

1. On the Visual Studio toolbar, select Test > Test Explorer.
2. Right-click on your test and click Run.

Set BrowserStack credentials

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

$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

# Set these values in your ~/.zprofile (zsh) or ~/.profile (bash)
export BROWSERSTACK_USERNAME="YOUR_USERNAME"
export BROWSERSTACK_ACCESS_KEY="YOUR_ACCESS_KEY"

Install BrowserStack SDK

Run the given command to install the BrowserStack SDK and create a browserstack.yml file in the root directory of your project.

• The browserstack.yml config file holds all the required capabilities to run tests on BrowserStack.

• The BrowserStack.TestAdapter works on top of your framework test adapter to run parallel tests on BrowserStack across multiple platforms mentioned on the browserstack.yml file.

dotnet add package BrowserStack.TestAdapter
dotnet build
dotnet browserstack-sdk setup --userName "YOUR_USERNAME" --accessKey "YOUR_ACCESS_KEY"

dotnet add package BrowserStack.TestAdapter
dotnet build
dotnet browserstack-sdk setup --userName "YOUR_USERNAME" --accessKey "YOUR_ACCESS_KEY"

Update your BrowserStack config file

Now that the BrowserStack SDK has been installed and the browserstack.yml config file has been created, update your browserstack.yml config file with the given parameters.

Set platforms on which to test

Set the browsers 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

Build Identifier

Select a dynamic build identifier that appends to the build name and generates a unique name on the BrowserStack dashboard

${BUILD_NUMBER}

${BUILD_NUMBER}

${DATE_TIME}

buildIdentifier	Description	Generated build name on dashboard
${BUILD_NUMBER} (Default)	If the build is triggered locally, an incremental counter is appended. If build is triggered with CI tools, CI-generated build number is appended.	bstack-demo 1 bstack-demo CI 1395
${DATE_TIME}	The timestamp of run time is appended to the build.	bstack-demo 29-Nov-20:44

Advanced use cases for build names

Custom formatting of build name

Prefix buildIdentifier with desired characters, for example, # or :

buildName: bstack-demo
buildIdentifier: '#${BUILD_NUMBER}'

Re-run tests in a build

In order to re-run your build, you need to ensure that your build name matches an existing build so that your tests get merged into the previously run build.
You can re-run selected tests from a build using any of the following options:

Option 1: Set the existing build name in the BROWSERSTACK_BUILD_NAME variable and prepend it to your test run command to re-run tests in the same build:

MacOS/Linux:

BROWSERSTACK_BUILD_NAME=“bstack-demo 123” dotnet test --filter "Category=sample-test"

Windows Powershell:

$env:BROWSERSTACK_BUILD_NAME=“bstack-demo 123”; dotnet test --filter "Category=sample-test"

Windows cmd:

set BROWSERSTACK_BUILD_NAME="bstack-demo 123" && dotnet test --filter "Category=sample-test"

Option 2: Set the build name as a combination of buildName and buildIdentifier, as seen on the dashboard, and set buildIdenitifier as null:

buildName: bstack-demo 123
buildIdentifier: null

Option 3: Set the buildIdentifier as the build number or time of the required build as seen on the dashboard:

buildName: bstack-demo
buildIdentifier: 123

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

Update browserstack.yml file with selected capabilities

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

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

Run your test suite

Continue running your tests as you have been running previously. The command to run your tests using the BrowserStack SDK remains unchanged. For your reference, here’s a sample command:

dotnet test --filter <EXPRESSION> [other_args]

dotnet test --filter <EXPRESSION> [other_args]