mirror of
https://github.com/grafana/grafana.git
synced 2024-11-28 11:44:26 -06:00
5af96544f3
These permissions could be created through the API but would not show correctly in the UI.
448 lines
14 KiB
Go
448 lines
14 KiB
Go
package api
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"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/dashboards"
|
|
"github.com/grafana/grafana/pkg/models"
|
|
"github.com/grafana/grafana/pkg/services/guardian"
|
|
"github.com/grafana/grafana/pkg/setting"
|
|
)
|
|
|
|
func TestDashboardPermissionAPIEndpoint(t *testing.T) {
|
|
t.Run("Dashboard permissions test", func(t *testing.T) {
|
|
settings := setting.NewCfg()
|
|
hs := &HTTPServer{Cfg: settings}
|
|
|
|
t.Run("Given dashboard not exists", func(t *testing.T) {
|
|
setUp := func() {
|
|
bus.AddHandler("test", func(query *models.GetDashboardQuery) error {
|
|
return models.ErrDashboardNotFound
|
|
})
|
|
}
|
|
|
|
loggedInUserScenarioWithRole(t, "When calling GET on", "GET", "/api/dashboards/id/1/permissions",
|
|
"/api/dashboards/id/:id/permissions", models.ROLE_EDITOR, func(sc *scenarioContext) {
|
|
setUp()
|
|
callGetDashboardPermissions(sc, hs)
|
|
assert.Equal(t, 404, sc.resp.Code)
|
|
})
|
|
|
|
cmd := dtos.UpdateDashboardAclCommand{
|
|
Items: []dtos.DashboardAclUpdateItem{
|
|
{UserID: 1000, Permission: models.PERMISSION_ADMIN},
|
|
},
|
|
}
|
|
|
|
updateDashboardPermissionScenario(t, updatePermissionContext{
|
|
desc: "When calling POST on",
|
|
url: "/api/dashboards/id/1/permissions",
|
|
routePattern: "/api/dashboards/id/:id/permissions",
|
|
cmd: cmd,
|
|
fn: func(sc *scenarioContext) {
|
|
setUp()
|
|
callUpdateDashboardPermissions(t, sc)
|
|
assert.Equal(t, 404, sc.resp.Code)
|
|
},
|
|
}, hs)
|
|
})
|
|
|
|
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})
|
|
|
|
getDashboardQueryResult := models.NewDashboard("Dash")
|
|
|
|
setUp := func() {
|
|
bus.AddHandlerCtx("test", func(ctx context.Context, query *models.GetDashboardQuery) error {
|
|
query.Result = getDashboardQueryResult
|
|
return nil
|
|
})
|
|
}
|
|
|
|
loggedInUserScenarioWithRole(t, "When calling GET on", "GET", "/api/dashboards/id/1/permissions",
|
|
"/api/dashboards/id/:id/permissions", models.ROLE_EDITOR, func(sc *scenarioContext) {
|
|
setUp()
|
|
callGetDashboardPermissions(sc, hs)
|
|
assert.Equal(t, 403, sc.resp.Code)
|
|
})
|
|
|
|
cmd := dtos.UpdateDashboardAclCommand{
|
|
Items: []dtos.DashboardAclUpdateItem{
|
|
{UserID: 1000, Permission: models.PERMISSION_ADMIN},
|
|
},
|
|
}
|
|
|
|
updateDashboardPermissionScenario(t, updatePermissionContext{
|
|
desc: "When calling POST on",
|
|
url: "/api/dashboards/id/1/permissions",
|
|
routePattern: "/api/dashboards/id/:id/permissions",
|
|
cmd: cmd,
|
|
fn: func(sc *scenarioContext) {
|
|
setUp()
|
|
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: []*models.DashboardAclInfoDTO{
|
|
{OrgId: 1, DashboardId: 1, UserId: 2, Permission: models.PERMISSION_VIEW},
|
|
{OrgId: 1, DashboardId: 1, UserId: 3, Permission: models.PERMISSION_EDIT},
|
|
{OrgId: 1, DashboardId: 1, UserId: 4, Permission: models.PERMISSION_ADMIN},
|
|
{OrgId: 1, DashboardId: 1, TeamId: 1, Permission: models.PERMISSION_VIEW},
|
|
{OrgId: 1, DashboardId: 1, TeamId: 2, Permission: models.PERMISSION_ADMIN},
|
|
},
|
|
})
|
|
|
|
setUp := func() {
|
|
getDashboardQueryResult := models.NewDashboard("Dash")
|
|
bus.AddHandlerCtx("test", func(ctx context.Context, query *models.GetDashboardQuery) error {
|
|
query.Result = getDashboardQueryResult
|
|
return nil
|
|
})
|
|
}
|
|
|
|
loggedInUserScenarioWithRole(t, "When calling GET on", "GET", "/api/dashboards/id/1/permissions",
|
|
"/api/dashboards/id/:id/permissions", models.ROLE_ADMIN, func(sc *scenarioContext) {
|
|
setUp()
|
|
callGetDashboardPermissions(sc, hs)
|
|
assert.Equal(t, 200, sc.resp.Code)
|
|
|
|
var resp []*models.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, models.PERMISSION_VIEW, resp[0].Permission)
|
|
})
|
|
|
|
cmd := dtos.UpdateDashboardAclCommand{
|
|
Items: []dtos.DashboardAclUpdateItem{
|
|
{UserID: 1000, Permission: models.PERMISSION_ADMIN},
|
|
},
|
|
}
|
|
|
|
updateDashboardPermissionScenario(t, updatePermissionContext{
|
|
desc: "When calling POST on",
|
|
url: "/api/dashboards/id/1/permissions",
|
|
routePattern: "/api/dashboards/id/:id/permissions",
|
|
cmd: cmd,
|
|
fn: func(sc *scenarioContext) {
|
|
setUp()
|
|
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,
|
|
})
|
|
|
|
setUp := func() {
|
|
getDashboardQueryResult := models.NewDashboard("Dash")
|
|
bus.AddHandlerCtx("test", func(ctx context.Context, query *models.GetDashboardQuery) error {
|
|
query.Result = getDashboardQueryResult
|
|
return nil
|
|
})
|
|
}
|
|
|
|
cmd := dtos.UpdateDashboardAclCommand{
|
|
Items: []dtos.DashboardAclUpdateItem{
|
|
{UserID: 1000, TeamID: 1, Permission: models.PERMISSION_ADMIN},
|
|
},
|
|
}
|
|
|
|
updateDashboardPermissionScenario(t, updatePermissionContext{
|
|
desc: "When calling POST on",
|
|
url: "/api/dashboards/id/1/permissions",
|
|
routePattern: "/api/dashboards/id/:id/permissions",
|
|
cmd: cmd,
|
|
fn: func(sc *scenarioContext) {
|
|
setUp()
|
|
callUpdateDashboardPermissions(t, sc)
|
|
assert.Equal(t, 400, sc.resp.Code)
|
|
respJSON, err := jsonMap(sc.resp.Body.Bytes())
|
|
require.NoError(t, err)
|
|
assert.Equal(t, models.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,
|
|
})
|
|
|
|
setUp := func() {
|
|
getDashboardQueryResult := models.NewDashboard("Dash")
|
|
bus.AddHandlerCtx("test", func(ctx context.Context, query *models.GetDashboardQuery) error {
|
|
query.Result = getDashboardQueryResult
|
|
return nil
|
|
})
|
|
}
|
|
|
|
cmd := dtos.UpdateDashboardAclCommand{
|
|
Items: []dtos.DashboardAclUpdateItem{
|
|
{UserID: 1000, Permission: models.PERMISSION_ADMIN},
|
|
},
|
|
}
|
|
|
|
updateDashboardPermissionScenario(t, updatePermissionContext{
|
|
desc: "When calling POST on",
|
|
url: "/api/dashboards/id/1/permissions",
|
|
routePattern: "/api/dashboards/id/:id/permissions",
|
|
cmd: cmd,
|
|
fn: func(sc *scenarioContext) {
|
|
setUp()
|
|
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 := models.ROLE_EDITOR
|
|
cmds := []dtos.UpdateDashboardAclCommand{
|
|
{
|
|
Items: []dtos.DashboardAclUpdateItem{
|
|
{UserID: 1000, Permission: models.PERMISSION_ADMIN, Role: &role},
|
|
},
|
|
},
|
|
{
|
|
Items: []dtos.DashboardAclUpdateItem{
|
|
{TeamID: 1000, Permission: models.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/:id/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, models.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},
|
|
)
|
|
|
|
setUp := func() {
|
|
getDashboardQueryResult := models.NewDashboard("Dash")
|
|
bus.AddHandlerCtx("test", func(ctx context.Context, query *models.GetDashboardQuery) error {
|
|
query.Result = getDashboardQueryResult
|
|
return nil
|
|
})
|
|
}
|
|
|
|
cmd := dtos.UpdateDashboardAclCommand{
|
|
Items: []dtos.DashboardAclUpdateItem{
|
|
{UserID: 1000, Permission: models.PERMISSION_ADMIN},
|
|
},
|
|
}
|
|
|
|
updateDashboardPermissionScenario(t, updatePermissionContext{
|
|
desc: "When calling POST on",
|
|
url: "/api/dashboards/id/1/permissions",
|
|
routePattern: "/api/dashboards/id/:id/permissions",
|
|
cmd: cmd,
|
|
fn: func(sc *scenarioContext) {
|
|
setUp()
|
|
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{})
|
|
})
|
|
|
|
guardian.MockDashboardGuardian(&guardian.FakeDashboardGuardian{
|
|
CanAdminValue: true,
|
|
CheckPermissionBeforeUpdateValue: true,
|
|
GetAclValue: []*models.DashboardAclInfoDTO{
|
|
{OrgId: 1, DashboardId: 1, UserId: 2, UserLogin: "hiddenUser", Permission: models.PERMISSION_VIEW},
|
|
{OrgId: 1, DashboardId: 1, UserId: 3, UserLogin: testUserLogin, Permission: models.PERMISSION_EDIT},
|
|
{OrgId: 1, DashboardId: 1, UserId: 4, UserLogin: "user_1", Permission: models.PERMISSION_ADMIN},
|
|
},
|
|
GetHiddenAclValue: []*models.DashboardAcl{
|
|
{OrgID: 1, DashboardID: 1, UserID: 2, Permission: models.PERMISSION_VIEW},
|
|
},
|
|
})
|
|
|
|
setUp := func() {
|
|
getDashboardQueryResult := models.NewDashboard("Dash")
|
|
bus.AddHandlerCtx("test", func(ctx context.Context, query *models.GetDashboardQuery) error {
|
|
query.Result = getDashboardQueryResult
|
|
return nil
|
|
})
|
|
}
|
|
|
|
var resp []*models.DashboardAclInfoDTO
|
|
loggedInUserScenarioWithRole(t, "When calling GET on", "GET", "/api/dashboards/id/1/permissions",
|
|
"/api/dashboards/id/:id/permissions", models.ROLE_ADMIN, func(sc *scenarioContext) {
|
|
setUp()
|
|
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, models.PERMISSION_EDIT, resp[0].Permission)
|
|
assert.Equal(t, int64(4), resp[1].UserId)
|
|
assert.Equal(t, models.PERMISSION_ADMIN, resp[1].Permission)
|
|
})
|
|
|
|
cmd := dtos.UpdateDashboardAclCommand{
|
|
Items: []dtos.DashboardAclUpdateItem{
|
|
{UserID: 1000, Permission: models.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)
|
|
|
|
updateDashboardPermissionScenario(t, updatePermissionContext{
|
|
desc: "When calling POST on",
|
|
url: "/api/dashboards/id/1/permissions",
|
|
routePattern: "/api/dashboards/id/:id/permissions",
|
|
cmd: cmd,
|
|
fn: func(sc *scenarioContext) {
|
|
setUp()
|
|
// TODO: Replace this fake with a fake SQLStore instead (once we can use an interface in its stead)
|
|
origUpdateDashboardACL := updateDashboardACL
|
|
t.Cleanup(func() {
|
|
updateDashboardACL = origUpdateDashboardACL
|
|
})
|
|
var gotItems []*models.DashboardAcl
|
|
updateDashboardACL = func(_ context.Context, _ dashboards.Store, folderID int64, items []*models.DashboardAcl) error {
|
|
gotItems = items
|
|
return nil
|
|
}
|
|
|
|
sc.fakeReqWithParams("POST", sc.url, map[string]string{}).exec()
|
|
assert.Equal(t, 200, sc.resp.Code)
|
|
assert.Len(t, gotItems, 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()
|
|
|
|
origUpdateDashboardACL := updateDashboardACL
|
|
t.Cleanup(func() {
|
|
updateDashboardACL = origUpdateDashboardACL
|
|
})
|
|
updateDashboardACL = func(_ context.Context, _ dashboards.Store, dashID int64, items []*models.DashboardAcl) error {
|
|
return nil
|
|
}
|
|
|
|
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) {
|
|
t.Cleanup(bus.ClearBusHandlers)
|
|
|
|
sc := setupScenarioContext(t, ctx.url)
|
|
|
|
sc.defaultHandler = routing.Wrap(func(c *models.ReqContext) response.Response {
|
|
sc.context = c
|
|
sc.context.OrgId = testOrgID
|
|
sc.context.UserId = testUserID
|
|
|
|
return hs.UpdateDashboardPermissions(c, ctx.cmd)
|
|
})
|
|
|
|
sc.m.Post(ctx.routePattern, sc.defaultHandler)
|
|
|
|
ctx.fn(sc)
|
|
})
|
|
}
|