mirror of
https://github.com/grafana/grafana.git
synced 2025-01-09 23:53:25 -06:00
6dbe3b555f
Adding support for backend plugin client middlewares. This allows headers in outgoing backend plugin and HTTP requests to be modified using client middlewares. The following client middlewares added: Forward cookies: Will forward incoming HTTP request Cookies to outgoing plugins.Client and HTTP requests if the datasource has enabled forwarding of cookies (keepCookies). Forward OAuth token: Will set OAuth token headers on outgoing plugins.Client and HTTP requests if the datasource has enabled Forward OAuth Identity (oauthPassThru). Clear auth headers: Will clear any outgoing HTTP headers that was part of the incoming HTTP request and used when authenticating to Grafana. The current suggested way to register client middlewares is to have a separate package, pluginsintegration, responsible for bootstrap/instantiate the backend plugin client with middlewares and/or longer term bootstrap/instantiate plugin management. Fixes #54135 Related to #47734 Related to #57870 Related to #41623 Related to #57065
83 lines
2.8 KiB
Go
83 lines
2.8 KiB
Go
package httpclientprovider
|
|
|
|
import (
|
|
"net/http"
|
|
"testing"
|
|
|
|
"github.com/grafana/grafana-plugin-sdk-go/backend/httpclient"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func TestSetUserAgentMiddleware(t *testing.T) {
|
|
t.Run("Without user agent set should return next http.RoundTripper", func(t *testing.T) {
|
|
ctx := &testContext{}
|
|
finalRoundTripper := ctx.createRoundTripper("finalrt")
|
|
mw := SetUserAgentMiddleware("")
|
|
rt := mw.CreateMiddleware(httpclient.Options{}, finalRoundTripper)
|
|
require.NotNil(t, rt)
|
|
middlewareName, ok := mw.(httpclient.MiddlewareName)
|
|
require.True(t, ok)
|
|
require.Equal(t, SetUserAgentMiddlewareName, middlewareName.MiddlewareName())
|
|
|
|
req, err := http.NewRequest(http.MethodGet, "http://", nil)
|
|
require.NoError(t, err)
|
|
res, err := rt.RoundTrip(req)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, res)
|
|
if res.Body != nil {
|
|
require.NoError(t, res.Body.Close())
|
|
}
|
|
require.Len(t, ctx.callChain, 1)
|
|
require.ElementsMatch(t, []string{"finalrt"}, ctx.callChain)
|
|
})
|
|
|
|
t.Run("With user agent set should apply HTTP headers to the request", func(t *testing.T) {
|
|
ctx := &testContext{}
|
|
finalRoundTripper := ctx.createRoundTripper("final")
|
|
mw := SetUserAgentMiddleware("Grafana/8.0.0")
|
|
rt := mw.CreateMiddleware(httpclient.Options{}, finalRoundTripper)
|
|
require.NotNil(t, rt)
|
|
middlewareName, ok := mw.(httpclient.MiddlewareName)
|
|
require.True(t, ok)
|
|
require.Equal(t, SetUserAgentMiddlewareName, middlewareName.MiddlewareName())
|
|
|
|
req, err := http.NewRequest(http.MethodGet, "http://", nil)
|
|
require.NoError(t, err)
|
|
res, err := rt.RoundTrip(req)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, res)
|
|
if res.Body != nil {
|
|
require.NoError(t, res.Body.Close())
|
|
}
|
|
require.Len(t, ctx.callChain, 1)
|
|
require.ElementsMatch(t, []string{"final"}, ctx.callChain)
|
|
|
|
require.Equal(t, "Grafana/8.0.0", req.Header.Get("User-Agent"))
|
|
})
|
|
|
|
t.Run("With user agent set, but request already has User-Agent header set should not apply HTTP headers to the request", func(t *testing.T) {
|
|
ctx := &testContext{}
|
|
finalRoundTripper := ctx.createRoundTripper("final")
|
|
mw := SetUserAgentMiddleware("Grafana/8.0.0")
|
|
rt := mw.CreateMiddleware(httpclient.Options{}, finalRoundTripper)
|
|
require.NotNil(t, rt)
|
|
middlewareName, ok := mw.(httpclient.MiddlewareName)
|
|
require.True(t, ok)
|
|
require.Equal(t, SetUserAgentMiddlewareName, middlewareName.MiddlewareName())
|
|
|
|
req, err := http.NewRequest(http.MethodGet, "http://", nil)
|
|
require.NoError(t, err)
|
|
req.Header.Set("User-Agent", "ua")
|
|
res, err := rt.RoundTrip(req)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, res)
|
|
if res.Body != nil {
|
|
require.NoError(t, res.Body.Close())
|
|
}
|
|
require.Len(t, ctx.callChain, 1)
|
|
require.ElementsMatch(t, []string{"final"}, ctx.callChain)
|
|
|
|
require.Equal(t, "ua", req.Header.Get("User-Agent"))
|
|
})
|
|
}
|