Mock library for testing Egg applications, plugins and custom Egg frameworks with ease. egg-mock
inherits all APIs from node_modules/mm, offering more flexibility.
$ npm i egg-mock --save-dev
Launch a mock server with mm.app
// test/index.test.js
const path = require('path');
const mm = require('egg-mock');
describe('some test', () => {
let app;
before(() => {
app = mm.app({
baseDir: 'apps/foo'
});
return app.ready();
})
after(() => app.close());
it('should request /', () => {
return app.httpRequest()
.get('/')
.expect(200);
});
});
Retrieve Agent instance through app.agent
after mm.app
started.
Using mm.cluster
launch cluster server, you can use the same API as mm.app
;
baseDir
is optional that is process.cwd()
by default.
before(() => {
app = mm.app();
return app.ready();
});
framework is optional, it's node_modules/egg
by default.
before(() => {
app = mm.app({
baseDir: 'apps/demo',
framework: true,
});
return app.ready();
});
If eggPlugin.name
is defined in package.json
, it's a plugin that will be loaded to plugin list automatically.
before(() => {
app = mm.app({
baseDir: 'apps/demo',
});
return app.ready();
});
You can also test the plugin in different framework, e.g. test aliyun-egg and framework-b in one plugin.
describe('aliyun-egg', () => {
let app;
before(() => {
app = mm.app({
baseDir: 'apps/demo',
framework: path.join(__dirname, 'node_modules/aliyun-egg'),
});
return app.ready();
});
});
describe('framework-b', () => {
let app;
before(() => {
app = mm.app({
baseDir: 'apps/demo',
framework: path.join(__dirname, 'node_modules/framework-b'),
});
return app.ready();
});
});
If it's detected as an plugin, but you don't want it to be, you can use plugin = false
.
before(() => {
app = mm.app({
baseDir: 'apps/demo',
plugin: false,
});
return app.ready();
});
Create a mock application.
Create a mock cluster server, but you can't use API in application, you should test using supertest
.
const mm = require('egg-mock');
describe('test/app.js', () => {
let app, config;
before(() => {
app = mm.cluster();
return app.ready();
});
after(() => app.close());
it('some test', () => {
return app.httpRequest()
.get('/config')
.expect(200)
});
});
You can disable coverage, because it's slow.
mm.cluster({
coverage: false,
});
Mock env when starting
// production environment
mm.env('prod');
mm.app({
cache: false,
});
Environment list https://github.com/eggjs/egg-core/blob/master/lib/loader/egg_loader.js#L82
Mock level that print to stdout/stderr
// DON'T log to terminal
mm.consoleLevel('NONE');
level list: DEBUG
, INFO
, WARN
, ERROR
, NONE
mock home directory
restore all mock data, e.g. afterEach(mm.restore)
Options for mm.app
and mm.cluster
The directory of application, default is process.cwd()
.
mm.app({
baseDir: path.join(__dirname, 'fixtures/apps/demo'),
})
You can use a string based on $CWD/test/fixtures
for short
mm.app({
baseDir: 'apps/demo',
})
The directory of framework
mm.app({
baseDir: 'apps/demo',
framework: path.join(__dirname, 'fixtures/egg'),
})
It can be true when test an framework
The directory of plugin, it's detected automatically.
mm.app({
baseDir: 'apps/demo',
})
Define a list of plugins
Determine whether enable cache. it's cached by baseDir.
Clean all logs directory, default is true.
If you are using ava
, disable it.
Assert some string value in the logger instance.
It is recommended to pair app.mockLog()
with app.expectLog()
or app.notExpectLog()
.
Using app.expectLog()
or app.notExpectLog()
alone requires dependency on the write speed of the log. When the server disk is high IO, unstable results will occur.
it('should work', async () => {
app.mockLog();
await app.httpRequest()
.get('/')
.expect('hello world')
.expect(200);
app.expectLog('foo in logger');
app.expectLog('foo in coreLogger', 'coreLogger');
app.expectLog('foo in myCustomLogger', 'myCustomLogger');
app.notExpectLog('bar in logger');
app.notExpectLog('bar in coreLogger', 'coreLogger');
app.notExpectLog('bar in myCustomLogger', 'myCustomLogger');
});
Request current app http server.
it('should work', () => {
return app.httpRequest()
.get('/')
.expect('hello world')
.expect(200);
});
See supertest to get more APIs.
Assert current response not contains the specified header
it('should work', () => {
return app.httpRequest()
.get('/')
.unexpectHeader('set-cookie')
.expect(200);
});
Assert current response contains the specified header
it('should work', () => {
return app.httpRequest()
.get('/')
.expectHeader('set-cookie')
.expect(200);
});
const ctx = app.mockContext({
user: {
name: 'Jason'
}
});
console.log(ctx.user.name); // Jason
await app.mockContextScope(async ctx => {
console.log(ctx.user.name); // Jason
}, {
user: {
name: 'Jason'
}
});
app.mockCookies({
foo: 'bar'
});
const ctx = app.mockContext();
console.log(ctx.getCookie('foo'));
Mock request header
app.mockSession({
foo: 'bar'
});
const ctx = app.mockContext();
console.log(ctx.session.foo);
it('should mock user name', function* () {
app.mockService('user', 'getName', function* (ctx, methodName, args) {
return 'popomore';
});
const ctx = app.mockContext();
yield ctx.service.user.getName();
});
You can mock an error for service
app.mockServiceError('user', 'home', new Error('mock error'));
app.mockCsrf();
return app.httpRequest()
.post('/login')
.expect(302);
Mock httpclient request, e.g.: ctx.curl
app.get('/', function*() {
const ret = yield this.curl('https://eggjs.org');
this.body = ret.data.toString();
});
app.mockHttpclient('https://eggjs.org', {
// can be buffer / string / json / function
// will auto convert to buffer
// follow options.dataType to convert
data: 'mock egg',
});
// app.mockHttpclient('https://eggjs.org', 'get', mockResponse); // mock get
// app.mockHttpclient('https://eggjs.org', [ 'get' , 'head' ], mockResponse); // mock get and head
// app.mockHttpclient('https://eggjs.org', '*', mockResponse); // mock all methods
// app.mockHttpclient('https://eggjs.org', mockResponse); // mock all methods by default
// app.mockHttpclient('https://eggjs.org', 'get', function(url, opt) { return 'xxx' }); // support fn
return app.httpRequest()
.post('/')
.expect('mock egg');
You can also use Regular Expression for matching url.
app.mockHttpclient(/\/users\/[a-z]$/i, {
data: {
name: 'egg',
},
});
You can alse mock agent.httpclient
app.agent.mockHttpclient('https://eggjs.org', {
data: {
name: 'egg',
},
});
We also provide a bootstrap file for applications' unit test to reduce duplicated code:
const { app, mock, assert } = require('egg-mock/bootstrap');
describe('test app', () => {
it('should request success', () => {
// mock data will be restored each case
mock.data(app, 'method', { foo: 'bar' });
return app.httpRequest()
.get('/foo')
.expect(res => {
assert(!res.headers.foo);
})
.expect(/bar/);
});
});
describe('test ctx', () => {
it('can use ctx', async function() {
const res = await this.ctx.service.foo();
assert(res === 'foo');
});
});
We inject ctx to every test case, so you can use app.currentContext
in your test case.
and the first call of app.mockContext
will reuse app.currentContext
.
const { app, mock, assert } = require('egg-mock/bootstrap');
describe('test ctx', () => {
it('should can use ctx', () => {
const ctx = app.currentContext;
assert(ctx);
});
it('should reuse ctx', () => {
const ctx = app.currentContext;
// first call will reuse app.currentContext
const mockCtx = app.mockContext();
assert(ctx === mockCtx);
// next call will create a new context
// multi call app.mockContext will get wrong context with app.currentContext
// so we recommend to use app.mockContextScope
const mockCtx2 = app.mockContext();
assert(ctx !== mockCtx);
});
});
And if you use mm.app to bootstrap app, you can manually call setGetAppCallback, then egg-mock will inject ctx for each test case.
// test/.setup.js
const mm = require('egg-mock');
const path = require('path');
before(async function() {
const app = this.app = mm.app();
mm.setGetAppCallback(() => {
return app;
});
await app.ready();
});
// test/index.test.js
it('should work', function() {
// eslint-disable-next-line no-undef
assert(this.app.currentContext);
});
EGG_BASE_DIR: the base dir of egg app EGG_FRAMEWORK: the framework of egg app
Please open an issue here.
Made with contributors-img.