diff --git a/pkg/services/provisioning/datasources/config_reader.go b/pkg/services/provisioning/datasources/config_reader.go index cd9652110a4..d7f37602d30 100644 --- a/pkg/services/provisioning/datasources/config_reader.go +++ b/pkg/services/provisioning/datasources/config_reader.go @@ -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])) -} diff --git a/pkg/services/provisioning/datasources/config_reader_test.go b/pkg/services/provisioning/datasources/config_reader_test.go index 23bd909bf69..8db0f53dc0a 100644 --- a/pkg/services/provisioning/datasources/config_reader_test.go +++ b/pkg/services/provisioning/datasources/config_reader_test.go @@ -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.AddHandler("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] diff --git a/pkg/services/provisioning/datasources/datasources.go b/pkg/services/provisioning/datasources/datasources.go index 3e28980778d..11e06a5421f 100644 --- a/pkg/services/provisioning/datasources/datasources.go +++ b/pkg/services/provisioning/datasources/datasources.go @@ -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 } diff --git a/pkg/services/provisioning/datasources/types.go b/pkg/services/provisioning/datasources/types.go index cc89c9e9308..b52b9cad3af 100644 --- a/pkg/services/provisioning/datasources/types.go +++ b/pkg/services/provisioning/datasources/types.go @@ -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 { diff --git a/pkg/services/provisioning/datasources/types_test.go b/pkg/services/provisioning/datasources/types_test.go new file mode 100644 index 00000000000..75820d6b128 --- /dev/null +++ b/pkg/services/provisioning/datasources/types_test.go @@ -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") + }) +}