npm 包 newman-reporter-run 使用教程

阅读时长 5 分钟读完

前言

newman-reporter-run 是一个基于 node.js 平台的 npm 包,它用于 Newman 工具的报告生成与数据提取。作为一名前端工程师,我们每天都需要和接口打交道,因此使用 Newman 进行接口测试是一个很常见的操作。但由于 Newman 本身输出的结果形式较为简单,可读性不够好,因此我们需要使用 newman-reporter-run 来进行对接口测试结果的深度统计和分析。

该包主要功能包括:

  1. 根据数据提取规则,从测试结果中提取指定的数据。
  2. 将测试结果输出为 HTML 网页报告,方便人员查看和分析。

在本文中,我们将学习如何使用 newman-reporter-run 包,从而为我们的接口测试提供更好的可视化支持。

安装

使用前需要先安装 newman-reporter-run:

使用

安装完成后,我们需要通过参数指定 newman 使用的 reporter。在此之前,我们需要先了解一下 newman 的相关使用方法。

假设我们有一个接口测试脚本 test.postman_collection.json,我们可以通过以下命令进行测试:

现在我们需要使用 newman-reporter-run 来代替 newman 的默认报告生成,我们需要加上以下参数:

此时,我们便可以生成一个 HTML 格式的测试报告,方便我们的查阅和分析。

接下来,我们将结合实例代码,详细介绍 newman-reporter-run 包的使用方法。

提取测试结果数据

在实际的测试中,我们可能需要从测试结果中提取数据进行进一步的处理。例如,我们需要根据测试结果中的响应时间进行性能优化的分析,那么我们可以使用 newman-reporter-run 包提供的数据提取功能,将测试结果中的响应时间数据提取出来。

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

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

上述代码中,我们新增了一个 extractData 的属性项,用于对测试结果进行数据提取。具体的参数说明如下:

  • type:指定数据提取的类型,支持 performance、response 等。
  • event:指定要提取的事件类型,例如在 performance 模式下,event 可以指定为 response-time、response-code、response-size 等。
  • data:指定要提取的数据路径,例如在 performance 模式下,data 指定为 timings.duration,表示要提取的是响应时间。
  • fileName:指定提取出来的数据保存的文件名。

在执行完成后,我们便可以在 reports 文件夹下看到生成的 performance.json 文件。

生成 HTML 测试报告

在进行接口测试后,我们需要对测试结果进行分析和评估,这时候就需要使用 newman-reporter-run 包提供的报告生成功能。我们可以将测试结果生成为一个 HTML 格式的测试报告,方便我们进行查看和分析。

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

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

上述代码中,我们新增了一个 export 的属性项,用于指定生成的测试报告输出的路径和文件名。

执行完成后,我们便可以在 reports 文件夹下看到生成的 report.html 文件。

结语

通过本教程,我们学习了如何安装和使用 newman-reporter-run 包,从测试结果中提取数据和生成测试报告。希望读者可以通过本文的学习,深入理解 newman-reporter-run 包的使用方法,并将其应用于实际的接口测试工作中。

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

纠错
反馈