[tests] Some Playwright related fixes (dotnet#4726)

radical · web-flow · commit 7166a5e399bb · 2024-07-02T15:18:59.000-04:00
* [tests] Move HasPlaywrightSupport to PlaywrightProvider class

* Fix condition disabling playwright based tests
diff --git a/tests/Aspire.Workload.Tests/EmptyTemplateRunTests.cs b/tests/Aspire.Workload.Tests/EmptyTemplateRunTests.cs
@@ -17,7 +17,7 @@ public EmptyTemplateRunTests(EmptyTemplateRunFixture fixture, ITestOutputHelper
     }
 
     [Fact]
-    [ActiveIssue("https://github.com/dotnet/aspire/issues/4623", typeof(BuildEnvironment), nameof(BuildEnvironment.HasPlaywrightSupport))]
+    [ActiveIssue("https://github.com/dotnet/aspire/issues/4623", typeof(PlaywrightProvider), nameof(PlaywrightProvider.DoesNotHavePlaywrightSupport))]
     public async Task ResourcesShowUpOnDashboad()
     {
         await using var context = await CreateNewBrowserContextAsync();
diff --git a/tests/Aspire.Workload.Tests/PerTestFrameworkTemplatesTests.cs b/tests/Aspire.Workload.Tests/PerTestFrameworkTemplatesTests.cs
@@ -50,7 +50,7 @@ public async Task TemplatesForIndividualTestFrameworks(string prefix)
             buildEnvironment: BuildEnvironment.ForDefaultFramework);
 
         await project.BuildAsync(extraBuildArgs: [$"-c {config}"]).ConfigureAwait(false);
-        if (BuildEnvironment.HasPlaywrightSupport)
+        if (PlaywrightProvider.HasPlaywrightSupport)
         {
             await using (var context = await CreateNewBrowserContextAsync())
             {
diff --git a/tests/Aspire.Workload.Tests/StarterTemplateProjectNamesTests.cs b/tests/Aspire.Workload.Tests/StarterTemplateProjectNamesTests.cs
@@ -40,7 +40,7 @@ public async Task StarterTemplateWithTest_ProjectNames(string prefix, string tes
             BuildEnvironment.ForDefaultFramework,
             $"-t {testType}").ConfigureAwait(false);
 
-        await using var context = BuildEnvironment.HasPlaywrightSupport ? await CreateNewBrowserContextAsync() : null;
+        await using var context = PlaywrightProvider.HasPlaywrightSupport ? await CreateNewBrowserContextAsync() : null;
         _testOutput.WriteLine($"Checking the starter template project");
         await AssertStarterTemplateRunAsync(context, project, config, _testOutput).ConfigureAwait(false);
 
diff --git a/tests/Aspire.Workload.Tests/StarterTemplateRunTestsBase.cs b/tests/Aspire.Workload.Tests/StarterTemplateRunTestsBase.cs
@@ -22,7 +22,7 @@ public StarterTemplateRunTestsBase(T fixture, ITestOutputHelper testOutput)
     }
 
     [Fact]
-    [ActiveIssue("https://github.com/dotnet/aspire/issues/4623", typeof(BuildEnvironment), nameof(BuildEnvironment.HasPlaywrightSupport))]
+    [ActiveIssue("https://github.com/dotnet/aspire/issues/4623", typeof(PlaywrightProvider), nameof(PlaywrightProvider.DoesNotHavePlaywrightSupport))]
     public async Task ResourcesShowUpOnDashboad()
     {
         await using var context = await CreateNewBrowserContextAsync();
@@ -35,7 +35,7 @@ await CheckDashboardHasResourcesAsync(
     [Theory]
     [InlineData("http://")]
     [InlineData("https://")]
-    [ActiveIssue("https://github.com/dotnet/aspire/issues/4623", typeof(BuildEnvironment), nameof(BuildEnvironment.HasPlaywrightSupport))]
+    [ActiveIssue("https://github.com/dotnet/aspire/issues/4623", typeof(PlaywrightProvider), nameof(PlaywrightProvider.DoesNotHavePlaywrightSupport))]
     public async Task WebFrontendWorks(string urlPrefix)
     {
         await using var context = await CreateNewBrowserContextAsync();
diff --git a/tests/Aspire.Workload.Tests/TemplateTests.cs b/tests/Aspire.Workload.Tests/TemplateTests.cs
@@ -50,7 +50,7 @@ public async Task BuildAndRunAspireTemplate(string config)
         await project.BuildAsync(extraBuildArgs: [$"-c {config}"]);
         await project.StartAppHostAsync(extraArgs: [$"-c {config}"]);
 
-        if (BuildEnvironment.HasPlaywrightSupport)
+        if (PlaywrightProvider.HasPlaywrightSupport)
         {
             await using var context = await CreateNewBrowserContextAsync();
             var page = await project.OpenDashboardPageAsync(context);
@@ -70,7 +70,7 @@ public async Task StarterTemplateNewAndRunWithoutExplicitBuild(string config)
             _testOutput,
             buildEnvironment: BuildEnvironment.ForDefaultFramework);
 
-        await using var context = BuildEnvironment.HasPlaywrightSupport ? await CreateNewBrowserContextAsync() : null;
+        await using var context = PlaywrightProvider.HasPlaywrightSupport ? await CreateNewBrowserContextAsync() : null;
         await AssertStarterTemplateRunAsync(context, project, config, _testOutput);
     }
 
@@ -100,7 +100,7 @@ public async Task ProjectWithNoHTTPSRequiresExplicitOverrideWithEnvironmentVaria
         testSpecificBuildEnvironment.EnvVars["ASPIRE_ALLOW_UNSECURED_TRANSPORT"] = "true";
         await project.StartAppHostAsync();
 
-        if (BuildEnvironment.HasPlaywrightSupport)
+        if (PlaywrightProvider.HasPlaywrightSupport)
         {
             await using var context = await CreateNewBrowserContextAsync();
             var page = await project.OpenDashboardPageAsync(context);
diff --git a/tests/Aspire.Workload.Tests/WorkloadTestsBase.cs b/tests/Aspire.Workload.Tests/WorkloadTestsBase.cs
@@ -34,7 +34,7 @@ private static IBrowser CreateBrowser()
     }
 
     public static Task<IBrowserContext> CreateNewBrowserContextAsync()
-        => BuildEnvironment.HasPlaywrightSupport
+        => PlaywrightProvider.HasPlaywrightSupport
                 ? Browser.Value.NewContextAsync(new BrowserNewContextOptions { IgnoreHTTPSErrors = true })
                 : throw new InvalidOperationException("Playwright is not available");
 
diff --git a/tests/Shared/Playwright/PlaywrightProvider.cs b/tests/Shared/Playwright/PlaywrightProvider.cs
@@ -11,6 +11,9 @@ 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") is "true";
+    public static bool HasPlaywrightSupport => !DoesNotHavePlaywrightSupport;
+
     public static async Task<IBrowser> CreateBrowserAsync(BrowserTypeLaunchOptions? options = null)
     {
         var playwright = await Playwright.CreateAsync();
diff --git a/tests/Shared/WorkloadTesting/BuildEnvironment.cs b/tests/Shared/WorkloadTesting/BuildEnvironment.cs
@@ -25,7 +25,6 @@ public class BuildEnvironment
     public const TestTargetFramework        DefaultTargetFramework = TestTargetFramework.Net80;
     public static readonly string           TestDataPath = Path.Combine(AppContext.BaseDirectory, "data");
     public static readonly string           TestRootPath = Path.Combine(Path.GetTempPath(), "testroot");
-    public static bool                      HasPlaywrightSupport => !EnvironmentVariables.DisablePlaywrightTests;
 
     public static bool IsRunningOnHelix => Environment.GetEnvironmentVariable("HELIX_WORKITEM_ROOT") is not null;
     public static bool IsRunningOnCIBuildMachine => Environment.GetEnvironmentVariable("BUILD_BUILDID") is not null;
diff --git a/tests/Shared/WorkloadTesting/EnvironmentVariables.cs b/tests/Shared/WorkloadTesting/EnvironmentVariables.cs
@@ -17,5 +17,4 @@ public static class EnvironmentVariables
     public static readonly string? TestAssetsPath            = Environment.GetEnvironmentVariable("TEST_ASSETS_PATH");
     public static readonly string? TestScenario              = Environment.GetEnvironmentVariable("TEST_SCENARIO");
     public static readonly string? BrowserPath               = Environment.GetEnvironmentVariable(PlaywrightProvider.BrowserPathEnvironmentVariableName);
-    public static readonly bool    DisablePlaywrightTests    = Environment.GetEnvironmentVariable("DISABLE_PLAYWRIGHT_TESTS") is "true";
 }

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ public EmptyTemplateRunTests(EmptyTemplateRunFixture fixture, ITestOutputHelper`
`17`	`17`	`}`
`18`	`18`
`19`	`19`	`[Fact]`
`20`		`- [ActiveIssue("https://github.com/dotnet/aspire/issues/4623", typeof(BuildEnvironment), nameof(BuildEnvironment.HasPlaywrightSupport))]`
	`20`	`+ [ActiveIssue("https://github.com/dotnet/aspire/issues/4623", typeof(PlaywrightProvider), nameof(PlaywrightProvider.DoesNotHavePlaywrightSupport))]`
`21`	`21`	`public async Task ResourcesShowUpOnDashboad()`
`22`	`22`	`{`
`23`	`23`	`await using var context = await CreateNewBrowserContextAsync();`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ public async Task TemplatesForIndividualTestFrameworks(string prefix)`
`50`	`50`	`buildEnvironment: BuildEnvironment.ForDefaultFramework);`
`51`	`51`
`52`	`52`	`await project.BuildAsync(extraBuildArgs: [$"-c {config}"]).ConfigureAwait(false);`
`53`		`- if (BuildEnvironment.HasPlaywrightSupport)`
	`53`	`+ if (PlaywrightProvider.HasPlaywrightSupport)`
`54`	`54`	`{`
`55`	`55`	`await using (var context = await CreateNewBrowserContextAsync())`
`56`	`56`	`{`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ public StarterTemplateRunTestsBase(T fixture, ITestOutputHelper testOutput)`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`[Fact]`
`25`		`- [ActiveIssue("https://github.com/dotnet/aspire/issues/4623", typeof(BuildEnvironment), nameof(BuildEnvironment.HasPlaywrightSupport))]`
	`25`	`+ [ActiveIssue("https://github.com/dotnet/aspire/issues/4623", typeof(PlaywrightProvider), nameof(PlaywrightProvider.DoesNotHavePlaywrightSupport))]`
`26`	`26`	`public async Task ResourcesShowUpOnDashboad()`
`27`	`27`	`{`
`28`	`28`	`await using var context = await CreateNewBrowserContextAsync();`
`@@ -35,7 +35,7 @@ await CheckDashboardHasResourcesAsync(`
`35`	`35`	`[Theory]`
`36`	`36`	`[InlineData("http://")]`
`37`	`37`	`[InlineData("https://")]`
`38`		`- [ActiveIssue("https://github.com/dotnet/aspire/issues/4623", typeof(BuildEnvironment), nameof(BuildEnvironment.HasPlaywrightSupport))]`
	`38`	`+ [ActiveIssue("https://github.com/dotnet/aspire/issues/4623", typeof(PlaywrightProvider), nameof(PlaywrightProvider.DoesNotHavePlaywrightSupport))]`
`39`	`39`	`public async Task WebFrontendWorks(string urlPrefix)`
`40`	`40`	`{`
`41`	`41`	`await using var context = await CreateNewBrowserContextAsync();`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ private static IBrowser CreateBrowser()`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`public static Task<IBrowserContext> CreateNewBrowserContextAsync()`
`37`		`- => BuildEnvironment.HasPlaywrightSupport`
	`37`	`+ => PlaywrightProvider.HasPlaywrightSupport`
`38`	`38`	`? Browser.Value.NewContextAsync(new BrowserNewContextOptions { IgnoreHTTPSErrors = true })`
`39`	`39`	`: throw new InvalidOperationException("Playwright is not available");`
`40`	`40`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,9 @@ public class PlaywrightProvider`
`11`	`11`	`public const string BrowserPathEnvironmentVariableName = "BROWSER_PATH";`
`12`	`12`	`private const string PlaywrightBrowsersPathEnvironmentVariableName = "PLAYWRIGHT_BROWSERS_PATH";`
`13`	`13`
	`14`	`+ public static bool DoesNotHavePlaywrightSupport => Environment.GetEnvironmentVariable("DISABLE_PLAYWRIGHT_TESTS") is "true";`
	`15`	`+ public static bool HasPlaywrightSupport => !DoesNotHavePlaywrightSupport;`
	`16`	`+`
`14`	`17`	`public static async Task<IBrowser> CreateBrowserAsync(BrowserTypeLaunchOptions? options = null)`
`15`	`18`	`{`
`16`	`19`	`var playwright = await Playwright.CreateAsync();`
Original file line number	Diff line number	Diff line change
`@@ -17,5 +17,4 @@ public static class EnvironmentVariables`
`17`	`17`	`public static readonly string? TestAssetsPath = Environment.GetEnvironmentVariable("TEST_ASSETS_PATH");`
`18`	`18`	`public static readonly string? TestScenario = Environment.GetEnvironmentVariable("TEST_SCENARIO");`
`19`	`19`	`public static readonly string? BrowserPath = Environment.GetEnvironmentVariable(PlaywrightProvider.BrowserPathEnvironmentVariableName);`
`20`		`- public static readonly bool DisablePlaywrightTests = Environment.GetEnvironmentVariable("DISABLE_PLAYWRIGHT_TESTS") is "true";`
`21`	`20`	`}`