Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Type to DataSourceInstanceSettings #490

Merged
merged 3 commits into from
Apr 19, 2022
Merged

Add Type to DataSourceInstanceSettings #490

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6d1d0f5
Add Type to DataSourceInstanceSettings
toddtreece Apr 15, 2022
c3d044d
add pluginID to DataSourceInstanceSettings
toddtreece Apr 19, 2022
287186a
remove extra new line
toddtreece Apr 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions backend/common.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,10 @@ type DataSourceInstanceSettings struct {
// UID is the Grafana assigned string identifier of the the data source instance.
UID string

// Type is the unique identifier of the plugin that the request is for.
// This should be the same value as PluginContext.PluginId.
Type string

// Name is the configured name of the data source instance.
Name string

Expand Down Expand Up @@ -110,6 +114,7 @@ func (s *DataSourceInstanceSettings) HTTPClientOptions() (httpclient.Options, er
opts := httpSettings.HTTPClientOptions()
opts.Labels["datasource_name"] = s.Name
opts.Labels["datasource_uid"] = s.UID
opts.Labels["datasource_type"] = s.Type

setCustomOptionsFromHTTPSettings(&opts, httpSettings)

Expand Down
4 changes: 4 additions & 0 deletions backend/common_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ func TestDataSourceInstanceSettings(t *testing.T) {
Name: "ds1",
UID: "uid1",
User: "user",
Type: "example-datasource",
JSONData: []byte("{}"),
BasicAuthEnabled: true,
BasicAuthUser: "buser",
Expand All @@ -100,6 +101,7 @@ func TestDataSourceInstanceSettings(t *testing.T) {
Labels: map[string]string{
"datasource_name": "ds1",
"datasource_uid": "uid1",
"datasource_type": "example-datasource",
},
CustomOptions: map[string]interface{}{
dataCustomOptionsKey: map[string]interface{}{},
Expand All @@ -114,6 +116,7 @@ func TestDataSourceInstanceSettings(t *testing.T) {
instanceSettings: &DataSourceInstanceSettings{
Name: "ds2",
UID: "uid2",
Type: "example-datasource-2",
User: "user",
JSONData: []byte("{}"),
BasicAuthEnabled: false,
Expand All @@ -131,6 +134,7 @@ func TestDataSourceInstanceSettings(t *testing.T) {
Labels: map[string]string{
"datasource_name": "ds2",
"datasource_uid": "uid2",
"datasource_type": "example-datasource-2",
},
CustomOptions: map[string]interface{}{
dataCustomOptionsKey: map[string]interface{}{},
Expand Down
5 changes: 3 additions & 2 deletions backend/convert_from_protobuf.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,15 @@ func (f ConvertFromProtobuf) AppInstanceSettings(proto *pluginv2.AppInstanceSett
}

// DataSourceInstanceSettings converts protobuf version of a DataSourceInstanceSettings to the SDK version.
func (f ConvertFromProtobuf) DataSourceInstanceSettings(proto *pluginv2.DataSourceInstanceSettings) *DataSourceInstanceSettings {
func (f ConvertFromProtobuf) DataSourceInstanceSettings(proto *pluginv2.DataSourceInstanceSettings, pluginID string) *DataSourceInstanceSettings {
if proto == nil {
return nil
}

return &DataSourceInstanceSettings{
ID: proto.Id,
UID: proto.Uid,
Type: pluginID,
Name: proto.Name,
URL: proto.Url,
User: proto.User,
Expand All @@ -76,7 +77,7 @@ func (f ConvertFromProtobuf) PluginContext(proto *pluginv2.PluginContext) Plugin
PluginID: proto.PluginId,
User: f.User(proto.User),
AppInstanceSettings: f.AppInstanceSettings(proto.AppInstanceSettings),
DataSourceInstanceSettings: f.DataSourceInstanceSettings(proto.DataSourceInstanceSettings),
DataSourceInstanceSettings: f.DataSourceInstanceSettings(proto.DataSourceInstanceSettings, proto.PluginId),
}
}

Expand Down
14 changes: 10 additions & 4 deletions backend/convert_from_protobuf_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ func TestConvertFromProtobufDataSourceInstanceSettings(t *testing.T) {
t.Fatalf(unsetErrFmt, "proto", "DataSourceInstanceSettings", protoWalker.ZeroValueFieldCount, protoWalker.FieldCount)
}

sdkDSIS := f.DataSourceInstanceSettings(protoDSIS)
sdkDSIS := f.DataSourceInstanceSettings(protoDSIS, "example-datasource")

sdkWalker := &walker{}
err = reflectwalk.Walk(sdkDSIS, sdkWalker)
Expand All @@ -171,12 +171,14 @@ func TestConvertFromProtobufDataSourceInstanceSettings(t *testing.T) {
t.Fatalf(unsetErrFmt, "sdk", "DataSourceInstanceSettings", sdkWalker.ZeroValueFieldCount, sdkWalker.FieldCount)
}

require.Equal(t, protoWalker.FieldCount, sdkWalker.FieldCount)
// adding +1 to the proto field count to account for the Type field in the SDK
require.Equal(t, protoWalker.FieldCount+1, sdkWalker.FieldCount)

requireCounter := &requireCounter{}

requireCounter.Equal(t, protoDSIS.Id, sdkDSIS.ID)
requireCounter.Equal(t, protoDSIS.Uid, sdkDSIS.UID)
requireCounter.Equal(t, "example-datasource", sdkDSIS.Type)
requireCounter.Equal(t, protoDSIS.Name, sdkDSIS.Name)
requireCounter.Equal(t, protoDSIS.Url, sdkDSIS.URL)
requireCounter.Equal(t, protoDSIS.User, sdkDSIS.User)
Expand Down Expand Up @@ -223,7 +225,8 @@ func TestConvertFromProtobufPluginContext(t *testing.T) {
t.Fatalf(unsetErrFmt, "sdk", "DataSourceInstanceSettings", sdkWalker.ZeroValueFieldCount, sdkWalker.FieldCount)
}

require.Equal(t, protoWalker.FieldCount, sdkWalker.FieldCount)
// adding +1 to the proto field count to account for the Type field in the SDK
require.Equal(t, protoWalker.FieldCount+1, sdkWalker.FieldCount)

requireCounter := &requireCounter{}

Expand All @@ -245,6 +248,7 @@ func TestConvertFromProtobufPluginContext(t *testing.T) {
requireCounter.Equal(t, protoCtx.DataSourceInstanceSettings.Name, sdkCtx.DataSourceInstanceSettings.Name)
requireCounter.Equal(t, protoCtx.DataSourceInstanceSettings.Id, sdkCtx.DataSourceInstanceSettings.ID)
requireCounter.Equal(t, protoCtx.DataSourceInstanceSettings.Uid, sdkCtx.DataSourceInstanceSettings.UID)
requireCounter.Equal(t, protoCtx.PluginId, sdkCtx.DataSourceInstanceSettings.Type)
requireCounter.Equal(t, protoCtx.DataSourceInstanceSettings.Url, sdkCtx.DataSourceInstanceSettings.URL)
requireCounter.Equal(t, protoCtx.DataSourceInstanceSettings.User, sdkCtx.DataSourceInstanceSettings.User)
requireCounter.Equal(t, protoCtx.DataSourceInstanceSettings.Database, sdkCtx.DataSourceInstanceSettings.Database)
Expand Down Expand Up @@ -374,7 +378,8 @@ func TestConvertFromProtobufQueryDataRequest(t *testing.T) {
t.Fatalf(unsetErrFmt, "sdk", "QueryDataRequest", sdkWalker.ZeroValueFieldCount, sdkWalker.FieldCount)
}

require.Equal(t, protoWalker.FieldCount, sdkWalker.FieldCount)
// adding +1 to the proto field count to account for the Type field in the SDK
require.Equal(t, protoWalker.FieldCount+1, sdkWalker.FieldCount)

requireCounter := &requireCounter{}

Expand All @@ -398,6 +403,7 @@ func TestConvertFromProtobufQueryDataRequest(t *testing.T) {
requireCounter.Equal(t, protoQDR.PluginContext.DataSourceInstanceSettings.Name, sdkQDR.PluginContext.DataSourceInstanceSettings.Name)
requireCounter.Equal(t, protoQDR.PluginContext.DataSourceInstanceSettings.Id, sdkQDR.PluginContext.DataSourceInstanceSettings.ID)
requireCounter.Equal(t, protoQDR.PluginContext.DataSourceInstanceSettings.Uid, sdkQDR.PluginContext.DataSourceInstanceSettings.UID)
requireCounter.Equal(t, protoQDR.PluginContext.PluginId, sdkQDR.PluginContext.DataSourceInstanceSettings.Type)
requireCounter.Equal(t, protoQDR.PluginContext.DataSourceInstanceSettings.Url, sdkQDR.PluginContext.DataSourceInstanceSettings.URL)
requireCounter.Equal(t, protoQDR.PluginContext.DataSourceInstanceSettings.User, sdkQDR.PluginContext.DataSourceInstanceSettings.User)
requireCounter.Equal(t, protoQDR.PluginContext.DataSourceInstanceSettings.Database, sdkQDR.PluginContext.DataSourceInstanceSettings.Database)
Expand Down