Prevent unnecessary progress indicator refresh (#2024)

The progress indicator is repeatedly refreshing, even in situations when a log message will not be output, e.g. when the verbosity level is not high enough.
microsoft · May 28, 2019 · c33a84f · c33a84f
1 parent 402060b
commit c33a84f
Showing 1 changed file with 46 additions and 12 deletions.
diff --git a/src/vstest.console/Internal/ConsoleLogger.cs b/src/vstest.console/Internal/ConsoleLogger.cs
@@ -366,9 +366,6 @@ private void TestMessageHandler(object sender, TestRunMessageEventArgs e)
             ValidateArg.NotNull<object>(sender, "sender");
             ValidateArg.NotNull<TestRunMessageEventArgs>(e, "e");
 
-            // Pause the progress indicator to print the message
-            this.progressIndicator?.Pause();
-
             switch (e.Level)
             {
                 case TestMessageLevel.Informational:
@@ -378,7 +375,14 @@ private void TestMessageHandler(object sender, TestRunMessageEventArgs e)
                             break;
                         }
 
+                        // Pause the progress indicator to print the message
+                        this.progressIndicator?.Pause();
+
                         Output.Information(AppendPrefix, e.Message);
+
+                        // Resume the progress indicator after printing the message
+                        this.progressIndicator?.Start();
+
                         break;
                     }
 
@@ -389,23 +393,34 @@ private void TestMessageHandler(object sender, TestRunMessageEventArgs e)
                             break;
                         }
 
+                        // Pause the progress indicator to print the message
+                        this.progressIndicator?.Pause();
+
                         Output.Warning(AppendPrefix, e.Message);
+
+                        // Resume the progress indicator after printing the message
+                        this.progressIndicator?.Start();
+
                         break;
                     }
 
                 case TestMessageLevel.Error:
                     {
+                        // Pause the progress indicator to print the message
+                        this.progressIndicator?.Pause();
+
                         this.testRunHasErrorMessages = true;
                         Output.Error(AppendPrefix, e.Message);
+
+                        // Resume the progress indicator after printing the message
+                        this.progressIndicator?.Start();
+
                         break;
                     }
                 default:
                     EqtTrace.Warning("ConsoleLogger.TestMessageHandler: The test message level is unrecognized: {0}", e.Level.ToString());
                     break;
             }
-
-            // Resume the progress indicator after printing the message
-            this.progressIndicator?.Start();
         }
 
         /// <summary>
@@ -416,9 +431,6 @@ private void TestResultHandler(object sender, TestResultEventArgs e)
             ValidateArg.NotNull<object>(sender, "sender");
             ValidateArg.NotNull<TestResultEventArgs>(e, "e");
 
-            // Pause the progress indicator before displaying test result information
-            this.progressIndicator?.Pause();
-
             // Update the test count statistics based on the result of the test. 
             this.testsTotal++;
 
@@ -445,13 +457,19 @@ private void TestResultHandler(object sender, TestResultEventArgs e)
                             break;
                         }
 
+                        // Pause the progress indicator before displaying test result information
+                        this.progressIndicator?.Pause();
+
                         Output.Write(string.Format("{0}{1} ", TestResultPrefix, SkippedTestIndicator), OutputLevel.Information, ConsoleColor.Yellow);
                         Output.WriteLine(testDisplayName, OutputLevel.Information);
                         if (this.verbosityLevel == Verbosity.Detailed)
                         {
                             DisplayFullInformation(e.Result);
                         }
 
+                        // Resume the progress indicator after displaying the test result information
+                        this.progressIndicator?.Start();
+
                         break;
                     }
 
@@ -463,9 +481,16 @@ private void TestResultHandler(object sender, TestResultEventArgs e)
                             break;
                         }
 
+                        // Pause the progress indicator before displaying test result information
+                        this.progressIndicator?.Pause();
+
                         Output.Write(string.Format("{0}{1} ", TestResultPrefix, FailedTestIndicator), OutputLevel.Information, ConsoleColor.Red);
                         Output.WriteLine(testDisplayName, OutputLevel.Information);
                         DisplayFullInformation(e.Result);
+
+                        // Resume the progress indicator after displaying the test result information
+                        this.progressIndicator?.Start();
+
                         break;
                     }
 
@@ -474,12 +499,18 @@ private void TestResultHandler(object sender, TestResultEventArgs e)
                         this.testsPassed++;
                         if (this.verbosityLevel == Verbosity.Normal || this.verbosityLevel == Verbosity.Detailed)
                         {
+                            // Pause the progress indicator before displaying test result information
+                            this.progressIndicator?.Pause();
+
                             Output.Write(string.Format("{0}{1} ", TestResultPrefix, PassedTestIndicator), OutputLevel.Information, ConsoleColor.Green);
                             Output.WriteLine(testDisplayName, OutputLevel.Information);
                             if (this.verbosityLevel == Verbosity.Detailed)
                             {
                                 DisplayFullInformation(e.Result);
                             }
+
+                            // Resume the progress indicator after displaying the test result information
+                            this.progressIndicator?.Start();
                         }
 
                         break;
@@ -492,19 +523,22 @@ private void TestResultHandler(object sender, TestResultEventArgs e)
                             break;
                         }
 
+                        // Pause the progress indicator before displaying test result information
+                        this.progressIndicator?.Pause();
+
                         Output.Write(string.Format("{0}{1} ", TestResultPrefix, SkippedTestIndicator), OutputLevel.Information, ConsoleColor.Yellow);
                         Output.WriteLine(testDisplayName, OutputLevel.Information);
                         if (this.verbosityLevel == Verbosity.Detailed)
                         {
                             DisplayFullInformation(e.Result);
                         }
 
+                        // Resume the progress indicator after displaying the test result information
+                        this.progressIndicator?.Start();
+
                         break;
                     }
             }
-
-            // Resume the progress indicator after displaying the test result information 
-            this.progressIndicator?.Start();
         }
 
         private string GetFormattedDurationString(TimeSpan duration)