Integrate Your C# 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 app to be tested

The app property determines the app to be tested. You can upload an Android app (.apk or .aab file) or an iOS app (.ipa file) from your local filesystem.

Supported method	Description
path(Recommended)	SDK uploads the app using the specified relative or absolute path. Eg: app: ./SampleApp.apk.

Check out how to create IPA files for iOS app testing on BrowserStack.

App

Set the path to your app. Or, if you have already uploaded your app, provide one of the other acceptable app property values here

Other acceptable app property values

You can use BrowserStack REST API to upload your app.

Following is a sample response that is generated when you upload an app using any of the mentioned methods:

 {
    "app_url":"bs://f7c874f21852ba57957a3fdc33f47514288c4ba4", 
    "custom_id":"SampleApp",
    "shareable_id":"exampleuser/SampleApp"
 }

The following table explains the other acceptable app property values:

Supported method	Description
app_url	Uploaded app’s app_url is a valid value for app property. Eg: app: bs://45e1c1473b17b7643aed1761f51cb5cdf3d3e334
custom_id	If you’ve defined a custom_id while uploading your app, the same value can be used as app property value. Eg: app: CalculatorApp
shareable_id	If you wish to test an app uploaded by someone else from your organization, a shareable_id can be used as the app property value. Eg: app: exampleuser/CalculatorApp

Check out how to specify the application under test to understand the above options better.

Set platforms to test on

Platform

Select an OS to choose the devices from below

Android

Android

iOS

Set the devices you want to test under the platforms object.

Parallel thread #1

Windows 10

Chrome 120

Parallel thread #2

OS X Monterey

Safari 15.6

Parallel thread #3

iOS 15

iPhone 13

Do you want to dynamically configure platforms?

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

Enable BrowserStack Local

Test apps with local/staging API servers

True

False

Test apps locally with local/staging API servers

BrowserStack’s Local Testing feature connects with locally hosted API servers to run your apps

Learn more

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 BrowserStack 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 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

You can re-run selected tests from a build using any of the following options:

Option 1: 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 2: 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

Use additional debugging features

By default, BrowserStack provides prettified session logs, screenshots on every failed command, and a video of the entire test. Additionally, you can enable the following features:

Visual logs

Enables screenshots for every command ran

True

False

Network logs

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

True

False

Create browserstack.yml file

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

Set BrowserStack credentials

Saving your BrowserStack credentials as environment variables makes it easier to run 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

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 app to be tested

The app property determines the app to be tested. You can upload an Android app (.apk or .aab file) or an iOS app (.ipa file) from your local filesystem.

Supported method	Description
path(Recommended)	SDK uploads the app using the specified relative or absolute path. Eg: app: ./SampleApp.apk.

Check out how to create IPA files for iOS app testing on BrowserStack.

App

Set the path to your app. Or, if you have already uploaded your app, provide one of the other acceptable app property values here

Other acceptable app property values

You can use BrowserStack REST API to upload your app.

Following is a sample response that is generated when you upload an app using any of the mentioned methods:

 {
    "app_url":"bs://f7c874f21852ba57957a3fdc33f47514288c4ba4", 
    "custom_id":"SampleApp",
    "shareable_id":"exampleuser/SampleApp"
 }

The following table explains the other acceptable app property values:

Supported method	Description
app_url	Uploaded app’s app_url is a valid value for app property. Eg: app: bs://45e1c1473b17b7643aed1761f51cb5cdf3d3e334
custom_id	If you’ve defined a custom_id while uploading your app, the same value can be used as app property value. Eg: app: CalculatorApp
shareable_id	If you wish to test an app uploaded by someone else from your organization, a shareable_id can be used as the app property value. Eg: app: exampleuser/CalculatorApp

Check out how to specify the application under test to understand the above options better.

Set platforms to test on

Platform

Select an OS to choose the devices from below

Android

Android

iOS

Set the devices you want to test under the platforms object.

Parallel thread #1

Windows 10

Chrome 120

Parallel thread #2

OS X Monterey

Safari 15.6

Parallel thread #3

iOS 15

iPhone 13

Do you want to dynamically configure platforms?

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

Enable BrowserStack Local

Test apps with local/staging API servers

True

False

Test apps locally with local/staging API servers

BrowserStack’s Local Testing feature connects with locally hosted API servers to run your apps

Learn more

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 BrowserStack 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 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

You can re-run selected tests from a build using any of the following options:

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

buildName: bstack-demo 123
buildIdentifier: null

Option 2: 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

By default, BrowserStack provides prettified session logs, screenshots on every failed command, and a video of the entire test. Additionally, you can enable the following features:

Visual logs

Enables screenshots for every command ran

True

False

Network logs

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

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.