Fix nunit tests adapter losing async locals (#16157)

* Fix NUnit test context not being properly set

* Add failing tests

* Capture ExecutionContext to keep async locals

* Remove explicit EstablishExecutionEnvironment call, as it was a bad idea

* Make ExecutionContext usage disabled by default, and only enabled for NUnit

src/Headless/Avalonia.Headless.NUnit/AvaloniaTestMethodCommand.cs

@@ -29,7 +29,7 @@ internal class AvaloniaTestMethodCommand : TestCommand
         .GetField("BeforeTest", BindingFlags.Instance | BindingFlags.NonPublic)!;
     private static FieldInfo s_afterTest = typeof(BeforeAndAfterTestCommand)
         .GetField("AfterTest", BindingFlags.Instance | BindingFlags.NonPublic)!;
-    
+
     private AvaloniaTestMethodCommand(
         HeadlessUnitTestSession session,
         TestCommand innerCommand,
@@ -47,7 +47,7 @@ internal class AvaloniaTestMethodCommand : TestCommand
     {
         return ProcessCommand(session, command, new List<Action>(), new List<Action>());
     }
-    
+
     private static TestCommand ProcessCommand(HeadlessUnitTestSession session, TestCommand command, List<Action> before, List<Action> after)
     {
         if (command is BeforeAndAfterTestCommand beforeAndAfterTestCommand)
@@ -79,7 +79,7 @@ internal class AvaloniaTestMethodCommand : TestCommand
 
     public override TestResult Execute(TestExecutionContext context)
     {
-        return _session.Dispatch(() => ExecuteTestMethod(context), default).GetAwaiter().GetResult();
+        return _session.DispatchCore(() => ExecuteTestMethod(context), true, default).GetAwaiter().GetResult();
     }
 
     // Unfortunately, NUnit has issues with custom synchronization contexts, which means we need to add some hacks to make it work.

src/Headless/Avalonia.Headless/Avalonia.Headless.csproj

@@ -16,6 +16,7 @@
   </ItemGroup>
 
   <ItemGroup Label="InternalsVisibleTo">
+    <InternalsVisibleTo Include="Avalonia.Headless.NUnit, PublicKey=$(AvaloniaPublicKey)" />
     <InternalsVisibleTo Include="Avalonia.Headless.Vnc, PublicKey=$(AvaloniaPublicKey)" />
     <InternalsVisibleTo Include="Avalonia.UnitTests, PublicKey=$(AvaloniaPublicKey)" />
     <InternalsVisibleTo Include="Avalonia.Base.UnitTests, PublicKey=$(AvaloniaPublicKey)" />

src/Headless/Avalonia.Headless/HeadlessUnitTestSession.cs

@@ -23,7 +23,7 @@ public sealed class HeadlessUnitTestSession : IDisposable
 
     private readonly AppBuilder _appBuilder;
     private readonly CancellationTokenSource _cancellationTokenSource;
-    private readonly BlockingCollection<Action> _queue;
+    private readonly BlockingCollection<(Action, ExecutionContext?)> _queue;
     private readonly Task _dispatchTask;
 
     internal const DynamicallyAccessedMemberTypes DynamicallyAccessed =
@@ -32,7 +32,7 @@ public sealed class HeadlessUnitTestSession : IDisposable
         DynamicallyAccessedMemberTypes.PublicParameterlessConstructor;
 
     private HeadlessUnitTestSession(AppBuilder appBuilder, CancellationTokenSource cancellationTokenSource,
-        BlockingCollection<Action> queue, Task dispatchTask)
+        BlockingCollection<(Action, ExecutionContext?)> queue, Task dispatchTask)
     {
         _appBuilder = appBuilder;
         _cancellationTokenSource = cancellationTokenSource;
@@ -40,20 +40,26 @@ public sealed class HeadlessUnitTestSession : IDisposable
         _dispatchTask = dispatchTask;
     }
 
-    /// <inheritdoc cref="Dispatch{TResult}(Func{Task{TResult}}, CancellationToken)"/>
+    /// <inheritdoc cref="DispatchCore{TResult}"/>
     public Task Dispatch(Action action, CancellationToken cancellationToken)
     {
-        return Dispatch(() =>
+        return DispatchCore(() =>
         {
             action();
             return Task.FromResult(0);
-        }, cancellationToken);
+        }, false ,cancellationToken);
     }
 
-    /// <inheritdoc cref="Dispatch{TResult}(Func{Task{TResult}}, CancellationToken)"/>
+    /// <inheritdoc cref="DispatchCore{TResult}"/>
     public Task<TResult> Dispatch<TResult>(Func<TResult> action, CancellationToken cancellationToken)
     {
-        return Dispatch(() => Task.FromResult(action()), cancellationToken);
+        return DispatchCore(() => Task.FromResult(action()), false, cancellationToken);
+    }
+
+    /// <inheritdoc cref="DispatchCore{TResult}"/>
+    public Task<TResult> Dispatch<TResult>(Func<Task<TResult>> action, CancellationToken cancellationToken)
+    {
+        return DispatchCore(action, false, cancellationToken);
     }
 
     /// <summary>
@@ -61,11 +67,12 @@ public sealed class HeadlessUnitTestSession : IDisposable
     /// setting app avalonia services, and runs <paramref name="action"/> parameter.
     /// </summary>
     /// <param name="action">Action to execute on the dispatcher thread with avalonia services.</param>
+    /// <param name="captureExecutionContext">Whether dispatch should capture ExecutionContext.</param>
     /// <param name="cancellationToken">Cancellation token to cancel execution.</param>
     /// <exception cref="ObjectDisposedException">
     /// If global session was already cancelled and thread killed, it's not possible to dispatch any actions again
     /// </exception>
-    public Task<TResult> Dispatch<TResult>(Func<Task<TResult>> action, CancellationToken cancellationToken)
+    internal Task<TResult> DispatchCore<TResult>(Func<Task<TResult>> action, bool captureExecutionContext, CancellationToken cancellationToken)
     {
         if (_cancellationTokenSource.IsCancellationRequested)
         {
@@ -73,9 +80,10 @@ public sealed class HeadlessUnitTestSession : IDisposable
         }
 
         var token = _cancellationTokenSource.Token;
+        var executionContext = captureExecutionContext ? ExecutionContext.Capture() : null;
 
         var tcs = new TaskCompletionSource<TResult>();
-        _queue.Add(() =>
+        _queue.Add((() =>
         {
             var cts = new CancellationTokenSource();
             using var globalCts = token.Register(s => ((CancellationTokenSource)s!).Cancel(), cts, true);
@@ -84,7 +92,6 @@ public sealed class HeadlessUnitTestSession : IDisposable
             try
             {
                 using var application = EnsureApplication();
-
                 var task = action();
                 task.ContinueWith((_, s) => ((CancellationTokenSource)s!).Cancel(), cts,
                     TaskScheduler.FromCurrentSynchronizationContext());
@@ -106,7 +113,7 @@ public sealed class HeadlessUnitTestSession : IDisposable
             {
                 tcs.TrySetException(ex);
             }
-        });
+        }, executionContext));
         return tcs.Task;
     }
 
@@ -152,7 +159,7 @@ public sealed class HeadlessUnitTestSession : IDisposable
     {
         var tcs = new TaskCompletionSource<HeadlessUnitTestSession>();
         var cancellationTokenSource = new CancellationTokenSource();
-        var queue = new BlockingCollection<Action>();
+        var queue = new BlockingCollection<(Action, ExecutionContext?)>();
 
         Task? task = null;
         task = Task.Run(() =>
@@ -180,8 +187,15 @@ public sealed class HeadlessUnitTestSession : IDisposable
             {
                 try
                 {
-                    var action = queue.Take(cancellationTokenSource.Token);
-                    action();
+                    var (action, executionContext) = queue.Take(cancellationTokenSource.Token);
+                    if (executionContext is not null)
+                    {
+                        ExecutionContext.Run(executionContext, a => ((Action)a!).Invoke(), action);
+                    }
+                    else
+                    {
+                        action();   
+                    }
                 }
                 catch (OperationCanceledException)
                 {

tests/Avalonia.Headless.UnitTests/ThreadingTests.cs

@@ -1,4 +1,6 @@
 using System;
+using System.Linq;
+using System.Runtime.CompilerServices;
 using System.Threading;
 using System.Threading.Tasks;
 using Avalonia.Threading;
@@ -14,6 +16,7 @@ public class ThreadingTests
 #endif
     public void Should_Be_On_Dispatcher_Thread()
     {
+        ValidateTestContext();
         Dispatcher.UIThread.VerifyAccess();
     }
 
@@ -34,20 +37,40 @@ public class ThreadingTests
 #endif
     public async Task DispatcherTimer_Works_On_The_Same_Thread(int interval)
     {
+        Assert.NotNull(SynchronizationContext.Current);
+        ValidateTestContext();
+        var currentThread = Thread.CurrentThread;
+
         await Task.Delay(100);
 
-        var currentThread = Thread.CurrentThread;
+        ValidateTestContext();
+        Assert.True(currentThread == Thread.CurrentThread);
+
         var tcs = new TaskCompletionSource();
-        var hasCompleted = false;
 
         DispatcherTimer.RunOnce(() =>
         {
-            hasCompleted = currentThread == Thread.CurrentThread;
-
-            tcs.SetResult();
+            try
+            {
+                ValidateTestContext();
+                Assert.True(currentThread == Thread.CurrentThread);
+                tcs.SetResult();
+            }
+            catch (Exception ex)
+            {
+                tcs.SetException(ex);
+            }
         }, TimeSpan.FromTicks(interval));
 
         await tcs.Task; 
-        Assert.True(hasCompleted);
+    }
+
+    private void ValidateTestContext([CallerMemberName] string runningMethodName = null)
+    {
+#if NUNIT
+        var testName = TestContext.CurrentContext.Test.Name;
+        // Test.Name also includes parameters.
+        Assert.AreEqual(testName.Split('(').First(), runningMethodName); 
+#endif
     }
 }