fix: don't mask OperationCanceledException triggered by SIGINT (#483)

natemcmaster · Dec 26, 2021 · 3774688 · 3774688
1 parent 6783c5f
commit 3774688
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 10 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,9 +15,11 @@
 * [@natemcmaster]: fix new CI to correctly publish symbols to nuget.org
 * [@scott-xu]:  show option types in help text when OptionAttribute.Template is set ([#429])
 * [@skirchner989]:  change to not throw when a validator is not of type AttributeValidator ([#431])
+* [@natemcmaster]: don't mask OperationCanceledException triggered by SIGINT ([#483])
 
 [#429]: https://github.com/natemcmaster/CommandLineUtils/pull/429
 [#431]: https://github.com/natemcmaster/CommandLineUtils/pull/431
+[#484]: https://github.com/natemcmaster/CommandLineUtils/pull/484
 
 
 ### Other

diff --git a/src/CommandLineUtils/CommandLineApplication.Execute.cs b/src/CommandLineUtils/CommandLineApplication.Execute.cs
@@ -78,6 +78,10 @@ public static async Task<int> ExecuteAsync<TApp>(CommandLineContext context, Can
                 app.Conventions.UseDefaultConventions();
                 return await app.ExecuteAsync(context.Arguments, cancellationToken);
             }
+            catch (OperationCanceledException)
+            {
+                return s_exitCodeOperationCanceled;
+            }
             catch (CommandParsingException ex)
             {
                 context.Console.Error.WriteLine(ex.Message);

diff --git a/src/CommandLineUtils/CommandLineApplication.cs b/src/CommandLineUtils/CommandLineApplication.cs
@@ -881,10 +881,6 @@ void cancelHandler(object o, ConsoleCancelEventArgs e)
 
                 return await command._handler(handlerCancellationTokenSource.Token);
             }
-            catch (OperationCanceledException)
-            {
-                return s_exitCodeOperationCanceled;
-            }
             finally
             {
                 _context.Console.CancelKeyPress -= cancelHandler;

diff --git a/src/CommandLineUtils/releasenotes.props b/src/CommandLineUtils/releasenotes.props
@@ -14,6 +14,7 @@ Fixes:
 * @natemcmaster: fix new CI to correctly publish symbols to nuget.org
 * @scott-xu: show option types in help text when OptionAttribute.Template is set (#429)
 * @skirchner989: change to not throw when a validator is not of type AttributeValidator (#431)
+* @natemcmaster: don't mask OperationCanceledException triggered by SIGINT (#483)
     </PackageReleaseNotes>
     <PackageReleaseNotes Condition="$(VersionPrefix.StartsWith('3.1.'))">
 Improvements:

diff --git a/test/CommandLineUtils.Tests/CommandLineApplicationTests.cs b/test/CommandLineUtils.Tests/CommandLineApplicationTests.cs
@@ -7,6 +7,7 @@
 using System.IO;
 using System.Linq;
 using System.Runtime.InteropServices;
+using System.Threading;
 using System.Threading.Tasks;
 using Moq;
 using Xunit;
@@ -1154,19 +1155,22 @@ public async Task AsyncTaskWithoutReturnIsAwaitedAsync()
             await Assert.ThrowsAsync<InvalidOperationException>(async () => await run);
         }
 
+        private class DelayTilCanceledProgram
+        {
+            public async Task OnExecuteAsync(CancellationToken ct)
+            {
+                await Task.Delay(-1, ct);
+            }
+        }
+
         [Fact]
         public async Task OperationCanceledReturnsExpectedOsCode()
         {
             var expectedCode = RuntimeInformation.IsOSPlatform(OSPlatform.Windows)
                 ? unchecked((int)0xC000013A)
                 : 130;
             var testConsole = new TestConsole(_output);
-            var app = new CommandLineApplication(testConsole);
-            app.OnExecuteAsync(async ct =>
-            {
-                await Task.Delay(-1, ct);
-            });
-            var executeTask = app.ExecuteAsync(Array.Empty<string>());
+            var executeTask = CommandLineApplication.ExecuteAsync<DelayTilCanceledProgram>(testConsole, Array.Empty<string>());
             testConsole.RaiseCancelKeyPress();
             var exitCode = await executeTask;
             Assert.Equal(expectedCode, exitCode);