Merge branch 'main' into fix-verify-result-encoding

Author: SimonCropp

docs/recording.md

@@ -25,7 +25,7 @@ public Task Usage()
     return Verify("TheValue");
 }
 ```
-<sup><a href='/src/Verify.Tests/RecordingTests.cs#L54-L64' title='Snippet source file'>snippet source</a> | <a href='#snippet-Recording' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/RecordingTests.cs#L84-L94' title='Snippet source file'>snippet source</a> | <a href='#snippet-Recording' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Results in:
@@ -61,7 +61,7 @@ public Task TryAdd()
     return Verify("TheValue");
 }
 ```
-<sup><a href='/src/Verify.Tests/RecordingTests.cs#L90-L102' title='Snippet source file'>snippet source</a> | <a href='#snippet-RecordingTryAdd' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/RecordingTests.cs#L120-L132' title='Snippet source file'>snippet source</a> | <a href='#snippet-RecordingTryAdd' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 
@@ -85,7 +85,7 @@ public Task RecordingScoped()
     return Verify();
 }
 ```
-<sup><a href='/src/Verify.Tests/RecordingTests.cs#L113-L128' title='Snippet source file'>snippet source</a> | <a href='#snippet-RecordingScoped' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/RecordingTests.cs#L143-L158' title='Snippet source file'>snippet source</a> | <a href='#snippet-RecordingScoped' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Results in:
@@ -117,7 +117,7 @@ public Task SameKey()
     return Verify("TheValue");
 }
 ```
-<sup><a href='/src/Verify.Tests/RecordingTests.cs#L312-L323' title='Snippet source file'>snippet source</a> | <a href='#snippet-RecordingSameKey' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/RecordingTests.cs#L342-L353' title='Snippet source file'>snippet source</a> | <a href='#snippet-RecordingSameKey' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Results in:
@@ -156,7 +156,7 @@ public Task Identifier()
     return Verify(Recording.Stop("identifier"));
 }
 ```
-<sup><a href='/src/Verify.Tests/RecordingTests.cs#L130-L140' title='Snippet source file'>snippet source</a> | <a href='#snippet-RecordingIdentifier' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/RecordingTests.cs#L160-L170' title='Snippet source file'>snippet source</a> | <a href='#snippet-RecordingIdentifier' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Results in:
@@ -188,7 +188,7 @@ public Task Case()
     return Verify("TheValue");
 }
 ```
-<sup><a href='/src/Verify.Tests/RecordingTests.cs#L334-L345' title='Snippet source file'>snippet source</a> | <a href='#snippet-RecordingIgnoreCase' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/RecordingTests.cs#L364-L375' title='Snippet source file'>snippet source</a> | <a href='#snippet-RecordingIgnoreCase' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Results in:
@@ -223,7 +223,7 @@ public Task Stop()
     return Verify(appends.Where(_ => _.Name != "name1"));
 }
 ```
-<sup><a href='/src/Verify.Tests/RecordingTests.cs#L172-L184' title='Snippet source file'>snippet source</a> | <a href='#snippet-RecordingStop' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/RecordingTests.cs#L202-L214' title='Snippet source file'>snippet source</a> | <a href='#snippet-RecordingStop' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Results in:
@@ -255,7 +255,7 @@ public Task StopNotInResult()
     return Verify("other data");
 }
 ```
-<sup><a href='/src/Verify.Tests/RecordingTests.cs#L186-L198' title='Snippet source file'>snippet source</a> | <a href='#snippet-RecordingStopNotInResult' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/RecordingTests.cs#L216-L228' title='Snippet source file'>snippet source</a> | <a href='#snippet-RecordingStopNotInResult' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Results in:
@@ -284,7 +284,7 @@ public void IsRecording()
     Assert.True(Recording.IsRecording());
 }
 ```
-<sup><a href='/src/Verify.Tests/RecordingTests.cs#L142-L152' title='Snippet source file'>snippet source</a> | <a href='#snippet-IsRecording' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/RecordingTests.cs#L172-L182' title='Snippet source file'>snippet source</a> | <a href='#snippet-IsRecording' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 This can be helpful if the cost of capturing data, to add to recording, is high.
@@ -307,7 +307,7 @@ public Task Clear()
     return Verify();
 }
 ```
-<sup><a href='/src/Verify.Tests/RecordingTests.cs#L232-L244' title='Snippet source file'>snippet source</a> | <a href='#snippet-RecordingClear' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/RecordingTests.cs#L262-L274' title='Snippet source file'>snippet source</a> | <a href='#snippet-RecordingClear' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Results in:
@@ -343,7 +343,7 @@ public Task PauseResume()
     return Verify();
 }
 ```
-<sup><a href='/src/Verify.Tests/RecordingTests.cs#L256-L271' title='Snippet source file'>snippet source</a> | <a href='#snippet-RecordingPauseResume' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/RecordingTests.cs#L286-L301' title='Snippet source file'>snippet source</a> | <a href='#snippet-RecordingPauseResume' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Results in:

src/Verify.ClipboardAccept/ClipboardAccept.cs

@@ -111,11 +111,28 @@ static async Task Append(string command)
         try
         {
             builder.AppendLine(command);
-            await ClipboardService.SetTextAsync(builder.ToString());
+            await SetClipboardText(builder.ToString());
         }
         finally
         {
             semaphore.Release();
         }
     }
+
+    static async Task SetClipboardText(string text)
+    {
+        try
+        {
+            await ClipboardService.SetTextAsync(text);
+        }
+        catch (Exception exception)
+        {
+            // This runs from the OnFirstVerify and OnVerifyMismatch callbacks, which the
+            // engine awaits while building the failure. Letting a clipboard failure out
+            // replaces the snapshot diff with an unrelated error: no xsel or wl-copy on a
+            // headless Linux box, or another process holding the Windows clipboard.
+            // Copying the accept command is a convenience, so it fails quietly.
+            Trace.WriteLine($"Verify: could not write the accept command to the clipboard. {exception}");
+        }
+    }
 }

src/Verify.Fixie/Execution/ExecutionState.cs

@@ -25,9 +25,10 @@ public static ExecutionState Current
 
             throw new(
                 """
-                No State found. Ensure a class inheriting from VerifyTestProject exists in the test project.
-                public class TestProject :
-                    VerifyTestProject;
+                No State found. Fixie leaves test execution up to the consumer, so Verify needs a class in the test project implementing Fixie's ITestProject and IExecution:
+                  * ITestProject.Configure must call VerifierSettings.AssignTargetAssembly(environment.Assembly)
+                  * IExecution.Run must wrap each test.Run in `using (ExecutionState.Set(testClass, test, parameters))`
+                See https://github.com/VerifyTests/Verify/blob/main/docs/mdsource/fixie-convention.include.md for a full example.
                 """);
         }
     }

src/Verify.MSTest.SourceGenerator.Tests/GlobalNamespaceTests.HasAssemblyAttribute.verified.txt

@@ -14,7 +14,7 @@ partial class Foo
   [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Verify.MSTest.SourceGenerator", "1.0.0.0")]
   public global::Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext
   {
-    get => global::VerifyMSTest.Verifier.CurrentTestContext.Value!.TestContext;
+    get => global::VerifyMSTest.Verifier.CurrentTestContext.Value.TestContext;
     set => global::VerifyMSTest.Verifier.CurrentTestContext.Value = new global::VerifyMSTest.TestExecutionContext(value, GetType());
   }
 }

src/Verify.MSTest.SourceGenerator.Tests/GlobalNamespaceTests.HasAssemblyAttributeAndCustomTestClassAttribute.verified.txt

@@ -14,7 +14,7 @@ partial class Foo
   [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Verify.MSTest.SourceGenerator", "1.0.0.0")]
   public global::Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext
   {
-    get => global::VerifyMSTest.Verifier.CurrentTestContext.Value!.TestContext;
+    get => global::VerifyMSTest.Verifier.CurrentTestContext.Value.TestContext;
     set => global::VerifyMSTest.Verifier.CurrentTestContext.Value = new global::VerifyMSTest.TestExecutionContext(value, GetType());
   }
 }

src/Verify.MSTest.SourceGenerator.Tests/GlobalNamespaceTests.HasAttributeOnClass.verified.txt

@@ -14,7 +14,7 @@ partial class Foo
   [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Verify.MSTest.SourceGenerator", "1.0.0.0")]
   public global::Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext
   {
-    get => global::VerifyMSTest.Verifier.CurrentTestContext.Value!.TestContext;
+    get => global::VerifyMSTest.Verifier.CurrentTestContext.Value.TestContext;
     set => global::VerifyMSTest.Verifier.CurrentTestContext.Value = new global::VerifyMSTest.TestExecutionContext(value, GetType());
   }
 }

src/Verify.MSTest.SourceGenerator.Tests/GlobalNamespaceTests.HasBothAssemblyAndClassAttributes.verified.txt

@@ -14,7 +14,7 @@ partial class Foo
   [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Verify.MSTest.SourceGenerator", "1.0.0.0")]
   public global::Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext
   {
-    get => global::VerifyMSTest.Verifier.CurrentTestContext.Value!.TestContext;
+    get => global::VerifyMSTest.Verifier.CurrentTestContext.Value.TestContext;
     set => global::VerifyMSTest.Verifier.CurrentTestContext.Value = new global::VerifyMSTest.TestExecutionContext(value, GetType());
   }
 }

src/Verify.MSTest.SourceGenerator.Tests/InheritanceTests.HasAssemblyAttributeAndTestClassInheritance.verified.txt

@@ -14,7 +14,7 @@ partial class Base
   [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Verify.MSTest.SourceGenerator", "1.0.0.0")]
   public global::Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext
   {
-    get => global::VerifyMSTest.Verifier.CurrentTestContext.Value!.TestContext;
+    get => global::VerifyMSTest.Verifier.CurrentTestContext.Value.TestContext;
     set => global::VerifyMSTest.Verifier.CurrentTestContext.Value = new global::VerifyMSTest.TestExecutionContext(value, GetType());
   }
 }

src/Verify.MSTest.SourceGenerator.Tests/InheritanceTests.HasAssemblyAttributeWithTestClassOnDerivedAndMarkerAttributeOnBase.verified.txt

@@ -14,7 +14,7 @@ partial class Base
   [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Verify.MSTest.SourceGenerator", "1.0.0.0")]
   public global::Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext
   {
-    get => global::VerifyMSTest.Verifier.CurrentTestContext.Value!.TestContext;
+    get => global::VerifyMSTest.Verifier.CurrentTestContext.Value.TestContext;
     set => global::VerifyMSTest.Verifier.CurrentTestContext.Value = new global::VerifyMSTest.TestExecutionContext(value, GetType());
   }
 }

src/Verify.MSTest.SourceGenerator.Tests/InheritanceTests.HasAttributeOnBaseAndDerivedClasses.verified.txt

@@ -14,7 +14,7 @@ partial class Base
   [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Verify.MSTest.SourceGenerator", "1.0.0.0")]
   public global::Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext
   {
-    get => global::VerifyMSTest.Verifier.CurrentTestContext.Value!.TestContext;
+    get => global::VerifyMSTest.Verifier.CurrentTestContext.Value.TestContext;
     set => global::VerifyMSTest.Verifier.CurrentTestContext.Value = new global::VerifyMSTest.TestExecutionContext(value, GetType());
   }
 }