middleware_test.go

package rux

import (
	"net/http"
	"testing"

	"github.com/gookit/goutil/testutil/assert"
)

func TestRouteMiddleware(t *testing.T) {
	r := New()
	is := assert.New(t)

	// add one middleware
	r.GET("/middle", func(c *Context) {
		c.WriteString("-O-")
	}, func(c *Context) {
		c.WriteString("a")
		c.Next()
		c.WriteString("b")
	})

	w := mockRequest(r, GET, "/middle", nil)
	is.Eq("a-O-b", w.Body.String())

	// add multi middleware
	r.GET("/middle2", func(c *Context) { // main handler
		c.WriteString("-O-")
	}, func(c *Context) { // middle 1
		c.WriteString("a")
		c.Next()
		c.WriteString("A")
	}, func(c *Context) { // middle 2
		c.WriteString("b")
		c.Next()
		c.WriteString("B")
	})
	// Call sequence: middle 1 -> middle 2 -> main handler -> middle 2 -> middle 1
	w = mockRequest(r, GET, "/middle2", nil)
	is.Eq("ab-O-BA", w.Body.String())

	// add multi middleware(don't call next)
	r.GET("/middle3", func(c *Context) { // main handler
		c.WriteString("-O-")
	}, func(c *Context) { // middle 1
		c.WriteString("a")
		// c.Next()
		c.WriteString("A")
	}, func(c *Context) { // middle 2
		c.WriteString("b")
		// c.Next()
		c.WriteString("B")
	})
	// Call sequence: middle 1 -> middle 2 -> main handler
	w = mockRequest(r, GET, "/middle3", nil)
	is.Eq("aAbB-O-", w.Body.String())

	// add middleware use method Use()
	route := r.GET("/middle4", func(c *Context) { // main handler
		c.WriteString("-O-")
	})
	route.Use(func(c *Context) { // middle 1
		c.WriteString("a")
		c.Next()
		c.WriteString("A")
	}, func(c *Context) { // middle 2
		c.WriteString("b")
		c.Next()
		c.WriteString("B")
	})
	// Call sequence: middle 1 -> middle 2 -> main handler -> middle 2 -> middle 1
	w = mockRequest(r, GET, "/middle4", nil)
	is.Eq("ab-O-BA", w.Body.String())
}

func TestContext_Abort(t *testing.T) {
	is := assert.New(t)
	r := New()

	// use middleware, will termination execution early by Abort()
	r.GET("/abort", func(c *Context) { // Will not execute
		c.WriteString("-O-")
	}, func(c *Context) {
		c.WriteString("a")
		// c.Next()
		c.Abort() // Will abort at the end of this middleware run
		c.WriteString("A")
	}, func(c *Context) { // Will not execute
		c.WriteString("b")
		c.Next()
		c.WriteString("B")
	})
	// Call sequence: middle 1
	w := mockRequest(r, GET, "/abort", nil)
	is.Eq("aA", w.Body.String())

	// use middleware, will termination execution early by AbortThen()
	r.GET("/abort1", func(c *Context) { // Will not execute
		c.WriteString("-O-")
	}, func(c *Context) {
		// Will abort at the end of this middleware run
		c.AbortThen().Redirect("/other", 302)
		c.WriteString("a")
		// c.Next()
		c.WriteString("A")
	}, func(c *Context) { // Will not execute
		c.WriteString("b")
		c.Next()
		c.WriteString("B")
	})
	// Call sequence: middle 1
	w = mockRequest(r, GET, "/abort1", nil)
	// body: <a href="/other">Found</a>.\n\naA
	is.NotEq("aA", w.Body.String())
	is.Eq(302, w.Code)

	// use middleware, will termination execution early by AbortWithStatus()
	r.GET("/abort2", func(c *Context) { // Will not execute
		c.WriteString("-O-")
	}, func(c *Context) {
		// Will abort at the end of this middleware run
		c.AbortWithStatus(404)
		c.WriteString("a")
		// c.Next()
		c.WriteString("A")
	}, func(c *Context) { // Will not execute
		c.WriteString("b")
		c.Next()
		c.WriteString("B")
	})
	// Call sequence: middle 1
	w = mockRequest(r, GET, "/abort2", nil)
	is.Eq("aA", w.Body.String())
	is.Eq(404, w.Code)
}

func TestGlobalMiddleware(t *testing.T) {
	is := assert.New(t)
	r := New()
	is.NotEmpty(r)

	r.Use(func(c *Context) {
		c.WriteString("z")
		c.Next()
		c.WriteString("Z")
	})

	// eg1: only global middles
	r.GET("/middle", func(c *Context) { // main handler
		c.WriteString("-O-")
	})
	w := mockRequest(r, GET, "/middle", nil)
	is.Eq("z-O-Z", w.Body.String())

	// eg2: global + route middle
	r.GET("/middle1", func(c *Context) { // main handler
		c.WriteString("-O-")
	}).Use(func(c *Context) {
		c.WriteString("b")
		c.Next()
		c.WriteString("B")
	})
	w = mockRequest(r, GET, "/middle1", nil)
	is.Eq("zb-O-BZ", w.Body.String())

	r.Group("/grp", func() {
		// eg3: global + group middles
		r.GET("/middle", func(c *Context) { // main handler
			c.WriteString("-O-")
		})

		// eg4: global + group + route middles
		r.GET("/middle1", func(c *Context) { // main handler
			c.WriteString("-O-")
		}).Use(func(c *Context) {
			c.WriteString("c")
			c.Next()
			c.WriteString("C")
		})
	}, func(c *Context) {
		c.WriteString("b")
		c.Next()
		c.WriteString("B")
	})
	w = mockRequest(r, GET, "/grp/middle", nil)
	is.Eq("zb-O-BZ", w.Body.String())
	w = mockRequest(r, GET, "/grp/middle1", nil)
	is.Eq("zbc-O-CBZ", w.Body.String())

}

func TestGroupMiddleware(t *testing.T) {
	is := assert.New(t)
	r := New()
	is.NotEmpty(r)

	r.Group("/g0", func() {
		// main handler
		r.GET("/m0", func(c *Context) {
			c.WriteString("-O-")
		})

		// main handler
		r.GET("/m1", func(c *Context) {
			c.WriteString("-O-")
		}, func(c *Context) {
			c.WriteString("a")
			c.Next()
			c.WriteString("A")
		})
	}, func(c *Context) {
		c.WriteString("x")
		c.Next()
		c.WriteString("X")
	})
	w := mockRequest(r, GET, "/g0/m0", nil)
	is.Eq("x-O-X", w.Body.String())

	w = mockRequest(r, GET, "/g0/m1", nil)
	is.Eq("xa-O-AX", w.Body.String())

	r.Group("/grp", func() {
		r.GET("/middle", func(c *Context) { // main handler
			c.WriteString("-O-")
		})

		r.GET("/middle1", func(c *Context) { // main handler
			c.WriteString("-O-")
		}).Use(func(c *Context) {
			c.WriteString("a")
			c.Next()
			c.WriteString("A")
		})

		// multi group level
		r.Group("/sub-grp", func() {
			r.GET("/middle", func(c *Context) { // main handler
				c.WriteString("-O-")
			})

			// main handler
			r.GET("/middle1", func(c *Context) {
				c.WriteString("-O-")
			}).Use(func(c *Context) {
				c.WriteString("a")
				c.Next()
				c.WriteString("A")
			})
		}, func(c *Context) {
			c.WriteString("x")
			c.Next()
			c.WriteString("X")
		})
	}, func(c *Context) {
		c.WriteString("z")
		c.Next()
		c.WriteString("Z")
	}, func(c *Context) {
		c.WriteString("y")
		c.Next()
		c.WriteString("Y")
	})
	w = mockRequest(r, GET, "/grp/middle", nil)
	is.Eq("zy-O-YZ", w.Body.String())
	w = mockRequest(r, GET, "/grp/middle1", nil)
	is.Eq("zya-O-AYZ", w.Body.String())
	w = mockRequest(r, GET, "/grp/sub-grp/middle", nil)
	is.Eq("zyx-O-XYZ", w.Body.String())
	w = mockRequest(r, GET, "/grp/sub-grp/middle1", nil)
	is.Eq("zyxa-O-AXYZ", w.Body.String())
}

func TestRouter_Use(t *testing.T) {
	is := assert.New(t)
	r := New()

	r.Use(func(c *Context) {
		c.WriteString("z")
		c.Next()
		c.WriteString("Z")
	})

	r.Group("/g0", func() {
		r.Use(func(c *Context) {
			c.WriteString("x")
			c.Next()
			c.WriteString("X")
		})

		// main handler
		r.GET("/m0", func(c *Context) {
			c.WriteString("-O-")
		})

		// main handler
		r.GET("/m1", func(c *Context) {
			c.WriteString("-O-")
		}, func(c *Context) {
			c.WriteString("a")
			c.Next()
			c.WriteString("A")
		})
	})

	r.Use(func(c *Context) {
		c.WriteString("y")
		c.Next()
		c.WriteString("Y")
	})

	is.Len(r.Handlers(), 2)

	w := mockRequest(r, GET, "/g0/m0", nil)
	is.Eq("zyx-O-XYZ", w.Body.String())

	w = mockRequest(r, GET, "/g0/m1", nil)
	is.Eq("zyxa-O-AXYZ", w.Body.String())
}

func TestWrapHTTPHandler(t *testing.T) {
	r := New()
	is := assert.New(t)
	gh := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		_, _ = w.Write([]byte("he"))
	})

	r.GET("/path", func(c *Context) {
		c.WriteString("o")
	}).Use(
		WrapH(gh),
		WrapHTTPHandler(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
			_, _ = w.Write([]byte("ll"))
		})))
	w := mockRequest(r, GET, "/path", nil)
	is.Eq("hello", w.Body.String())

	r.GET("/path1", func(c *Context) {
		c.WriteString("o")
	}).Use(
		WrapHF(gh),
		WrapHTTPHandlerFunc(func(w http.ResponseWriter, r *http.Request) {
			_, _ = w.Write([]byte("ll"))
		}))
	w = mockRequest(r, GET, "/path1", nil)
	is.Eq("hello", w.Body.String())
}

func TestHandlerFunc_ServeHTTP(t *testing.T) {
	ris := assert.New(t)
	hf := HandlerFunc(func(c *Context) {
		c.WriteString("hello, " + c.URL().Path)
	})

	w := mockRequest(hf, GET, "/path1", nil)
	ris.Eq("hello, /path1", w.Body.String())
}