Fix deadlocks in tests when there's no sync context

Patch provided in xunit/xunit#2912

Author: bradwilson

test/PowerShellEditorServices.Test/Debugging/DebugServiceTests.cs

@@ -33,7 +33,7 @@ internal class TestReadLine : IReadLine
     }
 
     [Trait("Category", "DebugService")]
-    public class DebugServiceTests : IDisposable
+    public class DebugServiceTests : IAsyncLifetime
     {
         private readonly PsesInternalHost psesHost;
         private readonly BreakpointService breakpointService;
@@ -76,14 +76,13 @@ public DebugServiceTests()
             variableScriptFile = GetDebugScript("VariableTest.ps1");
         }
 
-        public void Dispose()
+        public Task InitializeAsync() => Task.CompletedTask;
+
+        public async Task DisposeAsync()
         {
             debugService.Abort();
             debuggerStoppedQueue.Dispose();
-#pragma warning disable VSTHRD002
-            psesHost.StopAsync().Wait();
-#pragma warning restore VSTHRD002
-            GC.SuppressFinalize(this);
+            await Task.Run(psesHost.StopAsync);
         }
 
         /// <summary>

test/PowerShellEditorServices.Test/Extensions/ExtensionCommandTests.cs

@@ -20,33 +20,25 @@
 namespace PowerShellEditorServices.Test.Extensions
 {
     [Trait("Category", "Extensions")]
-    public class ExtensionCommandTests : IDisposable
+    public class ExtensionCommandTests : IAsyncLifetime
     {
-        private readonly PsesInternalHost psesHost;
+        private PsesInternalHost psesHost;
 
-        private readonly ExtensionCommandService extensionCommandService;
+        private ExtensionCommandService extensionCommandService;
 
-        public ExtensionCommandTests()
+        public async Task InitializeAsync()
         {
             psesHost = PsesHostFactory.Create(NullLoggerFactory.Instance);
             ExtensionService extensionService = new(
                 languageServer: null,
                 serviceProvider: null,
                 editorOperations: null,
                 executionService: psesHost);
-#pragma warning disable VSTHRD002
-            extensionService.InitializeAsync().Wait();
-#pragma warning restore VSTHRD002
+            await extensionService.InitializeAsync();
             extensionCommandService = new(extensionService);
         }
 
-        public void Dispose()
-        {
-#pragma warning disable VSTHRD002
-            psesHost.StopAsync().Wait();
-#pragma warning restore VSTHRD002
-            GC.SuppressFinalize(this);
-        }
+        public async Task DisposeAsync() => await psesHost.StopAsync();
 
         [Fact]
         public async Task CanRegisterAndInvokeCommandWithCmdletName()

test/PowerShellEditorServices.Test/Language/CompletionHandlerTests.cs

@@ -1,7 +1,6 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Threading;
@@ -21,7 +20,7 @@
 namespace PowerShellEditorServices.Test.Language
 {
     [Trait("Category", "Completions")]
-    public class CompletionHandlerTests : IDisposable
+    public class CompletionHandlerTests : IAsyncLifetime
     {
         private readonly PsesInternalHost psesHost;
         private readonly WorkspaceService workspace;
@@ -34,13 +33,9 @@ public CompletionHandlerTests()
             completionHandler = new PsesCompletionHandler(NullLoggerFactory.Instance, psesHost, psesHost, workspace);
         }
 
-        public void Dispose()
-        {
-#pragma warning disable VSTHRD002
-            psesHost.StopAsync().Wait();
-#pragma warning restore VSTHRD002
-            GC.SuppressFinalize(this);
-        }
+        public Task InitializeAsync() => Task.CompletedTask;
+
+        public async Task DisposeAsync() => await Task.Run(psesHost.StopAsync);
 
         private ScriptFile GetScriptFile(ScriptRegion scriptRegion) => workspace.GetFile(TestUtilities.GetSharedPath(scriptRegion.File));
 

test/PowerShellEditorServices.Test/Language/SymbolsServiceTests.cs

@@ -1,7 +1,6 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Management.Automation;
@@ -30,7 +29,7 @@
 namespace PowerShellEditorServices.Test.Language
 {
     [Trait("Category", "Symbols")]
-    public class SymbolsServiceTests : IDisposable
+    public class SymbolsServiceTests : IAsyncLifetime
     {
         private readonly PsesInternalHost psesHost;
         private readonly WorkspaceService workspace;
@@ -53,14 +52,13 @@ public SymbolsServiceTests()
                 new ConfigurationService());
         }
 
-        public void Dispose()
+        public Task InitializeAsync() => Task.CompletedTask;
+
+        public async Task DisposeAsync()
         {
-#pragma warning disable VSTHRD002
-            psesHost.StopAsync().GetAwaiter().GetResult();
-#pragma warning restore VSTHRD002
+            psesHost.StopAsync();
             CommandHelpers.s_cmdletToAliasCache.Clear();
             CommandHelpers.s_aliasToCmdletCache.Clear();
-            GC.SuppressFinalize(this);
         }
 
         private static void AssertIsRegion(

test/PowerShellEditorServices.Test/Session/PsesInternalHostTests.cs

@@ -20,19 +20,15 @@ namespace PowerShellEditorServices.Test.Session
     using System.Management.Automation.Runspaces;
 
     [Trait("Category", "PsesInternalHost")]
-    public class PsesInternalHostTests : IDisposable
+    public class PsesInternalHostTests : IAsyncLifetime
     {
         private readonly PsesInternalHost psesHost;
 
         public PsesInternalHostTests() => psesHost = PsesHostFactory.Create(NullLoggerFactory.Instance);
 
-        public void Dispose()
-        {
-#pragma warning disable VSTHRD002
-            psesHost.StopAsync().Wait();
-#pragma warning restore VSTHRD002
-            GC.SuppressFinalize(this);
-        }
+        public Task InitializeAsync() => Task.CompletedTask;
+
+        public async Task DisposeAsync() => await psesHost.StopAsync();
 
         [Fact]
         public async Task CanExecutePSCommand()
@@ -238,19 +234,15 @@ public async Task CanHandleBadInitialWorkingDirectory(string path)
     }
 
     [Trait("Category", "PsesInternalHost")]
-    public class PsesInternalHostWithProfileTests : IDisposable
+    public class PsesInternalHostWithProfileTests : IAsyncLifetime
     {
         private readonly PsesInternalHost psesHost;
 
         public PsesInternalHostWithProfileTests() => psesHost = PsesHostFactory.Create(NullLoggerFactory.Instance, loadProfiles: true);
 
-        public void Dispose()
-        {
-#pragma warning disable VSTHRD002
-            psesHost.StopAsync().Wait();
-#pragma warning restore VSTHRD002
-            GC.SuppressFinalize(this);
-        }
+        public Task InitializeAsync() => Task.CompletedTask;
+
+        public async Task DisposeAsync() => await psesHost.StopAsync();
 
         [Fact]
         public async Task CanResolveAndLoadProfilesForHostId()