2017-06-12 15:48:55 +02:00
package api
import (
2021-06-15 16:08:27 +02:00
"context"
2017-06-12 15:48:55 +02:00
"encoding/json"
2021-05-26 16:20:13 +02:00
"errors"
2018-02-19 11:12:56 +01:00
"fmt"
2021-07-16 12:40:03 +02:00
"net/http"
2022-08-10 13:37:51 +00:00
"os"
2017-06-12 15:48:55 +02:00
"testing"
2023-03-30 17:31:53 +03:00
"time"
2017-06-12 15:48:55 +02:00
2022-03-10 12:19:50 -05:00
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/mock"
"github.com/stretchr/testify/require"
2017-06-12 15:48:55 +02:00
"github.com/grafana/grafana/pkg/api/dtos"
2021-01-15 14:43:20 +01:00
"github.com/grafana/grafana/pkg/api/response"
"github.com/grafana/grafana/pkg/api/routing"
2023-01-26 10:21:10 +02:00
"github.com/grafana/grafana/pkg/bus"
2017-06-12 23:05:32 +02:00
"github.com/grafana/grafana/pkg/components/simplejson"
2022-10-19 09:02:15 -04:00
"github.com/grafana/grafana/pkg/infra/db"
2023-01-17 14:17:54 +01:00
"github.com/grafana/grafana/pkg/infra/db/dbtest"
2023-03-30 17:31:53 +03:00
"github.com/grafana/grafana/pkg/infra/localcache"
"github.com/grafana/grafana/pkg/infra/log"
2023-01-26 10:21:10 +02:00
"github.com/grafana/grafana/pkg/infra/tracing"
2021-09-22 16:28:40 +02:00
"github.com/grafana/grafana/pkg/infra/usagestats"
2023-07-17 12:21:44 +02:00
"github.com/grafana/grafana/pkg/plugins/manager/fakes"
2022-11-10 15:36:40 -05:00
"github.com/grafana/grafana/pkg/registry/corekind"
2023-01-23 10:54:29 +01:00
"github.com/grafana/grafana/pkg/services/accesscontrol/acimpl"
2022-11-24 14:38:55 +00:00
"github.com/grafana/grafana/pkg/services/accesscontrol/actest"
2022-03-10 12:58:18 +01:00
accesscontrolmock "github.com/grafana/grafana/pkg/services/accesscontrol/mock"
2018-10-12 22:53:28 -07:00
"github.com/grafana/grafana/pkg/services/alerting"
2022-09-19 10:54:37 +03:00
"github.com/grafana/grafana/pkg/services/annotations/annotationstest"
2023-01-27 08:50:36 +01:00
contextmodel "github.com/grafana/grafana/pkg/services/contexthandler/model"
2017-12-12 16:15:24 +01:00
"github.com/grafana/grafana/pkg/services/dashboards"
2022-02-16 14:15:44 +01:00
"github.com/grafana/grafana/pkg/services/dashboards/database"
2022-05-21 20:44:12 -04:00
"github.com/grafana/grafana/pkg/services/dashboards/service"
2022-05-25 10:41:51 +02:00
dashver "github.com/grafana/grafana/pkg/services/dashboardversion"
"github.com/grafana/grafana/pkg/services/dashboardversion/dashvertest"
2022-01-26 09:44:20 -08:00
"github.com/grafana/grafana/pkg/services/featuremgmt"
2022-10-10 21:47:53 +02:00
"github.com/grafana/grafana/pkg/services/folder"
2023-01-26 10:21:10 +02:00
"github.com/grafana/grafana/pkg/services/folder/folderimpl"
2022-11-11 14:28:24 +01:00
"github.com/grafana/grafana/pkg/services/folder/foldertest"
2022-03-21 10:49:49 +01:00
"github.com/grafana/grafana/pkg/services/guardian"
2023-02-01 17:32:05 +01:00
"github.com/grafana/grafana/pkg/services/libraryelements/model"
2020-10-28 08:36:57 +00:00
"github.com/grafana/grafana/pkg/services/live"
2022-08-10 11:56:48 +02:00
"github.com/grafana/grafana/pkg/services/org"
2022-04-21 15:03:17 +02:00
pref "github.com/grafana/grafana/pkg/services/preference"
"github.com/grafana/grafana/pkg/services/preference/preftest"
2019-04-30 13:32:18 +02:00
"github.com/grafana/grafana/pkg/services/provisioning"
2023-07-17 12:21:44 +02:00
"github.com/grafana/grafana/pkg/services/publicdashboards"
"github.com/grafana/grafana/pkg/services/publicdashboards/api"
2022-11-14 21:08:10 +02:00
"github.com/grafana/grafana/pkg/services/quota/quotatest"
2022-09-21 14:04:01 +02:00
"github.com/grafana/grafana/pkg/services/tag/tagimpl"
2022-09-20 18:58:04 +02:00
"github.com/grafana/grafana/pkg/services/team/teamtest"
2022-08-10 11:56:48 +02:00
"github.com/grafana/grafana/pkg/services/user"
2023-07-17 12:21:44 +02:00
"github.com/grafana/grafana/pkg/services/user/usertest"
2017-12-15 14:19:49 +01:00
"github.com/grafana/grafana/pkg/setting"
2021-10-11 14:30:59 +02:00
"github.com/grafana/grafana/pkg/web"
2017-06-12 15:48:55 +02:00
)
2020-06-22 18:00:39 +02:00
func TestGetHomeDashboard ( t * testing . T ) {
2021-07-16 12:40:03 +02:00
httpReq , err := http . NewRequest ( http . MethodGet , "" , nil )
require . NoError ( t , err )
2022-02-09 13:44:38 +01:00
httpReq . Header . Add ( "Content-Type" , "application/json" )
2023-01-27 08:50:36 +01:00
req := & contextmodel . ReqContext { SignedInUser : & user . SignedInUser {}, Context : & web . Context { Req : httpReq }}
2020-06-22 18:00:39 +02:00
cfg := setting . NewCfg ()
cfg . StaticRootPath = "../../public/"
2022-04-21 15:03:17 +02:00
prefService := preftest . NewPreferenceServiceFake ()
2022-05-25 10:41:51 +02:00
dashboardVersionService := dashvertest . NewDashboardVersionServiceFake ()
2020-06-22 18:00:39 +02:00
2021-03-17 16:06:10 +01:00
hs := & HTTPServer {
2022-05-25 10:41:51 +02:00
Cfg : cfg ,
2023-07-17 12:21:44 +02:00
pluginStore : & fakes . FakePluginStore {},
2023-01-17 14:17:54 +01:00
SQLStore : dbtest . NewFakeDB (),
2022-05-25 10:41:51 +02:00
preferenceService : prefService ,
dashboardVersionService : dashboardVersionService ,
2022-11-10 15:36:40 -05:00
Kinds : corekind . NewBase ( nil ),
2021-03-17 16:06:10 +01:00
}
2020-06-22 18:00:39 +02:00
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"
2022-08-10 13:37:51 +00:00
homeDashJSON , err := os . ReadFile ( tc . expectedDashboardPath )
2020-06-22 18:00:39 +02:00
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" )
2022-04-21 15:03:17 +02:00
prefService . ExpectedPreference = & pref . Preference {}
2020-06-22 18:00:39 +02:00
dash . Dashboard = bytes
b , err := json . Marshal ( dash )
require . NoError ( t , err , "must be able to marshal object to JSON" )
res := hs . GetHomeDashboard ( req )
2021-01-15 14:43:20 +01:00
nr , ok := res .( * response . NormalResponse )
2020-06-22 18:00:39 +02:00
require . True ( t , ok , "should return *NormalResponse" )
2021-01-15 14:43:20 +01:00
require . Equal ( t , b , nr . Body (), "default home dashboard should equal content on disk" )
2020-06-22 18:00:39 +02:00
})
}
}
2022-10-14 15:33:06 -04:00
func newTestLive ( t * testing . T , store db . DB ) * live . GrafanaLive {
2022-01-26 09:44:20 -08:00
features := featuremgmt . WithFeatures ()
2021-08-25 15:11:22 +02:00
cfg := & setting . Cfg { AppURL : "http://localhost:3000/" }
2022-01-26 09:44:20 -08:00
cfg . IsFeatureToggleEnabled = features . IsEnabled
gLive , err := live . ProvideService ( nil , cfg ,
routing . NewRouteRegister (),
2023-02-27 18:48:18 +00:00
nil , nil , nil , nil ,
2022-03-22 20:48:32 +01:00
store ,
2022-01-26 09:44:20 -08:00
nil ,
& usagestats . UsageStatsMock { T : t },
nil ,
2023-01-23 10:54:29 +01:00
features , acimpl . ProvideAccessControl ( cfg ), & dashboards . FakeDashboardService {}, annotationstest . NewFakeAnnotationsRepo (), nil )
2021-05-04 08:44:55 -07:00
require . NoError ( t , err )
return gLive
}
2018-02-19 11:12:56 +01:00
// This tests three main scenarios.
// If a user has access to execute an action on a dashboard:
// 1. and the dashboard is in a folder which does not have an acl
// 2. and the dashboard is in a folder which does have an acl
// 3. Post dashboard response tests
2018-01-30 14:09:30 +01:00
2020-11-13 09:52:38 +01:00
func TestDashboardAPIEndpoint ( t * testing . T ) {
t . Run ( "Given a dashboard with a parent folder which does not have an ACL" , func ( t * testing . T ) {
2023-01-16 16:33:55 +01:00
fakeDash := dashboards . NewDashboard ( "Child dash" )
2023-04-14 16:50:10 -07:00
fakeDash . SetID ( 1 )
fakeDash . SetUID ( "test-uid-one" )
2023-01-16 16:33:55 +01:00
fakeDash . FolderID = 1
2022-07-18 15:14:58 +02:00
fakeDash . HasACL = false
2022-05-25 10:41:51 +02:00
fakeDashboardVersionService := dashvertest . NewDashboardVersionServiceFake ()
2023-03-30 17:31:53 +03:00
fakeDashboardVersionService . ExpectedDashboardVersion = & dashver . DashboardVersionDTO { CreatedBy : 1 }
2022-09-20 18:58:04 +02:00
teamService := & teamtest . FakeService {}
2022-05-23 11:14:27 -04:00
dashboardService := dashboards . NewFakeDashboardService ( t )
2023-01-25 10:36:26 +01:00
dashboardService . On ( "GetDashboard" , mock . Anything , mock . AnythingOfType ( "*dashboards.GetDashboardQuery" )). Return ( fakeDash , nil )
2023-01-17 14:17:54 +01:00
mockSQLStore := dbtest . NewFakeDB ()
2018-01-31 16:51:06 +01:00
2022-02-07 12:43:43 +01:00
hs := & HTTPServer {
2022-05-25 10:41:51 +02:00
Cfg : setting . NewCfg (),
2023-07-17 12:21:44 +02:00
pluginStore : & fakes . FakePluginStore {},
2022-05-25 10:41:51 +02:00
SQLStore : mockSQLStore ,
AccessControl : accesscontrolmock . New (),
Features : featuremgmt . WithFeatures (),
2022-07-06 12:42:39 -06:00
DashboardService : dashboardService ,
2022-05-25 10:41:51 +02:00
dashboardVersionService : fakeDashboardVersionService ,
2022-11-10 15:36:40 -05:00
Kinds : corekind . NewBase ( nil ),
2022-11-14 21:08:10 +02:00
QuotaService : quotatest . New ( false , nil ),
2023-03-30 17:31:53 +03:00
userService : & usertest . FakeUserService {
ExpectedUser : & user . User { ID : 1 , Login : "test-user" },
},
2022-02-07 12:43:43 +01:00
}
2018-01-29 21:23:07 +01:00
2022-02-07 12:43:43 +01:00
setUp := func () {
2022-08-10 11:56:48 +02:00
viewerRole := org . RoleViewer
editorRole := org . RoleEditor
2023-01-25 10:36:26 +01:00
qResult := [] * dashboards . DashboardACLInfoDTO {
2023-01-26 08:46:30 -05:00
{ Role : & viewerRole , Permission : dashboards . PERMISSION_VIEW },
{ Role : & editorRole , Permission : dashboards . PERMISSION_EDIT },
2023-01-25 10:36:26 +01:00
}
dashboardService . On ( "GetDashboardACLInfoList" , mock . Anything , mock . AnythingOfType ( "*dashboards.GetDashboardACLInfoListQuery" )). Return ( qResult , nil )
2023-03-16 09:54:01 +00:00
guardian . InitLegacyGuardian ( hs . Cfg , mockSQLStore , dashboardService , teamService )
2020-11-13 09:52:38 +01:00
}
2017-06-22 17:43:55 -04:00
2018-01-30 14:09:30 +01:00
// This tests two scenarios:
// 1. user is an org viewer
// 2. user is an org editor
2020-11-13 09:52:38 +01:00
t . Run ( "When user is an Org Viewer" , func ( t * testing . T ) {
2022-08-10 11:56:48 +02:00
role := org . RoleViewer
2020-11-13 09:52:38 +01:00
loggedInUserScenarioWithRole ( t , "When calling GET on" , "GET" , "/api/dashboards/uid/abcdefghi" ,
"/api/dashboards/uid/:uid" , role , func ( sc * scenarioContext ) {
2022-02-07 12:43:43 +01:00
setUp ()
sc . sqlStore = mockSQLStore
2023-01-19 18:38:07 +02:00
dash := getDashboardShouldReturn200WithConfig ( t , sc , nil , nil , dashboardService , nil )
2020-11-13 09:52:38 +01:00
2023-04-14 16:50:10 -07:00
assert . Equal ( t , fakeDash . UID , dash . Dashboard . Get ( "uid" ). MustString ())
2020-11-13 09:52:38 +01:00
assert . False ( t , dash . Meta . CanEdit )
assert . False ( t , dash . Meta . CanSave )
assert . False ( t , dash . Meta . CanAdmin )
2022-02-07 12:43:43 +01:00
}, mockSQLStore )
2017-06-12 23:05:32 +02:00
2020-11-13 09:52:38 +01:00
loggedInUserScenarioWithRole ( t , "When calling GET on" , "GET" , "/api/dashboards/id/2/versions/1" ,
"/api/dashboards/id/:dashboardId/versions/:id" , role , func ( sc * scenarioContext ) {
setUp ()
2022-02-07 12:43:43 +01:00
sc . sqlStore = mockSQLStore
2018-01-31 16:46:31 +01:00
2022-02-07 12:43:43 +01:00
hs . callGetDashboardVersion ( sc )
2020-11-13 09:52:38 +01:00
assert . Equal ( t , 403 , sc . resp . Code )
2022-02-07 12:43:43 +01:00
}, mockSQLStore )
2017-06-12 23:05:32 +02:00
2020-11-13 09:52:38 +01:00
loggedInUserScenarioWithRole ( t , "When calling GET on" , "GET" , "/api/dashboards/id/2/versions" ,
"/api/dashboards/id/:dashboardId/versions" , role , func ( sc * scenarioContext ) {
setUp ()
2022-02-07 12:43:43 +01:00
sc . sqlStore = mockSQLStore
2017-06-14 00:28:34 +02:00
2022-02-07 12:43:43 +01:00
hs . callGetDashboardVersions ( sc )
2020-11-13 09:52:38 +01:00
assert . Equal ( t , 403 , sc . resp . Code )
2022-02-07 12:43:43 +01:00
}, mockSQLStore )
2017-06-12 15:48:55 +02:00
})
2020-11-13 09:52:38 +01:00
t . Run ( "When user is an Org Editor" , func ( t * testing . T ) {
2022-08-10 11:56:48 +02:00
role := org . RoleEditor
2020-11-13 09:52:38 +01:00
loggedInUserScenarioWithRole ( t , "When calling GET on" , "GET" , "/api/dashboards/uid/abcdefghi" ,
"/api/dashboards/uid/:uid" , role , func ( sc * scenarioContext ) {
2022-02-07 12:43:43 +01:00
setUp ()
sc . sqlStore = mockSQLStore
2023-01-19 18:38:07 +02:00
dash := getDashboardShouldReturn200WithConfig ( t , sc , nil , nil , dashboardService , nil )
2017-06-12 15:48:55 +02:00
2020-11-13 09:52:38 +01:00
assert . True ( t , dash . Meta . CanEdit )
assert . True ( t , dash . Meta . CanSave )
assert . False ( t , dash . Meta . CanAdmin )
2022-02-07 12:43:43 +01:00
}, mockSQLStore )
2017-06-12 23:05:32 +02:00
2020-11-13 09:52:38 +01:00
loggedInUserScenarioWithRole ( t , "When calling GET on" , "GET" , "/api/dashboards/id/2/versions/1" ,
"/api/dashboards/id/:dashboardId/versions/:id" , role , func ( sc * scenarioContext ) {
setUp ()
2022-02-07 12:43:43 +01:00
sc . sqlStore = mockSQLStore
hs . callGetDashboardVersion ( sc )
2018-01-31 16:46:31 +01:00
2020-11-13 09:52:38 +01:00
assert . Equal ( t , 200 , sc . resp . Code )
2023-03-30 17:31:53 +03:00
var version * dashver . DashboardVersionMeta
err := json . NewDecoder ( sc . resp . Body ). Decode ( & version )
require . NoError ( t , err )
assert . NotEqual ( t , anonString , version . CreatedBy )
2022-02-07 12:43:43 +01:00
}, mockSQLStore )
2017-06-12 23:05:32 +02:00
2020-11-13 09:52:38 +01:00
loggedInUserScenarioWithRole ( t , "When calling GET on" , "GET" , "/api/dashboards/id/2/versions" ,
"/api/dashboards/id/:dashboardId/versions" , role , func ( sc * scenarioContext ) {
setUp ()
2022-02-07 12:43:43 +01:00
hs . callGetDashboardVersions ( sc )
2017-06-14 00:28:34 +02:00
2020-11-13 09:52:38 +01:00
assert . Equal ( t , 200 , sc . resp . Code )
2022-02-07 12:43:43 +01:00
}, mockSQLStore )
2017-06-12 15:48:55 +02:00
})
})
2020-11-13 09:52:38 +01:00
t . Run ( "Given a dashboard with a parent folder which has an ACL" , func ( t * testing . T ) {
2023-01-16 16:33:55 +01:00
fakeDash := dashboards . NewDashboard ( "Child dash" )
fakeDash . ID = 1
fakeDash . FolderID = 1
2022-07-18 15:14:58 +02:00
fakeDash . HasACL = true
2022-05-25 10:41:51 +02:00
fakeDashboardVersionService := dashvertest . NewDashboardVersionServiceFake ()
2022-12-27 17:17:24 +01:00
fakeDashboardVersionService . ExpectedDashboardVersion = & dashver . DashboardVersionDTO {}
2022-09-20 18:58:04 +02:00
teamService := & teamtest . FakeService {}
2022-05-23 11:14:27 -04:00
dashboardService := dashboards . NewFakeDashboardService ( t )
2023-01-25 10:36:26 +01:00
dashboardService . On ( "GetDashboard" , mock . Anything , mock . AnythingOfType ( "*dashboards.GetDashboardQuery" )). Return ( fakeDash , nil )
qResult := [] * dashboards . DashboardACLInfoDTO {
{
DashboardID : 1 ,
2023-01-26 08:46:30 -05:00
Permission : dashboards . PERMISSION_EDIT ,
2023-01-25 10:36:26 +01:00
UserID : 200 ,
},
}
dashboardService . On ( "GetDashboardACLInfoList" , mock . Anything , mock . AnythingOfType ( "*dashboards.GetDashboardACLInfoListQuery" )). Return ( qResult , nil )
2022-02-07 12:43:43 +01:00
2023-01-17 14:17:54 +01:00
mockSQLStore := dbtest . NewFakeDB ()
2022-03-10 12:58:18 +01:00
cfg := setting . NewCfg ()
2022-10-19 09:02:15 -04:00
sql := db . InitTestDB ( t )
2022-05-17 14:52:22 -04:00
2020-11-13 09:52:38 +01:00
hs := & HTTPServer {
2022-05-25 10:41:51 +02:00
Cfg : cfg ,
Live : newTestLive ( t , sql ),
LibraryPanelService : & mockLibraryPanelService {},
LibraryElementService : & mockLibraryElementService {},
SQLStore : mockSQLStore ,
AccessControl : accesscontrolmock . New (),
2022-07-06 12:42:39 -06:00
DashboardService : dashboardService ,
2022-05-25 10:41:51 +02:00
dashboardVersionService : fakeDashboardVersionService ,
2022-07-19 17:44:41 -06:00
Features : featuremgmt . WithFeatures (),
2022-11-10 15:36:40 -05:00
Kinds : corekind . NewBase ( nil ),
2020-11-13 09:52:38 +01:00
}
2017-06-12 15:48:55 +02:00
2022-02-07 12:43:43 +01:00
setUp := func () {
2023-03-16 09:54:01 +00:00
cfg . ViewersCanEdit = false
guardian . InitLegacyGuardian ( cfg , mockSQLStore , dashboardService , teamService )
2019-04-30 13:32:18 +02:00
}
2018-01-30 14:09:30 +01:00
// This tests six scenarios:
// 1. user is an org viewer AND has no permissions for this dashboard
// 2. user is an org editor AND has no permissions for this dashboard
// 3. user is an org viewer AND has been granted edit permission for the dashboard
// 4. user is an org viewer AND all viewers have edit permission for this dashboard
// 5. user is an org viewer AND has been granted an admin permission
// 6. user is an org editor AND has been granted a view permission
2020-11-13 09:52:38 +01:00
t . Run ( "When user is an Org Viewer and has no permissions for this dashboard" , func ( t * testing . T ) {
2022-08-10 11:56:48 +02:00
role := org . RoleViewer
2020-11-13 09:52:38 +01:00
loggedInUserScenarioWithRole ( t , "When calling GET on" , "GET" , "/api/dashboards/uid/abcdefghi" ,
"/api/dashboards/uid/:uid" , role , func ( sc * scenarioContext ) {
2022-02-07 12:43:43 +01:00
setUp ()
sc . sqlStore = mockSQLStore
2020-11-13 09:52:38 +01:00
sc . handlerFunc = hs . GetDashboard
sc . fakeReqWithParams ( "GET" , sc . url , map [ string ] string {}). exec ()
2022-02-07 12:43:43 +01:00
2020-11-13 09:52:38 +01:00
assert . Equal ( t , 403 , sc . resp . Code )
2022-02-07 12:43:43 +01:00
}, mockSQLStore )
2018-01-29 21:23:07 +01:00
2020-11-13 09:52:38 +01:00
loggedInUserScenarioWithRole ( t , "When calling DELETE on" , "DELETE" , "/api/dashboards/uid/abcdefghi" ,
"/api/dashboards/uid/:uid" , role , func ( sc * scenarioContext ) {
2022-02-07 12:43:43 +01:00
setUp ()
sc . sqlStore = mockSQLStore
2023-03-08 14:54:35 -06:00
hs . callDeleteDashboardByUID ( t , sc , dashboardService , nil )
2018-01-29 21:23:07 +01:00
2020-11-13 09:52:38 +01:00
assert . Equal ( t , 403 , sc . resp . Code )
2022-02-07 12:43:43 +01:00
}, mockSQLStore )
2017-06-12 23:05:32 +02:00
2020-11-13 09:52:38 +01:00
loggedInUserScenarioWithRole ( t , "When calling GET on" , "GET" , "/api/dashboards/id/2/versions/1" ,
"/api/dashboards/id/:dashboardId/versions/:id" , role , func ( sc * scenarioContext ) {
setUp ()
2022-02-07 12:43:43 +01:00
sc . sqlStore = mockSQLStore
hs . callGetDashboardVersion ( sc )
2018-01-31 16:46:31 +01:00
2020-11-13 09:52:38 +01:00
assert . Equal ( t , 403 , sc . resp . Code )
2022-02-07 12:43:43 +01:00
}, mockSQLStore )
2017-06-12 23:05:32 +02:00
2020-11-13 09:52:38 +01:00
loggedInUserScenarioWithRole ( t , "When calling GET on" , "GET" , "/api/dashboards/id/2/versions" ,
"/api/dashboards/id/:dashboardId/versions" , role , func ( sc * scenarioContext ) {
setUp ()
2022-02-07 12:43:43 +01:00
hs . callGetDashboardVersions ( sc )
2017-06-14 00:28:34 +02:00
2020-11-13 09:52:38 +01:00
assert . Equal ( t , 403 , sc . resp . Code )
2022-02-07 12:43:43 +01:00
}, mockSQLStore )
2017-06-12 15:48:55 +02:00
})
2020-11-13 09:52:38 +01:00
t . Run ( "When user is an Org Editor and has no permissions for this dashboard" , func ( t * testing . T ) {
2022-08-10 11:56:48 +02:00
role := org . RoleEditor
2020-11-13 09:52:38 +01:00
loggedInUserScenarioWithRole ( t , "When calling GET on" , "GET" , "/api/dashboards/uid/abcdefghi" ,
"/api/dashboards/uid/:uid" , role , func ( sc * scenarioContext ) {
2022-02-07 12:43:43 +01:00
setUp ()
sc . sqlStore = mockSQLStore
2020-11-13 09:52:38 +01:00
sc . handlerFunc = hs . GetDashboard
sc . fakeReqWithParams ( "GET" , sc . url , map [ string ] string {}). exec ()
assert . Equal ( t , 403 , sc . resp . Code )
2022-02-07 12:43:43 +01:00
}, mockSQLStore )
2018-01-29 21:23:07 +01:00
2020-11-13 09:52:38 +01:00
loggedInUserScenarioWithRole ( t , "When calling DELETE on" , "DELETE" , "/api/dashboards/uid/abcdefghi" ,
"/api/dashboards/uid/:uid" , role , func ( sc * scenarioContext ) {
2022-02-07 12:43:43 +01:00
setUp ()
2023-03-08 14:54:35 -06:00
hs . callDeleteDashboardByUID ( t , sc , dashboardService , nil )
2018-01-29 21:23:07 +01:00
2020-11-13 09:52:38 +01:00
assert . Equal ( t , 403 , sc . resp . Code )
2022-02-07 12:43:43 +01:00
}, mockSQLStore )
2017-06-12 23:05:32 +02:00
2020-11-13 09:52:38 +01:00
loggedInUserScenarioWithRole ( t , "When calling GET on" , "GET" , "/api/dashboards/id/2/versions/1" ,
"/api/dashboards/id/:dashboardId/versions/:id" , role , func ( sc * scenarioContext ) {
setUp ()
2022-02-07 12:43:43 +01:00
hs . callGetDashboardVersion ( sc )
2018-01-31 16:46:31 +01:00
2020-11-13 09:52:38 +01:00
assert . Equal ( t , 403 , sc . resp . Code )
2022-02-07 12:43:43 +01:00
}, mockSQLStore )
2017-06-12 23:05:32 +02:00
2020-11-13 09:52:38 +01:00
loggedInUserScenarioWithRole ( t , "When calling GET on" , "GET" , "/api/dashboards/id/2/versions" ,
"/api/dashboards/id/:dashboardId/versions" , role , func ( sc * scenarioContext ) {
setUp ()
2022-02-07 12:43:43 +01:00
hs . callGetDashboardVersions ( sc )
2017-06-14 00:28:34 +02:00
2020-11-13 09:52:38 +01:00
assert . Equal ( t , 403 , sc . resp . Code )
2022-02-07 12:43:43 +01:00
}, mockSQLStore )
2017-06-12 15:48:55 +02:00
})
2020-11-13 09:52:38 +01:00
t . Run ( "When user is an Org Viewer but has an edit permission" , func ( t * testing . T ) {
2022-08-10 11:56:48 +02:00
role := org . RoleViewer
2017-06-12 23:05:32 +02:00
2022-02-07 12:43:43 +01:00
setUpInner := func () {
2023-03-16 09:54:01 +00:00
cfg . ViewersCanEdit = false
2022-06-01 14:16:26 -04:00
dashboardService := dashboards . NewFakeDashboardService ( t )
2023-01-25 10:36:26 +01:00
qResult := [] * dashboards . DashboardACLInfoDTO {
2023-01-26 08:46:30 -05:00
{ OrgID : 1 , DashboardID : 2 , UserID : 1 , Permission : dashboards . PERMISSION_EDIT },
2023-01-25 10:36:26 +01:00
}
dashboardService . On ( "GetDashboardACLInfoList" , mock . Anything , mock . AnythingOfType ( "*dashboards.GetDashboardACLInfoListQuery" )). Return ( qResult , nil )
2023-03-16 09:54:01 +00:00
guardian . InitLegacyGuardian ( cfg , mockSQLStore , dashboardService , teamService )
2020-11-13 09:52:38 +01:00
}
2022-02-07 12:43:43 +01:00
2020-11-13 09:52:38 +01:00
loggedInUserScenarioWithRole ( t , "When calling GET on" , "GET" , "/api/dashboards/uid/abcdefghi" ,
"/api/dashboards/uid/:uid" , role , func ( sc * scenarioContext ) {
2022-02-07 12:43:43 +01:00
setUpInner ()
sc . sqlStore = mockSQLStore
2023-01-19 18:38:07 +02:00
dash := getDashboardShouldReturn200WithConfig ( t , sc , nil , nil , dashboardService , nil )
2018-01-29 21:23:07 +01:00
2020-11-13 09:52:38 +01:00
assert . True ( t , dash . Meta . CanEdit )
assert . True ( t , dash . Meta . CanSave )
assert . False ( t , dash . Meta . CanAdmin )
2022-02-07 12:43:43 +01:00
}, mockSQLStore )
2017-06-23 00:34:19 +02:00
2020-11-13 09:52:38 +01:00
loggedInUserScenarioWithRole ( t , "When calling DELETE on" , "DELETE" , "/api/dashboards/uid/abcdefghi" , "/api/dashboards/uid/:uid" , role , func ( sc * scenarioContext ) {
2022-02-07 12:43:43 +01:00
setUpInner ()
2022-05-23 11:14:27 -04:00
dashboardService := dashboards . NewFakeDashboardService ( t )
2023-01-25 10:36:26 +01:00
qResult := dashboards . NewDashboard ( "test" )
dashboardService . On ( "GetDashboard" , mock . Anything , mock . AnythingOfType ( "*dashboards.GetDashboardQuery" )). Return ( qResult , nil )
2022-05-23 11:14:27 -04:00
dashboardService . On ( "DeleteDashboard" , mock . Anything , mock . AnythingOfType ( "int64" ), mock . AnythingOfType ( "int64" )). Return ( nil )
2022-02-07 12:43:43 +01:00
2023-03-08 14:54:35 -06:00
pubdashService := publicdashboards . NewFakePublicDashboardService ( t )
pubdashService . On ( "DeleteByDashboard" , mock . Anything , mock . Anything ). Return ( nil )
hs . callDeleteDashboardByUID ( t , sc , dashboardService , pubdashService )
2020-11-13 09:52:38 +01:00
assert . Equal ( t , 200 , sc . resp . Code )
2022-02-07 12:43:43 +01:00
}, mockSQLStore )
2017-06-23 00:34:19 +02:00
})
2020-11-13 09:52:38 +01:00
t . Run ( "When user is an Org Viewer and viewers can edit" , func ( t * testing . T ) {
2022-08-10 11:56:48 +02:00
role := org . RoleViewer
2017-12-15 14:19:49 +01:00
2022-02-07 12:43:43 +01:00
setUpInner := func () {
2023-03-16 09:54:01 +00:00
cfg . ViewersCanEdit = true
2022-06-01 14:16:26 -04:00
dashboardService := dashboards . NewFakeDashboardService ( t )
2023-01-25 10:36:26 +01:00
qResult := [] * dashboards . DashboardACLInfoDTO {
2023-01-26 08:46:30 -05:00
{ OrgID : 1 , DashboardID : 2 , UserID : 1 , Permission : dashboards . PERMISSION_VIEW },
2023-01-25 10:36:26 +01:00
}
dashboardService . On ( "GetDashboardACLInfoList" , mock . Anything , mock . AnythingOfType ( "*dashboards.GetDashboardACLInfoListQuery" )). Return ( qResult , nil )
2023-03-16 09:54:01 +00:00
guardian . InitLegacyGuardian ( cfg , mockSQLStore , dashboardService , teamService )
2020-11-13 09:52:38 +01:00
}
2022-02-07 12:43:43 +01:00
2020-11-13 09:52:38 +01:00
loggedInUserScenarioWithRole ( t , "When calling GET on" , "GET" , "/api/dashboards/uid/abcdefghi" , "/api/dashboards/uid/:uid" , role , func ( sc * scenarioContext ) {
2022-02-07 12:43:43 +01:00
setUpInner ()
2017-12-15 14:19:49 +01:00
2023-03-16 09:54:01 +00:00
require . True ( t , cfg . ViewersCanEdit )
2022-02-07 12:43:43 +01:00
sc . sqlStore = mockSQLStore
2023-01-19 18:38:07 +02:00
dash := getDashboardShouldReturn200WithConfig ( t , sc , nil , nil , dashboardService , nil )
2018-01-29 21:23:07 +01:00
2020-11-13 09:52:38 +01:00
assert . True ( t , dash . Meta . CanEdit )
assert . False ( t , dash . Meta . CanSave )
assert . False ( t , dash . Meta . CanAdmin )
2022-02-07 12:43:43 +01:00
}, mockSQLStore )
2017-12-15 14:19:49 +01:00
2020-11-13 09:52:38 +01:00
loggedInUserScenarioWithRole ( t , "When calling DELETE on" , "DELETE" , "/api/dashboards/uid/abcdefghi" , "/api/dashboards/uid/:uid" , role , func ( sc * scenarioContext ) {
2022-02-07 12:43:43 +01:00
setUpInner ()
2018-01-31 16:46:31 +01:00
2023-03-08 14:54:35 -06:00
hs . callDeleteDashboardByUID ( t , sc , dashboardService , nil )
2020-11-13 09:52:38 +01:00
assert . Equal ( t , 403 , sc . resp . Code )
2022-02-07 12:43:43 +01:00
}, mockSQLStore )
2017-12-15 14:19:49 +01:00
})
2020-11-13 09:52:38 +01:00
t . Run ( "When user is an Org Viewer but has an admin permission" , func ( t * testing . T ) {
2022-08-10 11:56:48 +02:00
role := org . RoleViewer
2017-06-23 00:34:19 +02:00
2022-02-07 12:43:43 +01:00
setUpInner := func () {
2023-03-16 09:54:01 +00:00
cfg . ViewersCanEdit = true
2020-11-13 09:52:38 +01:00
2022-06-01 14:16:26 -04:00
dashboardService := dashboards . NewFakeDashboardService ( t )
2023-01-25 10:36:26 +01:00
qResult := [] * dashboards . DashboardACLInfoDTO {
2023-01-26 08:46:30 -05:00
{ OrgID : 1 , DashboardID : 2 , UserID : 1 , Permission : dashboards . PERMISSION_ADMIN },
2023-01-25 10:36:26 +01:00
}
dashboardService . On ( "GetDashboardACLInfoList" , mock . Anything , mock . AnythingOfType ( "*dashboards.GetDashboardACLInfoListQuery" )). Return ( qResult , nil )
2023-03-16 09:54:01 +00:00
guardian . InitLegacyGuardian ( cfg , mockSQLStore , dashboardService , teamService )
2017-06-23 00:34:19 +02:00
}
2022-02-07 12:43:43 +01:00
loggedInUserScenarioWithRole ( t , "When calling GET on" , "GET" , "/api/dashboards/uid/abcdefghi" , "/api/dashboards/uid/:uid" , role , func ( sc * scenarioContext ) {
setUpInner ()
sc . sqlStore = mockSQLStore
2023-01-19 18:38:07 +02:00
dash := getDashboardShouldReturn200WithConfig ( t , sc , nil , nil , dashboardService , nil )
2018-01-29 21:23:07 +01:00
2020-11-13 09:52:38 +01:00
assert . True ( t , dash . Meta . CanEdit )
assert . True ( t , dash . Meta . CanSave )
assert . True ( t , dash . Meta . CanAdmin )
2022-02-07 12:43:43 +01:00
}, mockSQLStore )
2017-06-12 23:05:32 +02:00
2020-11-13 09:52:38 +01:00
loggedInUserScenarioWithRole ( t , "When calling DELETE on" , "DELETE" , "/api/dashboards/uid/abcdefghi" , "/api/dashboards/uid/:uid" , role , func ( sc * scenarioContext ) {
2022-02-07 12:43:43 +01:00
setUpInner ()
sc . sqlStore = mockSQLStore
2022-05-23 11:14:27 -04:00
dashboardService := dashboards . NewFakeDashboardService ( t )
2023-01-25 10:36:26 +01:00
qResult := dashboards . NewDashboard ( "test" )
dashboardService . On ( "GetDashboard" , mock . Anything , mock . AnythingOfType ( "*dashboards.GetDashboardQuery" )). Return ( qResult , nil )
2022-05-23 11:14:27 -04:00
dashboardService . On ( "DeleteDashboard" , mock . Anything , mock . AnythingOfType ( "int64" ), mock . AnythingOfType ( "int64" )). Return ( nil )
2023-03-08 14:54:35 -06:00
pubdashService := publicdashboards . NewFakePublicDashboardService ( t )
pubdashService . On ( "DeleteByDashboard" , mock . Anything , mock . Anything ). Return ( nil )
hs . callDeleteDashboardByUID ( t , sc , dashboardService , pubdashService )
2018-01-29 21:23:07 +01:00
2020-11-13 09:52:38 +01:00
assert . Equal ( t , 200 , sc . resp . Code )
2022-02-07 12:43:43 +01:00
}, mockSQLStore )
2017-06-12 23:05:32 +02:00
2020-11-13 09:52:38 +01:00
loggedInUserScenarioWithRole ( t , "When calling GET on" , "GET" , "/api/dashboards/id/2/versions/1" , "/api/dashboards/id/:dashboardId/versions/:id" , role , func ( sc * scenarioContext ) {
setUpInner ()
2018-01-31 16:46:31 +01:00
2022-02-07 12:43:43 +01:00
hs . callGetDashboardVersion ( sc )
2020-11-13 09:52:38 +01:00
assert . Equal ( t , 200 , sc . resp . Code )
2022-02-07 12:43:43 +01:00
}, mockSQLStore )
2017-06-12 23:05:32 +02:00
2020-11-13 09:52:38 +01:00
loggedInUserScenarioWithRole ( t , "When calling GET on" , "GET" , "/api/dashboards/id/2/versions" , "/api/dashboards/id/:dashboardId/versions" , role , func ( sc * scenarioContext ) {
setUpInner ()
2017-06-14 00:28:34 +02:00
2022-02-07 12:43:43 +01:00
hs . callGetDashboardVersions ( sc )
2020-11-13 09:52:38 +01:00
assert . Equal ( t , 200 , sc . resp . Code )
2022-02-07 12:43:43 +01:00
}, mockSQLStore )
2017-06-12 15:48:55 +02:00
})
2020-11-13 09:52:38 +01:00
t . Run ( "When user is an Org Editor but has a view permission" , func ( t * testing . T ) {
2022-08-10 11:56:48 +02:00
role := org . RoleEditor
2017-06-12 23:05:32 +02:00
2022-02-07 12:43:43 +01:00
setUpInner := func () {
2023-03-16 09:54:01 +00:00
cfg := setting . NewCfg ()
2022-06-01 14:16:26 -04:00
dashboardService := dashboards . NewFakeDashboardService ( t )
2023-01-25 10:36:26 +01:00
qResult := [] * dashboards . DashboardACLInfoDTO {
2023-01-26 08:46:30 -05:00
{ OrgID : 1 , DashboardID : 2 , UserID : 1 , Permission : dashboards . PERMISSION_VIEW },
2023-01-25 10:36:26 +01:00
}
dashboardService . On ( "GetDashboardACLInfoList" , mock . Anything , mock . AnythingOfType ( "*dashboards.GetDashboardACLInfoListQuery" )). Return ( qResult , nil )
2023-03-16 09:54:01 +00:00
guardian . InitLegacyGuardian ( cfg , mockSQLStore , dashboardService , teamService )
2020-11-13 09:52:38 +01:00
}
2017-06-12 15:48:55 +02:00
2022-02-07 12:43:43 +01:00
loggedInUserScenarioWithRole ( t , "When calling GET on" , "GET" , "/api/dashboards/uid/abcdefghi" , "/api/dashboards/uid/:uid" , role , func ( sc * scenarioContext ) {
setUpInner ()
sc . sqlStore = mockSQLStore
2023-01-19 18:38:07 +02:00
dash := getDashboardShouldReturn200WithConfig ( t , sc , nil , nil , dashboardService , nil )
2022-02-07 12:43:43 +01:00
2020-11-13 09:52:38 +01:00
assert . False ( t , dash . Meta . CanEdit )
assert . False ( t , dash . Meta . CanSave )
2022-02-07 12:43:43 +01:00
}, mockSQLStore )
2017-06-12 23:05:32 +02:00
2020-11-13 09:52:38 +01:00
loggedInUserScenarioWithRole ( t , "When calling DELETE on" , "DELETE" , "/api/dashboards/uid/abcdefghi" , "/api/dashboards/uid/:uid" , role , func ( sc * scenarioContext ) {
2022-02-07 12:43:43 +01:00
setUpInner ()
2023-03-08 14:54:35 -06:00
hs . callDeleteDashboardByUID ( t , sc , dashboardService , nil )
2018-01-31 16:46:31 +01:00
2020-11-13 09:52:38 +01:00
assert . Equal ( t , 403 , sc . resp . Code )
2022-02-07 12:43:43 +01:00
}, mockSQLStore )
2017-06-12 23:05:32 +02:00
2020-11-13 09:52:38 +01:00
loggedInUserScenarioWithRole ( t , "When calling GET on" , "GET" , "/api/dashboards/id/2/versions/1" , "/api/dashboards/id/:dashboardId/versions/:id" , role , func ( sc * scenarioContext ) {
setUpInner ()
2022-02-07 12:43:43 +01:00
hs . callGetDashboardVersion ( sc )
2020-11-13 09:52:38 +01:00
assert . Equal ( t , 403 , sc . resp . Code )
2022-02-07 12:43:43 +01:00
}, mockSQLStore )
2017-06-14 00:28:34 +02:00
2020-11-13 09:52:38 +01:00
loggedInUserScenarioWithRole ( t , "When calling GET on" , "GET" , "/api/dashboards/id/2/versions" , "/api/dashboards/id/:dashboardId/versions" , role , func ( sc * scenarioContext ) {
setUpInner ()
2022-02-07 12:43:43 +01:00
hs . callGetDashboardVersions ( sc )
2020-11-13 09:52:38 +01:00
assert . Equal ( t , 403 , sc . resp . Code )
2022-02-07 12:43:43 +01:00
}, mockSQLStore )
2017-06-12 15:48:55 +02:00
})
})
2018-01-31 16:51:06 +01:00
2020-11-13 09:52:38 +01:00
t . Run ( "Given two dashboards with the same title in different folders" , func ( t * testing . T ) {
2023-01-18 13:52:41 +01:00
dashOne := dashboards . NewDashboard ( "dash" )
dashOne . ID = 2
dashOne . FolderID = 1
2022-07-18 15:14:58 +02:00
dashOne . HasACL = false
2018-01-31 16:51:06 +01:00
2023-01-18 13:52:41 +01:00
dashTwo := dashboards . NewDashboard ( "dash" )
dashTwo . ID = 4
dashTwo . FolderID = 3
2022-07-18 15:14:58 +02:00
dashTwo . HasACL = false
2018-01-31 16:51:06 +01:00
})
2018-02-19 11:12:56 +01:00
2020-11-13 09:52:38 +01:00
t . Run ( "Post dashboard response tests" , func ( t * testing . T ) {
2022-03-10 12:19:50 -05:00
dashboardStore := & dashboards . FakeDashboardStore {}
2022-02-16 14:15:44 +01:00
defer dashboardStore . AssertExpectations ( t )
2018-02-19 11:12:56 +01:00
// This tests that a valid request returns correct response
2020-11-13 09:52:38 +01:00
t . Run ( "Given a correct request for creating a dashboard" , func ( t * testing . T ) {
const folderID int64 = 3
const dashID int64 = 2
2018-02-19 11:12:56 +01:00
2023-01-18 13:52:41 +01:00
cmd := dashboards . SaveDashboardCommand {
OrgID : 1 ,
UserID : 5 ,
2018-02-19 11:12:56 +01:00
Dashboard : simplejson . NewFromAny ( map [ string ] interface {}{
"title" : "Dash" ,
}),
Overwrite : true ,
2023-01-18 13:52:41 +01:00
FolderID : folderID ,
2018-02-19 11:12:56 +01:00
IsFolder : false ,
Message : "msg" ,
}
2022-05-23 11:14:27 -04:00
dashboardService := dashboards . NewFakeDashboardService ( t )
dashboardService . On ( "SaveDashboard" , mock . Anything , mock . AnythingOfType ( "*dashboards.SaveDashboardDTO" ), mock . AnythingOfType ( "bool" )).
2023-01-16 16:33:55 +01:00
Return ( & dashboards . Dashboard { ID : dashID , UID : "uid" , Title : "Dash" , Slug : "dash" , Version : 2 }, nil )
2018-02-19 11:12:56 +01:00
2022-05-23 11:14:27 -04:00
postDashboardScenario ( t , "When calling POST on" , "/api/dashboards" , "/api/dashboards" , cmd , dashboardService , nil , func ( sc * scenarioContext ) {
2020-11-13 09:52:38 +01:00
callPostDashboardShouldReturnSuccess ( sc )
2018-02-19 11:12:56 +01:00
2020-11-13 09:52:38 +01:00
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 ())
2018-02-19 11:12:56 +01:00
})
})
2021-05-26 16:20:13 +02:00
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
2023-01-18 13:52:41 +01:00
cmd := dashboards . SaveDashboardCommand {
OrgID : 1 ,
UserID : 5 ,
2021-05-26 16:20:13 +02:00
Dashboard : simplejson . NewFromAny ( map [ string ] interface {}{
"title" : "Dash" ,
}),
Overwrite : true ,
2023-01-18 13:52:41 +01:00
FolderUID : folderUid ,
2021-05-26 16:20:13 +02:00
IsFolder : false ,
Message : "msg" ,
}
2022-05-23 11:14:27 -04:00
dashboardService := dashboards . NewFakeDashboardService ( t )
dashboardService . On ( "SaveDashboard" , mock . Anything , mock . AnythingOfType ( "*dashboards.SaveDashboardDTO" ), mock . AnythingOfType ( "bool" )).
2023-01-16 16:33:55 +01:00
Return ( & dashboards . Dashboard { ID : dashID , UID : "uid" , Title : "Dash" , Slug : "dash" , Version : 2 }, nil )
2021-05-26 16:20:13 +02:00
2022-11-11 14:28:24 +01:00
mockFolder := & foldertest . FakeService {
ExpectedFolder : & folder . Folder { ID : 1 , UID : "folderUID" , Title : "Folder" },
2021-05-26 16:20:13 +02:00
}
2022-05-23 11:14:27 -04:00
postDashboardScenario ( t , "When calling POST on" , "/api/dashboards" , "/api/dashboards" , cmd , dashboardService , mockFolder , func ( sc * scenarioContext ) {
2021-05-26 16:20:13 +02:00
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 request with incorrect folder uid for creating a dashboard with" , func ( t * testing . T ) {
2023-01-18 13:52:41 +01:00
cmd := dashboards . SaveDashboardCommand {
OrgID : 1 ,
UserID : 5 ,
2021-05-26 16:20:13 +02:00
Dashboard : simplejson . NewFromAny ( map [ string ] interface {}{
"title" : "Dash" ,
}),
Overwrite : true ,
2023-01-18 13:52:41 +01:00
FolderUID : "folderUID" ,
2021-05-26 16:20:13 +02:00
IsFolder : false ,
Message : "msg" ,
}
2022-05-23 11:14:27 -04:00
dashboardService := dashboards . NewFakeDashboardService ( t )
2021-05-26 16:20:13 +02:00
2022-11-11 14:28:24 +01:00
mockFolder := & foldertest . FakeService {
ExpectedError : errors . New ( "Error while searching Folder ID" ),
2021-05-26 16:20:13 +02:00
}
2022-05-23 11:14:27 -04:00
postDashboardScenario ( t , "When calling POST on" , "/api/dashboards" , "/api/dashboards" , cmd , dashboardService , mockFolder , func ( sc * scenarioContext ) {
2021-05-26 16:20:13 +02:00
callPostDashboard ( sc )
assert . Equal ( t , 500 , sc . resp . Code )
})
})
2018-02-19 11:12:56 +01:00
// This tests that invalid requests returns expected error responses
2020-11-13 09:52:38 +01:00
t . Run ( "Given incorrect requests for creating a dashboard" , func ( t * testing . T ) {
2018-02-19 11:12:56 +01:00
testCases := [] struct {
SaveError error
ExpectedStatusCode int
}{
2022-06-30 09:31:54 -04:00
{ SaveError : dashboards . ErrDashboardNotFound , ExpectedStatusCode : 404 },
{ SaveError : dashboards . ErrFolderNotFound , ExpectedStatusCode : 400 },
{ SaveError : dashboards . ErrDashboardWithSameUIDExists , ExpectedStatusCode : 400 },
{ SaveError : dashboards . ErrDashboardWithSameNameInFolderExists , ExpectedStatusCode : 412 },
{ SaveError : dashboards . ErrDashboardVersionMismatch , ExpectedStatusCode : 412 },
{ SaveError : dashboards . ErrDashboardTitleEmpty , ExpectedStatusCode : 400 },
{ SaveError : dashboards . ErrDashboardFolderCannotHaveParent , ExpectedStatusCode : 400 },
2018-10-12 22:53:28 -07:00
{ SaveError : alerting . ValidationError { Reason : "Mu" }, ExpectedStatusCode : 422 },
2022-06-30 09:31:54 -04:00
{ SaveError : dashboards . ErrDashboardTypeMismatch , ExpectedStatusCode : 400 },
{ SaveError : dashboards . ErrDashboardFolderWithSameNameAsDashboard , ExpectedStatusCode : 400 },
{ SaveError : dashboards . ErrDashboardWithSameNameAsFolder , ExpectedStatusCode : 400 },
{ SaveError : dashboards . ErrDashboardFolderNameExists , ExpectedStatusCode : 400 },
{ SaveError : dashboards . ErrDashboardUpdateAccessDenied , ExpectedStatusCode : 403 },
{ SaveError : dashboards . ErrDashboardInvalidUid , ExpectedStatusCode : 400 },
{ SaveError : dashboards . ErrDashboardUidTooLong , ExpectedStatusCode : 400 },
{ SaveError : dashboards . ErrDashboardCannotSaveProvisionedDashboard , ExpectedStatusCode : 400 },
{ SaveError : dashboards . UpdatePluginDashboardError { PluginId : "plug" }, ExpectedStatusCode : 412 },
2018-02-19 11:12:56 +01:00
}
2023-01-18 13:52:41 +01:00
cmd := dashboards . SaveDashboardCommand {
OrgID : 1 ,
2018-02-19 11:12:56 +01:00
Dashboard : simplejson . NewFromAny ( map [ string ] interface {}{
"title" : "" ,
}),
}
for _ , tc := range testCases {
2022-05-23 11:14:27 -04:00
dashboardService := dashboards . NewFakeDashboardService ( t )
dashboardService . On ( "SaveDashboard" , mock . Anything , mock . AnythingOfType ( "*dashboards.SaveDashboardDTO" ), mock . AnythingOfType ( "bool" )). Return ( nil , tc . SaveError )
2018-02-19 11:12:56 +01:00
2020-11-13 09:52:38 +01:00
postDashboardScenario ( t , fmt . Sprintf ( "Expect '%s' error when calling POST on" , tc . SaveError . Error ()),
2022-05-23 11:14:27 -04:00
"/api/dashboards" , "/api/dashboards" , cmd , dashboardService , nil , func ( sc * scenarioContext ) {
2020-11-13 09:52:38 +01:00
callPostDashboard ( sc )
assert . Equal ( t , tc . ExpectedStatusCode , sc . resp . Code )
})
2018-02-19 11:12:56 +01:00
}
})
})
2018-02-27 17:53:30 +01:00
2022-10-14 14:51:05 +01:00
t . Run ( "Given a dashboard to validate" , func ( t * testing . T ) {
2023-01-18 16:01:25 +01:00
sqlmock := dbtest . NewFakeDB ()
2022-10-14 14:51:05 +01:00
t . Run ( "When an invalid dashboard json is posted" , func ( t * testing . T ) {
2023-01-18 13:52:41 +01:00
cmd := dashboards . ValidateDashboardCommand {
2022-10-14 14:51:05 +01:00
Dashboard : "{\"hello\": \"world\"}" ,
}
role := org . RoleAdmin
postValidateScenario ( t , "When calling POST on" , "/api/dashboards/validate" , "/api/dashboards/validate" , cmd , role , func ( sc * scenarioContext ) {
callPostDashboard ( sc )
result := sc . ToJSON ()
assert . Equal ( t , 422 , sc . resp . Code )
assert . False ( t , result . Get ( "isValid" ). MustBool ())
assert . NotEmpty ( t , result . Get ( "message" ). MustString ())
2023-01-18 16:01:25 +01:00
}, sqlmock )
2022-10-14 14:51:05 +01:00
})
t . Run ( "When a dashboard with a too-low schema version is posted" , func ( t * testing . T ) {
2023-01-18 13:52:41 +01:00
cmd := dashboards . ValidateDashboardCommand {
2022-10-14 14:51:05 +01:00
Dashboard : "{\"schemaVersion\": 1}" ,
}
role := org . RoleAdmin
postValidateScenario ( t , "When calling POST on" , "/api/dashboards/validate" , "/api/dashboards/validate" , cmd , role , func ( sc * scenarioContext ) {
callPostDashboard ( sc )
result := sc . ToJSON ()
assert . Equal ( t , 412 , sc . resp . Code )
assert . False ( t , result . Get ( "isValid" ). MustBool ())
assert . Equal ( t , "invalid schema version" , result . Get ( "message" ). MustString ())
2023-01-18 16:01:25 +01:00
}, sqlmock )
2022-10-14 14:51:05 +01:00
})
t . Run ( "When a valid dashboard is posted" , func ( t * testing . T ) {
devenvDashboard , readErr := os . ReadFile ( "../../devenv/dev-dashboards/home.json" )
assert . Empty ( t , readErr )
2023-01-18 13:52:41 +01:00
cmd := dashboards . ValidateDashboardCommand {
2022-10-14 14:51:05 +01:00
Dashboard : string ( devenvDashboard ),
}
role := org . RoleAdmin
postValidateScenario ( t , "When calling POST on" , "/api/dashboards/validate" , "/api/dashboards/validate" , cmd , role , func ( sc * scenarioContext ) {
callPostDashboard ( sc )
result := sc . ToJSON ()
assert . Equal ( t , 200 , sc . resp . Code )
assert . True ( t , result . Get ( "isValid" ). MustBool ())
2023-01-18 16:01:25 +01:00
}, sqlmock )
2022-10-14 14:51:05 +01:00
})
})
2020-11-13 09:52:38 +01:00
t . Run ( "Given two dashboards being compared" , func ( t * testing . T ) {
2022-05-25 10:41:51 +02:00
fakeDashboardVersionService := dashvertest . NewDashboardVersionServiceFake ()
2022-12-27 17:17:24 +01:00
fakeDashboardVersionService . ExpectedDashboardVersions = [] * dashver . DashboardVersionDTO {
2022-05-25 10:41:51 +02:00
{
DashboardID : 1 ,
Version : 1 ,
Data : simplejson . NewFromAny ( map [ string ] interface {}{
"title" : "Dash1" ,
}),
},
{
DashboardID : 2 ,
Version : 2 ,
Data : simplejson . NewFromAny ( map [ string ] interface {}{
"title" : "Dash2" ,
}),
},
}
2023-01-17 14:17:54 +01:00
sqlmock := dbtest . NewFakeDB ()
2020-11-13 09:52:38 +01:00
setUp := func () {
2022-09-20 18:58:04 +02:00
teamSvc := & teamtest . FakeService {}
2022-06-01 14:16:26 -04:00
dashSvc := dashboards . NewFakeDashboardService ( t )
2023-01-25 10:36:26 +01:00
dashSvc . On ( "GetDashboardACLInfoList" , mock . Anything , mock . AnythingOfType ( "*dashboards.GetDashboardACLInfoListQuery" )). Return ( nil , nil )
qResult := & dashboards . Dashboard {}
dashSvc . On ( "GetDashboard" , mock . Anything , mock . AnythingOfType ( "*dashboards.GetDashboardQuery" )). Return ( qResult , nil )
2023-03-16 09:54:01 +00:00
guardian . InitLegacyGuardian ( setting . NewCfg (), sqlmock , dashSvc , teamSvc )
2020-11-13 09:52:38 +01:00
}
2018-02-27 17:53:30 +01:00
cmd := dtos . CalculateDiffOptions {
Base : dtos . CalculateDiffTarget {
DashboardId : 1 ,
Version : 1 ,
},
New : dtos . CalculateDiffTarget {
DashboardId : 2 ,
Version : 2 ,
},
DiffType : "basic" ,
}
2020-11-13 09:52:38 +01:00
t . Run ( "when user does not have permission" , func ( t * testing . T ) {
2022-08-10 11:56:48 +02:00
role := org . RoleViewer
2020-11-13 09:52:38 +01:00
postDiffScenario ( t , "When calling POST on" , "/api/dashboards/calculate-diff" , "/api/dashboards/calculate-diff" , cmd , role , func ( sc * scenarioContext ) {
setUp ()
callPostDashboard ( sc )
assert . Equal ( t , 403 , sc . resp . Code )
2023-01-17 14:17:54 +01:00
}, sqlmock , fakeDashboardVersionService )
2018-02-27 17:53:30 +01:00
})
2020-11-13 09:52:38 +01:00
t . Run ( "when user does have permission" , func ( t * testing . T ) {
2022-08-10 11:56:48 +02:00
role := org . RoleAdmin
2020-11-13 09:52:38 +01:00
postDiffScenario ( t , "When calling POST on" , "/api/dashboards/calculate-diff" , "/api/dashboards/calculate-diff" , cmd , role , func ( sc * scenarioContext ) {
2022-07-18 15:14:58 +02:00
// This test shouldn't hit GetDashboardACLInfoList, so no setup needed
2022-05-25 10:41:51 +02:00
sc . dashboardVersionService = fakeDashboardVersionService
2020-11-13 09:52:38 +01:00
callPostDashboard ( sc )
assert . Equal ( t , 200 , sc . resp . Code )
2023-01-17 14:17:54 +01:00
}, sqlmock , fakeDashboardVersionService )
2018-02-27 17:53:30 +01:00
})
})
2019-03-06 14:38:40 +01:00
2020-11-13 09:52:38 +01:00
t . Run ( "Given dashboard in folder being restored should restore to folder" , func ( t * testing . T ) {
const folderID int64 = 1
2023-01-16 16:33:55 +01:00
fakeDash := dashboards . NewDashboard ( "Child dash" )
fakeDash . ID = 2
fakeDash . FolderID = folderID
2022-07-18 15:14:58 +02:00
fakeDash . HasACL = false
2019-03-06 14:38:40 +01:00
2022-05-23 11:14:27 -04:00
dashboardService := dashboards . NewFakeDashboardService ( t )
2023-01-25 10:36:26 +01:00
dashboardService . On ( "GetDashboard" , mock . Anything , mock . AnythingOfType ( "*dashboards.GetDashboardQuery" )). Return ( fakeDash , nil )
2022-05-23 11:14:27 -04:00
dashboardService . On ( "SaveDashboard" , mock . Anything , mock . AnythingOfType ( "*dashboards.SaveDashboardDTO" ), mock . AnythingOfType ( "bool" )). Run ( func ( args mock . Arguments ) {
cmd := args . Get ( 1 ).( * dashboards . SaveDashboardDTO )
2023-01-16 16:33:55 +01:00
cmd . Dashboard = & dashboards . Dashboard {
ID : 2 , UID : "uid" , Title : "Dash" , Slug : "dash" , Version : 1 ,
2022-05-23 11:14:27 -04:00
}
}). Return ( nil , nil )
2019-03-06 14:38:40 +01:00
cmd := dtos . RestoreDashboardVersionCommand {
Version : 1 ,
}
2022-05-25 10:41:51 +02:00
fakeDashboardVersionService := dashvertest . NewDashboardVersionServiceFake ()
2022-12-27 17:17:24 +01:00
fakeDashboardVersionService . ExpectedDashboardVersions = [] * dashver . DashboardVersionDTO {
2022-02-10 16:58:52 +08:00
{
2022-05-25 10:41:51 +02:00
DashboardID : 2 ,
2022-02-10 16:58:52 +08:00
Version : 1 ,
Data : fakeDash . Data ,
}}
2023-01-18 16:01:25 +01:00
mockSQLStore := dbtest . NewFakeDB ()
2020-11-13 09:52:38 +01:00
restoreDashboardVersionScenario ( t , "When calling POST on" , "/api/dashboards/id/1/restore" ,
2022-05-25 10:41:51 +02:00
"/api/dashboards/id/:dashboardId/restore" , dashboardService , fakeDashboardVersionService , cmd , func ( sc * scenarioContext ) {
sc . dashboardVersionService = fakeDashboardVersionService
2020-11-13 09:52:38 +01:00
callRestoreDashboardVersion ( sc )
assert . Equal ( t , 200 , sc . resp . Code )
2022-02-07 12:43:43 +01:00
}, mockSQLStore )
2019-03-06 14:38:40 +01:00
})
2020-11-13 09:52:38 +01:00
t . Run ( "Given dashboard in general folder being restored should restore to general folder" , func ( t * testing . T ) {
2023-01-16 16:33:55 +01:00
fakeDash := dashboards . NewDashboard ( "Child dash" )
fakeDash . ID = 2
2022-07-18 15:14:58 +02:00
fakeDash . HasACL = false
2019-03-06 14:38:40 +01:00
2022-05-23 11:14:27 -04:00
dashboardService := dashboards . NewFakeDashboardService ( t )
2023-01-25 10:36:26 +01:00
dashboardService . On ( "GetDashboard" , mock . Anything , mock . AnythingOfType ( "*dashboards.GetDashboardQuery" )). Return ( fakeDash , nil )
2022-05-23 11:14:27 -04:00
dashboardService . On ( "SaveDashboard" , mock . Anything , mock . AnythingOfType ( "*dashboards.SaveDashboardDTO" ), mock . AnythingOfType ( "bool" )). Run ( func ( args mock . Arguments ) {
cmd := args . Get ( 1 ).( * dashboards . SaveDashboardDTO )
2023-01-16 16:33:55 +01:00
cmd . Dashboard = & dashboards . Dashboard {
ID : 2 , UID : "uid" , Title : "Dash" , Slug : "dash" , Version : 1 ,
2022-05-23 11:14:27 -04:00
}
}). Return ( nil , nil )
2019-03-06 14:38:40 +01:00
2022-05-25 10:41:51 +02:00
fakeDashboardVersionService := dashvertest . NewDashboardVersionServiceFake ()
2022-12-27 17:17:24 +01:00
fakeDashboardVersionService . ExpectedDashboardVersions = [] * dashver . DashboardVersionDTO {
2022-05-25 10:41:51 +02:00
{
DashboardID : 2 ,
Version : 1 ,
Data : fakeDash . Data ,
}}
2019-03-06 14:38:40 +01:00
cmd := dtos . RestoreDashboardVersionCommand {
Version : 1 ,
}
2023-01-18 16:01:25 +01:00
mockSQLStore := dbtest . NewFakeDB ()
2020-11-13 09:52:38 +01:00
restoreDashboardVersionScenario ( t , "When calling POST on" , "/api/dashboards/id/1/restore" ,
2022-05-25 10:41:51 +02:00
"/api/dashboards/id/:dashboardId/restore" , dashboardService , fakeDashboardVersionService , cmd , func ( sc * scenarioContext ) {
2020-11-13 09:52:38 +01:00
callRestoreDashboardVersion ( sc )
assert . Equal ( t , 200 , sc . resp . Code )
2022-02-07 12:43:43 +01:00
}, mockSQLStore )
2019-03-06 14:38:40 +01:00
})
2019-04-10 13:29:10 +02:00
2020-11-13 09:52:38 +01:00
t . Run ( "Given provisioned dashboard" , func ( t * testing . T ) {
2023-01-18 16:01:25 +01:00
mockSQLStore := dbtest . NewFakeDB ()
2022-06-01 14:16:26 -04:00
dashboardStore := dashboards . NewFakeDashboardStore ( t )
2023-01-18 13:52:41 +01:00
dashboardStore . On ( "GetProvisionedDataByDashboardID" , mock . Anything , mock . AnythingOfType ( "int64" )). Return ( & dashboards . DashboardProvisioning { ExternalID : "/dashboard1.json" }, nil ). Once ()
2022-06-01 14:16:26 -04:00
2022-09-20 18:58:04 +02:00
teamService := & teamtest . FakeService {}
2022-06-01 14:16:26 -04:00
dashboardService := dashboards . NewFakeDashboardService ( t )
2022-02-16 14:15:44 +01:00
2022-02-07 12:43:43 +01:00
dataValue , err := simplejson . NewJson ([] byte ( `{"id": 1, "editable": true, "style": "dark"}` ))
require . NoError ( t , err )
2023-01-25 10:36:26 +01:00
qResult := & dashboards . Dashboard { ID : 1 , Data : dataValue }
dashboardService . On ( "GetDashboard" , mock . Anything , mock . AnythingOfType ( "*dashboards.GetDashboardQuery" )). Return ( qResult , nil )
2023-01-26 08:46:30 -05:00
qResult2 := [] * dashboards . DashboardACLInfoDTO {{ OrgID : testOrgID , DashboardID : 1 , UserID : testUserID , Permission : dashboards . PERMISSION_EDIT }}
2023-01-25 10:36:26 +01:00
dashboardService . On ( "GetDashboardACLInfoList" , mock . Anything , mock . AnythingOfType ( "*dashboards.GetDashboardACLInfoListQuery" )). Return ( qResult2 , nil )
2023-03-16 09:54:01 +00:00
guardian . InitLegacyGuardian ( setting . NewCfg (), mockSQLStore , dashboardService , teamService )
2019-04-30 13:32:18 +02:00
2022-08-10 11:56:48 +02:00
loggedInUserScenarioWithRole ( t , "When calling GET on" , "GET" , "/api/dashboards/uid/dash" , "/api/dashboards/uid/:uid" , org . RoleEditor , func ( sc * scenarioContext ) {
2022-02-16 14:15:44 +01:00
fakeProvisioningService := provisioning . NewProvisioningServiceMock ( context . Background ())
fakeProvisioningService . GetDashboardProvisionerResolvedPathFunc = func ( name string ) string {
2019-04-30 13:32:18 +02:00
return "/tmp/grafana/dashboards"
}
2023-01-19 18:38:07 +02:00
dash := getDashboardShouldReturn200WithConfig ( t , sc , fakeProvisioningService , dashboardStore , dashboardService , nil )
2022-02-16 14:15:44 +01:00
assert . Equal ( t , "../../../dashboard1.json" , dash . Meta . ProvisionedExternalId , mockSQLStore )
2022-02-07 12:43:43 +01:00
}, mockSQLStore )
2019-10-31 14:27:31 +01:00
2022-08-10 11:56:48 +02:00
loggedInUserScenarioWithRole ( t , "When allowUiUpdates is true and calling GET on" , "GET" , "/api/dashboards/uid/dash" , "/api/dashboards/uid/:uid" , org . RoleEditor , func ( sc * scenarioContext ) {
2022-02-16 14:15:44 +01:00
fakeProvisioningService := provisioning . NewProvisioningServiceMock ( context . Background ())
fakeProvisioningService . GetDashboardProvisionerResolvedPathFunc = func ( name string ) string {
2019-10-31 14:27:31 +01:00
return "/tmp/grafana/dashboards"
}
2022-02-16 14:15:44 +01:00
fakeProvisioningService . GetAllowUIUpdatesFromConfigFunc = func ( name string ) bool {
2019-10-31 14:27:31 +01:00
return true
}
hs := & HTTPServer {
2022-02-16 14:15:44 +01:00
Cfg : setting . NewCfg (),
ProvisioningService : fakeProvisioningService ,
LibraryPanelService : & mockLibraryPanelService {},
LibraryElementService : & mockLibraryElementService {},
dashboardProvisioningService : mockDashboardProvisioningService {},
SQLStore : mockSQLStore ,
2022-04-04 11:57:43 -03:00
AccessControl : accesscontrolmock . New (),
2022-07-06 12:42:39 -06:00
DashboardService : dashboardService ,
2022-07-19 17:44:41 -06:00
Features : featuremgmt . WithFeatures (),
2022-11-10 15:36:40 -05:00
Kinds : corekind . NewBase ( nil ),
2019-10-31 14:27:31 +01:00
}
2022-02-07 12:43:43 +01:00
hs . callGetDashboard ( sc )
2019-10-31 14:27:31 +01:00
2020-11-13 09:52:38 +01:00
assert . Equal ( t , 200 , sc . resp . Code )
2019-10-31 14:27:31 +01:00
dash := dtos . DashboardFullWithMeta {}
err := json . NewDecoder ( sc . resp . Body ). Decode ( & dash )
2020-11-13 09:52:38 +01:00
require . NoError ( t , err )
2019-10-31 14:27:31 +01:00
2020-11-13 09:52:38 +01:00
assert . Equal ( t , false , dash . Meta . Provisioned )
2022-02-07 12:43:43 +01:00
}, mockSQLStore )
2019-04-10 13:29:10 +02:00
})
2017-06-12 15:48:55 +02:00
}
2017-06-12 23:05:32 +02:00
2023-03-30 17:31:53 +03:00
func TestDashboardVersionsAPIEndpoint ( t * testing . T ) {
fakeDash := dashboards . NewDashboard ( "Child dash" )
fakeDash . ID = 1
fakeDash . FolderID = 1
fakeDash . HasACL = false
fakeDashboardVersionService := dashvertest . NewDashboardVersionServiceFake ()
dashboardService := dashboards . NewFakeDashboardService ( t )
dashboardService . On ( "GetDashboard" , mock . Anything , mock . AnythingOfType ( "*dashboards.GetDashboardQuery" )). Return ( fakeDash , nil )
teamService := & teamtest . FakeService {}
mockSQLStore := dbtest . NewFakeDB ()
cfg := setting . NewCfg ()
getHS := func ( userSvc * usertest . FakeUserService ) * HTTPServer {
return & HTTPServer {
Cfg : cfg ,
2023-07-17 12:21:44 +02:00
pluginStore : & fakes . FakePluginStore {},
2023-03-30 17:31:53 +03:00
SQLStore : mockSQLStore ,
AccessControl : accesscontrolmock . New (),
Features : featuremgmt . WithFeatures (),
DashboardService : dashboardService ,
dashboardVersionService : fakeDashboardVersionService ,
Kinds : corekind . NewBase ( nil ),
QuotaService : quotatest . New ( false , nil ),
userService : userSvc ,
CacheService : localcache . New ( 5 * time . Minute , 10 * time . Minute ),
log : log . New (),
}
}
setUp := func () {
viewerRole := org . RoleViewer
editorRole := org . RoleEditor
qResult := [] * dashboards . DashboardACLInfoDTO {
{ Role : & viewerRole , Permission : dashboards . PERMISSION_VIEW },
{ Role : & editorRole , Permission : dashboards . PERMISSION_EDIT },
}
dashboardService . On ( "GetDashboardACLInfoList" , mock . Anything , mock . AnythingOfType ( "*dashboards.GetDashboardACLInfoListQuery" )). Return ( qResult , nil )
guardian . InitLegacyGuardian ( cfg , mockSQLStore , dashboardService , teamService )
}
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 ) {
setUp ()
fakeDashboardVersionService . ExpectedListDashboarVersions = [] * dashver . DashboardVersionDTO {
{
Version : 1 ,
CreatedBy : 1 ,
},
{
Version : 2 ,
CreatedBy : 1 ,
},
}
getHS ( & usertest . FakeUserService {
ExpectedUser : & user . User { ID : 1 , Login : "test-user" },
}). callGetDashboardVersions ( sc )
assert . Equal ( t , 200 , sc . resp . Code )
var versions [] dashver . DashboardVersionMeta
err := json . NewDecoder ( sc . resp . Body ). Decode ( & versions )
require . NoError ( t , err )
for _ , v := range 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 ) {
setUp ()
fakeDashboardVersionService . ExpectedListDashboarVersions = [] * dashver . DashboardVersionDTO {
{
Version : 1 ,
CreatedBy : 1 ,
},
{
Version : 2 ,
CreatedBy : 1 ,
},
}
getHS ( & usertest . FakeUserService {
ExpectedError : user . ErrUserNotFound ,
}). callGetDashboardVersions ( sc )
assert . Equal ( t , 200 , sc . resp . Code )
var versions [] dashver . DashboardVersionMeta
err := json . NewDecoder ( sc . resp . Body ). Decode ( & versions )
require . NoError ( t , err )
for _ , v := range 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 ) {
setUp ()
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 , 200 , sc . resp . Code )
var versions [] dashver . DashboardVersionMeta
err := json . NewDecoder ( sc . resp . Body ). Decode ( & versions )
require . NoError ( t , err )
for _ , v := range versions {
assert . Equal ( t , anonString , v . CreatedBy )
}
}, mockSQLStore )
}
2023-02-01 15:43:21 +02:00
func getDashboardShouldReturn200WithConfig ( t * testing . T , sc * scenarioContext , provisioningService provisioning . ProvisioningService , dashboardStore dashboards . Store , dashboardService dashboards . DashboardService , folderStore folder . FolderStore ) dtos . DashboardFullWithMeta {
2022-02-16 14:15:44 +01:00
t . Helper ()
2019-04-30 13:32:18 +02:00
if provisioningService == nil {
2021-11-03 11:31:56 +01:00
provisioningService = provisioning . NewProvisioningServiceMock ( context . Background ())
2019-04-30 13:32:18 +02:00
}
2022-11-14 21:08:10 +02:00
var err error
2022-02-16 14:15:44 +01:00
if dashboardStore == nil {
2022-10-19 09:02:15 -04:00
sql := db . InitTestDB ( t )
2022-11-14 21:08:10 +02:00
quotaService := quotatest . New ( false , nil )
dashboardStore , err = database . ProvideDashboardStore ( sql , sql . Cfg , featuremgmt . WithFeatures (), tagimpl . ProvideService ( sql , sql . Cfg ), quotaService )
require . NoError ( t , err )
2022-02-16 14:15:44 +01:00
}
2021-05-12 08:48:17 +02:00
libraryPanelsService := mockLibraryPanelService {}
libraryElementsService := mockLibraryElementService {}
2022-03-10 12:58:18 +01:00
cfg := setting . NewCfg ()
2022-06-07 11:02:20 +02:00
ac := accesscontrolmock . New ()
folderPermissions := accesscontrolmock . NewMockedPermissionsService ()
dashboardPermissions := accesscontrolmock . NewMockedPermissionsService ()
2022-03-10 12:58:18 +01:00
features := featuremgmt . WithFeatures ()
2021-05-12 08:48:17 +02:00
2023-03-02 08:09:57 -05:00
folderSvc := folderimpl . ProvideService ( ac , bus . ProvideBus ( tracing . InitializeTracerForTest ()),
cfg , dashboardStore , folderStore , db . InitTestDB ( t ), featuremgmt . WithFeatures ())
2023-01-26 10:21:10 +02:00
2022-05-23 11:14:27 -04:00
if dashboardService == nil {
2023-04-14 11:17:23 +02:00
dashboardService , err = service . ProvideDashboardServiceImpl (
2023-03-03 15:56:33 +00:00
cfg , dashboardStore , folderStore , nil , features , folderPermissions , dashboardPermissions ,
2023-03-02 08:09:57 -05:00
ac , folderSvc ,
2022-06-07 11:02:20 +02:00
)
2023-04-14 11:17:23 +02:00
require . NoError ( t , err )
2022-05-23 11:14:27 -04:00
}
2023-04-14 11:17:23 +02:00
dashboardProvisioningService , err := service . ProvideDashboardServiceImpl (
cfg , dashboardStore , folderStore , nil , features , folderPermissions , dashboardPermissions ,
ac , folderSvc ,
)
require . NoError ( t , err )
2019-04-30 13:32:18 +02:00
hs := & HTTPServer {
2023-04-14 11:17:23 +02:00
Cfg : cfg ,
LibraryPanelService : & libraryPanelsService ,
LibraryElementService : & libraryElementsService ,
SQLStore : sc . sqlStore ,
ProvisioningService : provisioningService ,
AccessControl : accesscontrolmock . New (),
dashboardProvisioningService : dashboardProvisioningService ,
DashboardService : dashboardService ,
Features : featuremgmt . WithFeatures (),
Kinds : corekind . NewBase ( nil ),
2019-04-30 13:32:18 +02:00
}
2021-05-12 08:48:17 +02:00
2022-02-07 12:43:43 +01:00
hs . callGetDashboard ( sc )
2017-06-12 23:05:32 +02:00
2020-11-13 09:52:38 +01:00
require . Equal ( sc . t , 200 , sc . resp . Code )
2017-06-12 23:05:32 +02:00
dash := dtos . DashboardFullWithMeta {}
2022-11-14 21:08:10 +02:00
err = json . NewDecoder ( sc . resp . Body ). Decode ( & dash )
2020-11-13 09:52:38 +01:00
require . NoError ( sc . t , err )
2017-06-12 23:05:32 +02:00
return dash
}
2022-02-07 12:43:43 +01:00
func ( hs * HTTPServer ) callGetDashboard ( sc * scenarioContext ) {
2019-04-30 13:32:18 +02:00
sc . handlerFunc = hs . GetDashboard
2018-01-29 13:51:01 +01:00
sc . fakeReqWithParams ( "GET" , sc . url , map [ string ] string {}). exec ()
}
2022-02-07 12:43:43 +01:00
func ( hs * HTTPServer ) callGetDashboardVersion ( sc * scenarioContext ) {
sc . handlerFunc = hs . GetDashboardVersion
2017-06-14 00:28:34 +02:00
sc . fakeReqWithParams ( "GET" , sc . url , map [ string ] string {}). exec ()
}
2022-02-07 12:43:43 +01:00
func ( hs * HTTPServer ) callGetDashboardVersions ( sc * scenarioContext ) {
sc . handlerFunc = hs . GetDashboardVersions
2017-06-14 00:28:34 +02:00
sc . fakeReqWithParams ( "GET" , sc . url , map [ string ] string {}). exec ()
}
2022-02-16 14:15:44 +01:00
func ( hs * HTTPServer ) callDeleteDashboardByUID ( t * testing . T ,
2023-03-08 14:54:35 -06:00
sc * scenarioContext , mockDashboard * dashboards . FakeDashboardService , mockPubdashService * publicdashboards . FakePublicDashboardService ) {
2022-07-06 12:42:39 -06:00
hs . DashboardService = mockDashboard
2023-03-08 14:54:35 -06:00
pubdashApi := api . ProvideApi ( mockPubdashService , nil , nil , featuremgmt . WithFeatures ())
hs . PublicDashboardsApi = pubdashApi
2021-01-20 09:28:10 +01:00
sc . handlerFunc = hs . DeleteDashboardByUID
2018-01-31 16:46:31 +01:00
sc . fakeReqWithParams ( "DELETE" , sc . url , map [ string ] string {}). exec ()
}
2020-11-13 09:52:38 +01:00
func callPostDashboard ( sc * scenarioContext ) {
2017-06-12 23:05:32 +02:00
sc . fakeReqWithParams ( "POST" , sc . url , map [ string ] string {}). exec ()
}
2020-11-13 09:52:38 +01:00
func callRestoreDashboardVersion ( sc * scenarioContext ) {
2019-03-06 14:38:40 +01:00
sc . fakeReqWithParams ( "POST" , sc . url , map [ string ] string {}). exec ()
}
2020-11-13 09:52:38 +01:00
func callPostDashboardShouldReturnSuccess ( sc * scenarioContext ) {
callPostDashboard ( sc )
2018-01-30 23:37:54 +01:00
2020-11-13 09:52:38 +01:00
assert . Equal ( sc . t , 200 , sc . resp . Code )
2018-01-30 23:37:54 +01:00
}
2023-01-18 13:52:41 +01:00
func postDashboardScenario ( t * testing . T , desc string , url string , routePattern string , cmd dashboards . SaveDashboardCommand , dashboardService dashboards . DashboardService , folderService folder . Service , fn scenarioFunc ) {
2020-11-13 09:52:38 +01:00
t . Run ( fmt . Sprintf ( "%s %s" , desc , url ), func ( t * testing . T ) {
2020-12-15 19:09:04 +01:00
cfg := setting . NewCfg ()
2019-02-11 21:12:01 +01:00
hs := HTTPServer {
2022-11-14 21:08:10 +02:00
Cfg : cfg ,
ProvisioningService : provisioning . NewProvisioningServiceMock ( context . Background ()),
Live : newTestLive ( t , db . InitTestDB ( t )),
QuotaService : quotatest . New ( false , nil ),
2023-07-17 12:21:44 +02:00
pluginStore : & fakes . FakePluginStore {},
2021-05-12 08:48:17 +02:00
LibraryPanelService : & mockLibraryPanelService {},
LibraryElementService : & mockLibraryElementService {},
2022-07-06 12:42:39 -06:00
DashboardService : dashboardService ,
2022-02-16 14:15:44 +01:00
folderService : folderService ,
2022-03-03 15:05:47 +01:00
Features : featuremgmt . WithFeatures (),
2022-11-10 15:36:40 -05:00
Kinds : corekind . NewBase ( nil ),
2022-11-24 14:38:55 +00:00
accesscontrolService : actest . FakeService {},
2019-02-11 21:12:01 +01:00
}
2020-11-13 09:52:38 +01:00
sc := setupScenarioContext ( t , url )
2023-01-27 08:50:36 +01:00
sc . defaultHandler = routing . Wrap ( func ( c * contextmodel . ReqContext ) response . Response {
2021-11-29 10:18:01 +01:00
c . Req . Body = mockRequestBody ( cmd )
2022-02-09 13:44:38 +01:00
c . Req . Header . Add ( "Content-Type" , "application/json" )
2017-06-12 23:05:32 +02:00
sc . context = c
2023-01-18 13:52:41 +01:00
sc . context . SignedInUser = & user . SignedInUser { OrgID : cmd . OrgID , UserID : cmd . UserID }
2017-06-12 23:05:32 +02:00
2021-11-29 10:18:01 +01:00
return hs . PostDashboard ( c )
2017-06-12 23:05:32 +02:00
})
sc . m . Post ( routePattern , sc . defaultHandler )
fn ( sc )
})
}
2018-01-29 19:27:53 +01:00
2023-01-18 13:52:41 +01:00
func postValidateScenario ( t * testing . T , desc string , url string , routePattern string , cmd dashboards . ValidateDashboardCommand ,
2022-12-13 11:03:36 +01:00
role org . RoleType , fn scenarioFunc , sqlmock db . DB ) {
2022-10-14 14:51:05 +01:00
t . Run ( fmt . Sprintf ( "%s %s" , desc , url ), func ( t * testing . T ) {
cfg := setting . NewCfg ()
hs := HTTPServer {
Cfg : cfg ,
ProvisioningService : provisioning . NewProvisioningServiceMock ( context . Background ()),
2022-10-19 09:02:15 -04:00
Live : newTestLive ( t , db . InitTestDB ( t )),
2022-11-14 21:08:10 +02:00
QuotaService : quotatest . New ( false , nil ),
2022-10-14 14:51:05 +01:00
LibraryPanelService : & mockLibraryPanelService {},
LibraryElementService : & mockLibraryElementService {},
SQLStore : sqlmock ,
Features : featuremgmt . WithFeatures (),
2022-11-10 15:36:40 -05:00
Kinds : corekind . NewBase ( nil ),
2022-10-14 14:51:05 +01:00
}
sc := setupScenarioContext ( t , url )
2023-01-27 08:50:36 +01:00
sc . defaultHandler = routing . Wrap ( func ( c * contextmodel . ReqContext ) response . Response {
2022-10-14 14:51:05 +01:00
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 = role
return hs . ValidateDashboard ( c )
})
sc . m . Post ( routePattern , sc . defaultHandler )
fn ( sc )
})
}
2022-05-25 10:41:51 +02:00
func postDiffScenario ( t * testing . T , desc string , url string , routePattern string , cmd dtos . CalculateDiffOptions ,
2022-12-13 11:03:36 +01:00
role org . RoleType , fn scenarioFunc , sqlmock db . DB , fakeDashboardVersionService * dashvertest . FakeDashboardVersionService ) {
2020-11-13 09:52:38 +01:00
t . Run ( fmt . Sprintf ( "%s %s" , desc , url ), func ( t * testing . T ) {
2022-02-10 16:58:52 +08:00
cfg := setting . NewCfg ()
2022-12-15 16:34:17 +02:00
dashSvc := dashboards . NewFakeDashboardService ( t )
2022-02-10 16:58:52 +08:00
hs := HTTPServer {
2022-05-25 10:41:51 +02:00
Cfg : cfg ,
ProvisioningService : provisioning . NewProvisioningServiceMock ( context . Background ()),
2022-10-19 09:02:15 -04:00
Live : newTestLive ( t , db . InitTestDB ( t )),
2022-11-14 21:08:10 +02:00
QuotaService : quotatest . New ( false , nil ),
2022-05-25 10:41:51 +02:00
LibraryPanelService : & mockLibraryPanelService {},
LibraryElementService : & mockLibraryElementService {},
SQLStore : sqlmock ,
dashboardVersionService : fakeDashboardVersionService ,
2022-07-19 17:44:41 -06:00
Features : featuremgmt . WithFeatures (),
2022-11-10 15:36:40 -05:00
Kinds : corekind . NewBase ( nil ),
2022-12-15 16:34:17 +02:00
DashboardService : dashSvc ,
2022-02-10 16:58:52 +08:00
}
2020-11-13 09:52:38 +01:00
sc := setupScenarioContext ( t , url )
2023-01-27 08:50:36 +01:00
sc . defaultHandler = routing . Wrap ( func ( c * contextmodel . ReqContext ) response . Response {
2021-11-29 10:18:01 +01:00
c . Req . Body = mockRequestBody ( cmd )
2022-02-09 13:44:38 +01:00
c . Req . Header . Add ( "Content-Type" , "application/json" )
2018-02-27 17:53:30 +01:00
sc . context = c
2022-08-10 11:56:48 +02:00
sc . context . SignedInUser = & user . SignedInUser {
2022-08-11 13:28:55 +02:00
OrgID : testOrgID ,
UserID : testUserID ,
2018-02-27 17:53:30 +01:00
}
sc . context . OrgRole = role
2022-02-10 16:58:52 +08:00
return hs . CalculateDashboardDiff ( c )
2018-02-27 17:53:30 +01:00
})
sc . m . Post ( routePattern , sc . defaultHandler )
fn ( sc )
})
}
2022-05-25 10:41:51 +02:00
func restoreDashboardVersionScenario ( t * testing . T , desc string , url string , routePattern string ,
mock * dashboards . FakeDashboardService , fakeDashboardVersionService * dashvertest . FakeDashboardVersionService ,
2022-12-13 11:03:36 +01:00
cmd dtos . RestoreDashboardVersionCommand , fn scenarioFunc , sqlStore db . DB ) {
2020-11-13 09:52:38 +01:00
t . Run ( fmt . Sprintf ( "%s %s" , desc , url ), func ( t * testing . T ) {
2020-12-15 19:09:04 +01:00
cfg := setting . NewCfg ()
2019-03-06 14:38:40 +01:00
hs := HTTPServer {
2022-05-25 10:41:51 +02:00
Cfg : cfg ,
ProvisioningService : provisioning . NewProvisioningServiceMock ( context . Background ()),
2022-10-19 09:02:15 -04:00
Live : newTestLive ( t , db . InitTestDB ( t )),
2022-11-14 21:08:10 +02:00
QuotaService : quotatest . New ( false , nil ),
2022-05-25 10:41:51 +02:00
LibraryPanelService : & mockLibraryPanelService {},
LibraryElementService : & mockLibraryElementService {},
2022-07-06 12:42:39 -06:00
DashboardService : mock ,
2022-05-25 10:41:51 +02:00
SQLStore : sqlStore ,
Features : featuremgmt . WithFeatures (),
dashboardVersionService : fakeDashboardVersionService ,
2022-11-10 15:36:40 -05:00
Kinds : corekind . NewBase ( nil ),
2022-11-24 14:38:55 +00:00
accesscontrolService : actest . FakeService {},
2019-03-06 14:38:40 +01:00
}
2020-11-13 09:52:38 +01:00
sc := setupScenarioContext ( t , url )
2022-05-17 12:57:27 -04:00
sc . sqlStore = sqlStore
2022-05-25 10:41:51 +02:00
sc . dashboardVersionService = fakeDashboardVersionService
2023-01-27 08:50:36 +01:00
sc . defaultHandler = routing . Wrap ( func ( c * contextmodel . ReqContext ) response . Response {
2021-11-29 10:18:01 +01:00
c . Req . Body = mockRequestBody ( cmd )
2022-02-09 13:44:38 +01:00
c . Req . Header . Add ( "Content-Type" , "application/json" )
2019-03-06 14:38:40 +01:00
sc . context = c
2022-08-10 11:56:48 +02:00
sc . context . SignedInUser = & user . SignedInUser {
2022-08-11 13:28:55 +02:00
OrgID : testOrgID ,
UserID : testUserID ,
2019-03-06 14:38:40 +01:00
}
2022-08-10 11:56:48 +02:00
sc . context . OrgRole = org . RoleAdmin
2019-03-06 14:38:40 +01:00
2021-11-29 10:18:01 +01:00
return hs . RestoreDashboardVersion ( c )
2019-03-06 14:38:40 +01:00
})
sc . m . Post ( routePattern , sc . defaultHandler )
fn ( sc )
})
}
2018-03-22 22:13:46 +01:00
func ( sc * scenarioContext ) ToJSON () * simplejson . Json {
2022-04-12 09:30:34 +02:00
result := simplejson . New ()
err := json . NewDecoder ( sc . resp . Body ). Decode ( result )
2020-11-13 09:52:38 +01:00
require . NoError ( sc . t , err )
2018-01-29 19:27:53 +01:00
return result
}
2019-10-31 14:27:31 +01:00
type mockDashboardProvisioningService struct {
2021-03-12 11:51:02 +01:00
dashboards . DashboardProvisioningService
2019-10-31 14:27:31 +01:00
}
2022-09-21 14:04:01 +02:00
func ( s mockDashboardProvisioningService ) GetProvisionedDashboardDataByDashboardID ( ctx context . Context , dashboardID int64 ) (
2023-01-18 13:52:41 +01:00
* dashboards . DashboardProvisioning , error ) {
2021-03-17 16:06:10 +01:00
return nil , nil
2019-10-31 14:27:31 +01:00
}
2021-05-12 08:48:17 +02:00
type mockLibraryPanelService struct {
}
2023-01-16 16:33:55 +01:00
func ( m * mockLibraryPanelService ) ConnectLibraryPanelsForDashboard ( c context . Context , signedInUser * user . SignedInUser , dash * dashboards . Dashboard ) error {
2021-05-12 08:48:17 +02:00
return nil
}
2022-08-10 11:56:48 +02:00
func ( m * mockLibraryPanelService ) ImportLibraryPanelsForDashboard ( c context . Context , signedInUser * user . SignedInUser , libraryPanels * simplejson . Json , panels [] interface {}, folderID int64 ) error {
2021-09-20 10:58:24 +02:00
return nil
}
2021-05-12 08:48:17 +02:00
type mockLibraryElementService struct {
}
2023-02-01 17:32:05 +01:00
func ( l * mockLibraryElementService ) CreateElement ( c context . Context , signedInUser * user . SignedInUser , cmd model . CreateLibraryElementCommand ) ( model . LibraryElementDTO , error ) {
return model . LibraryElementDTO {}, nil
2021-09-20 10:58:24 +02:00
}
// GetElement gets an element from a UID.
2023-02-01 17:32:05 +01:00
func ( l * mockLibraryElementService ) GetElement ( c context . Context , signedInUser * user . SignedInUser , UID string ) ( model . LibraryElementDTO , error ) {
return model . LibraryElementDTO {}, nil
2021-05-12 08:48:17 +02:00
}
// GetElementsForDashboard gets all connected elements for a specific dashboard.
2023-02-01 17:32:05 +01:00
func ( l * mockLibraryElementService ) GetElementsForDashboard ( c context . Context , dashboardID int64 ) ( map [ string ] model . LibraryElementDTO , error ) {
return map [ string ] model . LibraryElementDTO {}, nil
2021-05-12 08:48:17 +02:00
}
// ConnectElementsToDashboard connects elements to a specific dashboard.
2022-08-10 11:56:48 +02:00
func ( l * mockLibraryElementService ) ConnectElementsToDashboard ( c context . Context , signedInUser * user . SignedInUser , elementUIDs [] string , dashboardID int64 ) error {
2021-05-12 08:48:17 +02:00
return nil
}
// DisconnectElementsFromDashboard disconnects elements from a specific dashboard.
2021-09-27 09:04:36 +02:00
func ( l * mockLibraryElementService ) DisconnectElementsFromDashboard ( c context . Context , dashboardID int64 ) error {
2021-05-12 08:48:17 +02:00
return nil
}
// DeleteLibraryElementsInFolder deletes all elements for a specific folder.
2022-08-10 11:56:48 +02:00
func ( l * mockLibraryElementService ) DeleteLibraryElementsInFolder ( c context . Context , signedInUser * user . SignedInUser , folderUID string ) error {
2021-05-12 08:48:17 +02:00
return nil
}