Gin-Gonic进行单元测试

时间:2019-12-05 00:36:35

标签: unit-testing go testing gin-gonic

我的项目分为三个主要部分:控制器,服务和模型。当通过URI查询路线时,将调用控制器,然后控制器调用服务与模型进行交互,然后模型通过gorm与数据库进行交互。

我正在尝试为控制器编写单元测试,但是在理解gin层时如何理解服务层方面存在困难。我可以获得模拟的gin上下文,但是无法模拟控制器方法中的服务层。下面是我的代码:

resourceController.go

package controllers

import (
    "MyApi/models"
    "MyApi/services"
    "github.com/gin-gonic/gin"
    "net/http"
)

func GetResourceById(c *gin.Context) {
    id := c.Param("id")
    resource, err := services.GetResourceById(id)

    if err != nil {
        c.JSON(http.StatusBadRequest, gin.H{"status": http.StatusBadRequest, "message": err})
        return
    } else if resource.ID == 0 {
        c.JSON(http.StatusNotFound, gin.H{"status": http.StatusNotFound, "message": "Resource with id:"+id+" does not exist"})
        return
    }

    c.JSON(http.StatusOK, gin.H{
        "id": resource.ID,
        "data1": resource.Data1,
        "data2": resource.Data2,
    })
}

我想测试c.JSON是否以正确的http状态和其他数据返回。我需要模拟id变量,err变量和c.JSON函数,但是当我尝试将测试中的c.JSON函数设置为新函数时,我得到了显示错误Cannot assign to c.JSON的错误。 以下是我编写测试的尝试:

resourceController_test.go

package controllers

import (
    "github.com/gin-gonic/gin"
    "github.com/stretchr/testify/assert"
    "net/http/httptest"
    "testing"
)

func TestGetResourceById(t *testing.T) {
    var status int
    var body interface{}
    c, _ := gin.CreateTestContext(httptest.NewRecorder())
    c.JSON = func(stat int, object interface{}) {
        status = stat
        body = object
    }
    GetResourceById(c)
    assert.Equal(t, 4, 4)
}

如何正确编写单元测试以测试c.JSON是否返回正确的值?

1 个答案:

答案 0 :(得分:0)

您无法在Go中修改类型的方法。它由在编译时定义类型的包定义且不可改变。这是Go的设计决定。根本不做。

您已经使用httptest.NewRecorder()作为gin.Context.ResponseWriter的模拟,它将记录写入响应中的内容,包括c.JSON调用。但是,您需要保留httptest.ReponseRecorder的引用,然后再进行检查。请注意,您只有编组的JSON,因此您需要取消编组以检查内容(因为Go map和JSON对象的顺序都无关紧要,检查编组的字符串的相等性容易出错)。

例如,

func TestGetResourceById(t *testing.T) {
    w := httptest.NewRecorder()
    c, _ := gin.CreateTestContext(w)
    GetResourceById(c)
    assert.Equal(t, 200, w.Status) // or what value you need it to be

    var got gin.H
    err := json.Unmarshal(&got, w.Body().Bytes())
    if err != nil {
        t.Fatal(err)
    }
    assert.Equal(t, want, got) // want is a gin.H that contains the wanted map.
}