Simpler fix for dotnet test when using retry by @Youssef1313 in #5731 (backport to rel/3.9) (#5732)

Co-authored-by: Youssef1313 <[email protected]>

Author: youssef-backport-bot

src/Platform/Microsoft.Testing.Platform.MSBuild/Tasks/InvokeTestingPlatformTask.cs

@@ -40,7 +40,6 @@ public class InvokeTestingPlatformTask : Build.Utilities.ToolTask, IDisposable
     private Task? _connectionLoopTask;
     private ModuleInfoRequest? _moduleInfo;
     private string? _outputFileName;
-    private StreamWriter? _outputFileStream;
     private string? _toolCommand;
 
     /// <summary>
@@ -373,15 +372,15 @@ public override bool Execute()
         bool returnValue = base.Execute();
         if (_toolCommand is not null)
         {
-            StringBuilder sb = new();
-            sb.AppendLine();
-            sb.AppendLine("=== COMMAND LINE ===");
-            sb.AppendLine(_toolCommand);
-            _output.AppendLine(sb.ToString());
+            _output.AppendLine();
+            _output.AppendLine("=== COMMAND LINE ===");
+            _output.AppendLine(_toolCommand);
         }
 
-        // Persist the output to the file.
-        _outputFileStream?.WriteLine(_output);
+        if (_outputFileName is not null)
+        {
+            _fileSystem.WriteAllText(_outputFileName, _output.ToString());
+        }
 
         _waitForConnections.Cancel();
         Dispose();
@@ -419,10 +418,6 @@ protected override bool HandleTaskExecutionErrors()
                 _fileSystem.CreateDirectory(_outputFileName);
                 _outputFileName = Path.Combine(_outputFileName, $"{Path.GetFileNameWithoutExtension(TargetPath.ItemSpec.Trim())}_{TargetFramework.ItemSpec}_{TestArchitecture.ItemSpec}.log");
                 Log.LogMessage(MessageImportance.Low, $"Invalid command line exit code and empty output file name, creating default one '{_outputFileName}'");
-                _outputFileStream = new StreamWriter(_fileSystem.CreateNew(_outputFileName), Encoding.Unicode)
-                {
-                    AutoFlush = true,
-                };
             }
 
             Log.LogError(null, "run failed", null, TargetPath.ItemSpec.Trim(), 0, 0, 0, 0, Resources.MSBuildResources.TestFailed, _outputFileName, TargetFramework.ItemSpec, TestArchitecture.ItemSpec);
@@ -445,10 +440,6 @@ private Task<IResponse> HandleRequestAsync(IRequest request)
                         _outputFileName = $"{Path.GetFileNameWithoutExtension(TargetPath.ItemSpec.Trim())}_{TargetFramework.ItemSpec}_{TestArchitecture.ItemSpec}.log";
                         _outputFileName = Path.Combine(_moduleInfo.TestResultFolder, _outputFileName);
                         Log.LogMessage(MessageImportance.Low, $"Initializing module info and output file '{_outputFileName}'");
-                        _outputFileStream = new StreamWriter(_fileSystem.CreateNew(_outputFileName), Encoding.Unicode)
-                        {
-                            AutoFlush = true,
-                        };
                     }
                 }
             }
@@ -530,7 +521,6 @@ public void Log<TState>(LogLevel logLevel, TState state, Exception? exception, F
     /// <inheritdoc />
     public void Dispose()
     {
-        _outputFileStream?.Dispose();
         _waitForConnections.Cancel();
         _connectionLoopTask?.Wait();
 

test/IntegrationTests/Microsoft.Testing.Platform.Acceptance.IntegrationTests/RetryFailedTestsTests.cs

@@ -180,6 +180,30 @@ await RetryHelper.RetryAsync(
             }, 3, TimeSpan.FromSeconds(5));
     }
 
+    [TestMethod]
+    public async Task RetryFailedTests_PassingFromFirstTime_UsingOldDotnetTest_MoveFiles_Succeeds()
+    {
+        string resultDirectory = Path.Combine(AssetFixture.TargetAssetPath, Guid.NewGuid().ToString("N"));
+
+        DotnetMuxerResult result = await DotnetCli.RunAsync(
+            $"test \"{AssetFixture.TargetAssetPath}\" -- --retry-failed-tests 1 --results-directory \"{resultDirectory}\"",
+            AcceptanceFixture.NuGetGlobalPackagesFolder.Path,
+            workingDirectory: AssetFixture.TargetAssetPath);
+
+        Assert.AreEqual(ExitCodes.Success, result.ExitCode);
+
+        string[] logFilesFromInvokeTestingPlatformTask = Directory.GetFiles(resultDirectory, "RetryFailedTests_*_*.log", SearchOption.AllDirectories);
+        Assert.AreEqual(TargetFrameworks.All.Length, logFilesFromInvokeTestingPlatformTask.Length);
+        foreach (string logFile in logFilesFromInvokeTestingPlatformTask)
+        {
+            string logFileContents = File.ReadAllText(logFile);
+            Assert.Contains("Test run summary: Passed!", logFileContents);
+            Assert.Contains("total: 3", logFileContents);
+            Assert.Contains("succeeded: 3", logFileContents);
+            Assert.Contains("Tests suite completed successfully in 1 attempts", logFileContents);
+        }
+    }
+
     public sealed class TestAssetFixture() : TestAssetFixtureBase(AcceptanceFixture.NuGetGlobalPackagesFolder)
     {
         public string TargetAssetPath => GetAssetPath(AssetName);
@@ -202,21 +226,30 @@ public sealed class TestAssetFixture() : TestAssetFixtureBase(AcceptanceFixture.
         <OutputType>Exe</OutputType>
         <UseAppHost>true</UseAppHost>
         <LangVersion>preview</LangVersion>
+        <GenerateTestingPlatformEntryPoint>false</GenerateTestingPlatformEntryPoint>
+        <TestingPlatformDotnetTestSupport>true</TestingPlatformDotnetTestSupport>
+        <TestingPlatformCaptureOutput>false</TestingPlatformCaptureOutput>
     </PropertyGroup>
     <ItemGroup>
         <PackageReference Include="Microsoft.Testing.Extensions.CrashDump" Version="$MicrosoftTestingPlatformVersion$" />
         <PackageReference Include="Microsoft.Testing.Extensions.Retry" Version="$MicrosoftTestingPlatformVersion$" />
         <PackageReference Include="Microsoft.Testing.Extensions.TrxReport" Version="$MicrosoftTestingPlatformVersion$" />
+        <PackageReference Include="Microsoft.Testing.Platform.MSBuild" Version="$MicrosoftTestingPlatformVersion$" />
     </ItemGroup>
 </Project>
 
+#file dotnet.config
+[dotnet.test.runner]
+name= "VSTest"
+
 #file Program.cs
 using Microsoft.Testing.Extensions;
 using Microsoft.Testing.Extensions.TrxReport.Abstractions;
 using Microsoft.Testing.Platform.Builder;
 using Microsoft.Testing.Platform.Capabilities.TestFramework;
 using Microsoft.Testing.Platform.Extensions.Messages;
 using Microsoft.Testing.Platform.Extensions.TestFramework;
+using Microsoft.Testing.Platform.MSBuild;
 using Microsoft.Testing.Platform.Services;
 
 public class Program
@@ -230,6 +263,7 @@ public static async Task<int> Main(string[] args)
         builder.AddCrashDumpProvider();
         builder.AddTrxReportProvider();
         builder.AddRetryProvider();
+        builder.AddMSBuild();
         using ITestApplication app = await builder.BuildAsync();
         return await app.RunAsync();
     }
@@ -270,7 +304,7 @@ public async Task ExecuteRequestAsync(ExecuteRequestContext context)
         string resultDir = Environment.GetEnvironmentVariable("RESULTDIR")!; 
         bool crash = Environment.GetEnvironmentVariable("CRASH") == "1";
 
-        if (await TestMethod1(fail, resultDir, crash))
+        if (TestMethod1(fail, resultDir, crash))
         {
             await context.MessageBus.PublishAsync(this, new TestNodeUpdateMessage(context.Request.Session.SessionUid,
                 new TestNode() { Uid = "1", DisplayName = "TestMethod1", Properties = new(PassedTestNodeStateProperty.CachedInstance) }));
@@ -281,7 +315,7 @@ public async Task ExecuteRequestAsync(ExecuteRequestContext context)
                 new TestNode() { Uid = "1", DisplayName = "TestMethod1", Properties = new(new FailedTestNodeStateProperty()) }));
         }
 
-        if (await TestMethod2(fail, resultDir))
+        if (TestMethod2(fail, resultDir))
         {
             await context.MessageBus.PublishAsync(this, new TestNodeUpdateMessage(context.Request.Session.SessionUid,
                 new TestNode() { Uid = "2", DisplayName = "TestMethod2", Properties = new(PassedTestNodeStateProperty.CachedInstance) }));
@@ -292,7 +326,7 @@ public async Task ExecuteRequestAsync(ExecuteRequestContext context)
                 new TestNode() { Uid = "2", DisplayName = "TestMethod2", Properties = new(new FailedTestNodeStateProperty()) }));
         }
 
-        if (await TestMethod3(fail, resultDir))
+        if (TestMethod3(fail, resultDir))
         {
             await context.MessageBus.PublishAsync(this, new TestNodeUpdateMessage(context.Request.Session.SessionUid,
                 new TestNode() { Uid = "3", DisplayName = "TestMethod3", Properties = new(PassedTestNodeStateProperty.CachedInstance) }));
@@ -306,7 +340,7 @@ public async Task ExecuteRequestAsync(ExecuteRequestContext context)
         context.Complete();
     }
 
-    private async Task<bool> TestMethod1(bool fail, string resultDir, bool crash)
+    private bool TestMethod1(bool fail, string resultDir, bool crash)
     {
         if (crash)
         {
@@ -330,7 +364,7 @@ private async Task<bool> TestMethod1(bool fail, string resultDir, bool crash)
         return assert;        
     }
 
-    private async Task<bool> TestMethod2(bool fail, string resultDir)
+    private bool TestMethod2(bool fail, string resultDir)
     {
         bool envVar = Environment.GetEnvironmentVariable("METHOD2") is null;
         System.Console.WriteLine("envVar " + envVar);
@@ -350,7 +384,7 @@ private async Task<bool> TestMethod2(bool fail, string resultDir)
         return assert;
     }
 
-    private async Task<bool> TestMethod3(bool fail, string resultDir)
+    private bool TestMethod3(bool fail, string resultDir)
     {
         bool envVar = Environment.GetEnvironmentVariable("METHOD3") is null;