驾驭 Golang 测试：5. 洞悉 MySQL 经典 mock driver—— sqlmock

2023-09-25 06:59:08

sqlmock——MySQL 数据库模拟的利器

在 Golang 测试中，我们常常需要模拟数据库的行为，以便在没有真实数据库连接的情况下也能对代码进行充分测试。而 sqlmock 正是为此而生，它是一款专为 MySQL 设计的 mock 库，能够轻松实现数据库行为的模拟。

sqlmock 的原理与设计

sqlmock 本质上是实现了 sql/driver 接口的一个 mock 库，其设计目标就是支持在测试中模拟任何 sql driver 的行为，而不需要一个真正数据库的连接。这对于 TDD（测试驱动开发）非常有用，因为它允许我们在没有真实数据库的情况下编写和运行测试，从而提高测试速度并降低测试成本。

sqlmock 的使用场景

sqlmock 可以应用于各种 Golang 测试场景中，包括但不限于：

单元测试：sqlmock 可以模拟数据库行为，帮助您在不依赖真实数据库的情况下测试您的代码，从而提高单元测试的速度和可靠性。
集成测试：sqlmock 可以模拟数据库行为，帮助您测试您的代码与数据库的交互，从而发现集成测试中的问题。
性能测试：sqlmock 可以模拟数据库行为，帮助您评估您的代码在不同数据库负载下的性能，从而优化您的代码性能。
回归测试：sqlmock 可以模拟数据库行为，帮助您在修改代码后，重新运行测试以确保代码仍然按预期工作，从而防止回归缺陷。

sqlmock 的使用方式

sqlmock 的使用非常简单，只需几行代码即可实现数据库行为的模拟。以下是一个简单的示例：

package main

import (
	"database/sql"
	"fmt"
	"testing"

	"github.com/DATA-DOG/go-sqlmock"
)

func TestSelect(t *testing.T) {
	db, mock, err := sqlmock.New()
	if err != nil {
		t.Fatalf("an error '%s' was not expected when opening a stub database connection", err)
	}
	defer db.Close()

	rows := sqlmock.NewRows([]string{"id", "name"}).AddRow(1, "John Doe").AddRow(2, "Jane Doe")
	mock.ExpectQuery("SELECT id, name FROM users").WillReturnRows(rows)

	type user struct {
		id   int
		name string
	}
	var users []user
	rows, err = db.Query("SELECT id, name FROM users")
	if err != nil {
		t.Fatalf("an error '%s' was not expected when querying the stub database", err)
	}
	for rows.Next() {
		var u user
		err = rows.Scan(&u.id, &u.name)
		if err != nil {
			t.Fatalf("an error '%s' was not expected when scanning the result row", err)
		}
		users = append(users, u)
	}
	if err = rows.Err(); err != nil {
		t.Fatalf("an error '%s' was not expected when closing the result iterator", err)
	}

	if len(users) != 2 {
		t.Errorf("expected 2 rows to be returned, but got %d", len(users))
	}
	if users[0].id != 1 || users[0].name != "John Doe" {
		t.Errorf("expected first row to be {1, John Doe}, but got %+v", users[0])
	}
	if users[1].id != 2 || users[1].name != "Jane Doe" {
		t.Errorf("expected second row to be {2, Jane Doe}, but got %+v", users[1])
	}
}

在这个示例中，我们首先使用 sqlmock.New() 函数创建了一个模拟数据库连接 db 和一个模拟对象 mock。然后，我们使用 mock.ExpectQuery() 函数来模拟一个查询语句的执行，并指定了这个查询语句应该返回哪些行。接下来，我们使用 db.Query() 函数来执行这个查询语句，并将结果存储在 rows 变量中。最后，我们使用 rows.Next() 和 rows.Scan() 函数来遍历查询结果，并将这些结果存储在 users 变量中。最后，我们检查 users 变量中的结果，以确保它们与我们预期的结果一致。