如何使用jest和sequelize-typescript对sequelize数据库调用进行单元测试

Question

在对在数据库模型中创建记录的函数进行单元测试时，出现以下错误。

Model not initialized: Member "create" cannot be called. "UserModel" needs to be added to a Sequelize instance.

我在 https://github.com/RobinBuschmann/sequelize-typescript/issues/688 上发现了一个与此相关的 github 问题

我尝试了使用

validateOnly: true

的解决方案，它引入了另一个错误：

this.lib.Database is not a constructor

模型类看起来像这样：

@Table({ tableName: 'User' })
export class UserModel extends Model {
    @AutoIncrement
    @PrimaryKey
    @Column(DataType.INTEGER)
    public id: number;

    @Unique
    @AllowNull(false)
    @Column(DataType.STRING(100))
    public email!: string;

    @AllowNull(false)
    @Column(DataType.TEXT)
    public password!: string;
}

我想测试的功能如下：

    public async register(registerRequest: RegisterRequest) {
    return UserModel.create({
            email: registerRequest.email,
            password: registerRequest.password
        })
    }

// A sample unit test looks like:

    test('1# Register user', async () => {
        const userService = new UserAccountService()
        jest.spyOn(UserModel, 'create')
    
        const registerRequest: RegisterRequest = {
            email: '[email protected]',
            password: '1234'
        }
        const registeredUser = await userService.register(registerRequest);
    
        expect(UserModel.create).toHaveBeenCalledTimes(1);
        expect(registeredUser).toBeInstanceOf(UserModel);
        expect(registeredUser.email).toEqual('[email protected]')
    });

有人可以帮助我如何使用此类 Sequelize 数据库调用进行单元测试吗？我知道我们可以将

mockImplementationOnce()

或

mockResolvedValue()

与假

UserModel

对象一起使用，但是如果我在具有多个模型的函数中有大量数据库调用，那么模拟或创建所有假模型对象会非常烦人，这会导致创建复杂且大型的测试用例，这显然是一个坏兆头。还有其他方法可以使用 Sequelize 模型函数进行单元测试吗？

Answer 1

我找到了以下解决方案来解决这个问题：

我们可以创建假/模拟sequelize实例，并可以使用sqlite3包初始化所有模型。这对于单元测试和集成测试来说也非常容易。 由于如果我们模拟每个数据库调用，测试包含大量数据库调用的函数可能会非常乏味，因此我们可以在没有任何数据库的情况下使用这个假的sequelize实例，并且可以执行CRUD操作而不会抛出任何错误或警告。

describe('Testing', () => {
  let mockedSequelize: Sequelize;

  beforeEach(async () => {
      mockedSequelize = new Sequelize({
          database: '<any name>',
          dialect: 'sqlite',
          username: 'root',
          password: '',
          validateOnly: true,
          models: [__dirname + '/models'],
      });
      await mockedSequelize.sync({ force: true });
  })

  afterEach(async () => {
      jest.clearAllMocks();
      await mockedSequelize.close();
  })

  test('1# Register user', async () => {
      const userService = new UserAccountService()
      jest.spyOn(UserModel, 'create')

      const registerRequest: RegisterRequest = {
          email: '[email protected]',
          password: '1234'
      }
      const registeredUser = await userService.register(registerRequest);

      expect(UserModel.create).toHaveBeenCalledTimes(1);
      expect(registeredUser).toBeInstanceOf(UserModel);
      expect(registeredUser.email).toEqual('[email protected]')
  });
});

这可能会引发错误，找不到 sqlite 包。您可以安装

sqlite3

包然后开始测试。