backend/services: Move GetDashboard from sqlstore to dashboard service (#48971)

* rename folder to match package name
* backend/sqlstore: move GetDashboard into DashboardService

This is a stepping-stone commit which copies the GetDashboard function - which lets us remove the sqlstore from the interfaces in dashboards - without changing any other callers.
* checkpoint: moving GetDashboard calls into dashboard service
* finish refactoring api tests for dashboardService.GetDashboard

pkg/services/sqlstore/dashboard.go

@@ -29,28 +29,6 @@ func init() {
 
 var generateNewUid func() string = util.GenerateShortUID
 
-func (ss *SQLStore) GetDashboard(ctx context.Context, query *models.GetDashboardQuery) error {
-	return ss.WithDbSession(ctx, func(dbSession *DBSession) error {
-		if query.Id == 0 && len(query.Slug) == 0 && len(query.Uid) == 0 {
-			return models.ErrDashboardIdentifierNotSet
-		}
-
-		dashboard := models.Dashboard{Slug: query.Slug, OrgId: query.OrgId, Id: query.Id, Uid: query.Uid}
-		has, err := dbSession.Get(&dashboard)
-
-		if err != nil {
-			return err
-		} else if !has {
-			return models.ErrDashboardNotFound
-		}
-
-		dashboard.SetId(dashboard.Id)
-		dashboard.SetUid(dashboard.Uid)
-		query.Result = &dashboard
-		return nil
-	})
-}
-
 type DashboardSearchProjection struct {
 	ID          int64  `xorm:"id"`
 	UID         string `xorm:"uid"`

pkg/services/sqlstore/dashboard_version_test.go

@@ -9,11 +9,12 @@ import (
 	"testing"
 	"time"
 
+	"github.com/stretchr/testify/require"
+
 	"github.com/grafana/grafana/pkg/components/simplejson"
 	"github.com/grafana/grafana/pkg/models"
 	"github.com/grafana/grafana/pkg/setting"
 	"github.com/grafana/grafana/pkg/util"
-	"github.com/stretchr/testify/require"
 )
 
 func updateTestDashboard(t *testing.T, sqlStore *SQLStore, dashboard *models.Dashboard, data map[string]interface{}) {
@@ -94,14 +95,13 @@ func TestGetDashboardVersion(t *testing.T) {
 		require.Equal(t, query.DashboardId, savedDash.Id)
 		require.Equal(t, query.Version, savedDash.Version)
 
-		dashCmd := models.GetDashboardQuery{
-			OrgId: savedDash.OrgId,
+		dashCmd := &models.Dashboard{
 			Uid:   savedDash.Uid,
+			OrgId: savedDash.OrgId,
 		}
-
-		err = sqlStore.GetDashboard(context.Background(), &dashCmd)
+		err = getDashboard(t, sqlStore, dashCmd)
 		require.Nil(t, err)
-		eq := reflect.DeepEqual(dashCmd.Result.Data, query.Result.Data)
+		eq := reflect.DeepEqual(dashCmd.Data, query.Result.Data)
 		require.Equal(t, true, eq)
 	})
 
@@ -222,3 +222,20 @@ func TestDeleteExpiredVersions(t *testing.T) {
 		require.LessOrEqual(t, versionsToWriteBigNumber-len(query.Result), perBatch*maxBatches)
 	})
 }
+
+func getDashboard(t *testing.T, sqlStore *SQLStore, dashboard *models.Dashboard) error {
+	t.Helper()
+	return sqlStore.WithDbSession(context.Background(), func(sess *DBSession) error {
+		has, err := sess.Get(dashboard)
+
+		if err != nil {
+			return err
+		} else if !has {
+			return models.ErrDashboardNotFound
+		}
+
+		dashboard.SetId(dashboard.Id)
+		dashboard.SetUid(dashboard.Uid)
+		return nil
+	})
+}

pkg/services/sqlstore/mockstore/mockstore.go

@@ -20,7 +20,6 @@ type SQLStoreMock struct {
 	ExpectedDatasource             *models.DataSource
 	ExpectedAlert                  *models.Alert
 	ExpectedPluginSetting          *models.PluginSetting
-	ExpectedDashboard              *models.Dashboard
 	ExpectedDashboards             []*models.Dashboard
 	ExpectedDashboardVersion       *models.DashboardVersion
 	ExpectedDashboardVersions      []*models.DashboardVersion
@@ -466,11 +465,6 @@ func (m *SQLStoreMock) SaveDashboard(cmd models.SaveDashboardCommand) (*models.D
 	return nil, m.ExpectedError
 }
 
-func (m *SQLStoreMock) GetDashboard(ctx context.Context, query *models.GetDashboardQuery) error {
-	query.Result = m.ExpectedDashboard
-	return m.ExpectedError
-}
-
 func (m SQLStoreMock) SearchDashboards(ctx context.Context, query *models.FindPersistedDashboardsQuery) error {
 	query.Result = m.ExpectedPersistedDashboards
 	return m.ExpectedError

pkg/services/sqlstore/store.go

@@ -100,7 +100,6 @@ type Store interface {
 	GetOrgUsers(ctx context.Context, query *models.GetOrgUsersQuery) error
 	SearchOrgUsers(ctx context.Context, query *models.SearchOrgUsersQuery) error
 	RemoveOrgUser(ctx context.Context, cmd *models.RemoveOrgUserCommand) error
-	GetDashboard(ctx context.Context, query *models.GetDashboardQuery) error
 	GetDashboardTags(ctx context.Context, query *models.GetDashboardTagsQuery) error
 	SearchDashboards(ctx context.Context, query *models.FindPersistedDashboardsQuery) error
 	GetDashboards(ctx context.Context, query *models.GetDashboardsQuery) error