Golang 与 Gin、Gorm、Testify、PostgreSQL 的集成测试

使用 Gin、GORM、Testify 和 PostgreSQL 在 Golang 中创建全面的集成测试设置涉及设置测试数据库、为 CRUD 操作编写测试以及使用 Testify 进行断言。这是帮助您入门的分步指南：

先决条件

• 安装
• Docker 已安装
• 库：gin-gonic/gin、gorm.io/gorm、gorm.io/driver/postgres、testify、testcontainers-go

项目结构

myapp/
|-- main.go
|-- models/
|   |-- models.go
|-- handlers/
|   |-- handlers.go
|-- tests/
|   |-- integration_test.go
|-- go.mod
|-- go.sum

1. 设置模型 (models/models.go)

使用 GORM 标签定义模型以进行数据库映射。

package models

import (
    "time"
    "gorm.io/gorm"
)

type User struct {
    ID        uint           `gorm:"primaryKey"`
    Name      string         `gorm:"not null"`
    Email     string         `gorm:"unique;not null"`
    CreatedAt time.Time
}

type Book struct {
    ID            uint           `gorm:"primaryKey"`
    Title         string         `gorm:"not null"`
    Author        string         `gorm:"not null"`
    PublishedDate time.Time      `gorm:"not null"`
}

type BorrowLog struct {
    ID         uint           `gorm:"primaryKey"`
    UserID     uint           `gorm:"not null"`
    BookID     uint           `gorm:"not null"`
    BorrowedAt time.Time      `gorm:"default:CURRENT_TIMESTAMP"`
    ReturnedAt *time.Time
}

2. 设置处理程序 (handlers/handlers.go)

使用 Gin 定义 CRUD 操作的路由和处理程序。

package handlers

import (
    "myapp/models"
    "net/http"

    "github.com/gin-gonic/gin"
    "gorm.io/gorm"
)

type Handler struct {
    DB *gorm.DB
}

func (h *Handler) CreateUser(c *gin.Context) {
    var user models.User
    if err := c.ShouldBindJSON(&user); err != nil {
        c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
        return
    }

    if err := h.DB.Create(&user).Error; err != nil {
        c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
        return
    }

    c.JSON(http.StatusCreated, user)
}

func (h *Handler) GetUser(c *gin.Context) {
    var user models.User
    if err := h.DB.First(&user, c.Param("id")).Error; err != nil {
        c.JSON(http.StatusNotFound, gin.H{"error": "User not found"})
        return
    }

    c.JSON(http.StatusOK, user)
}

func (h *Handler) UpdateUser(c *gin.Context) {
    var user models.User
    if err := h.DB.First(&user, c.Param("id")).Error; err != nil {
        c.JSON(http.StatusNotFound, gin.H{"error": "User not found"})
        return
    }

    if err := c.ShouldBindJSON(&user); err != nil {
        c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
        return
    }

    if err := h.DB.Save(&user).Error; err != nil {
        c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
        return
    }

    c.JSON(http.StatusOK, user)
}

func (h *Handler) DeleteUser(c *gin.Context) {
    if err := h.DB.Delete(&models.User{}, c.Param("id")).Error; err != nil {
        c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
        return
    }

    c.JSON(http.StatusOK, gin.H{"message": "User deleted"})
}

3. 主应用程序（main.go）

设置数据库连接和路由。

package main

import (
    "myapp/handlers"
    "myapp/models"
    "github.com/gin-gonic/gin"
    "gorm.io/driver/postgres"
    "gorm.io/gorm"
    "log"
    "os"
)

func main() {
    dsn := "host=localhost user=postgres password=yourpassword dbname=testdb port=5432 sslmode=disable"
    db, err := gorm.Open(postgres.Open(dsn), &gorm.Config{})
    if err != nil {
        log.Fatalf("failed to connect to database: %v", err)
    }

    // Auto migrate the models
    db.AutoMigrate(&models.User{}, &models.Book{}, &models.BorrowLog{})

    h := handlers.Handler{DB: db}

    r := gin.Default()

    r.POST("/users", h.CreateUser)
    r.GET("/users/:id", h.GetUser)
    r.PUT("/users/:id", h.UpdateUser)
    r.DELETE("/users/:id", h.DeleteUser)

    r.Run(":8080")
}

4.集成测试（tests/integration_test.go）

使用 Testify 设置和断言测试结果。

对于数据库，我们可以使用 Dockerized PostgreSQL 实例进行测试，该实例是隔离的，测试后可以快速拆除。以下是如何使用 testcontainers-go 在 Golang 中进行设置：

安装 testcontainers-go:

go get github.com/testcontainers/testcontainers-go

以下是integration_test.go 文件，用于设置用于测试的 PostgreSQL 容器：

myapp/
|-- main.go
|-- models/
|   |-- models.go
|-- handlers/
|   |-- handlers.go
|-- tests/
|   |-- integration_test.go
|-- go.mod
|-- go.sum

解释

• SetupTestDB：使用 GORM 设置 PostgreSQL 数据库连接进行测试。
• TestCreateUser：发送 POST 请求以创建新用户并断言响应。
• TestGetUser：通过 ID 检索用户并检查数据是否与插入的内容匹配。
• 测试更新用户：
  • 创建用户并使用 PUT /users/:id 端点更新它。
  • 断言响应状态为 200 OK。
  • 验证用户的详细信息是否已在响应中更新。
  • 从数据库中获取用户并确认更改已保留。
• 测试删除用户：
  • 创建用户并使用 DELETE /users/:id 端点删除它。
  • 断言响应状态为 200 OK 并检查是否有成功消息。
  • 尝试从数据库中获取已删除的用户以确保该用户不再存在，并断言 gorm.ErrRecordNotFound 错误。
• testcontainers-go：该库允许您直接从 Go 代码启动 Docker 容器。它非常适合创建临时 PostgreSQL 实例以进行集成测试。
• setupTestDB：此函数启动 PostgreSQL Docker 容器，使用 gorm 连接到它，并设置数据库架构。它还确保测试完成后容器得到清理。
• defer postgresC.Terminate(ctx)：确保 PostgreSQL 容器在测试完成后终止，模拟内存方法。
• 动态主机和端口：使用容器动态分配的主机和端口来连接数据库。

运行测试

使用以下命令运行测试：

myapp/
|-- main.go
|-- models/
|   |-- models.go
|-- handlers/
|   |-- handlers.go
|-- tests/
|   |-- integration_test.go
|-- go.mod
|-- go.sum

使用 testcontainers-go 的好处：

1. 隔离：每次测试运行都会获得一个新的 PostgreSQL 实例，确保测试之间不会发生数据泄漏。
2. 复制生产环境：针对真实的 PostgreSQL 实例进行测试可提供比使用内存数据库更可靠的结果。
3. 自动化：自动启动和停止 PostgreSQL 容器，使其易于在 CI/CD 管道中使用。

要点

• 使用测试数据库：使用单独的 PostgreSQL 数据库（例如：容器化数据库）进行测试是一个很好的做法，以避免影响生产数据。
• 设置和清理：确保在测试之间清理数据库以保持一致性。
• Testify：提供强大的断言方法来验证结果。
• Gin 的测试服务器：使用 httptest 模拟针对 Gin 服务器的 HTTP 请求。

通过此设置，您可以测试用户模型的 CRUD 操作，确保 API 按预期与 PostgreSQL 配合使用。您可以类似地对 Book 和 BorrowLog 模型扩展测试。

以上是Golang 与 Gin、Gorm、Testify、PostgreSQL 的集成测试的详细内容。更多信息请关注PHP中文网其他相关文章！