javascript - Sinon 如何 stub 内部使用的类的函数

Question

我想了解是否可以使用 Sinon 来 stub 内部调用的另一个类的函数。

例如有一个 dbutil 类:

class DBUtils {
    getMyResult(var1, var2){
        return new Promise((resolve) => {
            console.log("calling real getMyResult");//I still see this in the log
            resolve(var1 + var2);
        });
    }
}
module.exports = DBUtils;

它在另一个类dummyService中被调用:

const dbUtils = new DBUtils();
class dummyService {
    getResult(var1, var2){
    //initially in my code, it returns a promise, 
    //but I have replaced it with your code
    return dbUtils.getMyResult(var1, var2).then(item =>{
        console.log("finish getting my result!");
        console.log("here is my result: " + item);
        return item; 
    });
}
module.exports = dummyService;

这是我的单元测试文件:(@Mark_M 建议的应用代码更改)

describe("dummy Test", function () {
var service = new DummyService();

const stub = sinon.stub(DBUtils.prototype, 'getMyResult');
stub.resolves("1234");    

it("get result", function() {
    service.getResult("ab", "cd").then(item => {
        console.log(item);
    });
});
});

任何人都可以帮助我理解为什么我的 stub 无法工作吗？以及如何在 dbUtil 类中 stub getMyResult 函数？

================解决方案==================

我错过了两件事:

1. 我应该 stub DBUtils.prototype

sinon.stub(DBUtils.prototype, 'getMyResult').resolves("1234");

在测试中导入 DBUtils 时出现拼写错误。

在 dummyService 内部，我有

const DBUtils = require(./dbutils);

但是，在测试文件中，我有

const DBUtils = require(./DBUtils);

不知何故，sinon 没有提示这一点，这就是为什么我的 stub 从未在原始方法中注入(inject)......在我在测试中更正导入后，我可以看到 stub 结果现在被注入(inject)。

Answer 1

由于 getMyResult() 是 DBUtils 类上的类方法，因此您需要 stub DBUtils 的原型(prototype)。像这样的事情:

DBUtils.getMyResult() 返回一个 promise 。因此，您不需要将其重新包装在 dummyService.getResult() 中的 Promise 中。如果您只返回原始 promise ，那么推理(和测试)会变得更加容易:

虚拟服务:

const DBUtils = require('./DBUtils')

class dummyService {
    getResult(var1, var2){
        const dbUtils = new DBUtils() // <- I assume you are making an instance somewhere
        return dbUtils.getMyResult(var1, var2).then(item =>{
            console.log("finish getting my result!");
            console.log("here is my result: " + item);
            return item // <- if you want to access item in then you need to return it
        });
    }
}
module.exports = dummyService;

现在在 test.js 中:

const DBUtils = require('./DBUtils')
const DummyService = require('./dummy')
const sinon = require('sinon')

// stub the prototype
const stub = sinon.stub(DBUtils.prototype, 'getMyResult')
stub.resolves("Stubbed: 1234")

// make an instance of the service
const service = new DummyService()
service.getResult("ab", "cd").then(item => {
    console.log(item)
    // this prints 'stubbed: 1234'
    // item is "abcd", which is the returned value of the real getMyResult method.
    // the expectation is, item should be "1234" as specified in the stub.
});