RemoteProcess: add ExitSignal. (#233)

tmds · Sep 26, 2024 · f9ae42a · f9ae42a
1 parent 03d1a5e
commit f9ae42a
Show file tree

Hide file tree

Showing 5 changed files with 82 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -110,6 +110,8 @@ class RemoteProcess : IDisposable
 
   // Exit code.
   int ExitCode { get; }
+  // Exit signal (if terminated by a signal).
+  string? ExitSignal { get; }
 }
 class SshDataStream : Stream
 {

diff --git a/src/Tmds.Ssh/ISshChannel.cs b/src/Tmds.Ssh/ISshChannel.cs
@@ -6,6 +6,7 @@ interface ISshChannel
     int SendMaxPacket { get; }
     CancellationToken ChannelAborted { get; }
     int? ExitCode { get; }
+    string? ExitSignal { get; }
 
     void Dispose();
     void Abort(Exception exception);

diff --git a/src/Tmds.Ssh/RemoteProcess.cs b/src/Tmds.Ssh/RemoteProcess.cs
@@ -202,19 +202,34 @@ public int ExitCode
     {
         get
         {
-            if (_readMode == ReadMode.Disposed)
-            {
-                ThrowObjectDisposedException();
-            }
-            else if (_readMode != ReadMode.Exited)
-            {
-                throw new InvalidOperationException("The process has not yet exited.");
-            }
+            EnsureExited();
 
             return _channel.ExitCode!.Value;
         }
     }
 
+    public string? ExitSignal
+    {
+        get
+        {
+            EnsureExited();
+
+            return _channel.ExitSignal;
+        }
+    }
+
+    private void EnsureExited()
+    {
+        if (_readMode == ReadMode.Disposed)
+        {
+            ThrowObjectDisposedException();
+        }
+        else if (_readMode != ReadMode.Exited)
+        {
+            throw new InvalidOperationException("The process has not yet exited.");
+        }
+    }
+
     public CancellationToken ExecutionAborted
         => _channel.ChannelAborted;
 

diff --git a/src/Tmds.Ssh/SshChannel.cs b/src/Tmds.Ssh/SshChannel.cs
@@ -41,6 +41,7 @@ public CancellationToken ChannelAborted
         }
     }
     public int? ExitCode { get; private set; }
+    public string? ExitSignal { get; private set; }
     public int SendMaxPacket { get; private set; }
     public int ReceiveMaxPacket => Constants.MaxDataPacketSize;
     private int MaxWindowSize => Constants.DefaultWindowSize;
@@ -527,8 +528,8 @@ boolean   core dumped
                     string    error message in ISO-10646 UTF-8 encoding
                     string    language tag [RFC3066]
                 */
-                string exitSignal = reader.ReadUtf8String();
-                ExitCode = 128; // TODO: assign based on exitSignal.
+                ExitSignal = reader.ReadUtf8String();
+                ExitCode = 128 + SignalToInt(ExitSignal);
                 reader.SkipBoolean();
                 reader.SkipString();
                 reader.SkipString();
@@ -539,6 +540,45 @@ string    language tag [RFC3066]
         return want_reply;
     }
 
+    private static int SignalToInt(string signal) =>
+        signal switch
+        {
+            "HUP" => 1,
+            "INT" => 2,
+            "QUIT" => 3,
+            "ILL" => 4,
+            "TRAP" => 5,
+            "ABRT" => 6,
+            "IOT" => 6,
+            "BUS" => 7,
+            "FPE" => 8,
+            "KILL" => 9,
+            "USR1" => 10,
+            "SEGV" => 11,
+            "USR2" => 12,
+            "PIPE" => 13,
+            "ALRM" => 14,
+            "TERM" => 15,
+            "STKFLT" => 16,
+            "CHLD" => 17,
+            "CONT" => 18,
+            "STOP" => 19,
+            "TSTP" => 20,
+            "TTIN" => 21,
+            "TTOU" => 22,
+            "URG" => 23,
+            "XCPU" => 24,
+            "XFSZ" => 25,
+            "VTALRM" => 26,
+            "PROF" => 27,
+            "WINCH" => 28,
+            "IO" => 29,
+            "POLL" => 29,
+            "PWR" => 30,
+            "SYS" => 31,
+            _ => 32,
+        };
+
     private void ThrowIfDisposed()
     {
         if (_disposed != 0)

diff --git a/test/Tmds.Ssh.Tests/RemoteProcessTests.cs b/test/Tmds.Ssh.Tests/RemoteProcessTests.cs
@@ -243,6 +243,20 @@ public async Task ExitCode(int exitCode)
         Assert.Equal(0, bytesRead);
 
         Assert.Equal(exitCode, process.ExitCode);
+        Assert.Null(process.ExitSignal);
+    }
+
+    [Theory]
+    [InlineData("TERM", 128 + 15)]
+    [InlineData("KILL", 128 + 9)]
+    public async Task ExitCodeSignal(string signal, int expectedExitCode)
+    {
+        using var client = await _sshServer.CreateClientAsync();
+        using var process = await client.ExecuteAsync($"kill -s {signal} $$");
+        await process.WaitForExitAsync();
+
+        Assert.Equal(signal, process.ExitSignal);
+        Assert.Equal(expectedExitCode, process.ExitCode);
     }
 
     [Fact]