Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: Format failed external asserts nicer #2230

Closed
wants to merge 4 commits into from
Closed

WIP: Format failed external asserts nicer #2230

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ab133d7
Format failed external asserts nicer
tryzniak Aug 22, 2019
74046ef
Add comment for which error is which
tryzniak Sep 10, 2019
d515676
Fix comment indentation, reference origin library by URL not name
novemberborn Sep 15, 2019
818e495
Merge branch 'master' into feat/external-asserts
novemberborn Sep 15, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 36 additions & 10 deletions lib/test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,16 @@ const nowAndTimers = require('./now-and-timers');
const parseTestArgs = require('./parse-test-args');
const concordanceOptions = require('./concordance-options').default;

function isExternalAssertError(error) {
// Match errors thrown by <https://www.npmjs.com/package/expect>.
if (error.matcherResult) {
return error.matcherResult.actual && error.matcherResult.expected;
}

// Match errors thrown by <https://www.npmjs.com/package/chai> and <https://nodejs.org/api/assert.html>.
return error.actual && error.expected;
novemberborn marked this conversation as resolved.
Show resolved Hide resolved
}

function formatErrorValue(label, error) {
const formatted = concordance.format(error, concordanceOptions);
return {label, formatted};
Expand Down Expand Up @@ -565,11 +575,19 @@ class Test {
const result = this.callFn();
if (!result.ok) {
if (!this.detectImproperThrows(result.error)) {
this.saveFirstError(new assert.AssertionError({
message: 'Error thrown in test',
savedError: result.error instanceof Error && result.error,
values: [formatErrorValue('Error thrown in test:', result.error)]
}));
if (isExternalAssertError(result.error)) {
this.saveFirstError(new assert.AssertionError({
message: 'Assertion failed',
savedError: result.error instanceof Error && result.error,
values: [{label: 'Assertion failed: ', formatted: result.error.message}]
}));
} else {
this.saveFirstError(new assert.AssertionError({
message: 'Error thrown in test',
savedError: result.error instanceof Error && result.error,
values: [formatErrorValue('Error thrown in test:', result.error)]
}));
}
}

return this.finishPromised();
Expand Down Expand Up @@ -638,11 +656,19 @@ class Test {
promise
.catch(error => {
if (!this.detectImproperThrows(error)) {
this.saveFirstError(new assert.AssertionError({
message: 'Rejected promise returned by test',
savedError: error instanceof Error && error,
values: [formatErrorValue('Rejected promise returned by test. Reason:', error)]
}));
if (isExternalAssertError(error)) {
this.saveFirstError(new assert.AssertionError({
message: 'Assertion failed',
savedError: error instanceof Error && error,
values: [{label: 'Assertion failed: ', formatted: error.message}]
}));
} else {
this.saveFirstError(new assert.AssertionError({
message: 'Rejected promise returned by test',
savedError: error instanceof Error && error,
values: [formatErrorValue('Rejected promise returned by test. Reason:', error)]
}));
}
}
})
.then(() => resolve(this.finishPromised())); // eslint-disable-line promise/prefer-await-to-then
Expand Down