fix: update userschema api to v3alpha definition (#8511)

# Which Problems Are Solved

UserSchema API is currently not completely as defined for v3alpha.

# How the Problems Are Solved

Update the protos and integration tests.

# Additional Changes

None

# Additional Context

None
This commit is contained in:
Stefan Benz
2024-09-02 13:24:15 +02:00
committed by GitHub
parent bbdf9dbb20
commit a9eb50321c
7 changed files with 242 additions and 212 deletions

View File

@@ -35,7 +35,7 @@ func (s *Server) SearchUserSchemas(ctx context.Context, req *schema.SearchUserSc
}, nil
}
func (s *Server) GetUserSchemaByID(ctx context.Context, req *schema.GetUserSchemaByIDRequest) (*schema.GetUserSchemaByIDResponse, error) {
func (s *Server) GetUserSchema(ctx context.Context, req *schema.GetUserSchemaRequest) (*schema.GetUserSchemaResponse, error) {
if err := checkUserSchemaEnabled(ctx); err != nil {
return nil, err
}
@@ -47,8 +47,8 @@ func (s *Server) GetUserSchemaByID(ctx context.Context, req *schema.GetUserSchem
if err != nil {
return nil, err
}
return &schema.GetUserSchemaByIDResponse{
Schema: userSchema,
return &schema.GetUserSchemaResponse{
UserSchema: userSchema,
}, nil
}
@@ -94,8 +94,8 @@ func userSchemaFieldNameToSortingColumn(field *schema.FieldName) query.Column {
}
}
func userSchemasToPb(schemas []*query.UserSchema) (_ []*schema.UserSchema, err error) {
userSchemas := make([]*schema.UserSchema, len(schemas))
func userSchemasToPb(schemas []*query.UserSchema) (_ []*schema.GetUserSchema, err error) {
userSchemas := make([]*schema.GetUserSchema, len(schemas))
for i, userSchema := range schemas {
userSchemas[i], err = userSchemaToPb(userSchema)
if err != nil {
@@ -105,18 +105,22 @@ func userSchemasToPb(schemas []*query.UserSchema) (_ []*schema.UserSchema, err e
return userSchemas, nil
}
func userSchemaToPb(userSchema *query.UserSchema) (*schema.UserSchema, error) {
func userSchemaToPb(userSchema *query.UserSchema) (*schema.GetUserSchema, error) {
s := new(structpb.Struct)
if err := s.UnmarshalJSON(userSchema.Schema); err != nil {
return nil, err
}
return &schema.UserSchema{
Details: resource_object.DomainToDetailsPb(&userSchema.ObjectDetails, object.OwnerType_OWNER_TYPE_INSTANCE, userSchema.ResourceOwner),
Type: userSchema.Type,
State: userSchemaStateToPb(userSchema.State),
Revision: userSchema.Revision,
Schema: s,
PossibleAuthenticators: authenticatorTypesToPb(userSchema.PossibleAuthenticators),
return &schema.GetUserSchema{
Details: resource_object.DomainToDetailsPb(&userSchema.ObjectDetails, object.OwnerType_OWNER_TYPE_INSTANCE, userSchema.ResourceOwner),
Config: &schema.UserSchema{
Type: userSchema.Type,
DataType: &schema.UserSchema_Schema{
Schema: s,
},
PossibleAuthenticators: authenticatorTypesToPb(userSchema.PossibleAuthenticators),
},
State: userSchemaStateToPb(userSchema.State),
Revision: userSchema.Revision,
}, nil
}

View File

@@ -4,10 +4,10 @@ package userschema_test
import (
"context"
"fmt"
"testing"
"time"
"github.com/brianvoe/gofakeit/v6"
"github.com/muhlemmer/gu"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
@@ -69,7 +69,7 @@ func TestServer_ListUserSchemas(t *testing.T) {
TotalResult: 0,
AppliedLimit: 100,
},
Result: []*schema.UserSchema{},
Result: []*schema.GetUserSchema{},
},
},
{
@@ -78,7 +78,7 @@ func TestServer_ListUserSchemas(t *testing.T) {
ctx: IAMOwnerCTX,
req: &schema.SearchUserSchemasRequest{},
prepare: func(request *schema.SearchUserSchemasRequest, resp *schema.SearchUserSchemasResponse) error {
schemaType := fmt.Sprint(time.Now().UnixNano() + 1)
schemaType := gofakeit.Name()
createResp := Tester.CreateUserSchemaEmptyWithType(IAMOwnerCTX, schemaType)
request.Filters = []*schema.SearchFilter{
{
@@ -90,7 +90,7 @@ func TestServer_ListUserSchemas(t *testing.T) {
},
},
}
resp.Result[0].Type = schemaType
resp.Result[0].Config.Type = schemaType
resp.Result[0].Details = createResp.GetDetails()
// as schema is freshly created, the changed date is the created date
resp.Result[0].Details.Created = resp.Result[0].Details.GetChanged()
@@ -103,12 +103,17 @@ func TestServer_ListUserSchemas(t *testing.T) {
TotalResult: 1,
AppliedLimit: 100,
},
Result: []*schema.UserSchema{
Result: []*schema.GetUserSchema{
{
State: schema.State_STATE_ACTIVE,
Revision: 1,
Schema: userSchema,
PossibleAuthenticators: nil,
State: schema.State_STATE_ACTIVE,
Revision: 1,
Config: &schema.UserSchema{
Type: "",
DataType: &schema.UserSchema_Schema{
Schema: userSchema,
},
PossibleAuthenticators: nil,
},
},
},
},
@@ -119,7 +124,7 @@ func TestServer_ListUserSchemas(t *testing.T) {
ctx: IAMOwnerCTX,
req: &schema.SearchUserSchemasRequest{},
prepare: func(request *schema.SearchUserSchemasRequest, resp *schema.SearchUserSchemasResponse) error {
schemaType := fmt.Sprint(time.Now().UnixNano())
schemaType := gofakeit.Name()
schemaType1 := schemaType + "_1"
schemaType2 := schemaType + "_2"
createResp := Tester.CreateUserSchemaEmptyWithType(IAMOwnerCTX, schemaType1)
@@ -138,9 +143,9 @@ func TestServer_ListUserSchemas(t *testing.T) {
},
}
resp.Result[0].Type = schemaType1
resp.Result[0].Config.Type = schemaType1
resp.Result[0].Details = createResp.GetDetails()
resp.Result[1].Type = schemaType2
resp.Result[1].Config.Type = schemaType2
resp.Result[1].Details = createResp2.GetDetails()
return nil
},
@@ -150,18 +155,24 @@ func TestServer_ListUserSchemas(t *testing.T) {
TotalResult: 2,
AppliedLimit: 100,
},
Result: []*schema.UserSchema{
Result: []*schema.GetUserSchema{
{
State: schema.State_STATE_ACTIVE,
Revision: 1,
Schema: userSchema,
PossibleAuthenticators: nil,
State: schema.State_STATE_ACTIVE,
Revision: 1,
Config: &schema.UserSchema{
DataType: &schema.UserSchema_Schema{
Schema: userSchema,
},
},
},
{
State: schema.State_STATE_ACTIVE,
Revision: 1,
Schema: userSchema,
PossibleAuthenticators: nil,
State: schema.State_STATE_ACTIVE,
Revision: 1,
Config: &schema.UserSchema{
DataType: &schema.UserSchema_Schema{
Schema: userSchema,
},
},
},
},
},
@@ -203,7 +214,7 @@ func TestServer_ListUserSchemas(t *testing.T) {
}
}
func TestServer_GetUserSchemaByID(t *testing.T) {
func TestServer_GetUserSchema(t *testing.T) {
ensureFeatureEnabled(t, IAMOwnerCTX)
userSchema := new(structpb.Struct)
@@ -215,22 +226,22 @@ func TestServer_GetUserSchemaByID(t *testing.T) {
require.NoError(t, err)
type args struct {
ctx context.Context
req *schema.GetUserSchemaByIDRequest
prepare func(request *schema.GetUserSchemaByIDRequest, resp *schema.GetUserSchemaByIDResponse) error
req *schema.GetUserSchemaRequest
prepare func(request *schema.GetUserSchemaRequest, resp *schema.GetUserSchemaResponse) error
}
tests := []struct {
name string
args args
want *schema.GetUserSchemaByIDResponse
want *schema.GetUserSchemaResponse
wantErr bool
}{
{
name: "missing permission",
args: args{
ctx: Tester.WithAuthorization(context.Background(), integration.OrgOwner),
req: &schema.GetUserSchemaByIDRequest{},
prepare: func(request *schema.GetUserSchemaByIDRequest, resp *schema.GetUserSchemaByIDResponse) error {
schemaType := fmt.Sprint(time.Now().UnixNano() + 1)
req: &schema.GetUserSchemaRequest{},
prepare: func(request *schema.GetUserSchemaRequest, resp *schema.GetUserSchemaResponse) error {
schemaType := gofakeit.Name()
createResp := Tester.CreateUserSchemaEmptyWithType(IAMOwnerCTX, schemaType)
request.Id = createResp.GetDetails().GetId()
return nil
@@ -242,7 +253,7 @@ func TestServer_GetUserSchemaByID(t *testing.T) {
name: "not existing, error",
args: args{
ctx: IAMOwnerCTX,
req: &schema.GetUserSchemaByIDRequest{
req: &schema.GetUserSchemaRequest{
Id: "notexisting",
},
},
@@ -252,23 +263,26 @@ func TestServer_GetUserSchemaByID(t *testing.T) {
name: "get, ok",
args: args{
ctx: IAMOwnerCTX,
req: &schema.GetUserSchemaByIDRequest{},
prepare: func(request *schema.GetUserSchemaByIDRequest, resp *schema.GetUserSchemaByIDResponse) error {
schemaType := fmt.Sprint(time.Now().UnixNano() + 1)
req: &schema.GetUserSchemaRequest{},
prepare: func(request *schema.GetUserSchemaRequest, resp *schema.GetUserSchemaResponse) error {
schemaType := gofakeit.Name()
createResp := Tester.CreateUserSchemaEmptyWithType(IAMOwnerCTX, schemaType)
request.Id = createResp.GetDetails().GetId()
resp.Schema.Type = schemaType
resp.Schema.Details = createResp.GetDetails()
resp.UserSchema.Config.Type = schemaType
resp.UserSchema.Details = createResp.GetDetails()
return nil
},
},
want: &schema.GetUserSchemaByIDResponse{
Schema: &schema.UserSchema{
State: schema.State_STATE_ACTIVE,
Revision: 1,
Schema: userSchema,
PossibleAuthenticators: nil,
want: &schema.GetUserSchemaResponse{
UserSchema: &schema.GetUserSchema{
State: schema.State_STATE_ACTIVE,
Revision: 1,
Config: &schema.UserSchema{
DataType: &schema.UserSchema_Schema{
Schema: userSchema,
},
},
},
},
},
@@ -286,16 +300,17 @@ func TestServer_GetUserSchemaByID(t *testing.T) {
}
require.EventuallyWithT(t, func(ttt *assert.CollectT) {
got, err := Client.GetUserSchemaByID(tt.args.ctx, tt.args.req)
got, err := Client.GetUserSchema(tt.args.ctx, tt.args.req)
if tt.wantErr {
require.Error(ttt, err)
return
assert.Error(t, err, "Error: "+err.Error())
} else {
assert.NoError(t, err)
wantSchema := tt.want.GetUserSchema()
gotSchema := got.GetUserSchema()
integration.AssertResourceDetails(t, wantSchema.GetDetails(), gotSchema.GetDetails())
tt.want.UserSchema.Details = got.GetUserSchema().GetDetails()
grpc.AllFieldsEqual(t, tt.want.ProtoReflect(), got.ProtoReflect(), grpc.CustomMappers)
}
assert.NoError(ttt, err)
integration.AssertResourceDetails(t, tt.want.GetSchema().GetDetails(), got.GetSchema().GetDetails())
tt.want.Schema.Details = got.GetSchema().GetDetails()
grpc.AllFieldsEqual(t, tt.want.ProtoReflect(), got.ProtoReflect(), grpc.CustomMappers)
}, retryDuration, time.Millisecond*100, "timeout waiting for expected user schema result")
})
}

View File

@@ -3,6 +3,8 @@ package userschema
import (
"context"
"github.com/muhlemmer/gu"
"github.com/zitadel/zitadel/internal/api/authz"
resource_object "github.com/zitadel/zitadel/internal/api/grpc/resources/object/v3alpha"
"github.com/zitadel/zitadel/internal/command"
@@ -102,20 +104,28 @@ func createUserSchemaToCommand(req *schema.CreateUserSchemaRequest, resourceOwne
}
func patchUserSchemaToCommand(req *schema.PatchUserSchemaRequest, resourceOwner string) (*command.ChangeUserSchema, error) {
schema, err := req.GetSchema().MarshalJSON()
schema, err := req.GetUserSchema().GetSchema().MarshalJSON()
if err != nil {
return nil, err
}
var ty *string
if req.GetUserSchema() != nil && req.GetUserSchema().GetType() != "" {
ty = gu.Ptr(req.GetUserSchema().GetType())
}
return &command.ChangeUserSchema{
ID: req.GetId(),
ResourceOwner: resourceOwner,
Type: req.Type,
Type: ty,
Schema: schema,
PossibleAuthenticators: authenticatorsToDomain(req.GetPossibleAuthenticators()),
PossibleAuthenticators: authenticatorsToDomain(req.GetUserSchema().GetPossibleAuthenticators()),
}, nil
}
func authenticatorsToDomain(authenticators []schema.AuthenticatorType) []domain.AuthenticatorType {
if authenticators == nil {
return nil
}
types := make([]domain.AuthenticatorType, len(authenticators))
for i, authenticator := range authenticators {
types[i] = authenticatorTypeToDomain(authenticator)

View File

@@ -4,9 +4,7 @@ package userschema_test
import (
"context"
"fmt"
"testing"
"time"
"github.com/brianvoe/gofakeit/v6"
"github.com/muhlemmer/gu"
@@ -34,7 +32,7 @@ func TestServer_CreateUserSchema(t *testing.T) {
name: "missing permission, error",
ctx: Tester.WithAuthorization(context.Background(), integration.OrgOwner),
req: &schema.CreateUserSchemaRequest{
UserSchema: &schema.CreateUserSchema{
UserSchema: &schema.UserSchema{
Type: gofakeit.Name(),
},
},
@@ -44,7 +42,7 @@ func TestServer_CreateUserSchema(t *testing.T) {
name: "empty type",
ctx: IAMOwnerCTX,
req: &schema.CreateUserSchemaRequest{
UserSchema: &schema.CreateUserSchema{
UserSchema: &schema.UserSchema{
Type: "",
},
},
@@ -54,7 +52,7 @@ func TestServer_CreateUserSchema(t *testing.T) {
name: "empty schema, error",
ctx: IAMOwnerCTX,
req: &schema.CreateUserSchemaRequest{
UserSchema: &schema.CreateUserSchema{
UserSchema: &schema.UserSchema{
Type: gofakeit.Name(),
},
},
@@ -64,9 +62,9 @@ func TestServer_CreateUserSchema(t *testing.T) {
name: "invalid schema, error",
ctx: IAMOwnerCTX,
req: &schema.CreateUserSchemaRequest{
UserSchema: &schema.CreateUserSchema{
UserSchema: &schema.UserSchema{
Type: gofakeit.Name(),
DataType: &schema.CreateUserSchema_Schema{
DataType: &schema.UserSchema_Schema{
Schema: func() *structpb.Struct {
s := new(structpb.Struct)
err := s.UnmarshalJSON([]byte(`
@@ -95,9 +93,9 @@ func TestServer_CreateUserSchema(t *testing.T) {
name: "no authenticators, ok",
ctx: IAMOwnerCTX,
req: &schema.CreateUserSchemaRequest{
UserSchema: &schema.CreateUserSchema{
UserSchema: &schema.UserSchema{
Type: gofakeit.Name(),
DataType: &schema.CreateUserSchema_Schema{
DataType: &schema.UserSchema_Schema{
Schema: func() *structpb.Struct {
s := new(structpb.Struct)
err := s.UnmarshalJSON([]byte(`
@@ -134,9 +132,9 @@ func TestServer_CreateUserSchema(t *testing.T) {
name: "invalid authenticator, error",
ctx: IAMOwnerCTX,
req: &schema.CreateUserSchemaRequest{
UserSchema: &schema.CreateUserSchema{
UserSchema: &schema.UserSchema{
Type: gofakeit.Name(),
DataType: &schema.CreateUserSchema_Schema{
DataType: &schema.UserSchema_Schema{
Schema: func() *structpb.Struct {
s := new(structpb.Struct)
err := s.UnmarshalJSON([]byte(`
@@ -168,9 +166,9 @@ func TestServer_CreateUserSchema(t *testing.T) {
name: "with authenticator, ok",
ctx: IAMOwnerCTX,
req: &schema.CreateUserSchemaRequest{
UserSchema: &schema.CreateUserSchema{
UserSchema: &schema.UserSchema{
Type: gofakeit.Name(),
DataType: &schema.CreateUserSchema_Schema{
DataType: &schema.UserSchema_Schema{
Schema: func() *structpb.Struct {
s := new(structpb.Struct)
err := s.UnmarshalJSON([]byte(`
@@ -210,9 +208,9 @@ func TestServer_CreateUserSchema(t *testing.T) {
name: "with invalid permission, error",
ctx: IAMOwnerCTX,
req: &schema.CreateUserSchemaRequest{
UserSchema: &schema.CreateUserSchema{
UserSchema: &schema.UserSchema{
Type: gofakeit.Name(),
DataType: &schema.CreateUserSchema_Schema{
DataType: &schema.UserSchema_Schema{
Schema: func() *structpb.Struct {
s := new(structpb.Struct)
err := s.UnmarshalJSON([]byte(`
@@ -245,9 +243,9 @@ func TestServer_CreateUserSchema(t *testing.T) {
name: "with valid permission, ok",
ctx: IAMOwnerCTX,
req: &schema.CreateUserSchemaRequest{
UserSchema: &schema.CreateUserSchema{
UserSchema: &schema.UserSchema{
Type: gofakeit.Name(),
DataType: &schema.CreateUserSchema_Schema{
DataType: &schema.UserSchema_Schema{
Schema: func() *structpb.Struct {
s := new(structpb.Struct)
err := s.UnmarshalJSON([]byte(`
@@ -326,7 +324,9 @@ func TestServer_UpdateUserSchema(t *testing.T) {
args: args{
ctx: Tester.WithAuthorization(context.Background(), integration.OrgOwner),
req: &schema.PatchUserSchemaRequest{
Type: gu.Ptr(fmt.Sprint(time.Now().UnixNano() + 1)),
UserSchema: &schema.PatchUserSchema{
Type: gu.Ptr(gofakeit.Name()),
},
},
},
wantErr: true,
@@ -364,7 +364,9 @@ func TestServer_UpdateUserSchema(t *testing.T) {
args: args{
ctx: IAMOwnerCTX,
req: &schema.PatchUserSchemaRequest{
Type: gu.Ptr(""),
UserSchema: &schema.PatchUserSchema{
Type: gu.Ptr(""),
},
},
},
wantErr: true,
@@ -379,7 +381,9 @@ func TestServer_UpdateUserSchema(t *testing.T) {
args: args{
ctx: IAMOwnerCTX,
req: &schema.PatchUserSchemaRequest{
Type: gu.Ptr(fmt.Sprint(time.Now().UnixNano() + 1)),
UserSchema: &schema.PatchUserSchema{
Type: gu.Ptr(gofakeit.Name()),
},
},
},
want: &schema.PatchUserSchemaResponse{
@@ -402,7 +406,9 @@ func TestServer_UpdateUserSchema(t *testing.T) {
args: args{
ctx: IAMOwnerCTX,
req: &schema.PatchUserSchemaRequest{
DataType: &schema.PatchUserSchemaRequest_Schema{},
UserSchema: &schema.PatchUserSchema{
DataType: &schema.PatchUserSchema_Schema{},
},
},
},
want: &schema.PatchUserSchemaResponse{
@@ -425,10 +431,11 @@ func TestServer_UpdateUserSchema(t *testing.T) {
args: args{
ctx: IAMOwnerCTX,
req: &schema.PatchUserSchemaRequest{
DataType: &schema.PatchUserSchemaRequest_Schema{
Schema: func() *structpb.Struct {
s := new(structpb.Struct)
err := s.UnmarshalJSON([]byte(`
UserSchema: &schema.PatchUserSchema{
DataType: &schema.PatchUserSchema_Schema{
Schema: func() *structpb.Struct {
s := new(structpb.Struct)
err := s.UnmarshalJSON([]byte(`
{
"$schema": "urn:zitadel:schema:v1",
"type": "object",
@@ -443,9 +450,10 @@ func TestServer_UpdateUserSchema(t *testing.T) {
}
}
`))
require.NoError(t, err)
return s
}(),
require.NoError(t, err)
return s
}(),
},
},
},
},
@@ -461,10 +469,11 @@ func TestServer_UpdateUserSchema(t *testing.T) {
args: args{
ctx: IAMOwnerCTX,
req: &schema.PatchUserSchemaRequest{
DataType: &schema.PatchUserSchemaRequest_Schema{
Schema: func() *structpb.Struct {
s := new(structpb.Struct)
err := s.UnmarshalJSON([]byte(`
UserSchema: &schema.PatchUserSchema{
DataType: &schema.PatchUserSchema_Schema{
Schema: func() *structpb.Struct {
s := new(structpb.Struct)
err := s.UnmarshalJSON([]byte(`
{
"$schema": "urn:zitadel:schema:v1",
"type": "object",
@@ -479,9 +488,10 @@ func TestServer_UpdateUserSchema(t *testing.T) {
"required": ["name"]
}
`))
require.NoError(t, err)
return s
}(),
require.NoError(t, err)
return s
}(),
},
},
},
},
@@ -505,8 +515,10 @@ func TestServer_UpdateUserSchema(t *testing.T) {
args: args{
ctx: IAMOwnerCTX,
req: &schema.PatchUserSchemaRequest{
PossibleAuthenticators: []schema.AuthenticatorType{
schema.AuthenticatorType_AUTHENTICATOR_TYPE_UNSPECIFIED,
UserSchema: &schema.PatchUserSchema{
PossibleAuthenticators: []schema.AuthenticatorType{
schema.AuthenticatorType_AUTHENTICATOR_TYPE_UNSPECIFIED,
},
},
},
},
@@ -522,8 +534,10 @@ func TestServer_UpdateUserSchema(t *testing.T) {
args: args{
ctx: IAMOwnerCTX,
req: &schema.PatchUserSchemaRequest{
PossibleAuthenticators: []schema.AuthenticatorType{
schema.AuthenticatorType_AUTHENTICATOR_TYPE_USERNAME,
UserSchema: &schema.PatchUserSchema{
PossibleAuthenticators: []schema.AuthenticatorType{
schema.AuthenticatorType_AUTHENTICATOR_TYPE_USERNAME,
},
},
},
},
@@ -551,7 +565,9 @@ func TestServer_UpdateUserSchema(t *testing.T) {
args: args{
ctx: IAMOwnerCTX,
req: &schema.PatchUserSchemaRequest{
Type: gu.Ptr(fmt.Sprint(time.Now().UnixNano() + 1)),
UserSchema: &schema.PatchUserSchema{
Type: gu.Ptr(gofakeit.Name()),
},
},
},
wantErr: true,