单元测试

Vona 强烈建议基于测试驱动开发。测试驱动开发，可以有效沉淀开发成果，当代码出现变更时也能尽快锁定潜在问题，从而显著提升代码的鲁棒性

Vona 采用并行机制运行测试文件，从而显著提升测试效率

创建测试文件

1. Cli命令

$ vona :create:test student --module=demo-student

2. 菜单命令

TIP

右键菜单 - [模块路径]: Vona Create/Test

执行单元测试

$ npm run test

当执行此命名时，系统会执行以下步骤：

1. 创建全局 App 对象
2. 清理 Redis 数据
3. 删除旧数据库，重建一个新的数据库
4. 执行迁移代码
5. 并行执行单元测试文件

$ npm run db:reset

与test命令不同的是，db:reset只执行前4个步骤，不执行单元测试文件

测试覆盖率

$ npm run cov

测试举例

1. 模拟请求上下文对象

describe('student.test.ts', () => {
  it('action:student', async () => {
    await app.bean.executor.mockCtx(async () => {
      // do something
    });
  });
});

• 为 ctx 指定当前语言

describe('student.test.ts', () => {
  it('action:student', async () => {
    await app.bean.executor.mockCtx(async () => {
      // do something
    }, { locale: 'zh-cn' });
  });
});

2. 获取模块Scope对象

await app.bean.executor.mockCtx(async () => {
  const scopeTest = app.bean.scope('demo-student');
});

3. 使用Service

const scopeTest = app.bean.scope('demo-student');
const students = await scopeTest.service.student.findAll();

4. 使用Model

const scopeTest = app.bean.scope('demo-student');
const students = await scopeTest.model.student.select();

5. 使用Entity

const scopeTest = app.bean.scope('demo-student');
const tableName = scopeTest.entity.student.$table;
const fieldName = scopeTest.entity.student.name;

6. 调用Api，从而测试Controller

await app.bean.executor.mockCtx(async () => {
  const students = await app.bean.executor.performAction('get', '/demo/student');
});

7. 模拟认证

• 模拟登录

await app.bean.executor.mockCtx(async () => {
  await app.bean.passport.signinMock();
});

可以指定登录的用户名，默认为admin

await app.bean.passport.signinMock('admin');

• 获取当前用户信息

await app.bean.passport.signinMock();
const passport = app.bean.passport.getCurrent();
const auth = app.bean.passport.getCurrentAuth();
const user = app.bean.passport.getCurrentUser();
const roles = app.bean.passport.getCurrentRoles();

• 模拟退出登录

await app.bean.passport.signinMock();
await app.bean.passport.signout();

8. 工具：assert

Vona 使用 Node 内置的断言库

import assert from 'node:assert';

await app.bean.executor.mockCtx(async () => {
  assert.equal(app.config.server.listen.port, 7102);
});

9. 工具：catchError

catchError可以更优雅的捕获错误异常

• 一般的写法

await app.bean.executor.mockCtx(async () => {
  const scopeTest = app.bean.scope('demo-student');
  try {
    const students = await scopeTest.service.student.findAll();
  } catch (err) {
    // do something
  }
});

• 使用 catchError

import { catchError } from '@cabloy/utils';

await app.bean.executor.mockCtx(async () => {
  const scopeTest = app.bean.scope('demo-student');
  const [students, err] = await catchError(() => {
    return scopeTest.service.student.findAll();
  });
  // do somthing on err
});

10. 完整的Crud测试

describe('student.test.ts', () => {
  it('action:student', async () => {
    await app.bean.executor.mockCtx(async () => {
      // data
      const data: DtoStudentCreate = {
        name: '__Tom__',
        description: 'This is a test',
      };
      const dataUpdate: DtoStudentUpdate = {
        name: '__TomNew__',
        description: 'This is a test',
      };
      // login
      await app.bean.passport.signinMock();
      // create
      const student: EntityStudent = await app.bean.executor.performAction('post', '/demo/student', { body: data });
      assert.equal(student.name, data.name);
      // findAll
      const students: EntityStudent[] = await app.bean.executor.performAction('get', '/demo/student');
      assert.equal(students.findIndex(item => item.name === data.name) > -1, true);
      // update
      await app.bean.executor.performAction('patch', '/demo/student/:id', {
        params: { id: student.id },
        body: dataUpdate,
      });
      // findOne
      const studentOne: EntityStudent = await app.bean.executor.performAction('get', '/demo/student/:id', { params: { id: student.id } });
      assert.equal(studentOne.name, dataUpdate.name);
      // delete
      await app.bean.executor.performAction('delete', '/demo/student/:id', { params: { id: studentOne.id } });
      // findOne
      const [_, err] = await catchError(() => {
        return app.bean.executor.performAction('get', '/demo/student/:id', { params: { id: studentOne.id } });
      });
      assert.equal(err?.code, 404);
      // logout
      await app.bean.passport.signout();
    });
  });
});