数据模拟

Midway 提供了内置的在开发和测试时模拟数据的能力。

测试时 Mock

@midwayjs/mock 提供了一些更为通用的 API，用于在测试时进行模拟。

模拟上下文

使用 mockContext 方法来模拟上下文。

import { mockContext } from '@midwayjs/mock';

it('should test create koa app with new mode with mock', async () => {
  const app = await createApp();

  // 模拟上下文
  mockContext(app, 'user', 'midway');

  const result1 = await createHttpRequest(app).get('/');
  // ctx.user => midway
  // ...
});

如果你的数据比较复杂，或者带有逻辑，也可以使用回调形式。

import { mockContext } from '@midwayjs/mock';

it('should test create koa app with new mode with mock', async () => {
  const app = await createApp();

  // 模拟上下文
  mockContext(app, (ctx) => {
    ctx.user = 'midway';
  });
});

注意，这个 mock 行为是在所有中间件之前执行。

模拟 Session

使用 mockSession 方法来模拟 Session。

import { mockSession } from '@midwayjs/mock';

it('should test create koa app with new mode with mock', async () => {
  const app = await createApp();

  mockSession(app, 'user', 'midway');

  const result1 = await createHttpRequest(app).get('/');
  // ctx.session.user => midway
  // ...
});

模拟 Header

使用 mockHeader 方法来模拟 Header。

import { mockHeader } from '@midwayjs/mock';

it('should test create koa app with new mode with mock', async () => {
  const app = await createApp();

  mockHeader(app, 'x-abc', 'bbb');

  const result1 = await createHttpRequest(app).get('/');
  // ctx.headers['x-abc'] => bbb
  // ...
});

模拟类属性

使用 mockClassProperty 方法来模拟类的属性。

假如有下面的服务类。

@Provide()
export class UserService {
  data;

  async getUser() {
    return 'hello';
  }
}

我们可以在使用时进行模拟。

import { mockClassProperty } from '@midwayjs/mock';

it('should test create koa app with new mode with mock', async () => {

  mockClassProperty(UserService, 'data', {
    bbb: 1
  });
  // userService.data => {bbb: 1}

  // ...
});

也可以模拟方法。

import { mockClassProperty } from '@midwayjs/mock';

it('should test create koa app with new mode with mock', async () => {

  mockClassProperty(UserService, 'getUser', async () => {
    return 'midway';
  });

  // userService.getUser() => 'midway'

  // ...
});

模拟普通对象属性

使用 mockProperty 方法来模拟对象的属性。

import { mockProperty } from '@midwayjs/mock';

it('should test create koa app with new mode with mock', async () => {

  const a = {};
  mockProperty(a, 'name', 'hello');

  // a['name'] => 'hello'

  // ...
});

也可以模拟方法。

import { mockProperty } from '@midwayjs/mock';

it('should test create koa app with new mode with mock', async () => {

  const a = {};
  mockProperty(a, 'getUser', async () => {
    return 'midway';
  });

  // a.getUser() => 'midway'

  // ...
});

清理 mock

在每次调用 close 方法时，会自动清理所有的 mock 数据。

如果希望手动清理，也可以执行方法 restoreAllMocks 。

import { restoreAllMocks } from '@midwayjs/mock';

it('should test create koa app with new mode with mock', async () => {
  restoreAllMocks();
  // ...
});

标准 Mock 服务

Midway 提供了标准的 MidwayMockService 服务，用于在代码中进行模拟数据。

@midwayjs/mock 中的各种模拟方法，底层皆调用了此服务。

具体 API 请参考 内置服务