简介
Chai-feathers 是一个能够让开发者使用 Chai.js 的语法测试 Feathers 服务和 hooks 的库。Feathers 是一个现代的、实时的、基于 Node.js 的 Web 框架,它包括了很多方便易用的插件,可以快速实现 RESTful API 或实时的 Web Socket 服务。而 Chai.js 是一个流行的、功能强大的 JavaScript 测试库,它的语法简洁易懂,非常适合编写测试用例。
本文将详细介绍如何使用 Chai-feathers 来编写测试用例,包括如何测试服务的 CRUD 操作、如何测试 hooks 的行为以及如何模拟用户的登录状态等。
安装
首先,你需要在你的项目中安装 Chai.js 和 Chai-feathers:
npm install chai chai-feathers --save-dev
接着,在测试文件中引入这两个库:
const chai = require('chai');
const feathers = require('@feathersjs/feathers');
const memory = require('feathers-memory');
const chaiFeathers = require('chai-feathers');然后,你需要在 Chai.js 中注册 Chai-feathers 插件:
chai.use(chaiFeathers);
现在,你就可以开始编写测试用例了!
测试服务
首先,我们需要创建一个测试用的 Feathers 服务。这里我们使用内存型数据库插件 feathers-memory 来创建一个 messages 服务:
-- -------------------- ---- -------
----- --- - -----------
-------------------- --------
--------- -
-------- ---
---- --
-
----
----- ------- - ------------------------现在,我们来编写第一个测试用例:
-- -------------------- ---- -------
------------------ --------- -- -- -
------- ------ - --- --------- -- -- -
----- ------- - - ----- ------- ------- --
-- -- ---- --
------ ----------------------------------- -- -
-- -- -------------- ---------- ------- --
------------------------ - --- -- ----- ------- ------- ---
---
---
---可以看到,我们使用了 Chai.js 的 assert 断言库,来判断测试结果是否符合预期。这个测试用例测试了服务的创建操作,首先创建了一个 message 对象,然后使用 service.create 方法将其存入数据中,最后通过 assert 来对比存入数据库后返回的数据是否正确。
除了创建操作,Feathers 服务还包括了更新、删除和查询操作。我们可以通过类似的方式来测试它们:
-- -------------------- ---- -------
-- ----
------- ------ -- -------- --------- -- -- -
----- ------- - - ----- ------- ------- --
------ ------------------------------------------- -- -
-- -- ----- --
------ -------------------------------- - ----- ------- --------------- ---------------------- -- -
-- -- ------------- ---------- ------- --
-------------------------------- - --- ------------------ ----- ------- --------------- ---
-- -- --- --
------ ------------------------------------------- -- -
-- -- ----------- ---------- ------- --
------------------------- - --- ------------------ ----- ------- --------------- ---
---
---
---
---
-- ----
------- ------ -- -------- --------- -- -- -
----- ------- - - ----- ------- ------- --
------ ------------------------------------------- -- -
-- -- ------ --
------ ----------------------------------------- -- -
-- -- --- ---------
------ ------------------------------------------ -- -
--------------------------- --- ------ ----- --- -- --------
---
---
---
---
-- ----
------- ---- -------- ---- ------------ -- -- -
----- -------- - -
- ----- -------- -- --
- ----- -------- -- --
- ----- -------- -- --
- ----- -------- -- --
- ----- -------- -- --
- ----- -------- -- --
- ----- -------- -- --
- ----- -------- -- --
- ----- -------- -- --
- ----- -------- --- -
--
------ -------------------------------- -- --------------------------------- -- -
-- -- --- ----- ------ - ----- --
------ -------------- ------ - ------- -- ------ - - -------------- -- -
-- -- ------------ ------------- ------- --
------------------------ -
----- -
- --- -- ----- -------- -- --
- --- -- ----- -------- -- --
- --- -- ----- -------- -- --
- --- -- ----- -------- -- -
--
------ --
----- --
------ --
---
---
---
---这样,我们就完成了对服务的测试。
测试 hooks
Feathers 还提供了 hooks 系统,用于在数据读写前后进行一些操作,比如校验、权限控制、数据处理等。Chai-feathers 也支持对 hooks 的测试。
先来看一个简单的例子:
-- -------------------- ---- -------
-- ------ --- - -------
-- -- ----
----- ------ - ------- -- -
----------------- - ------- ------------- --------
------ --------
--
-- - ------- -- ----
---------------
------- -
------- --------
-
---
------------------ ------- -- -- -
------- ------ ---- ------ -------- -- -- -
----- ------- - - ----- ------- ------- --
------ ----------------------------------- -- -
------------------------ - --- -- ----- ------- ------------- ------- ---
---
---
---这个测试用例测试的是一个简单的 hook,它会在数据存储前将消息文本修改为 Hello, chai-feathers hooks!。我们在测试用例中创建一个 message 对象,然后使用 service.create 方法将其存入数据库,最后通过 assert 来判断存入数据库后的结果是否和预期一致。
这个 hook 完成的操作非常简单,但是 hooks 还可以完成更加复杂的任务,比如根据用户权限、请求参数等动态生成查询条件,或者使用外部 API 处理数据等。Chai-feathers 能够帮助你编写测试用例,确保 hook 的行为符合预期。
模拟用户登录状态
在 Web 应用中,用户登录状态常常对数据的访问权限产生重要的影响。Feathers 支持用户注册、登录和身份验证等功能,因此在测试时也需要考虑用户登录状态的不同场景。Chai-feathers 提供了模拟用户登录状态的方法。
假设我们的应用需要登录才能访问 /private 路由,否则会返回 401 错误码。我们可以使用以下代码来模拟用户登录:
-- -------------------- ---- -------
----- -------------- - ---------------------------------------------
----- ------- - -------------------------------
--------- -- -
------ ----------------
--------- --------
------ -------------------
--------- ------
---------------- -- -
------ -------------------------------------
------------ ------
-------- -------------------
------------------
--------- ------
------------ --------------------
---
---
---
----------------- -------- --------- -- -- -
----- -------- - -
- ----- -------- --- -------- ---- --
- ----- -------- --- -------- ---- --
- ----- -------- --- -------- ----- -
--
--------- -- -
---------------------------- -
------------ ------- -
-- -------------- -
----- --- ---------- ----------------
-
-- --------------- -
----- --- -------------- -- --- ----------
-
------ ----------------- --- -- ------- ---
-
---
---
------- ------ - --- ------- --------- -- -- -
------ ------------------------------------------------------------------- -- -
------------------------ - --- -- ----- -------- --- -------- ---- ---
---
---
------- --- ------ - --- ------ --------- -- -- -
------ ------------------------------------------------------------------- -- -
--------------------------- -------- -- --- ----------
---
---
------- --- ------ - --- ------- ------- ------- -- -- -
------ ---------------------------------------------------------------------- -- -
--------------------------- ---- ----------------
---
---
---我们使用 @feathersjs/authentication-client 库模拟用户登录,并将登录凭证存储到本地存储中。然后,我们使用 before 钩子,在 /private-messages 路由上注册自定义服务,该服务只允许已登录用户创建 private 数据。
在测试用例中,我们使用 service.service('private-messages').create 方法创建消息,然后通过 assert 验证操作结果是否正确。其中,第三个测试用例模拟了未登录的用户无法访问 /private-messages 路由。
这样,我们就完成了模拟用户登录状态的测试。Chai-feathers 提供了方便、易用的模拟登录方式,可以帮助我们广泛测试用户权限相关的场景。
总结
Chai-feathers 是一个非常实用的测试库,它允许我们使用 Chai.js 的强大语法来编写 Feathers 服务和 hooks 的测试用例。通过灵活使用 Chai-feathers,我们可以编写全面、深入的测试用例,保证我们的代码在各种不同情况下的表现符合预期。
Source: FunTeaLearn,Please indicate the source for reprints https://funteas.com/post/64746d29968c7c53b01ccd2b