npm 包 newman-reporter-run 使用教程

前言

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


猜你喜欢

  • npm 包 hapi-nosql-mongoose 使用教程

    介绍 hapi-nosql-mongoose 是一个基于 Hapi 的 MongoDB 数据库操作插件。它封装了基于 Mongoose 的模型和模式的 CRUD 操作,使之成为一个更加易用的 API ...

    4 年前
  • npm 包 plumier-starter 使用教程

    在现代前端开发中,优秀的框架和工具可以提升我们的工作效率和代码质量。在这篇文章中,我们将介绍一个非常有用的 npm 包 Plumier Starter,并详细讲解它的使用教程。

    4 年前
  • npm包 zap-step 使用教程

    前言 随着前端技术的不断发展,我们开发、维护前端代码的工作越来越复杂。为了更有效地管理我们的代码,npm包越来越被广泛使用。在我们的前端项目中,一些常用的功能也可以通过使用npm包来进行优化。

    4 年前
  • npm 包 react-native-camera-barcode-limit 使用教程

    简介 在移动应用开发中,扫描条形码和二维码是一个比较常见的功能。在 React Native 开发中,我们可以利用第三方库 react-native-camera 实现这个功能。

    4 年前
  • npm包 react-flexa使用教程

    React是一款广泛使用的JavaScript库,它已经发展成为前端开发的事实标准之一。React提供了许多有用的组件和功能,使得创建复杂的用户界面变得更加容易。在React中,布局是非常重要的一部分...

    4 年前
  • npm 包 vue-video-input 使用教程

    简介 vue-video-input 是一个基于 Vue 的视频输入组件,可以方便地集成到你的项目中,从而方便用户录制视频,比如在社交网络中发布视频动态、视频简历等场景。

    4 年前
  • npm 包 smart-redis-cache 使用教程

    前言 在前端开发中,缓存是提高性能和用户体验的重要手段之一。而 Redis 作为一种强大的缓存方案,成为了许多开发者的首选。但是在实际使用中,我们可能需要经常写一些繁琐的 Redis 操作代码,这无疑...

    4 年前
  • 前端技术:npm 包 graphql-flatten-path 使用教程

    简介 graphql-flatten-path 是一个用于处理 GraphQL 查询结果的 npm 包。它可以将查询结果中的嵌套数据展平,使其更容易处理和使用。 本篇文章将介绍如何使用 graphql...

    4 年前
  • npm 包 dns-over-tls 使用教程

    在网络环境中,DNS 系统是相当重要的一部分。但是,在传输 DNS 请求时,可能会存在安全和隐私问题。为了保障这些信息的安全性和隐私性,我们可以使用 DNS over TLS 技术。

    4 年前
  • npm 包 envtojson-cli 使用教程

    前言 在前端开发中,经常需要从环境变量中获取配置信息。envtojson-cli 是一个 npm 包,它可以将环境变量转换为 JSON 格式的对象,便于在 Node.js 应用中使用。

    4 年前
  • npm 包 shun-encode 使用教程

    npm 是一个全球最大的 JavaScript 包管理器,它允许开发者轻松地部署、共享和下载各种 JavaScript 包。shun-encode 就是一个在 npm 上发布的前端编码工具包,它可以帮...

    4 年前
  • npm 包 express-crud-api-swagger 使用教程

    什么是 express-crud-api-swagger express-crud-api-swagger 是一个 npm 包,它可以快速生成使用 Express 框架的 RESTful API,同时...

    4 年前
  • npm 包 @codenstein/tiff-js 使用教程

    介绍 TIFF 是一种常见的图像文件格式,该文件格式通常用于传输和存储数字图像,尤其是在印刷、出版和摄影领域中。 @codenstein/tiff-js 是一个可以解码和编码 TIFF 文件格式的 J...

    4 年前
  • npm 包 github-contributor 使用教程

    在许多开源项目中,会有一个贡献者列表,用于展示每个参与者的贡献度和头像,从而展示这个项目的活跃度和社区合作精神。这样一个列表通常需要手动维护,而 github-contributor 包就是为了方便在...

    4 年前
  • NPM 包 nodenodenode 使用教程

    一、什么是 nodenodenode? nodenodenode 是一个 Node.js 的 package manager,它允许你在前端项目中轻松管理依赖包,同时也支持版本控制和依赖解决冲突等功能...

    4 年前
  • npm 包 @codenstein/twain-js 使用教程

    简介 在前端开发中,有时需要使用到一些第三方库,为了方便管理这些库,可以使用 npm 来安装这些库。其中 @codenstein/twain-js 是一个强大、灵活和易用的 JavaScript 工具...

    4 年前
  • npm 包 censorify_manik 使用教程

    随着互联网的快速发展,人们开始越来越在意网络内容的质量。为了确保用户能够获得更好的上网体验,之前开始出现了各种网络过滤服务。其中一个比较流行的工具是 censorify_manik,它是一个用于屏蔽不...

    4 年前
  • npm 包 less-plugin-inline-svg 使用教程

    在前端开发中,我们经常会使用到 SVG 图片。而在使用 Less 预处理器时,有时候需要将 SVG 图片嵌入到 CSS 文件中。这时候我们可以使用 npm 包 less-plugin-inline-s...

    4 年前
  • npm 包 righteous-js 使用教程

    简介 Righteous-js 是一个开源的 JavaScript 库,它提供了一套简单易用的 API,帮助前端开发者轻松实现数据验证功能。在开发过程中,我们经常需要验证用户输入的数据,以保证数据的准...

    4 年前
  • npm 包 twain-js 使用教程

    简介 twain-js 是一个开源的 npm 包,可以用于在前端 web 应用中采集照片或者扫描文档。它基于 Web TWAIN 技术,提供了一些简单易用的 API,可以直接在浏览器中完成图像采集。

    4 年前

相关推荐

    暂无文章