Add TraceWriter Stuff

Author: JustinGrote

test/PowerShellEditorServices.Test.E2E/DebugAdapterProtocolMessageTests.cs

@@ -2,6 +2,7 @@
 // Licensed under the MIT License.
 
 using System;
+using System.Diagnostics;
 using System.IO;
 using System.Linq;
 using System.Runtime.InteropServices;
@@ -11,6 +12,7 @@
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Logging.Debug;
 using OmniSharp.Extensions.DebugAdapter.Client;
+using DapStackFrame = OmniSharp.Extensions.DebugAdapter.Protocol.Models.StackFrame;
 using OmniSharp.Extensions.DebugAdapter.Protocol.Events;
 using OmniSharp.Extensions.DebugAdapter.Protocol.Models;
 using OmniSharp.Extensions.DebugAdapter.Protocol.Requests;
@@ -20,6 +22,12 @@
 
 namespace PowerShellEditorServices.Test.E2E
 {
+    public class XunitOutputTraceListener(ITestOutputHelper output) : TraceListener
+    {
+        public override void Write(string message) => output.WriteLine(message);
+        public override void WriteLine(string message) => output.WriteLine(message);
+    }
+
     [Trait("Category", "DAP")]
     public class DebugAdapterProtocolMessageTests : IAsyncLifetime, IDisposable
     {
@@ -38,13 +46,20 @@ public class DebugAdapterProtocolMessageTests : IAsyncLifetime, IDisposable
         /// Completes when the first breakpoint is reached.
         /// </summary>
         public TaskCompletionSource<StoppedEvent> Stopped { get; } = new TaskCompletionSource<StoppedEvent>();
+
+        /// <summary>
+        /// Constructor. The ITestOutputHelper is injected by xUnit and used to write diagnostic logs.
+        /// </summary>
+        /// <param name="output"></param>
         public DebugAdapterProtocolMessageTests(ITestOutputHelper output) => _output = output;
 
         public async Task InitializeAsync()
         {
             LoggerFactory debugLoggerFactory = new();
             debugLoggerFactory.AddProvider(new DebugLoggerProvider());
 
+            // NOTE: To see debug logger output, add this line to your test
+
             _psesProcess = new PsesStdioProcess(debugLoggerFactory, true);
             await _psesProcess.Start();
 
@@ -308,7 +323,7 @@ await Assert.ThrowsAsync<JsonRpcException>(() => PsesDebugAdapterClient.RequestS
         }
 
         [SkippableFact]
-        public async Task SendsInitialLabelBreakpointForPerformanceReasons()
+        public async Task SendsInitialLabelBreakpointForPerformanceReasons(ITestOutputHelper output)
         {
             Skip.If(PsesStdioProcess.RunningInConstrainedLanguageMode,
                 "Breakpoints can't be set in Constrained Language Mode.");
@@ -318,6 +333,9 @@ public async Task SendsInitialLabelBreakpointForPerformanceReasons()
                 "after breakpoint"
             ));
 
+            // Enables DAP messages to be written to the test output
+            Trace.Listeners.Add(new XunitOutputTraceListener(_output));
+
             //TODO: This is technically wrong per the spec, configDone should be completed BEFORE launching, but this is how the vscode client does it today and we really need to fix that.
             await PsesDebugAdapterClient.LaunchScript(filePath, Started);
 
@@ -348,7 +366,7 @@ public async Task SendsInitialLabelBreakpointForPerformanceReasons()
             StackTraceResponse stackTraceResponse = await PsesDebugAdapterClient.RequestStackTrace(
                 new StackTraceArguments { ThreadId = 1 }
             );
-            StackFrame firstFrame = stackTraceResponse.StackFrames.First();
+            DapStackFrame firstFrame = stackTraceResponse.StackFrames.First();
             Assert.Equal(
                 firstFrame.PresentationHint,
                 StackFramePresentationHint.Label