package
A set of API to easily test the Pino logger
npm install pino-testGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
Estimated unpacked size across 2 packages.
48.6 kB
Includes dependencies.
Provides a set of utilities for verifying logs generated by the Pino logger.
npm install pino-test --save-devconst test = require('node:test')
const pino = require('pino')
const pinoTest = require('pino-test')
test('pino should log a info message', async () => {
const stream = pinoTest.sink()
const logger = pino(stream)
logger.info('hello world')
const expected = { msg: 'hello world', level: 30 }
await pinoTest.once(stream, expected)
})
// with a own assert function
function is (received, expected, msg) {
if (received.msg !== expected.msg) {
throw new Error(`expected msg ${expected.msg} doesn't match the received one ${received.msg}`)
}
}
test('pino should log a info message using a own assert function', async () => {
const stream = pinoTest.sink()
const logger = pino(stream)
logger.info('hello world')
const expected = { msg: 'hello world', level: 30 }
await pinoTest.once(stream, expected, is)
})pinoTest.sink({ destroyOnError = false, emitErrorEvent = false }) => TransformCreate a Pino destination stream to easily inspect the logs processed by Pino.
const pino = require('pino')
const pinoTest = require('pino-test')
const stream = pinoTest.sink()
const logger = pino(stream)
logger.info('hello world')
stream.once('data', (chunk) => {
console.log(chunk.msg) // 'hello world'
console.log(chunk.level) // 30
})Destroy the stream on error
const pino = require('pino')
const pinoTest = require('pino-test')
const stream = pinoTest.sink({ destroyOnError: true })
stream.write('helloworld')
stream.end()
stream.once('close', () => {
console.log('close event') // "close event"
})Destroy and send error event on error
const pino = require('pino')
const pinoTest = require('pino-test')
const stream = pinoTest.sink({ destroyOnError: false, emitErrorEvent: false })
stream.write('helloworld')
stream.end()
stream.on('error', (err) => {
console.log(err) // Unexpected token h in JSON at position 0
})
stream.on('close', () => {
console.log('close event') // "close event"
Send error event on error
const pino = require('pino')
const pinoTest = require('pino-test')
const stream = pinoTest.sink({ emitErrorEvent: false })
stream.write('helloworld')
stream.end()
stream.on('error', (err) => {
console.log(err) // Unexpected token h in JSON at position 0
})once(stream, expectedOrCallback, is) => Promise<void>Assert that a single log is expected. The function internally
time is less than or equal to the current timepid matches the current process idhostname matches the current hostnamedeepStrictEqual assert function of the node:assert module.const pino = require('pino')
const pinoTest = require('pino-test')
const stream = pinoTest.sink()
const logger = pino(stream)
logger.info('hello world')
const expected = { msg: 'hello world', level: 30 }
await pinoTest.once(stream, expected) // doesn't throw a diff error
await pinoTest.once(stream, { msg: 'bye world', level: 30 }) // throw a diff error
// OR logging an object
logger.info({ hello:
consecutive(stream, expectedOrCallbacks, is) => Promise<void>Assert that consecutive logs are expected. The function internally
time is less than or equal to the current timepid matches the current process idhostname matches the current hostnamedeepStrictEqual assert function of the node:assert module.const pino = require('pino')
const pinoTest = require('pino-test')
const stream = pinoTest.sink()
const logger = pino(stream)
logger.info('hello world')
logger.info('hi world')
const expected = [
{ msg: 'hello world', level: 30 },
{ msg: 'hi world', level: 30 }
]
await pinoTest.consecutive(stream, expected) // doesn't throw a diff error
jsumners
james.sumners@gmail.com