Skip to content

Commit 9302682

Browse files
Tristan Daviesljharb
Tristan Davies
authored and
ljharb
committed
[New] show full error stack on failure
1 parent 5ec88e7 commit 9302682

13 files changed

+295
-29
lines changed

‎lib/results.js

+7-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
var defined = require('defined');
12
var EventEmitter = require('events').EventEmitter;
23
var inherits = require('inherits');
34
var through = require('through');
@@ -157,8 +158,12 @@ function encodeResult (res, count) {
157158
if (res.at) {
158159
output += inner + 'at: ' + res.at + '\n';
159160
}
160-
if (res.operator === 'error' && res.actual && res.actual.stack) {
161-
var lines = String(res.actual.stack).split('\n');
161+
162+
var actualStack = res.actual && res.actual.stack;
163+
var errorStack = res.error && res.error.stack;
164+
var stack = defined(actualStack, errorStack);
165+
if (stack) {
166+
var lines = String(stack).split('\n');
162167
output += inner + 'stack: |-\n';
163168
for (var i = 0; i < lines.length; i++) {
164169
output += inner + ' ' + lines[i] + '\n';

‎test/circular-things.js

+8-1
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,15 @@ var tape = require('../');
22
var tap = require('tap');
33
var concat = require('concat-stream');
44

5+
var stripFullStack = require('./common').stripFullStack;
6+
57
tap.test('circular test', function (assert) {
68
var test = tape.createHarness({ exit : false });
79
assert.plan(1);
810

911
test.createStream().pipe(concat(function (body) {
1012
assert.equal(
11-
body.toString('utf8'),
13+
stripFullStack(body.toString('utf8')),
1214
'TAP version 13\n'
1315
+ '# circular\n'
1416
+ 'not ok 1 should be equal\n'
@@ -18,6 +20,11 @@ tap.test('circular test', function (assert) {
1820
+ ' {}\n'
1921
+ ' actual: |-\n'
2022
+ ' { circular: [Circular] }\n'
23+
+ ' stack: |-\n'
24+
+ ' Error: should be equal\n'
25+
+ ' [... stack stripped ...]\n'
26+
+ ' at Test.<anonymous> ($TEST/circular-things.js:$LINE:$COL)\n'
27+
+ ' [... stack stripped ...]\n'
2128
+ ' ...\n'
2229
+ '\n'
2330
+ '1..1\n'

‎test/common.js

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
var yaml = require('js-yaml');
2+
3+
module.exports.getDiag = function (body) {
4+
var yamlStart = body.indexOf(' ---');
5+
var yamlEnd = body.indexOf(' ...\n');
6+
var diag = body.slice(yamlStart, yamlEnd).split('\n').map(function (line) {
7+
return line.slice(2);
8+
}).join('\n');
9+
10+
// The stack trace will vary depending on where the code is run, so just
11+
// strip it out.
12+
var withStack = yaml.safeLoad(diag);
13+
delete withStack.stack;
14+
return withStack;
15+
}
16+
17+
// There are three challenges associated with checking the stack traces included
18+
// in errors:
19+
// 1) The base checkout directory of tape might change. Because stack traces
20+
// include absolute paths, the stack traces will change depending on the
21+
// checkout path. We handle this by replacing the base test directory with a
22+
// placeholder $TEST variable.
23+
// 2) Line positions within the file might change. We handle this by replacing
24+
// line and column markers with placeholder $LINE and $COL "variables"
25+
// 3) Stacks themselves change frequently with refactoring. We've even run into
26+
// issues with node library refactorings "breaking" stack traces. Most of
27+
// these changes are irrelevant to the tests themselves. To counter this, we
28+
// strip out all stack frames that aren't directly under our test directory,
29+
// and replace them with placeholders.
30+
module.exports.stripFullStack = function (output) {
31+
var stripped = ' [... stack stripped ...]';
32+
var withDuplicates = output.split('\n').map(function (line) {
33+
var m = line.match(/[ ]{8}at .*\((.*)\)/);
34+
35+
var stripChangingData = function (line) {
36+
var withoutDirectory = line.replace(__dirname, '$TEST');
37+
var withoutLineNumbers = withoutDirectory.replace(/:\d+:\d+/g, ':$LINE:$COL');
38+
return withoutLineNumbers;
39+
}
40+
41+
if (m) {
42+
if (m[1].slice(0, __dirname.length) === __dirname) {
43+
return stripChangingData(line);
44+
}
45+
return stripped;
46+
}
47+
return stripChangingData(line);
48+
})
49+
50+
var deduped = withDuplicates.filter(function (line, ix) {
51+
var hasPrior = line === stripped && withDuplicates[ix - 1] === stripped;
52+
return !hasPrior;
53+
});
54+
55+
return deduped.join('\n');
56+
}

‎test/deep-equal-failure.js

+25-14
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@ var tape = require('../');
22
var tap = require('tap');
33
var concat = require('concat-stream');
44
var tapParser = require('tap-parser');
5-
var yaml = require('js-yaml');
5+
var common = require('./common');
6+
7+
var getDiag = common.getDiag;
8+
var stripFullStack = common.stripFullStack;
69

710
tap.test('deep equal failure', function (assert) {
811
var test = tape.createHarness({ exit : false });
@@ -13,7 +16,7 @@ tap.test('deep equal failure', function (assert) {
1316
stream.pipe(parser);
1417
stream.pipe(concat(function (body) {
1518
assert.equal(
16-
body.toString('utf8'),
19+
stripFullStack(body.toString('utf8')),
1720
'TAP version 13\n'
1821
+ '# deep equal\n'
1922
+ 'not ok 1 should be equal\n'
@@ -23,6 +26,11 @@ tap.test('deep equal failure', function (assert) {
2326
+ ' { b: 2 }\n'
2427
+ ' actual: |-\n'
2528
+ ' { a: 1 }\n'
29+
+ ' stack: |-\n'
30+
+ ' Error: should be equal\n'
31+
+ ' [... stack stripped ...]\n'
32+
+ ' at Test.<anonymous> ($TEST/deep-equal-failure.js:$LINE:$COL)\n'
33+
+ ' [... stack stripped ...]\n'
2634
+ ' ...\n'
2735
+ '\n'
2836
+ '1..1\n'
@@ -39,6 +47,7 @@ tap.test('deep equal failure', function (assert) {
3947
}));
4048

4149
parser.once('assert', function (data) {
50+
delete data.diag.stack;
4251
assert.deepEqual(data, {
4352
ok: false,
4453
id: 1,
@@ -66,7 +75,7 @@ tap.test('deep equal failure, depth 6, with option', function (assert) {
6675
stream.pipe(parser);
6776
stream.pipe(concat(function (body) {
6877
assert.equal(
69-
body.toString('utf8'),
78+
stripFullStack(body.toString('utf8')),
7079
'TAP version 13\n'
7180
+ '# deep equal\n'
7281
+ 'not ok 1 should be equal\n'
@@ -76,6 +85,11 @@ tap.test('deep equal failure, depth 6, with option', function (assert) {
7685
+ ' { a: { a1: { a2: { a3: { a4: { a5: 2 } } } } } }\n'
7786
+ ' actual: |-\n'
7887
+ ' { a: { a1: { a2: { a3: { a4: { a5: 1 } } } } } }\n'
88+
+ ' stack: |-\n'
89+
+ ' Error: should be equal\n'
90+
+ ' [... stack stripped ...]\n'
91+
+ ' at Test.<anonymous> ($TEST/deep-equal-failure.js:$LINE:$COL)\n'
92+
+ ' [... stack stripped ...]\n'
7993
+ ' ...\n'
8094
+ '\n'
8195
+ '1..1\n'
@@ -92,6 +106,7 @@ tap.test('deep equal failure, depth 6, with option', function (assert) {
92106
}));
93107

94108
parser.once('assert', function (data) {
109+
delete data.diag.stack;
95110
assert.deepEqual(data, {
96111
ok: false,
97112
id: 1,
@@ -119,7 +134,7 @@ tap.test('deep equal failure, depth 6, without option', function (assert) {
119134
stream.pipe(parser);
120135
stream.pipe(concat(function (body) {
121136
assert.equal(
122-
body.toString('utf8'),
137+
stripFullStack(body.toString('utf8')),
123138
'TAP version 13\n'
124139
+ '# deep equal\n'
125140
+ 'not ok 1 should be equal\n'
@@ -129,6 +144,11 @@ tap.test('deep equal failure, depth 6, without option', function (assert) {
129144
+ ' { a: { a1: { a2: { a3: { a4: [Object] } } } } }\n'
130145
+ ' actual: |-\n'
131146
+ ' { a: { a1: { a2: { a3: { a4: [Object] } } } } }\n'
147+
+ ' stack: |-\n'
148+
+ ' Error: should be equal\n'
149+
+ ' [... stack stripped ...]\n'
150+
+ ' at Test.<anonymous> ($TEST/deep-equal-failure.js:$LINE:$COL)\n'
151+
+ ' [... stack stripped ...]\n'
132152
+ ' ...\n'
133153
+ '\n'
134154
+ '1..1\n'
@@ -145,6 +165,7 @@ tap.test('deep equal failure, depth 6, without option', function (assert) {
145165
}));
146166

147167
parser.once('assert', function (data) {
168+
delete data.diag.stack;
148169
assert.deepEqual(data, {
149170
ok: false,
150171
id: 1,
@@ -162,13 +183,3 @@ tap.test('deep equal failure, depth 6, without option', function (assert) {
162183
t.equal({ a: { a1: { a2: { a3: { a4: { a5: 1 } } } } } }, { a: { a1: { a2: { a3: { a4: { a5: 2 } } } } } });
163184
});
164185
})
165-
166-
function getDiag (body) {
167-
var yamlStart = body.indexOf(' ---');
168-
var yamlEnd = body.indexOf(' ...\n');
169-
var diag = body.slice(yamlStart, yamlEnd).split('\n').map(function (line) {
170-
return line.slice(2);
171-
}).join('\n');
172-
173-
return yaml.safeLoad(diag);
174-
}

‎test/double_end.js

+30-1
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,49 @@ var path = require('path');
33
var concat = require('concat-stream');
44
var spawn = require('child_process').spawn;
55

6+
var stripFullStack = require('./common').stripFullStack;
7+
68
test(function (t) {
79
t.plan(2);
810
var ps = spawn(process.execPath, [path.join(__dirname, 'double_end', 'double.js')]);
911
ps.on('exit', function (code) {
1012
t.equal(code, 1);
1113
});
1214
ps.stdout.pipe(concat(function (body) {
13-
t.equal(body.toString('utf8'), [
15+
// The implementation of node's timer library has changed over time. We
16+
// need to reverse engineer the error we expect to see.
17+
18+
// This code is unfortunately by necessity highly coupled to node
19+
// versions, and may require tweaking with future versions of the timers
20+
// library.
21+
function doEnd() { throw new Error() };
22+
var to = setTimeout(doEnd, 5000);
23+
clearTimeout(to);
24+
to._onTimeout = doEnd;
25+
26+
var stackExpected;
27+
try {
28+
to._onTimeout();
29+
}
30+
catch (e) {
31+
stackExpected = stripFullStack(e.stack).split('\n')[1];
32+
stackExpected = stackExpected.replace('double_end.js', 'double_end/double.js');
33+
stackExpected = stackExpected.trim();
34+
}
35+
36+
var stripped = stripFullStack(body.toString('utf8'));
37+
t.equal(stripped, [
1438
'TAP version 13',
1539
'# double end',
1640
'ok 1 should be equal',
1741
'not ok 2 .end() called twice',
1842
' ---',
1943
' operator: fail',
44+
' stack: |-',
45+
' Error: .end() called twice',
46+
' [... stack stripped ...]',
47+
' ' + stackExpected,
48+
' [... stack stripped ...]',
2049
' ...',
2150
'',
2251
'1..2',

‎test/double_end/double.js

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
var test = require('../../');
22

33
test('double end', function (t) {
4+
function doEnd() {
5+
t.end();
6+
}
7+
48
t.equal(1 + 1, 2);
59
t.end();
6-
setTimeout(function () {
7-
t.end();
8-
}, 5);
10+
setTimeout(doEnd, 5);
911
});

‎test/exit.js

+19-3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ var path = require('path');
33
var spawn = require('child_process').spawn;
44
var concat = require('concat-stream');
55

6+
var stripFullStack = require('./common').stripFullStack;
7+
68
tap.test('exit ok', function (t) {
79
t.plan(2);
810

@@ -38,7 +40,7 @@ tap.test('exit fail', function (t) {
3840
t.plan(2);
3941

4042
var tc = function (rows) {
41-
t.same(rows.toString('utf8'), [
43+
t.same(stripFullStack(rows.toString('utf8')), [
4244
'TAP version 13',
4345
'# array',
4446
'ok 1 should be equivalent',
@@ -50,6 +52,14 @@ tap.test('exit fail', function (t) {
5052
' operator: deepEqual',
5153
' expected: [ [ 1, 2, [ 3, 4444 ] ], [ 5, 6 ] ]',
5254
' actual: [ [ 1, 2, [ 3, 4 ] ], [ 5, 6 ] ]',
55+
' stack: |-',
56+
' Error: should be equivalent',
57+
' [... stack stripped ...]',
58+
' at $TEST/exit/fail.js:$LINE:$COL',
59+
' at eval (eval at <anonymous> ($TEST/exit/fail.js:$LINE:$COL), <anonymous>:$LINE:$COL)',
60+
' at eval (eval at <anonymous> ($TEST/exit/fail.js:$LINE:$COL), <anonymous>:$LINE:$COL)',
61+
' at Test.<anonymous> ($TEST/exit/fail.js:$LINE:$COL)',
62+
' [... stack stripped ...]',
5363
' ...',
5464
'',
5565
'1..5',
@@ -70,7 +80,7 @@ tap.test('too few exit', function (t) {
7080
t.plan(2);
7181

7282
var tc = function (rows) {
73-
t.same(rows.toString('utf8'), [
83+
t.same(stripFullStack(rows.toString('utf8')), [
7484
'TAP version 13',
7585
'# array',
7686
'ok 1 should be equivalent',
@@ -83,6 +93,9 @@ tap.test('too few exit', function (t) {
8393
' operator: fail',
8494
' expected: 6',
8595
' actual: 5',
96+
' stack: |-',
97+
' Error: plan != count',
98+
' [... stack stripped ...]',
8699
' ...',
87100
'',
88101
'1..6',
@@ -103,7 +116,7 @@ tap.test('more planned in a second test', function (t) {
103116
t.plan(2);
104117

105118
var tc = function (rows) {
106-
t.same(rows.toString('utf8'), [
119+
t.same(stripFullStack(rows.toString('utf8')), [
107120
'TAP version 13',
108121
'# first',
109122
'ok 1 should be truthy',
@@ -114,6 +127,9 @@ tap.test('more planned in a second test', function (t) {
114127
' operator: fail',
115128
' expected: 2',
116129
' actual: 1',
130+
' stack: |-',
131+
' Error: plan != count',
132+
' [... stack stripped ...]',
117133
' ...',
118134
'',
119135
'1..3',

‎test/fail.js

+11-1
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,14 @@ var tape = require('../');
33
var tap = require('tap');
44
var concat = require('concat-stream');
55

6+
var stripFullStack = require('./common').stripFullStack;
7+
68
tap.test('array test', function (tt) {
79
tt.plan(1);
810

911
var test = tape.createHarness({ exit : false });
1012
var tc = function (rows) {
11-
tt.same(rows.toString('utf8'), [
13+
tt.same(stripFullStack(rows.toString('utf8')), [
1214
'TAP version 13',
1315
'# array',
1416
'ok 1 should be equivalent',
@@ -20,6 +22,14 @@ tap.test('array test', function (tt) {
2022
' operator: deepEqual',
2123
' expected: [ [ 1, 2, [ 3, 4444 ] ], [ 5, 6 ] ]',
2224
' actual: [ [ 1, 2, [ 3, 4 ] ], [ 5, 6 ] ]',
25+
' stack: |-',
26+
' Error: should be equivalent',
27+
' [... stack stripped ...]',
28+
' at $TEST/fail.js:$LINE:$COL',
29+
' at eval (eval at <anonymous> ($TEST/fail.js:$LINE:$COL), <anonymous>:$LINE:$COL)',
30+
' at eval (eval at <anonymous> ($TEST/fail.js:$LINE:$COL), <anonymous>:$LINE:$COL)',
31+
' at Test.<anonymous> ($TEST/fail.js:$LINE:$COL)',
32+
' [... stack stripped ...]',
2333
' ...',
2434
'',
2535
'1..5',

0 commit comments

Comments
 (0)