Prevent premature end of the Benchmark process at Ctrl-C, fixes dotnet#2483

Set ConsoleCancelEventArgs.Cancel to true so that Benchmark process
continues and PowerPlan is reverted at end of aborted Benchmark.

Author: leonvandermeer

docs/articles/configs/configoptions.md

@@ -12,7 +12,7 @@ Available config options are:
 * `ConfigOptions.Default` - No configuration option is set - this is the default.
 * `ConfigOptions.KeepBenchmarkFiles` - All auto-generated files should be kept after running the benchmarks (by default they are removed).
 * `ConfigOptions.JoinSummary` - All benchmarks results should be joined into a single summary (by default we have a summary per type).
-* `ConfigOptions.StopOnFirstError` - Benchmarking should be stopped after the first error (by default it's not).
+* `ConfigOptions.StopOnFirstError` - Benchmarking should be stopped after the first error (by default it's not). This also stops benchmarking when Ctrl+C or Ctrl+Break is pressed (by default, Ctrl+C or Ctrl+Break only aborts current benchmark. Remaining benchmarks will continue to run).
 * `ConfigOptions.DisableOptimizationsValidator` - Mandatory optimizations validator should be entirely turned off.
 * `ConfigOptions.DontOverwriteResults` - The exported result files should not be overwritten (by default they are overwritten).
 * `ConfigOptions.DisableLogFile` - Disables the log file written on disk.

docs/articles/guides/console-args.md

@@ -231,7 +231,7 @@ dotnet run -c Release -- --filter * --runtimes net6.0 net8.0 --statisticalTest 5
 * `--coreRun` path(s) to CoreRun (optional).
 * `--ilcPackages` path to ILCompiler for NativeAOT.
 * `--info` prints environment configuration including BenchmarkDotNet, OS, CPU and .NET version
-* `--stopOnFirstError` stop on first error.
+* `--stopOnFirstError` Benchmarking should be stopped after the first error (by default it's not). This also stops benchmarking when Ctrl+C or Ctrl+Break is pressed (by default, Ctrl+C or Ctrl+Break only aborts current benchmark. Remaining benchmarks will continue to run).
 * `--help` display this help screen.
 * `--version` display version information.
 * `--keepFiles` (default: false) determines if all auto-generated files should be kept or removed after running the benchmarks.

docs/articles/samples/IntroStopOnFirstError.md

@@ -6,6 +6,10 @@ uid: BenchmarkDotNet.Samples.IntroStopOnFirstError
 
 BenchmarkDotNet can be configured to stop on first error. You just have to add `StopOnFirstError` attribute to your class or use `--stopOnFirstError` command line argument.
 
+This also stops benchmarking when Ctrl+C or Ctrl+Break is pressed.
+
+By default, remaining benchmarks will continue to run when Ctrl+C or Ctrl+Break is pressed.
+
 ### Source code
 
 [!code-csharp[IntroStopOnFirstError.cs](../../../samples/BenchmarkDotNet.Samples/IntroStopOnFirstError.cs)]

src/BenchmarkDotNet/Attributes/StopOnFirstErrorAttribute.cs

@@ -5,7 +5,7 @@
 namespace BenchmarkDotNet.Attributes
 {
     /// <summary>
-    /// determines if running should be stop after first error
+    /// Determines if running should be stop after first error or when Ctrl+C or Ctrl+Break is pressed.
     /// </summary>
     [PublicAPI]
     [AttributeUsage(AttributeTargets.Class)]

src/BenchmarkDotNet/Helpers/ConsoleExitHandler.cs

@@ -52,7 +52,11 @@ private void Detach()
         private void ProcessOnExited(object sender, EventArgs e) => Detach();
 
         // the user has clicked Ctrl+C so we kill the entire process tree
-        private void CancelKeyPressHandlerCallback(object sender, ConsoleCancelEventArgs e) => KillProcessTree();
+        private void CancelKeyPressHandlerCallback(object sender, ConsoleCancelEventArgs e)
+        {
+            e.Cancel = true; // Prevent premature termination of current process.
+            KillProcessTree();
+        }
 
         // the user has closed the console window so we kill the entire process tree
         private void ProcessExitEventHandlerHandlerCallback(object sender, EventArgs e) => KillProcessTree();