ContextQMD
Back to Nocobase

服务端插件测试

docs/docs/cn/plugin-development/server/test.md

2.0.555.4 KB
Original Source

Test 测试

NocoBase 提供了一套完整的测试工具，帮助开发者在插件开发过程中快速验证数据库逻辑、API 接口和功能实现的正确性。本文将介绍如何编写、运行和组织这些测试。

为什么要编写测试

在插件开发中编写自动化测试的好处：

  • 快速验证数据库模型、API、业务逻辑是否正确
  • 避免回归错误（升级核心后自动检测插件兼容性）
  • 支持持续集成（CI）环境自动运行测试
  • 支持在不启动完整服务的情况下测试插件功能

测试环境基础

NocoBase 提供两个核心测试工具：

工具说明用途
createMockDatabase创建内存数据库实例测试数据库模型和逻辑
createMockServer创建完整的应用实例（含数据库、插件、API 等）测试业务流程和接口行为

使用 createMockDatabase 进行数据库测试

createMockDatabase 适合测试与数据库直接相关的功能，例如模型定义、字段类型、关系、CRUD 操作等。

基础示例

ts
import { createMockDatabase, Database } from '@nocobase/database';

describe('Database test', () => {
  let db: Database;

  beforeEach(async () => {
    db = await createMockDatabase();
    await db.clean({ drop: true });
  });

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

  it('should create and query data', async () => {
    const User = db.collection({
      name: 'users',
      fields: [
        { type: 'string', name: 'username' },
        { type: 'integer', name: 'age' },
      ],
    });

    await User.sync();

    const user = await db.getRepository('users').create({
      values: { username: 'testuser', age: 25 },
    });

    const found = await db.getRepository('users').findOne({
      filter: { username: 'testuser' },
    });

    expect(found.get('age')).toBe(25);
  });
});

测试 CRUD 操作

ts
const Posts = db.collection({
  name: 'posts',
  fields: [{ type: 'string', name: 'title' }],
});
await db.sync();

// Create
const post = await db.getRepository('posts').create({ values: { title: 'Initial Title' } });
expect(post.get('title')).toBe('Initial Title');

// Update
await db.getRepository('posts').update({
  filterByTk: post.get('id'),
  values: { title: 'Updated Title' },
});
const updated = await db.getRepository('posts').findOne({ filterByTk: post.get('id') });
expect(updated.get('title')).toBe('Updated Title');

测试模型关联

ts
const Users = db.collection({
  name: 'users',
  fields: [
    { type: 'string', name: 'username' },
    { type: 'hasMany', name: 'posts' },
  ],
});

const Posts = db.collection({
  name: 'posts',
  fields: [
    { type: 'string', name: 'title' },
    { type: 'belongsTo', name: 'author' },
  ],
});
await db.sync();

const user = await db.getRepository('users').create({ values: { username: 'tester' } });
await db.getRepository('posts').create({
  values: { title: 'Post 1', authorId: user.get('id') },
});

const result = await db.getRepository('users').findOne({
  filterByTk: user.get('id'),
  appends: ['posts'],
});
expect(result.get('posts')).toHaveLength(1);

使用 createMockServer 进行 API 测试

createMockServer 会自动创建一个包含数据库、插件、API 路由的完整应用实例，非常适合测试插件接口。

基础示例

ts
import { createMockServer, MockServer } from '@nocobase/test';

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

  beforeEach(async () => {
    app = await createMockServer({ plugins: ['users', 'auth'] });
  });

  afterEach(async () => {
    await app.destroy();
  });

  it('should create a user', async () => {
    const response = await app.agent()
      .post('/users:create')
      .send({ username: 'test', email: '[email protected]', password: '123456' });

    expect(response.status).toBe(200);
    expect(response.body.username).toBe('test');
  });
});

测试接口的查询与更新

ts
// Query user list
const list = await app.agent().get('/users:list');
expect(list.body.rows.length).toBeGreaterThan(0);

// Update user
const update = await app.agent().post(`/users:update/${id}`).send({ username: 'newname' });
expect(update.body.username).toBe('newname');

模拟登录状态或权限测试

你可以在创建 MockServer 时启用 auth 插件，然后使用登录接口获得 token 或 session：

ts
const res = await app
  .agent()
  .post('/auth:signin')
  .send({ 
    username: 'admin',
    password: 'admin123',
  });

const token = res.body.data.token;

await app
  .agent()
  .set('Authorization', `Bearer ${token}`)
  .get('/protected-endpoint');

也可以使用更简单的 login() 方法

ts
await app.agent().login(userOrId);

在插件中组织测试文件

建议在插件的 ./src/server/__tests__ 文件夹中存放与服务端逻辑相关的测试文件。

bash
packages/plugins/@my-project/plugin-hello/
├── src/                     # Source code directory
│   └── server/              # Server-side code
│       ├── __tests__/       # Test files directory
│       │   ├── db.test.ts   # Database related tests (using createMockDatabase)
│       │   └── api.test.ts  # API related tests

运行测试

bash
# Specify directory
yarn test packages/plugins/@my-project/plugin-hello/src/server
# Specify file
yarn test packages/plugins/@my-project/plugin-hello/src/server/__tests__/db.test.ts