在 Jest 29 中使用 MongoDB基于 jest-mongodb Preset 的集成测试完整指南【免费下载链接】jestDelightful JavaScript Testing.项目地址: https://gitcode.com/gh_mirrors/je/jest本篇指南围绕 Jest 官方文档中「Using with MongoDB」一节的实战方案展开借助shelf/jest-mongodbpreset配合 Jest 的 Global Setup/Teardown 与 Async Test Environment 两大 API你可以在真实 MongoDB 实例上编写端到端风格的集成测试无需手动管理数据库进程、无需在测试内加载额外依赖。读完本文你将掌握从安装、配置到编写 CRUD 用例的完整链路并理解 preset、globalSetup 与 testEnvironment 在底层是如何协同工作的。为什么 Jest 可以平滑对接 MongoDBMongoDB 的集成测试天然需要一个真实运行的数据库实例连接、写入、查询、清理数据每一个环节都要求数据库在线可用。Jest 为此提供了两项关键 API见 Configuration.mdglobalSetupstring在全部测试文件运行之前执行一次的钩子可同步或异步接收globalConfig与projectConfig两个参数。典型用法是在这里启动内存版 MongoDBmongod并把实例句柄挂到globalThis上供globalTeardown读取与回收docs/Configuration.md#L855-L879。globalTeardownstring在所有测试文件运行结束后执行一次的钩子用于关闭数据库进程、释放资源docs/Configuration.md#L890-L902。testEnvironmentnode | jsdom | string指定测试运行的环境默认为node也可指向自定义环境对象需符合JestEnvironment形状docs/Configuration.md#L2014-L2113。shelf/jest-mongodb正是把这三者封装成了一个开箱即用的 preset它替你写好了启动 mongod 的 setup 脚本、关闭 mongod 的 teardown 脚本以及注入 MongoDB 连接信息的 testEnvironment。你只需要在配置里声明preset即可获得完整的测试数据库生命周期管理。第一步安装 shelf/jest-mongodbshelf/jest-mongodb以开发依赖形式安装npm install --save-dev shelf/jest-mongodb安装完成后无需在测试文件里额外加载任何依赖——MongoDB 实例的启动与关闭完全由 preset 内置的 global setup/teardown 脚本接管。第二步在 Jest 配置中声明 preset在jest.config.js或package.json的jest字段、jest.config.json中指定 preset{ preset: shelf/jest-mongodb }Jest 的preset配置项指向一个 npm 包该包根目录需提供jest-preset.json、jest-preset.js、jest-preset.cjs或jest-preset.mjs文件见 docs/Configuration.md#L1173-L1212。shelf/jest-mongodb的jest-preset内部即声明了globalSetup、globalTeardown与testEnvironment三项配置从而把数据库生命周期全部托管给 Jest。从源码看preset 的解析发生在 packages/jest-config/src/normalize.ts 的setupPreset函数中packages/jest-config/src/normalize.ts#L171-L185Jest 会基于rootDir解析 preset 模块路径按扩展名查找jest-preset文件随后与用户配置进行合并。其对应的配置归一化测试位于 packages/jest-config/src/tests/normalize.test.ts其中覆盖了 preset 缺失、文件格式非法、依赖缺失、与用户配置合并优先级等场景。这意味着preset 提供的globalSetup/globalTeardown/testEnvironment会自动生效你在自身配置中显式书写的同名配置项可以覆盖 preset 的默认值若 preset 包内缺少jest-preset.*文件Jest 会直接报错并提示对应 normalize.test.ts 中的校验逻辑。第三步编写使用全局 Mongo 全局变量的测试preset 生效后Jest 会在测试环境中注入两个全局变量可直接在测试代码中读取globalThis.__MONGO_URI__MongoDB 实例的连接串globalThis.__MONGO_DB_NAME__为本次测试运行准备的数据库名称。结合官方文档的示例一个完整的插入与查询用例长这样const {MongoClient} require(mongodb); describe(insert, () { let connection; let db; beforeAll(async () { connection await MongoClient.connect(globalThis.__MONGO_URI__, { useNewUrlParser: true, useUnifiedTopology: true, }); db await connection.db(globalThis.__MONGO_DB_NAME__); }); afterAll(async () { await connection.close(); }); it(should insert a doc into collection, async () { const users db.collection(users); const mockUser {_id: some-user-id, name: John}; await users.insertOne(mockUser); const insertedUser await users.findOne({_id: some-user-id}); expect(insertedUser).toEqual(mockUser); }); });要点拆解连接只建立一次在beforeAll中基于__MONGO_URI__建立连接并从中取出__MONGO_DB_NAME__对应的数据库句柄供整个 describe 块复用连接只关闭一次在afterAll中关闭连接避免资源泄漏与测试间互相干扰断言语义写入{_id: some-user-id, name: John}后再按_id读回用toEqual验证文档内容一致无需手工启动数据库__MONGO_URI__指向的内存/临时 MongoDB 实例由 preset 负责启动与销毁因此测试代码里没有出现任何 mongod 相关逻辑。深入原理globalSetup / globalTeardown / testEnvironment 如何协作为了更透彻地理解 preset 做了什么可以把文档中提到的机制拆开来看。Jest 官方在globalSetup一节中给出的示例docs/Configuration.md#L871-L888展示了手工实现时的核心思路——setup 脚本启动 mongod 并把句柄挂到全局module.exports async function (globalConfig, projectConfig) { console.log(globalConfig.testPathPatterns); console.log(projectConfig.cache); // Set reference to mongod in order to close the server during teardown. globalThis.__MONGOD__ mongod; };对应的 teardown 脚本则负责关闭进程module.exports async function (globalConfig, projectConfig) { console.log(globalConfig.testPathPatterns); console.log(projectConfig.cache); await globalThis.__MONGOD__.stop(); };这里有几点值得注意的边界官方文档明确标注globalSetup 中定义的全局变量只能在 globalTeardown 中读取测试套件内部无法直接访问docs/Configuration.md#L865。shelf/jest-mongodb之所以能让测试拿到__MONGO_URI__与__MONGO_DB_NAME__是因为它同时自定义了testEnvironment在环境初始化阶段把连接信息注入到globalThis——这正是文档开篇把「Global Setup/Teardown」与「Async Test Environment」并列作为前提的原因全局钩子只触发一次globalSetup在全部测试文件开始前执行globalTeardown在全部结束后执行多项目运行器下仅当该项目至少运行了一个测试时触发因此数据库进程在整个测试会话中只启动、销毁各一次性能开销可控node_modules 不做转换Jest 会对 setup 文件本身做代码转换但不会转换node_modules中的代码docs/Configuration.md#L867。仓库内 e2e/global-setup/setupWithConfig.js 展示了 global setup 接收(globalConfig, projectConfig)两个参数的实际用法其对应端到端测试位于 e2e/tests/globalSetup.test.ts可作为理解参数形状与调用时机的参考。进阶配置 MongoDB 版本与更多自定义官方文档的结尾指出关于MongoDB 版本选择、内存数据库的磁盘/内存限制、是否启用副本集等更细致的配置需要参考shelf/jest-mongodb自身的文档本仓库为只读镜像不包含该 preset 源码请以你项目node_modules中实际安装的版本为准。在jest-preset之上做自定义时推荐遵循以下模式// jest.config.js const {defineConfig} require(jest); module.exports defineConfig({ preset: shelf/jest-mongodb, // 覆盖 preset 提供的默认值 testTimeout: 20000, // 可叠加你自己的 setup 文件 setupFilesAfterEnv: [./jest.setup.js], });由于 preset 的配置会与你的显式配置做合并preset 中定义的moduleNameMapper、transform等均会被用户配置覆盖见 normalize.test.ts 中「merges with options」系列用例你可以在保留 preset 数据库能力的同时自由补充项目自身的配置项。小结环节你需要做的事背后的机制安装npm install --save-dev shelf/jest-mongodb无配置在 Jest 配置中声明preset: shelf/jest-mongodbjest-preset内含globalSetup/globalTeardown/testEnvironmentpackages/jest-config/src/normalize.ts 完成解析与合并编写测试在beforeAll中用globalThis.__MONGO_URI__连接、用globalThis.__MONGO_DB_NAME__取库preset 的 testEnvironment 注入全局变量生命周期无需手动启动/关闭 mongodglobalSetup启动、globalTeardown关闭参考 docs/Configuration.md#L855-L902 的手工实现示例这套方案的实战价值在于测试环境完全隔离、不依赖本机预装 MongoDB 服务同时因为跑在真实数据库上能覆盖索引、聚合、唯一约束等 mock 难以模拟的数据库行为。需要进一步定制如指定 MongoDB 版本时请查阅你所安装的shelf/jest-mongodb版本自带文档。【免费下载链接】jestDelightful JavaScript Testing.项目地址: https://gitcode.com/gh_mirrors/je/jest创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考