如何使用 Jest 模拟测试 Node.js CLI？

Question

我一开始就卡住了，只需要 CLI 并捕获它的输出。我尝试了两种方法，但都不起作用。

这是我的 cli.js：

#!/usr/bin/env node

console.log('Testing...');
process.exit(0);

这是我的 cli.test.js：

test('Attempt 1', () => {
    let stdout = require("test-console").stdout;
    let output = stdout.inspectSync(function() {
        require('./cli.js');
    });
    expect(output).toBe('Testing...');
});

test('Attempt 2', () => {
    console.log = jest.fn();
    require('./cli.js');
    expect(console.log.calls).toBe(['Testing...']);
});

实际上正在运行哪个测试并不重要，输出总是：

$ jest

 RUNS  bin/cli.test.js
Done in 3.10s.

Answer 1

Node.js CLI 应用程序除了对环境的依赖外，与其他应用程序没有什么不同。他们预计会广泛使用process 成员，例如：

• process.stdin
• process.stdout
• process.argv
• process.exit

如果使用了这些东西中的任何一个，则应该对它们进行相应的模拟和测试。

由于直接调用console.log进行输出，所以直接窥探它没有问题，尽管也可以使用像test-console这样的帮助包。

在这种情况下，process.exit(0) 在导入的文件中被调用，因此 spec 文件提前退出，下一个 Done 输出来自父进程。它应该被存根。抛出错误是必要的，以便停止代码执行 - 以模仿正常行为：

test('Attempt 2', () => {
    const spy = jest.spyOn(console, 'log');
    jest.spyOn(process, 'exit').mockImplementationOnce(() => {
      throw new Error('process.exit() was called.')
    });

    expect(() => {
      require('./cli.js');
    }).toThrow('process.exit() was called.');
    expect(spy.mock.calls).toEqual([['Testing...']]);
    expect(process.exit).toHaveBeenCalledWith(0);
});