网站搜索

node.js - 如何将依赖注入到 Firebase/Google 云函数中?(单元测试与集成测试)


我不知道我的问题是否真的与 Firebase 云函数相关,但我在尝试测试我的 Firebase 云函数时遇到了这个问题。

假设我有一个用 NodeJS 编写的 Firebase Cloud 函数:

function.ts

import * as functions from "firebase-functions"
const admin = require("firebase-admin")

import * as authVerifier from "../../auth/authVerifier"

export default functions.https.onRequest(async (req, res) => {
  let authId
  try {
    authId = await authVerifier.identifyClientRequest(req)
  } catch (err) {
    console.error(`Unauthorized request error: ${err}`)
    return res.status(401).send({
      error: "Unauthorized request"
    })
  }
}

通常我有一个接口,可以轻松地模拟我想测试的任何类。

例如,authVerifier 看起来像这样:

authVerifier.ts

import * as express from "express"

export async function identifyClientRequest(req: express.Request) {
  return true // whatever, it doesn't really matter, should be real logic here
}

我正在尝试测试 function.ts,我只能将 res 和 req 传入,例如:

function.test.ts

it("should verify client identity", async () => {
  const req = {
    method: "PUT"
  }

  const res = { }

  await myFunctions(req as express.Request, res as express.Response)

  // assert that authVerifier.identifyClientRequest(req) called with passed req
})

所以问题是:我如何模拟 authVerifier.identifyClientRequest(req),以在 function.ts 和 function.test.ts 中使用不同的实现?

我不太懂 NodeJS/TypeScript,所以我想知道我是否可以导入另一个 authVerifier 的 mock 类来进行测试或类似的操作。

答案#1

好,看来我找到了答案。我会把它贴在这里以防万一。

使用 sinonjs 和 chai,我们可以模拟我们的类(在这种情况下是 authVerifier)以返回所需的结果:

const chai = require("chai")
const assert = chai.assert
const sinon = require("sinon")

import * as authVerifier from "../../../src/auth/authVerifier"

it("should verify client identity", async () => {
   const req = {
     method: "PUT"
   }

   const res = mocks.createMockResponse()

   const identifyClientRequestStub = sinon.stub(authVerifier, "identifyClientRequest");
   const authVerifierStub = identifyClientRequestStub.resolves("UID")

   await updateUser(req as express.Request, res as express.Response)

   assert.isTrue(authVerifierStub.calledWith(req))
})

结果是: