OneStreamAutoLibrary.PlaywrightHelpers 2026.4.12.1

PlaywrightHelpers

A helper library for Playwright-based UI automation in .NET. It provides reusable browser setup, configuration access, wait helpers, page interaction utilities, and screenshot capture for Playwright test projects.

Integration

PlaywrightHelpers is designed to be used by:

• Web and UI test projects using xUnit and Playwright
• Shared automation frameworks that need consistent browser, page, and configuration helpers
• CI pipelines that run Playwright tests with environment-variable-based configuration

Features

• Browser bootstrapping with support for Chromium, Firefox, WebKit, and Edge channel
• Centralized configuration via Config/TestExecutionConfig.json and environment variables
• Config file discovery from the current working directory or parent folders
• Base URL, browser, headless, slow motion, run mode, and BrowserStack settings accessors
• Shared Playwright base methods for waits, page state checks, frame/window switching, and interactions
• Screenshot capture with timestamped file naming and automatic screenshot directory creation

Project Structure

• Browser.cs - Creates and configures Playwright browser, context, and page instances
• PlaywrightBase.cs - Shared wait, page-state, and interaction helper methods for derived classes
• PlaywrightConfig.cs - Configuration accessors for execution settings, base URL, and remote execution values
• ScreenCaptureLibrary.cs - Screenshot capture and path management utilities

Configuration

Configuration is loaded from:

• Config/TestExecutionConfig.json
• Environment variables, which override JSON values

PlaywrightConfig resolves the config file by checking the current directory, the application base directory, and then parent folders until it finds Config/TestExecutionConfig.json.

Common TestExecutionDetails keys

• Browser
• Environment
• BaseUrl
• Headless
• SlowMo
• RunMode
• BuildName
• MaxArchiveDays
• PlaywrightConnectionUrl

Common configuration methods

• GetBrowserFromConfigFile()
• GetEnvironmentFromConfigFile()
• GetBaseUrl()
• GetHeadlessFromConfigFile()
• GetHeadlessMode()
• GetSlowMoFromConfigFile()
• GetRunMode()
• GetBuildName()
• EnvironmentInfo()
• BrowserStackCapabilities()

Sample TestExecutionConfig.json

{
  "TestExecutionDetails": {
    "Browser": "Chromium",
    "Environment": "QA",
    "BaseUrl": "https://qa.example.com",
    "Headless": "true",
    "SlowMo": "0",
    "RunMode": "Local",
    "BuildName": "Playwright Smoke Tests",
    "MaxArchiveDays": "30",
    "PlaywrightConnectionUrl": "wss://cdp.example.com/playwright"
  },
  "Environments": {
    "QA": {
      "BaseUrl": "https://qa.example.com"
    },
    "Dev": {
      "BaseUrl": "https://dev.example.com"
    }
  },
  "Users": {
    "TestUser1": {
      "Username": "test.user@example.com",
      "Password": "use-secure-secret-storage"
    }
  },
  "BrowserStack": {
    "User": "BrowserStackUser1",
    "DeviceName": "iPhone 15",
    "OperatingSystem": "Windows",
    "OSVersion": "11",
    "Orientation": "portrait"
  },
  "BrowserCapabilities": {
    "Chromium": {
      "browserName": "chromium",
      "browserVersion": "latest"
    },
    "Firefox": {
      "browserName": "firefox",
      "browserVersion": "latest"
    }
  }
}

Quick Start

using Microsoft.Playwright;
using PlaywrightHelpers;

public class ExampleTest
{
    public async Task RunAsync()
    {
        using var playwright = await Playwright.CreateAsync();
        var (browser, context, page) = await Browser.CreateBrowserAsync(playwright);

        try
        {
            await page.GotoAsync(PlaywrightConfig.GetBaseUrl());

            var capture = new ScreenCaptureLibrary(page);
            await capture.Capture("example-home");
        }
        finally
        {
            await context.CloseAsync();
            await browser.CloseAsync();
        }
    }
}

Browser Setup

Browser.CreateBrowserAsync() uses the current configuration to:

• select Chromium, Firefox, WebKit, or Edge
• apply headless mode
• apply slow motion delay
• open a maximized browser context with no fixed viewport

Base Helpers

PlaywrightBase includes reusable helpers for common automation flows, such as:

• WaitUntilElementExists()
• WaitUntilElementVisible()
• WaitUntilElementInvisible()
• WaitUntilPageLoaded()
• WaitUntilPageHasTitle()
• SwitchToFrame()
• SwitchToWindow()
• Click()
• InputText()

Screenshot Capture

ScreenCaptureLibrary captures full-page screenshots and stores them in a Screenshots folder under the solution root using a timestamped .png file name.

var capture = new ScreenCaptureLibrary(page);
await capture.Capture("login-page");

Notes

• Keep secrets such as BrowserStack credentials in environment variables or secure pipeline secrets.
• GetBaseUrl() throws an exception when BaseUrl is not configured, which helps catch invalid test setup early.
• Prefer environment-specific values in Config/TestExecutionConfig.json for predictable local and CI behavior.