npm 包 gitbook-plugin-rqqtest 使用教程

本文主要介绍如何使用 npm 包 gitbook-plugin-rqqtest。该包是一个 GitBook 插件，用于在 GitBook 中展示自动化测试报告的结果。对于前端自动化测试人员而言，这是一个非常实用的工具。

什么是 gitbook-plugin-rqqtest

gitbook-plugin-rqqtest 是一个基于 Node.js 开发的 GitBook 插件，用于自动集成测试报告到 GitBook 中。它能够轻松地将测试结果展示在 GitBook 中，方便开发人员查看测试结果，评估项目的安全和稳定性。

这个插件使用了最流行的前端自动化测试框架之一——Mocha。它支持任何 Mocha 测试报告格式，并且能够根据需要进行配置。

如何使用 gitbook-plugin-rqqtest

安装

使用 npm 安装该插件：

npm install gitbook-plugin-rqqtest --save-dev

配置

在 GitBook 的 book.json 文件中，添加以下配置：

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

参数说明：

• reportFile：测试报告文件的路径；
• title（可选）：测试报告的标题，默认为 Test Report；
• description（可选）：测试报告的描述信息；
• showPassed（可选）：是否显示通过的测试用例，默认为 true。

运行

在运行 GitBook 之前，需要先运行 Mocha 测试任务并生成测试报告：

mocha --reporter mochawesome --reporter-options reportDir=./test/report

通过上述命令，在 ./test/report 目录中生成测试报告文件 mochawesome-report.json。

最后，使用 GitBook 构建并启动静态网站：

gitbook install && gitbook serve

现在，就可以在 GitBook 中查看测试报告了！

示例代码：使用 gitbook-plugin-rqqtest 展示 Mocha 测试报告

准备工作

1. 安装 Node.js；
2. 安装 GitBook，执行以下命令：

npm install -g gitbook-cli

创建 GitBook 项目

执行以下命令：

gitbook init my-project
cd my-project/

安装 gitbook-plugin-rqqtest

执行以下命令：

npm install gitbook-plugin-rqqtest --save-dev

配置 GitBook

在 book.json 文件中添加以下内容：

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

编写 Mocha 测试代码

在 test/index.js 文件中编写以下示例测试代码：

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

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

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

运行 Mocha 测试任务并生成测试报告

执行以下命令：

mocha test/*.js --reporter mochawesome --reporter-options reportDir=./test/report

开始 GitBook

执行以下命令：

gitbook serve

其他命令

• gitbook build
• gitbook pdf
• gitbook epub
• gitbook mobi

总结

通过使用 gitbook-plugin-rqqtest 插件，可以将自动化测试报告集成到 GitBook 中，达到更加灵活和时效的展示效果。而这种可视化的自动化测试方式，对项目的稳定性评测和应用会更加有帮助。

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