Permalink
Jul 7, 2016
Jul 7, 2016
Sep 26, 2017
Jul 7, 2016
Feb 9, 2022
Mar 2, 2019
Jul 7, 2016
Apr 21, 2019
May 27, 2019
Apr 8, 2019
Jul 7, 2016
Apr 2, 2019
Apr 8, 2019
Apr 8, 2019
Apr 13, 2019
Dec 8, 2016
Jul 7, 2016
Sep 6, 2019
Feb 13, 2019
Feb 13, 2019
Feb 13, 2019
Feb 12, 2019
Feb 12, 2019
Mar 20, 2019
Apr 25, 2019
Apr 25, 2019
Apr 25, 2019
Feb 12, 2019
Feb 12, 2019
Mar 2, 2019
Mar 2, 2019
Dec 5, 2020
Dec 5, 2020
Dec 5, 2020
Mar 2, 2019
Mar 2, 2019
Mar 2, 2019
Mar 2, 2019
Mar 2, 2019
Mar 2, 2019
Mar 2, 2019
Mar 2, 2019
Mar 2, 2019
Mar 2, 2019
Apr 13, 2019
Apr 13, 2019
Dec 8, 2016
Feb 22, 2019
Dec 18, 2018
Feb 22, 2019
Feb 22, 2019
Apr 21, 2019
Apr 21, 2019
Apr 21, 2019
Apr 21, 2019
Feb 23, 2022
Feb 28, 2022
Apr 21, 2019
Apr 21, 2019
Apr 21, 2019
Apr 21, 2019
Feb 28, 2022
Mar 2, 2019
Feb 20, 2019
Feb 28, 2022
Mar 2, 2019
Feb 28, 2022
Mar 2, 2019
Mar 2, 2019
Apr 22, 2019
Apr 22, 2019
Apr 13, 2019
Apr 13, 2019
Apr 19, 2018
Jul 7, 2016
Newer
100644
963 lines (842 sloc)
30.1 KB
1
/**
3
*
4
* This source code is licensed under the MIT license found in the
5
* LICENSE file in the root directory of this source tree.
6
*
7
*/
8
11
import {
12
arrayBufferEquality,
13
equals,
14
getObjectSubset,
15
getPath,
16
iterableEquality,
17
pathAsArray,
18
sparseArrayEquality,
19
subsetEquality,
20
typeEquality,
21
} from '@jest/expect-utils';
48
printReceivedStringContainExpectedResult,
49
printReceivedStringContainExpectedSubstring,
50
} from './print';
52
53
// Omit colon and one or more spaces, so can call getLabelPrinter.
54
const EXPECTED_LABEL = 'Expected';
55
const RECEIVED_LABEL = 'Received';
56
const EXPECTED_VALUE_LABEL = 'Expected value';
57
const RECEIVED_VALUE_LABEL = 'Received value';
59
// The optional property of matcher context is true if undefined.
60
const isExpand = (expand?: boolean): boolean => expand !== false;
61
62
const toStrictEqualTesters = [
63
iterableEquality,
64
typeEquality,
65
sparseArrayEquality,
76
const matchers: MatchersObject = {
79
const options: MatcherHintOptions = {
80
comment: 'Object.is equality',
81
isNot: this.isNot,
95
96
let deepEqualityName = null;
97
if (expectedType !== 'map' && expectedType !== 'set') {
98
// If deep equality passes when referential identity fails,
99
// but exclude map and set until review of their equality logic.
100
if (equals(received, expected, toStrictEqualTesters, true)) {
101
deepEqualityName = 'toStrictEqual';
102
} else if (equals(received, expected, [iterableEquality])) {
103
deepEqualityName = 'toEqual';
104
}
105
}
106
113
`If it should pass with deep equality, replace "${matcherName}" with "${deepEqualityName}"`,
116
printDiffOrStringify(
117
expected,
118
received,
119
EXPECTED_LABEL,
120
RECEIVED_LABEL,
127
// could access them, for example in order to display a custom visual diff,
128
// or create a different error message
130
},
142
143
if (typeof expected !== 'number') {
144
throw new Error(
145
matcherErrorMessage(
146
matcherHint(matcherName, undefined, undefined, options),
147
`${EXPECTED_COLOR('expected')} value must be a number`,
148
printWithType('Expected', expected, printExpected),
149
),
150
);
151
}
152
153
if (typeof received !== 'number') {
154
throw new Error(
155
matcherErrorMessage(
156
matcherHint(matcherName, undefined, undefined, options),
157
`${RECEIVED_COLOR('received')} value must be a number`,
158
printWithType('Received', received, printReceived),
159
),
160
);
161
}
164
let expectedDiff = 0;
165
let receivedDiff = 0;
166
167
if (received === Infinity && expected === Infinity) {
168
pass = true; // Infinity - Infinity is NaN
169
} else if (received === -Infinity && expected === -Infinity) {
170
pass = true; // -Infinity - -Infinity is NaN
171
} else {
172
expectedDiff = Math.pow(10, -precision) / 2;
173
receivedDiff = Math.abs(expected - received);
174
pass = receivedDiff < expectedDiff;
175
}
181
'\n\n' +
182
`Expected: not ${printExpected(expected)}\n` +
183
(receivedDiff === 0
184
? ''
185
: `Received: ${printReceived(received)}\n` +
190
'\n\n' +
191
`Expected: ${printExpected(expected)}\n` +
192
`Received: ${printReceived(received)}\n` +
193
'\n' +
252
`Expected:${isNot ? ' not' : ''} > ${printExpected(expected)}\n` +
253
`Received:${isNot ? ' ' : ''} ${printReceived(received)}`;
254
273
`Expected:${isNot ? ' not' : ''} >= ${printExpected(expected)}\n` +
274
`Received:${isNot ? ' ' : ''} ${printReceived(received)}`;
275
281
const options: MatcherHintOptions = {
282
isNot: this.isNot,
283
promise: this.promise,
284
};
303
printExpectedConstructorNameNot('Expected constructor', expected) +
304
(typeof received.constructor === 'function' &&
305
received.constructor !== expected
306
? printReceivedConstructorNameNot(
307
'Received constructor',
308
received.constructor,
309
expected,
310
)
311
: '')
318
? `\nReceived value has no prototype\nReceived value: ${printReceived(
319
received,
320
)}`
322
? `\nReceived value: ${printReceived(received)}`
323
: printReceivedConstructorName(
324
'Received constructor',
325
received.constructor,
326
));
346
`Expected:${isNot ? ' not' : ''} < ${printExpected(expected)}\n` +
347
`Received:${isNot ? ' ' : ''} ${printReceived(received)}`;
348
367
`Expected:${isNot ? ' not' : ''} <= ${printExpected(expected)}\n` +
368
`Received:${isNot ? ' ' : ''} ${printReceived(received)}`;
369
451
const isNot = this.isNot;
452
const options: MatcherHintOptions = {
453
comment: 'indexOf',
454
isNot,
455
promise: this.promise,
456
};
462
`${RECEIVED_COLOR('received')} value must not be null nor undefined`,
463
printWithType('Received', received, printReceived),
464
),
465
);
466
}
467
468
if (typeof received === 'string') {
469
const wrongTypeErrorMessage = `${EXPECTED_COLOR(
470
'expected',
471
)} value must be a string if ${RECEIVED_COLOR(
472
'received',
473
)} value is a string`;
474
476
throw new Error(
477
matcherErrorMessage(
478
matcherHint(matcherName, received, String(expected), options),
479
wrongTypeErrorMessage,
481
printWithType('Expected', expected, printExpected) +
482
'\n' +
483
printWithType('Received', received, printReceived),
484
),
485
);
486
}
487
488
const index = received.indexOf(String(expected));
489
const pass = index !== -1;
490
491
const message = () => {
492
const labelExpected = `Expected ${
493
typeof expected === 'string' ? 'substring' : 'value'
494
}`;
495
const labelReceived = 'Received string';
496
const printLabel = getLabelPrinter(labelExpected, labelReceived);
497
498
return (
501
'\n\n' +
502
`${printLabel(labelExpected)}${isNot ? 'not ' : ''}${printExpected(
503
expected,
504
)}\n` +
505
`${printLabel(labelReceived)}${isNot ? ' ' : ''}${
506
isNot
507
? printReceivedStringContainExpectedSubstring(
508
received,
509
index,
510
String(expected).length,
511
)
512
: printReceived(received)
513
}`
519
520
const indexable = Array.from(received);
521
const index = indexable.indexOf(expected);
522
const pass = index !== -1;
523
525
const labelExpected = 'Expected value';
526
const labelReceived = `Received ${getType(received)}`;
527
const printLabel = getLabelPrinter(labelExpected, labelReceived);
533
`${printLabel(labelExpected)}${isNot ? 'not ' : ''}${printExpected(
534
expected,
535
)}\n` +
536
`${printLabel(labelReceived)}${isNot ? ' ' : ''}${
537
isNot && Array.isArray(received)
538
? printReceivedArrayContainExpectedItem(received, index)
539
: printReceived(received)
540
}` +
541
(!isNot &&
542
indexable.findIndex(item =>
543
equals(item, expected, [iterableEquality]),
544
) !== -1
545
? `\n\n${SUGGEST_TO_CONTAIN_EQUAL}`
546
: '')
555
const isNot = this.isNot;
556
const options: MatcherHintOptions = {
557
comment: 'deep equality',
558
isNot,
559
promise: this.promise,
560
};
561
562
if (received == null) {
563
throw new Error(
564
matcherErrorMessage(
566
`${RECEIVED_COLOR('received')} value must not be null nor undefined`,
567
printWithType('Received', received, printReceived),
568
),
569
);
572
const index = Array.from(received).findIndex(item =>
573
equals(item, expected, [iterableEquality]),
574
);
575
const pass = index !== -1;
576
578
const labelExpected = 'Expected value';
579
const labelReceived = `Received ${getType(received)}`;
580
const printLabel = getLabelPrinter(labelExpected, labelReceived);
586
`${printLabel(labelExpected)}${isNot ? 'not ' : ''}${printExpected(
587
expected,
588
)}\n` +
589
`${printLabel(labelReceived)}${isNot ? ' ' : ''}${
590
isNot && Array.isArray(received)
591
? printReceivedArrayContainExpectedItem(received, index)
592
: printReceived(received)
593
}`
615
`Expected: not ${printExpected(expected)}\n` +
616
(stringify(expected) !== stringify(received)
617
? `Received: ${printReceived(received)}`
618
: '')
619
: () =>
621
matcherHint(matcherName, undefined, undefined, options) +
622
'\n\n' +
623
printDiffOrStringify(
624
expected,
625
received,
626
EXPECTED_LABEL,
627
RECEIVED_LABEL,
632
// could access them, for example in order to display a custom visual diff,
633
// or create a different error message
639
const isNot = this.isNot;
640
const options: MatcherHintOptions = {
641
isNot,
642
promise: this.promise,
643
};
644
649
`${RECEIVED_COLOR(
650
'received',
651
)} value must have a length property whose value must be a number`,
652
printWithType('Received', received, printReceived),
653
),
654
);
655
}
656
662
const labelExpected = 'Expected length';
663
const labelReceivedLength = 'Received length';
664
const labelReceivedValue = `Received ${getType(received)}`;
678
(isNot
679
? ''
680
: `${printLabel(labelReceivedLength)}${printReceived(
681
received.length,
682
)}\n`) +
683
`${printLabel(labelReceivedValue)}${isNot ? ' ' : ''}${printReceived(
684
received,
685
)}`
693
received: object,
694
expectedPath: string | Array<string>,
695
expectedValue?: unknown,
697
const matcherName = 'toHaveProperty';
698
const expectedArgument = 'path';
699
const hasValue = arguments.length === 3;
731
: expectedPath.length;
732
733
if (expectedPathType === 'array' && expectedPathLength === 0) {
734
throw new Error(
735
matcherErrorMessage(
736
matcherHint(matcherName, undefined, expectedArgument, options),
737
`${EXPECTED_COLOR('expected')} path must not be an empty array`,
738
printWithType('Expected', expectedPath, printExpected),
739
),
740
);
741
}
745
const receivedPath = result.traversedPath;
746
const hasCompletePath = receivedPath.length === expectedPathLength;
747
const receivedValue = hasCompletePath ? result.value : lastTraversedObject;
748
749
const pass =
750
hasValue && endPropIsDefined
751
? equals(value, expectedValue, [iterableEquality])
752
: Boolean(hasEndProp);
761
`Expected value: not ${printExpected(expectedValue)}${
762
stringify(expectedValue) !== stringify(receivedValue)
763
? `\nReceived value: ${printReceived(receivedValue)}`
764
: ''
765
}`
766
: `Expected path: not ${printExpected(expectedPath)}\n\n` +
767
`Received value: ${printReceived(receivedValue)}`)
768
: () =>
770
matcherHint(matcherName, undefined, expectedArgument, options) +
771
'\n\n' +
772
`Expected path: ${printExpected(expectedPath)}\n` +
773
(hasCompletePath
775
expectedValue,
776
receivedValue,
777
EXPECTED_VALUE_LABEL,
778
RECEIVED_VALUE_LABEL,
781
: `Received path: ${printReceived(
782
expectedPathType === 'array' || receivedPath.length === 0
783
? receivedPath
784
: receivedPath.join('.'),
785
)}\n\n${
786
hasValue
787
? `Expected value: ${printExpected(expectedValue)}\n`
788
: ''
789
}Received value: ${printReceived(receivedValue)}`);
796
const options: MatcherHintOptions = {
797
isNot: this.isNot,
798
promise: this.promise,
799
};
800
812
!(typeof expected === 'string') &&
813
!(expected && typeof expected.test === 'function')
834
? // eslint-disable-next-line prefer-template
835
matcherHint(matcherName, undefined, undefined, options) +
836
'\n\n' +
837
`Expected substring: not ${printExpected(expected)}\n` +
838
`Received string: ${printReceivedStringContainExpectedSubstring(
839
received,
840
received.indexOf(expected),
841
expected.length,
842
)}`
843
: // eslint-disable-next-line prefer-template
844
matcherHint(matcherName, undefined, undefined, options) +
845
'\n\n' +
846
`Expected pattern: not ${printExpected(expected)}\n` +
847
`Received string: ${printReceivedStringContainExpectedResult(
848
received,
849
typeof expected.exec === 'function'
850
? expected.exec(received)
851
: null,
852
)}`
853
: () => {
854
const labelExpected = `Expected ${
855
typeof expected === 'string' ? 'substring' : 'pattern'
856
}`;
857
const labelReceived = 'Received string';
858
const printLabel = getLabelPrinter(labelExpected, labelReceived);
859
860
return (
863
'\n\n' +
864
`${printLabel(labelExpected)}${printExpected(expected)}\n` +
865
`${printLabel(labelReceived)}${printReceived(received)}`
866
);
867
};
905
'\n\n' +
906
`Expected: not ${printExpected(expected)}` +
907
(stringify(expected) !== stringify(received)
908
? `\nReceived: ${printReceived(received)}`
909
: '')
910
: () =>
912
matcherHint(matcherName, undefined, undefined, options) +
913
'\n\n' +
914
printDiffOrStringify(
915
expected,
916
getObjectSubset(received, expected),
917
EXPECTED_LABEL,
918
RECEIVED_LABEL,
940
`Expected: not ${printExpected(expected)}\n` +
941
(stringify(expected) !== stringify(received)
942
? `Received: ${printReceived(received)}`
943
: '')
944
: () =>
946
matcherHint(matcherName, undefined, undefined, options) +
947
'\n\n' +
948
printDiffOrStringify(
949
expected,
950
received,
951
EXPECTED_LABEL,
952
RECEIVED_LABEL,
957
// could access them, for example in order to display a custom visual diff,
958
// or create a different error message
961
};
962
