mirror of
https://github.com/grafana/grafana.git
synced 2024-11-29 20:24:18 -06:00
bb798e24f3
* chore(services): replace dependencies on dashboard store with dashboard service This continues the backend service/store split by replacing dashboard store dependencies with service dependencies. the folder service remains the single exception for now; otherwise we'd have a dependency cycle between the folder and dashboard services. I have some ideas for that, but I'll take care of all the easy parts first. While doing this, I identified and removed a number of unused arguments from the following functions: NewFolderNameScopeResolver NewFolderIDScopeResolver NewFolderUIDScopeResolver NewDashboardIDScopeResolver NewDashboardUIDScopeResolver resolveDashboardScope I have a small enterprise PR to support this commit. * lingering fmt
373 lines
13 KiB
Go
373 lines
13 KiB
Go
package api
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
"testing"
|
|
|
|
"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/bus"
|
|
"github.com/grafana/grafana/pkg/infra/db/dbtest"
|
|
"github.com/grafana/grafana/pkg/infra/tracing"
|
|
accesscontrolmock "github.com/grafana/grafana/pkg/services/accesscontrol/mock"
|
|
contextmodel "github.com/grafana/grafana/pkg/services/contexthandler/model"
|
|
"github.com/grafana/grafana/pkg/services/dashboards"
|
|
dashboardservice "github.com/grafana/grafana/pkg/services/dashboards/service"
|
|
"github.com/grafana/grafana/pkg/services/featuremgmt"
|
|
"github.com/grafana/grafana/pkg/services/folder/folderimpl"
|
|
"github.com/grafana/grafana/pkg/services/folder/foldertest"
|
|
"github.com/grafana/grafana/pkg/services/guardian"
|
|
"github.com/grafana/grafana/pkg/services/org"
|
|
"github.com/grafana/grafana/pkg/setting"
|
|
)
|
|
|
|
func TestDashboardPermissionAPIEndpoint(t *testing.T) {
|
|
t.Run("Dashboard permissions test", func(t *testing.T) {
|
|
settings := setting.NewCfg()
|
|
dashboardStore := &dashboards.FakeDashboardStore{}
|
|
qResult := &dashboards.Dashboard{}
|
|
dashboardStore.On("GetDashboard", mock.Anything, mock.AnythingOfType("*dashboards.GetDashboardQuery")).Return(qResult, nil)
|
|
defer dashboardStore.AssertExpectations(t)
|
|
|
|
features := featuremgmt.WithFeatures()
|
|
mockSQLStore := dbtest.NewFakeDB()
|
|
ac := accesscontrolmock.New()
|
|
folderPermissions := accesscontrolmock.NewMockedPermissionsService()
|
|
dashboardPermissions := accesscontrolmock.NewMockedPermissionsService()
|
|
|
|
folderSvc := folderimpl.ProvideService(ac, bus.ProvideBus(tracing.InitializeTracerForTest()), settings, dashboardStore, foldertest.NewFakeFolderStore(t), mockSQLStore, featuremgmt.WithFeatures())
|
|
hs := &HTTPServer{
|
|
Cfg: settings,
|
|
SQLStore: mockSQLStore,
|
|
Features: features,
|
|
DashboardService: dashboardservice.ProvideDashboardService(
|
|
settings, dashboardStore, nil, features, folderPermissions, dashboardPermissions, ac,
|
|
folderSvc,
|
|
),
|
|
AccessControl: accesscontrolmock.New().WithDisabled(),
|
|
}
|
|
|
|
t.Run("Given user has no admin permissions", func(t *testing.T) {
|
|
origNewGuardian := guardian.New
|
|
t.Cleanup(func() {
|
|
guardian.New = origNewGuardian
|
|
})
|
|
|
|
guardian.MockDashboardGuardian(&guardian.FakeDashboardGuardian{CanAdminValue: false})
|
|
loggedInUserScenarioWithRole(t, "When calling GET on", "GET", "/api/dashboards/id/1/permissions",
|
|
"/api/dashboards/id/:dashboardId/permissions", org.RoleEditor, func(sc *scenarioContext) {
|
|
callGetDashboardPermissions(sc, hs)
|
|
assert.Equal(t, 403, sc.resp.Code)
|
|
}, mockSQLStore)
|
|
|
|
cmd := dtos.UpdateDashboardACLCommand{
|
|
Items: []dtos.DashboardACLUpdateItem{
|
|
{UserID: 1000, Permission: dashboards.PERMISSION_ADMIN},
|
|
},
|
|
}
|
|
|
|
dashboardStore.On("UpdateDashboardACL", mock.Anything, mock.Anything, mock.Anything).Return(nil).Once()
|
|
updateDashboardPermissionScenario(t, updatePermissionContext{
|
|
desc: "When calling POST on",
|
|
url: "/api/dashboards/id/1/permissions",
|
|
routePattern: "/api/dashboards/id/:dashboardId/permissions",
|
|
cmd: cmd,
|
|
fn: func(sc *scenarioContext) {
|
|
callUpdateDashboardPermissions(t, sc)
|
|
assert.Equal(t, 403, sc.resp.Code)
|
|
},
|
|
}, hs)
|
|
})
|
|
|
|
t.Run("Given user has admin permissions and permissions to update", func(t *testing.T) {
|
|
origNewGuardian := guardian.New
|
|
t.Cleanup(func() {
|
|
guardian.New = origNewGuardian
|
|
})
|
|
|
|
guardian.MockDashboardGuardian(&guardian.FakeDashboardGuardian{
|
|
CanAdminValue: true,
|
|
CheckPermissionBeforeUpdateValue: true,
|
|
GetACLValue: []*dashboards.DashboardACLInfoDTO{
|
|
{OrgID: 1, DashboardID: 1, UserID: 2, Permission: dashboards.PERMISSION_VIEW},
|
|
{OrgID: 1, DashboardID: 1, UserID: 3, Permission: dashboards.PERMISSION_EDIT},
|
|
{OrgID: 1, DashboardID: 1, UserID: 4, Permission: dashboards.PERMISSION_ADMIN},
|
|
{OrgID: 1, DashboardID: 1, TeamID: 1, Permission: dashboards.PERMISSION_VIEW},
|
|
{OrgID: 1, DashboardID: 1, TeamID: 2, Permission: dashboards.PERMISSION_ADMIN},
|
|
},
|
|
})
|
|
|
|
loggedInUserScenarioWithRole(t, "When calling GET on", "GET", "/api/dashboards/id/1/permissions",
|
|
"/api/dashboards/id/:dashboardId/permissions", org.RoleAdmin, func(sc *scenarioContext) {
|
|
callGetDashboardPermissions(sc, hs)
|
|
assert.Equal(t, 200, sc.resp.Code)
|
|
|
|
var resp []*dashboards.DashboardACLInfoDTO
|
|
err := json.Unmarshal(sc.resp.Body.Bytes(), &resp)
|
|
require.NoError(t, err)
|
|
|
|
assert.Len(t, resp, 5)
|
|
assert.Equal(t, int64(2), resp[0].UserID)
|
|
assert.Equal(t, dashboards.PERMISSION_VIEW, resp[0].Permission)
|
|
}, mockSQLStore)
|
|
|
|
cmd := dtos.UpdateDashboardACLCommand{
|
|
Items: []dtos.DashboardACLUpdateItem{
|
|
{UserID: 1000, Permission: dashboards.PERMISSION_ADMIN},
|
|
},
|
|
}
|
|
|
|
updateDashboardPermissionScenario(t, updatePermissionContext{
|
|
desc: "When calling POST on",
|
|
url: "/api/dashboards/id/1/permissions",
|
|
routePattern: "/api/dashboards/id/:dashboardId/permissions",
|
|
cmd: cmd,
|
|
fn: func(sc *scenarioContext) {
|
|
callUpdateDashboardPermissions(t, sc)
|
|
assert.Equal(t, 200, sc.resp.Code)
|
|
},
|
|
}, hs)
|
|
})
|
|
|
|
t.Run("When trying to add permissions with both a team and user", func(t *testing.T) {
|
|
origNewGuardian := guardian.New
|
|
t.Cleanup(func() {
|
|
guardian.New = origNewGuardian
|
|
})
|
|
|
|
guardian.MockDashboardGuardian(&guardian.FakeDashboardGuardian{
|
|
CanAdminValue: true,
|
|
CheckPermissionBeforeUpdateValue: true,
|
|
})
|
|
|
|
cmd := dtos.UpdateDashboardACLCommand{
|
|
Items: []dtos.DashboardACLUpdateItem{
|
|
{UserID: 1000, TeamID: 1, Permission: dashboards.PERMISSION_ADMIN},
|
|
},
|
|
}
|
|
|
|
updateDashboardPermissionScenario(t, updatePermissionContext{
|
|
desc: "When calling POST on",
|
|
url: "/api/dashboards/id/1/permissions",
|
|
routePattern: "/api/dashboards/id/:dashboardId/permissions",
|
|
cmd: cmd,
|
|
fn: func(sc *scenarioContext) {
|
|
callUpdateDashboardPermissions(t, sc)
|
|
assert.Equal(t, 400, sc.resp.Code)
|
|
respJSON, err := jsonMap(sc.resp.Body.Bytes())
|
|
require.NoError(t, err)
|
|
assert.Equal(t, dashboards.ErrPermissionsWithUserAndTeamNotAllowed.Error(), respJSON["error"])
|
|
},
|
|
}, hs)
|
|
})
|
|
|
|
t.Run("When trying to update permissions with duplicate permissions", func(t *testing.T) {
|
|
origNewGuardian := guardian.New
|
|
t.Cleanup(func() {
|
|
guardian.New = origNewGuardian
|
|
})
|
|
guardian.MockDashboardGuardian(&guardian.FakeDashboardGuardian{
|
|
CanAdminValue: true,
|
|
CheckPermissionBeforeUpdateValue: false,
|
|
CheckPermissionBeforeUpdateError: guardian.ErrGuardianPermissionExists,
|
|
})
|
|
|
|
cmd := dtos.UpdateDashboardACLCommand{
|
|
Items: []dtos.DashboardACLUpdateItem{
|
|
{UserID: 1000, Permission: dashboards.PERMISSION_ADMIN},
|
|
},
|
|
}
|
|
|
|
updateDashboardPermissionScenario(t, updatePermissionContext{
|
|
desc: "When calling POST on",
|
|
url: "/api/dashboards/id/1/permissions",
|
|
routePattern: "/api/dashboards/id/:dashboardId/permissions",
|
|
cmd: cmd,
|
|
fn: func(sc *scenarioContext) {
|
|
callUpdateDashboardPermissions(t, sc)
|
|
assert.Equal(t, 400, sc.resp.Code)
|
|
},
|
|
}, hs)
|
|
})
|
|
|
|
t.Run("When trying to update team or user permissions with a role", func(t *testing.T) {
|
|
role := org.RoleEditor
|
|
cmds := []dtos.UpdateDashboardACLCommand{
|
|
{
|
|
Items: []dtos.DashboardACLUpdateItem{
|
|
{UserID: 1000, Permission: dashboards.PERMISSION_ADMIN, Role: &role},
|
|
},
|
|
},
|
|
{
|
|
Items: []dtos.DashboardACLUpdateItem{
|
|
{TeamID: 1000, Permission: dashboards.PERMISSION_ADMIN, Role: &role},
|
|
},
|
|
},
|
|
}
|
|
|
|
for _, cmd := range cmds {
|
|
updateDashboardPermissionScenario(t, updatePermissionContext{
|
|
desc: "When calling POST on",
|
|
url: "/api/dashboards/id/1/permissions",
|
|
routePattern: "/api/dashboards/id/:dashboardId/permissions",
|
|
cmd: cmd,
|
|
fn: func(sc *scenarioContext) {
|
|
callUpdateDashboardPermissions(t, sc)
|
|
assert.Equal(t, 400, sc.resp.Code)
|
|
respJSON, err := jsonMap(sc.resp.Body.Bytes())
|
|
require.NoError(t, err)
|
|
assert.Equal(t, dashboards.ErrPermissionsWithRoleNotAllowed.Error(), respJSON["error"])
|
|
},
|
|
}, hs)
|
|
}
|
|
})
|
|
|
|
t.Run("When trying to override inherited permissions with lower precedence", func(t *testing.T) {
|
|
origNewGuardian := guardian.New
|
|
t.Cleanup(func() {
|
|
guardian.New = origNewGuardian
|
|
})
|
|
|
|
guardian.MockDashboardGuardian(&guardian.FakeDashboardGuardian{
|
|
CanAdminValue: true,
|
|
CheckPermissionBeforeUpdateValue: false,
|
|
CheckPermissionBeforeUpdateError: guardian.ErrGuardianOverride},
|
|
)
|
|
|
|
cmd := dtos.UpdateDashboardACLCommand{
|
|
Items: []dtos.DashboardACLUpdateItem{
|
|
{UserID: 1000, Permission: dashboards.PERMISSION_ADMIN},
|
|
},
|
|
}
|
|
|
|
updateDashboardPermissionScenario(t, updatePermissionContext{
|
|
desc: "When calling POST on",
|
|
url: "/api/dashboards/id/1/permissions",
|
|
routePattern: "/api/dashboards/id/:dashboardId/permissions",
|
|
cmd: cmd,
|
|
fn: func(sc *scenarioContext) {
|
|
callUpdateDashboardPermissions(t, sc)
|
|
assert.Equal(t, 400, sc.resp.Code)
|
|
},
|
|
}, hs)
|
|
})
|
|
|
|
t.Run("Getting and updating dashboard permissions with hidden users", func(t *testing.T) {
|
|
origNewGuardian := guardian.New
|
|
settings.HiddenUsers = map[string]struct{}{
|
|
"hiddenUser": {},
|
|
testUserLogin: {},
|
|
}
|
|
t.Cleanup(func() {
|
|
guardian.New = origNewGuardian
|
|
settings.HiddenUsers = make(map[string]struct{})
|
|
})
|
|
|
|
mockSQLStore := dbtest.NewFakeDB()
|
|
var resp []*dashboards.DashboardACLInfoDTO
|
|
loggedInUserScenarioWithRole(t, "When calling GET on", "GET", "/api/dashboards/id/1/permissions",
|
|
"/api/dashboards/id/:dashboardId/permissions", org.RoleAdmin, func(sc *scenarioContext) {
|
|
setUp()
|
|
guardian.MockDashboardGuardian(&guardian.FakeDashboardGuardian{
|
|
CanAdminValue: true,
|
|
CheckPermissionBeforeUpdateValue: true,
|
|
GetACLValue: []*dashboards.DashboardACLInfoDTO{
|
|
{OrgID: 1, DashboardID: 1, UserID: 2, UserLogin: "hiddenUser", Permission: dashboards.PERMISSION_VIEW},
|
|
{OrgID: 1, DashboardID: 1, UserID: 3, UserLogin: testUserLogin, Permission: dashboards.PERMISSION_EDIT},
|
|
{OrgID: 1, DashboardID: 1, UserID: 4, UserLogin: "user_1", Permission: dashboards.PERMISSION_ADMIN},
|
|
},
|
|
GetHiddenACLValue: []*dashboards.DashboardACL{
|
|
{OrgID: 1, DashboardID: 1, UserID: 2, Permission: dashboards.PERMISSION_VIEW},
|
|
},
|
|
})
|
|
|
|
callGetDashboardPermissions(sc, hs)
|
|
assert.Equal(t, 200, sc.resp.Code)
|
|
|
|
err := json.Unmarshal(sc.resp.Body.Bytes(), &resp)
|
|
require.NoError(t, err)
|
|
|
|
assert.Len(t, resp, 2)
|
|
assert.Equal(t, int64(3), resp[0].UserID)
|
|
assert.Equal(t, dashboards.PERMISSION_EDIT, resp[0].Permission)
|
|
assert.Equal(t, int64(4), resp[1].UserID)
|
|
assert.Equal(t, dashboards.PERMISSION_ADMIN, resp[1].Permission)
|
|
}, mockSQLStore)
|
|
|
|
cmd := dtos.UpdateDashboardACLCommand{
|
|
Items: []dtos.DashboardACLUpdateItem{
|
|
{UserID: 1000, Permission: dashboards.PERMISSION_ADMIN},
|
|
},
|
|
}
|
|
for _, acl := range resp {
|
|
cmd.Items = append(cmd.Items, dtos.DashboardACLUpdateItem{
|
|
UserID: acl.UserID,
|
|
Permission: acl.Permission,
|
|
})
|
|
}
|
|
assert.Len(t, cmd.Items, 3)
|
|
|
|
var numOfItems []*dashboards.DashboardACL
|
|
dashboardStore.On("UpdateDashboardACL", mock.Anything, mock.Anything, mock.Anything).Run(func(args mock.Arguments) {
|
|
items := args.Get(2).([]*dashboards.DashboardACL)
|
|
numOfItems = items
|
|
}).Return(nil).Once()
|
|
updateDashboardPermissionScenario(t, updatePermissionContext{
|
|
desc: "When calling POST on",
|
|
url: "/api/dashboards/id/1/permissions",
|
|
routePattern: "/api/dashboards/id/:dashboardId/permissions",
|
|
cmd: cmd,
|
|
fn: func(sc *scenarioContext) {
|
|
sc.fakeReqWithParams("POST", sc.url, map[string]string{}).exec()
|
|
assert.Equal(t, 200, sc.resp.Code)
|
|
assert.Len(t, numOfItems, 4)
|
|
},
|
|
}, hs)
|
|
})
|
|
})
|
|
}
|
|
|
|
func callGetDashboardPermissions(sc *scenarioContext, hs *HTTPServer) {
|
|
sc.handlerFunc = hs.GetDashboardPermissionList
|
|
sc.fakeReqWithParams("GET", sc.url, map[string]string{}).exec()
|
|
}
|
|
|
|
func callUpdateDashboardPermissions(t *testing.T, sc *scenarioContext) {
|
|
t.Helper()
|
|
sc.fakeReqWithParams("POST", sc.url, map[string]string{}).exec()
|
|
}
|
|
|
|
type updatePermissionContext struct {
|
|
desc string
|
|
url string
|
|
routePattern string
|
|
cmd dtos.UpdateDashboardACLCommand
|
|
fn scenarioFunc
|
|
}
|
|
|
|
func updateDashboardPermissionScenario(t *testing.T, ctx updatePermissionContext, hs *HTTPServer) {
|
|
t.Run(fmt.Sprintf("%s %s", ctx.desc, ctx.url), func(t *testing.T) {
|
|
sc := setupScenarioContext(t, ctx.url)
|
|
|
|
sc.defaultHandler = routing.Wrap(func(c *contextmodel.ReqContext) response.Response {
|
|
c.Req.Body = mockRequestBody(ctx.cmd)
|
|
c.Req.Header.Add("Content-Type", "application/json")
|
|
sc.context = c
|
|
sc.context.OrgID = testOrgID
|
|
sc.context.UserID = testUserID
|
|
|
|
return hs.UpdateDashboardPermissions(c)
|
|
})
|
|
|
|
sc.m.Post(ctx.routePattern, sc.defaultHandler)
|
|
|
|
ctx.fn(sc)
|
|
})
|
|
}
|