Skip to content

Make LoginName optional for admin edit user API #28834

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Make LoginName optional for admin edit user API #28834

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
85039b5
Make LoginName optional for admin edit user
me-heer Jan 17, 2024
414b821
Update swagger
me-heer Jan 17, 2024
b6a4765
Add back newline
me-heer Jan 17, 2024
6b46668
Make SourceID optional for admin edit user API
me-heer Jan 19, 2024
4fdf24d
Add back newline
me-heer Jan 19, 2024
9e3009e
Setting loginName in parseAuthSource if provided
me-heer Jan 19, 2024
bed241b
Make sourceID and loginName optional/pointers in admin edit user API
me-heer Jan 22, 2024
6c92880
go fmt
me-heer Jan 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions modules/structs/admin_user.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,8 @@ type CreateUserOption struct {

// EditUserOption edit user options
type EditUserOption struct {
// required: true
SourceID int64 `json:"source_id"`
// required: true
LoginName string `json:"login_name" binding:"Required"`
SourceID *int64 `json:"source_id"`
LoginName *string `json:"login_name"`
// swagger:strfmt email
Email *string `json:"email" binding:"MaxSize(254)"`
FullName *string `json:"full_name" binding:"MaxSize(100)"`
Expand Down
17 changes: 11 additions & 6 deletions routers/api/v1/admin/user.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ import (
user_service "code.gitea.io/gitea/services/user"
)

func parseAuthSource(ctx *context.APIContext, u *user_model.User, sourceID int64, loginName string) {
func parseAuthSource(ctx *context.APIContext, u *user_model.User, sourceID int64, loginName *string) {
if sourceID == 0 {
return
}
Expand All @@ -48,7 +48,9 @@ func parseAuthSource(ctx *context.APIContext, u *user_model.User, sourceID int64

u.LoginType = source.Type
u.LoginSource = source.ID
u.LoginName = loginName
if loginName != nil {
u.LoginName = *loginName
}
}

// CreateUser create a user
Expand Down Expand Up @@ -89,7 +91,7 @@ func CreateUser(ctx *context.APIContext) {
u.MustChangePassword = *form.MustChangePassword
}

parseAuthSource(ctx, u, form.SourceID, form.LoginName)
parseAuthSource(ctx, u, form.SourceID, &form.LoginName)
if ctx.Written() {
return
}
Expand Down Expand Up @@ -192,7 +194,9 @@ func EditUser(ctx *context.APIContext) {

form := web.GetForm(ctx).(*api.EditUserOption)

parseAuthSource(ctx, ctx.ContextUser, form.SourceID, form.LoginName)
if form.SourceID != nil {
parseAuthSource(ctx, ctx.ContextUser, *form.SourceID, form.LoginName)
}
if ctx.Written() {
return
}
Expand Down Expand Up @@ -229,8 +233,9 @@ func EditUser(ctx *context.APIContext) {
ctx.ContextUser.MustChangePassword = *form.MustChangePassword
}

ctx.ContextUser.LoginName = form.LoginName

if form.LoginName != nil {
ctx.ContextUser.LoginName = *form.LoginName
}
if form.FullName != nil {
ctx.ContextUser.FullName = *form.FullName
}
Expand Down
4 changes: 0 additions & 4 deletions templates/swagger/v1_json.tmpl
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

23 changes: 11 additions & 12 deletions tests/integration/api_admin_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ package integration
import (
"fmt"
"net/http"
"strings"
"testing"
"time"

Expand All @@ -15,6 +16,7 @@ import (
user_model "code.gitea.io/gitea/models/user"
"code.gitea.io/gitea/modules/json"
api "code.gitea.io/gitea/modules/structs"
"code.gitea.io/gitea/modules/util"
"code.gitea.io/gitea/tests"

"github.com/stretchr/testify/assert"
Expand Down Expand Up @@ -190,43 +192,40 @@ func TestAPICreateAndDeleteUser(t *testing.T) {
func TestAPIEditUser(t *testing.T) {
defer tests.PrepareTestEnv(t)()
adminUsername := "user1"
editedUsername := "user2"
token := getUserToken(t, adminUsername, auth_model.AccessTokenScopeWriteAdmin)
urlStr := fmt.Sprintf("/api/v1/admin/users/%s", "user2")
urlStr := fmt.Sprintf("/api/v1/admin/users/%s", editedUsername)

req := NewRequestWithValues(t, "PATCH", urlStr, map[string]string{
// required
"login_name": "user2",
"source_id": "0",
// to change
"full_name": "Full Name User 2",
}).AddTokenAuth(token)
MakeRequest(t, req, http.StatusOK)

empty := ""
req = NewRequestWithJSON(t, "PATCH", urlStr, api.EditUserOption{
LoginName: "user2",
SourceID: 0,
Email: &empty,
Email: &empty,
}).AddTokenAuth(token)
resp := MakeRequest(t, req, http.StatusUnprocessableEntity)

errMap := make(map[string]any)
json.Unmarshal(resp.Body.Bytes(), &errMap)
assert.EqualValues(t, "email is not allowed to be empty string", errMap["message"].(string))

user2 := unittest.AssertExistsAndLoadBean(t, &user_model.User{LoginName: "user2"})
user2 := unittest.AssertExistsAndLoadBean(t, &user_model.User{LowerName: strings.ToLower(editedUsername)})
assert.Equal(t, "user2", user2.LoginName)
assert.False(t, user2.IsRestricted)
bTrue := true
updatedLoginNameOfEditedUser := "user2_updated_loginName"
req = NewRequestWithJSON(t, "PATCH", urlStr, api.EditUserOption{
// required
LoginName: "user2",
SourceID: 0,
// to change
Restricted: &bTrue,
LoginName: util.ToPointer(updatedLoginNameOfEditedUser),
}).AddTokenAuth(token)
MakeRequest(t, req, http.StatusOK)
user2 = unittest.AssertExistsAndLoadBean(t, &user_model.User{LoginName: "user2"})
user2 = unittest.AssertExistsAndLoadBean(t, &user_model.User{LowerName: strings.ToLower(editedUsername)})
assert.True(t, user2.IsRestricted)
assert.Equal(t, updatedLoginNameOfEditedUser, user2.LoginName)
}

func TestAPICreateRepoForUser(t *testing.T) {
Expand Down