Skip to content

Commit

Permalink
jest-cirtus failure tests
Browse files Browse the repository at this point in the history
  • Loading branch information
aaronabramov committed Jun 9, 2017
1 parent dec54a3 commit f238a43
Show file tree
Hide file tree
Showing 13 changed files with 318 additions and 37 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@ exports[`not throwing Error objects 4`] = `
Expected two assertions to be called but only received one assertion call.
at ../../packages/jest-jasmine2/build/setup-jest-globals.js:68:21
● .assertions() › throws on redeclare of assertion count
Expand All @@ -62,15 +61,13 @@ exports[`not throwing Error objects 4`] = `
Expected zero assertions to be called but only received one assertion call.
at ../../packages/jest-jasmine2/build/setup-jest-globals.js:68:21
● .hasAssertions() › throws when there are not assertions
expect.hasAssertions()
Expected at least one assertion to be called but received none.
at ../../packages/jest-jasmine2/build/setup-jest-globals.js:88:21
.assertions()
✕ throws
Expand Down
21 changes: 20 additions & 1 deletion integration_tests/__tests__/failures-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,25 @@ const normalizeDots = text => text.replace(/\.{1,}$/gm, '.');

skipOnWindows.suite();

const cleanupStackTrace = stderr => {
const STACK_REGEXP = /at.*(setup-jest-globals|extractExpectedAssertionsErrors).*\n/gm;
if (!STACK_REGEXP.test(stderr)) {
throw new Error(
`
This function is used to remove inconsistent stack traces between
jest-jasmine2 and jest-circus. If you see this error, that means the
stack traces are no longer inconsistent and this function can be
safely removed.
output:
${stderr}
`,
);
}

return stderr.replace(STACK_REGEXP, '');
};

test('not throwing Error objects', () => {
let stderr;
stderr = runJest(dir, ['throw-number-test.js']).stderr;
Expand All @@ -26,7 +45,7 @@ test('not throwing Error objects', () => {
stderr = runJest(dir, ['throw-object-test.js']).stderr;
expect(extractSummary(stderr).rest).toMatchSnapshot();
stderr = runJest(dir, ['assertion-count-test.js']).stderr;
expect(extractSummary(stderr).rest).toMatchSnapshot();
expect(extractSummary(cleanupStackTrace(stderr)).rest).toMatchSnapshot();
});

test('works with node assert', () => {
Expand Down
1 change: 1 addition & 0 deletions integration_tests/utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,7 @@ const cleanupStackTrace = (output: string) => {
.replace(/\n.*at.*next_tick\.js.*$/gm, '')
.replace(/\n.*at Promise \(<anonymous>\).*$/gm, '')
.replace(/\n.*at <anonymous>.*$/gm, '')
.replace(/\n.*at Generator.next \(<anonymous>\).*$/gm, '')
.replace(/^.*at.*[\s][\(]?(\S*\:\d*\:\d*).*$/gm, ' at $1');
};

Expand Down
3 changes: 2 additions & 1 deletion packages/jest-circus/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@
"dependencies": {
"jest-snapshot": "^20.0.3",
"jest-matchers": "^20.0.3",
"jest-message-util": "^20.0.3"
"jest-message-util": "^20.0.3",
"jest-diff": "^20.0.3"
},
"devDependencies": {
"jest-runtime": "^20.0.3"
Expand Down
149 changes: 149 additions & 0 deletions packages/jest-circus/src/formatNodeAssertErrors.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
/**
* Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
*
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree. An additional grant
* of patent rights can be found in the PATENTS file in the same directory.
*
* @flow
*/

import type {DiffOptions} from 'jest-diff/src/diffStrings';
import type {Event, State} from '../types';

const {printReceived, printExpected} = require('jest-matcher-utils');
const chalk = require('chalk');
const diff = require('jest-diff');

type AssertionError = {|
actual: ?string,
expected: ?string,
generatedMessage: boolean,
message: string,
name: string,
operator: ?string,
stack: string,
|};

const assertOperatorsMap = {
'!=': 'notEqual',
'!==': 'notStrictEqual',
'==': 'equal',
'===': 'strictEqual',
};

const humanReadableOperators = {
deepEqual: 'to deeply equal',
deepStrictEqual: 'to deeply and strictly equal',
notDeepEqual: 'not to deeply equal',
notDeepStrictEqual: 'not to deeply and strictly equal',
};

module.exports = (event: Event, state: State) => {
switch (event.name) {
case 'test_failure':
case 'test_success': {
event.test.errors = event.test.errors.map(error => {
return error instanceof require('assert').AssertionError
? assertionErrorMessage(error, {expand: state.expand})
: error;
});
break;
}
}
};

const getOperatorName = (operator: ?string, stack: string) => {
if (typeof operator === 'string') {
return assertOperatorsMap[operator] || operator;
}
if (stack.match('.doesNotThrow')) {
return 'doesNotThrow';
}
if (stack.match('.throws')) {
return 'throws';
}
return '';
};

const operatorMessage = (operator: ?string, negator: boolean) =>
typeof operator === 'string'
? operator.startsWith('!') || operator.startsWith('=')
? `${negator ? 'not ' : ''}to be (operator: ${operator}):\n`
: `${humanReadableOperators[operator] || operator} to:\n`
: '';

const assertThrowingMatcherHint = (operatorName: string) => {
return (
chalk.dim('assert') +
chalk.dim('.' + operatorName + '(') +
chalk.red('function') +
chalk.dim(')')
);
};

const assertMatcherHint = (operator: ?string, operatorName: string) => {
let message =
chalk.dim('assert') +
chalk.dim('.' + operatorName + '(') +
chalk.red('received') +
chalk.dim(', ') +
chalk.green('expected') +
chalk.dim(')');

if (operator === '==') {
message +=
' or ' +
chalk.dim('assert') +
chalk.dim('(') +
chalk.red('received') +
chalk.dim(') ');
}

return message;
};

function assertionErrorMessage(error: AssertionError, options: DiffOptions) {
const {expected, actual, message, operator, stack} = error;
const diffString = diff(expected, actual, options);
const negator =
typeof operator === 'string' &&
(operator.startsWith('!') || operator.startsWith('not'));
const hasCustomMessage = !error.generatedMessage;
const operatorName = getOperatorName(operator, stack);

if (operatorName === 'doesNotThrow') {
return (
assertThrowingMatcherHint(operatorName) +
'\n\n' +
chalk.reset(`Expected the function not to throw an error.\n`) +
chalk.reset(`Instead, it threw:\n`) +
` ${printReceived(actual)}` +
chalk.reset(hasCustomMessage ? '\n\nMessage:\n ' + message : '') +
stack.replace(/AssertionError(.*)/g, '')
);
}

if (operatorName === 'throws') {
return (
assertThrowingMatcherHint(operatorName) +
'\n\n' +
chalk.reset(`Expected the function to throw an error.\n`) +
chalk.reset(`But it didn't throw anything.`) +
chalk.reset(hasCustomMessage ? '\n\nMessage:\n ' + message : '') +
stack.replace(/AssertionError(.*)/g, '')
);
}

return (
assertMatcherHint(operator, operatorName) +
'\n\n' +
chalk.reset(`Expected value ${operatorMessage(operator, negator)}`) +
` ${printExpected(expected)}\n` +
chalk.reset(`Received:\n`) +
` ${printReceived(actual)}` +
chalk.reset(hasCustomMessage ? '\n\nMessage:\n ' + message : '') +
(diffString ? `\n\nDifference:\n\n${diffString}` : '') +
stack.replace(/AssertionError(.*)/g, '')
);
}
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import type {TestResult, Status} from 'types/TestResult';
import type {GlobalConfig, Path, ProjectConfig} from 'types/Config';
import type {Event, TestEntry} from '../../types';

import {getState, setState} from 'jest-matchers';
import {extractExpectedAssertionsErrors, getState, setState} from 'jest-matchers';
import {formatResultsErrors} from 'jest-message-util';
import {SnapshotState, addSerializer} from 'jest-snapshot';
import {addEventHandler, ROOT_DESCRIBE_BLOCK_NAME} from '../state';
Expand Down Expand Up @@ -157,11 +157,18 @@ const eventHandler = (event: Event) => {
case 'test_success':
case 'test_failure': {
_addSuppressedErrors(event.test);
_addExpectedAssertionErrors(event.test);
break;
}
}
};

const _addExpectedAssertionErrors = (test: TestEntry) => {
const errors = extractExpectedAssertionsErrors();
errors.length && (test.status = 'fail');
test.errors = test.errors.concat(errors);
};

// Get suppressed errors from ``jest-matchers`` that weren't throw during
// test execution and add them to the test result, potentially failing
// a passing test.
Expand Down
7 changes: 6 additions & 1 deletion packages/jest-circus/src/state.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,20 @@ import type {Event, State, EventHandler} from '../types';

import {makeDescribe} from './utils';
import eventHandler from './eventHandler';
import formatNodeAssertErrors from './formatNodeAssertErrors';

const eventHandlers: Array<EventHandler> = [eventHandler];
const eventHandlers: Array<EventHandler> = [
eventHandler,
formatNodeAssertErrors,
];

const ROOT_DESCRIBE_BLOCK_NAME = 'ROOT_DESCRIBE_BLOCK';
const STATE_SYM = Symbol('JEST_STATE_SYMBOL');

const ROOT_DESCRIBE_BLOCK = makeDescribe(ROOT_DESCRIBE_BLOCK_NAME);
const INITIAL_STATE: State = {
currentDescribeBlock: ROOT_DESCRIBE_BLOCK,
expand: undefined,
hasFocusedTests: false,
rootDescribeBlock: ROOT_DESCRIBE_BLOCK,
testTimeout: 5000,
Expand Down
2 changes: 1 addition & 1 deletion packages/jest-circus/src/utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ const _formatError = (error: ?Exception): string => {
} else if (error.message) {
return error.message;
} else {
return String(error);
return `${String(error)} thrown`;
}
};

Expand Down
1 change: 1 addition & 0 deletions packages/jest-circus/types.js
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,7 @@ export type State = {|
hasFocusedTests: boolean, // that are defined using test.only
rootDescribeBlock: DescribeBlock,
testTimeout: number,
expand?: boolean, // expand error messages
|};

export type DescribeBlock = {|
Expand Down
64 changes: 64 additions & 0 deletions packages/jest-matchers/src/extractExpectedAssertionsErrors.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
/**
* Copyright (c) 2014, Facebook, Inc. All rights reserved.
*
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree. An additional grant
* of patent rights can be found in the PATENTS file in the same directory.
*
* @flow
*/

const {
EXPECTED_COLOR,
RECEIVED_COLOR,
matcherHint,
pluralize,
} = require('jest-matcher-utils');

const {getState, setState} = require('./jest-matchers-object');

// Create and format all errors related to the mismatched number of `expect`
// calls and reset the matchers state.
const extractExpectedAssertionsErrors = () => {
const result = [];
const {
assertionCalls,
expectedAssertionsNumber,
isExpectingAssertions,
} = getState();
setState({assertionCalls: 0, expectedAssertionsNumber: null});
if (
typeof expectedAssertionsNumber === 'number' &&
assertionCalls !== expectedAssertionsNumber
) {
const numOfAssertionsExpected = EXPECTED_COLOR(
pluralize('assertion', expectedAssertionsNumber),
);
const error = new Error(
matcherHint('.assertions', '', String(expectedAssertionsNumber), {
isDirectExpectCall: true,
}) +
'\n\n' +
`Expected ${numOfAssertionsExpected} to be called but only received ` +
RECEIVED_COLOR(pluralize('assertion call', assertionCalls || 0)) +
'.',
);
result.push(error);
}
if (isExpectingAssertions && assertionCalls === 0) {
const expected = EXPECTED_COLOR('at least one assertion');
const received = RECEIVED_COLOR('received none');
const error = new Error(
matcherHint('.hasAssertions', '', '', {
isDirectExpectCall: true,
}) +
'\n\n' +
`Expected ${expected} to be called but ${received}.`,
);
result.push(error);
}

return result;
};

module.exports = extractExpectedAssertionsErrors;
Loading

0 comments on commit f238a43

Please sign in to comment.