mirror of
https://github.com/andwati/zitadel.git
synced 2026-11-19 11:45:12 +00:00
feat: add administrator role permission table (#11817)
This update introduces a new table for managing administrator role permissions, along with the necessary repository and projection logic to handle adding and removing permissions. It also includes tests to ensure the correct functionality of the permission management system. closes https://github.com/zitadel/zitadel/issues/10219 --------- Co-authored-by: Marco Ardizzone <[email protected]>
This commit is contained in:
co-authored by
Marco Ardizzone
parent
bb3b52dda3
commit
7b9d2b7d17
@@ -0,0 +1,45 @@
|
||||
package projection
|
||||
|
||||
import (
|
||||
"context"
|
||||
"database/sql"
|
||||
|
||||
v3_sql "github.com/zitadel/zitadel/backend/v3/storage/database/dialect/sql"
|
||||
"github.com/zitadel/zitadel/backend/v3/storage/database/repository"
|
||||
"github.com/zitadel/zitadel/internal/eventstore"
|
||||
"github.com/zitadel/zitadel/internal/eventstore/handler/v2"
|
||||
"github.com/zitadel/zitadel/internal/repository/permission"
|
||||
"github.com/zitadel/zitadel/internal/zerrors"
|
||||
)
|
||||
|
||||
func (p *relationalTablesProjection) reduceAdministratorRolePermissionAdded(event eventstore.Event) (*handler.Statement, error) {
|
||||
e, err := assertEvent[*permission.AddedEvent](event)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return handler.NewStatement(e, func(ctx context.Context, ex handler.Executer, _ string) error {
|
||||
tx, ok := ex.(*sql.Tx)
|
||||
if !ok {
|
||||
return zerrors.ThrowInvalidArgumentf(nil, "HANDL-v3ARP01", "reduce.wrong.db.pool %T", ex)
|
||||
}
|
||||
repo := repository.AdministratorRoleRepository()
|
||||
_, err := repo.AddPermissions(ctx, v3_sql.SQLTx(tx), e.Aggregate().InstanceID, e.Role, e.Permission)
|
||||
return err
|
||||
}), nil
|
||||
}
|
||||
|
||||
func (p *relationalTablesProjection) reduceAdministratorRolePermissionRemoved(event eventstore.Event) (*handler.Statement, error) {
|
||||
e, err := assertEvent[*permission.RemovedEvent](event)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return handler.NewStatement(e, func(ctx context.Context, ex handler.Executer, _ string) error {
|
||||
tx, ok := ex.(*sql.Tx)
|
||||
if !ok {
|
||||
return zerrors.ThrowInvalidArgumentf(nil, "HANDL-v3ARP02", "reduce.wrong.db.pool %T", ex)
|
||||
}
|
||||
repo := repository.AdministratorRoleRepository()
|
||||
_, err := repo.RemovePermissions(ctx, v3_sql.SQLTx(tx), e.Aggregate().InstanceID, e.Role, e.Permission)
|
||||
return err
|
||||
}), nil
|
||||
}
|
||||
@@ -0,0 +1,94 @@
|
||||
package projection
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
|
||||
repoDomain "github.com/zitadel/zitadel/backend/v3/domain"
|
||||
"github.com/zitadel/zitadel/backend/v3/storage/database"
|
||||
"github.com/zitadel/zitadel/backend/v3/storage/database/repository"
|
||||
"github.com/zitadel/zitadel/internal/repository/permission"
|
||||
)
|
||||
|
||||
type administratorRolePermission struct {
|
||||
RoleName string `db:"role_name"`
|
||||
Permission string `db:"permission"`
|
||||
}
|
||||
|
||||
func TestAdministratorRolePermissionReducers(t *testing.T) {
|
||||
handler := &relationalTablesProjection{}
|
||||
rawTx, tx := getTransactions(t)
|
||||
t.Cleanup(func() {
|
||||
require.NoError(t, rawTx.Rollback())
|
||||
})
|
||||
|
||||
instanceID := seedAdministratorRolePermissions(t, tx)
|
||||
|
||||
repo := repository.AdministratorRoleRepository()
|
||||
|
||||
t.Run("added event inserts a permission row", func(t *testing.T) {
|
||||
event := permission.NewAddedEvent(t.Context(), permission.NewAggregate(instanceID), "ORG_OWNER", "org.read")
|
||||
require.True(t, callReduce(t, rawTx, handler, event))
|
||||
assert.Equal(t,
|
||||
[]administratorRolePermission{{RoleName: "ORG_OWNER", Permission: "org.read"}},
|
||||
listReducedAdministratorRolePermissions(t, tx),
|
||||
)
|
||||
})
|
||||
|
||||
t.Run("removed event deletes only the matching permission row", func(t *testing.T) {
|
||||
_, err := repo.AddPermissions(t.Context(), tx, instanceID, "INSTANCE_OWNER", "instance.read", "instance.write")
|
||||
require.NoError(t, err)
|
||||
|
||||
event := permission.NewRemovedEvent(t.Context(), permission.NewAggregate(instanceID), "INSTANCE_OWNER", "instance.read")
|
||||
require.True(t, callReduce(t, rawTx, handler, event))
|
||||
assert.Equal(t,
|
||||
[]administratorRolePermission{{RoleName: "INSTANCE_OWNER", Permission: "instance.write"}},
|
||||
listReducedAdministratorRolePermissions(t, tx, repo.RoleNameCondition(database.TextOperationEqual, "INSTANCE_OWNER")),
|
||||
)
|
||||
})
|
||||
}
|
||||
|
||||
func listReducedAdministratorRolePermissions(t *testing.T, tx database.QueryExecutor, conditions ...database.Condition) []administratorRolePermission {
|
||||
t.Helper()
|
||||
|
||||
builder := database.NewStatementBuilder(`SELECT role_name, permission FROM zitadel.administrator_role_permissions`)
|
||||
if len(conditions) > 0 {
|
||||
builder.WriteString(" WHERE ")
|
||||
database.And(conditions...).Write(builder)
|
||||
}
|
||||
builder.WriteString(" ORDER BY role_name, permission")
|
||||
|
||||
rows, err := tx.Query(t.Context(), builder.String(), builder.Args()...)
|
||||
require.NoError(t, err)
|
||||
|
||||
var result []*administratorRolePermission
|
||||
require.NoError(t, rows.(database.CollectableRows).Collect(&result))
|
||||
|
||||
out := make([]administratorRolePermission, len(result))
|
||||
for i, row := range result {
|
||||
out[i] = *row
|
||||
}
|
||||
return out
|
||||
}
|
||||
|
||||
func seedAdministratorRolePermissions(t *testing.T, tx database.QueryExecutor) string {
|
||||
t.Helper()
|
||||
|
||||
instanceID := fmt.Sprintf("instance-%d", time.Now().UnixNano())
|
||||
err := repository.InstanceRepository().Create(t.Context(), tx, &repoDomain.Instance{
|
||||
ID: instanceID,
|
||||
Name: "instance",
|
||||
DefaultOrgID: "default-org",
|
||||
IAMProjectID: "iam-project",
|
||||
ConsoleClientID: "console-client",
|
||||
ConsoleAppID: "console-app",
|
||||
DefaultLanguage: "en",
|
||||
})
|
||||
require.NoError(t, err)
|
||||
|
||||
return instanceID
|
||||
}
|
||||
@@ -8,6 +8,7 @@ import (
|
||||
"github.com/zitadel/zitadel/internal/repository/instance"
|
||||
"github.com/zitadel/zitadel/internal/repository/org"
|
||||
settings "github.com/zitadel/zitadel/internal/repository/organization_settings"
|
||||
"github.com/zitadel/zitadel/internal/repository/permission"
|
||||
"github.com/zitadel/zitadel/internal/repository/project"
|
||||
"github.com/zitadel/zitadel/internal/repository/session"
|
||||
"github.com/zitadel/zitadel/internal/repository/user"
|
||||
@@ -26,6 +27,19 @@ func (*relationalTablesProjection) Name() string {
|
||||
|
||||
func (p *relationalTablesProjection) Reducers() []handler.AggregateReducer {
|
||||
return []handler.AggregateReducer{
|
||||
{
|
||||
Aggregate: permission.AggregateType,
|
||||
EventReducers: []handler.EventReducer{
|
||||
{
|
||||
Event: permission.AddedType,
|
||||
Reduce: p.reduceAdministratorRolePermissionAdded,
|
||||
},
|
||||
{
|
||||
Event: permission.RemovedType,
|
||||
Reduce: p.reduceAdministratorRolePermissionRemoved,
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
Aggregate: instance.AggregateType,
|
||||
EventReducers: []handler.EventReducer{
|
||||
|
||||
Reference in New Issue
Block a user