mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-31 11:32:15 +00:00
feat: delete metadata on SetOrganizationMetadata api (#11790)
# Which Problems Are Solved Currently, to delete an Organization metadata key, callers must use a separate [DeleteMetadata](https://zitadel.com/docs/reference/api/org/zitadel.org.v2.OrganizationService.DeleteOrganizationMetadata) API. This increases the complexity on client-side for operations where metadata need to be synchronized. # How the Problems Are Solved Introduce deletion behavior to [SetOrganizationMetadata](https://zitadel.com/docs/reference/api/org/zitadel.org.v2.OrganizationService.SetOrganizationMetadata): When a metadata entry is passed with an empty value ("" / empty bytes): - If the key exists → delete the key - If the key does not exist → no-op (idempotent, no error) # Additional Changes n/a # Additional Context Relates to #11776 --------- Co-authored-by: Gayathri Vijayan <[email protected]> Co-authored-by: Gayathri Vijayan <[email protected]>
This commit is contained in:
Vitor Bari Buccianti
co-authored by
Gayathri Vijayan
Gayathri Vijayan
Gayathri Vijayan
Gayathri Vijayan
parent
8b90ddb0b5
commit
62cb5bbb83
@@ -4,6 +4,7 @@ package org_test
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/base64"
|
||||
"errors"
|
||||
"os"
|
||||
"slices"
|
||||
@@ -17,6 +18,7 @@ import (
|
||||
|
||||
"github.com/zitadel/zitadel/internal/integration"
|
||||
"github.com/zitadel/zitadel/pkg/grpc/admin"
|
||||
metadata "github.com/zitadel/zitadel/pkg/grpc/metadata/v2"
|
||||
"github.com/zitadel/zitadel/pkg/grpc/org/v2"
|
||||
"github.com/zitadel/zitadel/pkg/grpc/user/v2"
|
||||
)
|
||||
@@ -280,7 +282,7 @@ func TestServer_UpdateOrganization(t *testing.T) {
|
||||
name: "update org with non existent org id",
|
||||
ctx: Instance.WithAuthorizationToken(CTX, integration.UserTypeIAMOwner),
|
||||
req: &org.UpdateOrganizationRequest{
|
||||
OrganizationId: "non existant org id",
|
||||
OrganizationId: "non existent org id",
|
||||
// Name: "",
|
||||
},
|
||||
wantErr: true,
|
||||
@@ -1029,125 +1031,159 @@ func TestServer_ValidateOrganizationDomain(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestServer_SetOrganizationMetadata(t *testing.T) {
|
||||
orgs, _, _ := createOrgs(CTX, t, Client, 1)
|
||||
orgId := orgs[0].OrganizationId
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
ctx context.Context
|
||||
setupFunc func()
|
||||
orgId string
|
||||
key string
|
||||
value string
|
||||
setupFunc func(ctx context.Context, orgID string, req *org.SetOrganizationMetadataRequest)
|
||||
req *org.SetOrganizationMetadataRequest
|
||||
assert func(ttt *assert.CollectT, setMetadataResponse *org.SetOrganizationMetadataResponse, testStartTime time.Time, listMetadataResponse *org.ListOrganizationMetadataResponse)
|
||||
err error
|
||||
}{
|
||||
{
|
||||
name: "no permission",
|
||||
ctx: Instance.WithAuthorizationToken(CTX, integration.UserTypeOrgOwner),
|
||||
orgId: orgId,
|
||||
key: "key1",
|
||||
value: "value1",
|
||||
err: errors.New("membership not found"),
|
||||
name: "no permission",
|
||||
ctx: Instance.WithAuthorizationToken(CTX, integration.UserTypeOrgOwner),
|
||||
setupFunc: func(ctx context.Context, orgID string, req *org.SetOrganizationMetadataRequest) {
|
||||
req.OrganizationId = orgID
|
||||
},
|
||||
req: &org.SetOrganizationMetadataRequest{
|
||||
Metadata: []*org.Metadata{
|
||||
{Key: "key1", Value: []byte(base64.StdEncoding.EncodeToString([]byte("value1")))},
|
||||
},
|
||||
},
|
||||
err: errors.New("membership not found"),
|
||||
},
|
||||
{
|
||||
name: "set org metadata",
|
||||
ctx: Instance.WithAuthorizationToken(CTX, integration.UserTypeIAMOwner),
|
||||
orgId: orgId,
|
||||
key: "key1",
|
||||
value: "value1",
|
||||
name: "set org metadata",
|
||||
ctx: Instance.WithAuthorizationToken(CTX, integration.UserTypeIAMOwner),
|
||||
setupFunc: func(ctx context.Context, orgID string, req *org.SetOrganizationMetadataRequest) {
|
||||
req.OrganizationId = orgID
|
||||
},
|
||||
req: &org.SetOrganizationMetadataRequest{
|
||||
Metadata: []*org.Metadata{
|
||||
{Key: "key1", Value: []byte(base64.StdEncoding.EncodeToString([]byte("value1")))},
|
||||
},
|
||||
},
|
||||
assert: func(ttt *assert.CollectT, setMetadataResponse *org.SetOrganizationMetadataResponse, testStartTime time.Time, listMetadataResponse *org.ListOrganizationMetadataResponse) {
|
||||
assert.WithinRange(ttt, setMetadataResponse.GetSetDate().AsTime(), testStartTime, time.Now().UTC())
|
||||
|
||||
expectedMetadata := []*metadata.Metadata{
|
||||
{Key: "key1", Value: []byte(base64.StdEncoding.EncodeToString([]byte("value1")))},
|
||||
}
|
||||
integration.AssertMetadataEquals(ttt, expectedMetadata, listMetadataResponse.GetMetadata())
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "set org metadata on non existant org",
|
||||
ctx: Instance.WithAuthorizationToken(CTX, integration.UserTypeIAMOwner),
|
||||
orgId: "non existant orgid",
|
||||
key: "key2",
|
||||
value: "value2",
|
||||
err: errors.New("Organisation not found"),
|
||||
name: "set org metadata on non existent org",
|
||||
ctx: Instance.WithAuthorizationToken(CTX, integration.UserTypeIAMOwner),
|
||||
setupFunc: func(ctx context.Context, _ string, req *org.SetOrganizationMetadataRequest) {
|
||||
req.OrganizationId = "wrong-org-id"
|
||||
},
|
||||
req: &org.SetOrganizationMetadataRequest{
|
||||
Metadata: []*org.Metadata{
|
||||
{Key: "key1", Value: []byte(base64.StdEncoding.EncodeToString([]byte("updated-value1")))},
|
||||
},
|
||||
},
|
||||
err: errors.New("Organisation not found"),
|
||||
},
|
||||
{
|
||||
name: "update org metadata",
|
||||
ctx: Instance.WithAuthorizationToken(CTX, integration.UserTypeIAMOwner),
|
||||
setupFunc: func() {
|
||||
_, err := Client.SetOrganizationMetadata(CTX, &org.SetOrganizationMetadataRequest{
|
||||
OrganizationId: orgId,
|
||||
Metadata: []*org.Metadata{
|
||||
{
|
||||
Key: "key3",
|
||||
Value: []byte("value3"),
|
||||
},
|
||||
},
|
||||
})
|
||||
require.NoError(t, err)
|
||||
setupFunc: func(ctx context.Context, orgID string, req *org.SetOrganizationMetadataRequest) {
|
||||
req.OrganizationId = orgID
|
||||
Instance.SetOrganizationMetadata(ctx, orgID, "key1", "value1")
|
||||
},
|
||||
req: &org.SetOrganizationMetadataRequest{
|
||||
Metadata: []*org.Metadata{
|
||||
{Key: "key1", Value: []byte(base64.StdEncoding.EncodeToString([]byte("updated-value1")))},
|
||||
},
|
||||
},
|
||||
assert: func(ttt *assert.CollectT, setMetadataResponse *org.SetOrganizationMetadataResponse, testStartTime time.Time, listMetadataResponse *org.ListOrganizationMetadataResponse) {
|
||||
assert.WithinRange(ttt, setMetadataResponse.GetSetDate().AsTime(), testStartTime, time.Now().UTC())
|
||||
|
||||
expectedMetadata := []*metadata.Metadata{
|
||||
{Key: "key1", Value: []byte(base64.StdEncoding.EncodeToString([]byte("updated-value1")))},
|
||||
}
|
||||
integration.AssertMetadataEquals(ttt, expectedMetadata, listMetadataResponse.GetMetadata())
|
||||
},
|
||||
orgId: orgId,
|
||||
key: "key4",
|
||||
value: "value4",
|
||||
},
|
||||
{
|
||||
name: "update org metadata with same value",
|
||||
ctx: Instance.WithAuthorizationToken(CTX, integration.UserTypeIAMOwner),
|
||||
setupFunc: func() {
|
||||
_, err := Client.SetOrganizationMetadata(CTX, &org.SetOrganizationMetadataRequest{
|
||||
OrganizationId: orgId,
|
||||
Metadata: []*org.Metadata{
|
||||
{
|
||||
Key: "key5",
|
||||
Value: []byte("value5"),
|
||||
},
|
||||
},
|
||||
})
|
||||
require.NoError(t, err)
|
||||
setupFunc: func(ctx context.Context, orgID string, req *org.SetOrganizationMetadataRequest) {
|
||||
req.OrganizationId = orgID
|
||||
Instance.SetOrganizationMetadata(ctx, orgID, "key1", "value1")
|
||||
},
|
||||
req: &org.SetOrganizationMetadataRequest{
|
||||
Metadata: []*org.Metadata{
|
||||
{Key: "key1", Value: []byte(base64.StdEncoding.EncodeToString([]byte("value1")))},
|
||||
},
|
||||
},
|
||||
assert: func(ttt *assert.CollectT, setMetadataResponse *org.SetOrganizationMetadataResponse, testStartTime time.Time, listMetadataResponse *org.ListOrganizationMetadataResponse) {
|
||||
assert.True(ttt, setMetadataResponse.GetSetDate().AsTime().Before(testStartTime))
|
||||
|
||||
expectedMetadata := []*metadata.Metadata{
|
||||
{Key: "key1", Value: []byte(base64.StdEncoding.EncodeToString([]byte("value1")))},
|
||||
}
|
||||
integration.AssertMetadataEquals(ttt, expectedMetadata, listMetadataResponse.GetMetadata())
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "delete and update org metadata",
|
||||
ctx: Instance.WithAuthorizationToken(CTX, integration.UserTypeIAMOwner),
|
||||
setupFunc: func(ctx context.Context, orgID string, req *org.SetOrganizationMetadataRequest) {
|
||||
req.OrganizationId = orgID
|
||||
Instance.SetOrganizationMetadata(ctx, orgID, "key1", "value1")
|
||||
Instance.SetOrganizationMetadata(ctx, orgID, "key2", "value2")
|
||||
},
|
||||
req: &org.SetOrganizationMetadataRequest{
|
||||
Metadata: []*org.Metadata{
|
||||
{Key: "key1", Value: []byte(base64.StdEncoding.EncodeToString([]byte("updated-value1")))}, // updating
|
||||
{Key: "key2"}, // deleting
|
||||
{Key: "key3", Value: []byte(base64.StdEncoding.EncodeToString([]byte("value3")))}, // adding
|
||||
{Key: "key4"}, // deleting non-existent
|
||||
},
|
||||
},
|
||||
assert: func(ttt *assert.CollectT, setMetadataResponse *org.SetOrganizationMetadataResponse, testStartTime time.Time, listMetadataResponse *org.ListOrganizationMetadataResponse) {
|
||||
assert.WithinRange(ttt, setMetadataResponse.GetSetDate().AsTime(), testStartTime, time.Now().UTC())
|
||||
|
||||
expectedMetadata := []*metadata.Metadata{
|
||||
{Key: "key1", Value: []byte(base64.StdEncoding.EncodeToString([]byte("updated-value1")))},
|
||||
{Key: "key3", Value: []byte(base64.StdEncoding.EncodeToString([]byte("value3")))},
|
||||
}
|
||||
integration.AssertMetadataEquals(ttt, expectedMetadata, listMetadataResponse.GetMetadata())
|
||||
},
|
||||
orgId: orgId,
|
||||
key: "key5",
|
||||
value: "value5",
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
orgResponse := Instance.CreateOrganization(
|
||||
CTX,
|
||||
integration.OrganizationName(),
|
||||
integration.Email(),
|
||||
)
|
||||
|
||||
if tt.setupFunc != nil {
|
||||
tt.setupFunc()
|
||||
tt.setupFunc(tt.ctx, orgResponse.OrganizationId, tt.req)
|
||||
}
|
||||
got, err := Client.SetOrganizationMetadata(tt.ctx, &org.SetOrganizationMetadataRequest{
|
||||
OrganizationId: tt.orgId,
|
||||
Metadata: []*org.Metadata{
|
||||
{
|
||||
Key: tt.key,
|
||||
Value: []byte(tt.value),
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
testStartTime := time.Now().UTC()
|
||||
got, err := Client.SetOrganizationMetadata(tt.ctx, tt.req)
|
||||
if tt.err != nil {
|
||||
require.Contains(t, err.Error(), tt.err.Error())
|
||||
return
|
||||
}
|
||||
require.NoError(t, err)
|
||||
|
||||
// check details
|
||||
gotCD := got.GetSetDate().AsTime()
|
||||
now := time.Now()
|
||||
assert.WithinRange(t, gotCD, now.Add(-time.Minute), now.Add(time.Minute))
|
||||
|
||||
retryDuration, tick := integration.WaitForAndTickWithMaxDuration(CTX, 10*time.Minute)
|
||||
require.EventuallyWithT(t, func(ttt *assert.CollectT) {
|
||||
// check metadata
|
||||
listMetadataRes, err := Client.ListOrganizationMetadata(tt.ctx, &org.ListOrganizationMetadataRequest{
|
||||
OrganizationId: orgId,
|
||||
OrganizationId: orgResponse.OrganizationId,
|
||||
})
|
||||
require.NoError(ttt, err)
|
||||
foundMetadata := false
|
||||
foundMetadataKeyCount := 0
|
||||
for _, res := range listMetadataRes.Metadata {
|
||||
if res.Key == tt.key {
|
||||
foundMetadataKeyCount += 1
|
||||
}
|
||||
if res.Key == tt.key &&
|
||||
string(res.Value) == tt.value {
|
||||
foundMetadata = true
|
||||
}
|
||||
}
|
||||
require.True(ttt, foundMetadata, "unable to find added metadata")
|
||||
require.Equal(ttt, 1, foundMetadataKeyCount, "same metadata key found multiple times")
|
||||
tt.assert(ttt, got, testStartTime, listMetadataRes)
|
||||
}, retryDuration, tick, "timeout waiting for expected organizations being created")
|
||||
})
|
||||
}
|
||||
@@ -1242,7 +1278,7 @@ func TestServer_DeleteOrganizationMetadata(t *testing.T) {
|
||||
{
|
||||
name: "delete org metadata for org that does not exist",
|
||||
ctx: Instance.WithAuthorizationToken(CTX, integration.UserTypeIAMOwner),
|
||||
orgId: "non existant org id",
|
||||
orgId: "non existent org id",
|
||||
metadataToDelete: []struct{ key, value string }{
|
||||
{
|
||||
key: "key4",
|
||||
|
||||
@@ -54,7 +54,7 @@ func TestServer_SetUserMetadata(t *testing.T) {
|
||||
expectedMetadata := []*metadata.Metadata{
|
||||
{Key: "key1", Value: []byte(base64.StdEncoding.EncodeToString([]byte("value1")))},
|
||||
}
|
||||
assertMetadataEquals(t, expectedMetadata, getResponse.GetMetadata())
|
||||
integration.AssertMetadataEquals(t, expectedMetadata, getResponse.GetMetadata())
|
||||
},
|
||||
},
|
||||
{
|
||||
@@ -78,7 +78,7 @@ func TestServer_SetUserMetadata(t *testing.T) {
|
||||
{Key: "key2", Value: []byte(base64.StdEncoding.EncodeToString([]byte("value2")))},
|
||||
{Key: "key3", Value: []byte(base64.StdEncoding.EncodeToString([]byte("value3")))},
|
||||
}
|
||||
assertMetadataEquals(t, expectedMetadata, getResponse.GetMetadata())
|
||||
integration.AssertMetadataEquals(t, expectedMetadata, getResponse.GetMetadata())
|
||||
},
|
||||
},
|
||||
{
|
||||
@@ -106,7 +106,7 @@ func TestServer_SetUserMetadata(t *testing.T) {
|
||||
expectedMetadata := []*metadata.Metadata{
|
||||
{Key: "key1", Value: []byte(base64.StdEncoding.EncodeToString([]byte("value2")))},
|
||||
}
|
||||
assertMetadataEquals(t, expectedMetadata, getResponse.GetMetadata())
|
||||
integration.AssertMetadataEquals(t, expectedMetadata, getResponse.GetMetadata())
|
||||
},
|
||||
},
|
||||
{
|
||||
@@ -126,7 +126,7 @@ func TestServer_SetUserMetadata(t *testing.T) {
|
||||
expectedMetadata := []*metadata.Metadata{
|
||||
{Key: "key1", Value: []byte(base64.StdEncoding.EncodeToString([]byte("value1")))},
|
||||
}
|
||||
assertMetadataEquals(t, expectedMetadata, getResponse.GetMetadata())
|
||||
integration.AssertMetadataEquals(t, expectedMetadata, getResponse.GetMetadata())
|
||||
},
|
||||
},
|
||||
{
|
||||
@@ -164,7 +164,7 @@ func TestServer_SetUserMetadata(t *testing.T) {
|
||||
expectedMetadata := []*metadata.Metadata{
|
||||
{Key: "key1", Value: []byte(base64.StdEncoding.EncodeToString([]byte("value1")))},
|
||||
}
|
||||
assertMetadataEquals(t, expectedMetadata, getResponse.GetMetadata())
|
||||
integration.AssertMetadataEquals(t, expectedMetadata, getResponse.GetMetadata())
|
||||
},
|
||||
},
|
||||
{
|
||||
@@ -187,7 +187,7 @@ func TestServer_SetUserMetadata(t *testing.T) {
|
||||
expectedMetadata := []*metadata.Metadata{
|
||||
{Key: "key2", Value: []byte(base64.StdEncoding.EncodeToString([]byte("updated")))},
|
||||
}
|
||||
assertMetadataEquals(t, expectedMetadata, getResponse.GetMetadata())
|
||||
integration.AssertMetadataEquals(t, expectedMetadata, getResponse.GetMetadata())
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
@@ -3590,7 +3590,7 @@ func TestServer_CreateUser_And_Compare(t *testing.T) {
|
||||
{Key: "key1", Value: []byte(base64.StdEncoding.EncodeToString([]byte("value1")))},
|
||||
{Key: "key2", Value: []byte(base64.StdEncoding.EncodeToString([]byte("value2")))},
|
||||
}
|
||||
assertMetadataEquals(t, expectedMetadata, getMetadataResponse.GetMetadata())
|
||||
integration.AssertMetadataEquals(t, expectedMetadata, getMetadataResponse.GetMetadata())
|
||||
},
|
||||
}
|
||||
},
|
||||
@@ -3627,7 +3627,7 @@ func TestServer_CreateUser_And_Compare(t *testing.T) {
|
||||
expectedMetadata := []*metadata.Metadata{
|
||||
{Key: "key1", Value: []byte(base64.StdEncoding.EncodeToString([]byte("value1")))},
|
||||
}
|
||||
assertMetadataEquals(t, expectedMetadata, getMetadataResponse.GetMetadata())
|
||||
integration.AssertMetadataEquals(t, expectedMetadata, getMetadataResponse.GetMetadata())
|
||||
},
|
||||
}
|
||||
},
|
||||
@@ -3712,7 +3712,7 @@ func TestServer_CreateUser_And_Compare(t *testing.T) {
|
||||
{Key: "key1", Value: []byte(base64.StdEncoding.EncodeToString([]byte("value1")))},
|
||||
{Key: "key2", Value: []byte(base64.StdEncoding.EncodeToString([]byte("value2")))},
|
||||
}
|
||||
assertMetadataEquals(t, expectedMetadata, getMetadataResponse.GetMetadata())
|
||||
integration.AssertMetadataEquals(t, expectedMetadata, getMetadataResponse.GetMetadata())
|
||||
},
|
||||
}
|
||||
},
|
||||
@@ -3805,19 +3805,6 @@ func TestServer_CreateUser_And_Compare(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func getMetadataMap(metadata []*metadata.Metadata) map[string][]byte {
|
||||
metadataByKey := make(map[string][]byte, len(metadata))
|
||||
for _, md := range metadata {
|
||||
metadataByKey[md.Key] = md.Value
|
||||
}
|
||||
return metadataByKey
|
||||
}
|
||||
|
||||
func assertMetadataEquals(t *testing.T, expected []*metadata.Metadata, actual []*metadata.Metadata) {
|
||||
assert.Equal(t, len(expected), len(actual))
|
||||
assert.Equal(t, getMetadataMap(expected), getMetadataMap(actual))
|
||||
}
|
||||
|
||||
func TestServer_CreateUser_Permission(t *testing.T) {
|
||||
newOrgOwnerEmail := integration.Email()
|
||||
newOrg := Instance.CreateOrganization(IamCTX, integration.OrganizationName(), newOrgOwnerEmail)
|
||||
@@ -4615,7 +4602,7 @@ func TestServer_UpdateUser_And_Compare(t *testing.T) {
|
||||
{Key: "key2", Value: []byte("value2")},
|
||||
{Key: "key3", Value: []byte("value3")},
|
||||
}
|
||||
assertMetadataEquals(t, expectedMetadata, listMetadataResponse.GetMetadata())
|
||||
integration.AssertMetadataEquals(t, expectedMetadata, listMetadataResponse.GetMetadata())
|
||||
},
|
||||
}
|
||||
},
|
||||
@@ -4683,7 +4670,7 @@ func TestServer_UpdateUser_And_Compare(t *testing.T) {
|
||||
{Key: "key1", Value: []byte("updated_value1")},
|
||||
{Key: "key4", Value: []byte("value4")},
|
||||
}
|
||||
assertMetadataEquals(t, expectedMetadata, listMetadataResponse.GetMetadata())
|
||||
integration.AssertMetadataEquals(t, expectedMetadata, listMetadataResponse.GetMetadata())
|
||||
},
|
||||
}
|
||||
},
|
||||
@@ -4740,7 +4727,7 @@ func TestServer_UpdateUser_And_Compare(t *testing.T) {
|
||||
{Key: "key2", Value: []byte("value2")},
|
||||
{Key: "key3", Value: []byte("value3")},
|
||||
}
|
||||
assertMetadataEquals(t, expectedMetadata, listMetadataResponse.GetMetadata())
|
||||
integration.AssertMetadataEquals(t, expectedMetadata, listMetadataResponse.GetMetadata())
|
||||
},
|
||||
}
|
||||
},
|
||||
@@ -4802,7 +4789,7 @@ func TestServer_UpdateUser_And_Compare(t *testing.T) {
|
||||
{Key: "key1", Value: []byte("updated_value1")},
|
||||
{Key: "key4", Value: []byte("value4")},
|
||||
}
|
||||
assertMetadataEquals(t, expectedMetadata, listMetadataResponse.GetMetadata())
|
||||
integration.AssertMetadataEquals(t, expectedMetadata, listMetadataResponse.GetMetadata())
|
||||
},
|
||||
}
|
||||
},
|
||||
|
||||
Reference in New Issue
Block a user