sql - TDD 构造器 Golang

Question

尽管有几篇关于此的文章，但我还没有找到一篇有实质内容的文章。所以希望一些人能就此分享意见。

阻碍我拥有真正的 TDD 工作流程的一件事是，我无法找到一种干净的方法来测试必须连接到网络服务(如数据库)的东西。

例如:

type DB struct {
    conn *sql.DB
}

func NewDB(URL string) (*DB, err) {
    conn, err := sql.Open("postgres", URL)
    if err != nil {
        return nil, err
    }
}

我知道我可以将 sql 连接传递给 NewDB，或者直接传递给结构并将其分配给一个接口(interface)，该接口(interface)具有我需要的所有方法，并且可以轻松测试。但是在某个地方，我将不得不连接。我能找到的测试这个的唯一方法是......

var sqlOpen = sql.Open
func CreateDB() *DB {
    conn, err := sqlOpen("postgres", "url...")
    if err != nil {
         log.Fatal(err)
    }

    dataBase = DB{
        conn: conn
    }
}

然后在测试中，您将 sqlOpen 函数替换为返回具有相同签名的函数的函数，该函数会为一个测试用例提供错误，而不会为另一个测试用例提供错误。但这感觉像是一种 hack，尤其是当您对同一个文件中的多个函数执行此操作时。有没有更好的办法？我正在使用的代码库在包和网络连接方面有很多功能。因为我正在努力以干净的方式测试事物，所以它让我远离 TDD。

Answer 1

典型的业务应用程序在查询中有很多逻辑。如果未测试，我们会显着降低测试覆盖率并为回归错误留出空间。因此，模拟数据库存储库不是最佳选择。相反，我们可以模拟数据库本身并测试我们如何在 SQL 级别上使用它。

以下是使用 DATA-DOG/go-sqlmock 的示例代码, 但可能还有其他模拟 sql 数据库的库。

首先，我们需要在我们的代码中注入(inject)sql连接。 GO sql connection 是一个误导性的名称，它实际上是连接池，而不仅仅是单个 DB 连接。这就是为什么即使您不编写测试，在您的组合根中创建单个 *sql.DB 并在您的代码中重用也是有意义的。

下面的示例展示了如何模拟网络服务。

一开始，我们需要创建一个带有注入(inject)连接的新处理程序:

// New creates new handler
func New(db *sql.DB) http.Handler {
    return &handler{
        db:     db,
    }
}

处理程序代码:

type handler struct {
    db     *sql.DB
}

func (h handler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
  // some code that loads person name from database using id
}

单元测试模拟数据库的代码。它使用 stretchr/testify对于断言:

func TestHandler(t *testing.T) {
    db, sqlMock, _ := sqlmock.New()
    rows := sqlmock.NewRows([]string{"name"}).AddRow("John")
    // regex is used to match query
    // assert that we execute SQL statement with parameter and return data
    sqlMock.ExpectQuery(`select name from person where id \= \?`).WithArgs(42).WillReturnRows(rows)
    defer db.Close()

    sut := mypackage.New(db)

    r, err := http.NewRequest(http.MethodGet, "https://example.com", nil)
    require.NoError(t, err, fmt.Sprintf("Failed to create request: %v", err))
    w := httptest.NewRecorder()

    sut.ServeHTTP(w, r)
    // make sure that all DB expectations were met 
    err = sqlMock.ExpectationsWereMet()
    assert.NoError(t, err)
    // other assertions that check DB data should be here 
    assert.Equal(t, http.StatusOK, w.Code)
}

我们的测试断言针对数据库的简单 SQL 语句。但是使用 go-sqlmock 可以测试所有 CRUD 操作和数据库事务。

上面的测试还有一个弱点。我们测试了我们的 SQL 语句是从代码执行的，但我们没有测试它是否适用于我们的真实数据库。这个问题不能用单元测试来解决。唯一的解决方案是针对真实数据库进行集成测试。

不过，我们现在处于更好的位置。业务逻辑已经在单元测试中进行了测试。我们不需要创建大量集成测试来涵盖不同的场景和参数，相反，我们只需要对每个查询进行一次测试来验证 SQL 语法并匹配我们的数据库模式。

测试愉快!