/
base.spec.js
430 lines (347 loc) · 11.1 KB
/
base.spec.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
'use strict';
var assert = require('assert');
var chaiExpect = require('chai').expect;
var sinon = require('sinon');
var Base = require('../../lib/reporters/base');
var AssertionError = assert.AssertionError;
var makeTest = require('./helpers').makeTest;
var createElements = require('./helpers').createElements;
describe('Base reporter', function() {
var stdout;
var stdoutWrite;
var useColors;
var err;
var errOut;
var test;
function list(tests) {
Base.useColors = false;
var retval = Base.list(tests);
Base.useColors = useColors;
return retval;
}
function generateDiff(actual, expected) {
Base.useColors = false;
var retval = Base.generateDiff(actual, expected);
Base.useColors = useColors;
return retval;
}
beforeEach(function() {
useColors = Base.useColors;
stdout = [];
stdoutWrite = process.stdout.write;
process.stdout.write = function(string, enc, callback) {
stdout.push(string);
stdoutWrite.call(process.stdout, string, enc, callback);
};
});
afterEach(function() {
process.stdout.write = stdoutWrite;
});
describe('showDiff', function() {
beforeEach(function() {
err = new AssertionError({actual: 'foo', expected: 'bar'});
});
it('should show diffs by default', function() {
test = makeTest(err);
list([test]);
errOut = stdout.join('\n');
expect(errOut, 'to match', /- actual/);
expect(errOut, 'to match', /\+ expected/);
});
it('should show diffs if property set to `true`', function() {
err.showDiff = true;
test = makeTest(err);
list([test]);
errOut = stdout.join('\n');
expect(errOut, 'to match', /- actual/);
expect(errOut, 'to match', /\+ expected/);
});
it('should not show diffs when showDiff property set to `false`', function() {
err.showDiff = false;
test = makeTest(err);
list([test]);
errOut = stdout.join('\n');
expect(errOut, 'not to match', /- actual/);
expect(errOut, 'not to match', /\+ expected/);
});
it('should not show diffs when expected is not defined', function() {
err = new Error('ouch');
test = makeTest(err);
list([test]);
errOut = stdout.join('\n');
expect(errOut, 'not to match', /- actual/);
expect(errOut, 'not to match', /\+ expected/);
});
it('should not show diffs when hideDiff is set', function() {
test = makeTest(err);
Base.hideDiff = true;
list([test]);
Base.hideDiff = false; // Revert to original value
errOut = stdout.join('\n');
expect(errOut, 'not to match', /- actual/);
expect(errOut, 'not to match', /\+ expected/);
});
});
describe('Getting two strings', function() {
// Fix regression V1.2.1(see: issue #1241)
it('should show strings diff as is', function() {
err = new Error('test');
err.actual = 'foo\nbar';
err.expected = 'foo\nbaz';
err.showDiff = true;
test = makeTest(err);
list([test]);
errOut = stdout.join('\n');
expect(errOut, 'not to match', /"foo\\nbar"/);
expect(errOut, 'to match', /foo/).and('to match', /bar/);
expect(errOut, 'to match', /test/);
expect(errOut, 'to match', /actual/);
expect(errOut, 'to match', /expected/);
});
});
describe('Diff generation', function() {
var oldInlineDiffs;
var actual;
var expected;
var output;
beforeEach(function() {
oldInlineDiffs = Base.inlineDiffs;
});
afterEach(function() {
Base.inlineDiffs = oldInlineDiffs;
});
it('should generate unified diffs if `inlineDiff === false`', function() {
actual = 'a foo unified diff';
expected = 'a bar unified diff';
Base.inlineDiffs = false;
output = generateDiff(actual, expected);
expect(
output,
'to be',
'\n + expected - actual\n\n -a foo unified diff\n +a bar unified diff\n '
);
});
it('should generate inline diffs if `inlineDiffs === true`', function() {
actual = 'a foo inline diff';
expected = 'a bar inline diff';
Base.inlineDiffs = true;
output = generateDiff(actual, expected);
expect(
output,
'to be',
' \n actual expected\n \n a foobar inline diff\n '
);
});
});
describe('Inline strings diff', function() {
it('should show single line diff if property set to `true`', function() {
err = new Error('test');
err.actual = 'a foo inline diff';
err.expected = 'a bar inline diff';
err.showDiff = true;
test = makeTest(err);
Base.inlineDiffs = true;
list([test]);
errOut = stdout.join('\n');
expect(errOut, 'to match', /a foobar inline diff/);
expect(errOut, 'to match', /test/);
expect(errOut, 'to match', /actual/);
expect(errOut, 'to match', /expected/);
});
it('should split lines when string has more than 4 line breaks', function() {
err = new Error('test');
err.actual = 'a\nfoo\ninline\ndiff\nwith\nmultiple lines';
err.expected = 'a\nbar\ninline\ndiff\nwith\nmultiple lines';
err.showDiff = true;
test = makeTest(err);
Base.inlineDiffs = true;
list([test]);
errOut = stdout.join('\n');
expect(errOut, 'to match', /1 \| a/);
expect(errOut, 'to match', /2 \| foobar/);
expect(errOut, 'to match', /3 \| inline/);
expect(errOut, 'to match', /4 \| diff/);
expect(errOut, 'to match', /5 \| with/);
expect(errOut, 'to match', /6 \| multiple lines/);
expect(errOut, 'to match', /test/);
expect(errOut, 'to match', /actual/);
expect(errOut, 'to match', /expected/);
});
});
describe('unified diff reporter', function() {
beforeEach(function() {
err = new Error('test');
});
it('should separate diff hunks by two dashes', function() {
err.actual = createElements({from: 2, to: 11});
err.expected = createElements({from: 1, to: 10});
err.showDiff = true;
test = makeTest(err);
Base.inlineDiffs = false;
list([test]);
errOut = stdout.join('\n');
var regexesToMatch = [
/\[/,
/\+ {2}"element 1"/,
/"element 2"/,
/"element 3"/,
/"element 4"/,
/"element 5"/,
/--/,
/"element 7"/,
/"element 8"/,
/"element 9"/,
/"element 10"/,
/- {2}"element 11"/,
/]/,
/test/,
/expected/,
/actual/
];
regexesToMatch.forEach(function(aRegex) {
expect(errOut, 'to match', aRegex);
});
});
});
it('should stringify objects', function() {
err = new Error('test');
err.actual = {key: 'a1'};
err.expected = {key: 'e1'};
err.showDiff = true;
test = makeTest(err);
list([test]);
errOut = stdout.join('\n');
expect(errOut, 'to match', /"key"/);
expect(errOut, 'to match', /test/);
expect(errOut, 'to match', /- actual/);
expect(errOut, 'to match', /\+ expected/);
});
it('should stringify Object.create(null)', function() {
err = new Error('test');
err.actual = Object.create(null);
err.actual.hasOwnProperty = 1;
err.expected = Object.create(null);
err.expected.hasOwnProperty = 2;
err.showDiff = true;
test = makeTest(err);
list([test]);
errOut = stdout.join('\n');
expect(errOut, 'to match', /"hasOwnProperty"/);
expect(errOut, 'to match', /test/);
expect(errOut, 'to match', /- actual/);
expect(errOut, 'to match', /\+ expected/);
});
it('should handle error messages that are not strings', function() {
try {
assert(false, true);
} catch (err) {
err.actual = false;
err.expected = true;
err.showDiff = true;
test = makeTest(err);
list([test]);
errOut = stdout.join('\n');
expect(errOut, 'to match', /\+true/);
expect(errOut, 'to match', /-false/);
expect(errOut, 'to match', /- actual/);
expect(errOut, 'to match', /\+ expected/);
}
});
it('should interpret Chai custom error messages', function() {
try {
chaiExpect(43, 'custom error message').to.equal(42);
} catch (err) {
err.actual = 43;
err.expected = 42;
err.showDiff = true;
test = makeTest(err);
list([test]);
errOut = stdout.join('\n');
expect(errOut, 'to match', /custom error message\n/)
.and('to match', /\+42/)
.and('to match', /-43/)
.and('to match', /- actual/)
.and('to match', /\+ expected/);
}
});
it('should interpret assert module custom error messages', function() {
try {
assert.strictEqual(43, 42, 'custom error message');
// AssertionError: custom error message: expected 43 to equal 42.
// assert.equal(43, 42, 'custom error message: expected 43 to equal 42.');
} catch (err) {
err.actual = 43;
err.expected = 42;
err.showDiff = true;
test = makeTest(err);
list([test]);
errOut = stdout.join('\n');
expect(errOut, 'to match', /custom error message\n/);
expect(errOut, 'to match', /\+42/);
expect(errOut, 'to match', /-43/);
expect(errOut, 'to match', /- actual/);
expect(errOut, 'to match', /\+ expected/);
}
});
it('should remove message from stack', function() {
err = {
message: 'Error',
stack: 'Error\nfoo\nbar',
showDiff: false
};
test = makeTest(err);
list([test]);
errOut = stdout.join('\n').trim();
expect(errOut, 'to be', '1) test title:\n Error\n foo\n bar');
});
it('should use the inspect() property if `message` is not set', function() {
err = {
showDiff: false,
inspect: function() {
return 'an error happened';
}
};
test = makeTest(err);
list([test]);
errOut = stdout.join('\n').trim();
expect(errOut, 'to be', '1) test title:\n an error happened');
});
it('should set an empty message if `message` and `inspect()` are not set', function() {
err = {
showDiff: false
};
test = makeTest(err);
list([test]);
errOut = stdout.join('\n').trim();
expect(errOut, 'to be', '1) test title:');
});
it('should not modify stack if it does not contain message', function() {
err = {
message: 'Error',
stack: 'foo\nbar',
showDiff: false
};
test = makeTest(err);
list([test]);
errOut = stdout.join('\n').trim();
expect(errOut, 'to be', '1) test title:\n Error\n foo\n bar');
});
describe('when reporter output immune to user test changes', function() {
var sandbox;
var baseConsoleLog;
beforeEach(function() {
sandbox = sinon.createSandbox();
sandbox.stub(console, 'log');
baseConsoleLog = sandbox.stub(Base, 'consoleLog');
});
it('should let you stub out console.log without effecting reporters output', function() {
Base.list([]);
baseConsoleLog.restore();
expect(baseConsoleLog, 'was called');
expect(console.log, 'was not called');
});
afterEach(function() {
sandbox.restore();
});
});
});