Prometheus: Use contextual middleware for req headers and simplify client creation (#51061)

* Use contextual middleware and simplify client creation * Fix tests * Add test for the header propagation * Fix tests and lint * Update pkg/tsdb/prometheus/prometheus.go Co-authored-by: ismail simsek <ismailsimsek09@gmail.com> Co-authored-by: ismail simsek <ismailsimsek09@gmail.com>
2022-06-23 14:48:16 +02:00
parent a8eb29f1d7
commit d20afa2a39
17 changed files with 394 additions and 697 deletions
@@ -0,0 +1,117 @@
+package azureauth
+
+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/setting"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestConfigureAzureAuthentication(t *testing.T) {
+	cfg := &setting.Cfg{
+		Azure: &azsettings.AzureSettings{},
+	}
+
+	t.Run("should set Azure middleware when JsonData contains valid credentials", func(t *testing.T) {
+		settings := backend.DataSourceInstanceSettings{
+			JSONData: []byte(`{
+					"httpMethod": "POST",
+					"azureCredentials": {
+						"authType": "msi"
+					}
+				}`),
+		}
+
+		var opts = &sdkhttpclient.Options{CustomOptions: map[string]interface{}{}}
+
+		err := ConfigureAzureAuthentication(settings, cfg.Azure, 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) {
+		settings := backend.DataSourceInstanceSettings{
+			JSONData: []byte(`{ "httpMethod": "POST" }`),
+		}
+
+		var opts = &sdkhttpclient.Options{CustomOptions: map[string]interface{}{}}
+
+		err := ConfigureAzureAuthentication(settings, cfg.Azure, 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) {
+		settings := backend.DataSourceInstanceSettings{
+			JSONData: []byte(`{
+					"httpMethod":       "POST",
+					"azureCredentials": "invalid"
+				}`),
+		}
+
+		var opts = &sdkhttpclient.Options{CustomOptions: map[string]interface{}{}}
+		err := ConfigureAzureAuthentication(settings, cfg.Azure, opts)
+		assert.Error(t, err)
+	})
+
+	t.Run("should set Azure middleware when JsonData contains credentials and valid audience", func(t *testing.T) {
+		settings := backend.DataSourceInstanceSettings{
+			JSONData: []byte(`{
+					"httpMethod": "POST",
+					"azureCredentials": {
+						"authType": "msi"
+					},
+					"azureEndpointResourceId": "https://api.example.com/abd5c4ce-ca73-41e9-9cb2-bed39aa2adb5"
+				}`),
+		}
+		var opts = &sdkhttpclient.Options{CustomOptions: map[string]interface{}{}}
+
+		err := ConfigureAzureAuthentication(settings, cfg.Azure, 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) {
+		settings := backend.DataSourceInstanceSettings{
+			JSONData: []byte(`{
+					"httpMethod":              "POST",
+					"azureEndpointResourceId": "https://api.example.com/abd5c4ce-ca73-41e9-9cb2-bed39aa2adb5"
+				}`),
+		}
+		var opts = &sdkhttpclient.Options{CustomOptions: map[string]interface{}{}}
+
+		err := ConfigureAzureAuthentication(settings, cfg.Azure, 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) {
+		settings := backend.DataSourceInstanceSettings{
+			JSONData: []byte(`{
+					"httpMethod": "POST",
+					"azureCredentials": {
+						"authType": "msi"
+					},
+					"azureEndpointResourceId": "invalid"
+				}`),
+		}
+
+		var opts = &sdkhttpclient.Options{CustomOptions: map[string]interface{}{}}
+
+		err := ConfigureAzureAuthentication(settings, cfg.Azure, opts)
+		assert.Error(t, err)
+	})
+}