使用sqlmock测试gorm的删除子句

目前golang学习网上已经有很多关于Golang的文章了，自己在初次阅读这些文章中，也见识到了很多学习思路；那么本文《使用sqlmock测试gorm的删除子句》，也希望能帮助到大家，如果阅读完后真的对你学习Golang有帮助，欢迎动动手指，评论留言并分享~

我有一个 gorm 删除，返回结果：

expirationdate := time.now().utc().add(-(48 * time.hour))
var deletedusers users
res := gormdb.withcontext(ctx).
    table("my_users").
    clauses(clause.returning{columns: []clause.column{{name: "email"}}}).
    where("created_at < ?", expirationdate).
    delete(&deletedusers)

现在带有子句的测试总是失败。例如：

sqlMock.ExpectExec(`DELETE`)
    .WithArgs(expirationDate)
    .WillReturnResult(sqlmock.NewResult(1, 1))

接收错误：

“使用参数 [{name: ordinal:1 value:2023-01-18 06:15:34.694274 +0000 utc}] 调用查询 'delete from "my_users" where created_at < $1 returning "email"'不是预期的，下一个期望是： expectedexec => 期望 exec 或 execcontext 其中：\n - 匹配 sql：'delete'\n - 带有参数：\n 0 - 2023-01-18 06:15:34.694274 +0000 utc\ n - 应返回具有以下内容的结果：\n lastinsertid: 1\n rowsaffected: 1"

我尝试了许多其他 sqlmock 期望，但他们也有类似的问题。 另外，我们在 expectexec 中没有返回值，只有在 expectquery 中... 有人必须用子句测试 gorm 查询吗？

正确答案

我能够成功地管理您的需求。首先，让我分享我编写的文件，然后我将引导您完成所有相关更改。这些文件是用于生产的 repo.go 和用于测试代码的 repo_test.go。

repo.go

package gormdelete

import (
    "context"
    "time"

    "gorm.io/gorm"
    "gorm.io/gorm/clause"
)

type users struct {
    email string
}

func delete(ctx context.context, gormdb *gorm.db) error {
    expirationdate := time.now().utc().add(-(48 * time.hour))

    var deletedusers users
    res := gormdb.withcontext(ctx).table("my_users").clauses(clause.returning{columns: []clause.column{{name: "email"}}}).where("created_at < ?", expirationdate).delete(&deletedusers)
    if res.error != nil {
        return res.error
    }
    return nil
}

由于您没有提供完整的文件，我试图猜测缺少的内容。

repo_test.go

package gormdelete

import (
    "context"
    "database/sql/driver"
    "testing"
    "time"

    "github.com/DATA-DOG/go-sqlmock"
    "github.com/stretchr/testify/assert"
    "gorm.io/driver/postgres"
    "gorm.io/gorm"
)

// this is taken directly from the docs
// https://github.com/DATA-DOG/go-sqlmock#matching-arguments-like-timetime
type AnyTime struct{}

// Match satisfies sqlmock.Argument interface
func (a AnyTime) Match(v driver.Value) bool {
    _, ok := v.(time.Time)
    return ok
}

func TestDelete(t *testing.T) {
    db, mock, err := sqlmock.New()
    if err != nil {
        t.Fatalf("an error was not expected: %v", err)
    }

    conn, _ := db.Conn(context.Background())
    gormDb, err := gorm.Open(postgres.New(postgres.Config{
        Conn: conn,
    }))

    row := sqlmock.NewRows([]string{"email"}).AddRow("[email protected]")
    mock.ExpectBegin()
    mock.ExpectQuery("DELETE FROM \"my_users\" WHERE created_at < ?").WithArgs(AnyTime{}).WillReturnRows(row)
    mock.ExpectCommit()

    err = Delete(context.Background(), gormDb)

    assert.Nil(t, err)
    if err = mock.ExpectationsWereMet(); err != nil {
        t.Errorf("not all expectations were met: %v", err)
    }
}

这里还有更多值得一提的变化：

1. 我根据文档实例化了 anytime （您可以在评论中看到链接）。
2. 我再次猜测了 db、mock 和 gormdb 的设置，但我认为它们应该大致相同。
3. 我将 expectexec 的用法切换为 expectquery，因为我们将返回 clauses 文件中 repo.go 方法指定的结果集。
4. 您必须将 expectquery 包装在 expectbegin 和 expectcommit 中。
5. 最后，请注意驱动程序对 sql 语句中参数的期望方式的差异。在生产代码中，您可以选择使用?或$1。但在测试代码中，只能使用?，否则不符合预期。

希望能帮上一点忙，否则请告诉我！

理论要掌握，实操不能落！以上关于《使用sqlmock测试gorm的删除子句》的详细介绍，大家都掌握了吧！如果想要继续提升自己的能力，那么就来关注golang学习网公众号吧！