expressJS/jestJS：如何拆分 get() 函数来编写简单的 jest 单元测试？

Question

如何在 expressJS 应用程序中定义 get() 路由以进行简单的单元测试？

所以作为第一步，我将get() 的函数移到了一个自己的文件中：

index.js

const express = require('express')
const socketIo = require('socket.io')
const Gpio = require('pigpio').Gpio

const app = express()
const server = http.createServer(app)
const io = socketIo(server)

const setStatus = require('./lib/setStatus.js')

app.locals['target1'] = new Gpio(1, { mode: Gpio.OUTPUT })

app.get('/set-status', setStatus(app, io))

lib/setStatus.js

const getStatus = require('./getStatus.js')

module.exports = (app, io) => {
  return (req, res) => {
    const { id, value } = req.query // id is in this example '1'
    req.app.locals['target' + id].pwmWrite(value))
    getStatus(app, io)
    res.send({ value }) // don't need this
  }
}

lib/getStatus.js

const pins = require('../config.js').pins

module.exports = async (app, socket) => {
  const res = []
  pins.map((p, index) => {
    res.push(app.locals['target' + (index + 1)].getPwmDutyCycle())
  })
  socket.emit('gpioStatus', res)
}

所以首先我不太确定，如果我正确拆分代码 - 考虑进行单元测试。

对我来说，调用/set-status?id=1&value=50 唯一要做的就是调用pwmWrite() 获取一个（我猜的）对象，该对象由new Gpio 定义并存储在expressJS 的locals 中。

第二个：如果这应该是正确的方法，我不明白如何编写一个 jestJS 单元测试来检查 pwmWrite 是否已被调用 - 这是一个异步函数内部。

这是我的尝试，但我无法测试 pwmWrite 的内部调用：

test('should call pwmWrite() and getStatus()', async () => {
  const app = {}
  const io = { emit: jest.fn() }
  const req = {
    app: {
      locals: {
        target1: { pwmWrite: jest.fn() }
        }
      }
    }
  }
  expect.assertions(1)
  expect(req.app.locals.target1.pwmWrite).toHaveBeenCalled()
  await expect(getStatus(app, io)).toHaveBeenCalled()
})

Answer 1

你们很亲密，只是缺少了一些东西。

你需要在expect语句之前调用setStatus和getStatus方法， 并且您在 req.query 和 res 上缺少模拟，因为 getStatus 使用它们。

test('should call pwmWrite() and getStatus()', async () => {
  const app = {}
  const io = {};
  const req = {
    query: {
      id: '1',
      name: 'foo'
    },
    app: {
      locals: {
          target1: { pwmWrite: jest.fn() }
      }
    }
  };
  const res = { send: jest.fn() };

  // Mock getStatus BEFORE requiring setStatus
  jest.mock('./getStatus');

  //OBS Use your correct module paths
  const setStatus = require('./setStatus');
  const getStatus = require('./getStatus');


  // Call methods
  setStatus(app, io)(req, res);

  expect.assertions(2);

  // Get called in setStatus
  expect(req.app.locals.target1.pwmWrite).toHaveBeenCalled();

  // See if mocked getStatus has been called
  await expect(getStatus).toHaveBeenCalled();
});

getStatus 需要在需要 setStatus 之前进行模拟，因为它在那里使用过