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

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: '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')
    });

有没有人能帮我讲讲如何对这样的顺序化数据库调用进行单元测试？我知道我们可以使用带有伪UserModel对象的mockImplementationOnce()或mockResolvedValue()，但是如果我在一个具有多个模型的函数中有许多数据库调用，模拟或创建所有伪模型对象是非常恼人的，这会导致创建复杂而大型的测试用例，这显然是一个不好的迹象。有没有其他方法可以让我们用Sequelize模型函数进行单元测试？

Answer 1

对于这个问题，我找到了以下解决方案：

我们可以创建伪/模拟序列化实例，并可以使用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包，然后开始测试。