在现代的 Web 应用程序开发中,单元测试已经成为了标准的实践之一。单元测试可以帮助我们确保代码的运行效果符合预期,并且能够及时发现和修复代码中的错误。在 Express.js 中,可以使用 Mocha 和 Chai 这两个工具来进行单元测试。
建立测试环境
首先,我们需要建立一个测试环境,这个环境可以在运行测试时使用,并且不会影响到主程序的运行。
使用 Mocha 运行测试的方法非常简单。只需要使用 npm 安装 Mocha:
npm install mocha --save-dev
然后,我们需要在项目的根目录(或者其他合适的位置)建立一个 test 目录,用于存放测试用例。在 test 目录中,我们需要建立一个 index.js 文件,作为测试的入口文件。在这个文件中,我们需要引入 Mocha 并配置测试运行环境。
-- -------------------- ---- ------- ----- ----- - ----------------- ----- ----- - --- ------- --- ------ -------- ------ ------ ----- ----- ------ ----- ---- --- ------------------------------------ ------------------ ---------- - ----------------- ------ ------ --------- ---------- ---------------- - -------- - - - -- ---
这里配置了一些常用的 Mocha 选项。ui 表示测试用例使用的接口,timeout 表示测试用例的最大运行时间,color 表示输出结果是否带有颜色,slow 表示运行时间较长的测试用例的阈值,bail 表示是否在第一个失败的测试用例结束测试。可以根据需要自行修改这些选项。
addFile 方法用于添加测试用例文件,这里添加了一个示例文件,后面会讲到。
最后,使用 run 方法启动测试,输出测试结果并根据测试结果设置退出码。
使用 Chai 进行断言
在编写测试用例的过程中,我们需要对代码的输出结果进行判断。Mocha 本身并不提供断言库,需要使用其他库来实现断言。这里我们选用了 Chai,一个常用的断言库。
将 Chai 安装到项目中:
npm install chai --save-dev
使用 Chai 的方法非常简单。只需要在测试文件中引入 Chai,就可以进行各种类型的判断。这里列举了一些常用的判断方法:
- assert:判断表达式是否为 true;
- expect:判断表达式的值是否符合预期;
- should:类似于 expect,但可以将判断语句写成自然语言的形式。
下面是一个示例:
-- -------------------- ---- ------- ----- ---- - ---------------- ----- ------ - ------------ ---------------- ---------- - ---------- ------ ------ ---------- - -------- - --------------- --- ---
describe 和 it 是 Mocha 中两个最基本的函数,用于定义一个测试用例的名字和行为。在这个示例中,我们测试 1 + 2 是否能够正确地返回 3。
expect 函数用于定义一个表达式,并对它进行断言。to 方法用于将表达式的预期值和实际值进行比较。在这个示例中,我们判断表达式 1 + 2 是否等于 3。
示例代码
下面是一个使用 Express.js、Mocha 和 Chai 进行单元测试的示例。
假设我们有一个简单的 Express.js 应用,代码如下:
-- -------------------- ---- ------- ----- ------- - ------------------- ----- --- - ---------- ------------------------ --------------- ------------- ---- - ----- -- - -------------- --------------- --- -------------- - ----
这个应用包含了一个接口,用于返回一个 JSON 结构。
接下来,我们需要编写一个测试用例,用于测试这个接口是否能够正常运行。
首先,在 test 目录下新建一个文件 test/app.test.js,写入如下代码:
-- -------------------- ---- ------- ----- ------- - --------------------- ----- --- - ------------------ ---------------- ---------- - ---------- ------ ---- ------ -------------- - ------------ ------------ ------------ ------------------ ---- - -- ----- ------ ---------- ----------------------------------- -------- ------- --- --- ---
这里使用了 Supertest 这个库,它可以将 Express.js 应用封装成一个对象,用于进行请求和响应的测试。
在测试用例中,我们使用了 request 方法创建了一个 GET 请求,并断言它的返回值是否符合预期。
使用 Mocha 运行测试:
npm run test
运行结果应该如下:
Test ✓ should return {id: 123} 1 passing (17ms)
这证明我们的测试用例运行通过。
总结
使用 Mocha 和 Chai 进行单元测试非常简单,只需要几行代码就可以完成一个测试用例的编写和运行。单元测试可以帮助我们及时发现和修复代码中的错误,保证代码的质量和稳定性。在实际开发中,建议将单元测试作为标准的实践之一。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6476e638968c7c53b037fc74