诗乃 - 内部函数的基本用法

Question

我无法使用sinon获取测试代码的基础知识。我有一个简单的模块，它调用两个内部函数并检查它们的结果。我是使用存根来改变这些函数的输出来测试模块如何响应。这可能吗？

scripts.js中

let check1 = function(){return true}
let check2 = function(){return true}
let startFunc = function(){console.log('checks Passed')}
let sendLog = function(message){console.log(message)}

module.exports.check=function(){

    console.log('check1: ', check1())
    console.log('check2: ', check2())

    if (!check1() || !check2()) {
        startFunc()
        sendLog("started")
    }
}

test.js：

"use strict";
var chai = require("chai");
var sinon = require("sinon");
var sinonChai = require("sinon-chai");
var expect = chai.expect;
chai.use(sinonChai);

var scripts = require('./scripts')

describe("scripts", () => {
    describe("check", () => {
        it("should startFunc and send Log if check1 || check2 is false", () => {
            var check1 = sinon.stub(check1);
            check1.yields(false);
            var check2 = sinon.stub(check2);
            check2.yields(true);
            var startFunc = sinon.stub(startFunc);
            var sendLog = sinon.stub(sendLog);
            scripts.check();
            expect(sendLog).to.have.been.calledWith("started")
            expect(startFunc).to.have.been.calledOnce;
        })
    })
})

编辑：

我设法通过使函数可访问来使测试工作。我仍然不确定这是最好的方法

scripts.js中

let check1 = function(){return true}
let check2 = function(){return true}
let startFunc = function(){console.log('checks Passed')}
let sendLog = function(message){console.log(message)}

module.exports.check1 = check1
module.exports.check2 = check2
module.exports.startFunc = startFunc
module.exports.sendLog = sendLog

module.exports.check=function(){

    console.log('check1: ', this.check1())
    console.log('check2: ', this.check2())

    if (!this.check1() || !this.check2()) {
        this.startFunc()
        this.sendLog("started")
    }
}

test.js：

"use strict";
var chai = require("chai");
var sinon = require("sinon");
var sinonChai = require("sinon-chai");
var expect = chai.expect;
chai.use(sinonChai);

var scripts = require('./scripts')

describe("scripts", () => {
    describe("check", () => {
        it("should startFunc and send Log if check1 || check2 is false", () => {
            var check1 = sinon.stub(scripts,'check1',() => {return true});
            var check2 = sinon.stub(scripts,'check2',()=> {return false});
            var startFunc = sinon.stub(scripts,'startFunc');
            var sendLog = sinon.stub(scripts,'sendLog');
            scripts.check();
            expect(sendLog).to.have.been.calledWith("started")
            expect(startFunc).to.have.been.calledOnce;
        })
    })
})

Answer 1

我只是从模块中公开内部函数（就像你在上面的编辑中所做的那样）。但是，我会使用一些特殊符号，例如_check1和_check2，或代码组织，例如module.exports.privateFunctions = { check1: check1, ... };，表示这些内部函数不属于预期的模块接口。

另一种方法，虽然我不确定这是否是一种好的做法，但是通过添加内部函数作为其属性来扩展导出的方法，例如， module.exports.check.check1 = check1;。这样，每个导出的函数都会附加对其内部使用函数的引用，这些函数的行为可以被存根。此外，界面是安全的，即使您在代码的其他部分重新定义check.check1 = function() { return 42; };，这也不会影响check，因为它会调用原始check1。