Only print max threads when parallel test collections is on

xunit · Nov 13, 2023 · 6d1bc07 · 6d1bc07
1 parent d300c88
commit 6d1bc07
Show file tree

Hide file tree

Showing 5 changed files with 50 additions and 16 deletions.
diff --git a/src/xunit.runner.utility/Reporters/DefaultRunnerReporterMessageHandler.cs b/src/xunit.runner.utility/Reporters/DefaultRunnerReporterMessageHandler.cs
@@ -230,12 +230,20 @@ protected override bool Visit(ITestAssemblyExecutionStarting executionStarting)
             if (executionStarting.ExecutionOptions.GetDiagnosticMessagesOrDefault())
             {
                 var threadCount = executionStarting.ExecutionOptions.GetMaxParallelThreadsOrDefault();
+                var parallelTestCollections =
+                    executionStarting.ExecutionOptions.GetDisableParallelizationOrDefault()
+                        ? "off"
+                        : string.Format(
+                            CultureInfo.CurrentCulture,
+                            "on [{0} thread{1}]",
+                            threadCount < 0 ? "unlimited" : threadCount.ToString(CultureInfo.CurrentCulture),
+                            threadCount == 1 ? string.Empty : "s"
+                        );
 
                 Logger.LogImportantMessage(
-                    "  Starting:    {0} (parallel test collections = {1}, max threads = {2}, stop on fail = {3})",
+                    "  Starting:    {0} (parallel test collections = {1}, stop on fail = {2})",
                     assemblyDisplayName,
-                    !executionStarting.ExecutionOptions.GetDisableParallelizationOrDefault() ? "on" : "off",
-                    threadCount < 0 ? "unlimited" : threadCount.ToString(CultureInfo.CurrentCulture),
+                    parallelTestCollections,
                     executionStarting.ExecutionOptions.GetStopOnTestFailOrDefault() ? "on" : "off"
                 );
             }

diff --git a/src/xunit.runner.utility/Reporters/DefaultRunnerReporterWithTypesMessageHandler.cs b/src/xunit.runner.utility/Reporters/DefaultRunnerReporterWithTypesMessageHandler.cs
@@ -252,12 +252,20 @@ protected virtual void HandleTestAssemblyExecutionStarting(MessageHandlerArgs<IT
             if (executionStarting.ExecutionOptions.GetDiagnosticMessagesOrDefault())
             {
                 var threadCount = executionStarting.ExecutionOptions.GetMaxParallelThreadsOrDefault();
+                var parallelTestCollections =
+                    executionStarting.ExecutionOptions.GetDisableParallelizationOrDefault()
+                        ? "off"
+                        : string.Format(
+                            CultureInfo.CurrentCulture,
+                            "on [{0} thread{1}]",
+                            threadCount < 0 ? "unlimited" : threadCount.ToString(CultureInfo.CurrentCulture),
+                            threadCount == 1 ? string.Empty : "s"
+                        );
 
                 Logger.LogImportantMessage(
-                    "  Starting:    {0} (parallel test collections = {1}, max threads = {2}, stop on fail = {3})",
+                    "  Starting:    {0} (parallel test collections = {1}, stop on fail = {2})",
                     assemblyDisplayName,
-                    !executionStarting.ExecutionOptions.GetDisableParallelizationOrDefault() ? "on" : "off",
-                    threadCount < 0 ? "unlimited" : threadCount.ToString(CultureInfo.CurrentCulture),
+                    parallelTestCollections,
                     executionStarting.ExecutionOptions.GetStopOnTestFailOrDefault() ? "on" : "off"
                 );
             }

diff --git a/test/test.utility/TestDoubles/Mocks.cs b/test/test.utility/TestDoubles/Mocks.cs
@@ -247,10 +247,10 @@ public static ITestAssemblyExecutionFinished TestAssemblyExecutionFinished(bool
         return result;
     }
 
-    public static ITestAssemblyExecutionStarting TestAssemblyExecutionStarting(bool diagnosticMessages = false, string assemblyFilename = null)
+    public static ITestAssemblyExecutionStarting TestAssemblyExecutionStarting(bool diagnosticMessages = false, string assemblyFilename = null, bool? parallelizeTestCollections = null, int maxParallelThreads = 42, bool? stopOnFail = null)
     {
         var assembly = new XunitProjectAssembly { AssemblyFilename = assemblyFilename ?? "testAssembly.dll", ConfigFilename = "testAssembly.dll.config" };
-        var config = new TestAssemblyConfiguration { DiagnosticMessages = diagnosticMessages, MethodDisplay = Xunit.TestMethodDisplay.ClassAndMethod, MaxParallelThreads = 42, ParallelizeTestCollections = true, ShadowCopy = true, StopOnFail = true };
+        var config = new TestAssemblyConfiguration { DiagnosticMessages = diagnosticMessages, MethodDisplay = Xunit.TestMethodDisplay.ClassAndMethod, MaxParallelThreads = maxParallelThreads, ParallelizeTestCollections = parallelizeTestCollections, ShadowCopy = true, StopOnFail = stopOnFail };
         var result = Substitute.For<ITestAssemblyExecutionStarting, InterfaceProxy<ITestAssemblyExecutionStarting>>();
         result.Assembly.Returns(assembly);
         result.ExecutionOptions.Returns(TestFrameworkOptions.ForExecution(config));

diff --git a/test/test.xunit.runner.utility/Extensibility/DefaultRunnerReporterMessageHandlerTests.cs b/test/test.xunit.runner.utility/Extensibility/DefaultRunnerReporterMessageHandlerTests.cs
@@ -150,11 +150,20 @@ public static void LogsMessage()
     public class OnMessage_ITestAssemblyExecutionStarting
     {
         [Theory]
-        [InlineData(false, "[Imp] =>   Starting:    testAssembly")]
-        [InlineData(true, "[Imp] =>   Starting:    testAssembly (parallel test collections = on, max threads = 42, stop on fail = on)")]
-        public static void LogsMessage(bool diagnosticMessages, string expectedResult)
+        [InlineData(false, null, null, null, "[Imp] =>   Starting:    testAssembly")]
+        [InlineData(true, false, null, null, "[Imp] =>   Starting:    testAssembly (parallel test collections = off, stop on fail = off)")]
+        [InlineData(true, null, -1, null, "[Imp] =>   Starting:    testAssembly (parallel test collections = on [unlimited threads], stop on fail = off)")]
+        [InlineData(true, null, 1, null, "[Imp] =>   Starting:    testAssembly (parallel test collections = on [1 thread], stop on fail = off)")]
+        [InlineData(true, null, null, true, "[Imp] =>   Starting:    testAssembly (parallel test collections = on [42 threads], stop on fail = on)")]
+        [InlineData(true, null, null, null, "[Imp] =>   Starting:    testAssembly (parallel test collections = on [42 threads], stop on fail = off)")]
+        public static void LogsMessage(bool diagnosticMessages, bool? parallelizeTestCollections, int? maxThreads, bool? stopOnFail, string expectedResult)
         {
-            var message = Mocks.TestAssemblyExecutionStarting(diagnosticMessages: diagnosticMessages);
+            var message = Mocks.TestAssemblyExecutionStarting(
+                diagnosticMessages: diagnosticMessages,
+                parallelizeTestCollections: parallelizeTestCollections,
+                maxParallelThreads: maxThreads ?? 42,
+                stopOnFail: stopOnFail
+            );
             var handler = TestableDefaultRunnerReporterMessageHandler.Create();
 
             handler.OnMessage(message);

diff --git a/...t.xunit.runner.utility/Extensibility/DefaultRunnerReporterWithTypesMessageHandlerTests.cs b/...t.xunit.runner.utility/Extensibility/DefaultRunnerReporterWithTypesMessageHandlerTests.cs
@@ -148,11 +148,20 @@ public static void LogsMessage()
     public class OnMessage_ITestAssemblyExecutionStarting
     {
         [Theory]
-        [InlineData(false, "[Imp] =>   Starting:    testAssembly")]
-        [InlineData(true, "[Imp] =>   Starting:    testAssembly (parallel test collections = on, max threads = 42, stop on fail = on)")]
-        public static void LogsMessage(bool diagnosticMessages, string expectedResult)
+        [InlineData(false, null, null, null, "[Imp] =>   Starting:    testAssembly")]
+        [InlineData(true, false, null, null, "[Imp] =>   Starting:    testAssembly (parallel test collections = off, stop on fail = off)")]
+        [InlineData(true, null, -1, null, "[Imp] =>   Starting:    testAssembly (parallel test collections = on [unlimited threads], stop on fail = off)")]
+        [InlineData(true, null, 1, null, "[Imp] =>   Starting:    testAssembly (parallel test collections = on [1 thread], stop on fail = off)")]
+        [InlineData(true, null, null, true, "[Imp] =>   Starting:    testAssembly (parallel test collections = on [42 threads], stop on fail = on)")]
+        [InlineData(true, null, null, null, "[Imp] =>   Starting:    testAssembly (parallel test collections = on [42 threads], stop on fail = off)")]
+        public static void LogsMessage(bool diagnosticMessages, bool? parallelizeTestCollections, int? maxThreads, bool? stopOnFail, string expectedResult)
         {
-            var message = Mocks.TestAssemblyExecutionStarting(diagnosticMessages: diagnosticMessages);
+            var message = Mocks.TestAssemblyExecutionStarting(
+                diagnosticMessages: diagnosticMessages,
+                parallelizeTestCollections: parallelizeTestCollections,
+                maxParallelThreads: maxThreads ?? 42,
+                stopOnFail: stopOnFail
+            );
             var handler = TestableDefaultRunnerReporterWithTypesMessageHandler.Create();
 
             handler.OnMessageWithTypes(message, null);