在做nodejs后端开发中,不得不面对的一个问题是写单元测试(UT)。那么你也可能遇到下面的问题。
- 当你mock某个文件里面的函数,但是该文件里面其他用到该函数的方法没有进到你mock的方法里去。
案例分析:
代码
有如下方法需要写单元测试, 存放在文件名为radioStateHelper.js里。
// radioStateHelper.js
// 待测函数
function updateStateExceptAxc(antennaLineUri) {
// 代码...
return updateState(affectedUrisExceptAxc) // 注意这里,引用本文件的另一个函数,这里有问题
.tap(function() {
logger.debug("change state of resource %s successful", JSON.stringify(affectedUrisExceptAxc));
}).catch(function(err) {
logger.error("change state of resource %s failed, fail reason %s", JSON.stringify(affectedUrisExceptAxc), err.message);
});
}
function updateState(resourceUris) {
return Promise.try(function() {
// 代码...
});
}
// exports 出去方便测试。
// only for UT testing
module.exports.updateState = updateState;
module.exports.updateStateExceptAxc = updateStateExceptAxc;
单元测试文件,对updateStateExceptAxc()方法进行测试。
// UT测试文件
it("updateStateExceptAxc(): should call updateState method once", function(done) {
inq.mock(radioStateHelper, "updateState"); // 首先mock radioStateHelper的updateState方法
inq.expect(radioStateHelper.updateState).once.returns(Promise.resolve()); // 期待改方法被执行一次
radioStateHelper.updateStateExceptAxc(antennaLineUri).then(done); //调用测试函数
});
测试结果
没有调到mock的方法,而是调用原函数。
分析
期望结果: 我们期望调用测试函数的时候( radioStateHelper.updateStateExceptAxc(antennaLineUri).then(done); //调用测试函数
)是用到我们mock的updateState方法。
实际情况:实际上,还是执行到radioStateHelper.js的updateState方法了, 而没有走mock的方法,所以抛出好多异常。
原因分析:
module.exports.updateState = updateState
实际上是指exports出去的updateState的引用指向当前文件里的函数updateState。其它文件调用updateState都是用的exports出去的updateState。只是它的引用是radioStateHelper.js的updateState函数。
所以当inq.mock(radioStateHelper, "updateState");
时候,实际上是把exports出来的updateState 给mock了。
如图:
本例里面radioStateHelper.updateStateExceptAxc(antennaLineUri)
调用的时候, 该方法里面return updateState(affectedUrisExceptAxc)
,实际上还是用的radioStateHelper.js的函数updateState。所以不会用到mock的方法。
改进措施
知道原因后,改起来就方便了,只需要把radioStateHelper.js里面调用function updateState地方,改成调用module.exports.updateState
,这样module.exports.updateState(affectedUrisExceptAxc)
就指向mock的函数了。
代码更改
// 代码更改
return updateState(affectedUrisExceptAxc) // 注意这里,引用本文件的另一个函数,这里有问题
// ==> 改成 ==>
return module.exports.updateState(affectedUrisExceptAxc) // 更改完成