@jest-mock/express
Version:
A lightweight Jest mock for unit testing Express
272 lines • 15 kB
JavaScript
;
var __rest = (this && this.__rest) || function (s, e) {
var t = {};
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
t[p] = s[p];
if (s != null && typeof Object.getOwnPropertySymbols === "function")
for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
t[p[i]] = s[p[i]];
}
return t;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.getMockRes = void 0;
/**
* Returns a mocked version of key **Express** components, including:
* - a mocked **Express** `Response`, with mocked functions (chainable) and default values.
* - a mocked `next()` convenience function.
* - `mockClear()` to clear all internal **Jest** functions including `next()`
* - `clearMockRes()` an alias for `mockClear()`
*/
const getMockRes = (values = {}) => {
const next = jest.fn();
const {
/* express.Response */
status = jest.fn().mockName('status mock default'), sendStatus = jest.fn().mockName('sendStatus mock default'), links = jest.fn().mockName('links mock default'), send = jest.fn().mockName('send mock default'), json = jest.fn().mockName('json mock default'), jsonp = jest.fn().mockName('jsonp mock default'), sendFile = jest.fn().mockName('sendFile mock default'), sendfile = jest.fn().mockName('sendfile mock default'), download = jest.fn().mockName('download mock default'), contentType = jest.fn().mockName('contentType mock default'), type = jest.fn().mockName('type mock default'), format = jest.fn().mockName('format mock default'), attachment = jest.fn().mockName('attachment mock default'), set = jest.fn().mockName('set mock default'), header = jest.fn().mockName('header mock default'), headersSent = false, get = jest.fn().mockName('get mock default'), clearCookie = jest.fn().mockName('clearCookie mock default'), cookie = jest.fn().mockName('cookie mock default'), location = jest.fn().mockName('location mock default'), redirect = jest.fn().mockName('redirect mock default'), render = jest.fn().mockName('render mock default'), locals = {}, charset = '', vary = jest.fn().mockName('vary mock default'), app = {}, append = jest.fn().mockName('append mock default'), req = {},
/* http.ServerResponse */
statusCode = 0, statusMessage = '', assignSocket = jest.fn().mockName('assignSocket mock default'), detachSocket = jest.fn().mockName('detachSocket mock default'), writeContinue = jest.fn().mockName('writeContinue mock default'), writeHead = jest.fn().mockName('writeHead mock default'), writeProcessing = jest.fn().mockName('writeProcessing mock default'),
/* http.OutgoingMessage */
// req - is handled/overridden as part of express.Response
chunkedEncoding = false, shouldKeepAlive = false, useChunkedEncodingByDefault = false, sendDate = false, finished = false,
// headersSent - is handled/overridden as part of express.Response
connection = {}, socket = {}, setTimeout = jest.fn().mockName('setTimeout mock default'), setHeader = jest.fn().mockName('setHeader mock default'), getHeader = jest.fn().mockName('getHeader mock default'), getHeaders = jest.fn().mockName('getHeaders mock default'), getHeaderNames = jest.fn().mockName('getHeaderNames mock default'), hasHeader = jest.fn().mockName('hasHeader mock default'), removeHeader = jest.fn().mockName('removeHeader mock default'), addTrailers = jest.fn().mockName('addTrailers mock default'), flushHeaders = jest.fn().mockName('flushHeaders mock default'),
/* stream.Writable */
writable = false, writableEnded = false, writableFinished = false, writableHighWaterMark = 0, writableLength = 0, writableObjectMode = false, writableCorked = 0, destroyed = false, _write = jest.fn().mockName('_write mock default'), _writev = jest.fn().mockName('_writev mock default'), _destroy = jest.fn().mockName('_destroy mock default'), _final = jest.fn().mockName('_final mock default'), write = jest.fn().mockName('write mock default'), setDefaultEncoding = jest.fn().mockName('setDefaultEncoding mock default'), end = jest.fn().mockName('end mock default'), cork = jest.fn().mockName('cork mock default'), uncork = jest.fn().mockName('uncork mock default'), destroy = jest.fn().mockName('destroy mock default'), addListener = jest.fn().mockName('addListener mock default'), emit = jest.fn().mockName('emit mock default'), on = jest.fn().mockName('on mock default'), once = jest.fn().mockName('once mock default'), prependListener = jest.fn().mockName('prependListener mock default'), prependOnceListener = jest.fn().mockName('prependOnceListener mock default'), removeListener = jest.fn().mockName('removeListener mock default'),
/* event.EventEmitter */
// addListener - is handled/overridden as part of stream.Writable
// on - is handled/overridden as part of stream.Writable
// once - is handled/overridden as part of stream.Writable
// removeListener - is handled/overridden as part of stream.Writable
off = jest.fn().mockName('off mock default'), removeAllListeners = jest.fn().mockName('removeAllListeners mock default'), setMaxListeners = jest.fn().mockName('setMaxListeners mock default'), getMaxListeners = jest.fn().mockName('getMaxListeners mock default'), listeners = jest.fn().mockName('listeners mock default'), rawListeners = jest.fn().mockName('rawListeners mock default'),
// emit - is handled/overridden as part of stream.Writable
listenerCount = jest.fn().mockName('listenerCount mock default'),
// prependListener - is handled/overridden as part of stream.Writable
// prependOnceListener - is handled/overridden as part of stream.Writable
eventNames = jest.fn().mockName('eventNames mock default') } = values,
// custom values
extraProvidedValues = __rest(values, ["status", "sendStatus", "links", "send", "json", "jsonp", "sendFile", "sendfile", "download", "contentType", "type", "format", "attachment", "set", "header", "headersSent", "get", "clearCookie", "cookie", "location", "redirect", "render", "locals", "charset", "vary", "app", "append", "req", "statusCode", "statusMessage", "assignSocket", "detachSocket", "writeContinue", "writeHead", "writeProcessing", "chunkedEncoding", "shouldKeepAlive", "useChunkedEncodingByDefault", "sendDate", "finished", "connection", "socket", "setTimeout", "setHeader", "getHeader", "getHeaders", "getHeaderNames", "hasHeader", "removeHeader", "addTrailers", "flushHeaders", "writable", "writableEnded", "writableFinished", "writableHighWaterMark", "writableLength", "writableObjectMode", "writableCorked", "destroyed", "_write", "_writev", "_destroy", "_final", "write", "setDefaultEncoding", "end", "cork", "uncork", "destroy", "addListener", "emit", "on", "once", "prependListener", "prependOnceListener", "removeListener", "off", "removeAllListeners", "setMaxListeners", "getMaxListeners", "listeners", "rawListeners", "listenerCount", "eventNames"]);
const response = Object.assign({
/* express.Response */
status,
sendStatus,
links,
send,
json,
jsonp,
sendFile,
sendfile,
download,
contentType,
type,
format,
attachment,
set,
header,
get,
clearCookie,
cookie,
location,
redirect,
render,
vary,
append,
headersSent,
locals,
charset,
app,
req,
/* http.ServerResponse */
statusCode,
statusMessage,
assignSocket,
detachSocket,
writeContinue,
writeHead,
writeProcessing,
/* http.OutgoingMessage */
chunkedEncoding,
shouldKeepAlive,
useChunkedEncodingByDefault,
sendDate,
finished,
connection,
socket,
setTimeout,
setHeader,
getHeader,
getHeaders,
getHeaderNames,
hasHeader,
removeHeader,
addTrailers,
flushHeaders,
/* stream.Writable */
writable,
writableEnded,
writableFinished,
writableHighWaterMark,
writableLength,
writableObjectMode,
writableCorked,
destroyed,
_write,
_writev,
_destroy,
_final,
write,
setDefaultEncoding,
end,
cork,
uncork,
destroy,
addListener,
emit,
on,
once,
prependListener,
prependOnceListener,
removeListener,
/* event.EventEmitter */
// addListener - is handled/overridden as part of stream.Writable
// on - is handled/overridden as part of stream.Writable
// once - is handled/overridden as part of stream.Writable
// removeListener - is handled/overridden as part of stream.Writable
off,
removeAllListeners,
setMaxListeners,
getMaxListeners,
listeners,
rawListeners,
// emit - is handled/overridden as part of stream.Writable
listenerCount,
// prependListener - is handled/overridden as part of stream.Writable
// prependOnceListener - is handled/overridden as part of stream.Writable
eventNames }, extraProvidedValues);
/* express.Response - chainable functions */
response.status.mockReturnValue(response);
response.sendStatus.mockReturnValue(response);
response.links.mockReturnValue(response);
response.send.mockReturnValue(response);
response.json.mockReturnValue(response);
response.jsonp.mockReturnValue(response);
response.contentType.mockReturnValue(response);
response.type.mockReturnValue(response);
response.format.mockReturnValue(response);
response.attachment.mockReturnValue(response);
response.set.mockReturnValue(response);
response.header.mockReturnValue(response);
response.clearCookie.mockReturnValue(response);
response.cookie.mockReturnValue(response);
response.location.mockReturnValue(response);
response.vary.mockReturnValue(response);
response.append.mockReturnValue(response);
/* http.ServerResponse - chainable functions */
response.writeHead.mockReturnValue(response);
/* http.OutgoingMessage - chainable functions */
response.setTimeout.mockReturnValue(response);
/* stream.Writable - chainable functions */
response.setDefaultEncoding.mockReturnValue(response);
response.addListener.mockReturnValue(response);
response.on.mockReturnValue(response);
response.once.mockReturnValue(response);
response.prependListener.mockReturnValue(response);
response.prependOnceListener.mockReturnValue(response);
response.removeListener.mockReturnValue(response);
/* event.EventEmitter - chainable functions */
// addListener - is handled/overridden as part of stream.Writable
// on - is handled/overridden as part of stream.Writable
// once - is handled/overridden as part of stream.Writable
// removeListener - is handled/overridden as part of stream.Writable
response.off.mockReturnValue(response);
response.removeAllListeners.mockReturnValue(response);
response.setMaxListeners.mockReturnValue(response);
// prependListener - is handled/overridden as part of stream.Writable
// prependOnceListener - is handled/overridden as part of stream.Writable
const clearAllMocks = () => {
next.mockClear();
/* express.Response */
response.status.mockClear();
response.sendStatus.mockClear();
response.links.mockClear();
response.send.mockClear();
response.json.mockClear();
response.jsonp.mockClear();
response.sendFile.mockClear();
response.sendfile.mockClear();
response.download.mockClear();
response.contentType.mockClear();
response.type.mockClear();
response.format.mockClear();
response.attachment.mockClear();
response.set.mockClear();
response.header.mockClear();
response.get.mockClear();
response.clearCookie.mockClear();
response.cookie.mockClear();
response.location.mockClear();
response.redirect.mockClear();
response.render.mockClear();
response.vary.mockClear();
response.append.mockClear();
/* http.ServerResponse */
response.assignSocket.mockClear();
response.detachSocket.mockClear();
response.writeContinue.mockClear();
response.writeHead.mockClear();
response.writeProcessing.mockClear();
/* http.OutgoingMessage */
response.setTimeout.mockClear();
response.setHeader.mockClear();
response.getHeader.mockClear();
response.getHeaders.mockClear();
response.getHeaderNames.mockClear();
response.hasHeader.mockClear();
response.removeHeader.mockClear();
response.addTrailers.mockClear();
response.flushHeaders.mockClear();
/* stream.Writable */
response._write.mockClear();
response._writev.mockClear();
response._destroy.mockClear();
response._final.mockClear();
response.write.mockClear();
response.setDefaultEncoding.mockClear();
response.end.mockClear();
response.cork.mockClear();
response.uncork.mockClear();
response.destroy.mockClear();
response.addListener.mockClear();
response.emit.mockClear();
response.on.mockClear();
response.once.mockClear();
response.prependListener.mockClear();
response.prependOnceListener.mockClear();
response.removeListener.mockClear();
/* event.EventEmitter */
// addListener - is handled/overridden as part of stream.Writable
// on - is handled/overridden as part of stream.Writable
// once - is handled/overridden as part of stream.Writable
// removeListener - is handled/overridden as part of stream.Writable
response.off.mockClear();
response.removeAllListeners.mockClear();
response.setMaxListeners.mockClear();
response.getMaxListeners.mockClear();
response.listeners.mockClear();
response.rawListeners.mockClear();
// emit - is handled/overridden as part of stream.Writable
response.listenerCount.mockClear();
// prependListener - is handled/overridden as part of stream.Writable
// prependOnceListener - is handled/overridden as part of stream.Writable
response.eventNames.mockClear();
};
return {
res: response,
next: next,
mockClear: clearAllMocks,
clearMockRes: clearAllMocks,
};
};
exports.getMockRes = getMockRes;
exports.default = exports.getMockRes;
//# sourceMappingURL=response.js.map