public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Rename Acl to ACL (#52342)

Browse Source 
* Rename Acl to ACL

* Fix yaml files

* Add xorm tags and fix test
This commit is contained in:
idafurjes
2022-07-18 15:14:58 +02:00
committed by GitHub
parent 8ff152f98f
commit f5cace8bbd
48 changed files with 397 additions and 395 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pkg/services/dashboards/database/acl.go
+3 -3
View File
@@ -7,14 +7,14 @@ import (
"github.com/grafana/grafana/pkg/services/sqlstore"
)
// GetDashboardAclInfoList returns a list of permissions for a dashboard. They can be fetched from three
// GetDashboardACLInfoList returns a list of permissions for a dashboard. They can be fetched from three
// different places.
// 1) Permissions for the dashboard
// 2) permissions for its parent folder
// 3) if no specific permissions have been set for the dashboard or its parent folder then get the default permissions
func (d *DashboardStore) GetDashboardAclInfoList(ctx context.Context, query *models.GetDashboardAclInfoListQuery) error {
func (d *DashboardStore) GetDashboardACLInfoList(ctx context.Context, query *models.GetDashboardACLInfoListQuery) error {
outerErr := d.sqlStore.WithDbSession(ctx, func(dbSession *sqlstore.DBSession) error {
query.Result = make([]*models.DashboardAclInfoDTO, 0)
query.Result = make([]*models.DashboardACLInfoDTO, 0)
falseStr := d.dialect.BooleanStr(false)
if query.DashboardID == 0 {
pkg/services/dashboards/database/acl_test.go
+32 -32
View File
@@ -10,7 +10,7 @@ import (
"github.com/stretchr/testify/require"
)
func TestIntegrationDashboardAclDataAccess(t *testing.T) {
func TestIntegrationDashboardACLDataAccess(t *testing.T) {
if testing.Short() {
t.Skip("skipping integration test")
}
@@ -29,19 +29,19 @@ func TestIntegrationDashboardAclDataAccess(t *testing.T) {
t.Run("Dashboard permission with userId and teamId set to 0", func(t *testing.T) {
setup(t)
err := updateDashboardAcl(t, dashboardStore, savedFolder.Id, models.DashboardAcl{
err := updateDashboardACL(t, dashboardStore, savedFolder.Id, models.DashboardACL{
OrgID: 1,
DashboardID: savedFolder.Id,
Permission: models.PERMISSION_EDIT,
})
require.Equal(t, models.ErrDashboardAclInfoMissing, err)
require.Equal(t, models.ErrDashboardACLInfoMissing, err)
})
t.Run("Folder acl should include default acl", func(t *testing.T) {
setup(t)
query := models.GetDashboardAclInfoListQuery{DashboardID: savedFolder.Id, OrgID: 1}
query := models.GetDashboardACLInfoListQuery{DashboardID: savedFolder.Id, OrgID: 1}
err := dashboardStore.GetDashboardAclInfoList(context.Background(), &query)
err := dashboardStore.GetDashboardACLInfoList(context.Background(), &query)
require.Nil(t, err)
require.Equal(t, 2, len(query.Result))
@@ -56,9 +56,9 @@ func TestIntegrationDashboardAclDataAccess(t *testing.T) {
t.Run("Dashboard acl should include acl for parent folder", func(t *testing.T) {
setup(t)
query := models.GetDashboardAclInfoListQuery{DashboardID: childDash.Id, OrgID: 1}
query := models.GetDashboardACLInfoListQuery{DashboardID: childDash.Id, OrgID: 1}
err := dashboardStore.GetDashboardAclInfoList(context.Background(), &query)
err := dashboardStore.GetDashboardACLInfoList(context.Background(), &query)
require.Nil(t, err)
require.Equal(t, 2, len(query.Result))
@@ -76,8 +76,8 @@ func TestIntegrationDashboardAclDataAccess(t *testing.T) {
err := dashboardStore.UpdateDashboardACL(context.Background(), savedFolder.Id, nil)
require.Nil(t, err)
query := models.GetDashboardAclInfoListQuery{DashboardID: childDash.Id, OrgID: 1}
err = dashboardStore.GetDashboardAclInfoList(context.Background(), &query)
query := models.GetDashboardACLInfoListQuery{DashboardID: childDash.Id, OrgID: 1}
err = dashboardStore.GetDashboardACLInfoList(context.Background(), &query)
require.Nil(t, err)
require.Equal(t, 0, len(query.Result))
@@ -86,7 +86,7 @@ func TestIntegrationDashboardAclDataAccess(t *testing.T) {
t.Run("Given a dashboard folder and a user", func(t *testing.T) {
t.Run("Given dashboard folder permission", func(t *testing.T) {
setup(t)
err := updateDashboardAcl(t, dashboardStore, savedFolder.Id, models.DashboardAcl{
err := updateDashboardACL(t, dashboardStore, savedFolder.Id, models.DashboardACL{
OrgID: 1,
UserID: currentUser.ID,
DashboardID: savedFolder.Id,
@@ -95,9 +95,9 @@ func TestIntegrationDashboardAclDataAccess(t *testing.T) {
require.Nil(t, err)
t.Run("When reading dashboard acl should include acl for parent folder", func(t *testing.T) {
query := models.GetDashboardAclInfoListQuery{DashboardID: childDash.Id, OrgID: 1}
query := models.GetDashboardACLInfoListQuery{DashboardID: childDash.Id, OrgID: 1}
err := dashboardStore.GetDashboardAclInfoList(context.Background(), &query)
err := dashboardStore.GetDashboardACLInfoList(context.Background(), &query)
require.Nil(t, err)
require.Equal(t, 1, len(query.Result))
@@ -105,7 +105,7 @@ func TestIntegrationDashboardAclDataAccess(t *testing.T) {
})
t.Run("Given child dashboard permission", func(t *testing.T) {
err := updateDashboardAcl(t, dashboardStore, childDash.Id, models.DashboardAcl{
err := updateDashboardACL(t, dashboardStore, childDash.Id, models.DashboardACL{
OrgID: 1,
UserID: currentUser.ID,
DashboardID: childDash.Id,
@@ -114,9 +114,9 @@ func TestIntegrationDashboardAclDataAccess(t *testing.T) {
require.Nil(t, err)
t.Run("When reading dashboard acl should include acl for parent folder and child", func(t *testing.T) {
query := models.GetDashboardAclInfoListQuery{OrgID: 1, DashboardID: childDash.Id}
query := models.GetDashboardACLInfoListQuery{OrgID: 1, DashboardID: childDash.Id}
err := dashboardStore.GetDashboardAclInfoList(context.Background(), &query)
err := dashboardStore.GetDashboardACLInfoList(context.Background(), &query)
require.Nil(t, err)
require.Equal(t, 2, len(query.Result))
@@ -130,7 +130,7 @@ func TestIntegrationDashboardAclDataAccess(t *testing.T) {
t.Run("Reading dashboard acl should include default acl for parent folder and the child acl", func(t *testing.T) {
setup(t)
err := updateDashboardAcl(t, dashboardStore, childDash.Id, models.DashboardAcl{
err := updateDashboardACL(t, dashboardStore, childDash.Id, models.DashboardACL{
OrgID: 1,
UserID: currentUser.ID,
DashboardID: childDash.Id,
@@ -138,9 +138,9 @@ func TestIntegrationDashboardAclDataAccess(t *testing.T) {
})
require.Nil(t, err)
query := models.GetDashboardAclInfoListQuery{OrgID: 1, DashboardID: childDash.Id}
query := models.GetDashboardACLInfoListQuery{OrgID: 1, DashboardID: childDash.Id}
err = dashboardStore.GetDashboardAclInfoList(context.Background(), &query)
err = dashboardStore.GetDashboardACLInfoList(context.Background(), &query)
require.Nil(t, err)
defaultPermissionsId := int64(-1)
@@ -157,7 +157,7 @@ func TestIntegrationDashboardAclDataAccess(t *testing.T) {
t.Run("Add and delete dashboard permission", func(t *testing.T) {
setup(t)
err := updateDashboardAcl(t, dashboardStore, savedFolder.Id, models.DashboardAcl{
err := updateDashboardACL(t, dashboardStore, savedFolder.Id, models.DashboardACL{
OrgID: 1,
UserID: currentUser.ID,
DashboardID: savedFolder.Id,
@@ -165,8 +165,8 @@ func TestIntegrationDashboardAclDataAccess(t *testing.T) {
})
require.Nil(t, err)
q1 := &models.GetDashboardAclInfoListQuery{DashboardID: savedFolder.Id, OrgID: 1}
err = dashboardStore.GetDashboardAclInfoList(context.Background(), q1)
q1 := &models.GetDashboardACLInfoListQuery{DashboardID: savedFolder.Id, OrgID: 1}
err = dashboardStore.GetDashboardACLInfoList(context.Background(), q1)
require.Nil(t, err)
require.Equal(t, savedFolder.Id, q1.Result[0].DashboardId)
@@ -176,11 +176,11 @@ func TestIntegrationDashboardAclDataAccess(t *testing.T) {
require.Equal(t, currentUser.Login, q1.Result[0].UserLogin)
require.Equal(t, currentUser.Email, q1.Result[0].UserEmail)
err = updateDashboardAcl(t, dashboardStore, savedFolder.Id)
err = updateDashboardACL(t, dashboardStore, savedFolder.Id)
require.Nil(t, err)
q3 := &models.GetDashboardAclInfoListQuery{DashboardID: savedFolder.Id, OrgID: 1}
err = dashboardStore.GetDashboardAclInfoList(context.Background(), q3)
q3 := &models.GetDashboardACLInfoListQuery{DashboardID: savedFolder.Id, OrgID: 1}
err = dashboardStore.GetDashboardACLInfoList(context.Background(), q3)
require.Nil(t, err)
require.Equal(t, 0, len(q3.Result))
})
@@ -190,7 +190,7 @@ func TestIntegrationDashboardAclDataAccess(t *testing.T) {
team1, err := sqlStore.CreateTeam("group1 name", "", 1)
require.Nil(t, err)
err = updateDashboardAcl(t, dashboardStore, savedFolder.Id, models.DashboardAcl{
err = updateDashboardACL(t, dashboardStore, savedFolder.Id, models.DashboardACL{
OrgID: 1,
TeamID: team1.Id,
DashboardID: savedFolder.Id,
@@ -198,8 +198,8 @@ func TestIntegrationDashboardAclDataAccess(t *testing.T) {
})
require.Nil(t, err)
q1 := &models.GetDashboardAclInfoListQuery{DashboardID: savedFolder.Id, OrgID: 1}
err = dashboardStore.GetDashboardAclInfoList(context.Background(), q1)
q1 := &models.GetDashboardACLInfoListQuery{DashboardID: savedFolder.Id, OrgID: 1}
err = dashboardStore.GetDashboardACLInfoList(context.Background(), q1)
require.Nil(t, err)
require.Equal(t, savedFolder.Id, q1.Result[0].DashboardId)
require.Equal(t, models.PERMISSION_EDIT, q1.Result[0].Permission)
@@ -210,7 +210,7 @@ func TestIntegrationDashboardAclDataAccess(t *testing.T) {
setup(t)
team1, err := sqlStore.CreateTeam("group1 name", "", 1)
require.Nil(t, err)
err = updateDashboardAcl(t, dashboardStore, savedFolder.Id, models.DashboardAcl{
err = updateDashboardACL(t, dashboardStore, savedFolder.Id, models.DashboardACL{
OrgID: 1,
TeamID: team1.Id,
DashboardID: savedFolder.Id,
@@ -218,8 +218,8 @@ func TestIntegrationDashboardAclDataAccess(t *testing.T) {
})
require.Nil(t, err)
q3 := &models.GetDashboardAclInfoListQuery{DashboardID: savedFolder.Id, OrgID: 1}
err = dashboardStore.GetDashboardAclInfoList(context.Background(), q3)
q3 := &models.GetDashboardACLInfoListQuery{DashboardID: savedFolder.Id, OrgID: 1}
err = dashboardStore.GetDashboardACLInfoList(context.Background(), q3)
require.Nil(t, err)
require.Equal(t, 1, len(q3.Result))
require.Equal(t, savedFolder.Id, q3.Result[0].DashboardId)
@@ -233,9 +233,9 @@ func TestIntegrationDashboardAclDataAccess(t *testing.T) {
var rootFolderId int64 = 0
//sqlStore := sqlstore.InitTestDB(t)
query := models.GetDashboardAclInfoListQuery{DashboardID: rootFolderId, OrgID: 1}
query := models.GetDashboardACLInfoListQuery{DashboardID: rootFolderId, OrgID: 1}
err := dashboardStore.GetDashboardAclInfoList(context.Background(), &query)
err := dashboardStore.GetDashboardACLInfoList(context.Background(), &query)
require.Nil(t, err)
require.Equal(t, 2, len(query.Result))
pkg/services/dashboards/database/database.go
+4 -4
View File
@@ -192,7 +192,7 @@ func (d *DashboardStore) SaveDashboard(cmd models.SaveDashboardCommand) (*models
return cmd.Result, err
}
func (d *DashboardStore) UpdateDashboardACL(ctx context.Context, dashboardID int64, items []*models.DashboardAcl) error {
func (d *DashboardStore) UpdateDashboardACL(ctx context.Context, dashboardID int64, items []*models.DashboardACL) error {
return d.sqlStore.WithTransactionalDbSession(ctx, func(sess *sqlstore.DBSession) error {
// delete existing items
_, err := sess.Exec("DELETE FROM dashboard_acl WHERE dashboard_id=?", dashboardID)
@@ -202,7 +202,7 @@ func (d *DashboardStore) UpdateDashboardACL(ctx context.Context, dashboardID int
for _, item := range items {
if item.UserID == 0 && item.TeamID == 0 && (item.Role == nil || !item.Role.IsValid()) {
return models.ErrDashboardAclInfoMissing
return models.ErrDashboardACLInfoMissing
}
if item.DashboardID == 0 {
@@ -215,8 +215,8 @@ func (d *DashboardStore) UpdateDashboardACL(ctx context.Context, dashboardID int
}
}
// Update dashboard HasAcl flag
dashboard := models.Dashboard{HasAcl: true}
// Update dashboard HasACL flag
dashboard := models.Dashboard{HasACL: true}
_, err = sess.Cols("has_acl").Where("id=?", dashboardID).Update(&dashboard)
return err
})
pkg/services/dashboards/database/database_folder_test.go
+11 -11
View File
@@ -54,7 +54,7 @@ func TestIntegrationDashboardFolderDataAccess(t *testing.T) {
t.Run("and acl is set for dashboard folder", func(t *testing.T) {
var otherUser int64 = 999
err := updateDashboardAcl(t, dashboardStore, folder.Id, models.DashboardAcl{
err := updateDashboardACL(t, dashboardStore, folder.Id, models.DashboardACL{
DashboardID: folder.Id,
OrgID: 1,
UserID: otherUser,
@@ -75,7 +75,7 @@ func TestIntegrationDashboardFolderDataAccess(t *testing.T) {
})
t.Run("when the user is given permission", func(t *testing.T) {
err := updateDashboardAcl(t, dashboardStore, folder.Id, models.DashboardAcl{
err := updateDashboardACL(t, dashboardStore, folder.Id, models.DashboardACL{
DashboardID: folder.Id, OrgID: 1, UserID: currentUser.ID, Permission: models.PERMISSION_EDIT,
})
require.NoError(t, err)
@@ -116,9 +116,9 @@ func TestIntegrationDashboardFolderDataAccess(t *testing.T) {
t.Run("and acl is set for dashboard child and folder has all permissions removed", func(t *testing.T) {
var otherUser int64 = 999
err := updateDashboardAcl(t, dashboardStore, folder.Id)
err := updateDashboardACL(t, dashboardStore, folder.Id)
require.NoError(t, err)
err = updateDashboardAcl(t, dashboardStore, childDash.Id, models.DashboardAcl{
err = updateDashboardACL(t, dashboardStore, childDash.Id, models.DashboardACL{
DashboardID: folder.Id, OrgID: 1, UserID: otherUser, Permission: models.PERMISSION_EDIT,
})
require.NoError(t, err)
@@ -134,7 +134,7 @@ func TestIntegrationDashboardFolderDataAccess(t *testing.T) {
})
t.Run("when the user is given permission to child", func(t *testing.T) {
err := updateDashboardAcl(t, dashboardStore, childDash.Id, models.DashboardAcl{
err := updateDashboardACL(t, dashboardStore, childDash.Id, models.DashboardACL{
DashboardID: childDash.Id, OrgID: 1, UserID: currentUser.ID, Permission: models.PERMISSION_EDIT,
})
require.NoError(t, err)
@@ -211,7 +211,7 @@ func TestIntegrationDashboardFolderDataAccess(t *testing.T) {
t.Run("and acl is set for one dashboard folder", func(t *testing.T) {
const otherUser int64 = 999
err := updateDashboardAcl(t, dashboardStore, folder1.Id, models.DashboardAcl{
err := updateDashboardACL(t, dashboardStore, folder1.Id, models.DashboardACL{
DashboardID: folder1.Id, OrgID: 1, UserID: otherUser, Permission: models.PERMISSION_EDIT,
})
require.NoError(t, err)
@@ -252,7 +252,7 @@ func TestIntegrationDashboardFolderDataAccess(t *testing.T) {
})
t.Run("and a dashboard with an acl is moved to the folder without an acl", func(t *testing.T) {
err := updateDashboardAcl(t, dashboardStore, childDash1.Id, models.DashboardAcl{
err := updateDashboardACL(t, dashboardStore, childDash1.Id, models.DashboardACL{
DashboardID: childDash1.Id, OrgID: 1, UserID: otherUser, Permission: models.PERMISSION_EDIT,
})
require.NoError(t, err)
@@ -348,7 +348,7 @@ func TestIntegrationDashboardFolderDataAccess(t *testing.T) {
})
t.Run("Should have write access to one dashboard folder if default role changed to view for one folder", func(t *testing.T) {
err := updateDashboardAcl(t, dashboardStore, folder1.Id, models.DashboardAcl{
err := updateDashboardACL(t, dashboardStore, folder1.Id, models.DashboardACL{
DashboardID: folder1.Id, OrgID: 1, UserID: editorUser.ID, Permission: models.PERMISSION_VIEW,
})
require.NoError(t, err)
@@ -394,7 +394,7 @@ func TestIntegrationDashboardFolderDataAccess(t *testing.T) {
})
t.Run("Should be able to get one dashboard folder if default role changed to edit for one folder", func(t *testing.T) {
err := updateDashboardAcl(t, dashboardStore, folder1.Id, models.DashboardAcl{
err := updateDashboardACL(t, dashboardStore, folder1.Id, models.DashboardACL{
DashboardID: folder1.Id, OrgID: 1, UserID: viewerUser.ID, Permission: models.PERMISSION_EDIT,
})
require.NoError(t, err)
@@ -427,7 +427,7 @@ func TestIntegrationDashboardFolderDataAccess(t *testing.T) {
})
t.Run("and admin permission is given for user with org role viewer in one dashboard folder", func(t *testing.T) {
err := updateDashboardAcl(t, dashboardStore, folder1.Id, models.DashboardAcl{
err := updateDashboardACL(t, dashboardStore, folder1.Id, models.DashboardACL{
DashboardID: folder1.Id, OrgID: 1, UserID: viewerUser.ID, Permission: models.PERMISSION_ADMIN,
})
require.NoError(t, err)
@@ -443,7 +443,7 @@ func TestIntegrationDashboardFolderDataAccess(t *testing.T) {
})
t.Run("and edit permission is given for user with org role viewer in one dashboard folder", func(t *testing.T) {
err := updateDashboardAcl(t, dashboardStore, folder1.Id, models.DashboardAcl{
err := updateDashboardACL(t, dashboardStore, folder1.Id, models.DashboardACL{
DashboardID: folder1.Id, OrgID: 1, UserID: viewerUser.ID, Permission: models.PERMISSION_EDIT,
})
require.NoError(t, err)
pkg/services/dashboards/database/database_test.go
+3 -3
View File
@@ -723,11 +723,11 @@ func insertTestDashboardForPlugin(t *testing.T, dashboardStore *DashboardStore,
return dash
}
func updateDashboardAcl(t *testing.T, dashboardStore *DashboardStore, dashboardID int64,
items ...models.DashboardAcl) error {
func updateDashboardACL(t *testing.T, dashboardStore *DashboardStore, dashboardID int64,
items ...models.DashboardACL) error {
t.Helper()
var itemPtrs []*models.DashboardAcl
var itemPtrs []*models.DashboardACL
for _, it := range items {
item := it
item.Created = time.Now()