Fuzz tests now support timeout.

- Fix fuzz test pipeline by adding a proper timeout to a long-lasting test

Author: oetr

fuzztests/FuzzedDataProvider.fuzz.js

@@ -23,23 +23,27 @@ describe("FuzzedDataProvider", () => {
 	// FuzzedDataProvider as possible, before invoking a terminating one
 	// like consumeRemainingXY. Strange combinations of functions could produce a
 	// one off error.
-	it.fuzz("consumes the provided input", (data) => {
-		const provider = new FuzzedDataProvider(data);
-		const properties = Object.getOwnPropertyNames(
-			Object.getPrototypeOf(provider)
-		);
-		const methodNames = properties
-			.filter((p) => provider[p] instanceof Function)
-			.filter((m) => provider[m].length === 0);
+	it.fuzz(
+		"consumes the provided input",
+		(data) => {
+			const provider = new FuzzedDataProvider(data);
+			const properties = Object.getOwnPropertyNames(
+				Object.getPrototypeOf(provider)
+			);
+			const methodNames = properties
+				.filter((p) => provider[p] instanceof Function)
+				.filter((m) => provider[m].length === 0);
 
-		let usedMethods = "";
-		while (provider.remainingBytes > 0) {
-			const methodName = provider.pickValue(methodNames);
-			provider[methodName].call(provider);
-			usedMethods += methodName;
-		}
-		jazzer.exploreState(hash(usedMethods), 31);
-	});
+			let usedMethods = "";
+			while (provider.remainingBytes > 0) {
+				const methodName = provider.pickValue(methodNames);
+				provider[methodName].call(provider);
+				usedMethods += methodName;
+			}
+			jazzer.exploreState(hash(usedMethods), 31);
+		},
+		40000
+	);
 });
 
 const hash = (str) => {

packages/jest-runner/config.ts

@@ -27,7 +27,7 @@ export const defaultOptions: Options = {
 	fuzzerOptions: [],
 	sync: false,
 	expectedErrors: [],
-	timeout: 5000, // default Jest timeout
+	timeout: undefined,
 	coverage: false,
 	coverageDirectory: "coverage",
 	coverageReporters: ["json", "text", "lcov", "clover"], // default Jest reporters

packages/jest-runner/fuzz.ts

@@ -42,15 +42,19 @@ export class FuzzerStartError extends FuzzerError {}
 // Use Jests global object definition.
 const g = globalThis as unknown as Global.Global;
 
-export type FuzzTest = (name: Global.TestNameLike, fn: FuzzTarget) => void;
+export type FuzzTest = (
+	name: Global.TestNameLike,
+	fn: FuzzTarget,
+	timeout?: number
+) => void;
 
 export const skip: FuzzTest = (name) => {
 	g.test.skip(toTestName(name), () => {
 		return;
 	});
 };
 
-export const fuzz: FuzzTest = (name, fn) => {
+export const fuzz: FuzzTest = (name, fn, timeout = 5000) => {
 	const testName = toTestName(name);
 
 	// Request the current test file path from the worker to create appropriate
@@ -64,15 +68,10 @@ export const fuzz: FuzzTest = (name, fn) => {
 	// points to the element containing the fuzz function.
 	const testStatePath = currentTestStatePath(testName);
 
-	// The timeout setting is extracted from the test state and defaults to 5s.
-	// Setting timeouts on this level is necessary, as they apply to the
-	// individual inputs and not the whole run.
-	const timeout = currentTimeout();
-
 	const corpus = new Corpus(testFile, testStatePath);
 
 	const fuzzingConfig = loadConfig();
-	fuzzingConfig.timeout = timeout;
+	if (fuzzingConfig.timeout) timeout = fuzzingConfig.timeout;
 
 	if (fuzzingConfig.dryRun) {
 		runInRegressionMode(name, fn, corpus, timeout);
@@ -231,7 +230,3 @@ const currentTestStatePath = (testName: string): string[] => {
 	}
 	return elements;
 };
-
-const currentTimeout = (): number => {
-	return circus.getState().testTimeout || 5000;
-};