npm 包 @pact-foundation/pact-standalone-linux-x64 使用教程

简介

pact 是一个用于前后端契约测试（consumer-driven contract testing）的工具。在构建 Web 应用时，前后端通常会通过 API 交互数据。在这种情况下，前端和后端需要达成共识，即 API 的数据格式、请求参数和返回结果等方面的约定。而 pact 则提供了一种基于契约的 API 测试方法，帮助前端和后端开发者达成 API 交互方面的共识，从而保证系统的可靠性和稳定性。

@pact-foundation/pact-standalone-linux-x64 是 pact 的一个 npm 包，它是 pact 的一个完全独立的二进制文件，可以在一个单独的进程中运行 Pact Mock Service 和 Pact Broker。

本篇文章将详细介绍如何使用 @pact-foundation/pact-standalone-linux-x64 这个 npm 包。

安装

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

安装成功后，通过命令 node_modules/.bin/pact-standalone help 可以查看 pact-standalone 的使用帮助。pact-standalone 的使用可以分为三个阶段：准备 Mock Server、运行测试和推送 Contracts 到 Pact Broker。

准备 Mock Server

Mock Server 是一个虚拟的服务，前端开发者可以通过在测试中访问 Mock Server 来模拟后端 API 的返回结果。

首先需要在测试代码中创建一个 pact 实例，然后在 beforeEach 阶段启动 Mock Server：

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

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

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

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

在 provider.setup() 中，会启动一个 Mock Server。注意，consumer 和 provider 的名字在测试中需要一致。在 provider.verify() 中，会检查测试中发出的请求是否与 Mock Server 的契约一致。

运行测试

在测试中，需要发出 API 请求，并验证 Mock Server 的返回结果是否符合预期。在测试代码中，可以使用 pact.MockService.create() 来创建一个 Mock Service：

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

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

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

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

在 mockProvider.given() 中，指定了 Mock Server 的初始状态。在 mockProvider.uponReceiving() 中，指定了 HTTP 请求的信息。在 mockProvider.willRespondWith() 中，指定了 Mock Server 对这个请求的响应。在测试代码中发出 HTTP 请求，并验证返回结果是否符合预期。

推送 Contracts 到 Pact Broker

Contracts 是 Pact 契约的文档形式，保存在 Pact 中。Pact Broker 是一个可视化的工具，它可以将 Contracts 的版本控制和发布变得更加简单明了。

在 CI/CD 环境中，可以使用 pact.publish() 将 Contracts 推送到 Pact Broker：

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

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

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

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

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

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

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

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

在 provider.addInteraction() 中，将 Mock Server 和 Pact 进行交互。在 provider.finalize() 中，将 Mock Server 关闭。在 pact.publish() 中，将保存的 Pact 文件推送到 Pact Broker。

总结

本篇文章介绍了如何使用 @pact-foundation/pact-standalone-linux-x64 这个 npm 包来进行 API 测试。在测试中，首先需要准备 Mock Server，然后运行测试，最后将 Contracts 推送到 Pact Broker，以便管理和版本控制。Pact 是一种基于契约的 API 测试方法，可以帮助前后端开发者达成 API 交互方面的共识，从而保证系统的可靠性和稳定性。

来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/60057c2081e8991b448ebb69

阅读全文

猜你喜欢

  • npm 包 mod12222 使用教程

    在前端开发过程中，我们常常需要使用各种 npm 包来构建我们的项目。其中，npm 包 mod12222 是一个非常有用的工具类库，可以帮助我们快速完成一些常见的开发任务。

    3 年前
  • npm 包 mm-serializer-msgpack 使用教程

    在前端开发中，我们常常需要处理复杂的数据结构，而 JSON 作为一种广泛使用的数据交换格式，在很多场合下无法很好地满足我们的需求，比如说本地存储需求时的空间占用问题、数据传输时的带宽问题等等。

    3 年前
  • npm包fw-sockjs-client使用教程

    前言 在前端开发过程中，我们经常需要使用 WebSocket 与服务器进行数据交互。fw-sockjs-client 是一个易于使用和简洁的 SockJS 客户端，提供了 WebSocket 和长轮询...

    3 年前
  • npm包xng-op-logger使用教程

    简介 在前端开发中，我们常常需要进行日志记录。本文将介绍npm包xng-op-logger，它是一个为Angular应用开发者提供的一款简单、易用的日志记录工具。 安装 在Angular项目中安装xn...

    3 年前
  • npm 包 @ben-x9/react-toolkit 使用教程

    简介 @ben-x9/react-toolkit 是一个前端开发工具包，提供了在 React 项目中常用的一些组件、函数和样式，用于提高开发效率和统一项目 UI 风格。

    3 年前
  • NPM 包 modularscale-ratios 使用教程

    如果你是前端开发人员，你一定知道在设计响应式网站和应用程序的过程中，一些常见的问题是调整字体大小和每个元素之间的比例。好在有一些好用的 NPM 包可以帮助我们处理这些问题，比如 modularscal...

    3 年前
  • npm包react-on-off-state使用教程

    前言 在现代web应用程序中，经常需要使用开关和状态。这种状态很可能是当前选中的选项，一个开关的状态，或者一个按钮的状态。React是一个非常好用的JavaScript库，它为状态管理和组件化方案提供...

    3 年前
  • npm 包 vue-cuba-app 使用教程

    在前端开发中，为了提高开发效率和代码可复用性，我们经常使用不同的工具和库。而 npm 是目前最受欢迎的包管理器之一，提供了大量的开源库和工具，包括 Vue.js，React等前端框架。

    3 年前
  • npm 包 cordova-plugin-xyprogress 使用教程

    概述 cordova-plugin-xyprogress 是一个基于 Cordova 框架的插件，用于在移动端应用上展示进度条。使用这个插件可以让你的应用变得更加直观且用户友好。

    3 年前
  • npm 包 wm-rocketmq 使用教程

    在前端开发中，消息队列是非常重要的一部分。RocketMQ 是一个开源的分布式消息传递系统，具有高吞吐量、低延迟、高可用性、强容错能力等特点。本文将介绍一个基于 RocketMQ 的 npm 包 wm...

    3 年前
  • npm 包 tree-steps 使用教程

    前言 tree-steps 是一款 Node.js 的 npm 包，用于帮助前端开发者快速生成可折叠的树形菜单。这个包的使用非常简单，但对于一些刚刚接触前端的小白来说，可能还需要一些指导。

    3 年前
  • npm包 redux-naive-timer 使用教程

    在前端开发中，我们常会涉及到一些时间相关的操作，例如定时器模块、计时模块等等，而redux-naive-timer就是一个基于Redux框架的定时器模块，可以有效地帮助我们实现相关的功能。

    3 年前
  • npm 包 treetracker-api 使用教程

    前言 treetracker-api 是一款基于 Node.js 开发的 npm 包，它能够将一张树木图片转化为 JSON 格式的数据。这样，我们就可以通过程序化的方式来分析并学习树木的特征、成长过程...

    3 年前
  • NPM 包 React-Rainbow 使用教程

    React-Rainbow 是一个基于 React 和 Salesforce Lightning Design System 的 UI 组件库，它提供了丰富的组件类型和样式，方便你快速构建漂亮而现代的...

    3 年前
  • npm 包 muptest 使用教程

    什么是 muptest ？ muptest 是一个适用于前端开发的 npm 包，它可以通过多维度的方式进行性能测试，可以检测前端项目的性能，方便开发者在实际应用中寻找性能瓶颈并进行优化。

    3 年前
  • npm 包 node-notifier-icon 使用教程

    概述 在前端开发中，我们常常需要发送一些通知来提醒用户。而 Node.js 中的 node-notifier 是一个非常好用的通知库，可以用来在桌面系统中弹出通知窗口，但是这个库在默认情况下并不支持添...

    3 年前
  • npm 包 cex-crawler 使用教程

    前言 在前端开发中，我们经常需要收集数据并进行数据分析。这时候，爬虫就应运而生了。爬虫可以帮助我们收集大量数据，并且可以自动化数据分析过程。在这篇文章中，我们将介绍一个非常好用的 npm 包 cex-...

    3 年前
  • npm包 krimzen-ninja-express-error-handling 使用教程

    在前端开发中，错误处理是一个非常重要的环节。如果不对错误进行有效的捕获和处理，就会给用户带来不好的体验。npm包krimzen-ninja-express-error-handling是一个能够帮助我...

    3 年前
  • npm 包 ranvier-auto-login 使用教程

    随着互联网的发展，前端技术的重要性也越来越被人们所重视。而 npm 包作为一个重要的前端工具，让前端开发更加快捷和高效。本篇文章将会详细介绍 ranvier-auto-login 这个 npm 包的使...

    3 年前
  • npm 包 vue-fa5-svg 使用教程

    vue-fa5-svg 是一个基于 Vue.js 的 FontAwesome 5 图标库组件。这个组件可以帮助开发者轻松地在前端项目中使用 FontAwesome 5 的 SVG 图标而无需引入官方的...

    3 年前

相关推荐

    暂无文章