File: tests\Shared\Playwright\PlaywrightProvider.cs
Web Access
Project: src\tests\Aspire.Dashboard.Tests\Aspire.Dashboard.Tests.csproj (Aspire.Dashboard.Tests)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
using Microsoft.Playwright;
 
namespace Aspire.Workload.Tests;
 
public class PlaywrightProvider
{
    public const string BrowserPathEnvironmentVariableName = "BROWSER_PATH";
    private const string PlaywrightBrowsersPathEnvironmentVariableName = "PLAYWRIGHT_BROWSERS_PATH";
 
    public static bool DoesNotHavePlaywrightSupport => Environment.GetEnvironmentVariable("DISABLE_PLAYWRIGHT_TESTS")?.ToLowerInvariant() is "true";
    public static bool HasPlaywrightSupport => !DoesNotHavePlaywrightSupport;
 
    public static async Task<IBrowser> CreateBrowserAsync(BrowserTypeLaunchOptions? options = null)
    {
        var playwright = await Playwright.CreateAsync();
        string? browserPath = Environment.GetEnvironmentVariable(BrowserPathEnvironmentVariableName);
        if (!string.IsNullOrEmpty(browserPath) && !File.Exists(browserPath))
        {
            throw new FileNotFoundException($"Browser path {BrowserPathEnvironmentVariableName}='{browserPath}' does not exist");
        }
 
        options ??= new() { Headless = true };
        options.ExecutablePath ??= browserPath;
 
        if (OperatingSystem.IsMacOS() && string.IsNullOrEmpty(browserPath))
        {
            var probePath = "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome";
            if (File.Exists(probePath))
            {
                options.ExecutablePath = probePath;
            }
        }
        return await playwright.Chromium.LaunchAsync(options).ConfigureAwait(false);
    }
 
    // Tries to set PLAYWRIGHT_BROWSERS_PATH to the location of the playwright-deps directory in the repo
    public static void DetectAndSetInstalledPlaywrightDependenciesPath(DirectoryInfo? repoRoot = null)
    {
        if (!string.IsNullOrEmpty(Environment.GetEnvironmentVariable(PlaywrightBrowsersPathEnvironmentVariableName)))
        {
            // this would be the case for helix where the path is set to a
            // payload directory
            return;
        }
 
        repoRoot ??= TestUtils.FindRepoRoot();
        if (repoRoot is not null)
        {
            // Running from inside the repo
 
            // Check if we already have playwright-deps in artifacts
            var probePath = Path.Combine(repoRoot.FullName, "artifacts", "bin", "playwright-deps");
            if (Directory.Exists(probePath))
            {
                Environment.SetEnvironmentVariable(PlaywrightBrowsersPathEnvironmentVariableName, probePath);
                Console.WriteLine($"** Found playwright dependencies in {probePath}");
            }
        }
    }
}