Merge pull request #132 from FredrikNoren/master

Add timeoutAfter method

Author: Raynos

.gitignore

@@ -0,0 +1 @@
+/node_modules

lib/test.js

@@ -52,6 +52,10 @@ function Test (name_, opts_, cb_) {
     this._progeny = [];
     this._ok = true;
 
+    if (args.opts.timeout !== undefined) {
+        this.timeoutAfter(args.opts.timeout);
+    }
+
     for (var prop in this) {
         this[prop] = (function bind(self, val) {
             if (typeof val === 'function') {
@@ -105,6 +109,18 @@ Test.prototype.plan = function (n) {
     this.emit('plan', n);
 };
 
+Test.prototype.timeoutAfter = function(ms) {
+    if (!ms) throw new Error('timeoutAfter requires a timespan');
+    var self = this;
+    var timeout = setTimeout(function() {
+        self.fail('test timed out after ' + ms + 'ms');
+        self.end();
+    }, ms);
+    this.once('end', function() {
+        clearTimeout(timeout);
+    });
+}
+
 Test.prototype.end = function (err) { 
     var self = this;
     if (arguments.length >= 1) {

readme.markdown

@@ -75,10 +75,16 @@ in [node-tap](https://github.com/isaacs/node-tap).
 var test = require('tape')
 ```
 
-## test(name, cb)
+## test([name], [opts], cb)
 
-Create a new test with an optional `name` string. `cb(t)` fires with the new
-test object `t` once all preceeding tests have finished. Tests execute serially.
+Create a new test with an optional `name` string and optional `opts` object. 
+`cb(t)` fires with the new test object `t` once all preceeding tests have
+finished. Tests execute serially.
+
+Available `opts` options are:
+- opts.skip = true/false. See test.skip.
+- opts.timeout = 500. Set a timeout for the test, after which it will fail. 
+  See test.timeoutAfter.
 
 If you forget to `t.plan()` out how many assertions you are going to run and you
 don't call `t.end()` explicitly, your test will hang.
@@ -105,6 +111,10 @@ Generate a failing assertion with a message `msg`.
 
 Generate a passing assertion with a message `msg`.
 
+## t.timeoutAfter(ms)
+
+Automatically timeout the test after X ms.
+
 ## t.skip(msg)
 
 Generate an assertion that will be skipped over.

test/timeoutAfter.js

@@ -0,0 +1,35 @@
+var tape = require('../');
+var tap = require('tap');
+
+tap.test('timeoutAfter test', function (tt) {
+    tt.plan(1);
+    
+    var test = tape.createHarness();
+    var tc = tap.createConsumer();
+    
+    var rows = [];
+    tc.on('data', function (r) { rows.push(r) });
+    tc.on('end', function () {
+        var rs = rows.map(function (r) {
+            if (r && typeof r === 'object') {
+                return { id : r.id, ok : r.ok, name : r.name.trim() };
+            }
+            else return r;
+        });
+        tt.same(rs, [
+            'TAP version 13',
+            'timeoutAfter',
+            { id: 1, ok: false, name: 'test timed out after 1ms' },
+            'tests 1',
+            'pass  0',
+            'fail  1'
+        ]);
+    });
+    
+    test.createStream().pipe(tc);
+    
+    test('timeoutAfter', function (t) {
+        t.plan(1);
+        t.timeoutAfter(1);
+    });
+});