【问题标题】:Typescript: Is it possible to stub a declared function for a unit test?打字稿:是否可以为单元测试存根声明的函数?
【发布时间】:2021-05-23 13:52:30
【问题描述】:

对于上下文,我正在编写编译成 javascript 的 typescript,与 rollup 捆绑在一起,然后由框架调用。这个框架在全球范围内为我提供了一个库。这是一个看起来像这样的函数:

    fun({
      prop1: number,
      ...
    });

我不想将此库包含在我的捆绑 JavaScript 中,因为它已经由框架提供。我认为如果我的代码中的库版本与框架的不同,这可能会引入很多奇怪的错误。从理论上讲,我认为只使用框架提供的库会更不容易出错并且更简单。

我进行了一点研究,我认为declare 关键字就是为了这个目的。所以我把它放在我称之为fun的同一个文件中:

export declare function fun(input: unknown): void;

现在我的代码可以编译了,但我还没有找到一种对生产代码进行单元测试的方法。如果我调用调用fun的代码,茉莉花会抱怨该函数不存在:ReferenceError: fun is not defined

我了解为什么会发生此错误,但我不知道如何解决它。我尝试使用 sinon 来存根 fun,但是当我在 Jasmine 中运行测试时,它也有类似的关于 fun 不存在的抱怨。

我想出了一个我讨厌的解决方法:我将对fun 的调用封装在if 语句中,因此测试跳过了对fun 的调用。

我想知道是否有办法存根fun,这样我就可以执行调用它的代码并确认传入的属性是否正确。或者,有没有办法可以写一个假的fun 的版本并将其从转译的 javascript 中排除,因此 stub 可以用于测试,但在生产中不存在?鉴于模块的工作方式,我认为这不是一个选择。但我对各种想法持开放态度,这就是我提出它的原因。

【问题讨论】:

    标签: typescript unit-testing jasmine sinon rollupjs


    【解决方案1】:

    这个解决方案对我有用。如果有更好/更简单的方法,我想知道。

        // in some file (you must have an import/export in it or else it won't compile
        declare global {
          interface Window {
            fun: (input: unknown) => void;
          }
        }
        
        // in the test
          beforeEach(() => {
            sandbox = sinon.createSandbox();
            window.anime = sandbox.stub();
          });
        
          afterEach(() => {
            window.anime = ... // Optional. Put it back the way I found it
          });
        
        // somewhere in a test
           expect((window.fun as SinonStub).callCount).toBeGreaterThan(0);
    

    【讨论】:

      猜你喜欢
      • 2021-03-24
      • 2013-11-19
      • 2016-03-27
      • 1970-01-01
      • 1970-01-01
      • 2019-04-05
      • 1970-01-01
      • 2021-08-24
      • 1970-01-01
      相关资源
      最近更新 更多