mirror of https://github.com/grafana/grafana
Prometheus: Remove cache, pass headers in request, simplify client creation for resource calls and custom client (#51436)
* Remove cache, pass headers in request, simplify client creation * Add test for http options creationpull/51694/head
Andrej Ocenas
3 years ago
committed by
GitHub
parent
b7e22c37a8
commit
3df34fe064
@ -0,0 +1,27 @@ |
||||
package buffered |
||||
|
||||
import ( |
||||
"testing" |
||||
|
||||
"github.com/grafana/grafana-azure-sdk-go/azsettings" |
||||
"github.com/grafana/grafana-plugin-sdk-go/backend" |
||||
"github.com/grafana/grafana/pkg/infra/log/logtest" |
||||
"github.com/grafana/grafana/pkg/services/featuremgmt" |
||||
"github.com/stretchr/testify/require" |
||||
) |
||||
|
||||
func TestCreateTransportOptions(t *testing.T) { |
||||
t.Run("creates correct options object", func(t *testing.T) { |
||||
settings := backend.DataSourceInstanceSettings{ |
||||
BasicAuthEnabled: false, |
||||
BasicAuthUser: "", |
||||
JSONData: []byte(`{"httpHeaderName1": "foo"}`), |
||||
DecryptedSecureJSONData: map[string]string{ |
||||
"httpHeaderValue1": "bar", |
||||
}, |
||||
} |
||||
opts, err := CreateTransportOptions(settings, &azsettings.AzureSettings{}, featuremgmt.WithFeatures(), &logtest.Fake{}) |
||||
require.NoError(t, err) |
||||
require.Equal(t, map[string]string{"foo": "bar"}, opts.Headers) |
||||
}) |
||||
} |
||||
@ -1,55 +0,0 @@ |
||||
package client |
||||
|
||||
import ( |
||||
"sort" |
||||
"strings" |
||||
|
||||
lru "github.com/hashicorp/golang-lru" |
||||
) |
||||
|
||||
type ProviderCache struct { |
||||
provider promClientProvider |
||||
cache *lru.Cache |
||||
} |
||||
|
||||
type promClientProvider interface { |
||||
GetClient(map[string]string) (*Client, error) |
||||
} |
||||
|
||||
func NewProviderCache(p promClientProvider) (*ProviderCache, error) { |
||||
cache, err := lru.New(500) |
||||
if err != nil { |
||||
return nil, err |
||||
} |
||||
|
||||
return &ProviderCache{ |
||||
provider: p, |
||||
cache: cache, |
||||
}, nil |
||||
} |
||||
|
||||
func (c *ProviderCache) GetClient(headers map[string]string) (*Client, error) { |
||||
key := c.key(headers) |
||||
if client, ok := c.cache.Get(key); ok { |
||||
return client.(*Client), nil |
||||
} |
||||
|
||||
client, err := c.provider.GetClient(headers) |
||||
if err != nil { |
||||
return nil, err |
||||
} |
||||
|
||||
c.cache.Add(key, client) |
||||
return client, nil |
||||
} |
||||
|
||||
func (c *ProviderCache) key(headers map[string]string) string { |
||||
vals := make([]string, len(headers)) |
||||
var i int |
||||
for _, v := range headers { |
||||
vals[i] = v |
||||
i++ |
||||
} |
||||
sort.Strings(vals) |
||||
return strings.Join(vals, "") |
||||
} |
||||
@ -1,135 +0,0 @@ |
||||
package client_test |
||||
|
||||
import ( |
||||
"errors" |
||||
"io/ioutil" |
||||
"net/http" |
||||
"sort" |
||||
"strings" |
||||
"testing" |
||||
|
||||
"github.com/grafana/grafana/pkg/tsdb/prometheus/client" |
||||
|
||||
"github.com/stretchr/testify/require" |
||||
) |
||||
|
||||
func TestCache_GetClient(t *testing.T) { |
||||
t.Run("it caches the client for a set of auth headers", func(t *testing.T) { |
||||
tc := setupCacheContext() |
||||
|
||||
c, err := tc.providerCache.GetClient(headers) |
||||
require.Nil(t, err) |
||||
|
||||
c2, err := tc.providerCache.GetClient(headers) |
||||
require.Nil(t, err) |
||||
|
||||
require.Equal(t, c, c2) |
||||
require.Equal(t, 1, tc.clientProvider.numCalls) |
||||
}) |
||||
|
||||
t.Run("it returns different clients when the headers differ", func(t *testing.T) { |
||||
tc := setupCacheContext() |
||||
h1 := map[string]string{"Authorization": "token", "X-ID-Token": "id-token"} |
||||
h2 := map[string]string{"Authorization": "token2", "X-ID-Token": "id-token"} |
||||
|
||||
c, err := tc.providerCache.GetClient(h1) |
||||
require.Nil(t, err) |
||||
|
||||
c2, err := tc.providerCache.GetClient(h2) |
||||
require.Nil(t, err) |
||||
|
||||
require.NotEqual(t, c, c2) |
||||
require.Equal(t, 2, tc.clientProvider.numCalls) |
||||
}) |
||||
|
||||
t.Run("it returns from the cache when headers are the same", func(t *testing.T) { |
||||
tc := setupCacheContext() |
||||
h1 := map[string]string{"Authorization": "token", "X-ID-Token": "id-token"} |
||||
h2 := map[string]string{"Authorization": "token", "X-ID-Token": "id-token"} |
||||
|
||||
c, err := tc.providerCache.GetClient(h1) |
||||
require.Nil(t, err) |
||||
|
||||
c2, err := tc.providerCache.GetClient(h2) |
||||
require.Nil(t, err) |
||||
|
||||
require.Equal(t, c, c2) |
||||
require.Equal(t, 1, tc.clientProvider.numCalls) |
||||
}) |
||||
|
||||
t.Run("it doesn't cache anything when an error occurs", func(t *testing.T) { |
||||
tc := setupCacheContext() |
||||
tc.clientProvider.errors <- errors.New("something bad") |
||||
|
||||
_, err := tc.providerCache.GetClient(headers) |
||||
require.EqualError(t, err, "something bad") |
||||
|
||||
c, err := tc.providerCache.GetClient(headers) |
||||
require.Nil(t, err) |
||||
|
||||
require.NotNil(t, c) |
||||
require.Equal(t, 2, tc.clientProvider.numCalls) |
||||
}) |
||||
} |
||||
|
||||
type cacheTestContext struct { |
||||
providerCache *client.ProviderCache |
||||
clientProvider *fakeClientProvider |
||||
} |
||||
|
||||
func setupCacheContext() *cacheTestContext { |
||||
fp := newFakePromClientProvider() |
||||
p, err := client.NewProviderCache(fp) |
||||
if err != nil { |
||||
panic(err) |
||||
} |
||||
|
||||
return &cacheTestContext{ |
||||
providerCache: p, |
||||
clientProvider: fp, |
||||
} |
||||
} |
||||
|
||||
func newFakePromClientProvider() *fakeClientProvider { |
||||
return &fakeClientProvider{ |
||||
errors: make(chan error, 1), |
||||
} |
||||
} |
||||
|
||||
type fakeClientProvider struct { |
||||
headers map[string]string |
||||
numCalls int |
||||
errors chan error |
||||
} |
||||
|
||||
func (p *fakeClientProvider) GetClient(h map[string]string) (*client.Client, error) { |
||||
p.headers = h |
||||
p.numCalls++ |
||||
|
||||
var err error |
||||
select { |
||||
case err = <-p.errors: |
||||
default: |
||||
} |
||||
|
||||
var config []string |
||||
for _, v := range h { |
||||
config = append(config, v) |
||||
} |
||||
sort.Strings(config) //because map
|
||||
res := &http.Response{ |
||||
StatusCode: 200, |
||||
Header: http.Header{}, |
||||
Body: ioutil.NopCloser(strings.NewReader(strings.Join(config, ","))), |
||||
} |
||||
c := &fakeClient{res: res} |
||||
return client.NewClient(c, "GET", "http://localhost:9090/"), err |
||||
} |
||||
|
||||
type fakeClient struct { |
||||
res *http.Response |
||||
} |
||||
|
||||
func (c *fakeClient) Do(req *http.Request) (*http.Response, error) { |
||||
return c.res, nil |
||||
} |
||||
@ -1,93 +0,0 @@ |
||||
package client |
||||
|
||||
import ( |
||||
"net/http" |
||||
|
||||
"github.com/grafana/grafana-plugin-sdk-go/backend" |
||||
"github.com/grafana/grafana/pkg/services/featuremgmt" |
||||
"github.com/grafana/grafana/pkg/setting" |
||||
"github.com/grafana/grafana/pkg/tsdb/prometheus/middleware" |
||||
"github.com/grafana/grafana/pkg/util/maputil" |
||||
|
||||
sdkhttpclient "github.com/grafana/grafana-plugin-sdk-go/backend/httpclient" |
||||
"github.com/grafana/grafana/pkg/infra/httpclient" |
||||
"github.com/grafana/grafana/pkg/infra/log" |
||||
) |
||||
|
||||
type Provider struct { |
||||
settings backend.DataSourceInstanceSettings |
||||
jsonData map[string]interface{} |
||||
httpMethod string |
||||
clientProvider httpclient.Provider |
||||
cfg *setting.Cfg |
||||
features featuremgmt.FeatureToggles |
||||
log log.Logger |
||||
} |
||||
|
||||
func NewProvider( |
||||
settings backend.DataSourceInstanceSettings, |
||||
jsonData map[string]interface{}, |
||||
clientProvider httpclient.Provider, |
||||
cfg *setting.Cfg, |
||||
features featuremgmt.FeatureToggles, |
||||
log log.Logger, |
||||
) *Provider { |
||||
httpMethod, _ := maputil.GetStringOptional(jsonData, "httpMethod") |
||||
if httpMethod == "" { |
||||
httpMethod = http.MethodPost |
||||
} |
||||
return &Provider{ |
||||
settings: settings, |
||||
jsonData: jsonData, |
||||
httpMethod: httpMethod, |
||||
clientProvider: clientProvider, |
||||
cfg: cfg, |
||||
features: features, |
||||
log: log, |
||||
} |
||||
} |
||||
|
||||
func (p *Provider) GetClient(headers map[string]string) (*Client, error) { |
||||
opts, err := p.settings.HTTPClientOptions() |
||||
if err != nil { |
||||
return nil, err |
||||
} |
||||
|
||||
opts.Middlewares = p.middlewares() |
||||
opts.Headers = reqHeaders(headers) |
||||
|
||||
// Set SigV4 service namespace
|
||||
if opts.SigV4 != nil { |
||||
opts.SigV4.Service = "aps" |
||||
} |
||||
|
||||
// Azure authentication
|
||||
err = p.configureAzureAuthentication(&opts) |
||||
if err != nil { |
||||
return nil, err |
||||
} |
||||
|
||||
httpClient, err := p.clientProvider.New(opts) |
||||
if err != nil { |
||||
return nil, err |
||||
} |
||||
|
||||
return NewClient(httpClient, p.httpMethod, p.settings.URL), nil |
||||
} |
||||
|
||||
func (p *Provider) middlewares() []sdkhttpclient.Middleware { |
||||
middlewares := []sdkhttpclient.Middleware{ |
||||
middleware.CustomQueryParameters(p.log), |
||||
sdkhttpclient.CustomHeadersMiddleware(), |
||||
} |
||||
return middlewares |
||||
} |
||||
|
||||
func reqHeaders(headers map[string]string) map[string]string { |
||||
// copy to avoid changing the original map
|
||||
h := make(map[string]string, len(headers)) |
||||
for k, v := range headers { |
||||
h[k] = v |
||||
} |
||||
return h |
||||
} |
||||
@ -1,113 +0,0 @@ |
||||
package client |
||||
|
||||
import ( |
||||
"fmt" |
||||
"net/url" |
||||
"path" |
||||
|
||||
"github.com/grafana/grafana-azure-sdk-go/azcredentials" |
||||
"github.com/grafana/grafana-azure-sdk-go/azhttpclient" |
||||
"github.com/grafana/grafana-azure-sdk-go/azsettings" |
||||
sdkhttpclient "github.com/grafana/grafana-plugin-sdk-go/backend/httpclient" |
||||
|
||||
"github.com/grafana/grafana/pkg/services/featuremgmt" |
||||
"github.com/grafana/grafana/pkg/util/maputil" |
||||
) |
||||
|
||||
var ( |
||||
azurePrometheusScopes = map[string][]string{ |
||||
azsettings.AzurePublic: {"https://prometheus.monitor.azure.com/.default"}, |
||||
azsettings.AzureChina: {"https://prometheus.monitor.chinacloudapp.cn/.default"}, |
||||
azsettings.AzureUSGovernment: {"https://prometheus.monitor.usgovcloudapi.net/.default"}, |
||||
} |
||||
) |
||||
|
||||
func (p *Provider) configureAzureAuthentication(opts *sdkhttpclient.Options) error { |
||||
// Azure authentication is experimental (#35857)
|
||||
if !p.features.IsEnabled(featuremgmt.FlagPrometheusAzureAuth) { |
||||
return nil |
||||
} |
||||
|
||||
credentials, err := azcredentials.FromDatasourceData(p.jsonData, p.settings.DecryptedSecureJSONData) |
||||
if err != nil { |
||||
err = fmt.Errorf("invalid Azure credentials: %w", err) |
||||
return err |
||||
} |
||||
|
||||
if credentials != nil { |
||||
var scopes []string |
||||
|
||||
if scopes, err = getOverriddenScopes(p.jsonData); err != nil { |
||||
return err |
||||
} |
||||
|
||||
if scopes == nil { |
||||
if scopes, err = getPrometheusScopes(p.cfg.Azure, credentials); err != nil { |
||||
return err |
||||
} |
||||
} |
||||
|
||||
azhttpclient.AddAzureAuthentication(opts, p.cfg.Azure, credentials, scopes) |
||||
} |
||||
|
||||
return nil |
||||
} |
||||
|
||||
func getOverriddenScopes(jsonData map[string]interface{}) ([]string, error) { |
||||
resourceIdStr, err := maputil.GetStringOptional(jsonData, "azureEndpointResourceId") |
||||
if err != nil { |
||||
err = fmt.Errorf("overridden resource ID (audience) invalid") |
||||
return nil, err |
||||
} else if resourceIdStr == "" { |
||||
return nil, nil |
||||
} |
||||
|
||||
resourceId, err := url.Parse(resourceIdStr) |
||||
if err != nil || resourceId.Scheme == "" || resourceId.Host == "" { |
||||
err = fmt.Errorf("overridden endpoint resource ID (audience) '%s' invalid", resourceIdStr) |
||||
return nil, err |
||||
} |
||||
|
||||
resourceId.Path = path.Join(resourceId.Path, ".default") |
||||
scopes := []string{resourceId.String()} |
||||
return scopes, nil |
||||
} |
||||
|
||||
func getPrometheusScopes(settings *azsettings.AzureSettings, credentials azcredentials.AzureCredentials) ([]string, error) { |
||||
// Extract cloud from credentials
|
||||
azureCloud, err := getAzureCloudFromCredentials(settings, credentials) |
||||
if err != nil { |
||||
return nil, err |
||||
} |
||||
|
||||
// Get scopes for the given cloud
|
||||
if scopes, ok := azurePrometheusScopes[azureCloud]; !ok { |
||||
err := fmt.Errorf("the Azure cloud '%s' not supported by Prometheus datasource", azureCloud) |
||||
return nil, err |
||||
} else { |
||||
return scopes, nil |
||||
} |
||||
} |
||||
|
||||
// To be part of grafana-azure-sdk-go
|
||||
func getAzureCloudFromCredentials(settings *azsettings.AzureSettings, credentials azcredentials.AzureCredentials) (string, error) { |
||||
switch c := credentials.(type) { |
||||
case *azcredentials.AzureManagedIdentityCredentials: |
||||
// In case of managed identity, the cloud is always same as where Grafana is hosted
|
||||
return getDefaultAzureCloud(settings), nil |
||||
case *azcredentials.AzureClientSecretCredentials: |
||||
return c.AzureCloud, nil |
||||
default: |
||||
err := fmt.Errorf("the Azure credentials of type '%s' not supported by Prometheus datasource", c.AzureAuthType()) |
||||
return "", err |
||||
} |
||||
} |
||||
|
||||
// To be part of grafana-azure-sdk-go
|
||||
func getDefaultAzureCloud(settings *azsettings.AzureSettings) string { |
||||
cloudName := settings.Cloud |
||||
if cloudName == "" { |
||||
return azsettings.AzurePublic |
||||
} |
||||
return cloudName |
||||
} |
||||
@ -1,153 +0,0 @@ |
||||
package client |
||||
|
||||
import ( |
||||
"testing" |
||||
|
||||
"github.com/grafana/grafana-azure-sdk-go/azsettings" |
||||
"github.com/grafana/grafana-plugin-sdk-go/backend" |
||||
sdkhttpclient "github.com/grafana/grafana-plugin-sdk-go/backend/httpclient" |
||||
|
||||
"github.com/grafana/grafana/pkg/services/featuremgmt" |
||||
"github.com/grafana/grafana/pkg/setting" |
||||
"github.com/stretchr/testify/assert" |
||||
"github.com/stretchr/testify/require" |
||||
) |
||||
|
||||
func TestConfigureAzureAuthentication(t *testing.T) { |
||||
cfg := &setting.Cfg{ |
||||
Azure: &azsettings.AzureSettings{}, |
||||
} |
||||
settings := backend.DataSourceInstanceSettings{} |
||||
|
||||
t.Run("given feature flag enabled", func(t *testing.T) { |
||||
features := featuremgmt.WithFeatures(featuremgmt.FlagPrometheusAzureAuth) |
||||
|
||||
t.Run("should set Azure middleware when JsonData contains valid credentials", func(t *testing.T) { |
||||
jsonData := map[string]interface{}{ |
||||
"httpMethod": "POST", |
||||
"azureCredentials": map[string]interface{}{ |
||||
"authType": "msi", |
||||
}, |
||||
} |
||||
|
||||
var p = NewProvider(settings, jsonData, nil, cfg, features, nil) |
||||
|
||||
var opts = &sdkhttpclient.Options{CustomOptions: map[string]interface{}{}} |
||||
|
||||
err := p.configureAzureAuthentication(opts) |
||||
require.NoError(t, err) |
||||
|
||||
require.NotNil(t, opts.Middlewares) |
||||
assert.Len(t, opts.Middlewares, 1) |
||||
}) |
||||
|
||||
t.Run("should not set Azure middleware when JsonData doesn't contain valid credentials", func(t *testing.T) { |
||||
jsonData := map[string]interface{}{ |
||||
"httpMethod": "POST", |
||||
} |
||||
|
||||
var p = NewProvider(settings, jsonData, nil, cfg, features, nil) |
||||
|
||||
var opts = &sdkhttpclient.Options{CustomOptions: map[string]interface{}{}} |
||||
|
||||
err := p.configureAzureAuthentication(opts) |
||||
require.NoError(t, err) |
||||
|
||||
assert.NotContains(t, opts.CustomOptions, "_azureCredentials") |
||||
}) |
||||
|
||||
t.Run("should return error when JsonData contains invalid credentials", func(t *testing.T) { |
||||
jsonData := map[string]interface{}{ |
||||
"httpMethod": "POST", |
||||
"azureCredentials": "invalid", |
||||
} |
||||
|
||||
var p = NewProvider(settings, jsonData, nil, cfg, features, nil) |
||||
|
||||
var opts = &sdkhttpclient.Options{CustomOptions: map[string]interface{}{}} |
||||
|
||||
err := p.configureAzureAuthentication(opts) |
||||
assert.Error(t, err) |
||||
}) |
||||
|
||||
t.Run("should set Azure middleware when JsonData contains credentials and valid audience", func(t *testing.T) { |
||||
jsonData := map[string]interface{}{ |
||||
"httpMethod": "POST", |
||||
"azureCredentials": map[string]interface{}{ |
||||
"authType": "msi", |
||||
}, |
||||
"azureEndpointResourceId": "https://api.example.com/abd5c4ce-ca73-41e9-9cb2-bed39aa2adb5", |
||||
} |
||||
|
||||
var p = NewProvider(settings, jsonData, nil, cfg, features, nil) |
||||
|
||||
var opts = &sdkhttpclient.Options{CustomOptions: map[string]interface{}{}} |
||||
|
||||
err := p.configureAzureAuthentication(opts) |
||||
require.NoError(t, err) |
||||
|
||||
require.NotNil(t, opts.Middlewares) |
||||
assert.Len(t, opts.Middlewares, 1) |
||||
}) |
||||
|
||||
t.Run("should not set Azure middleware when JsonData doesn't contain credentials", func(t *testing.T) { |
||||
jsonData := map[string]interface{}{ |
||||
"httpMethod": "POST", |
||||
"azureEndpointResourceId": "https://api.example.com/abd5c4ce-ca73-41e9-9cb2-bed39aa2adb5", |
||||
} |
||||
|
||||
var p = NewProvider(settings, jsonData, nil, cfg, features, nil) |
||||
|
||||
var opts = &sdkhttpclient.Options{CustomOptions: map[string]interface{}{}} |
||||
|
||||
err := p.configureAzureAuthentication(opts) |
||||
require.NoError(t, err) |
||||
|
||||
if opts.Middlewares != nil { |
||||
assert.Len(t, opts.Middlewares, 0) |
||||
} |
||||
}) |
||||
|
||||
t.Run("should return error when JsonData contains invalid audience", func(t *testing.T) { |
||||
jsonData := map[string]interface{}{ |
||||
"httpMethod": "POST", |
||||
"azureCredentials": map[string]interface{}{ |
||||
"authType": "msi", |
||||
}, |
||||
"azureEndpointResourceId": "invalid", |
||||
} |
||||
|
||||
var p = NewProvider(settings, jsonData, nil, cfg, features, nil) |
||||
|
||||
var opts = &sdkhttpclient.Options{CustomOptions: map[string]interface{}{}} |
||||
|
||||
err := p.configureAzureAuthentication(opts) |
||||
assert.Error(t, err) |
||||
}) |
||||
}) |
||||
|
||||
t.Run("given feature flag not enabled", func(t *testing.T) { |
||||
features := featuremgmt.WithFeatures() |
||||
|
||||
t.Run("should not set Azure Credentials even when JsonData contains credentials", func(t *testing.T) { |
||||
jsonData := map[string]interface{}{ |
||||
"httpMethod": "POST", |
||||
"azureCredentials": map[string]interface{}{ |
||||
"authType": "msi", |
||||
}, |
||||
"azureEndpointResourceId": "https://api.example.com/abd5c4ce-ca73-41e9-9cb2-bed39aa2adb5", |
||||
} |
||||
|
||||
var p = NewProvider(settings, jsonData, nil, cfg, features, nil) |
||||
|
||||
var opts = &sdkhttpclient.Options{CustomOptions: map[string]interface{}{}} |
||||
|
||||
err := p.configureAzureAuthentication(opts) |
||||
require.NoError(t, err) |
||||
|
||||
if opts.Middlewares != nil { |
||||
assert.Len(t, opts.Middlewares, 0) |
||||
} |
||||
}) |
||||
}) |
||||
} |
||||
@ -1,125 +0,0 @@ |
||||
package client_test |
||||
|
||||
import ( |
||||
"encoding/json" |
||||
"net/http" |
||||
"testing" |
||||
|
||||
"github.com/grafana/grafana-plugin-sdk-go/backend" |
||||
sdkhttpclient "github.com/grafana/grafana-plugin-sdk-go/backend/httpclient" |
||||
"github.com/grafana/grafana/pkg/infra/httpclient" |
||||
"github.com/grafana/grafana/pkg/services/featuremgmt" |
||||
"github.com/grafana/grafana/pkg/setting" |
||||
"github.com/grafana/grafana/pkg/tsdb/prometheus/client" |
||||
|
||||
"github.com/stretchr/testify/require" |
||||
) |
||||
|
||||
var headers = map[string]string{"Authorization": "token", "X-ID-Token": "id-token"} |
||||
|
||||
func TestGetClient(t *testing.T) { |
||||
t.Run("it sets the SigV4 service if it exists", func(t *testing.T) { |
||||
tc := setup(`{"sigV4Auth":true}`) |
||||
|
||||
setting.SigV4AuthEnabled = true |
||||
defer func() { setting.SigV4AuthEnabled = false }() |
||||
|
||||
_, err := tc.clientProvider.GetClient(headers) |
||||
require.Nil(t, err) |
||||
|
||||
require.Equal(t, "aps", tc.httpProvider.opts.SigV4.Service) |
||||
}) |
||||
|
||||
t.Run("it always uses the custom params and custom headers middlewares", func(t *testing.T) { |
||||
tc := setup() |
||||
|
||||
_, err := tc.clientProvider.GetClient(headers) |
||||
require.Nil(t, err) |
||||
|
||||
require.Len(t, tc.httpProvider.middlewares(), 2) |
||||
require.Contains(t, tc.httpProvider.middlewares(), "prom-custom-query-parameters") |
||||
require.Contains(t, tc.httpProvider.middlewares(), "CustomHeaders") |
||||
}) |
||||
|
||||
t.Run("extra headers", func(t *testing.T) { |
||||
t.Run("it sets the headers when 'oauthPassThru' is true and auth headers are passed", func(t *testing.T) { |
||||
tc := setup(`{"oauthPassThru":true}`) |
||||
_, err := tc.clientProvider.GetClient(headers) |
||||
require.Nil(t, err) |
||||
|
||||
require.Equal(t, headers, tc.httpProvider.opts.Headers) |
||||
}) |
||||
|
||||
t.Run("it sets all headers", func(t *testing.T) { |
||||
withNonAuth := map[string]string{"X-Not-Auth": "stuff"} |
||||
|
||||
tc := setup(`{"oauthPassThru":true}`) |
||||
_, err := tc.clientProvider.GetClient(withNonAuth) |
||||
require.Nil(t, err) |
||||
|
||||
require.Equal(t, map[string]string{"X-Not-Auth": "stuff"}, tc.httpProvider.opts.Headers) |
||||
}) |
||||
|
||||
t.Run("it does not error when headers are nil", func(t *testing.T) { |
||||
tc := setup(`{"oauthPassThru":true}`) |
||||
|
||||
_, err := tc.clientProvider.GetClient(nil) |
||||
require.Nil(t, err) |
||||
}) |
||||
}) |
||||
} |
||||
|
||||
func setup(jsonData ...string) *testContext { |
||||
var rawData []byte |
||||
if len(jsonData) > 0 { |
||||
rawData = []byte(jsonData[0]) |
||||
} |
||||
|
||||
var jd map[string]interface{} |
||||
_ = json.Unmarshal(rawData, &jd) |
||||
|
||||
cfg := &setting.Cfg{} |
||||
settings := backend.DataSourceInstanceSettings{URL: "test-url", JSONData: rawData} |
||||
features := featuremgmt.WithFeatures() |
||||
hp := &fakeHttpClientProvider{} |
||||
p := client.NewProvider(settings, jd, hp, cfg, features, nil) |
||||
|
||||
return &testContext{ |
||||
httpProvider: hp, |
||||
clientProvider: p, |
||||
} |
||||
} |
||||
|
||||
type testContext struct { |
||||
httpProvider *fakeHttpClientProvider |
||||
clientProvider *client.Provider |
||||
} |
||||
|
||||
type fakeHttpClientProvider struct { |
||||
httpclient.Provider |
||||
|
||||
opts sdkhttpclient.Options |
||||
} |
||||
|
||||
func (p *fakeHttpClientProvider) New(opts ...sdkhttpclient.Options) (*http.Client, error) { |
||||
p.opts = opts[0] |
||||
return sdkhttpclient.New(opts[0]) |
||||
} |
||||
|
||||
func (p *fakeHttpClientProvider) GetTransport(opts ...sdkhttpclient.Options) (http.RoundTripper, error) { |
||||
p.opts = opts[0] |
||||
return http.DefaultTransport, nil |
||||
} |
||||
|
||||
func (p *fakeHttpClientProvider) middlewares() []string { |
||||
var middlewareNames []string |
||||
for _, m := range p.opts.Middlewares { |
||||
mw, ok := m.(sdkhttpclient.MiddlewareName) |
||||
if !ok { |
||||
panic("unexpected middleware type") |
||||
} |
||||
|
||||
middlewareNames = append(middlewareNames, mw.MiddlewareName()) |
||||
} |
||||
return middlewareNames |
||||
} |
||||
Loading…
Reference in new issue