IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Plugins: Add secure JSON fields to plugin setting DTO (#55313)

Browse Source 
* add secure JSON fields to plugin setting DTO

* add nil pointer fix

* adding secureJsonFields to the plugin meta.

Co-authored-by: Marcus Andersson <marcus.andersson@grafana.com>
This commit is contained in:
Will Browne
2022-09-21 12:20:11 +02:00
committed by GitHub
parent c10a69c007
commit b25ea75bac
12 changed files with 100 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
pkg/services/plugindashboards/service/dashboard_updater_test.go
View File

@@ -397,9 +397,21 @@ type pluginsSettingsServiceMock struct {
err error
}
func (s *pluginsSettingsServiceMock) GetPluginSettings(_ context.Context, args *pluginsettings.GetArgs) ([]*pluginsettings.DTO, error) {
func (s *pluginsSettingsServiceMock) GetPluginSettings(_ context.Context, args *pluginsettings.GetArgs) ([]*pluginsettings.InfoDTO, error) {
s.getPluginSettingsArgs = append(s.getPluginSettingsArgs, args.OrgID)
return s.storedPluginSettings, s.err
var res []*pluginsettings.InfoDTO
for _, ps := range s.storedPluginSettings {
res = append(res, &pluginsettings.InfoDTO{
PluginID: ps.PluginID,
OrgID: ps.OrgID,
Enabled: ps.Enabled,
Pinned: ps.Pinned,
PluginVersion: ps.PluginVersion,
})
}
return res, s.err
}
func (s *pluginsSettingsServiceMock) GetPluginSettingByPluginID(_ context.Context, args *pluginsettings.GetByPluginIDArgs) (*pluginsettings.DTO, error) {

8
pkg/services/pluginsettings/models.go
View File

@@ -16,6 +16,14 @@ type DTO struct {
Updated time.Time
}
type InfoDTO struct {
PluginID string
OrgID int64
Enabled bool
Pinned bool
PluginVersion string
}
type UpdateArgs struct {
Enabled bool
Pinned bool

2
pkg/services/pluginsettings/pluginsettings.go
View File

@@ -6,7 +6,7 @@ import (
type Service interface {
// GetPluginSettings returns all Plugin Settings for the provided Org
GetPluginSettings(ctx context.Context, args *GetArgs) ([]*DTO, error)
GetPluginSettings(ctx context.Context, args *GetArgs) ([]*InfoDTO, error)
// GetPluginSettingByPluginID returns a Plugin Settings by Plugin ID
GetPluginSettingByPluginID(ctx context.Context, args *GetByPluginIDArgs) (*DTO, error)
// UpdatePluginSetting updates a Plugin Setting

26
pkg/services/pluginsettings/service/service.go
View File

@@ -44,24 +44,20 @@ type secureJSONDecryptionCache struct {
sync.Mutex
}
func (s *Service) GetPluginSettings(ctx context.Context, args *pluginsettings.GetArgs) ([]*pluginsettings.DTO, error) {
ps, err := s.getPluginSettings(ctx, args.OrgID)
func (s *Service) GetPluginSettings(ctx context.Context, args *pluginsettings.GetArgs) ([]*pluginsettings.InfoDTO, error) {
ps, err := s.getPluginSettingsInfo(ctx, args.OrgID)
if err != nil {
return nil, err
}
var result []*pluginsettings.DTO
var result []*pluginsettings.InfoDTO
for _, p := range ps {
result = append(result, &pluginsettings.DTO{
ID: p.Id,
OrgID: p.OrgId,
PluginID: p.PluginId,
PluginVersion: p.PluginVersion,
JSONData: p.JsonData,
SecureJSONData: p.SecureJsonData,
Enabled: p.Enabled,
Pinned: p.Pinned,
Updated: p.Updated,
result = append(result, &pluginsettings.InfoDTO{
OrgID: p.OrgID,
PluginID: p.PluginID,
PluginVersion: p.PluginVersion,
Enabled: p.Enabled,
Pinned: p.Pinned,
})
}
@@ -140,7 +136,7 @@ func (s *Service) DecryptedValues(ps *pluginsettings.DTO) map[string]string {
return json
}
func (s *Service) getPluginSettings(ctx context.Context, orgID int64) ([]*models.PluginSetting, error) {
func (s *Service) getPluginSettingsInfo(ctx context.Context, orgID int64) ([]*models.PluginSettingInfo, error) {
sql := `SELECT org_id, plugin_id, enabled, pinned, plugin_version FROM plugin_setting `
params := make([]interface{}, 0)
@@ -149,7 +145,7 @@ func (s *Service) getPluginSettings(ctx context.Context, orgID int64) ([]*models
params = append(params, orgID)
}
var rslt []*models.PluginSetting
var rslt []*models.PluginSettingInfo
err := s.db.WithDbSession(ctx, func(sess *sqlstore.DBSession) error {
return sess.SQL(sql, params...).Find(&rslt)
})

4
pkg/services/pluginsettings/service/service_test.go
View File

@@ -137,8 +137,6 @@ func TestIntegrationPluginSettings(t *testing.T) {
require.Equal(t, existing.OrgId, ps.OrgID)
require.Equal(t, existing.PluginId, ps.PluginID)
require.False(t, ps.Enabled)
require.Nil(t, ps.JSONData)
require.Nil(t, ps.SecureJSONData)
})
t.Run("GetPluginSettings with orgID=1 should return all existing plugin settings", func(t *testing.T) {
@@ -149,8 +147,6 @@ func TestIntegrationPluginSettings(t *testing.T) {
require.Equal(t, existing.OrgId, ps.OrgID)
require.Equal(t, existing.PluginId, ps.PluginID)
require.False(t, ps.Enabled)
require.Nil(t, ps.JSONData)
require.Nil(t, ps.SecureJSONData)
})
t.Run("GetPluginSettingById should return existing plugin settings", func(t *testing.T) {

2
pkg/services/provisioning/plugins/plugin_provisioner_test.go
View File

@@ -106,7 +106,7 @@ func (m *mockStore) UpdatePluginSettingPluginVersion(_ context.Context, _ *plugi
return nil
}
func (m *mockStore) GetPluginSettings(_ context.Context, _ *pluginsettings.GetArgs) ([]*pluginsettings.DTO, error) {
func (m *mockStore) GetPluginSettings(_ context.Context, _ *pluginsettings.GetArgs) ([]*pluginsettings.InfoDTO, error) {
return nil, nil
}