Jest 模拟 Knex 交易
Jest mock Knex transaction
我有以下 lambda 处理程序来进行单元测试。它使用一个库@org/aws-connection
,它有一个函数mysql.getIamConnection
,它只是returns一个knex连接。
编辑:我在 post
的底部添加了 mysql.getIamConnection
函数
编辑:如果可能的话,我想只用 Jest 进行测试。除非它变得复杂
index.js
const {mysql} = require('@org/aws-connection');
exports.handler = async (event) => {
const connection = await mysql.getIamConnection()
let response = {
statusCode: 200,
body: {
message: 'Successful'
}
}
try {
for(const currentMessage of event.Records){
let records = JSON.parse(currentMessage.body);
await connection.transaction(async (trx) => {
await trx
.table('my_table')
.insert(records)
.then(() =>
console.log(`Records inserted into table ${table}`))
.catch((err) => {
console.log(err)
throw err
})
})
}
} catch (e) {
console.error('There was an error while processing', { errorMessage: e})
response = {
statusCode: 400,
body: e
}
} finally {
connection.destroy()
}
return response
}
我已经编写了一些单元测试,并且能够模拟 connection.transaction
函数,但我在使用 trx.select.insert.then.catch 函数时遇到了问题。 H
这是我的测试文件
index.test.js
import { handler } from '../src';
const mocks = require('./mocks');
jest.mock('@org/aws-connection', () => ({
mysql: {
getIamConnection: jest.fn(() => ({
transaction: jest.fn(() => ({
table: jest.fn().mockReturnThis(),
insert: jest.fn().mockReturnThis()
})),
table: jest.fn().mockReturnThis(),
insert: jest.fn().mockReturnThis(),
destroy: jest.fn().mockReturnThis()
}))
}
}))
describe('handler', () => {
test('test handler', async () =>{
const response = await handler(mocks.eventSqs)
expect(response.statusCode).toEqual(200)
});
});
此测试部分有效,但根本不涵盖 trx
部分。这些线未被覆盖
await trx
.table('my_table')
.insert(records)
.then(() =>
console.log(`Records inserted into table ${table}`))
.catch((err) => {
console.log(err)
throw err
})
如何设置我的 mock @org/aws-connection
以便它也涵盖 trx 函数?
编辑:
mysql.getIamConnection
async function getIamConnection (secretId, dbname) {
const secret = await getSecret(secretId)
const token = await getToken(secret)
let knex
console.log(`Initialzing a connection to ${secret.proxyendpoint}:${secret.port}/${dbname} as ${secret.username}`)
knex = require('knex')(
{
client: 'mysql2',
connection: {
host: secret.proxyendpoint,
user: secret.username,
database: dbname,
port: secret.port,
ssl: 'Amazon RDS',
authPlugins: {
mysql_clear_password: () => () => Buffer.from(token + '[=13=]')
},
connectionLimit: 1
}
}
)
return knex
}
解决方案
@qaismakani 的回答对我有用。我写的略有不同,但回调是关键。对于任何感兴趣的人,这是我的最终解决方案
const mockTrx = {
table: jest.fn().mockReturnThis(),
insert: jest.fn().mockResolvedValue()
}
jest.mock('@org/aws-connection', () => ({
mysql: {
getIamConnection: jest.fn(() => ({
transaction: jest.fn((callback) => callback(mockTrx)),
destroy: jest.fn().mockReturnThis()
}))
}
}))
我编写了 knex-mock-client
而不是模拟 knex 实现,它允许您使用简单的 API.
来模拟真实的数据库
使用
更改您的模拟实现
import { handler } from "../src";
import { getTracker } from "knex-mock-client";
const mocks = require("./mocks");
jest.mock("@org/aws-connection", () => {
const knex = require("knex");
const { MockClient } = require("knex-mock-client");
return {
mysql: {
getIamConnection: () => knex({ client: MockClient }),
},
};
});
describe("handler", () => {
test("test handler", async () => {
const tracker = getTracker();
tracker.on.insert("my_table").responseOnce([23]); // setup's a mock response when inserting into my_table
const response = await handler(mocks.eventSqs);
expect(response.statusCode).toEqual(200);
});
});
好的,让我们看看。更新你的模拟看起来像这样可能会成功:
const {mysql} = require('@org/aws-connection');
jest.mock('@org/aws-connection', () => ({
mySql: {
getIamConnection: jest.fn()
}
}));
const mockTrx = {
table: jest.fn().mockReturnThis(),
insert: jest.fn().mockResolveValue() // resolve any data here
};
mysql.getIamConnection.mockReturnValue({
transaction: jest.fn((callback) => callback(mockTrx)),
});
编辑:解释
您需要以一种使用虚拟 trx 调用您的回调的方式来模拟交易。现在要获得正确的虚拟 trx,您需要确保虚拟 trx 对象中的所有函数 return 返回对它的引用或承诺,以便您可以适当地链接它。
我有以下 lambda 处理程序来进行单元测试。它使用一个库@org/aws-connection
,它有一个函数mysql.getIamConnection
,它只是returns一个knex连接。
编辑:我在 post
的底部添加了mysql.getIamConnection
函数
编辑:如果可能的话,我想只用 Jest 进行测试。除非它变得复杂
index.js
const {mysql} = require('@org/aws-connection');
exports.handler = async (event) => {
const connection = await mysql.getIamConnection()
let response = {
statusCode: 200,
body: {
message: 'Successful'
}
}
try {
for(const currentMessage of event.Records){
let records = JSON.parse(currentMessage.body);
await connection.transaction(async (trx) => {
await trx
.table('my_table')
.insert(records)
.then(() =>
console.log(`Records inserted into table ${table}`))
.catch((err) => {
console.log(err)
throw err
})
})
}
} catch (e) {
console.error('There was an error while processing', { errorMessage: e})
response = {
statusCode: 400,
body: e
}
} finally {
connection.destroy()
}
return response
}
我已经编写了一些单元测试,并且能够模拟 connection.transaction
函数,但我在使用 trx.select.insert.then.catch 函数时遇到了问题。 H
这是我的测试文件 index.test.js
import { handler } from '../src';
const mocks = require('./mocks');
jest.mock('@org/aws-connection', () => ({
mysql: {
getIamConnection: jest.fn(() => ({
transaction: jest.fn(() => ({
table: jest.fn().mockReturnThis(),
insert: jest.fn().mockReturnThis()
})),
table: jest.fn().mockReturnThis(),
insert: jest.fn().mockReturnThis(),
destroy: jest.fn().mockReturnThis()
}))
}
}))
describe('handler', () => {
test('test handler', async () =>{
const response = await handler(mocks.eventSqs)
expect(response.statusCode).toEqual(200)
});
});
此测试部分有效,但根本不涵盖 trx
部分。这些线未被覆盖
await trx
.table('my_table')
.insert(records)
.then(() =>
console.log(`Records inserted into table ${table}`))
.catch((err) => {
console.log(err)
throw err
})
如何设置我的 mock @org/aws-connection
以便它也涵盖 trx 函数?
编辑: mysql.getIamConnection
async function getIamConnection (secretId, dbname) {
const secret = await getSecret(secretId)
const token = await getToken(secret)
let knex
console.log(`Initialzing a connection to ${secret.proxyendpoint}:${secret.port}/${dbname} as ${secret.username}`)
knex = require('knex')(
{
client: 'mysql2',
connection: {
host: secret.proxyendpoint,
user: secret.username,
database: dbname,
port: secret.port,
ssl: 'Amazon RDS',
authPlugins: {
mysql_clear_password: () => () => Buffer.from(token + '[=13=]')
},
connectionLimit: 1
}
}
)
return knex
}
解决方案
@qaismakani 的回答对我有用。我写的略有不同,但回调是关键。对于任何感兴趣的人,这是我的最终解决方案
const mockTrx = {
table: jest.fn().mockReturnThis(),
insert: jest.fn().mockResolvedValue()
}
jest.mock('@org/aws-connection', () => ({
mysql: {
getIamConnection: jest.fn(() => ({
transaction: jest.fn((callback) => callback(mockTrx)),
destroy: jest.fn().mockReturnThis()
}))
}
}))
我编写了 knex-mock-client
而不是模拟 knex 实现,它允许您使用简单的 API.
使用
更改您的模拟实现import { handler } from "../src";
import { getTracker } from "knex-mock-client";
const mocks = require("./mocks");
jest.mock("@org/aws-connection", () => {
const knex = require("knex");
const { MockClient } = require("knex-mock-client");
return {
mysql: {
getIamConnection: () => knex({ client: MockClient }),
},
};
});
describe("handler", () => {
test("test handler", async () => {
const tracker = getTracker();
tracker.on.insert("my_table").responseOnce([23]); // setup's a mock response when inserting into my_table
const response = await handler(mocks.eventSqs);
expect(response.statusCode).toEqual(200);
});
});
好的,让我们看看。更新你的模拟看起来像这样可能会成功:
const {mysql} = require('@org/aws-connection');
jest.mock('@org/aws-connection', () => ({
mySql: {
getIamConnection: jest.fn()
}
}));
const mockTrx = {
table: jest.fn().mockReturnThis(),
insert: jest.fn().mockResolveValue() // resolve any data here
};
mysql.getIamConnection.mockReturnValue({
transaction: jest.fn((callback) => callback(mockTrx)),
});
编辑:解释
您需要以一种使用虚拟 trx 调用您的回调的方式来模拟交易。现在要获得正确的虚拟 trx,您需要确保虚拟 trx 对象中的所有函数 return 返回对它的引用或承诺,以便您可以适当地链接它。