Add ProcessX.AcceptableExitCodes

Author: neuecc

README.md

@@ -1,4 +1,4 @@
-[![GitHub Actions](https://github.com/Cysharp/ProcessX/workflows/Build-Debug/badge.svg)](https://github.com/Cysharp/ProcessX/actions) [![Releases](https://img.shields.io/github/release/Cysharp/ProcessX.svg)](https://github.com/Cysharp/ProcessX/releases)
+[![GitHub Actions](https://github.com/Cysharp/ProcessX/workflows/Build-Debug/badge.svg)](https://github.com/Cysharp/ProcessX/actions)
 
 ProcessX
 ===
@@ -133,6 +133,10 @@ If stdout is binary data, you can use `StartReadBinaryAsync` to read `byte[]`.
 byte[] bin = await ProcessX.StartReadBinaryAsync($"...");
 ```
 
+Change acceptable exit codes
+---
+In default, ExitCode is not 0 throws ProcessErrorException. You can change acceptable exit codes globally by `ProcessX.AcceptableExitCodes` property. Default is `[0]`.
+
 Reference
 ---
 `ProcessX.StartAsync` overloads, you can set workingDirectory, environmentVariable, encoding.

sandbox/ConsoleApp/Program.cs

@@ -1,6 +1,7 @@
 using Cysharp.Diagnostics; // using namespace
 using System;
 using System.Collections.Generic;
+using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
 
@@ -10,9 +11,9 @@ class Program
     static async Task Main(string[] args)
     {
         var path = @"..\..\..\..\ReturnMessage\ReturnMessage.csproj";
-        // await ProcessX.StartAsync($"dotnet run --project {path} -- str -m foo -c 10").WriteLineAllAsync();
+        await ProcessX.StartAsync($"dotnet run --project {path} -- str -m foo -c 10").WriteLineAllAsync();
 
-        var bin = await ProcessX.StartReadBinaryAsync($"dotnet run --project {path} -- bin -s 999 -c 10 -w 10");
+        //var bin = await ProcessX.StartReadBinaryAsync($"dotnet run --project {path} -- bin -s 999 -c 10 -w 10");
 
         //// first argument is Process, if you want to know ProcessID, use StandardInput, use it.
         //var (_, stdOut, stdError) = ProcessX.GetDualAsyncEnumerable("dotnet --foo --bar");
@@ -47,6 +48,21 @@ static async Task Main(string[] args)
         //    // ex.ErrorOutput is empty, if you want to use it, buffer yourself.
         //    // Console.WriteLine(string.Join(Environment.NewLine, errorBuffered));
         //}
-        Console.WriteLine(bin.Length);
+        //Console.WriteLine(bin.Length);
+
+        Console.WriteLine(IsInvalidExitCode(0));
+        AcceptableExitCodes = new[] { 1 };
+        Console.WriteLine(IsInvalidExitCode(0));
+        Console.WriteLine(IsInvalidExitCode(1));
+        AcceptableExitCodes = new[] { 0, 1 };
+        Console.WriteLine(IsInvalidExitCode(0));
+        Console.WriteLine(IsInvalidExitCode(1));
+    }
+
+    public static IReadOnlyList<int> AcceptableExitCodes { get; set; } = new[] { 0 };
+
+    static bool IsInvalidExitCode(int processExitCode)
+    {
+        return !AcceptableExitCodes.Any(x => x == processExitCode);
     }
 }

src/ProcessX/ProcessX.cs

@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.IO;
+using System.Linq;
 using System.Text;
 using System.Threading;
 using System.Threading.Channels;
@@ -11,6 +12,13 @@ namespace Cysharp.Diagnostics
 {
     public static class ProcessX
     {
+        public static IReadOnlyList<int> AcceptableExitCodes { get; set; } = new[] { 0 };
+
+        static bool IsInvalidExitCode(Process process)
+        {
+            return !AcceptableExitCodes.Any(x => x == process.ExitCode);
+        }
+
         static (string fileName, string? arguments) ParseCommand(string command)
         {
             var cmdBegin = command.IndexOf(' ');
@@ -132,7 +140,7 @@ public static ProcessAsyncEnumerable StartAsync(ProcessStartInfo processStartInf
                     await waitOutputDataCompleted.Task.ConfigureAwait(false);
                 }
 
-                if (process.ExitCode != 0)
+                if (IsInvalidExitCode(process))
                 {
                     outputChannel.Writer.TryComplete(new ProcessErrorException(process.ExitCode, errorList.ToArray()));
                 }
@@ -245,7 +253,7 @@ public static (Process Process, ProcessAsyncEnumerable StdOut, ProcessAsyncEnume
                 await waitErrorDataCompleted.Task.ConfigureAwait(false);
                 await waitOutputDataCompleted.Task.ConfigureAwait(false);
 
-                if (process.ExitCode != 0)
+                if (IsInvalidExitCode(process))
                 {
                     errorChannel.Writer.TryComplete();
                     outputChannel.Writer.TryComplete(new ProcessErrorException(process.ExitCode, Array.Empty<string>()));
@@ -337,7 +345,7 @@ public static Task<byte[]> StartReadBinaryAsync(ProcessStartInfo processStartInf
             {
                 await waitErrorDataCompleted.Task.ConfigureAwait(false);
 
-                if (errorList.Count == 0 && process.ExitCode == 0)
+                if (errorList.Count == 0 && !IsInvalidExitCode(process))
                 {
                     var resultBin = await readTask.Task.ConfigureAwait(false);
                     if (resultBin != null)