NodeJs如何做API接口单元测试? --【elpis全栈项目】

NodeJs API接口单元测试

api单元测试需要用到的

  • assert:断言库 (还要一些断言库比如:Chai)
  • supertest: 模拟http请求

简单的例子:

const express = require('express');
const supertest = require('supertest');
const assert = require('assert');// 创建一个 Express 应用
const app = express();
app.get('/api/user', (req, res) => {res.status(200).json({ name: 'John Doe' });
});// 测试用例
describe('GET /api/user', () => {it('应该返回用户信息', async () => {const request = supertest(app)const res = await request().get('/api/user') // 发送 GET 请求.set('Accept', 'application/json') // 设置请求头.expect('Content-Type', /json/) // 验证响应头.expect(200); // 验证状态码// 验证响应体assert.strictEqual(res.body.name, 'John Doe');});
});

一、 断言


  1. Node.js 有内置的断言模块assert,用于在代码中验证某些条件是否为真。如果条件不满足,assert 会抛出一个 AssertionError,导致测试失败。

    简单介绍一些NodeJs内置的断言assert的一些属性方法:
    1. assert.ok(value[, message]) 可以直接简写为assert() 验证value 是否为真
      • assert.ok(1); // 通过
      • assert.ok(0, '值不能为 0'); // 抛出 AssertionError,错误信息为 “值不能为 0”
    2. assert.strictEqual(actual, expected[, message]) 验证是否 严格相等(===)
      • assert.strictEqual(1, 1); // 通过
    3. assert.notStrictEqual(actual, expected[, message]) 验证是否 不严格相等(!==)
    4. assert.deepStrictEqual(actual, expected[, message]) 验证是否 深度严格相等(适用于对象或数组)
      • assert.deepStrictEqual({ a: 1 }, { a: '1' }); // 抛出 AssertionError,因为类型不同
    5. assert.notDeepStrictEqual(actual, expected[, message]) 验证是否 深度不严格相等(上面的例子不会抛错)
    6. assert.equal(actual, expected[, message]) 验证是否 相等(==,非严格相等)
    7. assert.notEqual(actual, expected[, message]) 验证是否不相等(!=,非严格相等)
    8. assert.throws(block[, error][, message]) 验证 block 函数是否会 抛出错误
     assert.throws(() => {throw new Error('错误信息');},Error, // 验证错误类型'未抛出预期错误' // 自定义错误信息
    );
    
    1. assert.doesNotThrow(block[, error][, message]) 验证 block 函数是否 不会抛出错误
    2. assert.fail([message]) 强制抛出一个 AssertionError,标记测试失败assert.fail('测试失败')
    3. 总之: assert 是 Node.js 内置的断言模块,适合简单的测试场景。如果需要更丰富的功能和更友好的语法,可以考虑使用 chai 等第三方断言库。
  2. 还有一些第三方库,比如chai,它支持多种风格的断言。Chai是一个可以在node和浏览器环境运行的 BDD/TDD 断言库,可以和任何JavaScript测试框架结合。

按使用风格:

  • assert 风格:类似于 Node.js 内置的 assert,但功能更强大。
  • expect 风格:链式语法,可读性更高。
  • should 风格:基于原型链的语法,适合 BDD(行为驱动开发)。
// assert 风格
assert(res.body.success === true)// expect 风格
expect(1 + 1).to.equal(2);
expect({ a: 1 }).to.deep.equal({ a: 1 });// should 风格
chai.should();
(1 + 1).should.equal(2);

按测试风格:

  • BDD(Behavior Driven Development行为驱动开发):是一种敏捷软件开发的技术,它鼓励软件项目中的开发者、QA和非技术人员或商业参与者之间的协作(做正确的事)

  • TDD(Test-Driven Development测试驱动开发): 测试先于编写代码的思想用于指导软件开发(正确的做事)

    expect和should是BDD风格的。两者使用相同的语言链

    • expect使用构造函数来创建断言对象实例
    • should使用Object.prototype提供一个getter方法来实现,不兼容IE

    assert属于TDD

    • 除语法糖外,assert和node.js的非常相似,assert是三种断言风格唯一不支持链式调用的

chai详细介绍:学习Chai断言库

二、 supertest, 用于测试 HTTP 服务的库


supertest 是一个用于测试 HTTP 服务的 Node.js 库,特别适合测试 Express 或其他基于 Node.js 的 Web 服务器。它提供了简洁的 API 来构造和发送 HTTP 请求,并验证响应结果。supertest 通常与测试框架(如 Mocha、Jest 等)结合使用,用于编写端到端(E2E)测试或集成测试。

...
// 测试用例
describe('GET /api/user', () => {it('应该返回用户信息', async () => {const request = supertest(app)const res = await request().get('/api/user') // 发送 GET 请求.set('Accept', 'application/json') // 设置请求头.expect('Content-Type', /json/) // expect属于supertest内置断言,验证响应头.expect(200); // supertest内置断言,验证状态码});
});
...

下面列举一些supertest属性方法:

  1. 构造请求
    • .get(url):发送 GET 请求。
    • .post(url):发送 POST 请求。
    • .put(url):发送 PUT 请求。
    • .delete(url):发送 DELETE 请求。
    • .patch(url):发送 PATCH 请求。
    • .head(url):发送 HEAD 请求。
  2. 设置请求头, .set(field, value) 例如:
    • .set('Authorization', 'Bearer token') // 设置 Authorization 头
    • .set('Accept', 'application/json'); // 设置 Accept 头
  3. 发送请求体,使用.send(data)方法可以发送请求体,适用于 POST、PUT 等请求。
    • .send({ name: 'John', age: 30 })
  4. 设置查询参数, 使用.query(params)方法可以设置查询参数。
    • .query({ page: 1, limit: 10 }); // 设置查询参数 ?page=1&limit=10
  5. 设置请求类型, 使用.type(type)方法可以设置请求的 Content-Type
    • .type('json') // 设置 Content-Type 为 application/json
    • .type('form') // 设置 Content-Type 为 application/x-www-form-urlencoded
    • .type('text') // 设置 Content-Type 为 text/plain
  6. 文件上传, 使用 .attach(field, file) 方法可以上传文件。
    • .attach('file', 'path/to/file.txt'); // 上传文件
  7. 验证响应, 内置了.expect(...)方法,与第三方断言库库chai的expect作用类似,只是supertest的内置方法更专注于 HTTP 响应的验证, 而 chai 的 expect 是一个通用的断言库,适用于更广泛的场景。
    • .expect(status):验证状态码。
    • .expect(header, value):验证响应头。
    • .expect(body):验证响应体。
    • .expect(function(res) { ... }):自定义验证逻辑。
  8. 处理响应,使用 .end(callback) 方法可以处理响应结果。
    • .get('/api/data').end((err, res) => { if (err) throw err; ...})
  9. 超时设置, 使用.timeout(ms)方法可以设置请求的超时时间。
  10. 重定向, 使用 .redirects(n) 方法可以设置最大重定向次数。
    • .redirects(2) // 最多允许 2 次重定向
  11. Cookie, 使用 .set('Cookie', cookie) 方法可以设置请求的 Cookie。
  12. 自定义 Agent, 使用 .agent() 方法可以创建一个自定义的 superagent 实例,用于保持会话
const agent = request.agent(app);agent.post('/api/login').send({ username: 'john', password: '123456' }).end((err, res) => {if (err) throw err;agent.get('/api/data').end((err, res) => {if (err) throw err;console.log(res.body);});});
  1. 响应对象属性, 在 .end().expect() 的回调函数中,可以访问响应对象的属性。
 .end((err, res) => {if (err) throw err;console.log(res.status); // 状态码console.log(res.headers['content-type']); // 响应头console.log(res.body); // 响应体console.log( res.text); // 原始响应文本。});

三、完整配置


我在项目中的配置:(也不全,简单参考一下)

const assert = require('assert');
const supertest = require('supertest');
const md5 = require('md5');
const elpisCore = require('../../elpis-core')const signKey = '620b048b-8ac3-431b-845d-bcaf63ecc738'
const st = Date.now();describe('测试 project 相关接口', function () {this.timeout(60000);let request;it('启动服务', async () => {const app = await elpisCore.start();request = supertest(app.listen());});it('GET /api/project/model_list', async () => {let tmpRequest = request.get('/api/project/model_list');tmpRequest = tmpRequest.set('s_t', st);tmpRequest = tmpRequest.set('s_sign', md5(`${signKey}_${st}`))const res = await tmpRequest;assert(res.body.success === true)const resData = res.body.data;assert(resData.length > 0);for (let i = 0; i < resData.length; i++) {const item = resData[i];assert(item.model);assert(item.model.key);assert(item.model.name);assert(item.project);for (const projKey in item.project) {assert(item.project[projKey].key);assert(item.project[projKey].name);}}});})

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/diannao/68014.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

计算机视觉算法实战——无人机检测

✨个人主页欢迎您的访问 ✨期待您的三连 ✨ ✨个人主页欢迎您的访问 ✨期待您的三连 ✨ ✨个人主页欢迎您的访问 ✨期待您的三连✨ ​ ​ 1. 引言✨✨ 随着无人机技术的快速发展&#xff0c;无人机在农业、物流、监控等领域的应用越来越广泛。然而&#xff0c;无人机的滥用也带…

Node.js HTTP模块详解:创建服务器、响应请求与客户端请求

Node.js HTTP模块详解&#xff1a;创建服务器、响应请求与客户端请求 Node.js 的 http 模块是 Node.js 核心模块之一&#xff0c;它允许你创建 HTTP 服务器和客户端。以下是一些关键知识点和代码示例&#xff1a; 1. 创建 HTTP 服务器 使用 http.createServer() 方法可以创建…

华为支付接入规范

为了确保用户获得良好的支付体验&#xff0c;Payment Kit制定了相关接入设计规范&#xff0c;请开发者遵照执行&#xff0c;具体要求&#xff08;非强制性&#xff09;如下&#xff1a; 一、支付方式呈现 涉及支付公司名称&#xff0c;请统一使用&#xff1a;花瓣支付&#xff…

C语言-----扫雷游戏

扫雷游戏的功能说明 &#xff1a; • 使⽤控制台实现经典的扫雷游戏 • 游戏可以通过菜单实现继续玩或者退出游戏 • 扫雷的棋盘是9*9的格⼦ • 默认随机布置10个雷 • 可以排查雷&#xff1a; ◦ 如果位置不是雷&#xff0c;就显⽰周围有⼏个雷 ◦ 如果位置是雷&#xff0c;就…

Python人脸识别库DeepFace使用教程及源码解析

目录 一、DeepFace介绍 1、人脸库设计 2、DeepFace.find 3、DeepFace.verify 4、DeepFace.analyze 5、DeepFace.extract_faces 6、DeepFace.represent 7、DeepFace.stream 二、DeepFace二次开发 1、开发活体检测API 2、模型权重持久化 三、总结 一、DeepFace介绍 …

Java多线程的面试面试题及答案解析

什么是进程&#xff1f;什么是线程&#xff1f;有什么区别&#xff1f; 进程是系统资源分配的基本单位&#xff0c;拥有独立的地址空间。线程是 CPU 调度和分派的基本单位&#xff0c;是比进程更小的独立执行的单位&#xff0c;共享所在进程的内存空间等资源。一个进程可以包含…

三分钟简单了解一些HTML的标签和语法_02

1.a标签演示 点击然后跳转 代码加入title 2.图片链接 3.锚点链接 点击就会跳转的当前位置 4.a标签小知识补充 该实例会跳转到顶,锚点链接则会跳转到相应的锚点 5. 结果:直接跳转到该页面的锚点处 6. 在 HTML 中&#xff0c;<tr>标签表示表格中的行&#xff08;TableRow&…

多选multiple下拉框el-select回显问题(只显示后端返回id)

首先保证v-model的值对应options数据源里面的id <el-form-item prop"subclass" label"分类" ><el-select v-model"formData.subclass" multiple placeholder"请选择" clearable :disabled"!!formData.id"><e…

2025年数学建模美赛:A题分析(1)Testing Time: The Constant Wear On Stairs

2025年数学建模美赛 A题分析&#xff08;1&#xff09;Testing Time: The Constant Wear On Stairs 2025年数学建模美赛 A题分析&#xff08;2&#xff09;楼梯磨损分析模型 2025年数学建模美赛 A题分析&#xff08;3&#xff09;楼梯使用方向偏好模型 2025年数学建模美赛 A题分…

Qt——引用第三方SDK lib库的使用方法

【系列专栏】:博主结合工作实践输出的,解决实际问题的专栏,朋友们看过来! 《项目案例分享》 《极客DIY开源分享》 《嵌入式通用开发实战》 《C++语言开发基础总结》 《从0到1学习嵌入式Linux开发》 《QT开发实战》 《Android开发实战》 《实用硬件方案设计》 《结构建模设…

Java 反射与动态代理:实践中的应用与陷阱

Java 反射与动态代理&#xff1a;实践中的应用与陷阱 在现代Java应用中&#xff0c;反射和动态代理提供了强大的灵活性&#xff0c;但它们也带来了性能和复杂度上的挑战。本文将深入探讨这些技术在实际项目中的应用&#xff0c;分析它们可能导致的陷阱&#xff0c;并提供详细的…

Linux(Centos 7.6)命令详解:wc

1.命令作用 打印文件的行数、单词数、字节数&#xff0c;如果指定了多个文件&#xff0c;还会打印以上三种数据的总和(Print newline, word, and byte counts for each FILE, and a total line if more than one FILE is specified) 2.命令语法 Usage: wc [OPTION]... [FIL…

skynet 源码阅读 -- 核心概念服务 skynet_context

本文从 Skynet 源码层面深入解读 服务&#xff08;Service&#xff09; 的创建流程。从最基础的概念出发&#xff0c;逐步深入 skynet_context_new 函数、相关数据结构&#xff08;skynet_context, skynet_module, message_queue 等&#xff09;&#xff0c;并通过流程图、结构…

超分辨率体积重建实现术前前列腺MRI和大病理切片组织病理学图像的3D配准

摘要: 磁共振成像(MRI)在前列腺癌诊断和治疗中的应用正在迅速增加。然而,在MRI上识别癌症的存在和范围仍然具有挑战性,导致即使是专家放射科医生在检测结果上也存在高度变异性。提高MRI上的癌症检测能力对于减少这种变异性并最大化MRI的临床效用至关重要。迄今为止,这种改…

TypeScript 基础使用和相关问题

tsconfig.json 配置文件 {"compilerOptions": {"target": "esnext","jsx": "preserve","jsxImportSource": "vue","lib": ["esnext", "dom"],"useDefineForClassF…

leetcode-分割等和子集

本题涉及到的是01背包问题&#xff0c;我将从两种解决背包问题的思路写出题解 给你一个 只包含正整数 的 非空 数组 nums 。请你判断是否可以将这个数组分割成两个子集&#xff0c;使得两个子集的元素和相等。 示例 1&#xff1a; 输入&#xff1a;nums [1,5,11,5] 输出&#…

企业级流程架构设计思路-基于价值链的流程架构

获取更多企业流程资料 纸上得来终觉浅&#xff0c;绝知此事要躬行 一.企业流程分级规则定义 1.流程分类分级的总体原则 2.完整的流程体系需要体现出流程的分类分级 03.通用的流程分级方法 04.流程分级的标准 二.企业流程架构设计原则 1.流程架构设计原则 流程框架是流程体…

利用 SoybeanAdmin 实现前后端分离的企业级管理系统

引言 随着前后端分离架构的普及&#xff0c;越来越多的企业级应用开始采用这种方式来开发。前后端分离不仅提升了开发效率&#xff0c;还让前端和后端开发可以并行进行&#xff0c;减少了相互之间的耦合度。SoybeanAdmin 是一款基于 Spring Boot 和 MyBatis-Plus 的后台管理系…

智能风控 数据分析 groupby、apply、reset_index组合拳

目录 groupby——分组 本例 apply——对每个分组应用一个函数 等价用法 reset_index——重置索引 使用前​编辑 注意事项 groupby必须配合聚合函数、 关于agglist 一些groupby试验 1. groupby对象之后。sum&#xff08;一个列名&#xff09; 2. groupby对象…

尚硅谷大数据数仓项目superset db upgrade报错解决(2025.1.23解决)

尚硅谷大数据数仓项目superset db upgrade报错解决&#xff08;2025.1.23解决&#xff09;和 superset安装MySQL报错解决 解决方法&#xff08;2025.1.23解决&#xff09; 0.卸载之前安装好的Superset -- 退出当前环境 conda deactivate-- 卸载Superset conda remove -n sup…