docs(dotnet): improve trace viewer intro (microsoft#30671)

mxschmitt · May 21, 2024 · 446994f · 446994f
1 parent 2bba2a6
commit 446994f
Show file tree

Hide file tree

Showing 2 changed files with 186 additions and 91 deletions.
diff --git a/.../trace-viewer-intro-csharp-java-python.md → docs/src/trace-viewer-intro-csharp.md b/.../trace-viewer-intro-csharp-java-python.md → docs/src/trace-viewer-intro-csharp.md
@@ -13,81 +13,6 @@ Playwright Trace Viewer is a GUI tool that lets you explore recorded Playwright
 - How to open the trace viewer
 
 ## Recording a trace
-* langs: python
-
-Traces can be recorded by running your tests with the `--tracing` flag.
-
-```bash
-pytest --tracing on
-```
-Options for tracing are:
-- `on`: Record trace for each test
-- `off`: Do not record trace. (default)
-- `retain-on-failure`: Record trace for each test, but remove all traces from successful test runs.
-
-This will record the trace and place it into the file named `trace.zip` in your `test-results` directory.
-
-<details>
-<summary>If you are not using Pytest, click here to learn how to record traces.</summary>
-
-```python async
-browser = await chromium.launch()
-context = await browser.new_context()
-
-# Start tracing before creating / navigating a page.
-await context.tracing.start(screenshots=True, snapshots=True, sources=True)
-
-page = await context.new_page()
-await page.goto("https://playwright.dev")
-
-# Stop tracing and export it into a zip archive.
-await context.tracing.stop(path = "trace.zip")
-```
-
-```python sync
-browser = chromium.launch()
-context = browser.new_context()
-
-# Start tracing before creating / navigating a page.
-context.tracing.start(screenshots=True, snapshots=True, sources=True)
-
-page = context.new_page()
-page.goto("https://playwright.dev")
-
-# Stop tracing and export it into a zip archive.
-context.tracing.stop(path = "trace.zip")
-```
-
-</details>
-
-## Recording a trace
-* langs: java
-
-Traces can be recorded using the [`property: BrowserContext.tracing`] API as follows:
-
-```java
-Browser browser = browserType.launch();
-BrowserContext context = browser.newContext();
-
-// Start tracing before creating / navigating a page.
-context.tracing().start(new Tracing.StartOptions()
-  .setScreenshots(true)
-  .setSnapshots(true)
-  .setSources(true));
-
-Page page = context.newPage();
-page.navigate("https://playwright.dev");
-
-// Stop tracing and export it into a zip archive.
-context.tracing().stop(new Tracing.StopOptions()
-  .setPath(Paths.get("trace.zip")));
-```
-
-
-This will record the trace and place it into the file named `trace.zip`.
-
-## Recording a trace
-* langs: csharp
 
 Traces can be recorded using the [`property: BrowserContext.tracing`] API as follows:
 
@@ -113,7 +38,7 @@ public class Tests : PageTest
     {
         await Context.Tracing.StartAsync(new()
         {
-            Title = TestContext.CurrentContext.Test.ClassName + "." + TestContext.CurrentContext.Test.Name,
+            Title = $"{TestContext.CurrentContext.Test.ClassName}.{TestContext.CurrentContext.Test.Name}",
             Screenshots = true,
             Snapshots = true,
             Sources = true
@@ -159,7 +84,7 @@ public class ExampleTest : PageTest
     {
          await Context.Tracing.StartAsync(new()
         {
-            Title = TestContext.CurrentContext.Test.ClassName + "." + TestContext.
+            Title = $"{TestContext.FullyQualifiedTestClassName}.{TestContext.TestName}",
             Screenshots = true,
             Snapshots = true,
             Sources = true
@@ -174,7 +99,7 @@ public class ExampleTest : PageTest
             Path = Path.Combine(
                 Environment.CurrentDirectory,
                 "playwright-traces",
-                $"{TestContext.CurrentContext.Test.ClassName}.{TestContext.CurrentContext.Test.Name}.zip"
+                $"{TestContext.FullyQualifiedTestClassName}.{TestContext.TestName}.zip"
             )
         });
     }
@@ -196,27 +121,85 @@ This will record a zip file for each test, e.g. `PlaywrightTests.ExampleTest.Get
 
 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's zip file is located. Once opened you can click on each action or use the timeline to see the state of the page before and after each action. You can also inspect the log, source and network during each step of the test. The trace viewer creates a DOM snapshot so you can fully interact with it, open devtools etc.
 
-```bash java
-mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="show-trace trace.zip"
-```
-
-```bash python
-playwright show-trace trace.zip
-```
 
 ```bash csharp
 pwsh bin/Debug/net8.0/playwright.ps1 show-trace bin/Debug/net8.0/playwright-traces/PlaywrightTests.ExampleTest.GetStartedLink.zip
 ```
 
-######
-* langs: python, java
+![playwright trace viewer dotnet](https://github.com/microsoft/playwright/assets/13063165/4372d661-5bfa-4e1f-be65-0d2fe165a75c)
 
-![playwright trace viewer](https://github.com/microsoft/playwright/assets/13063165/10fe3585-8401-4051-b1c2-b2e92ac4c274)
 
-######
-* langs: csharp
+## Run trace only on failure
 
-![playwright trace viewer dotnet](https://github.com/microsoft/playwright/assets/13063165/4372d661-5bfa-4e1f-be65-0d2fe165a75c)
+<Tabs
+  groupId="test-runners"
+  defaultValue="nunit"
+  values={[
+    {label: 'NUnit', value: 'nunit'},
+    {label: 'MSTest', value: 'mstest'}
+  ]
+}>
+<TabItem value="nunit">
+
+```csharp
+namespace PlaywrightTests;
+
+[Parallelizable(ParallelScope.Self)]
+[TestFixture]
+public class ExampleTest : PageTest
+{
+    // ...
+    [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 = failed ? Path.Combine( 
+                TestContext.CurrentContext.WorkDirectory, 
+                "playwright-traces", 
+                $"{TestContext.CurrentContext.Test.ClassName}.{TestContext.CurrentContext.Test.Name}.zip" 
+            ) : null, 
+        });
+    }
+}
+```
+
+</TabItem>
+<TabItem value="mstest">
+
+```csharp
+using System.Text.RegularExpressions;
+using Microsoft.Playwright;
+using Microsoft.Playwright.MSTest;
+
+namespace PlaywrightTests;
+
+[TestClass]
+public class ExampleTest : PageTest
+{
+    // ...
+    [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 
+        });
+    }
+}
+```
+
+</TabItem>
+</Tabs>
 
 To learn more check out our detailed guide on [Trace Viewer](/trace-viewer.md).
 

diff --git a/docs/src/trace-viewer-intro-java-python.md b/docs/src/trace-viewer-intro-java-python.md
@@ -0,0 +1,112 @@
+---
+id: trace-viewer-intro
+title: "Trace viewer"
+---
+
+## Introduction
+
+Playwright Trace Viewer is a GUI tool that lets you explore recorded Playwright traces of your tests meaning you can go back and forward though each action of your test and visually see what was happening during each action.
+
+**You will learn**
+
+- How to record a trace
+- How to open the trace viewer
+
+## Recording a trace
+* langs: python
+
+Traces can be recorded by running your tests with the `--tracing` flag.
+
+```bash
+pytest --tracing on
+```
+Options for tracing are:
+- `on`: Record trace for each test
+- `off`: Do not record trace. (default)
+- `retain-on-failure`: Record trace for each test, but remove all traces from successful test runs.
+
+This will record the trace and place it into the file named `trace.zip` in your `test-results` directory.
+
+<details>
+<summary>If you are not using Pytest, click here to learn how to record traces.</summary>
+
+```python async
+browser = await chromium.launch()
+context = await browser.new_context()
+
+# Start tracing before creating / navigating a page.
+await context.tracing.start(screenshots=True, snapshots=True, sources=True)
+
+page = await context.new_page()
+await page.goto("https://playwright.dev")
+
+# Stop tracing and export it into a zip archive.
+await context.tracing.stop(path = "trace.zip")
+```
+
+```python sync
+browser = chromium.launch()
+context = browser.new_context()
+
+# Start tracing before creating / navigating a page.
+context.tracing.start(screenshots=True, snapshots=True, sources=True)
+
+page = context.new_page()
+page.goto("https://playwright.dev")
+
+# Stop tracing and export it into a zip archive.
+context.tracing.stop(path = "trace.zip")
+```
+
+</details>
+
+## Recording a trace
+* langs: java
+
+Traces can be recorded using the [`property: BrowserContext.tracing`] API as follows:
+
+```java
+Browser browser = browserType.launch();
+BrowserContext context = browser.newContext();
+
+// Start tracing before creating / navigating a page.
+context.tracing().start(new Tracing.StartOptions()
+  .setScreenshots(true)
+  .setSnapshots(true)
+  .setSources(true));
+
+Page page = context.newPage();
+page.navigate("https://playwright.dev");
+
+// Stop tracing and export it into a zip archive.
+context.tracing().stop(new Tracing.StopOptions()
+  .setPath(Paths.get("trace.zip")));
+```
+
+
+This will record the trace and place it into the file named `trace.zip`.
+
+## 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's zip file is located. Once opened you can click on each action or use the timeline to see the state of the page before and after each action. You can also inspect the log, source and network during each step of the test. The trace viewer creates a DOM snapshot so you can fully interact with it, open devtools etc.
+
+```bash java
+mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="show-trace trace.zip"
+```
+
+```bash python
+playwright show-trace trace.zip
+```
+
+######
+* langs: python, java
+
+![playwright trace viewer](https://github.com/microsoft/playwright/assets/13063165/10fe3585-8401-4051-b1c2-b2e92ac4c274)
+
+
+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)