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.

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 to test on

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

Parallel thread #1

Windows 10

Chrome 120

Parallel thread #2

OS X Monterey

Safari 15.6

Parallel thread #3

iOS 15

iPhone 13

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 build name as the name of the job/test suite being run. 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 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 name

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

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 dramatically faster. If enabled, Test Observability collects test data using the SDK. This capability is enabled (set to true) by default.

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

Debug

Warn

Error

Use Percy Visual Testing

Percy is an all-in-one visual testing and review platform enabling teams to automate visual tests, detect visual bugs, and provide valuable insights into UI changes.

Percy Visual Testing

Enable visual testing to automatically identify and highlight visual UI changes.

Note: Using Percy to perform Visual testing affects the performance of your Automate tests.

True

False

Percy Capture Mode

Select a capture mode for your visual testing.

auto

auto

testcase

click

screenshot

manual

percyCaptureMode takes effect only if you set percy to true. If you set the capture mode to manual, ensure you use the Percy Screenshot function in your test script.

Update browserstack.yml file

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

```yml 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 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_PERCY_CAPS_TYPE: YOUR_PERCY_CAPS YOUR_PERCY_CAPTURE_CAPS_TYPE: YOUR_PERCY_CAPTURE_CAPS ```

browserstack.yml

Copy snippet

Set BrowserStack credentials

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

Install BrowserStack SDK

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

[Only for Macs with Apple silicon] Install dotnet x64 on MacOS

If you are using a Mac computer with Apple silicon chip (M1 or M2) architecture, use the given command.

• <path> - Mention the absolute path to the directory where you want to save dotnet x64
• <version> - Mention the dotnet version which you want to use to run tests

This command performs the following functions:

• Installs dotnet x64
  Installs the required version of dotnet x64 at an appropriate path

• Sets alias
  Sets an alias for the dotnet installation location on confirmation (enter y option)
  The command sets the installation path in your ~/.zshrc (zsh) or ~/.bashrc (bash) profile and you can use this alias to run your tests later. If you choose not to set the alias, when you run the tests, you have to use the entire path to the installation location on every test run.
  

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 following parameters:

Set platforms to test on

Set the browsers and devices you want to test under the platforms object. Our config follows W3C formatted capabilities.

Parallel thread #1

Windows 10

Chrome 120

Parallel thread #2

OS X Monterey

Safari 15.6

Parallel thread #3

iOS 15

iPhone 13

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 build name as the name of the job/test suite being run. 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 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 name

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 dramatically faster. If enabled, Test Observability collects test data using the SDK. This capability is enabled (set to true) by default.

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

Debug

Warn

Error

Use Percy Visual Testing

Percy is an all-in-one visual testing and review platform enabling teams to automate visual tests, detect visual bugs, and provide valuable insights into UI changes.

Percy Visual Testing

Enable visual testing to automatically identify and highlight visual UI changes.

Note: Using Percy to perform Visual testing affects the performance of your Automate tests.

True

False

Percy Capture Mode

Select a capture mode for your visual testing.

auto

auto

testcase

click

screenshot

manual

percyCaptureMode takes effect only if you set percy to true. If you set the capture mode to manual, ensure you use the Percy Screenshot function in your test script.

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.

```yml 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 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_PERCY_CAPS_TYPE: YOUR_PERCY_CAPS YOUR_PERCY_CAPTURE_CAPS_TYPE: YOUR_PERCY_CAPTURE_CAPS ```

browserstack.yml

Copy snippet

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: