//go:build integration // +build integration package service import ( "context" "errors" "testing" "github.com/stretchr/testify/mock" "github.com/stretchr/testify/require" "github.com/grafana/grafana/pkg/bus" "github.com/grafana/grafana/pkg/components/simplejson" "github.com/grafana/grafana/pkg/infra/log" "github.com/grafana/grafana/pkg/models" m "github.com/grafana/grafana/pkg/services/dashboards" "github.com/grafana/grafana/pkg/services/guardian" "github.com/grafana/grafana/pkg/setting" ) func TestDashboardService(t *testing.T) { t.Run("Dashboard service tests", func(t *testing.T) { bus.ClearBusHandlers() fakeStore := m.FakeDashboardStore{} defer fakeStore.AssertExpectations(t) service := &DashboardServiceImpl{ log: log.New("test.logger"), dashboardStore: &fakeStore, dashAlertExtractor: &dummyDashAlertExtractor{}, } origNewDashboardGuardian := guardian.New defer func() { guardian.New = origNewDashboardGuardian }() guardian.MockDashboardGuardian(&guardian.FakeDashboardGuardian{CanSaveValue: true}) t.Run("Save dashboard validation", func(t *testing.T) { dto := &m.SaveDashboardDTO{} t.Run("When saving a dashboard with empty title it should return error", func(t *testing.T) { titles := []string{"", " ", " \t "} for _, title := range titles { dto.Dashboard = models.NewDashboard(title) _, err := service.SaveDashboard(context.Background(), dto, false) require.Equal(t, err, models.ErrDashboardTitleEmpty) } }) t.Run("Should return validation error if it's a folder and have a folder id", func(t *testing.T) { dto.Dashboard = models.NewDashboardFolder("Folder") dto.Dashboard.FolderId = 1 _, err := service.SaveDashboard(context.Background(), dto, false) require.Equal(t, err, models.ErrDashboardFolderCannotHaveParent) }) t.Run("Should return validation error if folder is named General", func(t *testing.T) { dto.Dashboard = models.NewDashboardFolder("General") _, err := service.SaveDashboard(context.Background(), dto, false) require.Equal(t, err, models.ErrDashboardFolderNameExists) }) t.Run("When saving a dashboard should validate uid", func(t *testing.T) { testCases := []struct { Uid string Error error }{ {Uid: "", Error: nil}, {Uid: " ", Error: nil}, {Uid: " \t ", Error: nil}, {Uid: "asdf90_-", Error: nil}, {Uid: "asdf/90", Error: models.ErrDashboardInvalidUid}, {Uid: " asdfghjklqwertyuiopzxcvbnmasdfghjklqwer ", Error: nil}, {Uid: "asdfghjklqwertyuiopzxcvbnmasdfghjklqwertyuiopzxcvbnmasdfghjklqwertyuiopzxcvbnm", Error: models.ErrDashboardUidTooLong}, } for _, tc := range testCases { dto.Dashboard = models.NewDashboard("title") dto.Dashboard.SetUid(tc.Uid) dto.User = &models.SignedInUser{} if tc.Error == nil { fakeStore.On("ValidateDashboardBeforeSave", mock.Anything, mock.Anything).Return(true, nil).Once() } _, err := service.BuildSaveDashboardCommand(context.Background(), dto, true, false) require.Equal(t, err, tc.Error) } }) t.Run("Should return validation error if dashboard is provisioned", func(t *testing.T) { fakeStore.On("ValidateDashboardBeforeSave", mock.Anything, mock.Anything).Return(true, nil).Once() fakeStore.On("GetProvisionedDataByDashboardID", mock.Anything).Return(&models.DashboardProvisioning{}, nil).Once() dto.Dashboard = models.NewDashboard("Dash") dto.Dashboard.SetId(3) dto.User = &models.SignedInUser{UserId: 1} _, err := service.SaveDashboard(context.Background(), dto, false) require.Equal(t, err, models.ErrDashboardCannotSaveProvisionedDashboard) }) t.Run("Should not return validation error if dashboard is provisioned but UI updates allowed", func(t *testing.T) { fakeStore.On("ValidateDashboardBeforeSave", mock.Anything, mock.Anything).Return(true, nil).Once() fakeStore.On("SaveDashboard", mock.Anything).Return(&models.Dashboard{Data: simplejson.New()}, nil).Once() fakeStore.On("SaveAlerts", mock.Anything, mock.Anything, mock.Anything).Return(nil).Once() dto.Dashboard = models.NewDashboard("Dash") dto.Dashboard.SetId(3) dto.User = &models.SignedInUser{UserId: 1} _, err := service.SaveDashboard(context.Background(), dto, true) require.NoError(t, err) }) t.Run("Should return validation error if alert data is invalid", func(t *testing.T) { fakeStore.On("ValidateDashboardBeforeSave", mock.Anything, mock.Anything).Return(true, nil).Once() fakeStore.On("GetProvisionedDataByDashboardID", mock.Anything).Return(nil, nil).Once() fakeStore.On("SaveDashboard", mock.Anything).Return(&models.Dashboard{Data: simplejson.New()}, nil).Once() fakeStore.On("SaveAlerts", mock.Anything, mock.Anything, mock.Anything).Return(errors.New("alert validation error")).Once() dto.Dashboard = models.NewDashboard("Dash") dto.User = &models.SignedInUser{UserId: 1} _, err := service.SaveDashboard(context.Background(), dto, false) require.Equal(t, err.Error(), "alert validation error") }) }) t.Run("Save provisioned dashboard validation", func(t *testing.T) { dto := &m.SaveDashboardDTO{} t.Run("Should not return validation error if dashboard is provisioned", func(t *testing.T) { fakeStore.On("ValidateDashboardBeforeSave", mock.Anything, mock.Anything).Return(true, nil).Once() fakeStore.On("SaveProvisionedDashboard", mock.Anything, mock.Anything).Return(&models.Dashboard{Data: simplejson.New()}, nil).Once() fakeStore.On("SaveAlerts", mock.Anything, mock.Anything, mock.Anything).Return(nil).Once() dto.Dashboard = models.NewDashboard("Dash") dto.Dashboard.SetId(3) dto.User = &models.SignedInUser{UserId: 1} _, err := service.SaveProvisionedDashboard(context.Background(), dto, nil) require.NoError(t, err) }) t.Run("Should override invalid refresh interval if dashboard is provisioned", func(t *testing.T) { fakeStore.On("ValidateDashboardBeforeSave", mock.Anything, mock.Anything).Return(true, nil).Once() fakeStore.On("SaveProvisionedDashboard", mock.Anything, mock.Anything).Return(&models.Dashboard{Data: simplejson.New()}, nil).Once() fakeStore.On("SaveAlerts", mock.Anything, mock.Anything, mock.Anything).Return(nil).Once() oldRefreshInterval := setting.MinRefreshInterval setting.MinRefreshInterval = "5m" defer func() { setting.MinRefreshInterval = oldRefreshInterval }() dto.Dashboard = models.NewDashboard("Dash") dto.Dashboard.SetId(3) dto.User = &models.SignedInUser{UserId: 1} dto.Dashboard.Data.Set("refresh", "1s") _, err := service.SaveProvisionedDashboard(context.Background(), dto, nil) require.NoError(t, err) require.Equal(t, dto.Dashboard.Data.Get("refresh").MustString(), "5m") }) }) t.Run("Import dashboard validation", func(t *testing.T) { dto := &m.SaveDashboardDTO{} t.Run("Should return validation error if dashboard is provisioned", func(t *testing.T) { fakeStore.On("ValidateDashboardBeforeSave", mock.Anything, mock.Anything).Return(true, nil).Once() fakeStore.On("GetProvisionedDataByDashboardID", mock.Anything).Return(&models.DashboardProvisioning{}, nil).Once() dto.Dashboard = models.NewDashboard("Dash") dto.Dashboard.SetId(3) dto.User = &models.SignedInUser{UserId: 1} _, err := service.ImportDashboard(context.Background(), dto) require.Equal(t, err, models.ErrDashboardCannotSaveProvisionedDashboard) }) }) t.Run("Given provisioned dashboard", func(t *testing.T) { t.Run("DeleteProvisionedDashboard should delete it", func(t *testing.T) { result := setupDeleteHandlers(t) err := service.DeleteProvisionedDashboard(context.Background(), 1, 1) require.NoError(t, err) require.True(t, result.deleteWasCalled) }) t.Run("DeleteDashboard should fail to delete it", func(t *testing.T) { fakeStore.On("GetProvisionedDataByDashboardID", mock.Anything).Return(&models.DashboardProvisioning{}, nil).Once() result := setupDeleteHandlers(t) err := service.DeleteDashboard(context.Background(), 1, 1) require.Equal(t, err, models.ErrDashboardCannotDeleteProvisionedDashboard) require.False(t, result.deleteWasCalled) }) }) t.Run("Given non provisioned dashboard", func(t *testing.T) { result := setupDeleteHandlers(t) t.Run("DeleteProvisionedDashboard should delete it", func(t *testing.T) { err := service.DeleteProvisionedDashboard(context.Background(), 1, 1) require.NoError(t, err) require.True(t, result.deleteWasCalled) }) t.Run("DeleteDashboard should delete it", func(t *testing.T) { fakeStore.On("GetProvisionedDataByDashboardID", mock.Anything).Return(nil, nil).Once() err := service.DeleteDashboard(context.Background(), 1, 1) require.NoError(t, err) require.True(t, result.deleteWasCalled) }) }) }) } type Result struct { deleteWasCalled bool } func setupDeleteHandlers(t *testing.T) *Result { t.Helper() result := &Result{} bus.AddHandler("test", func(ctx context.Context, cmd *models.DeleteDashboardCommand) error { require.Equal(t, cmd.Id, int64(1)) require.Equal(t, cmd.OrgId, int64(1)) result.deleteWasCalled = true return nil }) return result }