mirror of
https://github.com/zitadel/zitadel.git
synced 2025-07-13 10:48:32 +00:00

# Which Problems Are Solved This pull request addresses a significant gap in the user service v2 API, which currently lacks methods for managing machine users. # How the Problems Are Solved This PR adds new API endpoints to the user service v2 to manage machine users including their secret, keys and personal access tokens. Additionally, there's now a CreateUser and UpdateUser endpoints which allow to create either a human or machine user and update them. The existing `CreateHumanUser` endpoint has been deprecated along the corresponding management service endpoints. For details check the additional context section. # Additional Context - Closes https://github.com/zitadel/zitadel/issues/9349 ## More details - API changes: https://github.com/zitadel/zitadel/pull/9680 - Implementation: https://github.com/zitadel/zitadel/pull/9763 - Tests: https://github.com/zitadel/zitadel/pull/9771 ## Follow-ups - Metadata: support managing user metadata using resource API https://github.com/zitadel/zitadel/pull/10005 - Machine token type: support managing the machine token type (migrate to new enum with zero value unspecified?) --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Livio Spring <livio.a@gmail.com>
255 lines
6.1 KiB
Go
255 lines
6.1 KiB
Go
package user
|
|
|
|
import (
|
|
"fmt"
|
|
"testing"
|
|
|
|
"github.com/google/go-cmp/cmp"
|
|
"github.com/google/go-cmp/cmp/cmpopts"
|
|
"github.com/muhlemmer/gu"
|
|
"github.com/stretchr/testify/assert"
|
|
"golang.org/x/text/language"
|
|
|
|
"github.com/zitadel/zitadel/internal/command"
|
|
"github.com/zitadel/zitadel/internal/domain"
|
|
"github.com/zitadel/zitadel/pkg/grpc/user/v2"
|
|
)
|
|
|
|
func Test_patchHumanUserToCommand(t *testing.T) {
|
|
type args struct {
|
|
userId string
|
|
userName *string
|
|
human *user.UpdateUserRequest_Human
|
|
}
|
|
tests := []struct {
|
|
name string
|
|
args args
|
|
want *command.ChangeHuman
|
|
wantErr assert.ErrorAssertionFunc
|
|
}{{
|
|
name: "single property",
|
|
args: args{
|
|
userId: "userId",
|
|
human: &user.UpdateUserRequest_Human{
|
|
Profile: &user.UpdateUserRequest_Human_Profile{
|
|
GivenName: gu.Ptr("givenName"),
|
|
},
|
|
},
|
|
},
|
|
want: &command.ChangeHuman{
|
|
ID: "userId",
|
|
Profile: &command.Profile{
|
|
FirstName: gu.Ptr("givenName"),
|
|
},
|
|
},
|
|
wantErr: assert.NoError,
|
|
}, {
|
|
name: "all properties",
|
|
args: args{
|
|
userId: "userId",
|
|
userName: gu.Ptr("userName"),
|
|
human: &user.UpdateUserRequest_Human{
|
|
Profile: &user.UpdateUserRequest_Human_Profile{
|
|
GivenName: gu.Ptr("givenName"),
|
|
FamilyName: gu.Ptr("familyName"),
|
|
NickName: gu.Ptr("nickName"),
|
|
DisplayName: gu.Ptr("displayName"),
|
|
PreferredLanguage: gu.Ptr("en-US"),
|
|
Gender: gu.Ptr(user.Gender_GENDER_FEMALE),
|
|
},
|
|
Email: &user.SetHumanEmail{
|
|
Email: "email@example.com",
|
|
Verification: &user.SetHumanEmail_IsVerified{
|
|
IsVerified: true,
|
|
},
|
|
},
|
|
Phone: &user.SetHumanPhone{
|
|
Phone: "+123456789",
|
|
Verification: &user.SetHumanPhone_IsVerified{
|
|
IsVerified: true,
|
|
},
|
|
},
|
|
Password: &user.SetPassword{
|
|
Verification: &user.SetPassword_CurrentPassword{
|
|
CurrentPassword: "currentPassword",
|
|
},
|
|
PasswordType: &user.SetPassword_Password{
|
|
Password: &user.Password{
|
|
Password: "newPassword",
|
|
ChangeRequired: true,
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
want: &command.ChangeHuman{
|
|
ID: "userId",
|
|
Username: gu.Ptr("userName"),
|
|
Profile: &command.Profile{
|
|
FirstName: gu.Ptr("givenName"),
|
|
LastName: gu.Ptr("familyName"),
|
|
NickName: gu.Ptr("nickName"),
|
|
DisplayName: gu.Ptr("displayName"),
|
|
PreferredLanguage: &language.AmericanEnglish,
|
|
Gender: gu.Ptr(domain.GenderFemale),
|
|
},
|
|
Email: &command.Email{
|
|
Address: "email@example.com",
|
|
Verified: true,
|
|
},
|
|
Phone: &command.Phone{
|
|
Number: "+123456789",
|
|
Verified: true,
|
|
},
|
|
Password: &command.Password{
|
|
OldPassword: "currentPassword",
|
|
Password: "newPassword",
|
|
ChangeRequired: true,
|
|
},
|
|
},
|
|
wantErr: assert.NoError,
|
|
}, {
|
|
name: "set email and request code",
|
|
args: args{
|
|
userId: "userId",
|
|
human: &user.UpdateUserRequest_Human{
|
|
Email: &user.SetHumanEmail{
|
|
Email: "email@example.com",
|
|
Verification: &user.SetHumanEmail_ReturnCode{
|
|
ReturnCode: &user.ReturnEmailVerificationCode{},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
want: &command.ChangeHuman{
|
|
ID: "userId",
|
|
Email: &command.Email{
|
|
Address: "email@example.com",
|
|
ReturnCode: true,
|
|
},
|
|
},
|
|
wantErr: assert.NoError,
|
|
}, {
|
|
name: "set email and send code",
|
|
args: args{
|
|
userId: "userId",
|
|
human: &user.UpdateUserRequest_Human{
|
|
Email: &user.SetHumanEmail{
|
|
Email: "email@example.com",
|
|
Verification: &user.SetHumanEmail_SendCode{
|
|
SendCode: &user.SendEmailVerificationCode{},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
want: &command.ChangeHuman{
|
|
ID: "userId",
|
|
Email: &command.Email{
|
|
Address: "email@example.com",
|
|
},
|
|
},
|
|
wantErr: assert.NoError,
|
|
}, {
|
|
name: "set email and send code with template",
|
|
args: args{
|
|
userId: "userId",
|
|
human: &user.UpdateUserRequest_Human{
|
|
Email: &user.SetHumanEmail{
|
|
Email: "email@example.com",
|
|
Verification: &user.SetHumanEmail_SendCode{
|
|
SendCode: &user.SendEmailVerificationCode{
|
|
UrlTemplate: gu.Ptr("Code: {{.Code}}"),
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
want: &command.ChangeHuman{
|
|
ID: "userId",
|
|
Email: &command.Email{
|
|
Address: "email@example.com",
|
|
URLTemplate: "Code: {{.Code}}",
|
|
},
|
|
},
|
|
wantErr: assert.NoError,
|
|
}, {
|
|
name: "set phone and request code",
|
|
args: args{
|
|
userId: "userId",
|
|
human: &user.UpdateUserRequest_Human{
|
|
Phone: &user.SetHumanPhone{
|
|
Phone: "+123456789",
|
|
Verification: &user.SetHumanPhone_ReturnCode{
|
|
ReturnCode: &user.ReturnPhoneVerificationCode{},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
want: &command.ChangeHuman{
|
|
ID: "userId",
|
|
Phone: &command.Phone{
|
|
Number: "+123456789",
|
|
ReturnCode: true,
|
|
},
|
|
},
|
|
wantErr: assert.NoError,
|
|
}, {
|
|
name: "set phone and send code",
|
|
args: args{
|
|
userId: "userId",
|
|
human: &user.UpdateUserRequest_Human{
|
|
Phone: &user.SetHumanPhone{
|
|
Phone: "+123456789",
|
|
Verification: &user.SetHumanPhone_SendCode{
|
|
SendCode: &user.SendPhoneVerificationCode{},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
want: &command.ChangeHuman{
|
|
ID: "userId",
|
|
Phone: &command.Phone{
|
|
Number: "+123456789",
|
|
},
|
|
},
|
|
wantErr: assert.NoError,
|
|
}, {
|
|
name: "remove phone, ok",
|
|
args: args{
|
|
userId: "userId",
|
|
human: &user.UpdateUserRequest_Human{
|
|
Phone: &user.SetHumanPhone{},
|
|
},
|
|
},
|
|
want: &command.ChangeHuman{
|
|
ID: "userId",
|
|
Phone: &command.Phone{
|
|
Remove: true,
|
|
},
|
|
},
|
|
wantErr: assert.NoError,
|
|
}, {
|
|
name: "remove phone with verification, error",
|
|
args: args{
|
|
userId: "userId",
|
|
human: &user.UpdateUserRequest_Human{
|
|
Phone: &user.SetHumanPhone{
|
|
Verification: &user.SetHumanPhone_ReturnCode{},
|
|
},
|
|
},
|
|
},
|
|
wantErr: assert.Error,
|
|
}}
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
got, err := updateHumanUserToCommand(tt.args.userId, tt.args.userName, tt.args.human)
|
|
if !tt.wantErr(t, err, fmt.Sprintf("patchHumanUserToCommand(%v, %v, %v)", tt.args.userId, tt.args.userName, tt.args.human)) {
|
|
return
|
|
}
|
|
if diff := cmp.Diff(tt.want, got, cmpopts.EquateComparable(language.Tag{})); diff != "" {
|
|
t.Errorf("patchHumanUserToCommand() mismatch (-want +got):\n%s", diff)
|
|
}
|
|
})
|
|
}
|
|
}
|