Testing

How to write test case for Gin?

The net/http/httptest package is preferable way for HTTP testing.

  1. package main
  3. import "github.com/gin-gonic/gin"
  5. func setupRouter() *gin.Engine {
  6.     r := gin.Default()
  7.     r.GET("/ping", func(c *gin.Context) {
  8.         c.String(200, "pong")
  9.     })
  10.     return r
  11. }
  13. func main() {
  14.     r := setupRouter()
  15.     r.Run(":8080")
  16. }

Test for code example above:

  1. package main
  3. import (
  4.     "net/http"
  5.     "net/http/httptest"
  6.     "testing"
  8.     "github.com/stretchr/testify/assert"
  9. )
  11. func TestPingRoute(t *testing.T) {
  12.     router := setupRouter()
  14.     w := httptest.NewRecorder()
  15.     req, _ := http.NewRequest("GET", "/ping", nil)
  16.     router.ServeHTTP(w, req)
  18.     assert.Equal(t, 200, w.Code)
  19.     assert.Equal(t, "pong", w.Body.String())
  20. }

Last modified January 12, 2021 : Adjust testing index (#158) (e178d63)