mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-12-22 12:54:53 -05:00
[TESTS] webhook forms creation and edition
This commit is contained in:
oliverpool
parent
af0bb6e68a
commit
33a3ee1955
3 changed files with 341 additions and 2 deletions
|
|
@ -451,6 +451,13 @@ func (opts ListWebhookOptions) ToConds() builder.Cond {
|
|||
return cond
|
||||
}
|
||||
|
||||
var _ db.FindOptionsOrder = ListWebhookOptions{}
|
||||
|
||||
// ToOrders implements db.FindOptionsOrder, to sort the webhooks by id asc
|
||||
func (opts ListWebhookOptions) ToOrders() string {
|
||||
return "webhook.id"
|
||||
}
|
||||
|
||||
// UpdateWebhook updates information of webhook.
|
||||
func UpdateWebhook(ctx context.Context, w *Webhook) error {
|
||||
_, err := db.GetEngine(ctx).ID(w.ID).AllCols().Update(w)
|
||||
|
|
|
|||
|
|
@ -214,9 +214,10 @@ func createWebhook(ctx *context.Context, params webhookParams) {
|
|||
return
|
||||
}
|
||||
ctx.Data["BaseLink"] = orCtx.LinkNew
|
||||
ctx.Data["BaseLinkNew"] = orCtx.LinkNew
|
||||
|
||||
if ctx.HasError() {
|
||||
ctx.HTML(http.StatusOK, orCtx.NewTemplate)
|
||||
ctx.HTML(http.StatusUnprocessableEntity, orCtx.NewTemplate)
|
||||
return
|
||||
}
|
||||
|
||||
|
|
@ -271,7 +272,7 @@ func editWebhook(ctx *context.Context, params webhookParams) {
|
|||
ctx.Data["Webhook"] = w
|
||||
|
||||
if ctx.HasError() {
|
||||
ctx.HTML(http.StatusOK, orCtx.NewTemplate)
|
||||
ctx.HTML(http.StatusUnprocessableEntity, orCtx.NewTemplate)
|
||||
return
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -5,9 +5,12 @@ package integration
|
|||
|
||||
import (
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"net/url"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
gitea_context "code.gitea.io/gitea/services/context"
|
||||
"code.gitea.io/gitea/tests"
|
||||
|
||||
"github.com/PuerkitoBio/goquery"
|
||||
|
|
@ -18,6 +21,7 @@ func TestNewWebHookLink(t *testing.T) {
|
|||
defer tests.PrepareTestEnv(t)()
|
||||
session := loginUser(t, "user2")
|
||||
|
||||
webhooksLen := 12
|
||||
baseurl := "/user2/repo1/settings/hooks"
|
||||
tests := []string{
|
||||
// webhook list page
|
||||
|
|
@ -28,6 +32,7 @@ func TestNewWebHookLink(t *testing.T) {
|
|||
baseurl + "/1",
|
||||
}
|
||||
|
||||
var csrfToken string
|
||||
for _, url := range tests {
|
||||
resp := session.MakeRequest(t, NewRequest(t, "GET", url), http.StatusOK)
|
||||
htmlDoc := NewHTMLParser(t, resp.Body)
|
||||
|
|
@ -37,5 +42,331 @@ func TestNewWebHookLink(t *testing.T) {
|
|||
assert.True(t, exist)
|
||||
assert.True(t, strings.HasPrefix(url, baseurl))
|
||||
})
|
||||
assert.Equal(t, webhooksLen, htmlDoc.Find(`a[href^="`+baseurl+`/"][href$="/new"]`).Length(), "not all webhooks are listed in the 'new' dropdown")
|
||||
csrfToken = htmlDoc.GetCSRF()
|
||||
}
|
||||
|
||||
// ensure that the "failure" pages has the full dropdown as well
|
||||
resp := session.MakeRequest(t, NewRequestWithValues(t, "POST", baseurl+"/gitea/new", map[string]string{"_csrf": csrfToken}), http.StatusUnprocessableEntity)
|
||||
htmlDoc := NewHTMLParser(t, resp.Body)
|
||||
assert.Equal(t, webhooksLen, htmlDoc.Find(`a[href^="`+baseurl+`/"][href$="/new"]`).Length(), "not all webhooks are listed in the 'new' dropdown on failure")
|
||||
|
||||
resp = session.MakeRequest(t, NewRequestWithValues(t, "POST", baseurl+"/gitea/1", map[string]string{"_csrf": csrfToken}), http.StatusUnprocessableEntity)
|
||||
htmlDoc = NewHTMLParser(t, resp.Body)
|
||||
assert.Equal(t, webhooksLen, htmlDoc.Find(`a[href^="`+baseurl+`/"][href$="/new"]`).Length(), "not all webhooks are listed in the 'new' dropdown on failure")
|
||||
}
|
||||
|
||||
func TestWebhookForms(t *testing.T) {
|
||||
defer tests.PrepareTestEnv(t)()
|
||||
|
||||
session := loginUser(t, "user2")
|
||||
|
||||
t.Run("forgejo/required", testWebhookForms("forgejo", session, map[string]string{
|
||||
"payload_url": "https://forgejo.example.com",
|
||||
"http_method": "POST",
|
||||
"content_type": "1", // json
|
||||
}, map[string]string{
|
||||
"payload_url": "",
|
||||
}, map[string]string{
|
||||
"http_method": "",
|
||||
}, map[string]string{
|
||||
"content_type": "",
|
||||
}, map[string]string{
|
||||
"payload_url": "invalid_url",
|
||||
}, map[string]string{
|
||||
"http_method": "INVALID",
|
||||
}))
|
||||
t.Run("forgejo/optional", testWebhookForms("forgejo", session, map[string]string{
|
||||
"payload_url": "https://forgejo.example.com",
|
||||
"http_method": "POST",
|
||||
"content_type": "1", // json
|
||||
"secret": "s3cr3t",
|
||||
|
||||
"branch_filter": "forgejo/*",
|
||||
"authorization_header": "Bearer 123456",
|
||||
}))
|
||||
|
||||
t.Run("gitea/required", testWebhookForms("gitea", session, map[string]string{
|
||||
"payload_url": "https://gitea.example.com",
|
||||
"http_method": "POST",
|
||||
"content_type": "1", // json
|
||||
}, map[string]string{
|
||||
"payload_url": "",
|
||||
}, map[string]string{
|
||||
"http_method": "",
|
||||
}, map[string]string{
|
||||
"content_type": "",
|
||||
}, map[string]string{
|
||||
"payload_url": "invalid_url",
|
||||
}, map[string]string{
|
||||
"http_method": "INVALID",
|
||||
}))
|
||||
t.Run("gitea/optional", testWebhookForms("gitea", session, map[string]string{
|
||||
"payload_url": "https://gitea.example.com",
|
||||
"http_method": "POST",
|
||||
"content_type": "1", // json
|
||||
"secret": "s3cr3t",
|
||||
|
||||
"branch_filter": "gitea/*",
|
||||
"authorization_header": "Bearer 123456",
|
||||
}))
|
||||
|
||||
t.Run("gogs/required", testWebhookForms("gogs", session, map[string]string{
|
||||
"payload_url": "https://gogs.example.com",
|
||||
"content_type": "1", // json
|
||||
}))
|
||||
t.Run("gogs/optional", testWebhookForms("gogs", session, map[string]string{
|
||||
"payload_url": "https://gogs.example.com",
|
||||
"content_type": "1", // json
|
||||
"secret": "s3cr3t",
|
||||
|
||||
"branch_filter": "gogs/*",
|
||||
"authorization_header": "Bearer 123456",
|
||||
}))
|
||||
|
||||
t.Run("slack/required", testWebhookForms("slack", session, map[string]string{
|
||||
"payload_url": "https://slack.example.com",
|
||||
"channel": "general",
|
||||
}, map[string]string{
|
||||
"channel": "",
|
||||
}, map[string]string{
|
||||
"channel": "invalid channel name",
|
||||
}))
|
||||
t.Run("slack/optional", testWebhookForms("slack", session, map[string]string{
|
||||
"payload_url": "https://slack.example.com",
|
||||
"channel": "#general",
|
||||
"username": "john",
|
||||
"icon_url": "https://slack.example.com/icon.png",
|
||||
"color": "#dd4b39",
|
||||
|
||||
"branch_filter": "slack/*",
|
||||
"authorization_header": "Bearer 123456",
|
||||
}))
|
||||
|
||||
t.Run("discord/required", testWebhookForms("discord", session, map[string]string{
|
||||
"payload_url": "https://discord.example.com",
|
||||
}))
|
||||
t.Run("discord/optional", testWebhookForms("discord", session, map[string]string{
|
||||
"payload_url": "https://discord.example.com",
|
||||
"username": "john",
|
||||
"icon_url": "https://discord.example.com/icon.png",
|
||||
|
||||
"branch_filter": "discord/*",
|
||||
"authorization_header": "Bearer 123456",
|
||||
}))
|
||||
|
||||
t.Run("dingtalk/required", testWebhookForms("dingtalk", session, map[string]string{
|
||||
"payload_url": "https://dingtalk.example.com",
|
||||
}))
|
||||
t.Run("dingtalk/optional", testWebhookForms("dingtalk", session, map[string]string{
|
||||
"payload_url": "https://dingtalk.example.com",
|
||||
|
||||
"branch_filter": "discord/*",
|
||||
"authorization_header": "Bearer 123456",
|
||||
}))
|
||||
|
||||
t.Run("telegram/required", testWebhookForms("telegram", session, map[string]string{
|
||||
"bot_token": "123456",
|
||||
"chat_id": "789",
|
||||
}))
|
||||
t.Run("telegram/optional", testWebhookForms("telegram", session, map[string]string{
|
||||
"bot_token": "123456",
|
||||
"chat_id": "789",
|
||||
"thread_id": "abc",
|
||||
|
||||
"branch_filter": "telegram/*",
|
||||
"authorization_header": "Bearer 123456",
|
||||
}))
|
||||
|
||||
t.Run("msteams/required", testWebhookForms("msteams", session, map[string]string{
|
||||
"payload_url": "https://msteams.example.com",
|
||||
}))
|
||||
t.Run("msteams/optional", testWebhookForms("msteams", session, map[string]string{
|
||||
"payload_url": "https://msteams.example.com",
|
||||
|
||||
"branch_filter": "msteams/*",
|
||||
"authorization_header": "Bearer 123456",
|
||||
}))
|
||||
|
||||
t.Run("feishu/required", testWebhookForms("feishu", session, map[string]string{
|
||||
"payload_url": "https://feishu.example.com",
|
||||
}))
|
||||
t.Run("feishu/optional", testWebhookForms("feishu", session, map[string]string{
|
||||
"payload_url": "https://feishu.example.com",
|
||||
|
||||
"branch_filter": "feishu/*",
|
||||
"authorization_header": "Bearer 123456",
|
||||
}))
|
||||
|
||||
t.Run("matrix/required", testWebhookForms("matrix", session, map[string]string{
|
||||
"homeserver_url": "https://matrix.example.com",
|
||||
"room_id": "123",
|
||||
"authorization_header": "Bearer 123456",
|
||||
// }, map[string]string{ // authorization_header is actually required, but not enforced (yet)
|
||||
// "authorization_header": "",
|
||||
}))
|
||||
t.Run("matrix/optional", testWebhookForms("matrix", session, map[string]string{
|
||||
"homeserver_url": "https://matrix.example.com",
|
||||
"room_id": "123",
|
||||
"message_type": "1", // m.text
|
||||
|
||||
"branch_filter": "matrix/*",
|
||||
"authorization_header": "Bearer 123456",
|
||||
}))
|
||||
|
||||
t.Run("wechatwork/required", testWebhookForms("wechatwork", session, map[string]string{
|
||||
"payload_url": "https://wechatwork.example.com",
|
||||
}))
|
||||
t.Run("wechatwork/optional", testWebhookForms("wechatwork", session, map[string]string{
|
||||
"payload_url": "https://wechatwork.example.com",
|
||||
|
||||
"branch_filter": "wechatwork/*",
|
||||
"authorization_header": "Bearer 123456",
|
||||
}))
|
||||
|
||||
t.Run("packagist/required", testWebhookForms("packagist", session, map[string]string{
|
||||
"username": "john",
|
||||
"api_token": "secret",
|
||||
"package_url": "https://packagist.org/packages/example/framework",
|
||||
}))
|
||||
t.Run("packagist/optional", testWebhookForms("packagist", session, map[string]string{
|
||||
"username": "john",
|
||||
"api_token": "secret",
|
||||
"package_url": "https://packagist.org/packages/example/framework",
|
||||
|
||||
"branch_filter": "packagist/*",
|
||||
"authorization_header": "Bearer 123456",
|
||||
}))
|
||||
}
|
||||
|
||||
func assertInput(t testing.TB, form *goquery.Selection, name string) string {
|
||||
t.Helper()
|
||||
input := form.Find(`input[name="` + name + `"]`)
|
||||
if input.Length() != 1 {
|
||||
t.Log(form.Html())
|
||||
t.Errorf("field <input name=%q /> found %d times, expected once", name, input.Length())
|
||||
}
|
||||
return input.AttrOr("value", "")
|
||||
}
|
||||
|
||||
func testWebhookForms(name string, session *TestSession, validFields map[string]string, invalidPatches ...map[string]string) func(t *testing.T) {
|
||||
return func(t *testing.T) {
|
||||
// new webhook form
|
||||
resp := session.MakeRequest(t, NewRequest(t, "GET", "/user2/repo1/settings/hooks/"+name+"/new"), http.StatusOK)
|
||||
htmlForm := NewHTMLParser(t, resp.Body).Find(`form[action^="/user2/repo1/settings/hooks/"]`)
|
||||
|
||||
// fill the form
|
||||
payload := map[string]string{
|
||||
"_csrf": htmlForm.Find(`input[name="_csrf"]`).AttrOr("value", ""),
|
||||
"events": "send_everything",
|
||||
}
|
||||
for k, v := range validFields {
|
||||
assertInput(t, htmlForm, k)
|
||||
payload[k] = v
|
||||
}
|
||||
if t.Failed() {
|
||||
t.FailNow() // prevent further execution if the form could not be filled properly
|
||||
}
|
||||
|
||||
// create the webhook (this redirects back to the hook list)
|
||||
resp = session.MakeRequest(t, NewRequestWithValues(t, "POST", "/user2/repo1/settings/hooks/"+name+"/new", payload), http.StatusSeeOther)
|
||||
assertHasFlashMessages(t, resp, "success")
|
||||
|
||||
// find last created hook in the hook list
|
||||
// (a bit hacky, but the list should be sorted)
|
||||
resp = session.MakeRequest(t, NewRequest(t, "GET", "/user2/repo1/settings/hooks"), http.StatusOK)
|
||||
htmlDoc := NewHTMLParser(t, resp.Body)
|
||||
editFormURL := htmlDoc.Find(`a[href^="/user2/repo1/settings/hooks/"]`).Last().AttrOr("href", "")
|
||||
assert.NotEmpty(t, editFormURL)
|
||||
|
||||
// edit webhook form
|
||||
resp = session.MakeRequest(t, NewRequest(t, "GET", editFormURL), http.StatusOK)
|
||||
htmlForm = NewHTMLParser(t, resp.Body).Find(`form[action^="/user2/repo1/settings/hooks/"]`)
|
||||
editPostURL := htmlForm.AttrOr("action", "")
|
||||
assert.NotEmpty(t, editPostURL)
|
||||
|
||||
// fill the form
|
||||
payload = map[string]string{
|
||||
"_csrf": htmlForm.Find(`input[name="_csrf"]`).AttrOr("value", ""),
|
||||
"events": "push_only",
|
||||
}
|
||||
for k, v := range validFields {
|
||||
assert.Equal(t, v, assertInput(t, htmlForm, k), "input %q did not contain value %q", k, v)
|
||||
payload[k] = v
|
||||
}
|
||||
|
||||
// update the webhook
|
||||
resp = session.MakeRequest(t, NewRequestWithValues(t, "POST", editPostURL, payload), http.StatusSeeOther)
|
||||
assertHasFlashMessages(t, resp, "success")
|
||||
|
||||
// check the updated webhook
|
||||
resp = session.MakeRequest(t, NewRequest(t, "GET", editFormURL), http.StatusOK)
|
||||
htmlForm = NewHTMLParser(t, resp.Body).Find(`form[action^="/user2/repo1/settings/hooks/"]`)
|
||||
for k, v := range validFields {
|
||||
assert.Equal(t, v, assertInput(t, htmlForm, k), "input %q did not contain value %q", k, v)
|
||||
}
|
||||
|
||||
if len(invalidPatches) > 0 {
|
||||
// check that invalid fields are rejected
|
||||
resp := session.MakeRequest(t, NewRequest(t, "GET", "/user2/repo1/settings/hooks/"+name+"/new"), http.StatusOK)
|
||||
htmlForm := NewHTMLParser(t, resp.Body).Find(`form[action^="/user2/repo1/settings/hooks/"]`)
|
||||
|
||||
for _, invalidPatch := range invalidPatches {
|
||||
t.Run("invalid", func(t *testing.T) {
|
||||
// fill the form
|
||||
payload := map[string]string{
|
||||
"_csrf": htmlForm.Find(`input[name="_csrf"]`).AttrOr("value", ""),
|
||||
"events": "send_everything",
|
||||
}
|
||||
for k, v := range validFields {
|
||||
payload[k] = v
|
||||
}
|
||||
for k, v := range invalidPatch {
|
||||
if v == "" {
|
||||
delete(payload, k)
|
||||
} else {
|
||||
payload[k] = v
|
||||
}
|
||||
}
|
||||
|
||||
session.MakeRequest(t, NewRequestWithValues(t, "POST", "/user2/repo1/settings/hooks/"+name+"/new", payload), http.StatusUnprocessableEntity)
|
||||
if t.Failed() {
|
||||
t.Log(invalidPatch)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func assertHasFlashMessages(t *testing.T, resp *httptest.ResponseRecorder, expectedKeys ...string) {
|
||||
seenKeys := make(map[string][]string, len(expectedKeys))
|
||||
|
||||
for _, cookie := range resp.Result().Cookies() {
|
||||
if cookie.Name != gitea_context.CookieNameFlash {
|
||||
continue
|
||||
}
|
||||
flash, _ := url.ParseQuery(cookie.Value)
|
||||
for key, value := range flash {
|
||||
// the key is itself url-encoded
|
||||
if flash, err := url.ParseQuery(key); err == nil {
|
||||
for key, value := range flash {
|
||||
seenKeys[key] = value
|
||||
}
|
||||
} else {
|
||||
seenKeys[key] = value
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
for _, k := range expectedKeys {
|
||||
if len(seenKeys[k]) == 0 {
|
||||
t.Errorf("missing expected flash message %q", k)
|
||||
}
|
||||
delete(seenKeys, k)
|
||||
}
|
||||
|
||||
for k, v := range seenKeys {
|
||||
t.Errorf("unexpected flash message %q: %q", k, v)
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in a new issue