Integrate your test suite with BrowserStack
BrowserStack’s MSTest SDK supports a plug-and-play integration. Run your entire test suite in parallel in a few steps!
Looking for a starter project? Get started with our MSTest sample project
Prerequisites
- An existing automated test suite.
- .Net v5.0+, MSTest v2.2.4+
The BrowserStack SDK for MSTest is currently not available on Mac computers with the M1 and M2 chip architecture.
Integration steps
If you want to get started with our starter project, refer to our MSTest sample project. If you are using our sample project, you do not need to follow the integration steps.
Depending on your preferred method of building projects, perform the following steps to integrate your test suite with BrowserStack.
Add BrowserStack SDK as NuGet package
Steps to install BrowserStack SDK as a NuGet package:
- On the Visual Studio toolbar, select Project → Manage NuGet Packages. A NuGet Package Manager Window opens.
- 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/OS you want to test under the platforms
object. Select over 100+ browsers-OS combinations from the list of supported browsers and OS.
BrowserStack Reporting
You can leverage BrowserStack’s extensive reporting features using the following capabilities:
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 TestCategory=sample-test
Windows Powershell:
$env:BROWSERSTACK_BUILD_NAME=“bstack-demo 123”; dotnet test --filter TestCategory=sample-test
Windows cmd:
set BROWSERSTACK_BUILD_NAME="bstack-demo 123" && dotnet test --filter TestCategory=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
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.
Update browserstack.yml file
Update the browserstack.yml
file in the root folder of your test suite and add the following code to it. Note that the values in the platforms
section are sample values. Replace them with the browser-OS combination of your choice.
Run your test suite
The BrowserStack Test Adapter enables you to execute your test suite seamlessly, just as you did previously.
- On the Visual Studio toolbar, select Test → Test Explorer.
- Right-click on your test and click 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/OS you want to test under the platforms
object. Select over 100+ browsers-OS combinations from the list of supported browsers and OS.
BrowserStack Reporting
You can leverage BrowserStack’s extensive reporting features using the following capabilities:
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 TestCategory=sample-test
Windows Powershell:
$env:BROWSERSTACK_BUILD_NAME=“bstack-demo 123”; dotnet test --filter TestCategory=sample-test
Windows cmd:
set BROWSERSTACK_BUILD_NAME="bstack-demo 123" && dotnet test --filter TestCategory=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
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.
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. Note that the values in the platforms
section are example values. Replace them with the browser-OS combination of your choice.
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:
To find out the location of the BrowserStack SDK log files, refer to BrowserStack SDK Log Files. If you are looking for more information, see FAQ documentation.
Advanced features and use cases
Here’s a list of features and capabilities you may find useful.
Lighthouse Integration
Learn how to Integrate Lighthouse to your Playwright tests for improving the quality of your web pages.
Chrome Extension Testing
Learn more about Testing Chrome Extension on your Playwright tests with BrowserStack Automate.
Simulate IP geolocation
The browserstack.geoLocation
capability lets you test your websites across different countries.
Note that this capability is supported on the Enterprise plan only. You can contact sales to get an Enterprise plan for your account.
Capability | Description | Expected values |
---|---|---|
resolution |
Set the resolution of your VM before beginning your test | A string. Default resolution is 1024x768 Supported resolutions: Windows (XP, 7): 800x600 , 1024x768 , 1280x800 , 1280x1024 , 1366x768 , 1440x900 , 1680x1050 , 1600x1200 , 1920x1200 , 1920x1080 , and 2048x1536 Windows (8, 8.1, 10): 1024x768 , 1280x800 , 1280x1024 , 1366x768 , 1440x900 , 1680x1050 , 1600x1200 , 1920x1200 , 1920x1080 , and 2048x1536 OS X (Ventura, Monterey, Big Sur, Catalina, Mojave, and High Sierra): 1024x768 , 1280x960 , 1280x1024 , 1600x1200 , 1920x1080 , 2560x1440 , 2560x1600 , and 3840x2160 OS X (All other versions): 1024x768 , 1280x960 , 1280x1024 , 1600x1200 , and 1920x1080
|
Others
Following are a few additional links to documentation pages that might help with your test scenarios:
- Change the desktop browser window in your tests
- Test File upload scenarios
- Prevent sensitive test data from appearing in the Automate logs using mask commands
Next steps
Once you have successfully integrated your test suite with BrowserStack, you might want to check the following:
- Refer to the list of capabilities that you want to use in tests
- Find information about your Projects, Builds and Sessions using our REST APIs
- Set up your CI/CD: Gitlab, Azure Pipelines, CircleCI, GitHub Actions, Jenkins
We're sorry to hear that. Please share your feedback so we can do better
Contact our Support team for immediate help while we work on improving our docs.
We're continuously improving our docs. We'd love to know what you liked
- RESOURCES
We're sorry to hear that. Please share your feedback so we can do better
Contact our Support team for immediate help while we work on improving our docs.
We're continuously improving our docs. We'd love to know what you liked
Thank you for your valuable feedback!