mirror of
https://github.com/go-gitea/gitea.git
synced 2026-04-04 16:46:17 +02:00
Add an optional Name field to webhooks so users can give them human-readable labels instead of relying only on URLs. The webhook overview page now displays names when available, or falls back to the URL for unnamed webhooks. Fixes #37025 --------- Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
96 lines
3.2 KiB
Go
96 lines
3.2 KiB
Go
// Copyright 2022 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package integration
|
|
|
|
import (
|
|
"fmt"
|
|
"net/http"
|
|
"testing"
|
|
|
|
auth_model "code.gitea.io/gitea/models/auth"
|
|
repo_model "code.gitea.io/gitea/models/repo"
|
|
"code.gitea.io/gitea/models/unittest"
|
|
user_model "code.gitea.io/gitea/models/user"
|
|
api "code.gitea.io/gitea/modules/structs"
|
|
"code.gitea.io/gitea/tests"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func TestAPICreateHook(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 37})
|
|
owner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo.OwnerID})
|
|
|
|
// user1 is an admin user
|
|
session := loginUser(t, "user1")
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteRepository)
|
|
req := NewRequestWithJSON(t, "POST", fmt.Sprintf("/api/v1/repos/%s/%s/%s", owner.Name, repo.Name, "hooks"), api.CreateHookOption{
|
|
Type: "gitea",
|
|
Config: api.CreateHookOptionConfig{
|
|
"content_type": "json",
|
|
"url": "http://example.com/",
|
|
},
|
|
AuthorizationHeader: "Bearer s3cr3t",
|
|
Name: " CI notifications ",
|
|
}).AddTokenAuth(token)
|
|
resp := MakeRequest(t, req, http.StatusCreated)
|
|
|
|
var apiHook *api.Hook
|
|
DecodeJSON(t, resp, &apiHook)
|
|
assert.Equal(t, "http://example.com/", apiHook.Config["url"])
|
|
assert.Equal(t, "Bearer s3cr3t", apiHook.AuthorizationHeader)
|
|
assert.Equal(t, "CI notifications", apiHook.Name)
|
|
|
|
newName := "Deploy hook"
|
|
patchReq := NewRequestWithJSON(t, "PATCH", fmt.Sprintf("/api/v1/repos/%s/%s/hooks/%d", owner.Name, repo.Name, apiHook.ID), api.EditHookOption{
|
|
Name: &newName,
|
|
}).AddTokenAuth(token)
|
|
patchResp := MakeRequest(t, patchReq, http.StatusOK)
|
|
var patched *api.Hook
|
|
DecodeJSON(t, patchResp, &patched)
|
|
assert.Equal(t, newName, patched.Name)
|
|
|
|
hooksURL := fmt.Sprintf("/api/v1/repos/%s/%s/hooks", owner.Name, repo.Name)
|
|
|
|
// Create with Name field omitted: Name should be ""
|
|
req2 := NewRequestWithJSON(t, "POST", hooksURL, api.CreateHookOption{
|
|
Type: "gitea",
|
|
Config: api.CreateHookOptionConfig{
|
|
"content_type": "json",
|
|
"url": "http://example.com/",
|
|
},
|
|
}).AddTokenAuth(token)
|
|
resp2 := MakeRequest(t, req2, http.StatusCreated)
|
|
var created *api.Hook
|
|
DecodeJSON(t, resp2, &created)
|
|
assert.Empty(t, created.Name)
|
|
|
|
hookURL := fmt.Sprintf("/api/v1/repos/%s/%s/hooks/%d", owner.Name, repo.Name, created.ID)
|
|
|
|
// PATCH with Name set: existing Name must be updated
|
|
setName := "original"
|
|
setReq := NewRequestWithJSON(t, "PATCH", hookURL, api.EditHookOption{
|
|
Name: &setName,
|
|
}).AddTokenAuth(token)
|
|
MakeRequest(t, setReq, http.StatusOK)
|
|
|
|
// PATCH without Name field: name must remain "original"
|
|
patchReq2 := NewRequestWithJSON(t, "PATCH", hookURL, api.EditHookOption{}).AddTokenAuth(token)
|
|
patchResp2 := MakeRequest(t, patchReq2, http.StatusOK)
|
|
var notCleared *api.Hook
|
|
DecodeJSON(t, patchResp2, ¬Cleared)
|
|
assert.Equal(t, "original", notCleared.Name)
|
|
|
|
// PATCH with Name: "" explicitly: Name should be cleared to ""
|
|
clearReq := NewRequestWithJSON(t, "PATCH", hookURL, api.EditHookOption{
|
|
Name: new(""),
|
|
}).AddTokenAuth(token)
|
|
clearResp := MakeRequest(t, clearReq, http.StatusOK)
|
|
var cleared *api.Hook
|
|
DecodeJSON(t, clearResp, &cleared)
|
|
assert.Empty(t, cleared.Name)
|
|
}
|