Handle SIGINT on Windows

Signal handling in Node.js on Windows is only rudimentary supported.
Specifically using `process.kill`, like the test does to interrupt
itself, will unconditionally terminate the process. The signal
processing works in manual tests, though.

Author: bertschneider

packages/core/core.ts

@@ -405,6 +405,11 @@ function buildFuzzerOptions(options: Options): string[] {
 	}
 	const inSeconds = Math.ceil(options.timeout / 1000);
 	opts = opts.concat(`-timeout=${inSeconds}`);
+
+	// libFuzzer has to ignore SIGINT and SIGTERM, as it interferes
+	// with the Node.js signal handling.
+	opts = opts.concat("-handle_int=0", "-handle_term=0");
+
 	return [prepareLibFuzzerArg0(opts), ...opts];
 }
 

tests/helpers.js

@@ -23,8 +23,8 @@ const path = require("path");
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const assert = require("assert");
 
-// This is used to distinguish an error thrown during fuzzing from other errors, such as wrong
-// `fuzzEntryPoint` (which would return a "1")
+// This is used to distinguish an error thrown during fuzzing from other errors,
+// such as wrong `fuzzEntryPoint`, which would return a "1".
 const FuzzingExitCode = "77";
 const JestRegressionExitCode = "1";
 const WindowsExitCode = "1";
@@ -321,9 +321,19 @@ function callWithTimeout(fn, timeout) {
 	});
 }
 
+/**
+ * Returns a Jest describe function that is skipped if the current platform is not the given one.
+ * @param platform
+ * @returns describe(.skip) function
+ */
+function describeSkipOnPlatform(platform) {
+	return process.platform === platform ? global.describe.skip : global.describe;
+}
+
 module.exports.FuzzTestBuilder = FuzzTestBuilder;
 module.exports.FuzzingExitCode = FuzzingExitCode;
 module.exports.JestRegressionExitCode = JestRegressionExitCode;
 module.exports.WindowsExitCode = WindowsExitCode;
 module.exports.makeFnCalledOnce = makeFnCalledOnce;
 module.exports.callWithTimeout = callWithTimeout;
+module.exports.describeSkipOnPlatform = describeSkipOnPlatform;

tests/signal_handlers/signal_handlers.test.js

@@ -17,11 +17,18 @@
 /* eslint no-undef: 0 */
 const {
 	FuzzTestBuilder,
+	describeSkipOnPlatform,
 	// eslint-disable-next-line @typescript-eslint/no-var-requires
 } = require("../helpers.js");
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const path = require("path");
 
+// Signal handling in Node.js on Windows is only rudimentary supported.
+// Specifically using `process.kill`, like the test does to interrupt itself,
+// will unconditionally terminate the process. The signal processing works in
+// manual tests, though.
+const describe = describeSkipOnPlatform("win32");
+
 describe("SIGINT handlers", () => {
 	let fuzzTestBuilder;
 
@@ -35,13 +42,6 @@ describe("SIGINT handlers", () => {
 
 	describe("in standalone fuzzing mode", () => {
 		it("stop sync fuzzing on SIGINT", () => {
-			// TODO: make the SIGINT handling produce coverage reports on Windows on exit too.
-			if (process.platform === "win32") {
-				console.log(
-					"// TODO: make the SIGINT handling produce coverage reports on Windows on exit too.",
-				);
-				return;
-			}
 			const fuzzTest = fuzzTestBuilder
 				.sync(true)
 				.fuzzEntryPoint("SIGINT_SYNC")
@@ -50,13 +50,6 @@ describe("SIGINT handlers", () => {
 			assertSigintMessagesLogged(fuzzTest);
 		});
 		it("stop async fuzzing on SIGINT", () => {
-			// TODO: make the SIGINT handling produce coverage reports on Windows on exit too.
-			if (process.platform === "win32") {
-				console.log(
-					"// TODO: make the SIGINT handling produce coverage reports on Windows on exit too.",
-				);
-				return;
-			}
 			const fuzzTest = fuzzTestBuilder
 				.sync(false)
 				.fuzzEntryPoint("SIGINT_ASYNC")
@@ -68,13 +61,6 @@ describe("SIGINT handlers", () => {
 
 	describe("in Jest fuzzing mode", () => {
 		it("stop sync fuzzing on SIGINT", () => {
-			// TODO: make the SIGINT handling produce coverage reports on Windows on exit too.
-			if (process.platform === "win32") {
-				console.log(
-					"// TODO: make the SIGINT handling produce coverage reports on Windows on exit too.",
-				);
-				return;
-			}
 			const fuzzTest = fuzzTestBuilder
 				.jestTestFile("tests.fuzz.js")
 				.jestTestName("^Jest Sync$")
@@ -84,13 +70,6 @@ describe("SIGINT handlers", () => {
 			assertSigintMessagesLogged(fuzzTest);
 		});
 		it("stop async fuzzing on SIGINT", () => {
-			// TODO: make the SIGINT handling produce coverage reports on Windows on exit too.
-			if (process.platform === "win32") {
-				console.log(
-					"// TODO: make the SIGINT handling produce coverage reports on Windows on exit too.",
-				);
-				return;
-			}
 			const fuzzTest = fuzzTestBuilder
 				.jestTestFile("tests.fuzz.js")
 				.jestTestName("^Jest Async$")