github/overleaf
1
0
Fork 0
mirror of https://github.com/overleaf/overleaf.git synced 2024-11-21 20:47:08 -05:00
Code Issues Projects Releases Packages Wiki Activity

Improve assertion messages in test utility

Browse source
This commit is contained in:
John Lees-Miller 2020-05-15 10:32:18 +01:00
parent c44054a31b
commit 8af22ae878
1 changed files with 33 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

51
libraries/o-error/test/support/index.js
View file

@ -3,36 +3,51 @@ const { expect } = require('chai')
const OError = require('../..')
exports.expectError = function OErrorExpectError(e, expected) {
// should set the name to the error's name
expect(e.name).to.equal(expected.name)
expect(
e.name,
"error should set the name property to the error's name"
).to.equal(expected.name)
// should be an instance of the error type
expect(e instanceof expected.klass).to.be.true
expect(
e instanceof expected.klass,
'error should be an instance of the error type'
).to.be.true
// should be an instance of the built-in Error type
expect(e instanceof Error).to.be.true
expect(
e instanceof Error,
'error should be an instance of the built-in Error type'
).to.be.true
// should be recognised by util.isError
expect(require('util').types.isNativeError(e)).to.be.true
expect(
require('util').types.isNativeError(e),
'error should be recognised by util.types.isNativeError'
).to.be.true
// should have a stack trace
expect(e.stack).to.be.truthy
expect(e.stack, 'error should have a stack trace').to.be.truthy
// toString should return the default error message formatting
expect(e.toString()).to.equal(expected.message)
expect(
e.toString(),
'toString should return the default error message formatting'
).to.equal(expected.message)
// stack should start with the default error message formatting
expect(e.stack.split('\n')[0]).to.match(new RegExp(`^${expected.name}:`))
expect(
e.stack.split('\n')[0],
'stack should start with the default error message formatting'
).to.match(new RegExp(`^${expected.name}:`))
// first stack frame should be the function where the error was thrown
expect(e.stack.split('\n')[1]).to.match(expected.firstFrameRx)
expect(
e.stack.split('\n')[1],
'first stack frame should be the function where the error was thrown'
).to.match(expected.firstFrameRx)
}
exports.expectFullStackWithoutStackFramesToEqual = function (error, expected) {
// But the stack contains all of the errors and tags.
const fullStack = OError.getFullStack(error)
const fullStackWithoutFrames = fullStack
.split('\n')
.filter((line) => !/^\s+at\s/.test(line))
expect(fullStackWithoutFrames).to.deep.equal(expected)
expect(
fullStackWithoutFrames,
'full stack without frames should equal'
).to.deep.equal(expected)
}