使用 newman-reporter-execution-lite 自定义你的测试结果报告

阅读时长 6 分钟读完

引言

在进行测试时,测试结果的输出是非常必要的,而在 API 测试中,我们可以使用 newman 来进行一系列的测试。 newman 的功能非常强大,但是通过控制台输出展示的测试结果却很难看懂,因此 postman 开源了一个新的 npm 包 newman-reporter-execution-lite,它可以帮助你将测试结果以更加优美的方式展示出来。

安装

首先,你需要安装 newman 和 newman-reporter-execution-lite,你可以使用 npm 进行安装,如下所示:

使用

安装完成后,你需要在 newman 的运行命令中使用这个 reporter。假设我们有个 test_collection.json 文件包含 API 测试集合,我们可以执行以下命令来运行测试并生成漂亮的测试报告:

通过 -r 参数,指定了 newman 的报告类型。现在,newman 将会根据新的 report 来创建生成的报告,而不是普通的控制台输出。

高级用法

newman-reporter-execution-lite 提供了一些参数,可以让你自定义报告,以下是一些常用的参数:

  • --reporter-execution-lite-target: 指定报告输出的目录路径。

  • --reporter-execution-lite-template: 指定报告输出使用的模板文件路径。

  • --reporter-execution-lite-css: 指定报告输出使用的样式文件路径。

  • --reporter-execution-lite-height: 指定报告的高度,以像素为单位。

  • --reporter-execution-lite-mn-highlight-text-color: 指定高亮文本的颜色。

  • --reporter-execution-lite-mn-pass-text-color: 指定通过文本的颜色。

  • --reporter-execution-lite-mn-fail-text-color: 指定失败文本的颜色。

更多参数请参考官方文档:https://github.com/postmanlabs/newman-reporter-execution-lite#advanced-usage

示例代码

假设我们有一个 API 测试集合文件 test_collection.json,如下所示:

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

我们可以使用 newman-runner 来运行这个 collection 并生成报告,如下所示:

这里我们使用了 --reporter-execution-lite-target 参数来指定报告的输出目录为 report,然后 newman 就会将生成的报告保存在这个目录下。

结语

在 API 测试过程中,newman 是一个非常优秀的工具,它具有大量的扩展插件来优化测试结果展示,在这些插件中,newman-reporter-execution-lite 是最受欢迎的报告插件之一。希望这篇文章可以帮助到那些即将使用 newman 或者考虑使用 newman 的同学,同时,newman-reporter-execution-lite 也是一个开源的库,你们可以在源代码中深入了解这个插件的内部工作原理。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6006735b890c4f7277583f1b

纠错
反馈