使用 Sinon 创建 document.getSelection 的存根

Question

您可以在下面找到我的函数，它使用document.getSelection 来获取屏幕上当前选定的文本。我需要能够指定document.getSelection 的值，以便测试我的功能。

我尝试像这样创建存根：

document.getSelection = sinon.stub(document, "getSelection", function() { return "Hello world!" } );

var selection = wysiwyg.getCurrentRange();

但是，它只是得到undefined 供选择。谁能告诉我我做错了什么？

这是我正在测试的方法：

 Wysiwyg.prototype.getCurrentRange = function() {
    var sel, range;
    if ( window.getSelection ) {
        sel = window.getSelection();
        if ( sel.getRangeAt && sel.rangeCount ) {
            range = sel.getRangeAt( 0 );
        }
    } else if ( document.selection ) {
        range = document.selection.createRange();
    }

    return range;
 };

Answer 1

您的代码中有 4 个错误：

1. 第一个很明显。如果您想为 window.getSelection 你应该把它应用到window.getSelection （不是document.getSelection）。
2. 第二个也很明显。 原来sel 和range 是undefined。你代替 document.getSelection 带有返回字符串的函数 '你好世界！' （见第 4 行）。因此sel 等于 '你好世界！'和sel.getRangeAt 和sel.rangeCount 是undefined。因此，整个表达式 sel.getRangeAt && sel.rangeCount 是 false 和 range 您作为结果返回 仍然是undefined（你得到的确切结果）。
3. 您应该将sinon.stub 的结果分配给 一个新变量（不是被替换的方法）。
4. 始终在测试结束时恢复原始方法。

另请注意，如果方法未定义，则不能将存根应用于方法。

在您的情况下考虑到上述所有内容，没有存根的解决方案会更好。

要测试你可以使用的正分支

var getRangeAtResult = 'getRangeAt Expected Result';
var getRangeAtSpy = sinon.spy(function() {
    return getRangeAtResult;
});

var windowGetSelectionBackUp = window.getSelection;
window.getSelection = function() {
    return {
        getRangeAt: getRangeAtSpy,
        rangeCount: true
    };
};

wysiwyg.getCurrentRange().should.be.equal(getRangeAtResult);

getRangeAtSpy.withArgs(0).called.should.be.equal(true);
window.getSelection = windowGetSelectionBackUp;

如果您确定 document.getSelection 已定义，您可以使用存根

var getRangeAtResult = 'getRangeAt Expected Result';
var getRangeAtSpy = sinon.spy(function() {
    return getRangeAtResult;
});

var documentGetSelectionStub = sinon.stub(document, 'getSelection', function() {
    return {
        getRangeAt: getRangeAtSpy,
        rangeCount: true
    };
});

wysiwyg.getCurrentRange().should.be.equal(getRangeAtResult);

getRangeAtSpy.withArgs(0).called.should.be.equal(true);
documentGetSelectionStub.restore();

要测试你可以使用的负分支

var createRangeResult = 'createRange Expected Result';
var createRangeSpy = sinon.spy(function() {
    return createRangeResult;
});

var documentSelectionBackUp = document.selection;
document.selection = function() {
    return {createRange: createRangeSpy};
};

wysiwyg.getCurrentRange().should.be.equal(createRangeResult);

createRangeSpy.called.should.be.equal(true);
document.selection = documentSelectionBackUp;