npm 包 @pollyjs/node-server 使用教程

阅读时长 4 分钟读完

在现代 web 开发环境中,不可避免地需要进行接口测试和模拟。但是,传统的手动编写和维护接口测试和模拟代码的方式,已经无法满足快速迭代的需求。因此,我们需要使用 npm 包 @pollyjs/node-server 来简化这个过程。

Pollyjs 是什么?

Pollyjs 是一个友好的、现代化的数据录制和重放工具。它的目标是在开发过程中提供一个简单的工具集,以便于测试和模拟服务间的调用。Pollyjs 可以帮助我们创建测试以确保我们的代码在实际接口情况下能够正常运行。

安装 @pollyjs/node-server

安装 @pollyjs/node-server 时,需要先安装 npm 包管理器。安装 npm 的方法见官方安装文档

在安装了 npm 后,可以通过以下方式安装 @pollyjs/node-server:

使用 @pollyjs/node-server

使用 @pollyjs/node-server 很简单,只需要在目标文件夹中初始化 Pollyjs 项目并启动即可。

首先进入你想要记录或者回放 HTTP 流量的项目目录中。然后执行以下命令:

init 命令会为你的项目安装所需的 npm 包,并且会新建一个名为 polly.js 的配置文件。

随后使用以下命令启动 Node.js 服务器:

当访问该服务器地址时,Pollyjs 将自动地将所有传出的 HTTP 请求记录到磁盘上,并将其保存为 har 文件。在运行 Ployjs 的过程中,你可以随时按下 ctrl+c 以停止服务器运行。

添加测试

Pollyjs 不仅可以用来记录和回放服务请求,还可以用来方便地对服务进行调试和测试。下面我们将演示如何使用 Pollyjs 的测试功能。

我们先创建一个简单的测试文件 test.js,加载 Pollyjs 并通过它发送 HTTP 请求。代码如下:

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

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

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

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

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

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

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

在上面代码中,我们将 Pollyjs 的 NodeHttpAdapter 和 FetchAdapter 注册到了 Pollyjs 中。这样就可以使用这两个适配器来发送和接收 HTTP 请求。

在 mocha 的测试环境中,我们通过 setupMocha 方法指定 Pollyjs 使用 NodeHttpAdapter。这些参数将被传递给 Pollyjs 构造函数。

在测试中,我们使用 new Polly() 构造函数创建一个新的 Pollyjs 存储库。然后使用 Pollyjs 所提供的 HTTP 请求器 server 向服务器发送 HTTP GET 请求。最后,在断言中验证请求是否得到正确的响应。

总结

@pollyjs/node-server 是一个用于记录 HTTP 流量的现代化工具。它支持记录服务间的 HTTP 请求和回放、自动化测试和持续交付集成。在进行 web 开发时,为了保证代码质量和开发效率,Pollyjs 是一个很好的工具。在使用时,也需要注意一些细节和坑点。

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