mirror of
https://github.com/grafana/grafana.git
synced 2024-12-01 21:19:28 -06:00
534ece064b
* pkg/web: closure-style middlewares Switches the middleware execution model from web.Handlers in a slice to web.Middleware. Middlewares are temporarily kept in a slice to preserve ordering, but prior to execution they are applied, forming a giant call-stack, giving granular control over the execution flow. * pkg/middleware: adapt to web.Middleware * pkg/middleware/recovery: use c.Req over req c.Req gets updated by future handlers, while req stays static. The current recovery implementation needs this newer information * pkg/web: correct middleware ordering * pkg/webtest: adapt middleware * pkg/web/hack: set w and r onto web.Context By adopting std middlewares, it may happen they invoke next(w,r) without putting their modified w,r into the web.Context, leading old-style handlers to operate on outdated fields. pkg/web now takes care of this * pkg/middleware: selectively use future context * pkg/web: accept closure-style on Use() * webtest: Middleware testing adds a utility function to web/webtest to obtain a http.ResponseWriter, http.Request and http.Handler the same as a middleware that runs would receive * *: cleanup * pkg/web: don't wrap Middleware from Router * pkg/web: require chain to write response * *: remove temp files * webtest: don't require chain write * *: cleanup
87 lines
2.5 KiB
Go
87 lines
2.5 KiB
Go
package middleware
|
|
|
|
import (
|
|
"path/filepath"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/grafana/grafana/pkg/infra/remotecache"
|
|
"github.com/grafana/grafana/pkg/models"
|
|
"github.com/grafana/grafana/pkg/services/auth"
|
|
"github.com/grafana/grafana/pkg/setting"
|
|
"github.com/grafana/grafana/pkg/web"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func TestRecoveryMiddleware(t *testing.T) {
|
|
t.Run("Given an API route that panics", func(t *testing.T) {
|
|
apiURL := "/api/whatever"
|
|
recoveryScenario(t, "recovery middleware should return JSON", apiURL, func(t *testing.T, sc *scenarioContext) {
|
|
sc.handlerFunc = panicHandler
|
|
sc.fakeReq("GET", apiURL).exec()
|
|
sc.req.Header.Set("content-type", "application/json")
|
|
|
|
assert.Equal(t, 500, sc.resp.Code)
|
|
assert.Equal(t, "Internal Server Error - Check the Grafana server logs for the detailed error message.", sc.respJson["message"])
|
|
assert.True(t, strings.HasPrefix(sc.respJson["error"].(string), "Server Error"))
|
|
})
|
|
})
|
|
|
|
t.Run("Given a non-API route that panics", func(t *testing.T) {
|
|
apiURL := "/whatever"
|
|
recoveryScenario(t, "recovery middleware should return html", apiURL, func(t *testing.T, sc *scenarioContext) {
|
|
sc.handlerFunc = panicHandler
|
|
sc.fakeReq("GET", apiURL).exec()
|
|
|
|
assert.Equal(t, 500, sc.resp.Code)
|
|
assert.Equal(t, "text/html; charset=UTF-8", sc.resp.Header().Get("content-type"))
|
|
assert.Contains(t, sc.resp.Body.String(), "<title>Grafana - Error</title>")
|
|
})
|
|
})
|
|
}
|
|
|
|
func panicHandler(c *models.ReqContext) {
|
|
panic("Handler has panicked")
|
|
}
|
|
|
|
func recoveryScenario(t *testing.T, desc string, url string, fn scenarioFunc) {
|
|
t.Run(desc, func(t *testing.T) {
|
|
cfg := setting.NewCfg()
|
|
cfg.ErrTemplateName = "error-template"
|
|
sc := &scenarioContext{
|
|
t: t,
|
|
url: url,
|
|
cfg: cfg,
|
|
}
|
|
|
|
viewsPath, err := filepath.Abs("../../public/views")
|
|
require.NoError(t, err)
|
|
|
|
sc.m = web.New()
|
|
sc.m.UseMiddleware(Recovery(cfg))
|
|
|
|
sc.m.Use(AddDefaultResponseHeaders(cfg))
|
|
sc.m.UseMiddleware(web.Renderer(viewsPath, "[[", "]]"))
|
|
|
|
sc.userAuthTokenService = auth.NewFakeUserAuthTokenService()
|
|
sc.remoteCacheService = remotecache.NewFakeStore(t)
|
|
|
|
contextHandler := getContextHandler(t, nil, nil, nil, nil)
|
|
sc.m.Use(contextHandler.Middleware)
|
|
// mock out gc goroutine
|
|
sc.m.Use(OrgRedirect(cfg, sc.mockSQLStore))
|
|
|
|
sc.defaultHandler = func(c *models.ReqContext) {
|
|
sc.context = c
|
|
if sc.handlerFunc != nil {
|
|
sc.handlerFunc(sc.context)
|
|
}
|
|
}
|
|
|
|
sc.m.Get(url, sc.defaultHandler)
|
|
|
|
fn(t, sc)
|
|
})
|
|
}
|