Add IgnoreExitCode to ToolSettings

- When true, then ProcessExitCode method is not called
cake-build · Jul 8, 2020 · d55a15a · d55a15a
1 parent daa3c4f
commit d55a15a
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 1 deletion.
diff --git a/src/Cake.Core.Tests/Unit/Tooling/ToolTests.cs b/src/Cake.Core.Tests/Unit/Tooling/ToolTests.cs
@@ -144,6 +144,21 @@ public void Should_Throw_On_Invalid_ExitCode_Validated_By_Custom_Validator()
                 // Then
                 AssertEx.IsCakeException(result, "UnitTest");
             }
+
+            [Fact]
+            public void Should_Not_Throw_On_Invalid_ExitCode_When_IgnoreExitCode_Is_True()
+            {
+                // Given
+                var fixture = new DummyToolFixture();
+                fixture.Settings.IgnoreExitCode = true;
+                fixture.GivenProcessExitsWithCode(10);
+
+                // When
+                var result = fixture.Run();
+
+                // Then
+                Assert.IsNotType<Exception>(result);
+            }
         }
     }
 }
diff --git a/src/Cake.Core/Tooling/Tool.cs b/src/Cake.Core/Tooling/Tool.cs
@@ -117,7 +117,10 @@ protected void Run(
             // Post action specified?
             postAction?.Invoke(process);
 
-            ProcessExitCode(process.GetExitCode());
+            if (!settings.IgnoreExitCode)
+            {
+                ProcessExitCode(process.GetExitCode());
+            }
         }
 
         /// <summary>
@@ -131,6 +134,7 @@ protected virtual void ProcessExitCode(int exitCode)
             if (exitCode != 0)
             {
                 const string message = "{0}: Process returned an error (exit code {1}).";
+
                 throw new CakeException(string.Format(CultureInfo.InvariantCulture, message, GetToolName(), exitCode));
             }
         }

diff --git a/src/Cake.Core/Tooling/ToolSettings.cs b/src/Cake.Core/Tooling/ToolSettings.cs
@@ -73,5 +73,17 @@ public class ToolSettings
         /// </code>
         /// </example>
         public IDictionary<string, string> EnvironmentVariables { get; set; } = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
+
+        /// <summary>
+        /// Gets or sets a value indicating whether the exit code from the tool process causes an exception to be thrown.
+        /// </summary>
+        /// <example>
+        /// <code>
+        /// DotNetCoreTest("MyProject.csproj", new DotNetCoreTestSettings {
+        ///     IgnoreExitCode = true
+        /// });
+        /// </code>
+        /// </example>
+        public bool IgnoreExitCode { get; set; }
     }
 }