Skip to content

Logging tweaks for playwright #30703

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 30 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
43a5233
Update BlazorTemplateTest.cs
HaoK Mar 5, 2021
bbb165c
Update BlazorWasmTemplateTest.cs
HaoK Mar 5, 2021
55039a8
Use LoggedTest test sink
HaoK Mar 6, 2021
37d8771
Update BlazorTemplateTest.cs
HaoK Mar 6, 2021
8372ff8
Update BlazorTemplateTest.cs
HaoK Mar 6, 2021
757e1c8
Update BlazorServerTemplateTest.cs
HaoK Mar 6, 2021
9b6ba32
Update BlazorWasmTemplateTest.cs
HaoK Mar 6, 2021
a1359cf
Update BlazorServerTemplateTest.cs
HaoK Mar 6, 2021
0aa4b87
Update BlazorWasmTemplateTest.cs
HaoK Mar 6, 2021
8b0f5f7
Update BlazorTemplateTest.cs
HaoK Mar 6, 2021
e09d732
Update BlazorTemplateTest.cs
HaoK Mar 7, 2021
c8bdbb4
Update BlazorTemplateTest.cs
HaoK Mar 8, 2021
3ebf27f
Update playwrightSettings.json
HaoK Mar 8, 2021
144425c
Update playwrightSettings.json
HaoK Mar 8, 2021
a7cbf05
Update BrowserManager.cs
HaoK Mar 8, 2021
6010cfa
Add serilogger file stuff
HaoK Mar 9, 2021
d737a29
Update BlazorServerTemplateTest.cs
HaoK Mar 10, 2021
0ab67b0
Update BlazorWasmTemplateTest.cs
HaoK Mar 10, 2021
5dc34c0
Update BlazorServerTemplateTest.cs
HaoK Mar 10, 2021
ac6f0ed
Update BlazorWasmTemplateTest.cs
HaoK Mar 10, 2021
650157e
Update BlazorServerTemplateTest.cs
HaoK Mar 10, 2021
267f9a3
Update BlazorWasmTemplateTest.cs
HaoK Mar 10, 2021
2e23697
Merge branch 'haok/pwlog' of https://github.com/dotnet/aspnetcore int…
HaoK Mar 10, 2021
f2c8969
Update BlazorServerTemplateTest.cs
HaoK Mar 10, 2021
227d41a
Update BlazorWasmTemplateTest.cs
HaoK Mar 10, 2021
4637aab
Merge branch 'haok/pwlog' of https://github.com/dotnet/aspnetcore int…
HaoK Mar 11, 2021
7be15d5
Try writing logs to a file
HaoK Mar 11, 2021
1c55266
Try turning pw logging to warning for now
HaoK Mar 11, 2021
aae6eec
Update TestRunner.cs
HaoK Mar 11, 2021
a7287b3
Update TestRunner.cs
HaoK Mar 12, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions eng/Dependencies.props
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,7 @@ and are generated based on the last package release.
<LatestPackageReference Include="Selenium.WebDriver" />
<LatestPackageReference Include="Selenium.WebDriver.ChromeDriver" />
<LatestPackageReference Include="Serilog.Extensions.Logging" />
<LatestPackageReference Include="Serilog.Extensions.Logging.File" />
<LatestPackageReference Include="Serilog.Sinks.File" />
<LatestPackageReference Include="StackExchange.Redis" />
<LatestPackageReference Include="System.Reactive.Linq" />
Expand Down
1 change: 1 addition & 0 deletions eng/Versions.props
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,7 @@
<SeleniumWebDriverChromeDriverVersion>89.0.4389.2300-beta</SeleniumWebDriverChromeDriverVersion>
<SeleniumWebDriverVersion>4.0.0-beta1</SeleniumWebDriverVersion>
<SerilogExtensionsLoggingVersion>1.4.0</SerilogExtensionsLoggingVersion>
<SerilogExtensionsLoggingFileVersion>2.0.0</SerilogExtensionsLoggingFileVersion>
<SerilogSinksFileVersion>4.0.0</SerilogSinksFileVersion>
<StackExchangeRedisVersion>2.0.593</StackExchangeRedisVersion>
<SystemReactiveLinqVersion>3.1.1</SystemReactiveLinqVersion>
Expand Down
3 changes: 3 additions & 0 deletions eng/helix/content/RunTests/TestRunner.cs
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,9 @@ public bool SetupEnvironment()
var playwrightBrowsers = Path.Combine(helixDir, "ms-playwright");
Console.WriteLine($"Setting PLAYWRIGHT_BROWSERS_PATH: {playwrightBrowsers}");
EnvironmentVariables.Add("PLAYWRIGHT_BROWSERS_PATH", playwrightBrowsers);

Console.WriteLine($"Setting playwright console logging to warning: Logging__Console__LogLevel__PlaywrightSharp = Warning");
EnvironmentVariables.Add("Logging__Console__LogLevel__PlaywrightSharp", "Warning");
#endif

Console.WriteLine($"Creating nuget restore directory: {nugetRestore}");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
using System.Threading.Tasks;
using Microsoft.AspNetCore.BrowserTesting;
using Microsoft.AspNetCore.Testing;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Logging.Testing;
using PlaywrightSharp;
using ProjectTemplates.Tests.Infrastructure;
using Templates.Test.Helpers;
Expand All @@ -17,19 +19,16 @@

namespace Templates.Test
{
[LogLevel(LogLevel.Debug)]
public class BlazorServerTemplateTest : BlazorTemplateTest
{
public BlazorServerTemplateTest(ProjectFactoryFixture projectFactory, PlaywrightFixture<BlazorServerTemplateTest> fixture, ITestOutputHelper output)
public BlazorServerTemplateTest(ProjectFactoryFixture projectFactory, PlaywrightFixture<BlazorServerTemplateTest> fixture)
: base(fixture)
{
ProjectFactory = projectFactory; ;
Output = output;
BrowserContextInfo = new ContextInformation(CreateFactory(output));
}

public ProjectFactoryFixture ProjectFactory { get; set; }
public ITestOutputHelper Output { get; }
public ContextInformation BrowserContextInfo { get; }
public Project Project { get; private set; }


Expand All @@ -40,7 +39,7 @@ public async Task BlazorServerTemplateWorks_NoAuth(BrowserKind browserKind)
// Additional arguments are needed. See: https://github.com/dotnet/aspnetcore/issues/24278
Environment.SetEnvironmentVariable("EnableDefaultScopedCssItems", "true");

Project = await ProjectFactory.GetOrCreateProject("blazorservernoauth" + browserKind.ToString(), Output);
Project = await ProjectFactory.GetOrCreateProject("blazorservernoauth" + browserKind.ToString(), TestOutputHelper );

var createResult = await Project.RunDotNetNewAsync("blazorserver");
Assert.True(0 == createResult.ExitCode, ErrorMessages.GetFailedProcessMessage("create/restore", Project, createResult));
Expand Down Expand Up @@ -111,7 +110,7 @@ public async Task BlazorServerTemplateWorks_IndividualAuth(BrowserKind browserKi
// Additional arguments are needed. See: https://github.com/dotnet/aspnetcore/issues/24278
Environment.SetEnvironmentVariable("EnableDefaultScopedCssItems", "true");

Project = await ProjectFactory.GetOrCreateProject("blazorserverindividual" + browserKind + (useLocalDB ? "uld" : ""), Output);
Project = await ProjectFactory.GetOrCreateProject("blazorserverindividual" + browserKind + (useLocalDB ? "uld" : ""), TestOutputHelper );

var createResult = await Project.RunDotNetNewAsync("blazorserver", auth: "Individual", useLocalDB: useLocalDB);
Assert.True(0 == createResult.ExitCode, ErrorMessages.GetFailedProcessMessage("create/restore", Project, createResult));
Expand Down Expand Up @@ -216,7 +215,7 @@ private async Task TestBasicNavigation(IPage page)
[InlineData("SingleOrg", new string[] { "--calls-graph" })]
public async Task BlazorServerTemplat_IdentityWeb_BuildAndPublish(string auth, string[] args)
{
Project = await ProjectFactory.GetOrCreateProject("blazorserveridweb" + Guid.NewGuid().ToString().Substring(0, 10).ToLowerInvariant(), Output);
Project = await ProjectFactory.GetOrCreateProject("blazorserveridweb" + Guid.NewGuid().ToString().Substring(0, 10).ToLowerInvariant(), TestOutputHelper );

var createResult = await Project.RunDotNetNewAsync("blazorserver", auth: auth, args: args);
Assert.True(0 == createResult.ExitCode, ErrorMessages.GetFailedProcessMessage("create/restore", Project, createResult));
Expand Down
18 changes: 10 additions & 8 deletions src/ProjectTemplates/BlazorTemplates.Tests/BlazorTemplateTest.cs
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.

using System.Reflection;
using System.Runtime.InteropServices;
using Microsoft.AspNetCore.BrowserTesting;
using Microsoft.AspNetCore.Testing;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Logging.Testing;
using ProjectTemplates.Tests.Infrastructure;
Expand All @@ -11,26 +13,26 @@

namespace Templates.Test
{
public class BlazorTemplateTest
public class BlazorTemplateTest : LoggedTest
{
public BlazorTemplateTest(PlaywrightFixture<BlazorServerTemplateTest> browserFixture)
{
Fixture = browserFixture;
}

public PlaywrightFixture<BlazorServerTemplateTest> Fixture { get; }
public ContextInformation BrowserContextInfo { get; private set; }


public static ILoggerFactory CreateFactory(ITestOutputHelper output)
public override void Initialize(TestContext context, MethodInfo methodInfo, object[] testMethodArguments, ITestOutputHelper testOutputHelper)
{
var testSink = new TestSink();
testSink.MessageLogged += LogMessage;
var loggerFactory = new TestLoggerFactory(testSink, enabled: true);
return loggerFactory;
base.Initialize(context, methodInfo, testMethodArguments, testOutputHelper);

TestSink.MessageLogged += LogMessage;
BrowserContextInfo = new ContextInformation(LoggerFactory);

void LogMessage(WriteContext ctx)
{
output.WriteLine($"{MapLogLevel(ctx)}: [Browser]{ctx.Message}");
testOutputHelper.WriteLine($"{MapLogLevel(ctx)}: [Browser]{ctx.Message}");

static string MapLogLevel(WriteContext obj) => obj.LogLevel switch
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
<Reference Include="Microsoft.Extensions.Configuration" />
<Reference Include="Microsoft.Extensions.Configuration.Json" />
<Reference Include="Anglesharp" />
<Reference Include="Serilog.Extensions.Logging.File" />
<ProjectReference Include="$(RepoRoot)src\Framework\App.Runtime\src\Microsoft.AspNetCore.App.Runtime.csproj">
<ReferenceOutputAssembly>false</ReferenceOutputAssembly>
<SkipGetTargetFrameworkProperties>true</SkipGetTargetFrameworkProperties>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
using Microsoft.AspNetCore.Internal;
using Microsoft.AspNetCore.Testing;
using Microsoft.Extensions.CommandLineUtils;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Logging.Testing;
using Newtonsoft.Json.Linq;
using PlaywrightSharp;
using ProjectTemplates.Tests.Infrastructure;
Expand All @@ -24,30 +26,25 @@

namespace Templates.Test
{
[LogLevel(LogLevel.Debug)]
public class BlazorWasmTemplateTest : BlazorTemplateTest
{
public BlazorWasmTemplateTest(ProjectFactoryFixture projectFactory, PlaywrightFixture<BlazorServerTemplateTest> browserFixture, ITestOutputHelper output)
public BlazorWasmTemplateTest(ProjectFactoryFixture projectFactory, PlaywrightFixture<BlazorServerTemplateTest> browserFixture)
: base(browserFixture)
{
ProjectFactory = projectFactory;
Output = output;
BrowserContextInfo = new ContextInformation(CreateFactory(output));
}

public ProjectFactoryFixture ProjectFactory { get; set; }

public ITestOutputHelper Output { get; }

public ContextInformation BrowserContextInfo { get; }

[Theory]
[InlineData(BrowserKind.Chromium)]
public async Task BlazorWasmStandaloneTemplate_Works(BrowserKind browserKind)
{
// Additional arguments are needed. See: https://github.com/dotnet/aspnetcore/issues/24278
Environment.SetEnvironmentVariable("EnableDefaultScopedCssItems", "true");

var project = await ProjectFactory.GetOrCreateProject("blazorstandalone" + browserKind, Output);
var project = await ProjectFactory.GetOrCreateProject("blazorstandalone" + browserKind, TestOutputHelper);

var createResult = await project.RunDotNetNewAsync("blazorwasm");
Assert.True(0 == createResult.ExitCode, ErrorMessages.GetFailedProcessMessage("create/restore", project, createResult));
Expand All @@ -67,7 +64,7 @@ public async Task BlazorWasmStandaloneTemplate_Works(BrowserKind browserKind)
var (serveProcess, listeningUri) = RunPublishedStandaloneBlazorProject(project);
using (serveProcess)
{
Output.WriteLine($"Opening browser at {listeningUri}...");
TestOutputHelper.WriteLine($"Opening browser at {listeningUri}...");
if (Fixture.BrowserManager.IsAvailable(browserKind))
{
await using var browser = await Fixture.BrowserManager.GetBrowserInstance(browserKind, BrowserContextInfo);
Expand All @@ -79,6 +76,8 @@ public async Task BlazorWasmStandaloneTemplate_Works(BrowserKind browserKind)
EnsureBrowserAvailable(browserKind);
}
}

Assert.True(0 == 1);
}

private async Task<IPage> NavigateToPage(IBrowserContext browser, string listeningUri)
Expand All @@ -95,7 +94,7 @@ public async Task BlazorWasmHostedTemplate_Works(BrowserKind browserKind)
// Additional arguments are needed. See: https://github.com/dotnet/aspnetcore/issues/24278
Environment.SetEnvironmentVariable("EnableDefaultScopedCssItems", "true");

var project = await ProjectFactory.GetOrCreateProject("blazorhosted" + browserKind, Output);
var project = await ProjectFactory.GetOrCreateProject("blazorhosted" + browserKind, TestOutputHelper);
var createResult = await project.RunDotNetNewAsync("blazorwasm", args: new[] { "--hosted" });
Assert.True(0 == createResult.ExitCode, ErrorMessages.GetFailedProcessMessage("create/restore", project, createResult));

Expand Down Expand Up @@ -154,7 +153,7 @@ public async Task BlazorWasmStandalonePwaTemplate_Works(BrowserKind browserKind)
// Additional arguments are needed. See: https://github.com/dotnet/aspnetcore/issues/24278
Environment.SetEnvironmentVariable("EnableDefaultScopedCssItems", "true");

var project = await ProjectFactory.GetOrCreateProject("blazorstandalonepwa", Output);
var project = await ProjectFactory.GetOrCreateProject("blazorstandalonepwa", TestOutputHelper);

var createResult = await project.RunDotNetNewAsync("blazorwasm", args: new[] { "--pwa" });
Assert.True(0 == createResult.ExitCode, ErrorMessages.GetFailedProcessMessage("create/restore", project, createResult));
Expand All @@ -173,7 +172,7 @@ public async Task BlazorWasmStandalonePwaTemplate_Works(BrowserKind browserKind)
{
var (serveProcess, listeningUri) = RunPublishedStandaloneBlazorProject(project);
await using var browser = await Fixture.BrowserManager.GetBrowserInstance(browserKind, BrowserContextInfo);
Output.WriteLine($"Opening browser at {listeningUri}...");
TestOutputHelper.WriteLine($"Opening browser at {listeningUri}...");
var page = await NavigateToPage(browser, listeningUri);
using (serveProcess)
{
Expand Down Expand Up @@ -201,7 +200,7 @@ public async Task BlazorWasmHostedPwaTemplate_Works(BrowserKind browserKind)
// Additional arguments are needed. See: https://github.com/dotnet/aspnetcore/issues/24278
Environment.SetEnvironmentVariable("EnableDefaultScopedCssItems", "true");

var project = await ProjectFactory.GetOrCreateProject("blazorhostedpwa", Output);
var project = await ProjectFactory.GetOrCreateProject("blazorhostedpwa", TestOutputHelper);

var createResult = await project.RunDotNetNewAsync("blazorwasm", args: new[] { "--hosted", "--pwa" });
Assert.True(0 == createResult.ExitCode, ErrorMessages.GetFailedProcessMessage("create/restore", project, createResult));
Expand Down Expand Up @@ -297,7 +296,7 @@ private async Task BlazorWasmHostedTemplate_IndividualAuth_Works(BrowserKind bro
// Additional arguments are needed. See: https://github.com/dotnet/aspnetcore/issues/24278
Environment.SetEnvironmentVariable("EnableDefaultScopedCssItems", "true");

var project = await ProjectFactory.GetOrCreateProject("blazorhostedindividual" + browserKind + (useLocalDb ? "uld" : ""), Output);
var project = await ProjectFactory.GetOrCreateProject("blazorhostedindividual" + browserKind + (useLocalDb ? "uld" : ""), TestOutputHelper);

var createResult = await project.RunDotNetNewAsync("blazorwasm", args: new[] { "--hosted", "-au", "Individual", useLocalDb ? "-uld" : "" });
Assert.True(0 == createResult.ExitCode, ErrorMessages.GetFailedProcessMessage("create/restore", project, createResult));
Expand Down Expand Up @@ -370,7 +369,7 @@ public async Task BlazorWasmStandaloneTemplate_IndividualAuth_Works(BrowserKind
// Additional arguments are needed. See: https://github.com/dotnet/aspnetcore/issues/24278
Environment.SetEnvironmentVariable("EnableDefaultScopedCssItems", "true");

var project = await ProjectFactory.GetOrCreateProject("blazorstandaloneindividual" + browserKind, Output);
var project = await ProjectFactory.GetOrCreateProject("blazorstandaloneindividual" + browserKind, TestOutputHelper);

var createResult = await project.RunDotNetNewAsync("blazorwasm", args: new[] {
"-au",
Expand Down Expand Up @@ -402,7 +401,7 @@ public async Task BlazorWasmStandaloneTemplate_IndividualAuth_Works(BrowserKind
var (serveProcess, listeningUri) = RunPublishedStandaloneBlazorProject(project);
using (serveProcess)
{
Output.WriteLine($"Opening browser at {listeningUri}...");
TestOutputHelper.WriteLine($"Opening browser at {listeningUri}...");
await using var browser = await Fixture.BrowserManager.GetBrowserInstance(browserKind, BrowserContextInfo);
var page = await NavigateToPage(browser, listeningUri);
await TestBasicNavigation(project.ProjectName, page);
Expand Down Expand Up @@ -483,7 +482,7 @@ public TemplateInstance(string name, params string[] arguments)
[MemberData(nameof(TemplateData))]
public async Task BlazorWasmHostedTemplate_AzureActiveDirectoryTemplate_Works(TemplateInstance instance)
{
var project = await ProjectFactory.GetOrCreateProject(instance.Name, Output);
var project = await ProjectFactory.GetOrCreateProject(instance.Name, TestOutputHelper);
project.TargetFramework = "netstandard2.1";

var createResult = await project.RunDotNetNewAsync("blazorwasm", args: instance.Arguments);
Expand Down Expand Up @@ -652,7 +651,7 @@ private void UpdatePublishedSettings(Project serverProject)
{
var publishDir = Path.Combine(project.TemplatePublishDir, "wwwroot");

Output.WriteLine("Running dotnet serve on published output...");
TestOutputHelper.WriteLine("Running dotnet serve on published output...");
var developmentCertificate = DevelopmentCertificate.Create(project.TemplateOutputDir);
var args = $"-S --pfx \"{developmentCertificate.CertificatePath}\" --pfx-pwd \"{developmentCertificate.CertificatePassword}\" --port 0";
var command = DotNetMuxer.MuxerPathOrDefault();
Expand All @@ -666,7 +665,7 @@ private void UpdatePublishedSettings(Project serverProject)
args = "--roll-forward LatestMajor " + args; // dotnet-serve targets net5.0 by default
}

var serveProcess = ProcessEx.Run(Output, publishDir, command, args);
var serveProcess = ProcessEx.Run(TestOutputHelper, publishDir, command, args);
var listeningUri = ResolveListeningUrl(serveProcess);
return (serveProcess, listeningUri);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
using System.Threading.Tasks;
using Microsoft.AspNetCore.BrowserTesting;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Logging.Testing;
using Xunit;
using Xunit.Abstractions;
Expand Down Expand Up @@ -65,6 +66,11 @@ public async Task InitializeAsync()
var sink = new TestSink();
sink.MessageLogged += LogBrowserManagerMessage;
var factory = new TestLoggerFactory(sink, enabled: true);
var helixUploadDir = Environment.GetEnvironmentVariable("HELIX_WORKITEM_UPLOAD_ROOT");
if (!string.IsNullOrEmpty(helixUploadDir))
{
factory.AddFile(Path.Combine(helixUploadDir, "playwright-fixture.log"));
}
BrowserManager = await BrowserManager.CreateAsync(_configuration, factory);
}

Expand Down
2 changes: 1 addition & 1 deletion src/Shared/BrowserTesting/src/BrowserManager.cs
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ private async Task InitializeAsync()

async Task InitializeCore()
{
Playwright = await PlaywrightSharp.Playwright.CreateAsync(_loggerFactory/*, debug: "pw:api"*/);
Playwright = await PlaywrightSharp.Playwright.CreateAsync(_loggerFactory, debug: "pw:api");
foreach (var (browserName, options) in _browserManagerConfiguration.BrowserOptions)
{
if (!_launchBrowsers.ContainsKey(browserName))
Expand Down