diff --git a/docs/src/trace-viewer-intro-csharp.md b/docs/src/trace-viewer-intro-csharp.md index f4cee20e9b..c46edad5fc 100644 --- a/docs/src/trace-viewer-intro-csharp.md +++ b/docs/src/trace-viewer-intro-csharp.md @@ -59,7 +59,7 @@ public class Tests : PageTest } [Test] - public async Task TestYourOnlineShop() + public async Task GetStartedLink() { // .. } @@ -131,6 +131,8 @@ pwsh bin/Debug/net8.0/playwright.ps1 show-trace bin/Debug/net8.0/playwright-trac ## Run trace only on failure +Setup your tests to record a trace only when the test fails: + @@ -180,21 +198,38 @@ namespace PlaywrightTests; [TestClass] public class ExampleTest : PageTest { - // ... + [TestInitialize] + public async Task TestInitialize() + { + await Context.Tracing.StartAsync(new() + { + Title = $"{TestContext.FullyQualifiedTestClassName}.{TestContext.TestName}", + Screenshots = true, + Snapshots = true, + Sources = true + }); + } + [TestCleanup] public async Task TestCleanup() { var failed = new[] { UnitTestOutcome.Failed, UnitTestOutcome.Error, UnitTestOutcome.Timeout, UnitTestOutcome.Aborted }.Contains(TestContext.CurrentTestOutcome); - await Context.Tracing.StopAsync(new() - { - Path = failed ? Path.Combine( - Environment.CurrentDirectory, - "playwright-traces", - $"{TestContext.FullyQualifiedTestClassName}.{TestContext.TestName}.zip" - ) : null + await Context.Tracing.StopAsync(new() + { + Path = Path.Combine( + Environment.CurrentDirectory, + "playwright-traces", + $"{TestContext.FullyQualifiedTestClassName}.{TestContext.TestName}.zip" + ) }); } + + [TestMethod] + public async Task GetStartedLink() + { + // ... + } } ``` @@ -206,4 +241,4 @@ To learn more check out our detailed guide on [Trace Viewer](/trace-viewer.md). ## What's next - [Run tests on CI with GitHub Actions](/ci-intro.md) -- [Learn more about Trace Viewer](/trace-viewer.md) +- [Learn more about the NUnit and MSTest base classes](./test-runners.md) diff --git a/docs/src/trace-viewer.md b/docs/src/trace-viewer.md index 1f50025c32..98d6e71127 100644 --- a/docs/src/trace-viewer.md +++ b/docs/src/trace-viewer.md @@ -345,9 +345,118 @@ public class UnitTest1 : PageTest This will record the trace and place it into the `bin/Debug/net8.0/playwright-traces/` directory. + +## Run trace only on failure +* langs: csharp + +Setup your tests to record a trace only when the test fails: + + + + +```csharp +namespace PlaywrightTests; + +[Parallelizable(ParallelScope.Self)] +[TestFixture] +public class ExampleTest : PageTest +{ + [SetUp] + public async Task Setup() + { + await Context.Tracing.StartAsync(new() + { + Title = $"{TestContext.CurrentContext.Test.ClassName}.{TestContext.CurrentContext.Test.Name}", + Screenshots = true, + Snapshots = true, + Sources = true + }); + } + + [TearDown] + public async Task TearDown() + { + var failed = TestContext.CurrentContext.Result.Outcome == NUnit.Framework.Interfaces.ResultState.Error + || TestContext.CurrentContext.Result.Outcome == NUnit.Framework.Interfaces.ResultState.Failure; + + await Context.Tracing.StopAsync(new() + { + Path = Path.Combine( + TestContext.CurrentContext.WorkDirectory, + "playwright-traces", + $"{TestContext.CurrentContext.Test.ClassName}.{TestContext.CurrentContext.Test.Name}.zip" + ) + }); + } + + [Test] + public async Task GetStartedLink() + { + // .. + } +} +``` + + + +```csharp +using System.Text.RegularExpressions; +using Microsoft.Playwright; +using Microsoft.Playwright.MSTest; + +namespace PlaywrightTests; + +[TestClass] +public class ExampleTest : PageTest +{ + [TestInitialize] + public async Task TestInitialize() + { + await Context.Tracing.StartAsync(new() + { + Title = $"{TestContext.FullyQualifiedTestClassName}.{TestContext.TestName}", + Screenshots = true, + Snapshots = true, + Sources = true + }); + } + + [TestCleanup] + public async Task TestCleanup() + { + var failed = new[] { UnitTestOutcome.Failed, UnitTestOutcome.Error, UnitTestOutcome.Timeout, UnitTestOutcome.Aborted }.Contains(TestContext.CurrentTestOutcome); + + await Context.Tracing.StopAsync(new() + { + Path = Path.Combine( + Environment.CurrentDirectory, + "playwright-traces", + $"{TestContext.FullyQualifiedTestClassName}.{TestContext.TestName}.zip" + ) + }); + } + + [TestMethod] + public async Task GetStartedLink() + { + // ... + } +} +``` + + + + ## Opening the trace -You can open the saved trace using the Playwright CLI or in your browser on [`trace.playwright.dev`](https://trace.playwright.dev). Make sure to add the full path to where your `trace.zip` file is located. This should include the full path to your `trace.zip` file. +You can open the saved trace using the Playwright CLI or in your browser on [`trace.playwright.dev`](https://trace.playwright.dev). Make sure to add the full path to where your `trace.zip` file is located. ```bash js npx playwright show-trace path/to/trace.zip