Using test context in handlerfunc test

[madiganz]

I am trying to write tests around my handler functions and middleware functions, but the context is not being passed to the handlerfunc, and I am not sure why.

My code looks like this:

resp := httptest.NewRecorder()
gin.SetMode(gin.TestMode)
c, r := gin.CreateTestContext(resp)
c.Set("profile", "myfakeprofile")
r.GET("/test", func(c *gin.Context) {
    _, found := c.Get("profile")
    // found is always false    
    t.Log(found)
    c.Status(200)
})
c.Request, _ = http.NewRequest(http.MethodGet, "/test", nil)
r.ServeHTTP(resp, c.Request)

[thinkerou]

@madiganz please see https://github.com/gin-gonic/gin/blob/master/context_test.go#L179

IMPORTANT: the c' of _, found := c.Get("profile"is not thecofc, r := gin.CreateTestContext, so found is always false`.

[madiganz]

So based on that example, there is no way to do what I am trying to do, correct?

[thinkerou]

If you want to use Set/Get, you should read the example https://github.com/gin-gonic/gin#custom-middleware

[madiganz]

@thinkerou I understand how to use Set/`Get'. I just can't create a test for my middleware based on the first link you sent to me.

[sfro]

I am also interested in being able to test how an endpoint handles things that are in the context without doing fully fledged integration tests. After adding things to the context created by gin.CreateTestContext(), can the edited context then be injected into the engine? Or is it possible to define context stuff in another way so it isn't just a standard/empty context that is created in gin.CreateTestContext()?

[sfro]

After playing around a bit I worked it out:

resp := httptest.NewRecorder()
gin.SetMode(gin.TestMode)
c, r := gin.CreateTestContext(resp)

r.Use(func(c *gin.Context) {
	c.Set("profile", "myfakeprofile")
})

r.GET("/test", func(c *gin.Context) {
	_, found := c.Get("profile")
	// found is true
	t.Log(found)
	c.Status(200)
})
c.Request, _ = http.NewRequest(http.MethodGet, "/test", nil)
r.ServeHTTP(resp, c.Request)

[twocs]

I think that gin.CreateTestContext() is also useful to test the middleware in isolation without the involvement of the engine.

func MyHandlerFunc() gin.HandlerFunc {
	return func(c *gin.Context) {
		c.Set("profile", "myfakeprofile")
	}
}

func TestMyHandlerFunc(t *testing.T) {
	recorder := httptest.NewRecorder()
	ctx, _ := gin.CreateTestContext(recorder)
	MyHandlerFunc()(ctx)
        got := ctx.GetString("profile")
	t.Log(got) // "myfakeprofile"
}