Improve logging for host process tests

This change adds a new /logPath parameter to the host process which is
used to provide unique log paths for host process tests.  These new log
paths will help diagnose issues with individual tests, especially when
running on AppVeyor.

Author: daviwil

src/PowerShellEditorServices.Host/Program.cs

@@ -40,6 +40,19 @@ static void Main(string[] args)
             }
 #endif
 
+            string logPath = null;
+            string logPathArgument =
+                args.FirstOrDefault(
+                    arg => 
+                        arg.StartsWith(
+                            "/logPath:",
+                            StringComparison.InvariantCultureIgnoreCase));
+
+            if (!string.IsNullOrEmpty(logPathArgument))
+            {
+                logPath = logPathArgument.Substring(9).Trim('"');
+            }
+
             bool runDebugAdapter =
                 args.Any(
                     arg => 
@@ -51,34 +64,29 @@ static void Main(string[] args)
             // Catch unhandled exceptions for logging purposes
             AppDomain.CurrentDomain.UnhandledException += CurrentDomain_UnhandledException;
 
-            if (runDebugAdapter)
-            {
-                // TODO: Remove this behavior in the near future --
-                //   Create the debug service log in a separate file
-                //   so that there isn't a conflict with the default 
-                //   log file.
-                Logger.Initialize("DebugAdapter.log", LogLevel.Verbose);
-            }
-            else
-            {
-                // Initialize the logger
-                // TODO: Set the level based on command line parameter
-                Logger.Initialize(minimumLogLevel: LogLevel.Verbose);
-            }
-
-            Logger.Write(LogLevel.Normal, "PowerShell Editor Services Host started!");
-
             ProtocolServer server = null;
             if (runDebugAdapter)
             {
+                logPath = logPath ?? "DebugAdapter.log";
                 server = new DebugAdapter();
             }
             else
             {
+                logPath = logPath ?? "EditorServices.log";
                 server = new LanguageServer();
             }
 
+            // Start the logger with the specified log path
+            // TODO: Set the level based on command line parameter
+            Logger.Initialize(logPath, LogLevel.Verbose);
+
+            Logger.Write(LogLevel.Normal, "PowerShell Editor Services Host starting...");
+
+            // Start the server
             server.Start();
+            Logger.Write(LogLevel.Normal, "PowerShell Editor Services Host started!");
+
+            // Wait for the server to finish
             server.WaitForExit();
 
             Logger.Write(LogLevel.Normal, "PowerShell Editor Services Host exited normally.");

src/PowerShellEditorServices/Utility/Logger.cs

@@ -185,6 +185,11 @@ private bool TryOpenLogFile(
         {
             try
             {
+                // Make sure the log directory exists
+                Directory.CreateDirectory(
+                    Path.GetDirectoryName(
+                        logFilePath));
+
                 // Open the log file for writing with UTF8 encoding
                 this.textWriter =
                     new StreamWriter(

test/PowerShellEditorServices.Test.Host/DebugAdapterTests.cs

@@ -7,9 +7,12 @@
 using Microsoft.PowerShell.EditorServices.Protocol.DebugAdapter;
 using Microsoft.PowerShell.EditorServices.Protocol.MessageProtocol;
 using Microsoft.PowerShell.EditorServices.Protocol.MessageProtocol.Channel;
+using System;
 using System.IO;
 using System.Threading.Tasks;
 using Xunit;
+using Xunit.Abstractions;
+using Xunit.Sdk;
 
 namespace Microsoft.PowerShell.EditorServices.Test.Host
 {
@@ -21,11 +24,21 @@ public class DebugAdapterTests : IAsyncLifetime
 
         public Task InitializeAsync()
         {
+            string testLogPath =
+                Path.Combine(
+                    AppDomain.CurrentDomain.BaseDirectory,
+                    "logs",
+                    this.GetType().Name,
+                    Guid.NewGuid().ToString().Substring(0, 8) + ".log");
+
+            Console.WriteLine("        Output log at path: {0}", testLogPath);
+
             this.debugAdapterClient =
                 new DebugAdapterClient(
                     new StdioClientChannel(
                         "Microsoft.PowerShell.EditorServices.Host.exe",
-                        "/debugAdapter"));
+                        "/debugAdapter",
+                        "/logPath:\"" + testLogPath + "\""));
 
             return this.debugAdapterClient.Start();
         }

test/PowerShellEditorServices.Test.Host/LanguageServerTests.cs

@@ -13,6 +13,7 @@
 using System.Linq;
 using System.Threading.Tasks;
 using Xunit;
+using Xunit.Abstractions;
 
 namespace Microsoft.PowerShell.EditorServices.Test.Host
 {
@@ -22,10 +23,20 @@ public class LanguageServerTests : IAsyncLifetime
 
         public Task InitializeAsync()
         {
+            string testLogPath =
+                Path.Combine(
+                    AppDomain.CurrentDomain.BaseDirectory,
+                    "logs",
+                    this.GetType().Name,
+                    Guid.NewGuid().ToString().Substring(0, 8) + ".log");
+
+            Console.WriteLine("        Output log at path: {0}", testLogPath);
+
             this.languageServiceClient =
                 new LanguageServiceClient(
                     new StdioClientChannel(
-                        "Microsoft.PowerShell.EditorServices.Host.exe"));
+                        "Microsoft.PowerShell.EditorServices.Host.exe",
+                        "/logPath:\"" + testLogPath + "\""));
 
             return this.languageServiceClient.Start();
         }