Do not wait on std{out,err} when a test times out.
authorPat Gavlin <pagavlin@microsoft.com>
Tue, 14 Mar 2017 17:05:26 +0000 (10:05 -0700)
committerPat Gavlin <pagavlin@microsoft.com>
Tue, 14 Mar 2017 17:25:14 +0000 (10:25 -0700)
The test wrapper currently waits on each of the process, stdout copy,
and stderr copy in turn. This makes it difficult to determine whether
or not the test did in fact time out, as the time in which it may
write to its output streams is effectively twice or thrice the
time used to determine success or failure (i.e. the process wait
timeout). This can cause situations like what we've seen in dotnet/coreclr#10076,
where the harness reports that the process timed out but the test's
output indicates a successful run.

This change only waits on stdout/stderr if the process completes within
the time allotted; otherwise it cancels the copies and promptly reports
the timeout.

Commit migrated from https://github.com/dotnet/coreclr/commit/bd7a88958776655867a4af3184dfef317f33839d

src/coreclr/tests/src/Common/Coreclr.TestWrapper/CoreclrTestWrapperLib.cs

index ddb9050..5c04827 100644 (file)
@@ -71,23 +71,27 @@ namespace CoreclrTestLib
 
                 process.Start();
 
-                Task copyOutput = process.StandardOutput.BaseStream.CopyToAsync(outputStream);
-                Task copyError = process.StandardError.BaseStream.CopyToAsync(errorStream);
+                var cts = new CancellationTokenSource();
+                Task copyOutput = process.StandardOutput.BaseStream.CopyToAsync(outputStream, 4096, cts.Token);
+                Task copyError = process.StandardError.BaseStream.CopyToAsync(errorStream, 4096, cts.Token);
 
-                bool completed = process.WaitForExit(timeout);
-                copyOutput.Wait(timeout);
-                copyError.Wait(timeout);
-
-                if (completed)
+                if (process.WaitForExit(timeout))
                 {
                     // Process completed. Check process.ExitCode here.
                     exitCode = process.ExitCode;
+                    Task.WaitAll(copyOutput, copyError);
                 }
                 else
                 {
                     // Timed out.
-                    outputWriter.WriteLine("cmdLine:" + executable + " Timed Out");
-                    errorWriter.WriteLine("cmdLine:" + executable + " Timed Out");
+                    try
+                    {
+                        cts.Cancel();
+                    }
+                    catch {}
+
+                    outputWriter.WriteLine("\ncmdLine:" + executable + " Timed Out");
+                    errorWriter.WriteLine("\ncmdLine:" + executable + " Timed Out");
                 }
 
                outputWriter.WriteLine("Test Harness Exitcode is : " + exitCode.ToString());