Skip to main content
No Result Found

Test Observability on NUnit

Quick start guide to integrate BrowserStack Test Observability with NUnit

Pre-requisites

  • You have a C# NUnit test suite.
  • Ensure you have .Net v5.0+ and NUnit v3.0.0+.
  • You may run your tests on BrowserStack Automate or even on any other cloud provider or even locally.
  • Your tests can be unit / integration / functional or of any nature.
  • Note: The BrowserStack SDK for C# is currently not available on Mac computers with the M1 and M2 chip architecture.

Integrate with Test Observability

You can use BrowserStack Test Observability both when you’re using BrowserStack’s devices and browsers to run your functional end-to-end tests and also if you’re running tests locally on your laptop/CI system or even when you’re using some other cloud provider.

Not only that, Test Observability is agnostic to the type of testing and hence you could also integrate it with your unit or integration test suite written using NUnit.

Please select your setup below to get started with an awesome debugging experience with Test Observability:

To start using BrowserStack Test Observability with your existing setup of NUnit tests running on BrowserStack Automate or App Automate, you’d need to integrate with the BrowserStack SDK. Follow one of the methods below to integrate the SDK and start using Test Observability:

If you’re an existing BrowserStack SDK user, you can skip the steps below. However, ensure that you’ve specified static names (names should not change across build runs) for projectName and buildName in the browserstack.yml file in your project. Also, restrict the characters in your projectName and buildName to alphanumeric characters (A-Z, a-z, 0-9), underscores (_), colons (:), and hyphens (-). Any other character will be replaced with a space.

Set BrowserStack credentials

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

Copy icon Copy
$env:BROWSERSTACK_USERNAME="YOUR_USERNAME"
$env:BROWSERSTACK_ACCESS_KEY="YOUR_ACCESS_KEY"
Copy icon Copy
setx BROWSERSTACK_USERNAME "YOUR_USERNAME" 
setx BROWSERSTACK_ACCESS_KEY "YOUR_ACCESS_KEY" 
set BROWSERSTACK_USERNAME=YOUR_USERNAME
set BROWSERSTACK_ACCESS_KEY=YOUR_ACCESS_KEY
Copy icon Copy
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 ProjectManage NuGet Packages. A NuGet Package Manager Window opens.
  2. In the Browse tab, search for BrowserStack.TestAdapter, and click Install.

Install BrowserStack as NuGet

Create the browserstack.yml file

Ensure you create browserstack.yml file at the root of your directory with the following structure.

browserstack.yml
Copy icon Copy
userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
buildName: "Your static build/job name goes here"
projectName: "Your static project name goes here"
CUSTOM_TAG_1: "You can set a custom Build Tag here"
# Use CUSTOM_TAG_<N> and set more build tags as you need.
testObservability: true
browserstackAutomation: false # Set to true for tests on BrowserStack products.

The projectName and buildName config must be static and not change across different runs of the same build. This is a deviation in approach as specified by BrowserStack Automate or App Automate as Test Observability will automatically identify different build runs.

Restrict the characters in your projectName and buildName to alphanumeric characters (A-Z, a-z, 0-9), underscores (_), colons (:), and hyphens (-). Any other character will be replaced with a space.

Enable Test Observability

Run the following commands to set Test Observability on in an environment variable. This is a onetime setup that you will need to do before running tests.

setx BROWSERSTACK_TEST_OBSERVABILITY="true"
set BROWSERSTACK_TEST_OBSERVABILITY="true"
dotnet build
export BROWSERSTACK_TEST_OBSERVABILITY="true"
dotnet build

Run your suite with Test Observability

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

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

Run test suite using VS code

Post build run completion, you’ll be able to see the build run report along with all necessary debugging information right on this dashboard.

Visit Test Observability

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

Is this page helping you?

Yes
No

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!

Talk to an Expert
Download Copy Check Circle