#368: Added DoNotFailOnExitCodes to allow tolerating specific non-zero exit codes

Author: KevinLang2

src/FlubuCore.WebApi.Tests/FlubuCore.WebApi.Tests.csproj

@@ -29,6 +29,7 @@
   <ItemGroup>
     <ProjectReference Include="..\FlubuCore.WebApi.Client\FlubuCore.WebApi.Client.csproj" />
     <ProjectReference Include="..\FlubuCore.WebApi.Model\FlubuCore.WebApi.Model.csproj" />
+    <ProjectReference Include="..\FlubuCore.WebApi\FlubuCore.WebApi.csproj" />
   </ItemGroup>
 
   <ItemGroup>

src/FlubuCore/Tasks/Process/ExternalProcessTaskBase.cs

@@ -19,6 +19,8 @@ public abstract class ExternalProcessTaskBase<TResult, TTask> : TaskBase<TResult
 
         private char _additionalOptionKeyValueSeperator;
 
+        private int[] _doNotFailOnExitCodes;
+
         private IRunProgramTask _task;
 
         protected ExternalProcessTaskBase()
@@ -242,6 +244,18 @@ public TTask CaptureErrorOutput()
             return this as TTask;
         }
 
+        /// <summary>
+        /// Specifies non-zero exit codes that should not cause the task to fail.
+        /// By default any non-zero exit code fails the task.
+        /// </summary>
+        /// <param name="exitCodes">Exit codes that indicate success.</param>
+        /// <returns></returns>
+        public TTask DoNotFailOnExitCodes(params int[] exitCodes)
+        {
+            _doNotFailOnExitCodes = exitCodes;
+            return this as TTask;
+        }
+
         public TTask ChangeDefaultAdditionalOptionPrefix(string newPrefix)
         {
             AdditionalOptionPrefix = newPrefix;
@@ -292,6 +306,9 @@ protected override TResult DoExecute(ITaskContextInternal context)
                 _task.WithArguments(arg.arg, arg.maskArg);
             }
 
+            if (_doNotFailOnExitCodes != null)
+                _task.DoNotFailOnExitCodes(_doNotFailOnExitCodes);
+
             var result = _task
                 .ChangeDefaultAdditionalOptionPrefix(AdditionalOptionPrefix)
                 .AddPrefixToAdditionalOptionKey(_prefixToAdditionalOptionKeyFunc)

src/FlubuCore/Tasks/Process/IRunProgramTask.cs

@@ -71,5 +71,13 @@ public interface IRunProgramTask : ITaskOfT<int, IRunProgramTask>, IExternalProc
         IRunProgramTask ChangeAdditionalOptionKeyValueSeperator(char newSeperator);
 
         IRunProgramTask AddPrefixToAdditionalOptionKey(Func<string, string> action);
+
+        /// <summary>
+        /// Specifies non-zero exit codes that should not cause the task to fail.
+        /// By default any non-zero exit code fails the task.
+        /// </summary>
+        /// <param name="exitCodes">Exit codes that indicate success.</param>
+        /// <returns></returns>
+        IRunProgramTask DoNotFailOnExitCodes(params int[] exitCodes);
     }
 }

src/FlubuCore/Tasks/Process/RunProgramTask.cs

@@ -40,6 +40,8 @@ public class RunProgramTask : TaskBase<int, IRunProgramTask>, IRunProgramTask
 
         private Func<string, string> _addPrefixToAdditionalOptionKey = null;
 
+        private HashSet<int> _doNotFailOnExitCodes = null;
+
         /// <inheritdoc />
         public RunProgramTask(ICommandFactory commandFactory, string programToExecute)
         {
@@ -200,6 +202,14 @@ public IRunProgramTask AddPrefixToAdditionalOptionKey(Func<string, string> actio
             return this;
         }
 
+        /// <inheritdoc />
+        public IRunProgramTask DoNotFailOnExitCodes(params int[] exitCodes)
+        {
+            _doNotFailOnExitCodes = new HashSet<int>(exitCodes);
+            _doNotFailOnExitCodes.Add(0);
+            return this;
+        }
+
         public IRunProgramTask Executable(string executableFullFilePath)
         {
             _programToExecute = executableFullFilePath;
@@ -281,7 +291,9 @@ protected override int DoExecute(ITaskContextInternal context)
             int res = command.Execute()
                 .ExitCode;
 
-            if (!DoNotFail && res != 0)
+            bool isSuccess = _doNotFailOnExitCodes != null ? _doNotFailOnExitCodes.Contains(res) : res == 0;
+
+            if (!DoNotFail && !isSuccess)
                 context.Fail($"External program {cmd} failed with {res}.", res);
 
             return res;