Merge pull request #654 from sindresorhus/timeout

Add timeout functionality

Author: sindresorhus

api.js

@@ -13,8 +13,10 @@ var commonPathPrefix = require('common-path-prefix');
 var resolveCwd = require('resolve-cwd');
 var uniqueTempDir = require('unique-temp-dir');
 var findCacheDir = require('find-cache-dir');
+var debounce = require('lodash.debounce');
 var slash = require('slash');
 var isObj = require('is-obj');
+var ms = require('ms');
 var AvaError = require('./lib/ava-error');
 var fork = require('./lib/fork');
 var formatter = require('./lib/enhance-assert').formatter();
@@ -49,6 +51,11 @@ function Api(options) {
 	}, this);
 
 	this._reset();
+
+	if (this.options.timeout) {
+		var timeout = ms(this.options.timeout);
+		this._restartTimer = debounce(this._onTimeout, timeout);
+	}
 }
 
 util.inherits(Api, EventEmitter);
@@ -187,6 +194,18 @@ Api.prototype._prefixTitle = function (file) {
 	return prefix;
 };
 
+Api.prototype._onTimeout = function () {
+	var timeout = ms(this.options.timeout);
+	var message = 'Exited because no new tests completed within the last ' + timeout + 'ms of inactivity';
+
+	this._handleExceptions({
+		exception: new AvaError(message),
+		file: null
+	});
+
+	this.emit('timeout');
+};
+
 Api.prototype.run = function (files, options) {
 	var self = this;
 
@@ -196,6 +215,11 @@ Api.prototype.run = function (files, options) {
 		this.hasExclusive = true;
 	}
 
+	if (this.options.timeout) {
+		this._restartTimer();
+		this.on('test', this._restartTimer);
+	}
+
 	return handlePaths(files, this.excludePatterns)
 		.map(function (file) {
 			return path.resolve(file);
@@ -221,6 +245,12 @@ Api.prototype.run = function (files, options) {
 
 			var tests = new Array(self.fileCount);
 
+			self.on('timeout', function () {
+				tests.forEach(function (fork) {
+					fork.exit();
+				});
+			});
+
 			return new Promise(function (resolve) {
 				function run() {
 					if (self.options.match.length > 0 && !self.hasExclusive) {
@@ -313,6 +343,11 @@ Api.prototype.run = function (files, options) {
 			});
 		})
 		.then(function (results) {
+			// cancel debounced _onTimeout() from firing
+			if (self.options.timeout) {
+				self._restartTimer.cancel();
+			}
+
 			// assemble stats from all tests
 			self.stats = results.map(function (result) {
 				return result.stats;

cli.js

@@ -69,6 +69,7 @@ var cli = meow([
 	'  --match, -m      Only run tests with matching title (Can be repeated)',
 	'  --watch, -w      Re-run tests when tests and source files change',
 	'  --source, -S     Pattern to match source files so tests can be re-run (Can be repeated)',
+	'  --timeout, -T    Set global timeout',
 	'',
 	'Examples',
 	'  ava',
@@ -84,6 +85,7 @@ var cli = meow([
 	string: [
 		'_',
 		'require',
+		'timeout',
 		'source',
 		'match'
 	],
@@ -102,7 +104,8 @@ var cli = meow([
 		s: 'serial',
 		m: 'match',
 		w: 'watch',
-		S: 'source'
+		S: 'source',
+		T: 'timeout'
 	}
 });
 
@@ -120,7 +123,8 @@ var api = new Api({
 	cacheEnabled: cli.flags.cache !== false,
 	explicitTitles: cli.flags.watch,
 	match: arrify(cli.flags.match),
-	babelConfig: conf.babel
+	babelConfig: conf.babel,
+	timeout: cli.flags.timeout
 });
 
 var reporter;

index.js

@@ -61,8 +61,10 @@ function test(props) {
 }
 
 function exit() {
+	var stats = runner._buildStats();
+
 	send('results', {
-		stats: runner.stats
+		stats: stats
 	});
 }
 
@@ -85,6 +87,10 @@ globals.setImmediate(function () {
 	process.on('ava-run', function (options) {
 		runner.run(options).then(exit);
 	});
+
+	process.on('ava-init-exit', function () {
+		exit();
+	});
 });
 
 module.exports = runner.test;

lib/fork.js

@@ -48,6 +48,9 @@ module.exports = function (file, opts) {
 		}
 	};
 
+	var testResults = [];
+	var results;
+
 	var promise = new Promise(function (resolve, reject) {
 		ps.on('error', reject);
 
@@ -65,9 +68,6 @@ module.exports = function (file, opts) {
 			ps.emit(event.name, event.data);
 		});
 
-		var testResults = [];
-		var results;
-
 		ps.on('test', function (props) {
 			testResults.push(props);
 		});
@@ -142,6 +142,12 @@ module.exports = function (file, opts) {
 		return promise;
 	};
 
+	promise.exit = function () {
+		send(ps, 'init-exit');
+
+		return promise;
+	};
+
 	// send 'run' event only when fork is listening for it
 	var isReady = false;
 

lib/runner.js

@@ -41,6 +41,7 @@ function Runner(options) {
 
 	options = options || {};
 
+	this.results = [];
 	this.tests = new TestCollection();
 	this._bail = options.bail;
 	this._serial = options.serial;
@@ -112,11 +113,51 @@ Runner.prototype._addTestResult = function (result) {
 		todo: test.metadata.todo
 	};
 
+	this.results.push(result);
 	this.emit('test', props);
 };
 
+Runner.prototype._buildStats = function () {
+	var stats = {
+		testCount: 0,
+		skipCount: 0,
+		todoCount: 0
+	};
+
+	this.results
+		.map(function (result) {
+			return result.result;
+		})
+		.filter(function (test) {
+			return test.metadata.type === 'test';
+		})
+		.forEach(function (test) {
+			stats.testCount++;
+
+			if (test.metadata.skipped) {
+				stats.skipCount++;
+			}
+
+			if (test.metadata.todo) {
+				stats.todoCount++;
+			}
+		});
+
+	stats.failCount = this.results
+		.filter(function (result) {
+			return result.passed === false;
+		})
+		.length;
+
+	stats.passCount = stats.testCount - stats.failCount - stats.skipCount - stats.todoCount;
+
+	return stats;
+};
+
 Runner.prototype.run = function (options) {
-	var stats = this.stats = {
+	var self = this;
+
+	this.stats = {
 		failCount: 0,
 		passCount: 0,
 		skipCount: 0,
@@ -131,6 +172,8 @@ Runner.prototype.run = function (options) {
 	this.tests.on('test', this._addTestResult);
 
 	return Promise.resolve(this.tests.build(this._bail).run()).then(function () {
-		stats.passCount = stats.testCount - stats.failCount - stats.skipCount - stats.todoCount;
+		self.stats = self._buildStats();
+
+		return self.stats;
 	});
 };

package.json

@@ -109,11 +109,13 @@
     "is-observable": "^0.1.0",
     "is-promise": "^2.1.0",
     "last-line-stream": "^1.0.0",
+    "lodash.debounce": "^4.0.3",
     "loud-rejection": "^1.2.0",
     "matcher": "^0.1.1",
     "max-timeout": "^1.0.0",
     "md5-hex": "^1.2.0",
     "meow": "^3.7.0",
+    "ms": "^0.7.1",
     "multimatch": "^2.1.0",
     "object-assign": "^4.0.1",
     "observable-to-promise": "^0.3.0",

readme.md

@@ -146,6 +146,7 @@ $ ava --help
     --match, -m      Only run tests with matching title (Can be repeated)',
     --watch, -w      Re-run tests when tests and source files change
     --source, -S     Pattern to match source files so tests can be re-run (Can be repeated)
+    --timeout, -T    Set global timeout
 
   Examples
     ava
@@ -679,6 +680,20 @@ AVA automatically removes unrelated lines in stack traces, allowing you to find
 
 <img src="media/stack-traces.png" width="300">
 
+### Global timeout
+
+A global timeout can be set via the `--timeout` option.
+Timeout in AVA behaves differently than in other test frameworks.
+AVA resets a timer after each test, forcing tests to quit if no new test results were received within the specified timeout.
+
+You can set timeouts in a human-readable way:
+
+```
+$ ava --timeout=10s # 10 seconds
+$ ava --timeout=2m # 2 minutes
+$ ava --timeout=100 # 100 milliseconds
+```
+
 ## API
 
 ### `test([title], callback)`

test/cli.js

@@ -78,7 +78,15 @@ test('disallow invalid babel config shortcuts', function (t) {
 	});
 });
 
-test('throwing a named function will report the function to the console', function (t) {
+test('timeout', function (t) {
+	execCli(['fixture/long-running.js', '-T', '1s'], function (err, stdout, stderr) {
+		t.ok(err);
+		t.match(stderr, /Exited because no new tests completed within the last 1000ms of inactivity/);
+		t.end();
+	});
+});
+
+test('throwing a named function will report the to the console', function (t) {
 	execCli('fixture/throw-named-function.js', function (err, stdout, stderr) {
 		t.ok(err);
 		t.match(stderr, /function fooFn\(\) \{\}/);

test/fixture/long-running.js

@@ -1,31 +1,9 @@
 import test from '../../';
-import signalExit from 'signal-exit';
 
-test.cb('long running', t => {
-	t.plan(1);
-
-	signalExit(() => {
-		// simulate an exit hook that lasts a short while
-		const start = Date.now();
-
-		while (Date.now() - start < 2000) {
-			// synchronously wait for 2 seconds
-		}
-
-		process.send({
-			name: 'cleanup-completed',
-			data: {completed: true},
-			ava: true
-		});
-	}, {alwaysLast: true});
+test.cb('slow', t => {
+	setTimeout(t.end, 5000);
+});
 
-	setTimeout(() => {
-		t.ok(true);
-		t.end();
-	});
+test('fast', t => {
 
-	setTimeout(() => {
-		// this would keep the process running for a long time
-		console.log('I\'m gonna live forever!!');
-	}, 15000);
 });

test/fixture/slow-exit.js

@@ -0,0 +1,31 @@
+import test from '../../';
+import signalExit from 'signal-exit';
+
+test.cb('long running', t => {
+	t.plan(1);
+
+	signalExit(() => {
+		// simulate an exit hook that lasts a short while
+		const start = Date.now();
+
+		while (Date.now() - start < 2000) {
+			// synchronously wait for 2 seconds
+		}
+
+		process.send({
+			name: 'cleanup-completed',
+			data: {completed: true},
+			ava: true
+		});
+	}, {alwaysLast: true});
+
+	setTimeout(() => {
+		t.ok(true);
+		t.end();
+	});
+
+	setTimeout(() => {
+		// this would keep the process running for a long time
+		console.log('I\'m gonna live forever!!');
+	}, 15000);
+});

test/fork.js

@@ -49,7 +49,7 @@ test('exit after tests are finished', function (t) {
 	var start = Date.now();
 	var cleanupCompleted = false;
 
-	fork(fixture('long-running.js'))
+	fork(fixture('slow-exit.js'))
 		.run({})
 		.on('exit', function () {
 			t.true(Date.now() - start < 10000, 'test waited for a pending setTimeout');