jestjs - 如何使用 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
    })
}

示例单元测试如下所示:

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

    const registerRequest: RegisterRequest = {
        email: 'abc@abc.com',
        password: '1234'
    }
    const registeredUser = await userService.register(registerRequest);

    expect(UserModel.create).toHaveBeenCalledTimes(1);
    expect(registeredUser).toBeInstanceOf(UserModel);
    expect(registeredUser.email).toEqual('abc@abc.com')
});

有人可以帮助我了解如何使用此类 sequelize 数据库调用进行单元测试。我知道我们可以将 mockImplementationOnce() 或 mockResolvedValue() 与假 UserModel 对象一起使用，但是如果我在具有多个模型的函数中调用大量数据库，模拟或创建所有假模型对象会非常烦人，这会导致创建复杂而庞大的测试用例，这显然是一个坏兆头。有没有其他方法可以使用 sequelize 模型函数进行单元测试。

Answer 1

我为这个问题找到了以下解决方案:
我们可以创建 fake/mock 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: 'abc@abc.com',
            password: '1234'
        }
        const registeredUser = await userService.register(registerRequest);

        expect(UserModel.create).toHaveBeenCalledTimes(1);
        expect(registeredUser).toBeInstanceOf(UserModel);
        expect(registeredUser.email).toEqual('abc@abc.com')
    });
});

这可能会引发错误，未找到 sqlite 包。您可以安装 sqlite3 包，然后开始测试。