backend/datasources: move datasources models into the datasources service package (#51267)

* backend/datasources: move datasources models into the datasources service pkg
2025-02-25 18:55:37 -06:00 · 2022-06-27 12:23:15 -04:00
parent 78c012df65
commit 945f015770
77 changed files with 728 additions and 660 deletions
--- a/pkg/api/pluginproxy/ds_proxy_test.go
+++ b/pkg/api/pluginproxy/ds_proxy_test.go
@@ -13,6 +13,10 @@ import (
 	"testing"
 	"time"

+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"golang.org/x/oauth2"
+
 	"github.com/grafana/grafana/pkg/api/datasource"
 	"github.com/grafana/grafana/pkg/components/simplejson"
 	"github.com/grafana/grafana/pkg/infra/httpclient"
@@ -20,6 +24,7 @@ import (
 	"github.com/grafana/grafana/pkg/models"
 	"github.com/grafana/grafana/pkg/plugins"
 	acmock "github.com/grafana/grafana/pkg/services/accesscontrol/mock"
+	"github.com/grafana/grafana/pkg/services/datasources"
 	datasourceservice "github.com/grafana/grafana/pkg/services/datasources/service"
 	"github.com/grafana/grafana/pkg/services/featuremgmt"
 	"github.com/grafana/grafana/pkg/services/oauthtoken"
@@ -29,9 +34,6 @@ import (
 	secretsManager "github.com/grafana/grafana/pkg/services/secrets/manager"
 	"github.com/grafana/grafana/pkg/setting"
 	"github.com/grafana/grafana/pkg/web"
-	"github.com/stretchr/testify/assert"
-	"github.com/stretchr/testify/require"
-	"golang.org/x/oauth2"
 )

 func TestDataSourceProxy_routeRule(t *testing.T) {
@@ -96,7 +98,7 @@ func TestDataSourceProxy_routeRule(t *testing.T) {
 		key, err := secretsService.Encrypt(context.Background(), []byte("123"), secrets.WithoutScope())
 		require.NoError(t, err)

-		ds := &models.DataSource{
+		ds := &datasources.DataSource{
 			JsonData: simplejson.NewFromAny(map[string]interface{}{
 				"clientId":   "asd",
 				"dynamicUrl": "https://dynamic.grafana.com",
@@ -249,7 +251,7 @@ func TestDataSourceProxy_routeRule(t *testing.T) {
 		key, err := secretsService.Encrypt(context.Background(), []byte("123"), secrets.WithoutScope())
 		require.NoError(t, err)

-		ds := &models.DataSource{
+		ds := &datasources.DataSource{
 			JsonData: simplejson.NewFromAny(map[string]interface{}{
 				"clientId": "asd",
 				"tenantId": "mytenantId",
@@ -340,7 +342,7 @@ func TestDataSourceProxy_routeRule(t *testing.T) {

 	t.Run("When proxying graphite", func(t *testing.T) {
 		var routes []*plugins.Route
-		ds := &models.DataSource{Url: "htttp://graphite:8080", Type: models.DS_GRAPHITE}
+		ds := &datasources.DataSource{Url: "htttp://graphite:8080", Type: datasources.DS_GRAPHITE}
 		ctx := &models.ReqContext{}

 		secretsStore := kvstore.SetupTestService(t)
@@ -360,8 +362,8 @@ func TestDataSourceProxy_routeRule(t *testing.T) {
 	})

 	t.Run("When proxying InfluxDB", func(t *testing.T) {
-		ds := &models.DataSource{
-			Type:     models.DS_INFLUXDB_08,
+		ds := &datasources.DataSource{
+			Type:     datasources.DS_INFLUXDB_08,
 			Url:      "http://influxdb:8083",
 			Database: "site",
 			User:     "user",
@@ -386,8 +388,8 @@ func TestDataSourceProxy_routeRule(t *testing.T) {
 		json, err := simplejson.NewJson([]byte(`{"keepCookies": []}`))
 		require.NoError(t, err)

-		ds := &models.DataSource{
-			Type:     models.DS_GRAPHITE,
+		ds := &datasources.DataSource{
+			Type:     datasources.DS_GRAPHITE,
 			Url:      "http://graphite:8086",
 			JsonData: json,
 		}
@@ -415,8 +417,8 @@ func TestDataSourceProxy_routeRule(t *testing.T) {
 		json, err := simplejson.NewJson([]byte(`{"keepCookies": ["JSESSION_ID"]}`))
 		require.NoError(t, err)

-		ds := &models.DataSource{
-			Type:     models.DS_GRAPHITE,
+		ds := &datasources.DataSource{
+			Type:     datasources.DS_GRAPHITE,
 			Url:      "http://graphite:8086",
 			JsonData: json,
 		}
@@ -441,7 +443,7 @@ func TestDataSourceProxy_routeRule(t *testing.T) {
 	})

 	t.Run("When proxying a custom datasource", func(t *testing.T) {
-		ds := &models.DataSource{
+		ds := &datasources.DataSource{
 			Type: "custom-datasource",
 			Url:  "http://host/root/",
 		}
@@ -466,7 +468,7 @@ func TestDataSourceProxy_routeRule(t *testing.T) {
 	})

 	t.Run("When proxying a datasource that has OAuth token pass-through enabled", func(t *testing.T) {
-		ds := &models.DataSource{
+		ds := &datasources.DataSource{
 			Type: "custom-datasource",
 			Url:  "http://host/root/",
 			JsonData: simplejson.NewFromAny(map[string]interface{}{
@@ -555,18 +557,18 @@ func TestDataSourceProxy_routeRule(t *testing.T) {
 		secretsService := secretsManager.SetupTestService(t, fakes.NewFakeSecretsStore())

 		tests := []*testCase{
-			createAuthTest(t, secretsStore, models.DS_INFLUXDB_08, "http://localhost:9090", authTypePassword, authCheckQuery),
-			createAuthTest(t, secretsStore, models.DS_INFLUXDB_08, "http://localhost:9090", authTypePassword, authCheckQuery),
-			createAuthTest(t, secretsStore, models.DS_INFLUXDB, "http://localhost:9090", authTypePassword, authCheckHeader),
-			createAuthTest(t, secretsStore, models.DS_INFLUXDB, "http://localhost:9090", authTypePassword, authCheckHeader),
-			createAuthTest(t, secretsStore, models.DS_INFLUXDB, "http://localhost:9090", authTypeBasic, authCheckHeader),
-			createAuthTest(t, secretsStore, models.DS_INFLUXDB, "http://localhost:9090", authTypeBasic, authCheckHeader),
+			createAuthTest(t, secretsStore, datasources.DS_INFLUXDB_08, "http://localhost:9090", authTypePassword, authCheckQuery),
+			createAuthTest(t, secretsStore, datasources.DS_INFLUXDB_08, "http://localhost:9090", authTypePassword, authCheckQuery),
+			createAuthTest(t, secretsStore, datasources.DS_INFLUXDB, "http://localhost:9090", authTypePassword, authCheckHeader),
+			createAuthTest(t, secretsStore, datasources.DS_INFLUXDB, "http://localhost:9090", authTypePassword, authCheckHeader),
+			createAuthTest(t, secretsStore, datasources.DS_INFLUXDB, "http://localhost:9090", authTypeBasic, authCheckHeader),
+			createAuthTest(t, secretsStore, datasources.DS_INFLUXDB, "http://localhost:9090", authTypeBasic, authCheckHeader),

 			// These two should be enough for any other datasource at the moment. Proxy has special handling
 			// only for Influx, others have the same path and only BasicAuth. Non BasicAuth datasources
 			// do not go through proxy but through TSDB API which is not tested here.
-			createAuthTest(t, secretsStore, models.DS_ES, "http://localhost:9200", authTypeBasic, authCheckHeader),
-			createAuthTest(t, secretsStore, models.DS_ES, "http://localhost:9200", authTypeBasic, authCheckHeader),
+			createAuthTest(t, secretsStore, datasources.DS_ES, "http://localhost:9200", authTypeBasic, authCheckHeader),
+			createAuthTest(t, secretsStore, datasources.DS_ES, "http://localhost:9200", authTypeBasic, authCheckHeader),
 		}
 		for _, test := range tests {
 			runDatasourceAuthTest(t, secretsService, secretsStore, cfg, test)
@@ -585,7 +587,7 @@ func TestDataSourceProxy_requestHandling(t *testing.T) {
 		writeCb func(w http.ResponseWriter, r *http.Request)
 	}

-	setUp := func(t *testing.T, cfgs ...setUpCfg) (*models.ReqContext, *models.DataSource) {
+	setUp := func(t *testing.T, cfgs ...setUpCfg) (*models.ReqContext, *datasources.DataSource) {
 		writeErr = nil

 		backend := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
@@ -606,7 +608,7 @@ func TestDataSourceProxy_requestHandling(t *testing.T) {
 		}))
 		t.Cleanup(backend.Close)

-		ds := &models.DataSource{Url: backend.URL, Type: models.DS_GRAPHITE}
+		ds := &datasources.DataSource{Url: backend.URL, Type: datasources.DS_GRAPHITE}

 		responseWriter := web.NewResponseWriter("GET", httptest.NewRecorder())

@@ -758,7 +760,7 @@ func TestNewDataSourceProxy_InvalidURL(t *testing.T) {
 		Context:      &web.Context{},
 		SignedInUser: &models.SignedInUser{OrgRole: models.ROLE_EDITOR},
 	}
-	ds := models.DataSource{
+	ds := datasources.DataSource{
 		Type: "test",
 		Url:  "://host/root",
 	}
@@ -778,7 +780,7 @@ func TestNewDataSourceProxy_ProtocolLessURL(t *testing.T) {
 		Context:      &web.Context{},
 		SignedInUser: &models.SignedInUser{OrgRole: models.ROLE_EDITOR},
 	}
-	ds := models.DataSource{
+	ds := datasources.DataSource{
 		Type: "test",
 		Url:  "127.0.01:5432",
 	}
@@ -823,7 +825,7 @@ func TestNewDataSourceProxy_MSSQL(t *testing.T) {
 	for _, tc := range tcs {
 		t.Run(tc.description, func(t *testing.T) {
 			cfg := &setting.Cfg{}
-			ds := models.DataSource{
+			ds := datasources.DataSource{
 				Type: "mssql",
 				Url:  tc.url,
 			}
@@ -849,7 +851,7 @@ func TestNewDataSourceProxy_MSSQL(t *testing.T) {

 // getDatasourceProxiedRequest is a helper for easier setup of tests based on global config and ReqContext.
 func getDatasourceProxiedRequest(t *testing.T, ctx *models.ReqContext, cfg *setting.Cfg) *http.Request {
-	ds := &models.DataSource{
+	ds := &datasources.DataSource{
 		Type: "custom",
 		Url:  "http://host/root/",
 	}
@@ -897,7 +899,7 @@ func newFakeHTTPClient(t *testing.T, fakeBody []byte) httpClient {
 }

 type testCase struct {
-	datasource *models.DataSource
+	datasource *datasources.DataSource
 	checkReq   func(req *http.Request)
 }

@@ -916,7 +918,7 @@ func createAuthTest(t *testing.T, secretsStore kvstore.SecretsKVStore, dsType st
 	base64AuthHeader := "Basic dXNlcjpwYXNzd29yZA=="

 	test := &testCase{
-		datasource: &models.DataSource{
+		datasource: &datasources.DataSource{
 			Id:       1,
 			OrgId:    1,
 			Name:     fmt.Sprintf("%s,%s,%s,%s", dsType, url, authType, authCheck),
@@ -1019,7 +1021,7 @@ func Test_PathCheck(t *testing.T) {
 	secretsStore := kvstore.SetupTestService(t)
 	secretsService := secretsManager.SetupTestService(t, fakes.NewFakeSecretsStore())
 	dsService := datasourceservice.ProvideService(nil, secretsService, secretsStore, cfg, featuremgmt.WithFeatures(), acmock.New(), acmock.NewMockedPermissionsService())
-	proxy, err := NewDataSourceProxy(&models.DataSource{}, routes, ctx, "b", &setting.Cfg{}, httpclient.NewProvider(), &oauthtoken.Service{}, dsService, tracer)
+	proxy, err := NewDataSourceProxy(&datasources.DataSource{}, routes, ctx, "b", &setting.Cfg{}, httpclient.NewProvider(), &oauthtoken.Service{}, dsService, tracer)
 	require.NoError(t, err)

 	require.Nil(t, proxy.validateRequest())
@@ -1035,6 +1037,6 @@ func (m *mockOAuthTokenService) GetCurrentOAuthToken(ctx context.Context, user *
 	return m.token
 }

-func (m *mockOAuthTokenService) IsOAuthPassThruEnabled(ds *models.DataSource) bool {
+func (m *mockOAuthTokenService) IsOAuthPassThruEnabled(ds *datasources.DataSource) bool {
 	return m.oAuthEnabled
 }