Enable nullables on TestPlatform.Client (#3745)

microsoft · Jun 13, 2022 · 0bea333 · 0bea333
1 parent d2fc0fc
commit 0bea333
Show file tree

Hide file tree

Showing 14 changed files with 294 additions and 311 deletions.
diff --git a/...ft.TestPlatform.Client/AttachmentsProcessing/TestRunAttachmentsProcessingEventsHandler.cs b/...ft.TestPlatform.Client/AttachmentsProcessing/TestRunAttachmentsProcessingEventsHandler.cs
@@ -9,14 +9,12 @@
 using Microsoft.VisualStudio.TestPlatform.ObjectModel.Client;
 using Microsoft.VisualStudio.TestPlatform.ObjectModel.Logging;
 
-#nullable disable
-
 namespace Microsoft.VisualStudio.TestPlatform.Client.TestRunAttachmentsProcessing;
 
 /// <summary>
 /// The test run attachments processing events handler.
 /// </summary>
-/// 
+///
 public class TestRunAttachmentsProcessingEventsHandler : ITestRunAttachmentsProcessingEventsHandler
 {
     private readonly ICommunicationManager _communicationManager;
@@ -35,7 +33,7 @@ public void HandleTestRunAttachmentsProcessingComplete(TestRunAttachmentsProcess
     {
         EqtTrace.Info("Test run attachments processing completed.");
 
-        var payload = new TestRunAttachmentsProcessingCompletePayload()
+        var payload = new TestRunAttachmentsProcessingCompletePayload
         {
             AttachmentsProcessingCompleteEventArgs = attachmentsProcessingCompleteEventArgs,
             Attachments = lastChunk

diff --git a/src/Microsoft.TestPlatform.Client/DesignMode/DesignModeClient.cs b/src/Microsoft.TestPlatform.Client/DesignMode/DesignModeClient.cs
@@ -3,6 +3,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using System.Globalization;
 using System.Net;
 using System.Threading;
@@ -26,8 +27,6 @@
 
 using CommunicationUtilitiesResources = Microsoft.VisualStudio.TestPlatform.CommunicationUtilities.Resources.Resources;
 
-#nullable disable
-
 namespace Microsoft.VisualStudio.TestPlatform.Client.DesignMode;
 
 /// <summary>
@@ -45,9 +44,9 @@ public class DesignModeClient : IDesignModeClient
     private readonly TestSessionMessageLogger _testSessionMessageLogger;
     private readonly object _lockObject = new();
     [System.Diagnostics.CodeAnalysis.SuppressMessage("Style", "IDE1006:Naming Styles", Justification = "Part of the public API.")]
-    protected Action<Message> onCustomTestHostLaunchAckReceived;
+    protected Action<Message>? onCustomTestHostLaunchAckReceived;
     [System.Diagnostics.CodeAnalysis.SuppressMessage("Style", "IDE1006:Naming Styles", Justification = "Part of the public API.")]
-    protected Action<Message> onAttachDebuggerAckRecieved;
+    protected Action<Message>? onAttachDebuggerAckRecieved;
 
     /// <summary>
     /// Initializes a new instance of the <see cref="DesignModeClient"/> class.
@@ -81,11 +80,12 @@ internal DesignModeClient(ICommunicationManager communicationManager, IDataSeria
     /// <summary>
     /// Property exposing the Instance
     /// </summary>
-    public static IDesignModeClient Instance { get; private set; }
+    public static IDesignModeClient? Instance { get; private set; }
 
     /// <summary>
     /// Initializes DesignMode
     /// </summary>
+    [MemberNotNull(nameof(Instance))]
     public static void Initialize()
     {
         Instance = new DesignModeClient();
@@ -102,7 +102,7 @@ public static void Initialize()
     /// </param>
     public void ConnectToClientAndProcessRequests(int port, ITestRequestManager testRequestManager)
     {
-        EqtTrace.Info("Trying to connect to server on port : {0}", port);
+        EqtTrace.Info("Trying to connect to server on port: {0}", port);
         _communicationManager.SetupClientAsync(new IPEndPoint(IPAddress.Loopback, port));
 
         var connectionTimeoutInSecs = EnvironmentHelper.GetConnectionTimeout();
@@ -115,7 +115,7 @@ public void ConnectToClientAndProcessRequests(int port, ITestRequestManager test
         }
         else
         {
-            EqtTrace.Error("DesignModeClient : ConnectToClientAndProcessRequests : Client timed out while connecting to the server.");
+            EqtTrace.Error("DesignModeClient.ConnectToClientAndProcessRequests: Client timed out while connecting to the server.");
             Dispose();
             throw new TimeoutException(
                 string.Format(
@@ -135,7 +135,7 @@ public void HandleParentProcessExit()
         // this should end the "ProcessRequests" loop with an exception
         Dispose();
 
-        EqtTrace.Info("DesignModeClient: Parent process exited, Exiting myself..");
+        EqtTrace.Info("DesignModeClient.HandleParentProcessExit: Parent process exited, Exiting myself...");
 
         _platformEnvironment.Exit(1);
     }
@@ -303,7 +303,7 @@ public int LaunchCustomHost(TestProcessStartInfo testProcessStartInfo, Cancellat
         lock (_lockObject)
         {
             var waitHandle = new AutoResetEvent(false);
-            Message ackMessage = null;
+            Message? ackMessage = null;
             onCustomTestHostLaunchAckReceived = (ackRawMessage) =>
             {
                 ackMessage = ackRawMessage;
@@ -343,7 +343,7 @@ public bool AttachDebuggerToProcess(AttachDebuggerInfo attachDebuggerInfo, Cance
         lock (_lockObject)
         {
             var waitHandle = new AutoResetEvent(false);
-            Message ackMessage = null;
+            Message? ackMessage = null;
             onAttachDebuggerAckRecieved = (ackRawMessage) =>
             {
                 ackMessage = ackRawMessage;
@@ -363,7 +363,7 @@ public bool AttachDebuggerToProcess(AttachDebuggerInfo attachDebuggerInfo, Cance
             {
                 var payload = new EditorAttachDebuggerPayload
                 {
-                    TargetFramework = attachDebuggerInfo.TargetFramework.ToString(),
+                    TargetFramework = attachDebuggerInfo.TargetFramework?.ToString(),
                     ProcessID = attachDebuggerInfo.ProcessId,
                 };
                 _communicationManager.SendMessage(MessageType.EditorAttachDebugger2, payload);
@@ -394,7 +394,7 @@ public void SendRawMessage(string rawMessage)
     }
 
     /// <inheritdoc />
-    public void SendTestMessage(TestMessageLevel level, string message)
+    public void SendTestMessage(TestMessageLevel level, string? message)
     {
         var payload = new TestMessagePayload { MessageLevel = level, Message = message };
         _communicationManager.SendMessage(MessageType.TestMessage, payload);
@@ -405,7 +405,7 @@ public void SendTestMessage(TestMessageLevel level, string message)
     /// </summary>
     /// <param name="sender"></param>
     /// <param name="e"></param>
-    public void TestRunMessageHandler(object sender, TestRunMessageEventArgs e)
+    public void TestRunMessageHandler(object? sender, TestRunMessageEventArgs e)
     {
         // save into trace log and send the message to the IDE
         //
@@ -440,41 +440,40 @@ public void TestRunMessageHandler(object sender, TestRunMessageEventArgs e)
 
     private void StartTestRun(TestRunRequestPayload testRunPayload, ITestRequestManager testRequestManager, bool shouldLaunchTesthost)
     {
-        Task.Run(
-            () =>
+        Task.Run(() =>
+        {
+            try
             {
-                try
-                {
-                    testRequestManager.ResetOptions();
+                testRequestManager.ResetOptions();
+
+                // We must avoid re-launching the test host if the test run payload already
+                // contains test session info. Test session info being present is an indicative
+                // of an already running test host spawned by a start test session call.
+                var customLauncher =
+                    shouldLaunchTesthost && testRunPayload.TestSessionInfo == null
+                        ? DesignModeTestHostLauncherFactory.GetCustomHostLauncherForTestRun(
+                            this,
+                            testRunPayload.DebuggingEnabled)
+                        : null;
+
+                testRequestManager.RunTests(testRunPayload, customLauncher, new DesignModeTestEventsRegistrar(this), _protocolConfig);
+            }
+            catch (Exception ex)
+            {
+                EqtTrace.Error("DesignModeClient: Exception in StartTestRun: " + ex);
 
-                    // We must avoid re-launching the test host if the test run payload already
-                    // contains test session info. Test session info being present is an indicative
-                    // of an already running test host spawned by a start test session call.
-                    var customLauncher =
-                        shouldLaunchTesthost && testRunPayload.TestSessionInfo == null
-                            ? DesignModeTestHostLauncherFactory.GetCustomHostLauncherForTestRun(
-                                this,
-                                testRunPayload.DebuggingEnabled)
-                            : null;
-
-                    testRequestManager.RunTests(testRunPayload, customLauncher, new DesignModeTestEventsRegistrar(this), _protocolConfig);
-                }
-                catch (Exception ex)
+                var testMessagePayload = new TestMessagePayload { MessageLevel = TestMessageLevel.Error, Message = ex.ToString() };
+                _communicationManager.SendMessage(MessageType.TestMessage, testMessagePayload);
+                var runCompletePayload = new TestRunCompletePayload()
                 {
-                    EqtTrace.Error("DesignModeClient: Exception in StartTestRun: " + ex);
-
-                    var testMessagePayload = new TestMessagePayload { MessageLevel = TestMessageLevel.Error, Message = ex.ToString() };
-                    _communicationManager.SendMessage(MessageType.TestMessage, testMessagePayload);
-                    var runCompletePayload = new TestRunCompletePayload()
-                    {
-                        TestRunCompleteArgs = new TestRunCompleteEventArgs(null, false, true, ex, null, null, TimeSpan.MinValue),
-                        LastRunTests = null
-                    };
+                    TestRunCompleteArgs = new TestRunCompleteEventArgs(null, false, true, ex, null, null, TimeSpan.MinValue),
+                    LastRunTests = null
+                };
 
-                    // Send run complete to translation layer
-                    _communicationManager.SendMessage(MessageType.ExecutionComplete, runCompletePayload);
-                }
-            });
+                // Send run complete to translation layer
+                _communicationManager.SendMessage(MessageType.ExecutionComplete, runCompletePayload);
+            }
+        });
     }
 
     private void StartDiscovery(DiscoveryRequestPayload discoveryRequestPayload, ITestRequestManager testRequestManager)

diff --git a/src/Microsoft.TestPlatform.Client/DesignMode/DesignModeTestEventsRegistrar.cs b/src/Microsoft.TestPlatform.Client/DesignMode/DesignModeTestEventsRegistrar.cs
@@ -2,13 +2,9 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
 using Microsoft.VisualStudio.TestPlatform.Common.Interfaces;
-
 using Microsoft.VisualStudio.TestPlatform.ObjectModel.Client;
-
 using Microsoft.VisualStudio.TestPlatform.ObjectModel.Logging;
 
-#nullable disable
-
 namespace Microsoft.VisualStudio.TestPlatform.Client.DesignMode;
 
 /// <summary>
@@ -62,7 +58,7 @@ private void OnRawMessageReceived(object sender, string rawMessage)
         _designModeClient.SendRawMessage(rawMessage);
     }
 
-    public void LogWarning(string message)
+    public void LogWarning(string? message)
     {
         _designModeClient.SendTestMessage(TestMessageLevel.Warning, message);
     }

diff --git a/src/Microsoft.TestPlatform.Client/DesignMode/DesignModeTestHostLauncher.cs b/src/Microsoft.TestPlatform.Client/DesignMode/DesignModeTestHostLauncher.cs
@@ -7,8 +7,6 @@
 using Microsoft.VisualStudio.TestPlatform.ObjectModel;
 using Microsoft.VisualStudio.TestPlatform.ObjectModel.Client.Interfaces;
 
-#nullable disable
-
 namespace Microsoft.VisualStudio.TestPlatform.Client.DesignMode;
 
 /// <summary>

diff --git a/src/Microsoft.TestPlatform.Client/DesignMode/DesignModeTestHostLauncherFactory.cs b/src/Microsoft.TestPlatform.Client/DesignMode/DesignModeTestHostLauncherFactory.cs
@@ -3,17 +3,15 @@
 
 using Microsoft.VisualStudio.TestPlatform.ObjectModel.Client.Interfaces;
 
-#nullable disable
-
 namespace Microsoft.VisualStudio.TestPlatform.Client.DesignMode;
 
 /// <summary>
 /// Factory for providing the design mode test host launchers
 /// </summary>
 public static class DesignModeTestHostLauncherFactory
 {
-    private static ITestHostLauncher3 s_defaultLauncher;
-    private static ITestHostLauncher3 s_debugLauncher;
+    private static ITestHostLauncher3? s_defaultLauncher;
+    private static ITestHostLauncher3? s_debugLauncher;
 
     public static ITestHostLauncher3 GetCustomHostLauncherForTestRun(IDesignModeClient designModeClient, bool debuggingEnabled)
     {

diff --git a/src/Microsoft.TestPlatform.Client/DesignMode/IDesignModeClient.cs b/src/Microsoft.TestPlatform.Client/DesignMode/IDesignModeClient.cs
@@ -9,8 +9,6 @@
 using Microsoft.VisualStudio.TestPlatform.ObjectModel.Client.Interfaces;
 using Microsoft.VisualStudio.TestPlatform.ObjectModel.Logging;
 
-#nullable disable
-
 namespace Microsoft.VisualStudio.TestPlatform.Client.DesignMode;
 
 /// <summary>
@@ -56,5 +54,5 @@ public interface IDesignModeClient : IDisposable
     /// </summary>
     /// <param name="level">Level for the message</param>
     /// <param name="message">Actual message string</param>
-    void SendTestMessage(TestMessageLevel level, string message);
+    void SendTestMessage(TestMessageLevel level, string? message);
 }