Go语言中mgo数据库单元测试的接口抽象实践

package main

import (
    "gopkg.in/mgo.v2" // 假设使用mgo v2
    "gopkg.in/mgo.v2/bson"
)

// 定义MgoCollection接口，包含myFunc所需的方法
type MgoCollection interface {
    Insert(docs ...interface{}) error
    // 如果myFunc还使用了Find、Update等方法，也需要在这里定义
    Find(query interface{}) *mgo.Query // mgo.Query 也是一个具体类型，通常也需要抽象
}

// 定义MgoDatabase接口，包含myFunc所需的方法
type MgoDatabase interface {
    C(name string) MgoCollection // C方法返回我们定义的MgoCollection接口
    // 如果myFunc还使用了Run、Login等方法，也需要在这里定义
}

// 原始函数，现在修改为接受MgoDatabase接口
func myFunc(db MgoDatabase, data interface{}) error {
    collection := db.C("my_collection")
    return collection.Insert(data)
}

// 原始函数签名: func myFunc(db *mgo.Database, data interface{}) error
// 修改后的函数签名:
func myFunc(db MgoDatabase, data interface{}) error {
    collection := db.C("my_collection")
    return collection.Insert(data)
}

// MockCollection 是 MgoCollection 接口的模拟实现
type MockCollection struct {
    InsertedDocs []interface{} // 用于记录插入的文档
    InsertErr    error         // 用于模拟插入时返回的错误
}

func (mc *MockCollection) Insert(docs ...interface{}) error {
    if mc.InsertErr != nil {
        return mc.InsertErr
    }
    mc.InsertedDocs = append(mc.InsertedDocs, docs...)
    return nil
}

func (mc *MockCollection) Find(query interface{}) *mgo.Query {
    // 在模拟中，Find通常返回一个模拟的mgo.Query，或者直接返回nil
    // 对于本例，我们只关注Insert，所以可以简化
    return nil // 或者返回一个模拟的mgo.Query
}

// MockDatabase 是 MgoDatabase 接口的模拟实现
type MockDatabase struct {
    MockCollections map[string]*MockCollection // 模拟不同的集合
    DefaultMockCol  *MockCollection            // 默认的模拟集合，如果未指定则返回
}

func (md *MockDatabase) C(name string) MgoCollection {
    if col, ok := md.MockCollections[name]; ok {
        return col
    }
    // 如果没有为特定集合设置模拟，则返回一个默认的
    if md.DefaultMockCol == nil {
        md.DefaultMockCol = &MockCollection{}
    }
    return md.DefaultMockCol
}

package main

import (
    "errors"
    "testing"
)

func TestMyFunc_Success(t *testing.T) {
    // 准备模拟数据
    mockCol := &MockCollection{}
    mockDB := &MockDatabase{
        MockCollections: map[string]*MockCollection{
            "my_collection": mockCol,
        },
    }

    testDoc := bson.M{"name": "test_user", "age": 30}

    // 调用被测试函数
    err := myFunc(mockDB, testDoc)

    // 断言
    if err != nil {
        t.Errorf("myFunc unexpected error: %v", err)
    }
    if len(mockCol.InsertedDocs) != 1 {
        t.Errorf("Expected 1 document to be inserted, got %d", len(mockCol.InsertedDocs))
    }
    insertedDoc := mockCol.InsertedDocs[0].([]interface{})[0] // Insert takes variadic args
    if insertedDoc.(bson.M)["name"] != "test_user" {
        t.Errorf("Inserted document name mismatch. Expected 'test_user', got '%v'", insertedDoc.(bson.M)["name"])
    }
}

func TestMyFunc_InsertError(t *testing.T) {
    // 准备模拟数据，模拟插入错误
    expectedErr := errors.New("simulated insert error")
    mockCol := &MockCollection{
        InsertErr: expectedErr,
    }
    mockDB := &MockDatabase{
        MockCollections: map[string]*MockCollection{
            "my_collection": mockCol,
        },
    }

    testDoc := bson.M{"name": "error_user"}

    // 调用被测试函数
    err := myFunc(mockDB, testDoc)

    // 断言
    if err == nil {
        t.Error("myFunc expected an error, but got none")
    }
    if err != expectedErr {
        t.Errorf("myFunc returned wrong error. Expected '%v', got '%v'", expectedErr, err)
    }
    if len(mockCol.InsertedDocs) != 0 {
        t.Errorf("Expected 0 documents to be inserted on error, got %d", len(mockCol.InsertedDocs))
    }
}

package main

import (
    "fmt"
    "log"
    "gopkg.in/mgo.v2"
    "gopkg.in/mgo.v2/bson"
)

// main函数或服务启动时初始化真实的mgo数据库连接
func main() {
    session, err := mgo.Dial("mongodb://localhost:27017/testdb")
    if err != nil {
        log.Fatalf("Failed to connect to MongoDB: %v", err)
    }
    defer session.Close()

    // 获取真实的mgo.Database实例
    realDB := session.DB("mydatabase")

    // 由于*mgo.Database实现了MgoDatabase接口，可以直接传入
    dataToSave := bson.M{"product": "Go Book", "price": 49.99}
    err = myFunc(realDB, dataToSave) // realDB (*mgo.Database) 隐式满足 MgoDatabase 接口
    if err != nil {
        log.Printf("Failed to save data: %v", err)
    } else {
        fmt.Println("Data saved successfully to real database.")
    }

    // 验证数据（可选）
    var result bson.M
    err = realDB.C("my_collection").Find(bson.M{"product": "Go Book"}).One(&result)
    if err != nil {
        log.Printf("Failed to find data: %v", err)
    } else {
        fmt.Printf("Found data: %+v\n", result)
    }
}