npm 包 cli-tester 使用教程-JavaScript中文网-JavaScript教程资源分享门户

简介

cli-tester 是一个用于测试命令行接口（CLI）的 npm 包。这个包提供了一套简单易用的 API，可以方便地模拟用户输入和断言 CLI 的输出。

安装

使用 npm 进行安装：

npm install cli-tester --save-dev

使用方法

基本用法

在测试文件中引入 cli-tester：

const { CliTester } = require('cli-tester');

然后创建一个 CliTester 实例，并传入要测试的命令：

const tester = new CliTester('my-cli-command');

最后，使用 tester.exec() 方法执行命令，并传入一个参数数组：

const result = await tester.exec(['arg1', 'arg2']);

result 变量是一个对象，包含了 CLI 的输出和错误信息：

{
  code: 0, // 命令的退出码
  stdout: 'Hello, world!', // 标准输出
  stderr: '' // 错误输出
}

模拟用户输入

有些 CLI 需要用户输入才能继续执行。对于这种情况，我们可以使用 tester.feed() 方法来模拟用户输入：

const result = await tester
  .feed('input-1\n')
  .feed('input-2\n')
  .exec(['arg1', 'arg2']);

这里我们连续调用了两次 tester.feed() 方法，分别传入了两个用户输入。每次调用 feed() 方法时需要传入一个以 \n 结尾的字符串。

断言输出

对于 CLI 的输出，我们可以使用 chai 库提供的 API 进行断言。首先，在测试文件中引入 chai：

const { expect } = require('chai');

然后将 result.stdout 和 result.stderr 作为参数传给 expect() 函数进行断言：

expect(result.stdout).to.equal('Hello, world!');
expect(result.stderr).to.equal('');

这里我们断言了标准输出是否等于 'Hello, world!'，错误输出是否为空字符串。

示例代码

下面是一个完整的例子，演示了如何使用 cli-tester 测试一个简单的 CLI：

-- -------------------- ---- -------
----- - ------ - - ----------------
----- - --------- - - ----------------------

-------------------------- -- -- -
  ---------- ----- ------- ----- -- -- -
    ----- ------ - --- ----------------------------
    ----- ------ - ----- ----------------
    --------------------------------
    -------------------------------------- -----------
    -----------------------------------
  ---

  ---------- --- ------ ----- -- -- -
    ----- ------ - --- ----------------------------
    ----- ------ - ----- ------
      ----------------
      ----------

    --------------------------------
    -------------------------------------- -----------
    -----------------------------------
  ---
---

总结

cli-tester 是一个非常实用的 npm 包，可以帮助我们快速编写 CLI 的单元测试。在使用过程中，我们需要注意模拟用户输入和断言输出的细节。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/49625