Add configurable test timeouts

src/steps/inject-root-package.test.ts

@@ -47,6 +47,7 @@ describe('#injectRootPackage()', () => {
 			testInParallel: true,
 			compileScriptName: 'compile',
 			printSuccessfulOutput: false,
+			timeouts: { test: 30000 },
 		}));
 		const tmp = require('tmp') as jest.Mocked<typeof tmpDef>;
 

src/steps/test-projects.test.ts

@@ -31,6 +31,7 @@ describe('#testProjects()', () => {
 			testInParallel: true,
 			compileScriptName: 'compile',
 			printSuccessfulOutput: false,
+			timeouts: { test: 30000 },
 		}));
 
 		const packageManager = (require('../utils/package-manager') as {
@@ -88,7 +89,12 @@ describe('#testProjects()', () => {
 
 		await expect(testProjects(['/example-project'], finalResult)).resolves.not.toThrow();
 		expect(execa).toHaveBeenCalledTimes(1);
-		expect(execa).toHaveBeenCalledWith('yarn', [], { cwd: '/example-project', all: true, reject: false });
+		expect(execa).toHaveBeenCalledWith('yarn', [], {
+			cwd: '/example-project',
+			all: true,
+			reject: false,
+			timeout: 30000,
+		});
 		expect(finalResult.successfulTests).toStrictEqual([]);
 		expect(finalResult.failedTests).toStrictEqual([]);
 	});
@@ -101,6 +107,7 @@ describe('#testProjects()', () => {
 			testInParallel: true,
 			compileScriptName: 'compile',
 			printSuccessfulOutput: true,
+			timeouts: { test: 30000 },
 		}));
 
 		const testProjects = (require('./test-projects') as { default: typeof testProjectsDef }).default;

src/steps/test-projects.ts

@@ -11,7 +11,7 @@ import printHeader from '../utils/print-header';
 /** Installs dependencies into the root project and test projects */
 export default async function testProjects(testProjectPaths: string[], finalResult: FinalResult): Promise<void> {
 	// Get the configuration for testing in parallel
-	const { testInParallel, printSuccessfulOutput } = await getConfig();
+	const { testInParallel, printSuccessfulOutput, timeouts } = await getConfig();
 
 	// Print section header
 	printHeader('Testing projects');
@@ -29,6 +29,7 @@ export default async function testProjects(testProjectPaths: string[], finalResu
 					cwd: testProjectPath,
 					all: true,
 					reject: false,
+					timeout: timeouts.test,
 				});
 
 				// Check for failure

src/utils/get-config.test.ts

@@ -198,4 +198,51 @@ describe('#getConfig()', () => {
 			'In the rugged.config.js file, the yarnMutexPort key contains an invalid value'
 		);
 	});
+
+	it('Handles invalid timeouts configuration', async () => {
+		jest
+			.spyOn(process, 'cwd')
+			.mockReturnValue(path.join(testFileTreesPath, 'invalid-config-value', 'timeouts-is-not-object'));
+
+		await expect(() => getConfig(true)).rejects.toThrow(PrintableError);
+		await expect(() => getConfig(true)).rejects.toThrow(
+			'In the rugged.config.js file, the timeouts key contains an invalid value'
+		);
+
+		jest
+			.spyOn(process, 'cwd')
+			.mockReturnValue(path.join(testFileTreesPath, 'invalid-config-value', 'timeouts-is-null'));
+
+		await expect(() => getConfig(true)).rejects.toThrow(PrintableError);
+		await expect(() => getConfig(true)).rejects.toThrow(
+			'In the rugged.config.js file, the timeouts key contains an invalid value'
+		);
+
+		jest
+			.spyOn(process, 'cwd')
+			.mockReturnValue(path.join(testFileTreesPath, 'invalid-config-value', 'timeouts-is-array'));
+
+		await expect(() => getConfig(true)).rejects.toThrow(PrintableError);
+		await expect(() => getConfig(true)).rejects.toThrow(
+			'In the rugged.config.js file, the timeouts key contains an invalid value'
+		);
+
+		jest
+			.spyOn(process, 'cwd')
+			.mockReturnValue(path.join(testFileTreesPath, 'invalid-config-value', 'timeouts-value-not-integer'));
+
+		await expect(() => getConfig(true)).rejects.toThrow(PrintableError);
+		await expect(() => getConfig(true)).rejects.toThrow(
+			'In the rugged.config.js file, the timeouts key contains an invalid value'
+		);
+
+		jest
+			.spyOn(process, 'cwd')
+			.mockReturnValue(path.join(testFileTreesPath, 'invalid-config-value', 'timeouts-value-not-positive-integer'));
+
+		await expect(() => getConfig(true)).rejects.toThrow(PrintableError);
+		await expect(() => getConfig(true)).rejects.toThrow(
+			'In the rugged.config.js file, the timeouts key contains an invalid value'
+		);
+	});
 });

src/utils/get-config.ts

@@ -25,6 +25,12 @@ export interface Config {
 
 	/** Whether to print successful test output, in addition to failed test output. Defaults to `false`. */
 	printSuccessfulOutput: boolean;
+
+	/** How long to wait before timing out, values are represented in milliseconds. Defaults to thirty seconds. */
+	timeouts: {
+		// Time before the test command times out.
+		test: number;
+	};
 }
 
 // Initialize
@@ -45,6 +51,9 @@ export default async function getConfig(reconstruct?: true): Promise<Config> {
 		testInParallel: true,
 		compileScriptName: 'compile',
 		printSuccessfulOutput: false,
+		timeouts: {
+			test: 30000,
+		},
 	};
 
 	// Initialize custom config
@@ -62,6 +71,11 @@ export default async function getConfig(reconstruct?: true): Promise<Config> {
 		testInParallel: (value) => typeof value === 'boolean',
 		compileScriptName: (value) => typeof value === 'string',
 		printSuccessfulOutput: (value) => typeof value === 'boolean',
+		timeouts: (value) =>
+			typeof value === 'object' &&
+			value !== null &&
+			!Array.isArray(value) &&
+			Object.values(value).every((timeout) => Number.isInteger(timeout) && Math.sign(timeout) !== -1),
 	};
 
 	// Initialize paths to possible config files

test-file-trees/invalid-config-value/timeouts-is-array/rugged.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+	timeouts: [],
+};

test-file-trees/invalid-config-value/timeouts-is-not-object/rugged.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+	timeouts: 0,
+};

test-file-trees/invalid-config-value/timeouts-is-null/rugged.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+	timeouts: null,
+};

test-file-trees/invalid-config-value/timeouts-value-not-integer/rugged.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+	timeouts: null,
+};

test-file-trees/invalid-config-value/timeouts-value-not-positive-integer/rugged.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+	timeouts: null,
+};