/
stub-test.js
3555 lines (2799 loc) · 108 KB
/
stub-test.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
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"use strict";
var referee = require("@sinonjs/referee");
var createStub = require("../lib/sinon/stub");
var createSpy = require("../lib/sinon/spy");
var createProxy = require("../lib/sinon/proxy");
var match = require("@sinonjs/samsam").createMatcher;
var assert = referee.assert;
var refute = referee.refute;
var fail = referee.fail;
var globalContext = typeof global !== "undefined" ? global : window;
function verifyFunctionName(func, expectedName) {
var descriptor = Object.getOwnPropertyDescriptor(func, "name");
if (descriptor && descriptor.configurable) {
// IE 11 functions don't have a name.
// Safari 9 has names that are not configurable.
assert.equals(descriptor.value, expectedName);
assert.equals(func.name, expectedName);
}
}
describe("stub", function () {
it("is spy", function () {
var stub = createStub();
assert.isFalse(stub.called);
assert.isFunction(stub.calledWith);
assert.isFunction(stub.calledOn);
});
it("does not define create method", function () {
var stub = createStub();
assert.isUndefined(stub.create);
});
it("fails if stubbing property on null", function () {
assert.exception(
function () {
createStub(null, "prop");
},
{
message: "Trying to stub property 'prop' of null",
}
);
});
it("throws a readable error if stubbing Symbol on null", function () {
if (typeof Symbol !== "function") {
this.skip();
}
assert.exception(
function () {
createStub(null, Symbol("apple pie"));
},
{
message: "Trying to stub property 'Symbol(apple pie)' of null",
}
);
});
it("should contain asynchronous versions of callsArg*, and yields* methods", function () {
var stub = createStub();
var syncVersions = 0;
var asyncVersions = 0;
for (var method in stub) {
if (
stub.hasOwnProperty(method) &&
method.match(/^(callsArg|yields)/)
) {
if (!method.match(/Async/)) {
syncVersions++;
} else if (method.match(/Async/)) {
asyncVersions++;
}
}
}
assert.same(
syncVersions,
asyncVersions,
"Stub prototype should contain same amount of synchronous and asynchronous methods"
);
});
it("should allow overriding async behavior with sync behavior", function () {
var stub = createStub();
var callback = createSpy();
stub.callsArgAsync(1);
stub.callsArg(1);
stub(1, callback);
assert(callback.called);
});
it("should works with combination of withArgs arguments", function () {
var stub = createStub();
stub.returns(0);
stub.withArgs(1, 1).returns(2);
stub.withArgs(1).returns(1);
assert.equals(stub(), 0);
assert.equals(stub(1), 1);
assert.equals(stub(1, 1), 2);
assert.equals(stub(1, 1, 1), 2);
assert.equals(stub(2), 0);
});
it("should work with combination of withArgs arguments", function () {
var stub = createStub();
stub.withArgs(1).returns(42);
stub(1);
refute.isNull(stub.withArgs(1).firstCall);
});
it("retains function name", function () {
var object = {
test: function test() {
return;
},
};
var stub = createStub(object, "test");
assert.equals(stub.displayName, "test");
verifyFunctionName(stub, "test");
});
describe("non enumerable properties", function () {
it("create and call spy apis", function () {
var stub = createStub();
assert.equals(Object.keys(stub), []);
// call spy and verify no enumerable properties are added
stub(15);
assert.equals(Object.keys(stub), []);
// it should still work to add properties
stub.fooBar = 1;
assert.equals(Object.keys(stub), ["fooBar"]);
// call some spy APIs and verify no enumerable properties are added
stub.withArgs(1);
stub.calledBefore(createStub());
stub.calledAfter(createStub());
stub.calledOn(undefined);
stub.calledWith(15);
stub.calledWithNew();
stub.threw();
stub.returned("ret");
assert.equals(stub.thisValues.length, 1);
assert.equals(stub.exceptions.length, 1);
assert.equals(stub.returnValues.length, 1);
assert.equals(Object.keys(stub), ["fooBar"]);
// verify that reset history doesn't change enumerable properties
stub.resetHistory();
assert.equals(Object.keys(stub), ["fooBar"]);
});
it("create stub from function on object", function () {
var func = function () {
throw new Error("aError");
};
var object = {
test: func,
};
func.aProp = 42;
createStub(object, "test");
assert.equals(object.test.aProp, 42);
assert.equals(Object.keys(object.test), Object.keys(func));
assert.equals(Object.keys(object.test), ["aProp"]);
object.test();
object.test.resetHistory();
assert.equals(Object.keys(object.test), ["aProp"]);
});
});
describe(".returns", function () {
it("returns specified value", function () {
var stub = createStub();
var object = {};
stub.returns(object);
assert.same(stub(), object);
});
it("returns should return stub", function () {
var stub = createStub();
assert.same(stub.returns(""), stub);
});
it("returns undefined", function () {
var stub = createStub();
assert.isUndefined(stub());
});
it("supersedes previous throws", function () {
var stub = createStub();
stub.throws().returns(1);
refute.exception(function () {
stub();
});
});
it("supersedes previous callsFake", function () {
var fakeFn = createStub().returns(2);
var stub = createStub().callsFake(fakeFn).returns(1);
assert.equals(stub(), 1);
refute(fakeFn.called);
});
it("throws only on the first call", function () {
var stub = createStub();
stub.returns("no exception");
stub.onFirstCall().throws();
assert.exception(function () {
stub();
});
// on the second call there is no exception
assert.same(stub(), "no exception");
});
});
describe(".resolves", function () {
before(function () {
if (typeof Promise === "undefined") {
this.skip();
}
});
afterEach(function () {
if (Promise.resolve.restore) {
Promise.resolve.restore();
}
});
it("returns a promise to the specified value", function () {
var stub = createStub();
var object = {};
stub.resolves(object);
return stub().then(function (actual) {
assert.same(actual, object);
});
});
it("should return the same stub", function () {
var stub = createStub();
assert.same(stub.resolves(""), stub);
});
it("supersedes previous throws", function () {
var stub = createStub();
stub.throws().resolves(1);
refute.exception(function () {
stub();
});
});
it("supersedes previous rejects", function () {
var stub = createStub();
stub.rejects(Error("should be superseded")).resolves(1);
return stub().then();
});
it("supersedes previous callsFake", function () {
var fakeFn = createStub().resolves(2);
var stub = createStub().callsFake(fakeFn).resolves(1);
return stub().then(function (actual) {
assert.same(actual, 1);
refute(fakeFn.called);
});
});
it("can be superseded by returns", function () {
var stub = createStub();
stub.resolves(2).returns(1);
assert.equals(stub(), 1);
});
it("does not invoke Promise.resolve when the behavior is added to the stub", function () {
var resolveSpy = createSpy(Promise, "resolve");
var stub = createStub();
stub.resolves(2);
assert.equals(resolveSpy.callCount, 0);
});
});
describe(".rejects", function () {
before(function () {
if (typeof Promise === "undefined") {
this.skip();
}
});
afterEach(function () {
if (Promise.reject.restore) {
Promise.reject.restore();
}
});
it("returns a promise which rejects for the specified reason", function () {
var stub = createStub();
var reason = new Error();
stub.rejects(reason);
return stub()
.then(function () {
referee.fail("this should not resolve");
})
.catch(function (actual) {
assert.same(actual, reason);
});
});
it("should return the same stub", function () {
var stub = createStub();
assert.same(stub.rejects({}), stub);
});
it("specifies exception message", function () {
var stub = createStub();
var message = "Oh no!";
stub.rejects("Error", message);
return stub()
.then(function () {
referee.fail("Expected stub to reject");
})
.catch(function (reason) {
assert.equals(reason.message, message);
});
});
it("does not specify exception message if not provided", function () {
var stub = createStub();
stub.rejects("Error");
return stub()
.then(function () {
referee.fail("Expected stub to reject");
})
.catch(function (reason) {
assert.equals(reason.message, "");
});
});
it("rejects for a generic reason", function () {
var stub = createStub();
stub.rejects();
return stub()
.then(function () {
referee.fail("Expected stub to reject");
})
.catch(function (reason) {
assert.equals(reason.name, "Error");
});
});
it("can be superseded by returns", function () {
var stub = createStub();
stub.rejects(2).returns(1);
assert.equals(stub(), 1);
});
it("supersedes previous callsFake", function () {
var fakeFn = createStub().resolves(2);
var reason = new Error();
var stub = createStub().callsFake(fakeFn).rejects(reason);
return stub()
.then(function () {
referee.fail("this should not resolve");
})
.catch(function (actual) {
assert.same(actual, reason);
refute(fakeFn.called);
});
});
it("does not invoke Promise.reject when the behavior is added to the stub", function () {
var rejectSpy = createSpy(Promise, "reject");
var stub = createStub();
stub.rejects(2);
assert.equals(rejectSpy.callCount, 0);
});
});
describe(".resolvesThis", function () {
before(function () {
if (typeof Promise === "undefined") {
this.skip();
}
});
afterEach(function () {
if (Promise.resolve.restore) {
Promise.resolve.restore();
}
});
it("returns a promise resolved with this", function () {
var instance = {};
instance.stub = createStub();
instance.stub.resolvesThis();
return instance.stub().then(function (actual) {
assert.same(actual, instance);
});
});
it("returns a promise resolved with the context bound with stub#call", function () {
var stub = createStub();
stub.resolvesThis();
var object = {};
return stub.call(object).then(function (actual) {
assert.same(actual, object);
});
});
it("returns a promise resolved with the context bound with stub#apply", function () {
var stub = createStub();
stub.resolvesThis();
var object = {};
return stub.apply(object).then(function (actual) {
assert.same(actual, object);
});
});
it("returns the stub itself, allowing to chain function calls", function () {
var stub = createStub();
assert.same(stub.resolvesThis(), stub);
});
it("overrides throws behavior for error objects", function () {
var instance = {};
instance.stub = createStub().throws(new Error()).resolvesThis();
return instance.stub().then(function (actual) {
assert.same(actual, instance);
});
});
it("overrides throws behavior for dynamically created errors", function () {
var instance = {};
instance.stub = createStub().throws().resolvesThis();
return instance.stub().then(function (actual) {
assert.same(actual, instance);
});
});
it("supersedes previous callsFake", function () {
var fakeInstance = {};
var fakeFn = createStub().resolves(fakeInstance);
var instance = {};
instance.stub = createStub().callsFake(fakeFn).resolvesThis();
return instance.stub().then(function (actual) {
assert.same(actual, instance);
refute(fakeFn.called);
});
});
});
describe(".resolvesArg", function () {
before(function () {
if (typeof Promise === "undefined") {
this.skip();
}
});
afterEach(function () {
if (Promise.resolve.restore) {
Promise.resolve.restore();
}
});
it("returns a promise to the argument at specified index", function () {
var stub = createStub();
var object = {};
stub.resolvesArg(0);
return stub(object).then(function (actual) {
assert.same(actual, object);
});
});
it("returns a promise to the argument at another specified index", function () {
var stub = createStub();
var object = {};
stub.resolvesArg(2);
return stub("ignored", "ignored again", object).then(function (
actual
) {
assert.same(actual, object);
});
});
it("should return the same stub", function () {
var stub = createStub();
assert.same(stub.resolvesArg(1), stub);
});
it("supersedes previous throws", function () {
var stub = createStub();
stub.throws().resolvesArg(1);
refute.exception(function () {
stub("zero", "one");
});
});
it("supersedes previous rejects", function () {
var stub = createStub();
stub.rejects(Error("should be superseded")).resolvesArg(1);
return stub("zero", "one").then(function (actual) {
assert.same(actual, "one");
});
});
it("supersedes previous callsFake", function () {
var fakeFn = createStub().resolves("fake");
var stub = createStub().callsFake(fakeFn).resolvesArg(1);
return stub("zero", "one").then(function (actual) {
assert.same(actual, "one");
refute(fakeFn.called);
});
});
it("does not invoke Promise.resolve when the behavior is added to the stub", function () {
var resolveSpy = createSpy(Promise, "resolve");
var stub = createStub();
stub.resolvesArg(2);
assert(resolveSpy.notCalled);
});
it("throws if index is not a number", function () {
var stub = createStub();
assert.exception(
function () {
stub.resolvesArg();
},
{ name: "TypeError" }
);
});
it("throws without enough arguments", function () {
var stub = createStub();
stub.resolvesArg(3);
assert.exception(
function () {
stub("zero", "one", "two");
},
{
name: "TypeError",
message:
"resolvesArg failed: 4 arguments required but only 3 present",
}
);
});
});
describe(".returnsArg", function () {
it("returns argument at specified index", function () {
var stub = createStub();
stub.returnsArg(0);
var object = {};
assert.same(stub(object), object);
});
it("returns stub", function () {
var stub = createStub();
assert.same(stub.returnsArg(0), stub);
});
it("supersedes previous callsFake", function () {
var fakeFn = createStub().returns("fake");
var stub = createStub().callsFake(fakeFn).returnsArg(0);
assert.equals(stub("myarg"), "myarg");
refute(fakeFn.called);
});
it("throws if no index is specified", function () {
var stub = createStub();
assert.exception(
function () {
stub.returnsArg();
},
{ name: "TypeError" }
);
});
it("should throw without enough arguments", function () {
var stub = createStub();
stub.returnsArg(3);
assert.exception(
function () {
stub("only", "two arguments");
},
{
name: "TypeError",
message:
"returnsArg failed: 4 arguments required but only 2 present",
}
);
});
});
describe(".throwsArg", function () {
it("throws argument at specified index", function () {
var stub = createStub();
stub.throwsArg(0);
var expectedError = new Error("The expected error message");
assert.exception(
function () {
stub(expectedError);
},
function (err) {
return err.message === expectedError.message;
}
);
});
it("returns stub", function () {
var stub = createStub();
assert.same(stub.throwsArg(0), stub);
});
it("throws TypeError if no index is specified", function () {
var stub = createStub();
assert.exception(
function () {
stub.throwsArg();
},
{ name: "TypeError" }
);
});
it("should throw without enough arguments", function () {
var stub = createStub();
stub.throwsArg(3);
assert.exception(
function () {
stub("only", "two arguments");
},
{
name: "TypeError",
message:
"throwsArg failed: 4 arguments required but only 2 present",
}
);
});
it("should work with call-based behavior", function () {
var stub = createStub();
var expectedError = new Error("catpants");
stub.returns(1);
stub.onSecondCall().throwsArg(1);
refute.exception(function () {
assert.equals(1, stub(null, expectedError));
});
assert.exception(
function () {
stub(null, expectedError);
},
function (error) {
return error.message === expectedError.message;
}
);
});
it("should be reset by .resetBehavior", function () {
var stub = createStub();
stub.throwsArg(0);
stub.resetBehavior();
refute.exception(function () {
stub(new Error("catpants"));
});
});
it("supersedes previous callsFake", function () {
var fakeFn = createStub();
var stub = createStub().callsFake(fakeFn).throwsArg(1);
var expectedError = new Error("catpants");
assert.exception(
function () {
stub(null, expectedError);
},
function (error) {
return error.message === expectedError.message;
}
);
refute(fakeFn.called);
});
});
describe(".returnsThis", function () {
it("stub returns this", function () {
var instance = {};
instance.stub = createStub();
instance.stub.returnsThis();
assert.same(instance.stub(), instance);
});
it("stub returns undefined when detached", function () {
var thisValue = (function () {
return this;
})();
if (thisValue !== undefined) {
this.skip();
}
var stub = createStub();
stub.returnsThis();
// Due to strict mode, would be `global` otherwise
assert.same(stub(), undefined);
});
it("stub respects call/apply", function () {
var stub = createStub();
stub.returnsThis();
var object = {};
assert.same(stub.call(object), object);
assert.same(stub.apply(object), object);
});
it("returns stub", function () {
var stub = createStub();
assert.same(stub.returnsThis(), stub);
});
it("supersedes previous callsFake", function () {
var fakeInstance = {};
var fakeFn = createStub().returns(fakeInstance);
var instance = {};
instance.stub = createStub();
instance.stub.callsFake(fakeFn).returnsThis();
assert.same(instance.stub(), instance);
refute(fakeFn.called);
});
});
describe(".usingPromise", function () {
before(function () {
if (typeof Promise === "undefined") {
this.skip();
}
});
it("should exist and be a function", function () {
var stub = createStub();
assert(stub.usingPromise);
assert.isFunction(stub.usingPromise);
});
it("should return the current stub", function () {
var stub = createStub();
assert.same(stub.usingPromise(Promise), stub);
});
it("should set the promise used by resolve", function () {
var stub = createStub();
var promise = {
resolve: createStub().callsFake(function (value) {
return Promise.resolve(value);
}),
};
var object = {};
stub.usingPromise(promise).resolves(object);
return stub().then(function (actual) {
assert.same(actual, object, "Same object resolved");
assert.isTrue(
promise.resolve.calledOnce,
"Custom promise resolve called once"
);
assert.isTrue(
promise.resolve.calledWith(object),
"Custom promise resolve called once with expected"
);
});
});
it("should set the promise used by reject", function () {
var stub = createStub();
var promise = {
reject: createStub().callsFake(function (err) {
return Promise.reject(err);
}),
};
var reason = new Error();
stub.usingPromise(promise).rejects(reason);
return stub()
.then(function () {
referee.fail("this should not resolve");
})
.catch(function (actual) {
assert.same(actual, reason, "Same object resolved");
assert.isTrue(
promise.reject.calledOnce,
"Custom promise reject called once"
);
assert.isTrue(
promise.reject.calledWith(reason),
"Custom promise reject called once with expected"
);
});
});
});
describe(".throws", function () {
it("throws specified exception", function () {
var stub = createStub();
var error = new Error();
stub.throws(error);
assert.exception(stub, error);
});
it("returns stub", function () {
var stub = createStub();
assert.same(stub.throws({}), stub);
});
it("sets type of exception to throw", function () {
var stub = createStub();
var exceptionType = "TypeError";
stub.throws(exceptionType);
assert.exception(function () {
stub();
}, exceptionType);
});
it("specifies exception message", function () {
var stub = createStub();
var message = "Oh no!";
stub.throws("Error", message);
assert.exception(stub, {
message: message,
});
});
it("does not specify exception message if not provided", function () {
var stub = createStub();
stub.throws("Error");
assert.exception(stub, {
message: "",
});
});
it("throws generic error", function () {
var stub = createStub();
stub.throws();
assert.exception(stub, "Error");
});
it("throws an exception created using a function", function () {
var stub = createStub();
stub.throws(function () {
return new Error("not implemented");
});
assert.exception(stub, {
message: "not implemented",
});
assert.same(stub.firstCall.exception.message, "not implemented");
assert.contains(stub.firstCall.toString(), "not implemented");
});
describe("lazy instantiation of exceptions", function () {
var errorSpy;
beforeEach(function () {
this.originalError = globalContext.Error;
errorSpy = createSpy(globalContext, "Error");
// errorSpy starts with a call already made, not sure why
errorSpy.resetHistory();
});
afterEach(function () {
errorSpy.restore();
globalContext.Error = this.originalError;
});
it("uses a lazily created exception for the generic error", function () {
var stub = createStub();
stub.throws();
assert.isFalse(errorSpy.called);
assert.exception(stub, "Error");
assert.isTrue(errorSpy.called);
});
it("uses a lazily created exception for the named error", function () {
var stub = createStub();
stub.throws("Named Error", "error message");
assert.isFalse(errorSpy.called);
assert.exception(stub, {
name: "Named Error",
message: "error message",
});
assert.isTrue(errorSpy.called);
});
it("uses a lazily created exception provided by a function", function () {
var stub = createStub();
stub.throws(function () {
return new Error("not implemented");
});
assert.isFalse(errorSpy.called);
assert.exception(stub, {
message: "not implemented",
});
assert.isTrue(errorSpy.called);
});
it("does not use a lazily created exception if the error object is provided", function () {
var stub = createStub();
var exception = new Error();
stub.throws(exception);
assert.same(errorSpy.callCount, 1);
assert.exception(stub, exception);
assert.same(errorSpy.callCount, 1);
});
});