Gin, Gorm, Testify, PostgreSQL을 사용한 Golang 통합 테스트

Gin, GORM, Testify 및 PostgreSQL을 사용하여 Golang에서 포괄적인 통합 테스트 설정을 생성하려면 테스트 데이터베이스 설정, CRUD 작업을 위한 테스트 작성, 어설션을 위한 Testify 사용이 포함됩니다. 시작하는 데 도움이 되는 단계별 가이드는 다음과 같습니다.

전제조건

• 설치하러 가기
• 도커 설치
• 라이브러리: 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

다음은 테스트용 PostgreSQL 컨테이너를 설정하는 Integration_test.go 파일입니다.

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의 테스트 서버: Gin 서버에 대한 HTTP 요청을 시뮬레이션하기 위해 httptest를 사용합니다.

이 설정을 사용하면 사용자 모델에 대한 CRUD 작업을 테스트하여 API가 PostgreSQL에서 예상대로 작동하는지 확인할 수 있습니다. Book 및 BorrowLog 모델에 대해서도 유사하게 테스트를 확장할 수 있습니다.

위 내용은 Gin, Gorm, Testify, PostgreSQL을 사용한 Golang 통합 테스트의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!