Home Backend Development Golang Golang Integration Test With Gin, Gorm, Testify, PostgreSQL

Golang Integration Test With Gin, Gorm, Testify, PostgreSQL

Oct 26, 2024 pm 03:10 PM

Golang Integration Test With Gin, Gorm, Testify, PostgreSQL

Creating a comprehensive integration test setup in Golang with Gin, GORM, Testify, and PostgreSQL involves setting up a test database, writing tests for CRUD operations, and using Testify for assertions. Here’s a step-by-step guide to get you started:

Prerequisites

  • Go installed
  • Docker installed
  • Libraries: gin-gonic/gin, gorm.io/gorm, gorm.io/driver/postgres, testify, testcontainers-go

Project Structure

1

2

3

4

5

6

7

8

9

10

myapp/

|-- main.go

|-- models/

|   |-- models.go

|-- handlers/

|   |-- handlers.go

|-- tests/

|   |-- integration_test.go

|-- go.mod

|-- go.sum

Copy after login
Copy after login
Copy after login

1. Setup the Models (models/models.go)

Define the models with GORM tags for database mapping.

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

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

}

Copy after login

2. Setup Handlers (handlers/handlers.go)

Define the routes and handlers for CRUD operations using Gin.

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

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"})

}

Copy after login

3. Main Application (main.go)

Set up the database connection and routes.

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

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")

}

Copy after login

4. Integration Test (tests/integration_test.go)

Use Testify for setting up and asserting test results.

For database we can use a Dockerized PostgreSQL instance for testing purposes, which is isolated and can be quickly torn down after tests. Here’s how to set it up in Golang using testcontainers-go:

Install testcontainers-go:

1

go get github.com/testcontainers/testcontainers-go

Copy after login

Following is the integration_test.go file that sets up a PostgreSQL container for testing:

1

2

3

4

5

6

7

8

9

10

myapp/

|-- main.go

|-- models/

|   |-- models.go

|-- handlers/

|   |-- handlers.go

|-- tests/

|   |-- integration_test.go

|-- go.mod

|-- go.sum

Copy after login
Copy after login
Copy after login

Explanation

  • SetupTestDB: Sets up a PostgreSQL database connection using GORM for testing.
  • TestCreateUser: Sends a POST request to create a new user and asserts the response.
  • TestGetUser: Retrieves a user by ID and checks that the data matches what was inserted.
  • TestUpdateUser:
    • Creates a user and updates it using the PUT /users/:id endpoint.
    • Asserts that the response status is 200 OK.
    • Verifies that the user's details are updated in the response.
    • Fetches the user from the database and confirms that the changes are persisted.
  • TestDeleteUser:
    • Creates a user and deletes it using the DELETE /users/:id endpoint.
    • Asserts that the response status is 200 OK and checks for a success message.
    • Attempts to fetch the deleted user from the database to ensure the user no longer exists, asserting an error of gorm.ErrRecordNotFound.
  • testcontainers-go: This library allows you to spin up Docker containers directly from your Go code. It's ideal for creating a temporary PostgreSQL instance for integration tests.
  • setupTestDB: This function starts a PostgreSQL Docker container, connects to it using gorm, and sets up the database schema. It also ensures that the container is cleaned up after the tests are finished.
  • defer postgresC.Terminate(ctx): Ensures that the PostgreSQL container is terminated after tests are done, simulating an in-memory approach.
  • Dynamic Host and Port: Uses the container's dynamically allocated host and port for connecting to the database.

Running the Tests

Run the tests using:

1

2

3

4

5

6

7

8

9

10

myapp/

|-- main.go

|-- models/

|   |-- models.go

|-- handlers/

|   |-- handlers.go

|-- tests/

|   |-- integration_test.go

|-- go.mod

|-- go.sum

Copy after login
Copy after login
Copy after login
Benefits of Using testcontainers-go:
  1. Isolation: Each test run gets a fresh PostgreSQL instance, ensuring no data leakage between tests.
  2. Replicates Production Environment: Testing against a real PostgreSQL instance provides more reliable results than using an in-memory database.
  3. Automation: Automatically starts and stops the PostgreSQL container, making it easy to use in CI/CD pipelines.

Key Points

  • Using a Test Database: It's a good practice to use a separate PostgreSQL database (ex: containerized ones) for testing to avoid affecting production data.
  • Setup and Cleanup: Ensure to clean up the database between tests to maintain consistency.
  • Testify: Provides powerful assertion methods for validating the results.
  • Gin's Test Server: Uses httptest for simulating HTTP requests against the Gin server.

With this setup, you can test CRUD operations for a User model, ensuring the API works as expected with PostgreSQL. You can expand the tests similarly for Book and BorrowLog models.

The above is the detailed content of Golang Integration Test With Gin, Gorm, Testify, PostgreSQL. For more information, please follow other related articles on the PHP Chinese website!

Statement of this Website
The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn

Hot AI Tools

Undresser.AI Undress

Undresser.AI Undress

AI-powered app for creating realistic nude photos

AI Clothes Remover

AI Clothes Remover

Online AI tool for removing clothes from photos.

Undress AI Tool

Undress AI Tool

Undress images for free

Clothoff.io

Clothoff.io

AI clothes remover

Video Face Swap

Video Face Swap

Swap faces in any video effortlessly with our completely free AI face swap tool!

Hot Tools

Notepad++7.3.1

Notepad++7.3.1

Easy-to-use and free code editor

SublimeText3 Chinese version

SublimeText3 Chinese version

Chinese version, very easy to use

Zend Studio 13.0.1

Zend Studio 13.0.1

Powerful PHP integrated development environment

Dreamweaver CS6

Dreamweaver CS6

Visual web development tools

SublimeText3 Mac version

SublimeText3 Mac version

God-level code editing software (SublimeText3)

Hot Topics

Java Tutorial
1655
14
PHP Tutorial
1252
29
C# Tutorial
1226
24
Golang's Purpose: Building Efficient and Scalable Systems Golang's Purpose: Building Efficient and Scalable Systems Apr 09, 2025 pm 05:17 PM

Go language performs well in building efficient and scalable systems. Its advantages include: 1. High performance: compiled into machine code, fast running speed; 2. Concurrent programming: simplify multitasking through goroutines and channels; 3. Simplicity: concise syntax, reducing learning and maintenance costs; 4. Cross-platform: supports cross-platform compilation, easy deployment.

Golang and C  : Concurrency vs. Raw Speed Golang and C : Concurrency vs. Raw Speed Apr 21, 2025 am 12:16 AM

Golang is better than C in concurrency, while C is better than Golang in raw speed. 1) Golang achieves efficient concurrency through goroutine and channel, which is suitable for handling a large number of concurrent tasks. 2)C Through compiler optimization and standard library, it provides high performance close to hardware, suitable for applications that require extreme optimization.

Golang vs. Python: Key Differences and Similarities Golang vs. Python: Key Differences and Similarities Apr 17, 2025 am 12:15 AM

Golang and Python each have their own advantages: Golang is suitable for high performance and concurrent programming, while Python is suitable for data science and web development. Golang is known for its concurrency model and efficient performance, while Python is known for its concise syntax and rich library ecosystem.

Golang vs. Python: Performance and Scalability Golang vs. Python: Performance and Scalability Apr 19, 2025 am 12:18 AM

Golang is better than Python in terms of performance and scalability. 1) Golang's compilation-type characteristics and efficient concurrency model make it perform well in high concurrency scenarios. 2) Python, as an interpreted language, executes slowly, but can optimize performance through tools such as Cython.

The Performance Race: Golang vs. C The Performance Race: Golang vs. C Apr 16, 2025 am 12:07 AM

Golang and C each have their own advantages in performance competitions: 1) Golang is suitable for high concurrency and rapid development, and 2) C provides higher performance and fine-grained control. The selection should be based on project requirements and team technology stack.

Golang's Impact: Speed, Efficiency, and Simplicity Golang's Impact: Speed, Efficiency, and Simplicity Apr 14, 2025 am 12:11 AM

Goimpactsdevelopmentpositivelythroughspeed,efficiency,andsimplicity.1)Speed:Gocompilesquicklyandrunsefficiently,idealforlargeprojects.2)Efficiency:Itscomprehensivestandardlibraryreducesexternaldependencies,enhancingdevelopmentefficiency.3)Simplicity:

Golang and C  : The Trade-offs in Performance Golang and C : The Trade-offs in Performance Apr 17, 2025 am 12:18 AM

The performance differences between Golang and C are mainly reflected in memory management, compilation optimization and runtime efficiency. 1) Golang's garbage collection mechanism is convenient but may affect performance, 2) C's manual memory management and compiler optimization are more efficient in recursive computing.

C   and Golang: When Performance is Crucial C and Golang: When Performance is Crucial Apr 13, 2025 am 12:11 AM

C is more suitable for scenarios where direct control of hardware resources and high performance optimization is required, while Golang is more suitable for scenarios where rapid development and high concurrency processing are required. 1.C's advantage lies in its close to hardware characteristics and high optimization capabilities, which are suitable for high-performance needs such as game development. 2.Golang's advantage lies in its concise syntax and natural concurrency support, which is suitable for high concurrency service development.

See all articles