123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435 |
- 'use strict';
- var matcherUtils = _interopRequireWildcard(require('jest-matcher-utils'));
- var _asymmetricMatchers = require('./asymmetricMatchers');
- var _extractExpectedAssertionsErrors = _interopRequireDefault(
- require('./extractExpectedAssertionsErrors')
- );
- var _jasmineUtils = require('./jasmineUtils');
- var _jestMatchersObject = require('./jestMatchersObject');
- var _matchers = _interopRequireDefault(require('./matchers'));
- var _spyMatchers = _interopRequireDefault(require('./spyMatchers'));
- var _toThrowMatchers = _interopRequireWildcard(require('./toThrowMatchers'));
- var _utils = require('./utils');
- function _interopRequireDefault(obj) {
- return obj && obj.__esModule ? obj : {default: obj};
- }
- function _getRequireWildcardCache() {
- if (typeof WeakMap !== 'function') return null;
- var cache = new WeakMap();
- _getRequireWildcardCache = function () {
- return cache;
- };
- return cache;
- }
- function _interopRequireWildcard(obj) {
- if (obj && obj.__esModule) {
- return obj;
- }
- if (obj === null || (typeof obj !== 'object' && typeof obj !== 'function')) {
- return {default: obj};
- }
- var cache = _getRequireWildcardCache();
- if (cache && cache.has(obj)) {
- return cache.get(obj);
- }
- var newObj = {};
- var hasPropertyDescriptor =
- Object.defineProperty && Object.getOwnPropertyDescriptor;
- for (var key in obj) {
- if (Object.prototype.hasOwnProperty.call(obj, key)) {
- var desc = hasPropertyDescriptor
- ? Object.getOwnPropertyDescriptor(obj, key)
- : null;
- if (desc && (desc.get || desc.set)) {
- Object.defineProperty(newObj, key, desc);
- } else {
- newObj[key] = obj[key];
- }
- }
- }
- newObj.default = obj;
- if (cache) {
- cache.set(obj, newObj);
- }
- return newObj;
- }
- var Symbol = global['jest-symbol-do-not-touch'] || global.Symbol;
- var Symbol = global['jest-symbol-do-not-touch'] || global.Symbol;
- var Promise = global[Symbol.for('jest-native-promise')] || global.Promise;
- function _defineProperty(obj, key, value) {
- if (key in obj) {
- Object.defineProperty(obj, key, {
- value: value,
- enumerable: true,
- configurable: true,
- writable: true
- });
- } else {
- obj[key] = value;
- }
- return obj;
- }
- class JestAssertionError extends Error {
- constructor(...args) {
- super(...args);
- _defineProperty(this, 'matcherResult', void 0);
- }
- }
- const isPromise = obj =>
- !!obj &&
- (typeof obj === 'object' || typeof obj === 'function') &&
- typeof obj.then === 'function';
- const createToThrowErrorMatchingSnapshotMatcher = function (matcher) {
- return function (received, testNameOrInlineSnapshot) {
- return matcher.apply(this, [received, testNameOrInlineSnapshot, true]);
- };
- };
- const getPromiseMatcher = (name, matcher) => {
- if (name === 'toThrow' || name === 'toThrowError') {
- return (0, _toThrowMatchers.createMatcher)(name, true);
- } else if (
- name === 'toThrowErrorMatchingSnapshot' ||
- name === 'toThrowErrorMatchingInlineSnapshot'
- ) {
- return createToThrowErrorMatchingSnapshotMatcher(matcher);
- }
- return null;
- };
- const expect = (actual, ...rest) => {
- if (rest.length !== 0) {
- throw new Error('Expect takes at most one argument.');
- }
- const allMatchers = (0, _jestMatchersObject.getMatchers)();
- const expectation = {
- not: {},
- rejects: {
- not: {}
- },
- resolves: {
- not: {}
- }
- };
- const err = new JestAssertionError();
- Object.keys(allMatchers).forEach(name => {
- const matcher = allMatchers[name];
- const promiseMatcher = getPromiseMatcher(name, matcher) || matcher;
- expectation[name] = makeThrowingMatcher(matcher, false, '', actual);
- expectation.not[name] = makeThrowingMatcher(matcher, true, '', actual);
- expectation.resolves[name] = makeResolveMatcher(
- name,
- promiseMatcher,
- false,
- actual,
- err
- );
- expectation.resolves.not[name] = makeResolveMatcher(
- name,
- promiseMatcher,
- true,
- actual,
- err
- );
- expectation.rejects[name] = makeRejectMatcher(
- name,
- promiseMatcher,
- false,
- actual,
- err
- );
- expectation.rejects.not[name] = makeRejectMatcher(
- name,
- promiseMatcher,
- true,
- actual,
- err
- );
- });
- return expectation;
- };
- const getMessage = message =>
- (message && message()) ||
- matcherUtils.RECEIVED_COLOR('No message was specified for this matcher.');
- const makeResolveMatcher = (matcherName, matcher, isNot, actual, outerErr) => (
- ...args
- ) => {
- const options = {
- isNot,
- promise: 'resolves'
- };
- if (!isPromise(actual)) {
- throw new JestAssertionError(
- matcherUtils.matcherErrorMessage(
- matcherUtils.matcherHint(matcherName, undefined, '', options),
- `${matcherUtils.RECEIVED_COLOR('received')} value must be a promise`,
- matcherUtils.printWithType(
- 'Received',
- actual,
- matcherUtils.printReceived
- )
- )
- );
- }
- const innerErr = new JestAssertionError();
- return actual.then(
- result =>
- makeThrowingMatcher(matcher, isNot, 'resolves', result, innerErr).apply(
- null,
- args
- ),
- reason => {
- outerErr.message =
- matcherUtils.matcherHint(matcherName, undefined, '', options) +
- '\n\n' +
- `Received promise rejected instead of resolved\n` +
- `Rejected to value: ${matcherUtils.printReceived(reason)}`;
- return Promise.reject(outerErr);
- }
- );
- };
- const makeRejectMatcher = (matcherName, matcher, isNot, actual, outerErr) => (
- ...args
- ) => {
- const options = {
- isNot,
- promise: 'rejects'
- };
- const actualWrapper = typeof actual === 'function' ? actual() : actual;
- if (!isPromise(actualWrapper)) {
- throw new JestAssertionError(
- matcherUtils.matcherErrorMessage(
- matcherUtils.matcherHint(matcherName, undefined, '', options),
- `${matcherUtils.RECEIVED_COLOR(
- 'received'
- )} value must be a promise or a function returning a promise`,
- matcherUtils.printWithType(
- 'Received',
- actual,
- matcherUtils.printReceived
- )
- )
- );
- }
- const innerErr = new JestAssertionError();
- return actualWrapper.then(
- result => {
- outerErr.message =
- matcherUtils.matcherHint(matcherName, undefined, '', options) +
- '\n\n' +
- `Received promise resolved instead of rejected\n` +
- `Resolved to value: ${matcherUtils.printReceived(result)}`;
- return Promise.reject(outerErr);
- },
- reason =>
- makeThrowingMatcher(matcher, isNot, 'rejects', reason, innerErr).apply(
- null,
- args
- )
- );
- };
- const makeThrowingMatcher = (matcher, isNot, promise, actual, err) =>
- function throwingMatcher(...args) {
- let throws = true;
- const utils = {
- ...matcherUtils,
- iterableEquality: _utils.iterableEquality,
- subsetEquality: _utils.subsetEquality
- };
- const matcherContext = {
- // When throws is disabled, the matcher will not throw errors during test
- // execution but instead add them to the global matcher state. If a
- // matcher throws, test execution is normally stopped immediately. The
- // snapshot matcher uses it because we want to log all snapshot
- // failures in a test.
- dontThrow: () => (throws = false),
- ...(0, _jestMatchersObject.getState)(),
- equals: _jasmineUtils.equals,
- error: err,
- isNot,
- promise,
- utils
- };
- const processResult = (result, asyncError) => {
- _validateResult(result);
- (0, _jestMatchersObject.getState)().assertionCalls++;
- if ((result.pass && isNot) || (!result.pass && !isNot)) {
- // XOR
- const message = getMessage(result.message);
- let error;
- if (err) {
- error = err;
- error.message = message;
- } else if (asyncError) {
- error = asyncError;
- error.message = message;
- } else {
- error = new JestAssertionError(message); // Try to remove this function from the stack trace frame.
- // Guard for some environments (browsers) that do not support this feature.
- if (Error.captureStackTrace) {
- Error.captureStackTrace(error, throwingMatcher);
- }
- } // Passing the result of the matcher with the error so that a custom
- // reporter could access the actual and expected objects of the result
- // for example in order to display a custom visual diff
- error.matcherResult = result;
- if (throws) {
- throw error;
- } else {
- (0, _jestMatchersObject.getState)().suppressedErrors.push(error);
- }
- }
- };
- const handleError = error => {
- if (
- matcher[_jestMatchersObject.INTERNAL_MATCHER_FLAG] === true &&
- !(error instanceof JestAssertionError) &&
- error.name !== 'PrettyFormatPluginError' && // Guard for some environments (browsers) that do not support this feature.
- Error.captureStackTrace
- ) {
- // Try to remove this and deeper functions from the stack trace frame.
- Error.captureStackTrace(error, throwingMatcher);
- }
- throw error;
- };
- let potentialResult;
- try {
- potentialResult =
- matcher[_jestMatchersObject.INTERNAL_MATCHER_FLAG] === true
- ? matcher.call(matcherContext, actual, ...args) // It's a trap specifically for inline snapshot to capture this name
- : // in the stack trace, so that it can correctly get the custom matcher
- // function call.
- (function __EXTERNAL_MATCHER_TRAP__() {
- return matcher.call(matcherContext, actual, ...args);
- })();
- if (isPromise(potentialResult)) {
- const asyncResult = potentialResult;
- const asyncError = new JestAssertionError();
- if (Error.captureStackTrace) {
- Error.captureStackTrace(asyncError, throwingMatcher);
- }
- return asyncResult
- .then(aResult => processResult(aResult, asyncError))
- .catch(handleError);
- } else {
- const syncResult = potentialResult;
- return processResult(syncResult);
- }
- } catch (error) {
- return handleError(error);
- }
- };
- expect.extend = matchers =>
- (0, _jestMatchersObject.setMatchers)(matchers, false, expect);
- expect.anything = _asymmetricMatchers.anything;
- expect.any = _asymmetricMatchers.any;
- expect.not = {
- arrayContaining: _asymmetricMatchers.arrayNotContaining,
- objectContaining: _asymmetricMatchers.objectNotContaining,
- stringContaining: _asymmetricMatchers.stringNotContaining,
- stringMatching: _asymmetricMatchers.stringNotMatching
- };
- expect.objectContaining = _asymmetricMatchers.objectContaining;
- expect.arrayContaining = _asymmetricMatchers.arrayContaining;
- expect.stringContaining = _asymmetricMatchers.stringContaining;
- expect.stringMatching = _asymmetricMatchers.stringMatching;
- const _validateResult = result => {
- if (
- typeof result !== 'object' ||
- typeof result.pass !== 'boolean' ||
- (result.message &&
- typeof result.message !== 'string' &&
- typeof result.message !== 'function')
- ) {
- throw new Error(
- 'Unexpected return from a matcher function.\n' +
- 'Matcher functions should ' +
- 'return an object in the following format:\n' +
- ' {message?: string | function, pass: boolean}\n' +
- `'${matcherUtils.stringify(result)}' was returned`
- );
- }
- };
- function assertions(expected) {
- const error = new Error();
- if (Error.captureStackTrace) {
- Error.captureStackTrace(error, assertions);
- }
- (0, _jestMatchersObject.getState)().expectedAssertionsNumber = expected;
- (0, _jestMatchersObject.getState)().expectedAssertionsNumberError = error;
- }
- function hasAssertions(...args) {
- const error = new Error();
- if (Error.captureStackTrace) {
- Error.captureStackTrace(error, hasAssertions);
- }
- matcherUtils.ensureNoExpected(args[0], '.hasAssertions');
- (0, _jestMatchersObject.getState)().isExpectingAssertions = true;
- (0, _jestMatchersObject.getState)().isExpectingAssertionsError = error;
- } // add default jest matchers
- (0, _jestMatchersObject.setMatchers)(_matchers.default, true, expect);
- (0, _jestMatchersObject.setMatchers)(_spyMatchers.default, true, expect);
- (0, _jestMatchersObject.setMatchers)(_toThrowMatchers.default, true, expect);
- expect.addSnapshotSerializer = () => void 0;
- expect.assertions = assertions;
- expect.hasAssertions = hasAssertions;
- expect.getState = _jestMatchersObject.getState;
- expect.setState = _jestMatchersObject.setState;
- expect.extractExpectedAssertionsErrors =
- _extractExpectedAssertionsErrors.default;
- const expectExport = expect;
- module.exports = expectExport;
|