Skip to main content

Integrate Your Test Suite with BrowserStack

BrowserStack gives you instant access to our Playwright Grid of 3000+ real devices and desktop browsers. Running your Playwright tests with C# on BrowserStack is simple.

Setup authentication

Set environment variables for BrowserStack credentials

In the previous section, we set up BrowserStack credentials directly in the test script. That method works for a sample build, but for a production-grade integration we recommend you store your credentials as environment variables and use those environment variables in your code.

$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"

Use BrowserStack credentials in your test cases

Update your test cases to read BrowserStack credentials from environment variables and point the Selenium hub to the BrowserStack remote hub URL.

test-script.cs

Connect your website under test

BrowserStack can integrate with test suites pointing to your localhost URL, staging environment and even websites behind one or more proxies/firewalls.

  • Language Bindings
  • CLI Interface - Binary

Install the package

Install the BrowserStack Local binary by running the following command.

dotnet add package BrowserStackLocal

Set the access key and use available methods in your test script

Set the bsLocalArgs variable to your BrowserStack access key and use the following methods provided by the local library to manage your local connection:

Method Description
local.start(bsLocalArgs) Expects bsLocalArgs object. Returns a callback when the tunnel has started successfully. Your test script should start executing after this callback has been invoked.
local.stop() Call this method after your test suite is complete.
local.isRunning() Check if the BrowserStack local instance is running.
test-script.cs

Add desired capabilities to enable browserstack.local

Copy and set the browserstack.local capability to true. You may face errors running your test script if any other capability is enabled before setting up browserstack-local.

  "capabilities": {
    "build": "browserstack-build-1",
    "name": "BStack Playwright local test",
    "browserstack.debug": true,
    "browserstack.local": true
  },

If your staging environment is behind a proxy or firewall, additional arguments, such as proxy username, proxy password, etc, need to be set. Check out Local Binary parameters to learn about additional arguments.

Download BrowserStack Local

Show download options

Unzip the binary

Unzip the downloaded file and move it to a folder/directory from which you have permission to start it using your command line or terminal.

Run the binary using your command line or terminal

Run the adjacent command to initiate the BrowserStack Local connection

If your staging environment is behind a proxy or firewall, additional arguments, such as proxy username, proxy password, etc, need to be set. Check out Local Binary parameters to learn about additional arguments.

# Step 3 - Run this command in your terminal to start the BrowserStack Local binary. Your working directory should be where you have the downloaded binary.
./BrowserStackLocal --key YOUR_ACCESS_KEY
# Step 3 - Run this command in your command prompt. Your working directory should be where you have unzipped BrowserStackLocal.exe
BrowserStackLocal.exe --key YOUR_ACCESS_KEY

Set up config to enable browserstack.local

Copy the capabilities from the adjacent window into your config file.

  "capabilities": {
    "build": "browserstack-build-1",
    "name": "BStack Playwright local test",
    "browserstack.debug": true,
    "browserstack.local": true
  },

Migrate your test cases

This section helps you with all the configuration changes, commonly used features, and best practices for a smooth migration of your test cases to BrowserStack.

Run test suite on a single browser

We recommend running your build using a single browser like Chrome or Firefox, to begin with. This isolates issues during the migration phase and helps with faster debugging. Refer to the capabilities as shown to use Chrome.

single.conf.json

Once you’ve migrated your test cases or have achieved stability with Chrome or Firefox, you can set up cross-browser testing.

Organize tests

Use the following capabilities for naming your tests and builds. This ensures effective debugging, test reporting, and build execution time analysis.

single.conf.json
Capability Description
sessionName Name for your test case. For example, Homepage - Get started
buildName CI/CD job or build name. For example, Website build #23, staging_1.3.27
projectName Name of your project. For example, Marketing Website

Use a new buildName name every time you run your test cases. This ensures that sessions are logically grouped under a unique build name and helps you monitor the health of your test suite effectively.

A build can only have a maximum of 1000 tests and post that a new build gets created with a ‘-1’ suffixed to the original build name.

Mark test as passed or failed

To mark whether your test has passed or failed on BrowserStack, use the Javascript executor in your test script. You can mark a test as passed or failed based on your test assertions.

The arguments passed in the Javascript method for setting the status and the corresponding reason of the test are status and reason

  • status accepts either passed or failed as the value.
  • reason accepts a string value.
TestScript.cs

Set up debugging capabilities

To effectively debug your tests, utilize the following capabilities:

  1. Enable visual logs and automatic screenshot capture at every Selenium command by setting the debug capability.
  2. By default, Console Logs with log level ‘errors’ are enabled. Utilize the consoleLogs capability to enable various log levels, including warnings, info, verbose, errors, and disable.
  3. Capture the browser’s performance data, such as network traffic, latency, HTTP requests, and responses in a HAR format, by setting the networkLogs capability.
App.config

Commonly used features and advanced-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
browserstack.geoLocation Set the country code you want your test to detect A string. An ISO 2 country code

FR for France,
CN for China

Check out the complete list of 45+ countries we support.
browserstack.yml

Others

Following are a few additional links to documentation pages that might help with your test scenarios:

Next steps

Once you have successfully integrated your test suite with BrowserStack, you might want to check the following:

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