Golang GORM 数据库模拟

Question

我必须模拟测试服务。要创建新服务，我需要通过 gorm.DB{} 但每次我通过它并运行测试时，我都会得到零指针错误（恐慌）。 请帮助了解如何正确模拟 gorm.DB{} 实例以进行单元测试。

func NewService(db *gorm.DB) Service {
    return &service{
        repo:  newReactionRepo(db),
    }
}

像这样在测试中进行模拟调用：-

mockDB = &gorm.DB{}

package.NewService(mockDB)

收到此错误

testing.tRunner.func1.2({0x1648e40, 0x21cdd60})
    C:/Program Files/Go/src/testing/testing.go:1396 +0x24e
testing.tRunner.func1()
    C:/Program Files/Go/src/testing/testing.go:1399 +0x39f
panic({0x1648e40, 0x21cdd60})
    C:/Program Files/Go/src/runtime/panic.go:884 +0x212
gorm.io/gorm.(*DB).Session(0x21ef260, 0xc000861a50)
    C:/Users/acb/sdk/go1.17/pkg/mod/gorm.io/gorm@v1.24.2/gorm.go:215 +0x3b
gorm.io/gorm.(*DB).WithContext(...)

Answer 1

您可以初始化数据库，即：

//...
 mockDB := initDb()
 package.NewService(mockDB)
//...

func initDb() *gorm.DB {
    dsn := "host=localhost user=myuser password=mypassword dbname=mydb port=5432 sslmode=disable"

    db, err := gorm.Open(postgres.Open(dsn))
    if err != nil {
        log.Fatal("couldn't connect to db")
    }
    return db
}

Answer 2

由于gorm.DB类型是一个结构，因此直接使用它进行单元测试有点困难。 对于您收到的 nil 指针错误，您可能需要修改代码以检查传入的nil值，这样它就不会尝试调用 nil 指针上的方法。

如果你想进行单元测试，你可以将你的数据库操作包装在一个接口中，然后提供一个不使用真实数据库的模拟实现。 这可以通过创建一个定义与数据库交互所需的方法的接口，然后创建一个为实际数据库操作实现该接口的结构来完成。

例如：

// Database is an interface that defines methods for interacting with a database.
type Database interface {
    Create(data interface{}) error
    GetByID(id int, result interface{}) error
}

// RealDatabase is a struct that implements the Database interface
// using a real GORM connection.
type RealDatabase struct {
    // db is a connection to the database
    db *gorm.DB
}

// Create saves the data in the database
func (rdb *RealDatabase) Create(data interface{}) error {
    return rdb.db.Create(data).Error
}

// GetByID retrieves the data by ID from the database
func (rdb *RealDatabase) GetByID(id int, result interface{}) error {
    return rdb.db.First(result, id).Error
}

// MockDatabase is a struct that implements the Database interface
// using a mock GORM connection.
type MockDatabase struct {
    // data is a map of ID to data used for mocking.
    data map[int]interface{}
}

// Create does not do anything but returns no errors
func (mdb *MockDatabase) Create(data interface{}) error {
    return nil
}

// GetByID returns the data for a given ID
func (mdb *MockDatabase) GetByID(id int, result interface{}) error {
    data, ok := mdb.data[id]
    if !ok {
        return fmt.Errorf("data not found for ID: %d", id)
    }
    result = data
    return nil
}

在此示例中，RealDatabase 结构使用 GORM 与数据库交互，而 MockDatabase 结构使用 map 来模拟真实数据库的行为。 MockDatabase 结构中的 Create 方法不执行任何操作且不返回任何错误，而 GetByID 方法返回给定 ID 的数据。 您还可以向模拟结构和接口添加更多功能，以根据需要模拟真实数据库的行为。

最后，您还可以使用Gomock 库，它提供的工具可以自动生成您提供给它的接口的模拟版本。

Answer 3

您可以尝试使用组合。

type DBInstance struct {
  *gorm.DB
}

将DBInstance的实例传递给NewService(db DBInstance)而不是*gorm.DB 。 您可以模拟在对代码进行单元测试时使用的*gorm.DB方法。 例子：

func (DBInstance) Find(dest interface{}, conds ...interface{}) (tx *DB) {
  // mock implementation of gorm.DB.Find()
}

从实际代码调用时，使用数据库实例初始化数据库实例：

dsn := "host=localhost user=myuser password=mypassword dbname=mydb port=5432 sslmode=disable"
db, err := gorm.Open(postgres.Open(dsn))
dbInstance := DBInstance{
  &db,
}

从单元测试调用时，传递一个空的未初始化*gorm.DB object 并模拟所有必需的方法。

dbInstance := DBInstance{
  &gorm.DB{},
}