如何用Jest模拟DynamoDb Datamapper返回的DynamoDb？

Question

我试图为调用TypeScript的DynamoDb类编写单元测试。到目前为止，这就是我所掌握的。

import {DataMapper, QueryIterator} from '@aws/dynamodb-data-mapper';
import DynamoDB = require("aws-sdk/clients/dynamodb");

jest.mock("aws-sdk/clients/dynamodb");
jest.mock("@aws/dynamodb-data-mapper");


describe("queryDynamoDb", () => {
    let myRepository = new MyRepository();
    const mockQueryCall = jest.fn();

    DataMapper.prototype.query = mockQueryCall;

   test("queriesDynamoDb", async () => {
        const mockQueryIterator = <jest.Mock<QueryIterator<DataObject>>>QueryIterator;
        mockQueryIterator.prototype.next.mockReturnValueOnce(getExpectedReturnObjectsValues())
        mockQueryCall.mockReturnValue(mockQueryIterator);

        let responseObjects = await myRepository.queryDynamoDb(testIdString);

        // Validate response Objects
   })
});

该方法使用for...of循环迭代响应，因此我需要返回.next函数。

为了测试测试，我将console.log(await queryIterator.next());添加到dynamoDb查询函数中。

但是当我尝试运行它时，我的反应是：

TypeError: queryIterator.next不是一个函数

在日志线上。

因此，很明显，mockQueryCall.mockReturnValue(mockQueryIterator);没有完成它的工作并返回我的mockQueryIterator，或者const mockQueryIterator = <jest.Mock<QueryIterator<DataObject>>>QueryIterator;没有正确地将类型应用于mockQueryIterator。但我不知道怎么解决这两件事。

Answer 1

经过一些尝试和错误之后，我想出了一些有用的东西。它模拟了QueryIterator的Symbol.iterator函数。

import {DataMapper, QueryIterator, StringToAnyObjectMap} from '@aws/dynamodb-data-mapper';
import createMockInstance from 'jest-create-mock-instance';

describe('alert service test', () => {

    test('find by user id', async () => {
        const mapper = createMockInstance(DataMapper);
        const qi: QueryIterator<StringToAnyObjectMap> = createMockInstance(QueryIterator);
        // @ts-ignore
        qi[Symbol.iterator] = jest.fn(() => [1, 2, 3].values());
        mapper.query.mockReturnValue(qi);

        // @ts-ignore any query arguments will do
        const results = mapper.query();

        const resultArray = [];
        for await (const o of results) {
            resultArray.push(o);
        }
        expect(resultArray).toEqual([1, 2, 3]);
    });
});