首页
指南
API
开发
贡献
首页
指南
API
开发
贡献

测试

测试基于 Jest 测试框架。为了方便的编写测试，提供了 mockDatabase() 和 mockServer() 用于数据库和服务端应用的测试。

WARNING

测试的环境变量在 .env.test文件里配置，建议使用独立的测试数据库进行测试。

mockDatabase()

默认提供一种完全隔离的 db 测试环境

import { mockDatabase } from '@tachybase/test';

describe('my db suite', () => {
  let db;

  beforeEach(async () => {
    db = mockDatabase();
    db.collection({
      name: 'posts',
      fields: [
        {
          type: 'string',
          name: 'title',
        },
      ],
    });
    await db.sync();
  });

  afterEach(async () => {
    await db.close();
  });

  test('my case', async () => {
    const repository = db.getRepository('posts');
    const post = await repository.create({
      values: {
        title: 'hello',
      },
    });

    expect(post.get('title')).toEqual('hello');
  });
});

mockServer()

提供模拟的服务端应用实例，对应的 app.db 为 mockDatabase() 实例，同时还提供了便捷的 app.agent() 用于测试 HTTP API，针对 Tachybase 的 Resource Action 还封装了 app.agent().resource() 用于测试资源的 Action。

import { MockServer, mockServer } from '@tachybase/test';

// 每个插件的 app 最小化安装的插件都不一样，需要插件根据自己的情况添加必备插件
async function createApp(options: any = {}) {
  const app = mockServer({
    ...options,
    plugins: [
      'acl',
      'users',
      'collection-manager',
      'error-handler',
      ...options.plugins,
    ],
    // 还会有些其他参数配置
  });
  // 这里可以补充一些需要特殊处理的逻辑，比如导入测试需要的数据表
  return app;
}

// 大部分的测试都需要启动应用，所以也可以提供一个通用的启动方法
async function startApp() {
  const app = createApp();
  await app.quickstart({
    // 运行测试前，清空数据库
    clean: true,
  });
  return app;
}

describe('test example', () => {
  let app: MockServer;

  beforeEach(async () => {
    app = await startApp();
  });

  afterEach(async () => {
    // 运行测试后，清空数据库
    await app.destroy();
    // 只停止不清空数据库
    await app.stop();
  });

  test('case1', async () => {
    // coding...
  });
});

常用的应用流程

如果需要测试不同流程的情况，可以根据以下示例执行相关命令。

先安装再启动

终端命令行

pnpm tachybase install
pnpm start

前置的测试流程

const app = mockServer();
await app.runCommand('install');
await app.runCommand('start');

先启动再安装

终端命令行

pnpm start # 常驻内存
# 另一个终端里执行
pnpm tachybase install

前置的测试流程

const app = mockServer();
await app.runCommand('start');
await app.runCommand('install');

快速启动（自动安装或升级）

终端命令行

yarn start --quickstart

前置的测试流程

const app = mockServer();
await app.runCommand('start', '--quickstart');

对已安装启动的应用进行重装

终端命令行

pnpm start --quickstart
# 另一个终端里执行
pnpm tachybase install -f

前置的测试流程

const app = mockServer();
await app.runCommand('start', '--quickstart');
await app.runCommand('install', '-f');

升级应用（启动前）

终端命令行

pnpm tachybase upgrade
pnpm start

前置的测试流程

const app = mockServer();
await app.runCommand('upgrade', '-f');
await app.runCommand('start', '--quickstart');

升级应用（启动后）

pnpm start # 常驻内存
# 另一个终端里执行
pnpm tachybase upgrade

前置的测试流程

const app = mockServer();
await app.runCommand('start', '--quickstart');
await app.runCommand('upgrade', '-f');

激活插件

终端命令行

yarn start --quickstart
yarn pm enable @my-project/plugin-hello

前置的测试流程

const app = mockServer();
await app.runCommand('start', '--quickstart');
await app.runCommand('pm', 'enable', '@my-project/plugin-hello');

禁用插件

终端命令行

yarn start --quickstart
yarn pm disable @my-project/plugin-hello

前置的测试流程

const app = mockServer();
await app.runCommand('start', '--quickstart');
await app.runCommand('pm', 'disable', '@my-project/plugin-hello');