-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
runnable.spec.js
729 lines (625 loc) · 20.8 KB
/
runnable.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
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
'use strict';
var Mocha = require('../../lib/mocha');
var Runnable = Mocha.Runnable;
var Suite = Mocha.Suite;
var sinon = require('sinon');
var STATE_FAILED = Runnable.constants.STATE_FAILED;
describe('Runnable(title, fn)', function() {
describe('#timeout(ms)', function() {
var MIN_TIMEOUT = 0;
var MAX_TIMEOUT = 2147483647; // INT_MAX (32-bit signed integer)
describe('when value is less than lower bound', function() {
it('should clamp to lower bound given numeric', function() {
var run = new Runnable();
run.timeout(-1);
expect(run.timeout(), 'to be', MIN_TIMEOUT);
});
it('should clamp to lower bound given timestamp', function() {
var run = new Runnable();
run.timeout('-1 ms');
expect(run.timeout(), 'to be', MIN_TIMEOUT);
});
});
describe('when value is equal to lower bound', function() {
var run;
beforeEach(function() {
run = new Runnable();
run.timeout(MIN_TIMEOUT);
});
describe('given numeric value', function() {
it('should set the timeout value', function() {
expect(run.timeout(), 'to be', MIN_TIMEOUT);
});
it('should disable timeouts', function() {
expect(run.enableTimeouts(), 'to be false');
});
});
describe('given string timestamp', function() {
it('should set the timeout value', function() {
expect(run.timeout(), 'to be', MIN_TIMEOUT);
});
it('should disable timeouts', function() {
expect(run.enableTimeouts(), 'to be false');
});
});
});
describe('when value is within `setTimeout` bounds', function() {
var run;
var timeout = 1000;
beforeEach(function() {
run = new Runnable();
run.timeout(timeout);
});
describe('given numeric value', function() {
it('should set the timeout value', function() {
expect(run.timeout(), 'to be', timeout);
});
it('should enable timeouts', function() {
expect(run.enableTimeouts(), 'to be true');
});
});
describe('given string timestamp', function() {
it('should set the timeout value', function() {
expect(run.timeout(), 'to be', timeout);
});
it('should enable timeouts', function() {
expect(run.enableTimeouts(), 'to be true');
});
});
});
describe('when value is equal to upper bound', function() {
var run;
beforeEach(function() {
run = new Runnable();
run.timeout(MAX_TIMEOUT);
});
describe('given numeric value', function() {
it('should set the timeout value', function() {
expect(run.timeout(), 'to be', MAX_TIMEOUT);
});
it('should disable timeouts', function() {
expect(run.enableTimeouts(), 'to be false');
});
});
describe('given string timestamp', function() {
it('should set the timeout value', function() {
expect(run.timeout(), 'to be', MAX_TIMEOUT);
});
it('should disable timeouts', function() {
expect(run.enableTimeouts(), 'to be false');
});
});
});
describe('when value is out-of-bounds', function() {
var run;
var timeout = MAX_TIMEOUT + 1;
beforeEach(function() {
run = new Runnable();
run.timeout(timeout);
});
describe('given numeric value', function() {
it('should clamp the value to max timeout', function() {
expect(run.timeout(), 'to be', MAX_TIMEOUT);
});
it('should enable timeouts', function() {
expect(run.enableTimeouts(), 'to be false');
});
});
describe('given string timestamp', function() {
it('should clamp the value to max timeout', function() {
expect(run.timeout(), 'to be', MAX_TIMEOUT);
});
it('should enable timeouts', function() {
expect(run.enableTimeouts(), 'to be false');
});
});
});
});
describe('#enableTimeouts(enabled)', function() {
it('should set enabled', function() {
var run = new Runnable();
run.enableTimeouts(false);
expect(run.enableTimeouts(), 'to be false');
});
});
describe('#slow(ms)', function() {
var run;
beforeEach(function() {
run = new Runnable();
});
it('should set the slow threshold', function() {
run.slow(100);
expect(run.slow(), 'to be', 100);
});
it('should not set the slow threshold if the parameter is not passed', function() {
run.slow();
expect(run.slow(), 'to be', 75);
});
it('should not set the slow threshold if the parameter is undefined', function() {
run.slow(undefined);
expect(run.slow(), 'to be', 75);
});
describe('when passed a time-formatted string', function() {
it('should convert to ms', function() {
run.slow('1s');
expect(run.slow(), 'to be', 1000);
});
});
});
describe('.title', function() {
it('should be present', function() {
expect(new Runnable('foo').title, 'to be', 'foo');
});
});
describe('.titlePath()', function() {
it("returns the concatenation of the parent's title path and runnable's title", function() {
var runnable = new Runnable('bar');
runnable.parent = new Suite('foo');
expect(
JSON.stringify(runnable.titlePath()),
'to be',
JSON.stringify(['foo', 'bar'])
);
});
});
describe('when arity >= 1', function() {
var run;
beforeEach(function() {
run = new Runnable('foo', function(done) {});
});
it('should be .async', function() {
expect(run.async, 'to be', 1);
});
it('should not be .sync', function() {
expect(run.sync, 'to be false');
});
});
describe('when arity == 0', function() {
var run;
beforeEach(function() {
run = new Runnable('foo', function() {});
});
it('should not be .async', function() {
expect(run.async, 'to be', 0);
});
it('should be .sync', function() {
expect(run.sync, 'to be true');
});
});
describe('#globals', function() {
it('should allow for whitelisting globals', function() {
var runnable = new Runnable('foo', function() {});
runnable.globals(['foobar']);
expect(runnable._allowedGlobals, 'to equal', ['foobar']);
});
});
describe('#retries(n)', function() {
it('should set the number of retries', function() {
var run = new Runnable();
run.retries(1);
expect(run.retries(), 'to be', 1);
});
});
describe('.run(fn)', function() {
describe('when .pending', function() {
it('should not invoke the callback', function(done) {
var spy = sinon.spy();
var runnable = new Runnable('foo', spy);
runnable.pending = true;
runnable.run(function(err) {
if (err) {
return done(err);
}
expect(spy, 'was not called');
done();
});
});
});
describe('when sync', function() {
describe('without error', function() {
it('should invoke the callback', function(done) {
var spy = sinon.spy();
var runnable = new Runnable('foo', spy);
runnable.run(function(err) {
if (err) {
return done(err);
}
expect(spy, 'was called times', 1);
done();
});
});
});
describe('when an exception is thrown', function() {
it('should invoke the callback with error', function(done) {
var stub = sinon.stub().throws('Error', 'fail');
var runnable = new Runnable('foo', stub);
runnable.run(function(err) {
expect(err.message, 'to be', 'fail');
expect(stub, 'was called');
done();
});
});
});
describe('when an exception is thrown and is allowed to remain uncaught', function() {
it('throws an error when it is allowed', function() {
var stub = sinon.stub().throws('Error', 'fail');
var runnable = new Runnable('foo', stub);
runnable.allowUncaught = true;
function fail() {
runnable.run(function() {});
}
expect(fail, 'to throw', 'fail');
});
});
});
describe('when timeouts are disabled', function() {
it('should not error with timeout', function(done) {
var runnable = new Runnable('foo', function(done) {
setTimeout(function() {
setTimeout(done);
}, 2);
});
runnable.timeout(1);
runnable.enableTimeouts(false);
runnable.run(function(err) {
expect(err, 'to be falsy');
done();
});
});
});
describe('when async', function() {
describe('without error', function() {
it('should invoke the callback', function(done) {
var runnable = new Runnable('foo', function(done) {
setTimeout(done);
});
runnable.run(function(err) {
expect(err, 'to be falsy');
done();
});
});
});
describe('when the callback is invoked several times', function() {
describe('without an error', function() {
it('should emit a single "error" event', function(done) {
var callbackSpy = sinon.spy();
var errorSpy = sinon.spy();
var runnable = new Runnable('foo', function(done) {
process.nextTick(done);
setTimeout(done);
setTimeout(done);
setTimeout(done);
});
// XXX too many diff assertions and very flimsy assertion that this
// event was only emitted once. think of a better way.
runnable.on('error', errorSpy).on('error', function(err) {
process.nextTick(function() {
expect(errorSpy, 'was called times', 1);
expect(err.message, 'to be', 'done() called multiple times');
expect(callbackSpy, 'was called times', 1);
done();
});
});
runnable.run(callbackSpy);
});
});
describe('with an error', function() {
it('should emit a single "error" event', function(done) {
var callbackSpy = sinon.spy();
var errorSpy = sinon.spy();
var runnable = new Runnable('foo', function(done) {
done(new Error('fail'));
setTimeout(done);
done(new Error('fail'));
setTimeout(done);
setTimeout(done);
});
// XXX too many diff assertions and very flimsy assertion that this
// event was only emitted once. think of a better way.
runnable.on('error', errorSpy).on('error', function(err) {
process.nextTick(function() {
expect(errorSpy, 'was called times', 1);
expect(
err.message,
'to be',
"fail (and Mocha's done() called multiple times)"
);
expect(callbackSpy, 'was called times', 1);
done();
});
});
runnable.run(callbackSpy);
});
});
});
describe('when an exception is thrown', function() {
it('should invoke the callback', function(done) {
var runnable = new Runnable(
'foo',
sinon.stub().throws('Error', 'fail')
);
runnable.run(function(err) {
expect(err.message, 'to be', 'fail');
done();
});
});
it('should not throw its own exception if passed a non-object', function(done) {
var runnable = new Runnable('foo', function(done) {
/* eslint no-throw-literal: off */
throw null;
});
runnable.run(function(err) {
expect(err.message, 'to be', Runnable.toValueOrError().message);
done();
});
});
});
describe('when an exception is thrown and is allowed to remain uncaught', function() {
it('throws an error when it is allowed', function(done) {
var runnable = new Runnable('foo', function(done) {
throw new Error('fail');
});
runnable.allowUncaught = true;
function fail() {
runnable.run(function() {});
}
expect(fail, 'to throw', 'fail');
done();
});
});
describe('when an error is passed', function() {
it('should invoke the callback', function(done) {
var runnable = new Runnable('foo', function(done) {
done(new Error('fail'));
});
runnable.run(function(err) {
expect(err.message, 'to be', 'fail');
done();
});
});
});
describe('when done() is invoked with a non-Error object', function() {
it('should invoke the callback', function(done) {
var runnable = new Runnable('foo', function(done) {
done({
error: 'Test error'
});
});
runnable.run(function(err) {
expect(
err.message,
'to be',
'done() invoked with non-Error: {"error":"Test error"}'
);
done();
});
});
});
describe('when done() is invoked with a string', function() {
it('should invoke the callback', function(done) {
var runnable = new Runnable('foo', function(done) {
done('Test error');
});
runnable.run(function(err) {
expect(
err.message,
'to be',
'done() invoked with non-Error: Test error'
);
done();
});
});
});
it('should allow updating the timeout', function(done) {
var spy = sinon.spy();
var runnable = new Runnable('foo', function(done) {
setTimeout(spy, 1);
setTimeout(spy, 100);
});
runnable.timeout(50);
runnable.run(function(err) {
expect(err, 'to be truthy');
expect(spy, 'was called times', 1);
done();
});
});
it('should allow a timeout of 0');
});
describe('when fn returns a promise', function() {
describe('when the promise is fulfilled with no value', function() {
var fulfilledPromise = {
then: function(fulfilled) {
setTimeout(fulfilled);
}
};
it('should invoke the callback', function(done) {
var runnable = new Runnable('foo', function() {
return fulfilledPromise;
});
runnable.run(function(err) {
expect(err, 'to be falsy');
done();
});
});
});
describe('when the promise is fulfilled with a value', function() {
var fulfilledPromise = {
then: function(fulfilled, rejected) {
setTimeout(function() {
fulfilled({});
});
}
};
it('should invoke the callback', function(done) {
var runnable = new Runnable('foo', function() {
return fulfilledPromise;
});
runnable.run(function(err) {
expect(err, 'to be falsy');
done();
});
});
});
describe('when the promise is rejected', function() {
var expectedErr = new Error('fail');
var rejectedPromise = {
then: function(fulfilled, rejected) {
setTimeout(function() {
rejected(expectedErr);
});
}
};
it('should invoke the callback', function(done) {
var runnable = new Runnable('foo', function() {
return rejectedPromise;
});
runnable.run(function(err) {
expect(err, 'to be', expectedErr);
done();
});
});
});
describe('when the promise is rejected without a reason', function() {
var expectedErr = new Error('Promise rejected with no or falsy reason');
var rejectedPromise = {
then: function(fulfilled, rejected) {
setTimeout(function() {
rejected();
});
}
};
it('should invoke the callback', function(done) {
var runnable = new Runnable('foo', function() {
return rejectedPromise;
});
runnable.run(function(err) {
expect(err.message, 'to be', expectedErr.message);
done();
});
});
});
describe('when the promise takes too long to settle', function() {
var foreverPendingPromise = {
then: function() {}
};
it('should throw the timeout error', function(done) {
var runnable = new Runnable('foo', function() {
return foreverPendingPromise;
});
runnable.file = '/some/path';
runnable.timeout(10);
runnable.run(function(err) {
expect(
err.message,
'to match',
/Timeout of 10ms exceeded.*\(\/some\/path\)$/
);
done();
});
});
});
});
describe('when fn returns a non-promise', function() {
it('should invoke the callback', function(done) {
var runnable = new Runnable('foo', function() {
return {
then: 'i ran my tests'
};
});
runnable.run(done);
});
});
describe('if timed-out', function() {
it('should ignore call to `done` and not execute callback again', function(done) {
var runnable = new Runnable('foo', function(done) {
setTimeout(done, 20);
});
runnable.timeout(10);
runnable.run(function(err) {
expect(err.message, 'to match', /^Timeout of 10ms/);
// timedOut is set *after* this callback is executed
process.nextTick(function() {
expect(runnable.timedOut, 'to be truthy');
done();
});
});
});
});
describe('if async', function() {
it('this.skip() should set runnable to pending', function(done) {
var runnable = new Runnable('foo', function(done) {
// normally "this" but it gets around having to muck with a context
runnable.skip();
});
runnable.run(function(err) {
expect(err, 'to be undefined');
expect(runnable.pending, 'to be true');
done();
});
});
it('this.skip() should halt synchronous execution', function(done) {
var aborted = true;
var runnable = new Runnable('foo', function(done) {
// normally "this" but it gets around having to muck with a context
runnable.skip();
aborted = false;
});
runnable.run(function() {
process.nextTick(function() {
expect(aborted, 'to be true');
done();
});
});
});
});
});
describe('#isFailed()', function() {
it('should return `true` if test has not failed', function() {
var runnable = new Runnable('foo', function() {});
// runner sets the state
runnable.run(function() {
expect(runnable.isFailed(), 'to be false');
});
});
it('should return `true` if test has failed', function() {
var runnable = new Runnable('foo', function() {});
// runner sets the state
runnable.state = STATE_FAILED;
runnable.run(function() {
expect(runnable.isFailed(), 'to be false');
});
});
it('should return `false` if test is pending', function() {
var runnable = new Runnable('foo', function() {});
// runner sets the state
runnable.isPending = function() {
return true;
};
runnable.run(function() {
expect(runnable.isFailed(), 'to be false');
});
});
});
describe('#resetTimeout()', function() {
it('should not time out if timeouts disabled after reset', function(done) {
var runnable = new Runnable('foo', function() {});
runnable.timeout(10);
runnable.resetTimeout();
runnable.enableTimeouts(false);
setTimeout(function() {
expect(runnable.timedOut, 'to be', false);
done();
}, 20);
});
});
describe('static method', function() {
describe('toValueOrError', function() {
it('should return identity if parameter is truthy', function() {
expect(Runnable.toValueOrError('foo'), 'to be', 'foo');
});
it('should return an Error if parameter is falsy', function() {
expect(Runnable.toValueOrError(null), 'to be an', Error);
});
});
});
});