JavaScript 中 CommonJS 怎么在自动化测试断言库中导出公共的测试辅助函数

胖晨小哥_3629

胖晨小哥_3629

2026-08-27

886人浏览

原创

在commonjs环境(如node.js+mocha/jest)中,可将断言辅助函数封装于模块中用module.exports导出,通过require引入使用;函数应单一职责、语义清晰、纯函数、兼容chai或jest等断言库,并支持typescript类型提示。

javascript 中 commonjs 怎么在自动化测试断言库中导出公共的测试辅助函数

在 JavaScript 的 CommonJS 环境(如 Node.js + Mocha/Jest 默认 CommonJS 模式)中,你可以把通用的断言辅助函数封装在一个模块里,用 module.exports 导出,然后在测试文件中通过 require() 引入使用。关键是要让这些函数可复用、语义清晰,并与主流断言库(如 Chai、Jest expect、或自定义断言)协同工作。

导出可复用的断言辅助函数

比如你经常需要校验某个异步操作是否抛出特定错误,或检查对象是否包含一组动态键值对,可以写成独立函数并统一导出:

  • 新建 test-helpers.js(或 assertions.js)
  • 每个函数只做一件事,接收必要参数,返回布尔值或直接调用断言(推荐后者,便于报错定位)
  • 避免副作用,不修改传入对象,保持纯函数特性

示例(基于 Chai):

Java Maven Common
Java Maven Common

Java Maven 项目审查工作流的通用输入处理。当 Java Maven 项目以 ZIP压缩包或 GitLab 仓库 URL 形式提供且需要...时使用。

下载
// test-helpers.js
const { expect } = require('chai');
<p>function expectToThrowAsync(fn, expectedErrorType, messageContains) {
return expect(fn()).to.eventually.be.rejected.then(err => {
expect(err).to.be.an.instanceOf(expectedErrorType);
if (messageContains) {
expect(err.message).to.include(messageContains);
}
});
}</p><p>function expectObjectContains(obj, partial) {
Object.keys(partial).forEach(key => {
expect(obj).to.have.property(key);
expect(obj[key]).to.deep.equal(partial[key]);
});
}</p><p>module.exports = {
expectToThrowAsync,
expectObjectContains,
};</p>

在测试文件中引入并使用

直接 require 后即可调用,和原生断言一样参与测试流程:

// user.test.js
const { expect } = require('chai');
const { expectToThrowAsync, expectObjectContains } = require('./test-helpers');
<p>describe('User service', () => {
it('should reject with ValidationError when email is invalid', async () => {
await expectToThrowAsync(
() => createUser({ email: 'invalid' }),
Error,
'email'
);
});</p><p>it('should return user with id and name', () => {
const user = { id: 123, name: 'Alice', role: 'user' };
expectObjectContains(user, { id: 123, name: 'Alice' });
});
});</p>

适配不同断言库的注意事项

  • Jest 用户:不要在辅助函数里直接调用 expect(...),因为 Jest 的 expect 是 per-test 绑定的;改用返回布尔值或抛错,再由测试内调用 expect(...).toBe(true) 或 expect(() => ...).toThrow(...)
  • Chai 用户:可直接链式调用(如上例),但注意异步函数需配合 .eventually 或 .and 等修饰符
  • 若辅助函数内部抛错(如 throw new Error('xxx')),Jest/Chai 都能捕获并显示为测试失败,且保留堆栈信息

进阶:支持 TypeScript 和自动类型提示

即使使用 CommonJS,也可以为 test-helpers.js 添加 .d.ts 声明文件,或在 JS 文件顶部加 JSDoc 注释,让 VS Code 等工具识别参数和返回类型:

/**
 * @param {() => Promise<any>} fn
 * @param {typeof Error} expectedErrorType
 * @param {string} [messageContains]
 * @returns {Promise<void>}
 */
function expectToThrowAsync(fn, expectedErrorType, messageContains) {
  // ...
}
</void></any>

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

4966

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1229

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

4884

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

960

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1876

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3505

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

4553

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

2980

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

948

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12.2万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.7万人学习