测试未导出的 TypeScript 函数

Question

我使用 Mocha/Chai 来测试 JavaScript 前端代码，现在我们切换到 TypeScript。 我有几个要测试的功能。 但它们不应该是可出口的。 我可以访问此功能并对其进行测试而不添加export吗？

Answer 1

无法访问非导出的模块函数。

module MyModule {
    function privateFunction() {
        alert("privateFunction");
    }
}
MyModule.privateFunction(); // Generates a compiler error

但是，撇开私有​​方法测试的有效性问题不谈，您可以执行以下操作。

将您的函数分组到一个实用程序类中，然后利用可以通过方括号表示法访问私有类成员的事实。

module MyModule {
    export class UtilityClass {
        private privateFunction() {
            alert("privateFunction");
        }   
    }
}
var utility = new MyModule.UtilityClass();
//utility.privateFunction(); Generates a compiler error
utility["privateFunction"](); // Alerts "privateFunction"

Answer 2

虽然无法直接访问非导出函数，但仍然可以通过“半隐藏”方式导出它们。 一种可能的方法是：

// In your library module declare internal functions as non-exported like normal.
function someInternalFunctionA(x: number): number {
  return x;
}

function someInternalFunctionB(x: number): number {
  return x;
}

// At the bottom, offer a public escape hatch for accessing certain functions
// you would like to be available for testing.
export const _private = {
  someInternalFunctionA,
  someInternalFunctionB,
};

在测试方面，您可以执行以下操作：

import { _private } from "./myModule";

test("someInternalFunctionA", () => {
  expect(_private.someInternalFunctionA(42)).toEqual(42);
});

我喜欢这种方法的地方：

• 不需要直接用export标记someInternalFunctionA 。
• _private下的东西不是公共接口的正式组成部分，这应该仍然是非常明显的。

Answer 3

正如您在相关问题中所看到的，在 StackOverflow 上对在类或模块中测试私有函数的问题进行了激烈的辩论 - 以下可能是一种架构解决方案，甚至没有进行这种讨论：

如果这些功能足够重要，可以单独测试，但不应作为模块的一部分访问，是否应该将它们放在自己的模块中？

这将解决您的可访问性问题 - 它们现在是一个模块中的公共函数，您可以轻松地从另一个模块中使用它们，而不是将它们作为该模块的一部分公开。

Answer 4

我发现的最佳解决方案是以不同的名称导出私有函数，因此该名称会提醒您不要在其他任何地方使用此函数。

export const getPriceTEST = getPrice;

function getPrice(): number {
  return 10 + Math.Random() * 50;
}

Answer 5

但它们不应该是可出口的。 我可以访问此功能并对其进行测试而不添加导出吗？

一般来说，没有。 可以访问私有类成员，但不能访问模块的未导出成员。

我会回应@Katana314 的评论——单元测试不应该与非公共方法有关。 尝试这样做表明您正在测试模块的实现细节，而不是模块声称要实现的契约。

Answer 6

这是一个彻头彻尾的黑客，但是嘿......

window.testing = {};

然后在你的模块中：

module.exports = {
    myPublicFunction: myPublicFunction
};

window.testing.myModule = {
    myPublicFunction: myPublicFunction,
    myPrivateFunction: myPrivateFunction
};