feat: Add possibility to load Playwright settings programmatically

As an alternative to using a .runsettings XML file. Fixes #3081
microsoft · Dec 8, 2024 · 595abc1 · 595abc1
1 parent df59854
commit 595abc1
Show file tree

Hide file tree

Showing 6 changed files with 84 additions and 10 deletions.
diff --git a/src/Playwright.MSTest/WorkerAwareTest.cs b/src/Playwright.MSTest/WorkerAwareTest.cs
@@ -34,9 +34,26 @@ public async Task<T> RegisterService<T>(string name, Func<Task<T>> factory) wher
         return (_currentWorker.Services[name] as T)!;
     }
 
+    protected virtual PlaywrightSettings? PlaywrightSettings()
+    {
+        return null;
+    }
+
+    private void LoadPlaywrightSettings()
+    {
+        var settings = PlaywrightSettings();
+        if (settings != null)
+        {
+            PlaywrightSettingsProvider.Load(settings);
+        }
+    }
+
     [TestInitialize]
     public void WorkerSetup()
     {
+        // Must be run before accessing any static PlaywrightSettingsProvider.* properties
+        LoadPlaywrightSettings();
+
         if (PlaywrightSettingsProvider.ExpectTimeout.HasValue)
         {
             AssertionsBase.SetDefaultTimeout(PlaywrightSettingsProvider.ExpectTimeout.Value);

diff --git a/src/Playwright.NUnit/WorkerAwareTest.cs b/src/Playwright.NUnit/WorkerAwareTest.cs
@@ -58,6 +58,20 @@ public async Task<T> RegisterService<T>(string name, Func<Task<T>> factory) wher
         return (_currentWorker.Services[name] as T)!;
     }
 
+    protected virtual PlaywrightSettings? PlaywrightSettings()
+    {
+        return null;
+    }
+
+    private void LoadPlaywrightSettings()
+    {
+        var settings = PlaywrightSettings();
+        if (settings != null)
+        {
+            PlaywrightSettingsProvider.Load(settings);
+        }
+    }
+
     [SetUp]
     public void WorkerSetup()
     {
@@ -66,6 +80,10 @@ public void WorkerSetup()
             _currentWorker = new();
         }
         WorkerIndex = _currentWorker.WorkerIndex;
+
+        // Must be run before accessing any static PlaywrightSettingsProvider.* properties
+        LoadPlaywrightSettings();
+
         if (PlaywrightSettingsProvider.ExpectTimeout.HasValue)
         {
             AssertionsBase.SetDefaultTimeout(PlaywrightSettingsProvider.ExpectTimeout.Value);

diff --git a/src/Playwright.TestAdapter/PlaywrightBrowser.cs b/src/Playwright.TestAdapter/PlaywrightBrowser.cs
@@ -0,0 +1,8 @@
+namespace Microsoft.Playwright.TestAdapter;
+
+public enum PlaywrightBrowser
+{
+    Chromium,
+    Firefox,
+    Webkit,
+}
diff --git a/src/Playwright.TestAdapter/PlaywrightSettings.cs b/src/Playwright.TestAdapter/PlaywrightSettings.cs
@@ -0,0 +1,10 @@
+using System;
+
+namespace Microsoft.Playwright.TestAdapter;
+
+public class PlaywrightSettings
+{
+    public PlaywrightBrowser Browser { get; set; } = PlaywrightBrowser.Chromium;
+    public BrowserTypeLaunchOptions? LaunchOptions { get; set; }
+    public TimeSpan? ExpectTimeout { get; set; }
+}
diff --git a/src/Playwright.TestAdapter/PlaywrightSettingsProvider.cs b/src/Playwright.TestAdapter/PlaywrightSettingsProvider.cs
@@ -34,11 +34,18 @@ namespace Microsoft.Playwright.TestAdapter;
 public class PlaywrightSettingsProvider : ISettingsProvider
 {
     private static PlaywrightSettingsXml? _settings = null!;
+    private static PlaywrightSettings? _playwrightSettings;
 
     public static string BrowserName
     {
         get
         {
+            if (_playwrightSettings != null)
+            {
+                var browser = _playwrightSettings.Browser.ToString().ToLowerInvariant();
+                ValidateBrowserName(browser, "PlaywrightSettings.Browser property", string.Empty);
+                return browser;
+            }
             var browserFromEnv = Environment.GetEnvironmentVariable("BROWSER")?.ToLowerInvariant();
             // GitHub Codespaces sets the BROWSER environment variable, ignore it if its bogus.
             var ignoreValueFromEnv = Environment.GetEnvironmentVariable("CODESPACES") == "true" && browserFromEnv!.StartsWith("/vscode/");
@@ -61,23 +68,16 @@ public static float? ExpectTimeout
     {
         get
         {
-            if (_settings == null)
-            {
-                return null;
-            }
-            if (_settings.ExpectTimeout.HasValue)
-            {
-                return _settings.ExpectTimeout.Value;
-            }
-            return null;
+            var expectTimeout = _playwrightSettings?.ExpectTimeout?.TotalMilliseconds;
+            return expectTimeout.HasValue ? Convert.ToSingle(expectTimeout.Value) : _settings?.ExpectTimeout;
         }
     }
 
     public static BrowserTypeLaunchOptions LaunchOptions
     {
         get
         {
-            var launchOptions = _settings?.LaunchOptions ?? new BrowserTypeLaunchOptions();
+            var launchOptions = _playwrightSettings?.LaunchOptions ?? _settings?.LaunchOptions ?? new BrowserTypeLaunchOptions();
             if (Environment.GetEnvironmentVariable("HEADED") == "1")
             {
                 launchOptions.Headless = false;
@@ -104,4 +104,7 @@ private static void ValidateBrowserName(string browserName, string fromText, str
 
     public void Load(XmlReader reader)
         => _settings = new PlaywrightSettingsXml(reader);
+
+    public static void Load(PlaywrightSettings settings)
+        => _playwrightSettings = settings;
 }
diff --git a/src/Playwright.Xunit/WorkerAwareTest.cs b/src/Playwright.Xunit/WorkerAwareTest.cs
@@ -57,6 +57,20 @@ public async Task<T> RegisterService<T>(string name, Func<Task<T>> factory) wher
         return (_currentWorker.Services[name] as T)!;
     }
 
+    protected virtual PlaywrightSettings? PlaywrightSettings()
+    {
+        return null;
+    }
+
+    private void LoadPlaywrightSettings()
+    {
+        var settings = PlaywrightSettings();
+        if (settings != null)
+        {
+            PlaywrightSettingsProvider.Load(settings);
+        }
+    }
+
     async public override Task InitializeAsync()
     {
         await base.InitializeAsync().ConfigureAwait(false);
@@ -65,6 +79,10 @@ async public override Task InitializeAsync()
             _currentWorker = new();
         }
         WorkerIndex = _currentWorker.WorkerIndex;
+
+        // Must be run before accessing any static PlaywrightSettingsProvider.* properties
+        LoadPlaywrightSettings();
+
         if (PlaywrightSettingsProvider.ExpectTimeout.HasValue)
         {
             AssertionsBase.SetDefaultTimeout(PlaywrightSettingsProvider.ExpectTimeout.Value);