javascript - node jasmine - 如何对涉及 redis 调用的函数进行单元测试？

Question

我刚开始玩 Jasmine，我还在为 spy /模拟的事情苦苦挣扎，例如，我有一个函数

module.exports = (() => {
    ....

    function getUserInfo(id) {
        return new Promise((resolve, reject) => {
            redis.getAsync(id).then(result => {
                resolve(result)
            })
        }) 
    }
    return { getUserInfo: getUserInfo }
})()

然后我开始编写 Jasmine 规范

describe('Test user helper', () => {
    let userInfo

    beforeEach(done => {
        userHelper.getUserInfo('userid123')
            .then(info => {
                userInfo = info
                done() 
            })
    })

    it('return user info if user is found', () => {
        expect(userInfo).toEqual('info of userid 123')
    })
})

它运行良好，但我的问题是如何模拟 redis.getAsync 调用，使其成为真正的独立单元测试？

谢谢。

Answer 1

好问题。您可以模拟 redis 依赖项，但前提是您稍微重写代码以提高可测试性。在这里，这意味着将 redis 作为返回包含 getUserInfo 对象的工厂的参数。

当然，这改变了 API，调用者现在需要调用导出来获取对象。为了解决这个问题，我们可以创建一个包装器模块，它使用标准的 redis 对象调用函数，并返回结果。然后我们将实际的工厂移动到一个内部模块中，这仍然允许对其进行测试。

这可能是这样的

user-helper/factory.js

module.exports = redis => {
  ....

  function getUserInfo(id) {
    return redis.getAsync(id); // note simplified as new Promise was not needed
  }
  return {getUserInfo};
};

user-helper/index.js

// this is the wrapper that preserves existing API
module.exports = require('./factory')(redis);

现在进行测试

const userHelperFactory = require('./user-helper/factory');

function createMockRedis() {
  const users = [
    {userId: 'userid123'},
    // etc.
  ];
  return {
    getAsync: function (id) {
      // Note: I do not know off hand what redis returns, or if it throws,
      // if there is no matching record - adjust this to match.
      return Promise.resolve(users.find(user => user.userId === id));
    }
  };
}

describe('Test user helper', () => {
  const mockRedis = createMockRedis();
  const userHelper = userHelperFactory(mockRedis);

  let userInfo;

  beforeEach(async () => {
    userInfo = await userHelper.getUserInfo('userid123');
  });

  it('must return user info when a matching user exists', () => {
    expect(userInfo).toEqual('info of userid 123');
  });
});

注意:正如评论中所讨论的，这只是我对当前情况的偶然做法。您可以使用许多其他设置和约定，但主要想法只是基于 IIFE 结果的现有导出，这是一个可靠的模式，我利用了 NodeJS /index 约定以保留现有的 API。您也可以使用一个文件并通过 module.exports = factory(redis) 和 module.exports.factory = factory 进行导出，但我相信这样会更少NodeJS 中的惯用语。更广泛的观点是，能够模拟测试，而可测试性通常只是关于参数化。

参数化非常强大，它的简单性就是为什么使用函数式语言的开发人员有时会 mock 像您这样的 OOP 程序员，以及我们的 secret 咒语，例如“哦，光荣的依赖注入(inject)容器，给我一个 instanceof X":)

不是 OOP 或 DI 弄错了，而是可测试性、DI、IOC 等只是关于参数化。

有趣的是，如果我们将 redis 作为模块加载，并且如果我们使用可配置的模块加载器(例如 SystemJS)，我们可以通过在测试级别简单地使用加载器配置来实现。即使是 Webpack 也允许您在某种程度上执行此操作，但对于 NodeJS，您需要对 Require 函数进行猴子修补，或者创建一堆假包，这不是好的选择。

OP的具体回应

Thanks! That's a good idea, but practically, it seems it's quite strange when I have tons of file to test in which I will need to create a factory and index.js for each of them.

您需要重组 API 表面并简单地导出使用代码必须调用的工厂，而不是应用这些工厂的结果，以减轻负担，但需要权衡取舍，默认实例对消费者有帮助。