{"id":13487434,"url":"https://github.com/eggjs/mock","last_synced_at":"2025-10-14T14:17:47.431Z","repository":{"id":10459066,"uuid":"61421499","full_name":"eggjs/mock","owner":"eggjs","description":"Mock library for egg testing.","archived":false,"fork":false,"pushed_at":"2025-08-06T09:40:20.000Z","size":597,"stargazers_count":143,"open_issues_count":1,"forks_count":31,"subscribers_count":25,"default_branch":"5.x","last_synced_at":"2025-10-05T14:02:01.759Z","etag":null,"topics":["egg","egg-mock","mm","mock","muk"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eggjs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2016-06-18T07:01:05.000Z","updated_at":"2025-09-12T02:58:24.000Z","dependencies_parsed_at":"2023-01-16T21:00:52.685Z","dependency_job_id":"e271df7b-ba78-4a7f-836a-72040b2d1113","html_url":"https://github.com/eggjs/mock","commit_stats":{"total_commits":279,"total_committers":31,"mean_commits":9.0,"dds":0.7240143369175627,"last_synced_commit":"110cb8a06e6ddadac22f82672a28c43080258f53"},"previous_names":["eggjs/mock"],"tags_count":136,"template":false,"template_full_name":null,"purl":"pkg:github/eggjs/mock","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eggjs%2Fmock","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eggjs%2Fmock/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eggjs%2Fmock/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eggjs%2Fmock/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eggjs","download_url":"https://codeload.github.com/eggjs/mock/tar.gz/refs/heads/5.x","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eggjs%2Fmock/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279017453,"owners_count":26086081,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-13T02:00:06.723Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["egg","egg-mock","mm","mock","muk"],"created_at":"2024-07-31T18:00:59.229Z","updated_at":"2025-10-14T14:17:47.426Z","avatar_url":"https://github.com/eggjs.png","language":"TypeScript","funding_links":[],"categories":["仓库","QuickStart"],"sub_categories":["[内置插件](https://eggjs.org/zh-cn/basics/plugin.html#%E6%8F%92%E4%BB%B6%E5%88%97%E8%A1%A8)","Feature"],"readme":"# egg-mock\n\n[![NPM version][npm-image]][npm-url]\n[![Node.js CI](https://github.com/eggjs/egg-mock/actions/workflows/nodejs.yml/badge.svg)](https://github.com/eggjs/egg-mock/actions/workflows/nodejs.yml)\n[![Test coverage][codecov-image]][codecov-url]\n[![npm download][download-image]][download-url]\n\n[npm-image]: https://img.shields.io/npm/v/egg-mock.svg?style=flat-square\n[npm-url]: https://npmjs.org/package/egg-mock\n[codecov-image]: https://codecov.io/github/eggjs/egg-mock/coverage.svg?branch=master\n[codecov-url]: https://codecov.io/github/eggjs/egg-mock?branch=master\n[download-image]: https://img.shields.io/npm/dm/egg-mock.svg?style=flat-square\n[download-url]: https://npmjs.org/package/egg-mock\n\nMock library for testing Egg applications, plugins and custom Egg frameworks with ease. `egg-mock` inherits all APIs from [node_modules/mm](https://github.com/node-modules/mm), offering more flexibility.\n\n## Install\n\n```bash\n$ npm i egg-mock --save-dev\n```\n\n## Usage\n\n### Create testcase\n\nLaunch a mock server with `mm.app`\n\n```js\n// test/index.test.js\nconst path = require('path');\nconst mm = require('egg-mock');\n\ndescribe('some test', () =\u003e {\n  let app;\n  before(() =\u003e {\n    app = mm.app({\n      baseDir: 'apps/foo'\n    });\n    return app.ready();\n  })\n  after(() =\u003e app.close());\n\n  it('should request /', () =\u003e {\n    return app.httpRequest()\n      .get('/')\n      .expect(200);\n  });\n});\n```\n\nRetrieve Agent instance through `app.agent` after `mm.app` started.\n\nUsing `mm.cluster` launch cluster server, you can use the same API as `mm.app`;\n\n### Test Application\n\n`baseDir` is optional that is `process.cwd()` by default.\n\n```js\nbefore(() =\u003e {\n  app = mm.app();\n  return app.ready();\n});\n```\n\n### Test Framework\n\nframework is optional, it's `node_modules/egg` by default.\n\n```js\nbefore(() =\u003e {\n  app = mm.app({\n    baseDir: 'apps/demo',\n    framework: true,\n  });\n  return app.ready();\n});\n```\n\n### Test Plugin\n\nIf `eggPlugin.name` is defined in `package.json`, it's a plugin that will be loaded to plugin list automatically.\n\n```js\nbefore(() =\u003e {\n  app = mm.app({\n    baseDir: 'apps/demo',\n  });\n  return app.ready();\n});\n```\n\nYou can also test the plugin in different framework, e.g. test [aliyun-egg](https://github.com/eggjs/aliyun-egg) and framework-b in one plugin.\n\n```js\ndescribe('aliyun-egg', () =\u003e {\n  let app;\n  before(() =\u003e {\n    app = mm.app({\n      baseDir: 'apps/demo',\n      framework: path.join(__dirname, 'node_modules/aliyun-egg'),\n    });\n    return app.ready();\n  });\n});\n\ndescribe('framework-b', () =\u003e {\n  let app;\n  before(() =\u003e {\n    app = mm.app({\n      baseDir: 'apps/demo',\n      framework: path.join(__dirname, 'node_modules/framework-b'),\n    });\n    return app.ready();\n  });\n});\n```\n\nIf it's detected as an plugin, but you don't want it to be, you can use `plugin = false`.\n\n```js\nbefore(() =\u003e {\n  app = mm.app({\n    baseDir: 'apps/demo',\n    plugin: false,\n  });\n  return app.ready();\n});\n```\n\n## API\n\n### mm.app(options)\n\nCreate a mock application.\n\n### mm.cluster(options)\n\nCreate a mock cluster server, but you can't use API in application, you should test using `supertest`.\n\n```js\nconst mm = require('egg-mock');\ndescribe('test/app.js', () =\u003e {\n  let app, config;\n  before(() =\u003e {\n    app = mm.cluster();\n    return app.ready();\n  });\n  after(() =\u003e app.close());\n\n  it('some test', () =\u003e {\n    return app.httpRequest()\n      .get('/config')\n      .expect(200)\n  });\n});\n```\n\nYou can disable coverage, because it's slow.\n\n```js\nmm.cluster({\n  coverage: false,\n});\n```\n\n### mm.env(env)\n\nMock env when starting\n\n```js\n// production environment\nmm.env('prod');\nmm.app({\n  cache: false,\n});\n```\n\nEnvironment list \u003chttps://github.com/eggjs/egg-core/blob/master/lib/loader/egg_loader.js#L82\u003e\n\n### mm.consoleLevel(level)\n\nMock level that print to stdout/stderr\n\n```js\n// DON'T log to terminal\nmm.consoleLevel('NONE');\n```\n\nlevel list: `DEBUG`, `INFO`, `WARN`, `ERROR`, `NONE`\n\n### mm.home(homePath)\n\nmock home directory\n\n### mm.restore()\n\nrestore all mock data, e.g. `afterEach(mm.restore)`\n\n### options\n\nOptions for `mm.app` and `mm.cluster`\n\n#### baseDir {String}\n\nThe directory of application, default is `process.cwd()`.\n\n```js\nmm.app({\n  baseDir: path.join(__dirname, 'fixtures/apps/demo'),\n})\n```\n\nYou can use a string based on `$CWD/test/fixtures` for short\n\n```js\nmm.app({\n  baseDir: 'apps/demo',\n})\n```\n\n#### framework {String/Boolean}\n\nThe directory of framework\n\n```js\nmm.app({\n  baseDir: 'apps/demo',\n  framework: path.join(__dirname, 'fixtures/egg'),\n})\n```\n\nIt can be true when test an framework\n\n#### plugin\n\nThe directory of plugin, it's detected automatically.\n\n```js\nmm.app({\n  baseDir: 'apps/demo',\n})\n```\n\n#### plugins {Object}\n\nDefine a list of plugins\n\n#### cache {Boolean}\n\nDetermine whether enable cache. it's cached by baseDir.\n\n#### clean {Boolean}\n\nClean all logs directory, default is true.\n\nIf you are using `ava`, disable it.\n\n### app.mockLog([logger]) and app.expectLog(str[, logger]), app.notExpectLog(str[, logger])\n\nAssert some string value in the logger instance.\nIt is recommended to pair `app.mockLog()` with `app.expectLog()` or `app.notExpectLog()`.\nUsing `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.\n\n```js\nit('should work', async () =\u003e {\n  app.mockLog();\n  await app.httpRequest()\n    .get('/')\n    .expect('hello world')\n    .expect(200);\n\n  app.expectLog('foo in logger');\n  app.expectLog('foo in coreLogger', 'coreLogger');\n  app.expectLog('foo in myCustomLogger', 'myCustomLogger');\n\n  app.notExpectLog('bar in logger');\n  app.notExpectLog('bar in coreLogger', 'coreLogger');\n  app.notExpectLog('bar in myCustomLogger', 'myCustomLogger');\n});\n```\n\n### app.httpRequest()\n\nRequest current app http server.\n\n```js\nit('should work', () =\u003e {\n  return app.httpRequest()\n    .get('/')\n    .expect('hello world')\n    .expect(200);\n});\n```\n\nSee [supertest](https://github.com/visionmedia/supertest) to get more APIs.\n\n#### .unexpectHeader(name)\n\nAssert current response not contains the specified header\n\n```js\nit('should work', () =\u003e {\n  return app.httpRequest()\n    .get('/')\n    .unexpectHeader('set-cookie')\n    .expect(200);\n});\n```\n\n#### .expectHeader(name)\n\nAssert current response contains the specified header\n\n```js\nit('should work', () =\u003e {\n  return app.httpRequest()\n    .get('/')\n    .expectHeader('set-cookie')\n    .expect(200);\n});\n```\n\n### app.mockContext(options)\n\n```js\nconst ctx = app.mockContext({\n  user: {\n    name: 'Jason'\n  }\n});\nconsole.log(ctx.user.name); // Jason\n```\n\n### app.mockContextScope(fn, options)\n\n```js\nawait app.mockContextScope(async ctx =\u003e {\n  console.log(ctx.user.name); // Jason\n}, {\n  user: {\n    name: 'Jason'\n  }\n});\n```\n\n### app.mockCookies(data)\n\n```js\napp.mockCookies({\n  foo: 'bar'\n});\nconst ctx = app.mockContext();\nconsole.log(ctx.getCookie('foo'));\n```\n\n### app.mockHeaders(data)\n\nMock request header\n\n### app.mockSession(data)\n\n```js\napp.mockSession({\n  foo: 'bar'\n});\nconst ctx = app.mockContext();\nconsole.log(ctx.session.foo);\n```\n\n### app.mockService(service, methodName, fn)\n\n```js\nit('should mock user name', function* () {\n  app.mockService('user', 'getName', function* (ctx, methodName, args) {\n    return 'popomore';\n  });\n  const ctx = app.mockContext();\n  yield ctx.service.user.getName();\n});\n```\n\n### app.mockServiceError(service, methodName, error)\n\nYou can mock an error for service\n\n```js\napp.mockServiceError('user', 'home', new Error('mock error'));\n```\n\n### app.mockCsrf()\n\n```js\napp.mockCsrf();\n\nreturn app.httpRequest()\n  .post('/login')\n  .expect(302);\n```\n\n### app.mockHttpclient(url, method, data)\n\nMock httpclient request, e.g.: `ctx.curl`\n\n```js\napp.get('/', function*() {\n  const ret = yield this.curl('https://eggjs.org');\n  this.body = ret.data.toString();\n});\n\napp.mockHttpclient('https://eggjs.org', {\n  // can be buffer / string / json / function\n  // will auto convert to buffer\n  // follow options.dataType to convert\n  data: 'mock egg',\n});\n// app.mockHttpclient('https://eggjs.org', 'get', mockResponse); // mock get\n// app.mockHttpclient('https://eggjs.org', [ 'get' , 'head' ], mockResponse); // mock get and head\n// app.mockHttpclient('https://eggjs.org', '*', mockResponse); // mock all methods\n// app.mockHttpclient('https://eggjs.org', mockResponse); // mock all methods by default\n// app.mockHttpclient('https://eggjs.org', 'get', function(url, opt) { return 'xxx' }); // support fn\n\nreturn app.httpRequest()\n  .post('/')\n  .expect('mock egg');\n```\n\nYou can also use Regular Expression for matching url.\n\n```js\napp.mockHttpclient(/\\/users\\/[a-z]$/i, {\n  data: {\n    name: 'egg',\n  },\n});\n```\n\nYou can alse mock agent.httpclient\n\n```js\napp.agent.mockHttpclient('https://eggjs.org', {\n  data: {\n    name: 'egg',\n  },\n});\n```\n\n## Bootstrap\n\nWe also provide a bootstrap file for applications' unit test to reduce duplicated code:\n\n```js\nconst { app, mock, assert } = require('egg-mock/bootstrap');\n\ndescribe('test app', () =\u003e {\n  it('should request success', () =\u003e {\n    // mock data will be restored each case\n    mock.data(app, 'method', { foo: 'bar' });\n    return app.httpRequest()\n      .get('/foo')\n      .expect(res =\u003e {\n        assert(!res.headers.foo);\n      })\n      .expect(/bar/);\n  });\n});\n\ndescribe('test ctx', () =\u003e {\n  it('can use ctx', async function() {\n    const res = await this.ctx.service.foo();\n    assert(res === 'foo');\n  });\n});\n```\n\nWe inject ctx to every test case, so you can use `app.currentContext` in your test case.\nand the first call of `app.mockContext` will reuse `app.currentContext`.\n\n```js\nconst { app, mock, assert } = require('egg-mock/bootstrap');\n\ndescribe('test ctx', () =\u003e {\n  it('should can use ctx', () =\u003e {\n    const ctx = app.currentContext;\n    assert(ctx);\n  });\n\n  it('should reuse ctx', () =\u003e {\n    const ctx = app.currentContext;\n    // first call will reuse app.currentContext\n    const mockCtx = app.mockContext();\n    assert(ctx === mockCtx);\n    // next call will create a new context\n    // multi call app.mockContext will get wrong context with app.currentContext\n    // so we recommend to use app.mockContextScope\n    const mockCtx2 = app.mockContext();\n    assert(ctx !== mockCtx);\n  });\n});\n```\n\nAnd if you use mm.app to bootstrap app, you can manually call setGetAppCallback,\nthen egg-mock will inject ctx for each test case.\n```js\n// test/.setup.js\nconst mm = require('egg-mock');\nconst path = require('path');\nbefore(async function() {\n  const app = this.app = mm.app();\n  mm.setGetAppCallback(() =\u003e {\n    return app;\n  });\n  await app.ready();\n});\n\n\n// test/index.test.js\nit('should work', function() {\n  // eslint-disable-next-line no-undef\n  assert(this.app.currentContext);\n});\n```\n\n### env for custom bootstrap\n\nEGG_BASE_DIR: the base dir of egg app\nEGG_FRAMEWORK: the framework of egg app\n\n## Questions \u0026 Suggestions\n\nPlease open an issue [here](https://github.com/eggjs/egg/issues).\n\n## License\n\n[MIT](LICENSE)\n\n## Contributors\n\n[![Contributors](https://contrib.rocks/image?repo=eggjs/egg-mock)](https://github.com/eggjs/egg-mock/graphs/contributors)\n\nMade with [contributors-img](https://contrib.rocks).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feggjs%2Fmock","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feggjs%2Fmock","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feggjs%2Fmock/lists"}