用Jest模拟mysql连接

Question

尝试测试如下所示的代码:

const mysql = require('mysql2/promise');

async myFunction () {

    const db = await mysql.createConnection(options);

    const results = await db.execute('SELECT `something` from `table`;');

    await db.end();
    
    // more code ...

}

我需要模拟mysql连接，使我能够使用它返回的任何内容来模拟对execute函数的调用。

我曾尝试对整个mysql2/promise模块进行模拟，但当然没有起作用，因为被模拟的CreateConnection没有返回任何可以调用execute函数的内容。我还尝试只模仿我需要的这3个函数，而不是模仿整个模块，类似于:

jest.mock('mysql2/promise', () => ({
    createConnection: jest.fn(() => ({
        execute: jest.fn(),
        end: jest.fn(),
    })),
}));

但这也不起作用。如有任何建议，我们将不胜感激。

Answer 1

我会用不同的方法来处理这个问题。当您觉得需要模拟整个第三方库进行测试时，您的应用程序中出现了一些问题。

作为一般的最佳实践，您应该始终包装第三方库。首先，请查看本文的讨论。

基本上，我们的想法是定义您自己的接口以实现所需的功能，然后使用第三方库实现这些接口。在代码的其余部分中，您将只针对接口工作，而不针对第三方实现。

这有几个优点

1. 您可以自己定义接口。它通常比整个第三方库要小得多，因为您很少使用第三方库的所有功能，您可以为您的具体用例决定什么是最好的接口定义，而不必完全遵循某个库作者的命令。
2. 如果有一天您决定不想再使用MySQL而要转到Mongo，您可以编写一个DB接口的Mongo实现。
3. 在您的情况下，最重要的是:您可以轻松地创建DB接口的模拟实现，而不必开始模拟整个第三方API.

那么这怎么能行得通呢？

首先，定义一个接口，因为它在代码中是最有用的。您的DB接口可能如下所示:

interface Database<T> {
  create(object: T): Promise<void>;
  get(id: string): Promise<T>;
  getAll(): Promise<T[]>;
  update(id: string, object: T): Promise<void>;
  delete(id: string): Promise<void>;
}

现在，您可以针对这个database接口开发整个代码库。当您需要从'table'中检索数据时，您可以使用database实现，而不是在整个代码中编写MySQL查询。

这里我只举一个例子ResultRetriever，它非常原始，但也很有用:

class ResultRetriever {
  
    constructor(private database: Database<Something>) {}

    getResults(): Promise<Something[]> {
        return this.database.getAll();
    }
  
}

正如您所看到的，您的代码不需要关心哪个DB实现交付数据。另外，我们在这里反转了依赖关系:ResultReteriver注入了它的Database实例。它不知道它获得的是哪个conrete数据库实现。不需要。它所关心的只是它是一个有效的。

现在可以轻松实现MySQLDatabase类:

class MySqlDatabase<T> implements Database<T> {

  create(object: T): Promise<void> {...}

  get(id: string): Promise<T> {...}

  getAll(): Promise<T[]> {
      const db = await mysql.createConnection(options);
      const results = await db.execute('SELECT `something` from `table`;');
      await db.end();
      return results;
  }

  update(id: string, object: T): Promise<void> {...}

  delete(id: string): Promise<void> {...}

}

现在，我们已经从主代码库中完全抽象出了MySQL特定的实现。当涉及到测试时，您可以编写一个简单的MockDatabase:

export class MockDatabase<T> implements Database<T> {

  private objects: T[] = [];

  async create(object: T): Promise<void> {
    this.objects.push(object);
  }

  async get(id: string): Promise<T> {
    return this.objects.find(o => o.id === id);
  }

  async getAll(): Promise<T[]> {
    return this.objects;
  }

  update(id: string, object: T): Promise<void> {...}

  delete(id: string): Promise<void> {...}
  
}

当涉及到测试时，您现在可以使用MockDatabase来测试ResultRieve，而不是依赖于MySQL库并因此完全模拟它:

describe('ResultRetriever', () => {

    let retriever: ResultRetriever;
    let db: Database;

    beforeEach(() => {
      db = new MockDatabase();
      retriever = new ResultRetriever(db);
    });

    ...

});

如果我超出了问题的范围，我很抱歉，但是我觉得仅仅回应如何模仿MySQL库并不能解决底层的架构问题。

如果您不使用/不想使用TypeScript，可以将相同的逻辑应用于JavaScript。