Блог

У меня есть интеграционный тест, в котором я делаю фактические вызовы DB для базы данных MongoDB. Но для того, чтобы проверить, истек срок действия транзакции или нет, мне нужно издеваться над DB для этого конкретного теста. У меня есть много причин сделать фактический вызов DB, я упоминаю состояние только ради этого примера.

У Jest есть jest.doMock функция, но это полезно только тогда, когда я хотел импортировать функцию в тест, но в моем случае это функция DB, которую я хотел смоделировать для этого конкретного теста, когда вызывается внутри промежуточного программного обеспечения express.

Есть еще один вариант издевательства над всем ../db модулем, но это сильно усложнит тесты в моем реальном проекте. Для меня было бы очень легко, если бы я мог издеваться над вызовом DB для определенного теста, а для остальных всех тестов он должен выполнять реальные вызовы DB.

Есть ли способ сделать это в шутку?

 // a.ts
import express from "express"
import db from "../db";

const app = express()

app.get("/api/deduct-balance/:txn_id", (req, res) => {
  const txn = await db.findById(txn_id)
  
  // return error message if txn expired
  if (txn.exipre_at <= new Date()) {
    return res.status(401).json({ error: "txn expired" });
  }

  // otherwise update the txn state
  txn.state = "DEDUCTED";
  await txn.save()

  return res.status(200).json();
});
  

 // a.test.ts
import db from "../db";

describe("mixed tests", () => {
  test("should make REAL db calls", async () => {
    await axios.get("/api/deduct-balance/123")
    const txn = await db.findById("123");
    expect(txn.state).toBe("DEDUCTED");
  });

  test("should use MOCKED value", async () => {
    // need a way to mock the DB call so that I can return an expired transaction
    // when I hit the API

    const { data } = await axios.get("/api/deduct-balance/123")
    
    expect(data).toBe({
      error: {
        message: "txn expired"
      }
    });
  });
})
  

Интеграционные тесты излишни для этого сценария. Достаточно простых модульных тестов. Они быстро выполняются, тестируют только одну вещь, и у вас их должно быть много.

Поскольку вы определяете обработчик как анонимную функцию, по умолчанию сложно выполнить модульное тестирование. Итак, первое действие — упростить тестирование, извлекая его.

 // deduct-balance-handlers.ts
export const deductBalanceByTransaction = async (req, res) => {
   const txn = await db.findById(txn_id)

   // return error message if txn expired
   if (txn.exipre_at <= new Date()) {
        return res.status(401).json({ error: "txn expired" });
   }

   // otherwise update the txn state
   txn.state = "DEDUCTED";
   await txn.save()

   return res.status(200).json();
}
  

Это также сделает конфигурацию приложения более чистой.

 // a.ts
import express from "express"
import db from "../db";
import { deductBalanceByTransaction } from './deduct-balance-handlers';
const app = express()

app.get("/api/deduct-balance/:txn_id", deductBalanceByTransaction);
  

Теперь легко повторно использовать обработчик в вашем тесте, не полагаясь на веб-фреймворк или базу данных.

 // a.test.ts
import db from "../db";
import { deductBalanceByTransaction } from './deduct-balance-handlers';

jest.mock('../db');

describe("deduct-balance", () => {
  test("Expired transaction should respond with 401 status", async () => {
    const response = mockResponse();
    deductBalanceByTransaction(request, response);
    expect(response.status).toBe(401);
  });
})
  

Для простоты я оставил часть создания макетного ответа и издевательства над модулем из кода. Больше можно узнать о издевательствах здесь: https://jestjs.io/docs/en/manual-mocks