-
-
Notifications
You must be signed in to change notification settings - Fork 6.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
dec54a3
commit f238a43
Showing
13 changed files
with
318 additions
and
37 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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, '') | ||
); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
64 changes: 64 additions & 0 deletions
64
packages/jest-matchers/src/extractExpectedAssertionsErrors.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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; |
Oops, something went wrong.