mirror of https://github.com/grafana/grafana.git
				
				
				
			
		
			
				
	
	
		
			1124 lines
		
	
	
		
			44 KiB
		
	
	
	
		
			Go
		
	
	
	
			
		
		
	
	
			1124 lines
		
	
	
		
			44 KiB
		
	
	
	
		
			Go
		
	
	
	
| package api
 | |
| 
 | |
| import (
 | |
| 	"bytes"
 | |
| 	"context"
 | |
| 	"encoding/json"
 | |
| 	"fmt"
 | |
| 	"net/http"
 | |
| 	"os"
 | |
| 	"strconv"
 | |
| 	"testing"
 | |
| 	"time"
 | |
| 
 | |
| 	"github.com/stretchr/testify/assert"
 | |
| 	"github.com/stretchr/testify/mock"
 | |
| 	"github.com/stretchr/testify/require"
 | |
| 
 | |
| 	"github.com/grafana/grafana/pkg/api/dtos"
 | |
| 	"github.com/grafana/grafana/pkg/api/response"
 | |
| 	"github.com/grafana/grafana/pkg/api/routing"
 | |
| 	"github.com/grafana/grafana/pkg/apimachinery/identity"
 | |
| 	"github.com/grafana/grafana/pkg/bus"
 | |
| 	"github.com/grafana/grafana/pkg/components/simplejson"
 | |
| 	"github.com/grafana/grafana/pkg/infra/db"
 | |
| 	"github.com/grafana/grafana/pkg/infra/db/dbtest"
 | |
| 	"github.com/grafana/grafana/pkg/infra/kvstore"
 | |
| 	"github.com/grafana/grafana/pkg/infra/localcache"
 | |
| 	"github.com/grafana/grafana/pkg/infra/log"
 | |
| 	"github.com/grafana/grafana/pkg/infra/serverlock"
 | |
| 	"github.com/grafana/grafana/pkg/infra/tracing"
 | |
| 	"github.com/grafana/grafana/pkg/infra/usagestats"
 | |
| 	"github.com/grafana/grafana/pkg/services/accesscontrol"
 | |
| 	"github.com/grafana/grafana/pkg/services/accesscontrol/acimpl"
 | |
| 	"github.com/grafana/grafana/pkg/services/accesscontrol/actest"
 | |
| 	accesscontrolmock "github.com/grafana/grafana/pkg/services/accesscontrol/mock"
 | |
| 	"github.com/grafana/grafana/pkg/services/annotations/annotationstest"
 | |
| 	"github.com/grafana/grafana/pkg/services/apiserver"
 | |
| 	"github.com/grafana/grafana/pkg/services/apiserver/client"
 | |
| 	contextmodel "github.com/grafana/grafana/pkg/services/contexthandler/model"
 | |
| 	"github.com/grafana/grafana/pkg/services/dashboards"
 | |
| 	"github.com/grafana/grafana/pkg/services/dashboards/database"
 | |
| 	"github.com/grafana/grafana/pkg/services/dashboards/service"
 | |
| 	dashver "github.com/grafana/grafana/pkg/services/dashboardversion"
 | |
| 	"github.com/grafana/grafana/pkg/services/dashboardversion/dashvertest"
 | |
| 	"github.com/grafana/grafana/pkg/services/featuremgmt"
 | |
| 	"github.com/grafana/grafana/pkg/services/folder"
 | |
| 	"github.com/grafana/grafana/pkg/services/folder/folderimpl"
 | |
| 	"github.com/grafana/grafana/pkg/services/folder/foldertest"
 | |
| 	"github.com/grafana/grafana/pkg/services/guardian"
 | |
| 	libraryelementsfake "github.com/grafana/grafana/pkg/services/libraryelements/fake"
 | |
| 	"github.com/grafana/grafana/pkg/services/librarypanels"
 | |
| 	"github.com/grafana/grafana/pkg/services/licensing/licensingtest"
 | |
| 	"github.com/grafana/grafana/pkg/services/live"
 | |
| 	"github.com/grafana/grafana/pkg/services/org"
 | |
| 	"github.com/grafana/grafana/pkg/services/pluginsintegration/pluginstore"
 | |
| 	pref "github.com/grafana/grafana/pkg/services/preference"
 | |
| 	"github.com/grafana/grafana/pkg/services/preference/preftest"
 | |
| 	"github.com/grafana/grafana/pkg/services/provisioning"
 | |
| 	"github.com/grafana/grafana/pkg/services/publicdashboards"
 | |
| 	"github.com/grafana/grafana/pkg/services/publicdashboards/api"
 | |
| 	publicdashboardModels "github.com/grafana/grafana/pkg/services/publicdashboards/models"
 | |
| 	"github.com/grafana/grafana/pkg/services/quota/quotatest"
 | |
| 	"github.com/grafana/grafana/pkg/services/search/sort"
 | |
| 	"github.com/grafana/grafana/pkg/services/star/startest"
 | |
| 	"github.com/grafana/grafana/pkg/services/supportbundles/supportbundlestest"
 | |
| 	"github.com/grafana/grafana/pkg/services/tag/tagimpl"
 | |
| 	"github.com/grafana/grafana/pkg/services/user"
 | |
| 	"github.com/grafana/grafana/pkg/services/user/usertest"
 | |
| 	"github.com/grafana/grafana/pkg/setting"
 | |
| 	"github.com/grafana/grafana/pkg/storage/legacysql/dualwrite"
 | |
| 	"github.com/grafana/grafana/pkg/web"
 | |
| 	"github.com/grafana/grafana/pkg/web/webtest"
 | |
| )
 | |
| 
 | |
| func TestGetHomeDashboard(t *testing.T) {
 | |
| 	httpReq, err := http.NewRequest(http.MethodGet, "", nil)
 | |
| 	require.NoError(t, err)
 | |
| 	httpReq.Header.Add("Content-Type", "application/json")
 | |
| 	req := &contextmodel.ReqContext{SignedInUser: &user.SignedInUser{}, Context: &web.Context{Req: httpReq}}
 | |
| 	cfg := setting.NewCfg()
 | |
| 	cfg.StaticRootPath = "../../public/"
 | |
| 	prefService := preftest.NewPreferenceServiceFake()
 | |
| 	dashboardVersionService := dashvertest.NewDashboardVersionServiceFake()
 | |
| 
 | |
| 	hs := &HTTPServer{
 | |
| 		Cfg:                     cfg,
 | |
| 		pluginStore:             &pluginstore.FakePluginStore{},
 | |
| 		SQLStore:                dbtest.NewFakeDB(),
 | |
| 		preferenceService:       prefService,
 | |
| 		dashboardVersionService: dashboardVersionService,
 | |
| 		log:                     log.New("test-logger"),
 | |
| 		tracer:                  tracing.InitializeTracerForTest(),
 | |
| 	}
 | |
| 
 | |
| 	tests := []struct {
 | |
| 		name                  string
 | |
| 		defaultSetting        string
 | |
| 		expectedDashboardPath string
 | |
| 	}{
 | |
| 		{name: "using default config", defaultSetting: "", expectedDashboardPath: "../../public/dashboards/home.json"},
 | |
| 		{name: "custom path", defaultSetting: "../../public/dashboards/default.json", expectedDashboardPath: "../../public/dashboards/default.json"},
 | |
| 	}
 | |
| 
 | |
| 	for _, tc := range tests {
 | |
| 		t.Run(tc.name, func(t *testing.T) {
 | |
| 			dash := dtos.DashboardFullWithMeta{}
 | |
| 			dash.Meta.FolderTitle = "General"
 | |
| 
 | |
| 			homeDashJSON, err := os.ReadFile(tc.expectedDashboardPath)
 | |
| 			require.NoError(t, err, "must be able to read expected dashboard file")
 | |
| 			hs.Cfg.DefaultHomeDashboardPath = tc.defaultSetting
 | |
| 			bytes, err := simplejson.NewJson(homeDashJSON)
 | |
| 			require.NoError(t, err, "must be able to encode file as JSON")
 | |
| 
 | |
| 			prefService.ExpectedPreference = &pref.Preference{}
 | |
| 
 | |
| 			dash.Dashboard = bytes
 | |
| 
 | |
| 			b, err := json.Marshal(dash)
 | |
| 			require.NoError(t, err, "must be able to marshal object to JSON")
 | |
| 
 | |
| 			res := hs.GetHomeDashboard(req)
 | |
| 			nr, ok := res.(*response.NormalResponse)
 | |
| 			require.True(t, ok, "should return *NormalResponse")
 | |
| 			require.Equal(t, b, nr.Body(), "default home dashboard should equal content on disk")
 | |
| 		})
 | |
| 	}
 | |
| }
 | |
| 
 | |
| func newTestLive(t *testing.T, store db.DB) *live.GrafanaLive {
 | |
| 	features := featuremgmt.WithFeatures()
 | |
| 	cfg := setting.NewCfg()
 | |
| 	cfg.AppURL = "http://localhost:3000/"
 | |
| 	gLive, err := live.ProvideService(nil, cfg,
 | |
| 		routing.NewRouteRegister(),
 | |
| 		nil, nil, nil, nil,
 | |
| 		store,
 | |
| 		nil,
 | |
| 		&usagestats.UsageStatsMock{T: t},
 | |
| 		nil,
 | |
| 		features, acimpl.ProvideAccessControl(features),
 | |
| 		&dashboards.FakeDashboardService{},
 | |
| 		annotationstest.NewFakeAnnotationsRepo(),
 | |
| 		nil, nil)
 | |
| 	require.NoError(t, err)
 | |
| 	return gLive
 | |
| }
 | |
| 
 | |
| func TestHTTPServer_GetDashboard_AccessControl(t *testing.T) {
 | |
| 	setup := func() *webtest.Server {
 | |
| 		return SetupAPITestServer(t, func(hs *HTTPServer) {
 | |
| 			dash := dashboards.NewDashboard("some dash")
 | |
| 			dash.ID = 1
 | |
| 			dash.UID = "1"
 | |
| 
 | |
| 			dashSvc := dashboards.NewFakeDashboardService(t)
 | |
| 			dashSvc.On("GetDashboard", mock.Anything, mock.Anything).Return(dash, nil).Maybe()
 | |
| 			hs.DashboardService = dashSvc
 | |
| 
 | |
| 			hs.Cfg = setting.NewCfg()
 | |
| 			hs.AccessControl = acimpl.ProvideAccessControl(featuremgmt.WithFeatures())
 | |
| 			hs.starService = startest.NewStarServiceFake()
 | |
| 			hs.dashboardProvisioningService = mockDashboardProvisioningService{}
 | |
| 
 | |
| 			guardian.InitAccessControlGuardian(hs.Cfg, hs.AccessControl, hs.DashboardService, hs.folderService, log.NewNopLogger())
 | |
| 		})
 | |
| 	}
 | |
| 
 | |
| 	getDashboard := func(server *webtest.Server, permissions []accesscontrol.Permission) (*http.Response, error) {
 | |
| 		return server.Send(webtest.RequestWithSignedInUser(server.NewGetRequest("/api/dashboards/uid/1"), userWithPermissions(1, permissions)))
 | |
| 	}
 | |
| 
 | |
| 	t.Run("Should not be able to get dashboard without correct permission", func(t *testing.T) {
 | |
| 		server := setup()
 | |
| 
 | |
| 		res, err := getDashboard(server, nil)
 | |
| 		require.NoError(t, err)
 | |
| 
 | |
| 		assert.Equal(t, http.StatusForbidden, res.StatusCode)
 | |
| 		require.NoError(t, res.Body.Close())
 | |
| 	})
 | |
| 
 | |
| 	t.Run("Should be able to get when user has permission to read dashboard", func(t *testing.T) {
 | |
| 		server := setup()
 | |
| 
 | |
| 		permissions := []accesscontrol.Permission{{Action: dashboards.ActionDashboardsRead, Scope: "dashboards:uid:1"}}
 | |
| 		res, err := getDashboard(server, permissions)
 | |
| 		require.NoError(t, err)
 | |
| 
 | |
| 		assert.Equal(t, http.StatusOK, res.StatusCode)
 | |
| 		var data dtos.DashboardFullWithMeta
 | |
| 		require.NoError(t, json.NewDecoder(res.Body).Decode(&data))
 | |
| 
 | |
| 		assert.Equal(t, data.Meta.CanSave, false)
 | |
| 		assert.Equal(t, data.Meta.CanEdit, false)
 | |
| 		assert.Equal(t, data.Meta.CanDelete, false)
 | |
| 		assert.Equal(t, data.Meta.CanAdmin, false)
 | |
| 
 | |
| 		require.NoError(t, res.Body.Close())
 | |
| 	})
 | |
| 
 | |
| 	t.Run("Should set CanSave and CanEdit with correct permissions", func(t *testing.T) {
 | |
| 		server := setup()
 | |
| 
 | |
| 		res, err := getDashboard(server, []accesscontrol.Permission{
 | |
| 			{Action: dashboards.ActionDashboardsRead, Scope: "dashboards:uid:1"},
 | |
| 			{Action: dashboards.ActionDashboardsWrite, Scope: "dashboards:uid:1"},
 | |
| 		})
 | |
| 		require.NoError(t, err)
 | |
| 
 | |
| 		assert.Equal(t, http.StatusOK, res.StatusCode)
 | |
| 		var data dtos.DashboardFullWithMeta
 | |
| 		require.NoError(t, json.NewDecoder(res.Body).Decode(&data))
 | |
| 
 | |
| 		assert.Equal(t, data.Meta.CanSave, true)
 | |
| 		assert.Equal(t, data.Meta.CanEdit, true)
 | |
| 		assert.Equal(t, data.Meta.CanDelete, false)
 | |
| 		assert.Equal(t, data.Meta.CanAdmin, false)
 | |
| 
 | |
| 		require.NoError(t, res.Body.Close())
 | |
| 	})
 | |
| 
 | |
| 	t.Run("Should set canDelete with correct permissions", func(t *testing.T) {
 | |
| 		server := setup()
 | |
| 
 | |
| 		res, err := getDashboard(server, []accesscontrol.Permission{
 | |
| 			{Action: dashboards.ActionDashboardsRead, Scope: "dashboards:uid:1"},
 | |
| 			{Action: dashboards.ActionDashboardsDelete, Scope: "dashboards:uid:1"},
 | |
| 		})
 | |
| 		require.NoError(t, err)
 | |
| 
 | |
| 		assert.Equal(t, http.StatusOK, res.StatusCode)
 | |
| 		var data dtos.DashboardFullWithMeta
 | |
| 		require.NoError(t, json.NewDecoder(res.Body).Decode(&data))
 | |
| 
 | |
| 		assert.Equal(t, data.Meta.CanSave, false)
 | |
| 		assert.Equal(t, data.Meta.CanEdit, false)
 | |
| 		assert.Equal(t, data.Meta.CanDelete, true)
 | |
| 		assert.Equal(t, data.Meta.CanAdmin, false)
 | |
| 
 | |
| 		require.NoError(t, res.Body.Close())
 | |
| 	})
 | |
| 
 | |
| 	t.Run("Should set canAdmin with correct permissions", func(t *testing.T) {
 | |
| 		server := setup()
 | |
| 
 | |
| 		res, err := getDashboard(server, []accesscontrol.Permission{
 | |
| 			{Action: dashboards.ActionDashboardsRead, Scope: "dashboards:uid:1"},
 | |
| 			{Action: dashboards.ActionDashboardsPermissionsRead, Scope: "dashboards:uid:1"},
 | |
| 			{Action: dashboards.ActionDashboardsPermissionsWrite, Scope: "dashboards:uid:1"},
 | |
| 		})
 | |
| 		require.NoError(t, err)
 | |
| 
 | |
| 		assert.Equal(t, http.StatusOK, res.StatusCode)
 | |
| 		var data dtos.DashboardFullWithMeta
 | |
| 		require.NoError(t, json.NewDecoder(res.Body).Decode(&data))
 | |
| 
 | |
| 		assert.Equal(t, data.Meta.CanSave, false)
 | |
| 		assert.Equal(t, data.Meta.CanEdit, false)
 | |
| 		assert.Equal(t, data.Meta.CanDelete, false)
 | |
| 		assert.Equal(t, data.Meta.CanAdmin, true)
 | |
| 
 | |
| 		require.NoError(t, res.Body.Close())
 | |
| 	})
 | |
| }
 | |
| 
 | |
| func TestHTTPServer_DeleteDashboardByUID_AccessControl(t *testing.T) {
 | |
| 	setup := func() *webtest.Server {
 | |
| 		return SetupAPITestServer(t, func(hs *HTTPServer) {
 | |
| 			dash := dashboards.NewDashboard("some dash")
 | |
| 			dash.ID = 1
 | |
| 			dash.UID = "1"
 | |
| 
 | |
| 			dashSvc := dashboards.NewFakeDashboardService(t)
 | |
| 			dashSvc.On("GetDashboard", mock.Anything, mock.Anything).Return(dash, nil).Maybe()
 | |
| 			dashSvc.On("DeleteDashboard", mock.Anything, mock.Anything, mock.Anything, mock.Anything).Return(nil).Maybe()
 | |
| 			hs.DashboardService = dashSvc
 | |
| 
 | |
| 			hs.Cfg = setting.NewCfg()
 | |
| 			hs.AccessControl = acimpl.ProvideAccessControl(featuremgmt.WithFeatures())
 | |
| 			hs.starService = startest.NewStarServiceFake()
 | |
| 
 | |
| 			hs.LibraryPanelService = &mockLibraryPanelService{}
 | |
| 			hs.LibraryElementService = &libraryelementsfake.LibraryElementService{}
 | |
| 
 | |
| 			middleware := publicdashboards.NewFakePublicDashboardMiddleware(t)
 | |
| 			license := licensingtest.NewFakeLicensing()
 | |
| 			license.On("FeatureEnabled", publicdashboardModels.FeaturePublicDashboardsEmailSharing).Return(false)
 | |
| 			hs.PublicDashboardsApi = api.ProvideApi(nil, nil, hs.AccessControl, featuremgmt.WithFeatures(), middleware, hs.Cfg, license)
 | |
| 
 | |
| 			guardian.InitAccessControlGuardian(hs.Cfg, hs.AccessControl, hs.DashboardService, hs.folderService, log.NewNopLogger())
 | |
| 		})
 | |
| 	}
 | |
| 	deleteDashboard := func(server *webtest.Server, permissions []accesscontrol.Permission) (*http.Response, error) {
 | |
| 		return server.Send(webtest.RequestWithSignedInUser(server.NewRequest(http.MethodDelete, "/api/dashboards/uid/1", nil), userWithPermissions(1, permissions)))
 | |
| 	}
 | |
| 
 | |
| 	t.Run("Should not be able to delete dashboard without correct permission", func(t *testing.T) {
 | |
| 		server := setup()
 | |
| 		res, err := deleteDashboard(server, []accesscontrol.Permission{
 | |
| 			{Action: dashboards.ActionDashboardsDelete, Scope: "dashboards:uid:2"},
 | |
| 		})
 | |
| 		require.NoError(t, err)
 | |
| 
 | |
| 		assert.Equal(t, http.StatusForbidden, res.StatusCode)
 | |
| 		require.NoError(t, res.Body.Close())
 | |
| 	})
 | |
| 
 | |
| 	t.Run("Should be able to delete dashboard with correct permission", func(t *testing.T) {
 | |
| 		server := setup()
 | |
| 		res, err := deleteDashboard(server, []accesscontrol.Permission{
 | |
| 			{Action: dashboards.ActionDashboardsDelete, Scope: "dashboards:uid:1"},
 | |
| 		})
 | |
| 		require.NoError(t, err)
 | |
| 
 | |
| 		assert.Equal(t, http.StatusOK, res.StatusCode)
 | |
| 		require.NoError(t, res.Body.Close())
 | |
| 	})
 | |
| }
 | |
| 
 | |
| func TestHTTPServer_GetDashboardVersions_AccessControl(t *testing.T) {
 | |
| 	setup := func() *webtest.Server {
 | |
| 		return SetupAPITestServer(t, func(hs *HTTPServer) {
 | |
| 			dash := dashboards.NewDashboard("some dash")
 | |
| 			dash.ID = 1
 | |
| 			dash.UID = "1"
 | |
| 
 | |
| 			dashSvc := dashboards.NewFakeDashboardService(t)
 | |
| 			dashSvc.On("GetDashboard", mock.Anything, mock.Anything).Return(dash, nil).Maybe()
 | |
| 			dashSvc.On("DeleteDashboard", mock.Anything, mock.Anything, mock.Anything).Return(nil).Maybe()
 | |
| 			hs.DashboardService = dashSvc
 | |
| 
 | |
| 			hs.Cfg = setting.NewCfg()
 | |
| 			hs.AccessControl = acimpl.ProvideAccessControl(featuremgmt.WithFeatures())
 | |
| 			hs.starService = startest.NewStarServiceFake()
 | |
| 
 | |
| 			expectedDashVersions := []*dashver.DashboardVersionDTO{
 | |
| 				{Data: simplejson.NewFromAny(map[string]any{"title": "Dash"})},
 | |
| 				{Data: simplejson.NewFromAny(map[string]any{"title": "Dash updated"})},
 | |
| 			}
 | |
| 
 | |
| 			hs.dashboardVersionService = &dashvertest.FakeDashboardVersionService{
 | |
| 				ExpectedListDashboarVersions: []*dashver.DashboardVersionDTO{},
 | |
| 				ExpectedDashboardVersions:    expectedDashVersions,
 | |
| 				ExpectedDashboardVersion:     &dashver.DashboardVersionDTO{},
 | |
| 			}
 | |
| 		})
 | |
| 	}
 | |
| 
 | |
| 	getVersion := func(server *webtest.Server, permissions []accesscontrol.Permission) (*http.Response, error) {
 | |
| 		return server.Send(webtest.RequestWithSignedInUser(server.NewGetRequest("/api/dashboards/uid/1/versions/1"), userWithPermissions(1, permissions)))
 | |
| 	}
 | |
| 
 | |
| 	getVersions := func(server *webtest.Server, permissions []accesscontrol.Permission) (*http.Response, error) {
 | |
| 		return server.Send(webtest.RequestWithSignedInUser(server.NewGetRequest("/api/dashboards/uid/1/versions"), userWithPermissions(1, permissions)))
 | |
| 	}
 | |
| 
 | |
| 	calculateDiff := func(server *webtest.Server, permissions []accesscontrol.Permission) (*http.Response, error) {
 | |
| 		cmd := &dtos.CalculateDiffOptions{
 | |
| 			Base:     dtos.CalculateDiffTarget{DashboardId: 1, Version: 1},
 | |
| 			New:      dtos.CalculateDiffTarget{DashboardId: 1, Version: 2},
 | |
| 			DiffType: "json",
 | |
| 		}
 | |
| 		jsonBytes, err := json.Marshal(cmd)
 | |
| 		require.NoError(t, err)
 | |
| 		return server.SendJSON(webtest.RequestWithSignedInUser(server.NewPostRequest("/api/dashboards/calculate-diff", bytes.NewReader(jsonBytes)), userWithPermissions(1, permissions)))
 | |
| 	}
 | |
| 
 | |
| 	t.Run("Should not be able to list dashboard versions without correct permission", func(t *testing.T) {
 | |
| 		server := setup()
 | |
| 
 | |
| 		res, err := getVersions(server, []accesscontrol.Permission{})
 | |
| 		require.NoError(t, err)
 | |
| 		assert.Equal(t, http.StatusForbidden, res.StatusCode)
 | |
| 		require.NoError(t, res.Body.Close())
 | |
| 
 | |
| 		res, err = getVersion(server, []accesscontrol.Permission{})
 | |
| 		require.NoError(t, err)
 | |
| 		assert.Equal(t, http.StatusForbidden, res.StatusCode)
 | |
| 
 | |
| 		require.NoError(t, res.Body.Close())
 | |
| 	})
 | |
| 
 | |
| 	t.Run("Should be able to list dashboard versions with correct permission", func(t *testing.T) {
 | |
| 		server := setup()
 | |
| 
 | |
| 		permissions := []accesscontrol.Permission{
 | |
| 			{Action: dashboards.ActionDashboardsWrite, Scope: "dashboards:uid:1"},
 | |
| 		}
 | |
| 
 | |
| 		res, err := getVersions(server, permissions)
 | |
| 		require.NoError(t, err)
 | |
| 		assert.Equal(t, http.StatusOK, res.StatusCode)
 | |
| 		require.NoError(t, res.Body.Close())
 | |
| 
 | |
| 		res, err = getVersion(server, permissions)
 | |
| 		require.NoError(t, err)
 | |
| 		assert.Equal(t, http.StatusOK, res.StatusCode)
 | |
| 
 | |
| 		require.NoError(t, res.Body.Close())
 | |
| 	})
 | |
| 
 | |
| 	t.Run("Should be able to diff dashboards with correct permissions", func(t *testing.T) {
 | |
| 		server := setup()
 | |
| 
 | |
| 		permissions := []accesscontrol.Permission{
 | |
| 			{Action: dashboards.ActionDashboardsWrite, Scope: dashboards.ScopeDashboardsAll},
 | |
| 		}
 | |
| 
 | |
| 		res, err := calculateDiff(server, permissions)
 | |
| 		require.NoError(t, err)
 | |
| 		assert.Equal(t, http.StatusOK, res.StatusCode)
 | |
| 		require.NoError(t, res.Body.Close())
 | |
| 	})
 | |
| 
 | |
| 	t.Run("Should not be able to diff dashboards without permissions", func(t *testing.T) {
 | |
| 		server := setup()
 | |
| 
 | |
| 		res, err := calculateDiff(server, []accesscontrol.Permission{})
 | |
| 		require.NoError(t, err)
 | |
| 		assert.Equal(t, http.StatusForbidden, res.StatusCode)
 | |
| 		require.NoError(t, res.Body.Close())
 | |
| 	})
 | |
| }
 | |
| 
 | |
| func TestDashboardAPIEndpoint(t *testing.T) {
 | |
| 	t.Run("Given two dashboards with the same title in different folders", func(t *testing.T) {
 | |
| 		dashOne := dashboards.NewDashboard("dash")
 | |
| 		dashOne.ID = 2
 | |
| 		dashOne.FolderUID = "folderUID"
 | |
| 		dashOne.HasACL = false
 | |
| 
 | |
| 		dashTwo := dashboards.NewDashboard("dash")
 | |
| 		dashTwo.ID = 4
 | |
| 		dashTwo.FolderUID = "folderUID2"
 | |
| 		dashTwo.HasACL = false
 | |
| 	})
 | |
| 
 | |
| 	t.Run("Post dashboard response tests", func(t *testing.T) {
 | |
| 		dashboardStore := &dashboards.FakeDashboardStore{}
 | |
| 		defer dashboardStore.AssertExpectations(t)
 | |
| 		// This tests that a valid request returns correct response
 | |
| 		t.Run("Given a correct request for creating a dashboard", func(t *testing.T) {
 | |
| 			folderUID := "Folder"
 | |
| 			const dashID int64 = 2
 | |
| 
 | |
| 			cmd := dashboards.SaveDashboardCommand{
 | |
| 				OrgID:  1,
 | |
| 				UserID: 5,
 | |
| 				Dashboard: simplejson.NewFromAny(map[string]any{
 | |
| 					"title": "Dash",
 | |
| 				}),
 | |
| 				Overwrite: true,
 | |
| 				FolderUID: folderUID,
 | |
| 				IsFolder:  false,
 | |
| 				Message:   "msg",
 | |
| 			}
 | |
| 
 | |
| 			dashboardService := dashboards.NewFakeDashboardService(t)
 | |
| 			dashboardService.On("SaveDashboard", mock.Anything, mock.AnythingOfType("*dashboards.SaveDashboardDTO"), mock.AnythingOfType("bool")).
 | |
| 				Return(&dashboards.Dashboard{ID: dashID, UID: "uid", Title: "Dash", Slug: "dash", Version: 2, FolderUID: folderUID}, nil)
 | |
| 			mockFolderService := &foldertest.FakeService{
 | |
| 				ExpectedFolder: &folder.Folder{UID: folderUID, Title: "Folder"},
 | |
| 			}
 | |
| 
 | |
| 			postDashboardScenario(t, "When calling POST on", "/api/dashboards", "/api/dashboards", cmd, dashboardService, mockFolderService, func(sc *scenarioContext) {
 | |
| 				callPostDashboardShouldReturnSuccess(sc)
 | |
| 
 | |
| 				result := sc.ToJSON()
 | |
| 				assert.Equal(t, "success", result.Get("status").MustString())
 | |
| 				assert.Equal(t, dashID, result.Get("id").MustInt64())
 | |
| 				assert.Equal(t, "uid", result.Get("uid").MustString())
 | |
| 				assert.Equal(t, "dash", result.Get("slug").MustString())
 | |
| 				assert.Equal(t, "/d/uid/dash", result.Get("url").MustString())
 | |
| 			})
 | |
| 		})
 | |
| 
 | |
| 		t.Run("Given a correct request for creating a dashboard with folder uid", func(t *testing.T) {
 | |
| 			const folderUid string = "folderUID"
 | |
| 			const dashID int64 = 2
 | |
| 
 | |
| 			cmd := dashboards.SaveDashboardCommand{
 | |
| 				OrgID:  1,
 | |
| 				UserID: 5,
 | |
| 				Dashboard: simplejson.NewFromAny(map[string]any{
 | |
| 					"title": "Dash",
 | |
| 				}),
 | |
| 				Overwrite: true,
 | |
| 				FolderUID: folderUid,
 | |
| 				IsFolder:  false,
 | |
| 				Message:   "msg",
 | |
| 			}
 | |
| 
 | |
| 			dashboardService := dashboards.NewFakeDashboardService(t)
 | |
| 			dashboardService.On("SaveDashboard", mock.Anything, mock.AnythingOfType("*dashboards.SaveDashboardDTO"), mock.AnythingOfType("bool")).
 | |
| 				Return(&dashboards.Dashboard{ID: dashID, UID: "uid", Title: "Dash", Slug: "dash", Version: 2}, nil)
 | |
| 
 | |
| 			mockFolder := &foldertest.FakeService{
 | |
| 				ExpectedFolder: &folder.Folder{UID: "folderUID", Title: "Folder"},
 | |
| 			}
 | |
| 
 | |
| 			postDashboardScenario(t, "When calling POST on", "/api/dashboards", "/api/dashboards", cmd, dashboardService, mockFolder, func(sc *scenarioContext) {
 | |
| 				callPostDashboardShouldReturnSuccess(sc)
 | |
| 
 | |
| 				result := sc.ToJSON()
 | |
| 				assert.Equal(t, "success", result.Get("status").MustString())
 | |
| 				assert.Equal(t, dashID, result.Get("id").MustInt64())
 | |
| 				assert.Equal(t, "uid", result.Get("uid").MustString())
 | |
| 				assert.Equal(t, "dash", result.Get("slug").MustString())
 | |
| 				assert.Equal(t, "/d/uid/dash", result.Get("url").MustString())
 | |
| 			})
 | |
| 		})
 | |
| 
 | |
| 		// This tests that invalid requests returns expected error responses
 | |
| 		t.Run("Given incorrect requests for creating a dashboard", func(t *testing.T) {
 | |
| 			testCases := []struct {
 | |
| 				SaveError          error
 | |
| 				ExpectedStatusCode int
 | |
| 			}{
 | |
| 				{SaveError: dashboards.ErrDashboardNotFound, ExpectedStatusCode: http.StatusNotFound},
 | |
| 				{SaveError: dashboards.ErrFolderNotFound, ExpectedStatusCode: http.StatusBadRequest},
 | |
| 				{SaveError: dashboards.ErrDashboardWithSameUIDExists, ExpectedStatusCode: http.StatusBadRequest},
 | |
| 				{SaveError: dashboards.ErrDashboardVersionMismatch, ExpectedStatusCode: http.StatusPreconditionFailed},
 | |
| 				{SaveError: dashboards.ErrDashboardTitleEmpty, ExpectedStatusCode: http.StatusBadRequest},
 | |
| 				{SaveError: dashboards.ErrDashboardFolderCannotHaveParent, ExpectedStatusCode: http.StatusBadRequest},
 | |
| 				{SaveError: dashboards.ErrDashboardTypeMismatch, ExpectedStatusCode: http.StatusBadRequest},
 | |
| 				{SaveError: dashboards.ErrDashboardFolderNameExists, ExpectedStatusCode: http.StatusBadRequest},
 | |
| 				{SaveError: dashboards.ErrDashboardUpdateAccessDenied, ExpectedStatusCode: http.StatusForbidden},
 | |
| 				{SaveError: dashboards.ErrDashboardInvalidUid, ExpectedStatusCode: http.StatusBadRequest},
 | |
| 				{SaveError: dashboards.ErrDashboardUidTooLong, ExpectedStatusCode: http.StatusBadRequest},
 | |
| 				{SaveError: dashboards.ErrDashboardCannotSaveProvisionedDashboard, ExpectedStatusCode: http.StatusBadRequest},
 | |
| 				{SaveError: dashboards.UpdatePluginDashboardError{PluginId: "plug"}, ExpectedStatusCode: http.StatusPreconditionFailed},
 | |
| 			}
 | |
| 
 | |
| 			cmd := dashboards.SaveDashboardCommand{
 | |
| 				OrgID: 1,
 | |
| 				Dashboard: simplejson.NewFromAny(map[string]any{
 | |
| 					"title": "",
 | |
| 				}),
 | |
| 			}
 | |
| 
 | |
| 			for _, tc := range testCases {
 | |
| 				dashboardService := dashboards.NewFakeDashboardService(t)
 | |
| 				dashboardService.On("SaveDashboard", mock.Anything, mock.AnythingOfType("*dashboards.SaveDashboardDTO"), mock.AnythingOfType("bool")).Return(nil, tc.SaveError)
 | |
| 
 | |
| 				postDashboardScenario(t, fmt.Sprintf("Expect '%s' error when calling POST on", tc.SaveError.Error()),
 | |
| 					"/api/dashboards", "/api/dashboards", cmd, dashboardService, nil, func(sc *scenarioContext) {
 | |
| 						callPostDashboard(sc)
 | |
| 						assert.Equal(t, tc.ExpectedStatusCode, sc.resp.Code, sc.resp.Body.String())
 | |
| 					})
 | |
| 			}
 | |
| 		})
 | |
| 	})
 | |
| 
 | |
| 	t.Run("Given two dashboards being compared", func(t *testing.T) {
 | |
| 		fakeDashboardVersionService := dashvertest.NewDashboardVersionServiceFake()
 | |
| 		fakeDashboardVersionService.ExpectedDashboardVersions = []*dashver.DashboardVersionDTO{
 | |
| 			{
 | |
| 				DashboardID: 1,
 | |
| 				Version:     1,
 | |
| 				Data: simplejson.NewFromAny(map[string]any{
 | |
| 					"title": "Dash1",
 | |
| 				}),
 | |
| 			},
 | |
| 			{
 | |
| 				DashboardID: 2,
 | |
| 				Version:     2,
 | |
| 				Data: simplejson.NewFromAny(map[string]any{
 | |
| 					"title": "Dash2",
 | |
| 				}),
 | |
| 			},
 | |
| 		}
 | |
| 	})
 | |
| 
 | |
| 	t.Run("Given dashboard in folder being restored should restore to folder", func(t *testing.T) {
 | |
| 		fakeDash := dashboards.NewDashboard("Child dash")
 | |
| 		fakeDash.ID = 2
 | |
| 		fakeDash.HasACL = false
 | |
| 
 | |
| 		dashboardService := dashboards.NewFakeDashboardService(t)
 | |
| 		dashboardService.On("GetDashboard", mock.Anything, mock.AnythingOfType("*dashboards.GetDashboardQuery")).Return(fakeDash, nil)
 | |
| 		dashboardService.On("SaveDashboard", mock.Anything, mock.AnythingOfType("*dashboards.SaveDashboardDTO"), mock.AnythingOfType("bool")).Run(func(args mock.Arguments) {
 | |
| 			cmd := args.Get(1).(*dashboards.SaveDashboardDTO)
 | |
| 			cmd.Dashboard = &dashboards.Dashboard{
 | |
| 				ID: 2, UID: "uid", Title: "Dash", Slug: "dash", Version: 1,
 | |
| 			}
 | |
| 		}).Return(nil, nil)
 | |
| 
 | |
| 		cmd := dtos.RestoreDashboardVersionCommand{
 | |
| 			Version: 1,
 | |
| 		}
 | |
| 		fakeDashboardVersionService := dashvertest.NewDashboardVersionServiceFake()
 | |
| 		fakeDashboardVersionService.ExpectedDashboardVersions = []*dashver.DashboardVersionDTO{
 | |
| 			{
 | |
| 				DashboardID: 2,
 | |
| 				Version:     1,
 | |
| 				Data: simplejson.NewFromAny(map[string]any{
 | |
| 					"title": "Dash1",
 | |
| 				}),
 | |
| 			},
 | |
| 		}
 | |
| 		mockSQLStore := dbtest.NewFakeDB()
 | |
| 
 | |
| 		restoreDashboardVersionScenario(t, "When calling POST on", "/api/dashboards/id/1/restore",
 | |
| 			"/api/dashboards/id/:dashboardId/restore", dashboardService, fakeDashboardVersionService, cmd, func(sc *scenarioContext) {
 | |
| 				sc.dashboardVersionService = fakeDashboardVersionService
 | |
| 
 | |
| 				callRestoreDashboardVersion(sc)
 | |
| 				assert.Equal(t, http.StatusOK, sc.resp.Code)
 | |
| 			}, mockSQLStore)
 | |
| 	})
 | |
| 
 | |
| 	t.Run("Should not be able to restore to the same data", func(t *testing.T) {
 | |
| 		fakeDash := dashboards.NewDashboard("Child dash")
 | |
| 		fakeDash.ID = 2
 | |
| 		fakeDash.HasACL = false
 | |
| 
 | |
| 		dashboardService := dashboards.NewFakeDashboardService(t)
 | |
| 		dashboardService.On("GetDashboard", mock.Anything, mock.AnythingOfType("*dashboards.GetDashboardQuery")).Return(fakeDash, nil)
 | |
| 
 | |
| 		cmd := dtos.RestoreDashboardVersionCommand{
 | |
| 			Version: 1,
 | |
| 		}
 | |
| 		fakeDashboardVersionService := dashvertest.NewDashboardVersionServiceFake()
 | |
| 		fakeDashboardVersionService.ExpectedDashboardVersions = []*dashver.DashboardVersionDTO{
 | |
| 			{
 | |
| 				DashboardID: 2,
 | |
| 				Version:     1,
 | |
| 				Data:        fakeDash.Data,
 | |
| 			},
 | |
| 		}
 | |
| 		mockSQLStore := dbtest.NewFakeDB()
 | |
| 
 | |
| 		restoreDashboardVersionScenario(t, "When calling POST on", "/api/dashboards/id/1/restore",
 | |
| 			"/api/dashboards/id/:dashboardId/restore", dashboardService, fakeDashboardVersionService, cmd, func(sc *scenarioContext) {
 | |
| 				sc.dashboardVersionService = fakeDashboardVersionService
 | |
| 
 | |
| 				callRestoreDashboardVersion(sc)
 | |
| 				assert.Equal(t, http.StatusBadRequest, sc.resp.Code)
 | |
| 			}, mockSQLStore)
 | |
| 	})
 | |
| 
 | |
| 	t.Run("Given dashboard in general folder being restored should restore to general folder", func(t *testing.T) {
 | |
| 		fakeDash := dashboards.NewDashboard("Child dash")
 | |
| 		fakeDash.ID = 2
 | |
| 		fakeDash.HasACL = false
 | |
| 
 | |
| 		dashboardService := dashboards.NewFakeDashboardService(t)
 | |
| 		dashboardService.On("GetDashboard", mock.Anything, mock.AnythingOfType("*dashboards.GetDashboardQuery")).Return(fakeDash, nil)
 | |
| 		dashboardService.On("SaveDashboard", mock.Anything, mock.AnythingOfType("*dashboards.SaveDashboardDTO"), mock.AnythingOfType("bool")).Run(func(args mock.Arguments) {
 | |
| 			cmd := args.Get(1).(*dashboards.SaveDashboardDTO)
 | |
| 			cmd.Dashboard = &dashboards.Dashboard{
 | |
| 				ID: 2, UID: "uid", Title: "Dash", Slug: "dash", Version: 1,
 | |
| 			}
 | |
| 		}).Return(nil, nil)
 | |
| 
 | |
| 		fakeDashboardVersionService := dashvertest.NewDashboardVersionServiceFake()
 | |
| 		fakeDashboardVersionService.ExpectedDashboardVersions = []*dashver.DashboardVersionDTO{
 | |
| 			{
 | |
| 				DashboardID: 2,
 | |
| 				Version:     1,
 | |
| 				Data: simplejson.NewFromAny(map[string]any{
 | |
| 					"title": "Dash1",
 | |
| 				}),
 | |
| 			},
 | |
| 		}
 | |
| 
 | |
| 		cmd := dtos.RestoreDashboardVersionCommand{
 | |
| 			Version: 1,
 | |
| 		}
 | |
| 		mockSQLStore := dbtest.NewFakeDB()
 | |
| 		restoreDashboardVersionScenario(t, "When calling POST on", "/api/dashboards/id/1/restore",
 | |
| 			"/api/dashboards/id/:dashboardId/restore", dashboardService, fakeDashboardVersionService, cmd, func(sc *scenarioContext) {
 | |
| 				callRestoreDashboardVersion(sc)
 | |
| 				assert.Equal(t, http.StatusOK, sc.resp.Code)
 | |
| 			}, mockSQLStore)
 | |
| 	})
 | |
| 
 | |
| 	t.Run("Given dashboard in general folder being restored should restore to general folder", func(t *testing.T) {
 | |
| 		fakeDash := dashboards.NewDashboard("Child dash")
 | |
| 		fakeDash.ID = 2
 | |
| 		fakeDash.HasACL = false
 | |
| 
 | |
| 		dashboardService := dashboards.NewFakeDashboardService(t)
 | |
| 		dashboardService.On("GetDashboard", mock.Anything, mock.AnythingOfType("*dashboards.GetDashboardQuery")).Return(fakeDash, nil)
 | |
| 		dashboardService.On("SaveDashboard", mock.Anything, mock.AnythingOfType("*dashboards.SaveDashboardDTO"), mock.AnythingOfType("bool")).Run(func(args mock.Arguments) {
 | |
| 			cmd := args.Get(1).(*dashboards.SaveDashboardDTO)
 | |
| 			cmd.Dashboard = &dashboards.Dashboard{
 | |
| 				ID: 2, UID: "uid", Title: "Dash", Slug: "dash", Version: 1,
 | |
| 			}
 | |
| 		}).Return(nil, nil)
 | |
| 
 | |
| 		fakeDashboardVersionService := dashvertest.NewDashboardVersionServiceFake()
 | |
| 		fakeDashboardVersionService.ExpectedDashboardVersions = []*dashver.DashboardVersionDTO{
 | |
| 			{
 | |
| 				DashboardID: 2,
 | |
| 				Version:     1,
 | |
| 				Data: simplejson.NewFromAny(map[string]any{
 | |
| 					"title": "Dash1",
 | |
| 				}),
 | |
| 			},
 | |
| 		}
 | |
| 
 | |
| 		cmd := dtos.RestoreDashboardVersionCommand{
 | |
| 			Version: 1,
 | |
| 		}
 | |
| 		mockSQLStore := dbtest.NewFakeDB()
 | |
| 		restoreDashboardVersionScenario(t, "When calling POST on", "/api/dashboards/id/1/restore",
 | |
| 			"/api/dashboards/id/:dashboardId/restore", dashboardService, fakeDashboardVersionService, cmd, func(sc *scenarioContext) {
 | |
| 				callRestoreDashboardVersion(sc)
 | |
| 				assert.Equal(t, http.StatusOK, sc.resp.Code)
 | |
| 			}, mockSQLStore)
 | |
| 	})
 | |
| 
 | |
| 	t.Run("Given provisioned dashboard", func(t *testing.T) {
 | |
| 		mockSQLStore := dbtest.NewFakeDB()
 | |
| 		dashboardStore := dashboards.NewFakeDashboardStore(t)
 | |
| 		dashboardStore.On("GetProvisionedDataByDashboardID", mock.Anything, mock.AnythingOfType("int64")).Return(&dashboards.DashboardProvisioning{ExternalID: "/dashboard1.json"}, nil).Once()
 | |
| 
 | |
| 		dashboardService := dashboards.NewFakeDashboardService(t)
 | |
| 
 | |
| 		dataValue, err := simplejson.NewJson([]byte(`{"id": 1, "editable": true, "style": "dark"}`))
 | |
| 		require.NoError(t, err)
 | |
| 		qResult := &dashboards.Dashboard{ID: 1, Data: dataValue}
 | |
| 		dashboardService.On("GetDashboard", mock.Anything, mock.AnythingOfType("*dashboards.GetDashboardQuery")).Return(qResult, nil)
 | |
| 
 | |
| 		loggedInUserScenarioWithRole(t, "When calling GET on", "GET", "/api/dashboards/uid/dash", "/api/dashboards/uid/:uid", org.RoleEditor, func(sc *scenarioContext) {
 | |
| 			fakeProvisioningService := provisioning.NewProvisioningServiceMock(context.Background())
 | |
| 			fakeProvisioningService.GetDashboardProvisionerResolvedPathFunc = func(name string) string {
 | |
| 				return "/tmp/grafana/dashboards"
 | |
| 			}
 | |
| 
 | |
| 			dash := getDashboardShouldReturn200WithConfig(t, sc, fakeProvisioningService, dashboardStore, dashboardService, nil)
 | |
| 
 | |
| 			assert.Equal(t, "../../../dashboard1.json", dash.Meta.ProvisionedExternalId, mockSQLStore)
 | |
| 		}, mockSQLStore)
 | |
| 
 | |
| 		loggedInUserScenarioWithRole(t, "When allowUiUpdates is true and calling GET on", "GET", "/api/dashboards/uid/dash", "/api/dashboards/uid/:uid", org.RoleEditor, func(sc *scenarioContext) {
 | |
| 			fakeProvisioningService := provisioning.NewProvisioningServiceMock(context.Background())
 | |
| 			fakeProvisioningService.GetDashboardProvisionerResolvedPathFunc = func(name string) string {
 | |
| 				return "/tmp/grafana/dashboards"
 | |
| 			}
 | |
| 
 | |
| 			fakeProvisioningService.GetAllowUIUpdatesFromConfigFunc = func(name string) bool {
 | |
| 				return true
 | |
| 			}
 | |
| 
 | |
| 			hs := &HTTPServer{
 | |
| 				Cfg:                          setting.NewCfg(),
 | |
| 				ProvisioningService:          fakeProvisioningService,
 | |
| 				LibraryPanelService:          &mockLibraryPanelService{},
 | |
| 				LibraryElementService:        &libraryelementsfake.LibraryElementService{},
 | |
| 				dashboardProvisioningService: mockDashboardProvisioningService{},
 | |
| 				SQLStore:                     mockSQLStore,
 | |
| 				AccessControl:                actest.FakeAccessControl{ExpectedEvaluate: true},
 | |
| 				DashboardService:             dashboardService,
 | |
| 				Features:                     featuremgmt.WithFeatures(),
 | |
| 				starService:                  startest.NewStarServiceFake(),
 | |
| 				tracer:                       tracing.InitializeTracerForTest(),
 | |
| 			}
 | |
| 			hs.callGetDashboard(sc)
 | |
| 
 | |
| 			assert.Equal(t, http.StatusOK, sc.resp.Code)
 | |
| 
 | |
| 			dash := dtos.DashboardFullWithMeta{}
 | |
| 			err := json.NewDecoder(sc.resp.Body).Decode(&dash)
 | |
| 			require.NoError(t, err)
 | |
| 
 | |
| 			assert.Equal(t, false, dash.Meta.Provisioned)
 | |
| 		}, mockSQLStore)
 | |
| 	})
 | |
| 
 | |
| 	t.Run("v2 dashboards should not be returned in api", func(t *testing.T) {
 | |
| 		mockSQLStore := dbtest.NewFakeDB()
 | |
| 		dashboardService := dashboards.NewFakeDashboardService(t)
 | |
| 
 | |
| 		dataValue, err := simplejson.NewJson([]byte(`{"id": 1, "apiVersion": "v2"}`))
 | |
| 		require.NoError(t, err)
 | |
| 		qResult := &dashboards.Dashboard{
 | |
| 			ID:         1,
 | |
| 			UID:        "dash",
 | |
| 			OrgID:      1,
 | |
| 			APIVersion: "v2",
 | |
| 			Data:       dataValue,
 | |
| 		}
 | |
| 		dashboardService.On("GetDashboard", mock.Anything, mock.AnythingOfType("*dashboards.GetDashboardQuery")).Return(qResult, nil)
 | |
| 
 | |
| 		loggedInUserScenarioWithRole(t, "When calling GET on", "GET", "/api/dashboards/uid/dash", "/api/dashboards/uid/:uid", org.RoleEditor, func(sc *scenarioContext) {
 | |
| 			hs := &HTTPServer{
 | |
| 				Cfg:                          setting.NewCfg(),
 | |
| 				LibraryPanelService:          &mockLibraryPanelService{},
 | |
| 				LibraryElementService:        &libraryelementsfake.LibraryElementService{},
 | |
| 				SQLStore:                     mockSQLStore,
 | |
| 				AccessControl:                actest.FakeAccessControl{ExpectedEvaluate: true},
 | |
| 				DashboardService:             dashboardService,
 | |
| 				Features:                     featuremgmt.WithFeatures(),
 | |
| 				starService:                  startest.NewStarServiceFake(),
 | |
| 				tracer:                       tracing.InitializeTracerForTest(),
 | |
| 				dashboardProvisioningService: mockDashboardProvisioningService{},
 | |
| 				folderService:                foldertest.NewFakeService(),
 | |
| 				log:                          log.New("test"),
 | |
| 				namespacer:                   func(orgID int64) string { return strconv.FormatInt(orgID, 10) },
 | |
| 			}
 | |
| 			hs.callGetDashboard(sc)
 | |
| 
 | |
| 			assert.Equal(t, http.StatusNotAcceptable, sc.resp.Code)
 | |
| 			result := sc.ToJSON()
 | |
| 			assert.Equal(t, "dashboard api version not supported, use /apis/dashboard.grafana.app/v2/namespaces/1/dashboards/dash instead", result.Get("message").MustString())
 | |
| 		}, mockSQLStore)
 | |
| 	})
 | |
| }
 | |
| 
 | |
| func TestDashboardVersionsAPIEndpoint(t *testing.T) {
 | |
| 	fakeDash := dashboards.NewDashboard("Child dash")
 | |
| 
 | |
| 	fakeDashboardVersionService := dashvertest.NewDashboardVersionServiceFake()
 | |
| 	dashboardService := dashboards.NewFakeDashboardService(t)
 | |
| 	dashboardService.On("GetDashboard", mock.Anything, mock.AnythingOfType("*dashboards.GetDashboardQuery")).Return(fakeDash, nil)
 | |
| 
 | |
| 	mockSQLStore := dbtest.NewFakeDB()
 | |
| 
 | |
| 	cfg := setting.NewCfg()
 | |
| 
 | |
| 	getHS := func(userSvc *usertest.FakeUserService) *HTTPServer {
 | |
| 		return &HTTPServer{
 | |
| 			Cfg:                     cfg,
 | |
| 			pluginStore:             &pluginstore.FakePluginStore{},
 | |
| 			SQLStore:                mockSQLStore,
 | |
| 			AccessControl:           actest.FakeAccessControl{ExpectedEvaluate: true},
 | |
| 			Features:                featuremgmt.WithFeatures(),
 | |
| 			DashboardService:        dashboardService,
 | |
| 			dashboardVersionService: fakeDashboardVersionService,
 | |
| 			QuotaService:            quotatest.New(false, nil),
 | |
| 			userService:             userSvc,
 | |
| 			CacheService:            localcache.New(5*time.Minute, 10*time.Minute),
 | |
| 			log:                     log.New(),
 | |
| 			tracer:                  tracing.InitializeTracerForTest(),
 | |
| 		}
 | |
| 	}
 | |
| 
 | |
| 	loggedInUserScenarioWithRole(t, "When user exists and calling GET on", "GET", "/api/dashboards/id/2/versions",
 | |
| 		"/api/dashboards/id/:dashboardId/versions", org.RoleEditor, func(sc *scenarioContext) {
 | |
| 			fakeDashboardVersionService.ExpectedListDashboarVersions = []*dashver.DashboardVersionDTO{
 | |
| 				{
 | |
| 					Version:   1,
 | |
| 					CreatedBy: 1,
 | |
| 				},
 | |
| 				{
 | |
| 					Version:   2,
 | |
| 					CreatedBy: 1,
 | |
| 				},
 | |
| 			}
 | |
| 			getHS(&usertest.FakeUserService{
 | |
| 				ExpectedSignedInUser: &user.SignedInUser{Login: "test-user"},
 | |
| 			}).callGetDashboardVersions(sc)
 | |
| 
 | |
| 			assert.Equal(t, http.StatusOK, sc.resp.Code)
 | |
| 			var versions dashver.DashboardVersionResponseMeta
 | |
| 			err := json.NewDecoder(sc.resp.Body).Decode(&versions)
 | |
| 			require.NoError(t, err)
 | |
| 			for _, v := range versions.Versions {
 | |
| 				assert.Equal(t, "test-user", v.CreatedBy)
 | |
| 			}
 | |
| 		}, mockSQLStore)
 | |
| 
 | |
| 	loggedInUserScenarioWithRole(t, "When user does not exist and calling GET on", "GET", "/api/dashboards/id/2/versions",
 | |
| 		"/api/dashboards/id/:dashboardId/versions", org.RoleEditor, func(sc *scenarioContext) {
 | |
| 			fakeDashboardVersionService.ExpectedListDashboarVersions = []*dashver.DashboardVersionDTO{
 | |
| 				{
 | |
| 					Version:   1,
 | |
| 					CreatedBy: 1,
 | |
| 				},
 | |
| 				{
 | |
| 					Version:   2,
 | |
| 					CreatedBy: 1,
 | |
| 				},
 | |
| 			}
 | |
| 			getHS(&usertest.FakeUserService{
 | |
| 				ExpectedError: user.ErrUserNotFound,
 | |
| 			}).callGetDashboardVersions(sc)
 | |
| 
 | |
| 			assert.Equal(t, http.StatusOK, sc.resp.Code)
 | |
| 			var versions dashver.DashboardVersionResponseMeta
 | |
| 			err := json.NewDecoder(sc.resp.Body).Decode(&versions)
 | |
| 			require.NoError(t, err)
 | |
| 			for _, v := range versions.Versions {
 | |
| 				assert.Equal(t, anonString, v.CreatedBy)
 | |
| 			}
 | |
| 		}, mockSQLStore)
 | |
| 
 | |
| 	loggedInUserScenarioWithRole(t, "When failing to get user and calling GET on", "GET", "/api/dashboards/id/2/versions",
 | |
| 		"/api/dashboards/id/:dashboardId/versions", org.RoleEditor, func(sc *scenarioContext) {
 | |
| 			fakeDashboardVersionService.ExpectedListDashboarVersions = []*dashver.DashboardVersionDTO{
 | |
| 				{
 | |
| 					Version:   1,
 | |
| 					CreatedBy: 1,
 | |
| 				},
 | |
| 				{
 | |
| 					Version:   2,
 | |
| 					CreatedBy: 1,
 | |
| 				},
 | |
| 			}
 | |
| 			getHS(&usertest.FakeUserService{
 | |
| 				ExpectedError: fmt.Errorf("some error"),
 | |
| 			}).callGetDashboardVersions(sc)
 | |
| 
 | |
| 			assert.Equal(t, http.StatusOK, sc.resp.Code)
 | |
| 			var versions dashver.DashboardVersionResponseMeta
 | |
| 			err := json.NewDecoder(sc.resp.Body).Decode(&versions)
 | |
| 			require.NoError(t, err)
 | |
| 			for _, v := range versions.Versions {
 | |
| 				assert.Equal(t, anonString, v.CreatedBy)
 | |
| 			}
 | |
| 		}, mockSQLStore)
 | |
| }
 | |
| 
 | |
| func getDashboardShouldReturn200WithConfig(t *testing.T, sc *scenarioContext, provisioningService provisioning.ProvisioningService, dashboardStore dashboards.Store, dashboardService dashboards.DashboardService, folderStore folder.FolderStore) dtos.DashboardFullWithMeta {
 | |
| 	t.Helper()
 | |
| 
 | |
| 	if provisioningService == nil {
 | |
| 		provisioningService = provisioning.NewProvisioningServiceMock(context.Background())
 | |
| 	}
 | |
| 
 | |
| 	features := featuremgmt.WithFeatures()
 | |
| 	var err error
 | |
| 	if dashboardStore == nil {
 | |
| 		sql, cfg := db.InitTestDBWithCfg(t)
 | |
| 		dashboardStore, err = database.ProvideDashboardStore(sql, cfg, features, tagimpl.ProvideService(sql))
 | |
| 		require.NoError(t, err)
 | |
| 	}
 | |
| 
 | |
| 	libraryPanelsService := mockLibraryPanelService{}
 | |
| 	libraryElementsService := libraryelementsfake.LibraryElementService{}
 | |
| 	cfg := setting.NewCfg()
 | |
| 	ac := accesscontrolmock.New()
 | |
| 	folderPermissions := accesscontrolmock.NewMockedPermissionsService()
 | |
| 	dashboardPermissions := accesscontrolmock.NewMockedPermissionsService()
 | |
| 
 | |
| 	db := db.InitTestDB(t)
 | |
| 	fStore := folderimpl.ProvideStore(db)
 | |
| 	quotaService := quotatest.New(false, nil)
 | |
| 	folderSvc := folderimpl.ProvideService(
 | |
| 		fStore, ac, bus.ProvideBus(tracing.InitializeTracerForTest()), dashboardStore, folderStore,
 | |
| 		nil, db, features, supportbundlestest.NewFakeBundleService(), nil, cfg, nil, tracing.InitializeTracerForTest(), nil,
 | |
| 		dualwrite.ProvideTestService(), sort.ProvideService(), apiserver.WithoutRestConfig)
 | |
| 	if dashboardService == nil {
 | |
| 		dashboardService, err = service.ProvideDashboardServiceImpl(
 | |
| 			cfg, dashboardStore, folderStore, features, folderPermissions,
 | |
| 			ac, actest.FakeService{}, folderSvc, nil, client.MockTestRestConfig{}, nil, quotaService, nil, nil, nil,
 | |
| 			dualwrite.ProvideTestService(), sort.ProvideService(),
 | |
| 			serverlock.ProvideService(db, tracing.InitializeTracerForTest()), kvstore.NewFakeKVStore(),
 | |
| 		)
 | |
| 		require.NoError(t, err)
 | |
| 		dashboardService.(dashboards.PermissionsRegistrationService).RegisterDashboardPermissions(dashboardPermissions)
 | |
| 	}
 | |
| 
 | |
| 	dashboardProvisioningService, err := service.ProvideDashboardServiceImpl(
 | |
| 		cfg, dashboardStore, folderStore, features, folderPermissions,
 | |
| 		ac, actest.FakeService{}, folderSvc, nil, client.MockTestRestConfig{}, nil, quotaService, nil, nil, nil,
 | |
| 		dualwrite.ProvideTestService(), sort.ProvideService(),
 | |
| 		serverlock.ProvideService(db, tracing.InitializeTracerForTest()), kvstore.NewFakeKVStore(),
 | |
| 	)
 | |
| 	require.NoError(t, err)
 | |
| 
 | |
| 	hs := &HTTPServer{
 | |
| 		Cfg:                          cfg,
 | |
| 		LibraryPanelService:          &libraryPanelsService,
 | |
| 		LibraryElementService:        &libraryElementsService,
 | |
| 		SQLStore:                     sc.sqlStore,
 | |
| 		ProvisioningService:          provisioningService,
 | |
| 		AccessControl:                accesscontrolmock.New(),
 | |
| 		dashboardProvisioningService: dashboardProvisioningService,
 | |
| 		DashboardService:             dashboardService,
 | |
| 		Features:                     featuremgmt.WithFeatures(),
 | |
| 		starService:                  startest.NewStarServiceFake(),
 | |
| 		tracer:                       tracing.InitializeTracerForTest(),
 | |
| 	}
 | |
| 
 | |
| 	hs.callGetDashboard(sc)
 | |
| 
 | |
| 	require.Equal(sc.t, 200, sc.resp.Code)
 | |
| 
 | |
| 	dash := dtos.DashboardFullWithMeta{}
 | |
| 	err = json.NewDecoder(sc.resp.Body).Decode(&dash)
 | |
| 	require.NoError(sc.t, err)
 | |
| 
 | |
| 	return dash
 | |
| }
 | |
| 
 | |
| func (hs *HTTPServer) callGetDashboard(sc *scenarioContext) {
 | |
| 	sc.handlerFunc = hs.GetDashboard
 | |
| 	sc.fakeReqWithParams("GET", sc.url, map[string]string{}).exec()
 | |
| }
 | |
| 
 | |
| func (hs *HTTPServer) callGetDashboardVersions(sc *scenarioContext) {
 | |
| 	sc.handlerFunc = hs.GetDashboardVersions
 | |
| 	sc.fakeReqWithParams("GET", sc.url, map[string]string{}).exec()
 | |
| }
 | |
| 
 | |
| func callPostDashboard(sc *scenarioContext) {
 | |
| 	sc.fakeReqWithParams("POST", sc.url, map[string]string{}).exec()
 | |
| }
 | |
| 
 | |
| func callRestoreDashboardVersion(sc *scenarioContext) {
 | |
| 	sc.fakeReqWithParams("POST", sc.url, map[string]string{}).exec()
 | |
| }
 | |
| 
 | |
| func callPostDashboardShouldReturnSuccess(sc *scenarioContext) {
 | |
| 	callPostDashboard(sc)
 | |
| 
 | |
| 	assert.Equal(sc.t, 200, sc.resp.Code)
 | |
| }
 | |
| 
 | |
| func postDashboardScenario(t *testing.T, desc string, url string, routePattern string, cmd dashboards.SaveDashboardCommand, dashboardService dashboards.DashboardService, folderService folder.Service, fn scenarioFunc) {
 | |
| 	t.Run(fmt.Sprintf("%s %s", desc, url), func(t *testing.T) {
 | |
| 		cfg := setting.NewCfg()
 | |
| 		hs := HTTPServer{
 | |
| 			Cfg:                   cfg,
 | |
| 			ProvisioningService:   provisioning.NewProvisioningServiceMock(context.Background()),
 | |
| 			Live:                  newTestLive(t, db.InitTestDB(t)),
 | |
| 			QuotaService:          quotatest.New(false, nil),
 | |
| 			pluginStore:           &pluginstore.FakePluginStore{},
 | |
| 			LibraryPanelService:   &mockLibraryPanelService{},
 | |
| 			LibraryElementService: &libraryelementsfake.LibraryElementService{},
 | |
| 			DashboardService:      dashboardService,
 | |
| 			folderService:         folderService,
 | |
| 			Features:              featuremgmt.WithFeatures(),
 | |
| 			accesscontrolService:  actest.FakeService{},
 | |
| 			log:                   log.New("test-logger"),
 | |
| 			tracer:                tracing.InitializeTracerForTest(),
 | |
| 		}
 | |
| 
 | |
| 		sc := setupScenarioContext(t, url)
 | |
| 		sc.defaultHandler = routing.Wrap(func(c *contextmodel.ReqContext) response.Response {
 | |
| 			c.Req.Body = mockRequestBody(cmd)
 | |
| 			c.Req.Header.Add("Content-Type", "application/json")
 | |
| 			sc.context = c
 | |
| 			sc.context.SignedInUser = &user.SignedInUser{OrgID: cmd.OrgID, UserID: cmd.UserID}
 | |
| 
 | |
| 			return hs.PostDashboard(c)
 | |
| 		})
 | |
| 
 | |
| 		sc.m.Post(routePattern, sc.defaultHandler)
 | |
| 
 | |
| 		fn(sc)
 | |
| 	})
 | |
| }
 | |
| 
 | |
| func restoreDashboardVersionScenario(t *testing.T, desc string, url string, routePattern string,
 | |
| 	mock *dashboards.FakeDashboardService, fakeDashboardVersionService *dashvertest.FakeDashboardVersionService,
 | |
| 	cmd dtos.RestoreDashboardVersionCommand, fn scenarioFunc, sqlStore db.DB,
 | |
| ) {
 | |
| 	t.Run(fmt.Sprintf("%s %s", desc, url), func(t *testing.T) {
 | |
| 		cfg := setting.NewCfg()
 | |
| 		folderSvc := foldertest.NewFakeService()
 | |
| 		folderSvc.ExpectedFolder = &folder.Folder{}
 | |
| 
 | |
| 		hs := HTTPServer{
 | |
| 			Cfg:                     cfg,
 | |
| 			ProvisioningService:     provisioning.NewProvisioningServiceMock(context.Background()),
 | |
| 			Live:                    newTestLive(t, db.InitTestDB(t)),
 | |
| 			QuotaService:            quotatest.New(false, nil),
 | |
| 			LibraryPanelService:     &mockLibraryPanelService{},
 | |
| 			LibraryElementService:   &libraryelementsfake.LibraryElementService{},
 | |
| 			DashboardService:        mock,
 | |
| 			SQLStore:                sqlStore,
 | |
| 			Features:                featuremgmt.WithFeatures(),
 | |
| 			dashboardVersionService: fakeDashboardVersionService,
 | |
| 			accesscontrolService:    actest.FakeService{},
 | |
| 			folderService:           folderSvc,
 | |
| 			tracer:                  tracing.InitializeTracerForTest(),
 | |
| 		}
 | |
| 
 | |
| 		sc := setupScenarioContext(t, url)
 | |
| 		sc.sqlStore = sqlStore
 | |
| 		sc.dashboardVersionService = fakeDashboardVersionService
 | |
| 		sc.defaultHandler = routing.Wrap(func(c *contextmodel.ReqContext) response.Response {
 | |
| 			c.Req.Body = mockRequestBody(cmd)
 | |
| 			c.Req.Header.Add("Content-Type", "application/json")
 | |
| 			sc.context = c
 | |
| 			sc.context.SignedInUser = &user.SignedInUser{
 | |
| 				OrgID:  testOrgID,
 | |
| 				UserID: testUserID,
 | |
| 			}
 | |
| 			sc.context.OrgRole = org.RoleAdmin
 | |
| 
 | |
| 			return hs.RestoreDashboardVersion(c)
 | |
| 		})
 | |
| 
 | |
| 		sc.m.Post(routePattern, sc.defaultHandler)
 | |
| 
 | |
| 		fn(sc)
 | |
| 	})
 | |
| }
 | |
| 
 | |
| func (sc *scenarioContext) ToJSON() *simplejson.Json {
 | |
| 	result := simplejson.New()
 | |
| 	err := json.NewDecoder(sc.resp.Body).Decode(result)
 | |
| 	require.NoError(sc.t, err)
 | |
| 	return result
 | |
| }
 | |
| 
 | |
| type mockDashboardProvisioningService struct {
 | |
| 	dashboards.DashboardProvisioningService
 | |
| }
 | |
| 
 | |
| func (s mockDashboardProvisioningService) GetProvisionedDashboardDataByDashboardID(ctx context.Context, dashboardID int64) (
 | |
| 	*dashboards.DashboardProvisioning, error,
 | |
| ) {
 | |
| 	return nil, nil
 | |
| }
 | |
| 
 | |
| type mockLibraryPanelService struct{}
 | |
| 
 | |
| var _ librarypanels.Service = (*mockLibraryPanelService)(nil)
 | |
| 
 | |
| func (m *mockLibraryPanelService) ConnectLibraryPanelsForDashboard(c context.Context, signedInUser identity.Requester, dash *dashboards.Dashboard) error {
 | |
| 	return nil
 | |
| }
 | |
| 
 | |
| func (m *mockLibraryPanelService) ImportLibraryPanelsForDashboard(c context.Context, signedInUser identity.Requester, libraryPanels *simplejson.Json, panels []any, folderID int64, folderUID string) error {
 | |
| 	return nil
 | |
| }
 |