How to do Unit Testing with gorm

When using the GORM ORM library in Go, unit testing is essential for ensuring code quality and functional correctness. Implementing unit tests for GORM typically involves the following steps:

1. Setting up the test environment

During unit testing, avoid interacting with the actual database. Instead, use an in-memory SQLite database or a database running in a Docker container. This ensures the isolation of the test environment and prevents interference with actual data.

For example, using an in-memory SQLite database:

go
import (
    "gorm.io/driver/sqlite"
    "gorm.io/gorm"
)

func SetupTestDB() *gorm.DB {
    db, err := gorm.Open(sqlite.Open("file::memory:?cache=shared"), &gorm.Config{})
    if err != nil {
        panic("failed to connect database")
    }
    return db
}

2. Creating models and migrations

Create the required tables and structures in the test database. Perform migrations before starting the tests.

go
type Product struct {
    gorm.Model
    Code  string
    Price uint
}

func TestMigrate(t *testing.T) {
    db := SetupTestDB()
    // Auto-migration mode
    db.AutoMigrate(&Product{})
}

3. Writing unit tests

Unit tests should comprehensively cover business logic. Use Go's standard testing package for testing. For each business logic scenario, write corresponding test functions.

go
func TestCreateProduct(t *testing.T) {
    db := SetupTestDB()
    db.AutoMigrate(&Product{})

    product := Product{Code: "D42", Price: 100}
    if err := db.Create(&product).Error; err != nil {
        t.Errorf("Failed to create product: %v", err)
    }
}

func TestFindProduct(t *testing.T) {
    db := SetupTestDB()
    db.AutoMigrate(&Product{})
    db.Create(&Product{Code: "D42", Price: 100})

    var product Product
    if err := db.First(&product, "code = ?", "D42").Error; err != nil {
        t.Errorf("Failed to find product: %v", err)
    }

    if product.Price != 100 {
        t.Errorf("Expected price 100, found %d", product.Price)
    }
}

4. Using mocking

Sometimes directly interacting with the database is not ideal, especially when testing complex queries or logic that depends on the state of an external database. In such cases, use mocking packages like go-mock or gomock to simulate GORM behavior.

go
// Using mocking libraries, such as gomock or go-mock
// Pseudo-code; adjust according to actual needs
mockDB := mocks.NewMockGormDBInterface(ctrl)
mockDB.EXPECT().Create(gomock.Any()).Return(nil)

5. Cleaning up and resetting

After each test, clean up the test environment to ensure test independence. Perform this in each test case or use defer to close the database connection. If using an in-memory database, this step can be omitted.

Summary

Unit testing plays a critical role in project development. It helps identify and fix errors early, avoiding issues in production environments. By following these methods, you can effectively perform unit tests on Go applications using GORM, ensuring their robustness and reliability.