'use strict'; Object.defineProperty(exports, '__esModule', { value: true }); exports.parseSingleTestResult = exports.makeTest = exports.makeSingleTestResult = exports.makeRunResult = exports.makeDescribe = exports.getTestID = exports.getTestDuration = exports.getEachHooksForTest = exports.getAllHooksForDescribe = exports.describeBlockHasTests = exports.createTestCaseStartInfo = exports.callAsyncCircusFn = exports.addErrorToEachTestUnderDescribe = void 0; var path = _interopRequireWildcard(require('path')); var _co = _interopRequireDefault(require('co')); var _dedent = _interopRequireDefault(require('dedent')); var _isGeneratorFn = _interopRequireDefault(require('is-generator-fn')); var _slash = _interopRequireDefault(require('slash')); var _stackUtils = _interopRequireDefault(require('stack-utils')); var _jestUtil = require('jest-util'); var _prettyFormat = require('pretty-format'); var _state = require('./state'); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : {default: obj}; } function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== 'function') return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); } function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || (typeof obj !== 'object' && typeof obj !== 'function')) { return {default: obj}; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== 'default' && 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 = globalThis['jest-symbol-do-not-touch'] || globalThis.Symbol; var Symbol = globalThis['jest-symbol-do-not-touch'] || globalThis.Symbol; var jestNow = globalThis[Symbol.for('jest-native-now')] || globalThis.Date.now; var Symbol = globalThis['jest-symbol-do-not-touch'] || globalThis.Symbol; var Promise = globalThis[Symbol.for('jest-native-promise')] || globalThis.Promise; /** * Copyright (c) Meta Platforms, Inc. and affiliates. * * This source code is licensed under the MIT license found in the * LICENSE file in the root directory of this source tree. */ const stackUtils = new _stackUtils.default({ cwd: 'A path that does not exist' }); const jestEachBuildDir = (0, _slash.default)( path.dirname(require.resolve('jest-each')) ); function takesDoneCallback(fn) { return fn.length > 0; } function isGeneratorFunction(fn) { return (0, _isGeneratorFn.default)(fn); } const makeDescribe = (name, parent, mode) => { let _mode = mode; if (parent && !mode) { // If not set explicitly, inherit from the parent describe. _mode = parent.mode; } return { type: 'describeBlock', // eslint-disable-next-line sort-keys children: [], hooks: [], mode: _mode, name: (0, _jestUtil.convertDescriptorToString)(name), parent, tests: [] }; }; exports.makeDescribe = makeDescribe; const makeTest = ( fn, mode, concurrent, name, parent, timeout, asyncError, failing ) => ({ type: 'test', // eslint-disable-next-line sort-keys asyncError, concurrent, duration: null, errors: [], failing, fn, invocations: 0, mode, name: (0, _jestUtil.convertDescriptorToString)(name), numPassingAsserts: 0, parent, retryReasons: [], seenDone: false, startedAt: null, status: null, timeout }); // Traverse the tree of describe blocks and return true if at least one describe // block has an enabled test. exports.makeTest = makeTest; const hasEnabledTest = describeBlock => { const {hasFocusedTests, testNamePattern} = (0, _state.getState)(); return describeBlock.children.some(child => child.type === 'describeBlock' ? hasEnabledTest(child) : !( child.mode === 'skip' || (hasFocusedTests && child.mode !== 'only') || (testNamePattern && !testNamePattern.test(getTestID(child))) ) ); }; const getAllHooksForDescribe = describe => { const result = { afterAll: [], beforeAll: [] }; if (hasEnabledTest(describe)) { for (const hook of describe.hooks) { switch (hook.type) { case 'beforeAll': result.beforeAll.push(hook); break; case 'afterAll': result.afterAll.push(hook); break; } } } return result; }; exports.getAllHooksForDescribe = getAllHooksForDescribe; const getEachHooksForTest = test => { const result = { afterEach: [], beforeEach: [] }; if (test.concurrent) { // *Each hooks are not run for concurrent tests return result; } let block = test.parent; do { const beforeEachForCurrentBlock = []; for (const hook of block.hooks) { switch (hook.type) { case 'beforeEach': beforeEachForCurrentBlock.push(hook); break; case 'afterEach': result.afterEach.push(hook); break; } } // 'beforeEach' hooks are executed from top to bottom, the opposite of the // way we traversed it. result.beforeEach = [...beforeEachForCurrentBlock, ...result.beforeEach]; } while ((block = block.parent)); return result; }; exports.getEachHooksForTest = getEachHooksForTest; const describeBlockHasTests = describe => describe.children.some( child => child.type === 'test' || describeBlockHasTests(child) ); exports.describeBlockHasTests = describeBlockHasTests; const _makeTimeoutMessage = (timeout, isHook, takesDoneCallback) => `Exceeded timeout of ${(0, _jestUtil.formatTime)(timeout)} for a ${ isHook ? 'hook' : 'test' }${ takesDoneCallback ? ' while waiting for `done()` to be called' : '' }.\nAdd a timeout value to this test to increase the timeout, if this is a long-running test. See https://jestjs.io/docs/api#testname-fn-timeout.`; // Global values can be overwritten by mocks or tests. We'll capture // the original values in the variables before we require any files. const {setTimeout, clearTimeout} = globalThis; function checkIsError(error) { return !!(error && error.message && error.stack); } const callAsyncCircusFn = (testOrHook, testContext, {isHook, timeout}) => { let timeoutID; let completed = false; const {fn, asyncError} = testOrHook; const doneCallback = takesDoneCallback(fn); return new Promise((resolve, reject) => { timeoutID = setTimeout( () => reject(_makeTimeoutMessage(timeout, isHook, doneCallback)), timeout ); // If this fn accepts `done` callback we return a promise that fulfills as // soon as `done` called. if (doneCallback) { let returnedValue = undefined; const done = reason => { // We need to keep a stack here before the promise tick const errorAtDone = new _jestUtil.ErrorWithStack(undefined, done); if (!completed && testOrHook.seenDone) { errorAtDone.message = 'Expected done to be called once, but it was called multiple times.'; if (reason) { errorAtDone.message += ` Reason: ${(0, _prettyFormat.format)( reason, { maxDepth: 3 } )}`; } reject(errorAtDone); throw errorAtDone; } else { testOrHook.seenDone = true; } // Use `Promise.resolve` to allow the event loop to go a single tick in case `done` is called synchronously Promise.resolve().then(() => { if (returnedValue !== undefined) { asyncError.message = (0, _dedent.default)` Test functions cannot both take a 'done' callback and return something. Either use a 'done' callback, or return a promise. Returned value: ${(0, _prettyFormat.format)(returnedValue, { maxDepth: 3 })} `; return reject(asyncError); } let errorAsErrorObject; if (checkIsError(reason)) { errorAsErrorObject = reason; } else { errorAsErrorObject = errorAtDone; errorAtDone.message = `Failed: ${(0, _prettyFormat.format)(reason, { maxDepth: 3 })}`; } // Consider always throwing, regardless if `reason` is set or not if (completed && reason) { errorAsErrorObject.message = `Caught error after test environment was torn down\n\n${errorAsErrorObject.message}`; throw errorAsErrorObject; } return reason ? reject(errorAsErrorObject) : resolve(); }); }; returnedValue = fn.call(testContext, done); return; } let returnedValue; if (isGeneratorFunction(fn)) { returnedValue = _co.default.wrap(fn).call({}); } else { try { returnedValue = fn.call(testContext); } catch (error) { reject(error); return; } } if ((0, _jestUtil.isPromise)(returnedValue)) { returnedValue.then(() => resolve(), reject); return; } if (!isHook && returnedValue !== undefined) { reject( new Error((0, _dedent.default)` test functions can only return Promise or undefined. Returned value: ${(0, _prettyFormat.format)(returnedValue, { maxDepth: 3 })} `) ); return; } // Otherwise this test is synchronous, and if it didn't throw it means // it passed. resolve(); }) .then(() => { completed = true; // If timeout is not cleared/unrefed the node process won't exit until // it's resolved. timeoutID.unref?.(); clearTimeout(timeoutID); }) .catch(error => { completed = true; timeoutID.unref?.(); clearTimeout(timeoutID); throw error; }); }; exports.callAsyncCircusFn = callAsyncCircusFn; const getTestDuration = test => { const {startedAt} = test; return typeof startedAt === 'number' ? jestNow() - startedAt : null; }; exports.getTestDuration = getTestDuration; const makeRunResult = (describeBlock, unhandledErrors) => ({ testResults: makeTestResults(describeBlock), unhandledErrors: unhandledErrors.map(_getError).map(getErrorStack) }); exports.makeRunResult = makeRunResult; const getTestNamesPath = test => { const titles = []; let parent = test; do { titles.unshift(parent.name); } while ((parent = parent.parent)); return titles; }; const makeSingleTestResult = test => { const {includeTestLocationInResult} = (0, _state.getState)(); const {status} = test; (0, _jestUtil.invariant)( status, 'Status should be present after tests are run.' ); const testPath = getTestNamesPath(test); let location = null; if (includeTestLocationInResult) { const stackLines = test.asyncError.stack.split('\n'); const stackLine = stackLines[1]; let parsedLine = stackUtils.parseLine(stackLine); if (parsedLine?.file?.startsWith(jestEachBuildDir)) { const stackLine = stackLines[4]; parsedLine = stackUtils.parseLine(stackLine); } if ( parsedLine && typeof parsedLine.column === 'number' && typeof parsedLine.line === 'number' ) { location = { column: parsedLine.column, line: parsedLine.line }; } } const errorsDetailed = test.errors.map(_getError); return { duration: test.duration, errors: errorsDetailed.map(getErrorStack), errorsDetailed, invocations: test.invocations, location, numPassingAsserts: test.numPassingAsserts, retryReasons: test.retryReasons.map(_getError).map(getErrorStack), status, testPath: Array.from(testPath) }; }; exports.makeSingleTestResult = makeSingleTestResult; const makeTestResults = describeBlock => { const testResults = []; for (const child of describeBlock.children) { switch (child.type) { case 'describeBlock': { testResults.push(...makeTestResults(child)); break; } case 'test': { testResults.push(makeSingleTestResult(child)); break; } } } return testResults; }; // Return a string that identifies the test (concat of parent describe block // names + test title) const getTestID = test => { const testNamesPath = getTestNamesPath(test); testNamesPath.shift(); // remove TOP_DESCRIBE_BLOCK_NAME return testNamesPath.join(' '); }; exports.getTestID = getTestID; const _getError = errors => { let error; let asyncError; if (Array.isArray(errors)) { error = errors[0]; asyncError = errors[1]; } else { error = errors; asyncError = new Error(); } if (error && (typeof error.stack === 'string' || error.message)) { return error; } asyncError.message = `thrown: ${(0, _prettyFormat.format)(error, { maxDepth: 3 })}`; return asyncError; }; const getErrorStack = error => typeof error.stack === 'string' ? error.stack : error.message; const addErrorToEachTestUnderDescribe = (describeBlock, error, asyncError) => { for (const child of describeBlock.children) { switch (child.type) { case 'describeBlock': addErrorToEachTestUnderDescribe(child, error, asyncError); break; case 'test': child.errors.push([error, asyncError]); break; } } }; exports.addErrorToEachTestUnderDescribe = addErrorToEachTestUnderDescribe; const resolveTestCaseStartInfo = testNamesPath => { const ancestorTitles = testNamesPath.filter( name => name !== _state.ROOT_DESCRIBE_BLOCK_NAME ); const fullName = ancestorTitles.join(' '); const title = testNamesPath[testNamesPath.length - 1]; // remove title ancestorTitles.pop(); return { ancestorTitles, fullName, title }; }; const parseSingleTestResult = testResult => { let status; if (testResult.status === 'skip') { status = 'pending'; } else if (testResult.status === 'todo') { status = 'todo'; } else if (testResult.errors.length > 0) { status = 'failed'; } else { status = 'passed'; } const {ancestorTitles, fullName, title} = resolveTestCaseStartInfo( testResult.testPath ); return { ancestorTitles, duration: testResult.duration, failureDetails: testResult.errorsDetailed, failureMessages: Array.from(testResult.errors), fullName, invocations: testResult.invocations, location: testResult.location, numPassingAsserts: testResult.numPassingAsserts, retryReasons: Array.from(testResult.retryReasons), status, title }; }; exports.parseSingleTestResult = parseSingleTestResult; const createTestCaseStartInfo = test => { const testPath = getTestNamesPath(test); const {ancestorTitles, fullName, title} = resolveTestCaseStartInfo(testPath); return { ancestorTitles, fullName, mode: test.mode, startedAt: test.startedAt, title }; }; exports.createTestCaseStartInfo = createTestCaseStartInfo;