mirror of https://github.com/grafana/grafana.git
				
				
				
			
		
			
				
	
	
		
			88 lines
		
	
	
		
			2.6 KiB
		
	
	
	
		
			Go
		
	
	
	
			
		
		
	
	
			88 lines
		
	
	
		
			2.6 KiB
		
	
	
	
		
			Go
		
	
	
	
package middleware
 | 
						|
 | 
						|
import (
 | 
						|
	"path/filepath"
 | 
						|
	"strings"
 | 
						|
	"testing"
 | 
						|
 | 
						|
	"github.com/stretchr/testify/assert"
 | 
						|
	"github.com/stretchr/testify/require"
 | 
						|
 | 
						|
	"github.com/grafana/grafana/pkg/services/authn"
 | 
						|
	"github.com/grafana/grafana/pkg/services/authn/authntest"
 | 
						|
	contextmodel "github.com/grafana/grafana/pkg/services/contexthandler/model"
 | 
						|
	"github.com/grafana/grafana/pkg/services/licensing"
 | 
						|
	"github.com/grafana/grafana/pkg/services/user/usertest"
 | 
						|
	"github.com/grafana/grafana/pkg/setting"
 | 
						|
	"github.com/grafana/grafana/pkg/web"
 | 
						|
)
 | 
						|
 | 
						|
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 - test error", 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 *contextmodel.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"
 | 
						|
		cfg.UserFacingDefaultError = "test error"
 | 
						|
		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, &licensing.OSSLicensingService{}))
 | 
						|
 | 
						|
		sc.m.Use(AddDefaultResponseHeaders(cfg))
 | 
						|
		sc.m.UseMiddleware(web.Renderer(viewsPath, "[[", "]]"))
 | 
						|
 | 
						|
		contextHandler := getContextHandler(t, setting.NewCfg(), &authntest.FakeService{ExpectedIdentity: &authn.Identity{}})
 | 
						|
		sc.m.Use(contextHandler.Middleware)
 | 
						|
		// mock out gc goroutine
 | 
						|
		sc.m.Use(OrgRedirect(cfg, usertest.NewUserServiceFake()))
 | 
						|
 | 
						|
		sc.defaultHandler = func(c *contextmodel.ReqContext) {
 | 
						|
			sc.context = c
 | 
						|
			if sc.handlerFunc != nil {
 | 
						|
				sc.handlerFunc(sc.context)
 | 
						|
			}
 | 
						|
		}
 | 
						|
 | 
						|
		sc.m.Get(url, sc.defaultHandler)
 | 
						|
 | 
						|
		fn(t, sc)
 | 
						|
	})
 | 
						|
}
 |