MongoDB内存服务器初始化数据与索引的最佳实践

前言

在使用MongoDB内存服务器(MongoDB Memory Server)进行测试时，经常需要预置测试数据、创建集合和索引。本文将详细介绍如何高效地完成这些初始化操作，特别是针对需要测试唯一索引约束等特殊场景。

核心概念

MongoDB内存服务器的特点

MongoDB内存服务器是一个用于测试的轻量级解决方案，它：

• 自动下载并运行mongod二进制文件
• 使用随机端口（除非显式指定）
• 不包含mongo shell或其他客户端工具

初始化方法

1. 使用Node.js驱动直接操作

推荐使用官方的MongoDB Node.js驱动程序来执行初始化操作：

const { MongoMemoryServer } = require('mongodb-memory-server');
const { MongoClient } = require('mongodb');

async function initTestDB() {
  const mongod = await MongoMemoryServer.create();
  const uri = mongod.getUri();
  
  const client = new MongoClient(uri);
  try {
    await client.connect();
    const db = client.db();
    
    // 创建集合
    await db.createCollection('users');
    
    // 创建索引
    await db.collection('users').createIndex({ email: 1 }, { unique: true });
    
    // 插入初始数据
    await db.collection('users').insertMany([
      { name: 'Alice', email: '[e-mail]' },
      { name: 'Bob', email: '[e-mail]' }
    ]);
  } finally {
    await client.close();
  }
}

2. 执行外部脚本文件

如果需要复用已有的shell脚本，可以通过以下方式：

const { exec } = require('child_process');
const fs = require('fs');

async function runMongoScript(mongod, scriptPath) {
  const uri = mongod.getUri();
  const tempFile = `${scriptPath}.tmp`;
  
  // 替换连接字符串
  let scriptContent = await fs.promises.readFile(scriptPath, 'utf8');
  scriptContent = scriptContent.replace(/mongodb:\/\/.*?\//, `${uri}/`);
  
  await fs.promises.writeFile(tempFile, scriptContent);
  
  return new Promise((resolve, reject) => {
    exec(`mongo ${tempFile}`, (error, stdout, stderr) => {
      fs.unlink(tempFile, () => {});
      if (error) return reject(error);
      resolve(stdout);
    });
  });
}

高级技巧

测试唯一索引冲突

针对需要测试唯一索引冲突的场景，可以这样设计测试用例：

describe('Unique Index Tests', () => {
  let mongod;
  let client;
  
  beforeAll(async () => {
    mongod = await MongoMemoryServer.create();
    client = new MongoClient(mongod.getUri());
    await client.connect();
    
    const db = client.db();
    await db.collection('users').createIndex({ email: 1 }, { unique: true });
  });
  
  it('should throw error on duplicate email', async () => {
    const db = client.db();
    await db.collection('users').insertOne({ email: '[e-mail]' });
    
    await expect(
      db.collection('users').insertOne({ email: '[e-mail]' })
    ).rejects.toThrow();
  });
  
  afterAll(async () => {
    await client.close();
    await mongod.stop();
  });
});

注意事项

1. 性能考虑：在beforeEach中初始化数据会比beforeAll更耗时，但能保证测试隔离性

2. 环境依赖：使用外部脚本需要确保测试环境已安装mongo shell工具

3. 数据清理：测试完成后应确保清理测试数据，避免影响后续测试

4. 错误处理：初始化过程中应妥善处理可能出现的错误

总结

通过MongoDB Node.js驱动程序直接操作是最可靠的方式，它不依赖外部工具，能更好地集成到测试流程中。对于复杂的初始化场景，可以将初始化逻辑封装为可复用的模块，提高测试代码的可维护性。

对于从Docker环境迁移过来的测试，建议逐步将shell脚本转换为Node.js代码，这样能获得更好的类型检查和错误提示，同时减少环境依赖。