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

Populate missing UID of provisioned data source only for new records (#42999)

Browse Source 
* defer updating empty UID to insert command
* change logging to use the command
This commit is contained in:
Yuriy Tseretyan 2021-12-13 14:14:39 -05:00 committed by GitHub
parent b63595b47f
commit 35b0067650
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 70 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
pkg/services/provisioning/datasources/config_reader.go
View File

@ -2,17 +2,17 @@ package datasources
import (
"context"
"crypto/sha256"
"fmt"
"io/ioutil"
"os"
"path/filepath"
"strings"
"gopkg.in/yaml.v2"
"github.com/grafana/grafana/pkg/infra/log"
"github.com/grafana/grafana/pkg/models"
"github.com/grafana/grafana/pkg/services/provisioning/utils"
"gopkg.in/yaml.v2"
)
type configReader struct {
@ -36,12 +36,6 @@ func (cr *configReader) readConfig(ctx context.Context, path string) ([]*configs
}
if datasource != nil {
for _, ds := range datasource.Datasources {
if ds.UID == "" && ds.Name != "" {
ds.UID = safeUIDFromName(ds.Name)
}
}
datasources = append(datasources, datasource)
}
}
@ -145,10 +139,3 @@ func (cr *configReader) validateAccessAndOrgID(ctx context.Context, ds *upsertDa
}
return nil
}
func safeUIDFromName(name string) string {
h := sha256.New()
_, _ = h.Write([]byte(name))
bs := h.Sum(nil)
return strings.ToUpper(fmt.Sprintf("P%x", bs[:8]))
}

54
pkg/services/provisioning/datasources/config_reader_test.go
View File

@ -8,6 +8,7 @@ import (
"github.com/grafana/grafana/pkg/bus"
"github.com/grafana/grafana/pkg/infra/log"
"github.com/grafana/grafana/pkg/models"
"github.com/grafana/grafana/pkg/util"
"github.com/stretchr/testify/require"
)
@ -39,19 +40,40 @@ func TestDatasourceAsConfig(t *testing.T) {
bus.AddHandlerCtx("test", mockGetOrg)
}
t.Run("apply default values when missing", func(t *testing.T) {
setup()
dc := newDatasourceProvisioner(logger)
err := dc.applyChanges(context.Background(), withoutDefaults)
if err != nil {
t.Fatalf("applyChanges return an error %v", err)
}
t.Run("when some values missing", func(t *testing.T) {
t.Run("should apply default on insert", func(t *testing.T) {
setup()
dc := newDatasourceProvisioner(logger)
err := dc.applyChanges(context.Background(), withoutDefaults)
if err != nil {
t.Fatalf("applyChanges return an error %v", err)
}
require.Equal(t, len(fakeRepo.inserted), 1)
require.Equal(t, fakeRepo.inserted[0].OrgId, int64(1))
require.Equal(t, fakeRepo.inserted[0].Access, models.DsAccess("proxy"))
require.Equal(t, fakeRepo.inserted[0].Name, "My datasource name")
require.Equal(t, fakeRepo.inserted[0].Uid, "P2AD1F727255C56BA")
require.Equal(t, len(fakeRepo.inserted), 1)
require.Equal(t, fakeRepo.inserted[0].OrgId, int64(1))
require.Equal(t, fakeRepo.inserted[0].Access, models.DsAccess("proxy"))
require.Equal(t, fakeRepo.inserted[0].Name, "My datasource name")
require.Equal(t, fakeRepo.inserted[0].Uid, "P2AD1F727255C56BA")
})
t.Run("should not change UID when updates", func(t *testing.T) {
setup()
fakeRepo.loadAll = []*models.DataSource{
{Name: "My datasource name", OrgId: 1, Id: 1, Uid: util.GenerateShortUID()},
}
dc := newDatasourceProvisioner(logger)
err := dc.applyChanges(context.Background(), withoutDefaults)
if err != nil {
t.Fatalf("applyChanges return an error %v", err)
}
require.Equal(t, len(fakeRepo.deleted), 0)
require.Equal(t, len(fakeRepo.inserted), 0)
require.Equal(t, len(fakeRepo.updated), 1)
require.Equal(t, "", fakeRepo.updated[0].Uid) // XORM will not update the field if its value is default
})
})
t.Run("no datasource in database", func(t *testing.T) {
@ -222,14 +244,6 @@ func TestDatasourceAsConfig(t *testing.T) {
})
}
func TestUIDFromNames(t *testing.T) {
t.Run("generate safe uid from name", func(t *testing.T) {
require.Equal(t, safeUIDFromName("Hello world"), "P64EC88CA00B268E5")
require.Equal(t, safeUIDFromName("Hello World"), "PA591A6D40BF42040")
require.Equal(t, safeUIDFromName("AAA"), "PCB1AD2119D8FAFB6")
})
}
func validateDeleteDatasources(t *testing.T, dsCfg *configs) {
require.Equal(t, len(dsCfg.DeleteDatasources), 1)
deleteDs := dsCfg.DeleteDatasources[0]

4
pkg/services/provisioning/datasources/datasources.go
View File

@ -51,14 +51,14 @@ func (dc *DatasourceProvisioner) apply(ctx context.Context, cfg *configs) error
}
if errors.Is(err, models.ErrDataSourceNotFound) {
dc.log.Info("inserting datasource from configuration ", "name", ds.Name, "uid", ds.UID)
insertCmd := createInsertCommand(ds)
dc.log.Info("inserting datasource from configuration ", "name", insertCmd.Name, "uid", insertCmd.Uid)
if err := bus.DispatchCtx(ctx, insertCmd); err != nil {
return err
}
} else {
dc.log.Debug("updating datasource from configuration", "name", ds.Name, "uid", ds.UID)
updateCmd := createUpdateCommand(ds, cmd.Result.Id)
dc.log.Debug("updating datasource from configuration", "name", updateCmd.Name, "uid", updateCmd.Uid)
if err := bus.DispatchCtx(ctx, updateCmd); err != nil {
return err
}

18
pkg/services/provisioning/datasources/types.go
View File

@ -1,6 +1,10 @@
package datasources
import (
"crypto/sha256"
"fmt"
"strings"
"github.com/grafana/grafana/pkg/components/simplejson"
"github.com/grafana/grafana/pkg/infra/log"
"github.com/grafana/grafana/pkg/models"
@ -220,7 +224,7 @@ func createInsertCommand(ds *upsertDataSourceFromConfig) *models.AddDataSourceCo
}
}
return &models.AddDataSourceCommand{
cmd := &models.AddDataSourceCommand{
OrgId: ds.OrgID,
Name: ds.Name,
Type: ds.Type,
@ -239,6 +243,18 @@ func createInsertCommand(ds *upsertDataSourceFromConfig) *models.AddDataSourceCo
ReadOnly: !ds.Editable,
Uid: ds.UID,
}
if cmd.Uid == "" {
cmd.Uid = safeUIDFromName(cmd.Name)
}
return cmd
}
func safeUIDFromName(name string) string {
h := sha256.New()
_, _ = h.Write([]byte(name))
bs := h.Sum(nil)
return strings.ToUpper(fmt.Sprintf("P%x", bs[:8]))
}
func createUpdateCommand(ds *upsertDataSourceFromConfig, id int64) *models.UpdateDataSourceCommand {

15
pkg/services/provisioning/datasources/types_test.go Normal file
View File

@ -0,0 +1,15 @@
package datasources
import (
"testing"
"github.com/stretchr/testify/require"
)
func TestUIDFromNames(t *testing.T) {
t.Run("generate safe uid from name", func(t *testing.T) {
require.Equal(t, safeUIDFromName("Hello world"), "P64EC88CA00B268E5")
require.Equal(t, safeUIDFromName("Hello World"), "PA591A6D40BF42040")
require.Equal(t, safeUIDFromName("AAA"), "PCB1AD2119D8FAFB6")
})
}