Connect & Get help from fellow developers on our Discord community.

Run C# Playwright-Android tests on BrowserStack Automate

Learn how to run your C# Playwright Android tests on BrowserStack Automate using the BrowserStack.Playwright package for .NET

Use the BrowserStack.Playwright NuGet package to run Playwright Android tests written in C# on real devices via BrowserStack Automate. This guide shows you how to install the package, configure capabilities, connect to an Android device, run a sample script, and mark the session status.

Prerequisites

BrowserStack Username and Access key. You can find this in your account profile. If you have not created an account yet, you can sign up for a Free Trial.
You have .NET 6.0 or later installed (run: dotnet --version).
You have removed any existing Microsoft.Playwright package to avoid conflicts.

Perform the steps given below to run a Playwright-Android test:

Install the BrowserStack Playwright package

Run the given command to add the BrowserStack.Playwright dependency to your project.

Copy

Set your credentials securely

Execute the given command to set environment variables:

Copy

Understand required capabilities

You must pass a capabilities JSON when establishing the WebSocket connection. Below are some key capability fields:

browserstack.username / browserstack.accessKey: Your credentials.
browser: chrome (Android currently supports Chrome).
device: Device name (Example: Samsung Galaxy S25 Ultra).
os_version: Android OS version.
name: Your test name (shown in Automate dashboard).
client.playwrightVersion: Local Playwright version.
browserstack.playwrightVersion: Remote Playwright version on BrowserStack (keep aligned for API compatibility).
browserstack.console: info,errors,warnings for console log verbosity.

Keep version pairs updated when upgrading locally.

Sample C# Android automation script

The following is a sample test script

```csharp
// Sample Playwright Android test on BrowserStack
// Expected: Opens Chrome on the specified Android device, loads Google homepage, marks session passed.

using Microsoft.Playwright;
using System.Text.Json;
using System.Web;
using System.Text;

// TIP: Ensure the Microsoft.Playwright package is removed to avoid type conflicts.

class Program
{
    public static async Task Main(string[] args)
    {
        var browserStackUser = Environment.GetEnvironmentVariable("BROWSERSTACK_USERNAME") ?? "";
        var browserStackAccessKey = Environment.GetEnvironmentVariable("BROWSERSTACK_ACCESS_KEY") ?? "";

        if (string.IsNullOrEmpty(browserStackUser) || string.IsNullOrEmpty(browserStackAccessKey))
        {
            Console.WriteLine("Missing BrowserStack credentials. Set BROWSERSTACK_USERNAME and BROWSERSTACK_ACCESS_KEY.");
            return;
        }

        using var playwright = await Playwright.CreateAsync();

        // Define capabilities for the Android device session
        var capabilities = new Dictionary<string, object?>
        {
            { "browserstack.username", browserStackUser },
            { "browserstack.accessKey", browserStackAccessKey },
            { "browser", "chrome" },
            { "device", "Samsung Galaxy S25 Ultra" },
            { "os_version", "15.0" },
            { "name", "sample_android_playwright_test" },
            { "client.playwrightVersion", "1.53.1" },       // Local Playwright version
            { "browserstack.playwrightVersion", "1.53.0" }, // Remote Playwright version
            { "browserstack.console", "info" }
        };

        var capsJson = JsonSerializer.Serialize(capabilities);
        var capsEncoded = HttpUtility.UrlEncode(capsJson);
        var wsEndpoint = $"wss://cdp.browserstack.com/playwright?caps={capsEncoded}";

        // Connect to Android device
        var android = playwright.Android;
        await using var device = await android.ConnectAsync(wsEndpoint);

        // Launch Chromium-based browser instance
        var context = await device.LaunchBrowserAsync();
        var page = await context.NewPageAsync();

        await page.GotoAsync("https://www.google.com/");

        // Mark session status
        var browserstackData = new {
            action = "setSessionStatus",
            arguments = new {
                status = "passed",
                reason = "Google homepage loaded"
            }
        };

        await page.EvaluateAsync(
            "(_) => {}",
            $"browserstack_executor: {JsonSerializer.Serialize(browserstackData)}"
        );

        await page.CloseAsync();
        await context.CloseAsync();
        await device.CloseAsync();
    }
}
```

Copy

This script:

Connects to a BrowserStack Android device.
Launches a browser context.
Navigates to Google.
Marks the session as passed.

Run the test

Run the given command to execute the test on BrowserStack:

Copy

The test connects to a real Android device, opens Chrome, loads Google, and ends the session.

View results in Automate dashboard

After the run:

Navigate to the BrowserStack Automate Dashboard.
Open the session named sample_android_playwright_test.
Verify device, logs, and marked status (Passed).

Did this page help you?

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

This page has exactly what I am looking for
This content & code samples are accurate and up-to-date
The content on this page is easy to understand
Other (please tell us more below)

Any additional feedback?

Thank you for your valuable feedback

Is this page helping you?

Yes

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

This page has exactly what I am looking for
This content & code samples are accurate and up-to-date
The content on this page is easy to understand
Other (please tell us more below)

Any additional feedback?

Thank you for your valuable feedback!