mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-11-25 22:43:32 +00:00
3963625b6e
Add support for triggering webhook notifications on wiki changes. This PR contains frontend and backend for webhook notifications on wiki actions (create a new page, rename a page, edit a page and delete a page). The frontend got a new checkbox under the Custom Event -> Repository Events section. There is only one checkbox for create/edit/rename/delete actions, because it makes no sense to separate it and others like releases or packages follow the same schema.  The actions itself are separated, so that different notifications will be executed (with the "action" field). All the webhook receivers implement the new interface method (Wiki) and the corresponding tests. When implementing this, I encounter a little bug on editing a wiki page. Creating and editing a wiki page is technically the same action and will be handled by the ```updateWikiPage``` function. But the function need to know if it is a new wiki page or just a change. This distinction is done by the ```action``` parameter, but this will not be sent by the frontend (on form submit). This PR will fix this by adding the ```action``` parameter with the values ```_new``` or ```_edit```, which will be used by the ```updateWikiPage``` function. I've done integration tests with matrix and gitea (http).  Fix #16457 Signed-off-by: Aaron Fischer <mail@aaron-fischer.net>
331 lines
10 KiB
Go
331 lines
10 KiB
Go
// Copyright 2017 The Gitea Authors. All rights reserved.
|
|
// Use of this source code is governed by a MIT-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package webhook
|
|
|
|
import (
|
|
"context"
|
|
"testing"
|
|
"time"
|
|
|
|
"code.gitea.io/gitea/models/db"
|
|
"code.gitea.io/gitea/models/unittest"
|
|
"code.gitea.io/gitea/modules/json"
|
|
api "code.gitea.io/gitea/modules/structs"
|
|
"code.gitea.io/gitea/modules/util"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func TestHookContentType_Name(t *testing.T) {
|
|
assert.Equal(t, "json", ContentTypeJSON.Name())
|
|
assert.Equal(t, "form", ContentTypeForm.Name())
|
|
}
|
|
|
|
func TestIsValidHookContentType(t *testing.T) {
|
|
assert.True(t, IsValidHookContentType("json"))
|
|
assert.True(t, IsValidHookContentType("form"))
|
|
assert.False(t, IsValidHookContentType("invalid"))
|
|
}
|
|
|
|
func TestWebhook_History(t *testing.T) {
|
|
assert.NoError(t, unittest.PrepareTestDatabase())
|
|
webhook := unittest.AssertExistsAndLoadBean(t, &Webhook{ID: 1})
|
|
tasks, err := webhook.History(0)
|
|
assert.NoError(t, err)
|
|
if assert.Len(t, tasks, 1) {
|
|
assert.Equal(t, int64(1), tasks[0].ID)
|
|
}
|
|
|
|
webhook = unittest.AssertExistsAndLoadBean(t, &Webhook{ID: 2})
|
|
tasks, err = webhook.History(0)
|
|
assert.NoError(t, err)
|
|
assert.Len(t, tasks, 0)
|
|
}
|
|
|
|
func TestWebhook_UpdateEvent(t *testing.T) {
|
|
assert.NoError(t, unittest.PrepareTestDatabase())
|
|
webhook := unittest.AssertExistsAndLoadBean(t, &Webhook{ID: 1})
|
|
hookEvent := &HookEvent{
|
|
PushOnly: true,
|
|
SendEverything: false,
|
|
ChooseEvents: false,
|
|
HookEvents: HookEvents{
|
|
Create: false,
|
|
Push: true,
|
|
PullRequest: false,
|
|
},
|
|
}
|
|
webhook.HookEvent = hookEvent
|
|
assert.NoError(t, webhook.UpdateEvent())
|
|
assert.NotEmpty(t, webhook.Events)
|
|
actualHookEvent := &HookEvent{}
|
|
assert.NoError(t, json.Unmarshal([]byte(webhook.Events), actualHookEvent))
|
|
assert.Equal(t, *hookEvent, *actualHookEvent)
|
|
}
|
|
|
|
func TestWebhook_EventsArray(t *testing.T) {
|
|
assert.Equal(t, []string{
|
|
"create", "delete", "fork", "push",
|
|
"issues", "issue_assign", "issue_label", "issue_milestone", "issue_comment",
|
|
"pull_request", "pull_request_assign", "pull_request_label", "pull_request_milestone",
|
|
"pull_request_comment", "pull_request_review_approved", "pull_request_review_rejected",
|
|
"pull_request_review_comment", "pull_request_sync", "wiki", "repository", "release",
|
|
"package",
|
|
},
|
|
(&Webhook{
|
|
HookEvent: &HookEvent{SendEverything: true},
|
|
}).EventsArray(),
|
|
)
|
|
|
|
assert.Equal(t, []string{"push"},
|
|
(&Webhook{
|
|
HookEvent: &HookEvent{PushOnly: true},
|
|
}).EventsArray(),
|
|
)
|
|
}
|
|
|
|
func TestCreateWebhook(t *testing.T) {
|
|
hook := &Webhook{
|
|
RepoID: 3,
|
|
URL: "www.example.com/unit_test",
|
|
ContentType: ContentTypeJSON,
|
|
Events: `{"push_only":false,"send_everything":false,"choose_events":false,"events":{"create":false,"push":true,"pull_request":true}}`,
|
|
}
|
|
unittest.AssertNotExistsBean(t, hook)
|
|
assert.NoError(t, CreateWebhook(db.DefaultContext, hook))
|
|
unittest.AssertExistsAndLoadBean(t, hook)
|
|
}
|
|
|
|
func TestGetWebhookByRepoID(t *testing.T) {
|
|
assert.NoError(t, unittest.PrepareTestDatabase())
|
|
hook, err := GetWebhookByRepoID(1, 1)
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, int64(1), hook.ID)
|
|
|
|
_, err = GetWebhookByRepoID(unittest.NonexistentID, unittest.NonexistentID)
|
|
assert.Error(t, err)
|
|
assert.True(t, IsErrWebhookNotExist(err))
|
|
}
|
|
|
|
func TestGetWebhookByOrgID(t *testing.T) {
|
|
assert.NoError(t, unittest.PrepareTestDatabase())
|
|
hook, err := GetWebhookByOrgID(3, 3)
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, int64(3), hook.ID)
|
|
|
|
_, err = GetWebhookByOrgID(unittest.NonexistentID, unittest.NonexistentID)
|
|
assert.Error(t, err)
|
|
assert.True(t, IsErrWebhookNotExist(err))
|
|
}
|
|
|
|
func TestGetActiveWebhooksByRepoID(t *testing.T) {
|
|
assert.NoError(t, unittest.PrepareTestDatabase())
|
|
hooks, err := ListWebhooksByOpts(db.DefaultContext, &ListWebhookOptions{RepoID: 1, IsActive: util.OptionalBoolTrue})
|
|
assert.NoError(t, err)
|
|
if assert.Len(t, hooks, 1) {
|
|
assert.Equal(t, int64(1), hooks[0].ID)
|
|
assert.True(t, hooks[0].IsActive)
|
|
}
|
|
}
|
|
|
|
func TestGetWebhooksByRepoID(t *testing.T) {
|
|
assert.NoError(t, unittest.PrepareTestDatabase())
|
|
hooks, err := ListWebhooksByOpts(db.DefaultContext, &ListWebhookOptions{RepoID: 1})
|
|
assert.NoError(t, err)
|
|
if assert.Len(t, hooks, 2) {
|
|
assert.Equal(t, int64(1), hooks[0].ID)
|
|
assert.Equal(t, int64(2), hooks[1].ID)
|
|
}
|
|
}
|
|
|
|
func TestGetActiveWebhooksByOrgID(t *testing.T) {
|
|
assert.NoError(t, unittest.PrepareTestDatabase())
|
|
hooks, err := ListWebhooksByOpts(db.DefaultContext, &ListWebhookOptions{OrgID: 3, IsActive: util.OptionalBoolTrue})
|
|
assert.NoError(t, err)
|
|
if assert.Len(t, hooks, 1) {
|
|
assert.Equal(t, int64(3), hooks[0].ID)
|
|
assert.True(t, hooks[0].IsActive)
|
|
}
|
|
}
|
|
|
|
func TestGetWebhooksByOrgID(t *testing.T) {
|
|
assert.NoError(t, unittest.PrepareTestDatabase())
|
|
hooks, err := ListWebhooksByOpts(db.DefaultContext, &ListWebhookOptions{OrgID: 3})
|
|
assert.NoError(t, err)
|
|
if assert.Len(t, hooks, 1) {
|
|
assert.Equal(t, int64(3), hooks[0].ID)
|
|
assert.True(t, hooks[0].IsActive)
|
|
}
|
|
}
|
|
|
|
func TestUpdateWebhook(t *testing.T) {
|
|
assert.NoError(t, unittest.PrepareTestDatabase())
|
|
hook := unittest.AssertExistsAndLoadBean(t, &Webhook{ID: 2})
|
|
hook.IsActive = true
|
|
hook.ContentType = ContentTypeForm
|
|
unittest.AssertNotExistsBean(t, hook)
|
|
assert.NoError(t, UpdateWebhook(hook))
|
|
unittest.AssertExistsAndLoadBean(t, hook)
|
|
}
|
|
|
|
func TestDeleteWebhookByRepoID(t *testing.T) {
|
|
assert.NoError(t, unittest.PrepareTestDatabase())
|
|
unittest.AssertExistsAndLoadBean(t, &Webhook{ID: 2, RepoID: 1})
|
|
assert.NoError(t, DeleteWebhookByRepoID(1, 2))
|
|
unittest.AssertNotExistsBean(t, &Webhook{ID: 2, RepoID: 1})
|
|
|
|
err := DeleteWebhookByRepoID(unittest.NonexistentID, unittest.NonexistentID)
|
|
assert.Error(t, err)
|
|
assert.True(t, IsErrWebhookNotExist(err))
|
|
}
|
|
|
|
func TestDeleteWebhookByOrgID(t *testing.T) {
|
|
assert.NoError(t, unittest.PrepareTestDatabase())
|
|
unittest.AssertExistsAndLoadBean(t, &Webhook{ID: 3, OrgID: 3})
|
|
assert.NoError(t, DeleteWebhookByOrgID(3, 3))
|
|
unittest.AssertNotExistsBean(t, &Webhook{ID: 3, OrgID: 3})
|
|
|
|
err := DeleteWebhookByOrgID(unittest.NonexistentID, unittest.NonexistentID)
|
|
assert.Error(t, err)
|
|
assert.True(t, IsErrWebhookNotExist(err))
|
|
}
|
|
|
|
func TestHookTasks(t *testing.T) {
|
|
assert.NoError(t, unittest.PrepareTestDatabase())
|
|
hookTasks, err := HookTasks(1, 1)
|
|
assert.NoError(t, err)
|
|
if assert.Len(t, hookTasks, 1) {
|
|
assert.Equal(t, int64(1), hookTasks[0].ID)
|
|
}
|
|
|
|
hookTasks, err = HookTasks(unittest.NonexistentID, 1)
|
|
assert.NoError(t, err)
|
|
assert.Len(t, hookTasks, 0)
|
|
}
|
|
|
|
func TestCreateHookTask(t *testing.T) {
|
|
assert.NoError(t, unittest.PrepareTestDatabase())
|
|
hookTask := &HookTask{
|
|
RepoID: 3,
|
|
HookID: 3,
|
|
Payloader: &api.PushPayload{},
|
|
}
|
|
unittest.AssertNotExistsBean(t, hookTask)
|
|
assert.NoError(t, CreateHookTask(hookTask))
|
|
unittest.AssertExistsAndLoadBean(t, hookTask)
|
|
}
|
|
|
|
func TestUpdateHookTask(t *testing.T) {
|
|
assert.NoError(t, unittest.PrepareTestDatabase())
|
|
|
|
hook := unittest.AssertExistsAndLoadBean(t, &HookTask{ID: 1})
|
|
hook.PayloadContent = "new payload content"
|
|
hook.DeliveredString = "new delivered string"
|
|
hook.IsDelivered = true
|
|
unittest.AssertNotExistsBean(t, hook)
|
|
assert.NoError(t, UpdateHookTask(hook))
|
|
unittest.AssertExistsAndLoadBean(t, hook)
|
|
}
|
|
|
|
func TestCleanupHookTaskTable_PerWebhook_DeletesDelivered(t *testing.T) {
|
|
assert.NoError(t, unittest.PrepareTestDatabase())
|
|
hookTask := &HookTask{
|
|
RepoID: 3,
|
|
HookID: 3,
|
|
Payloader: &api.PushPayload{},
|
|
IsDelivered: true,
|
|
Delivered: time.Now().UnixNano(),
|
|
}
|
|
unittest.AssertNotExistsBean(t, hookTask)
|
|
assert.NoError(t, CreateHookTask(hookTask))
|
|
unittest.AssertExistsAndLoadBean(t, hookTask)
|
|
|
|
assert.NoError(t, CleanupHookTaskTable(context.Background(), PerWebhook, 168*time.Hour, 0))
|
|
unittest.AssertNotExistsBean(t, hookTask)
|
|
}
|
|
|
|
func TestCleanupHookTaskTable_PerWebhook_LeavesUndelivered(t *testing.T) {
|
|
assert.NoError(t, unittest.PrepareTestDatabase())
|
|
hookTask := &HookTask{
|
|
RepoID: 2,
|
|
HookID: 4,
|
|
Payloader: &api.PushPayload{},
|
|
IsDelivered: false,
|
|
}
|
|
unittest.AssertNotExistsBean(t, hookTask)
|
|
assert.NoError(t, CreateHookTask(hookTask))
|
|
unittest.AssertExistsAndLoadBean(t, hookTask)
|
|
|
|
assert.NoError(t, CleanupHookTaskTable(context.Background(), PerWebhook, 168*time.Hour, 0))
|
|
unittest.AssertExistsAndLoadBean(t, hookTask)
|
|
}
|
|
|
|
func TestCleanupHookTaskTable_PerWebhook_LeavesMostRecentTask(t *testing.T) {
|
|
assert.NoError(t, unittest.PrepareTestDatabase())
|
|
hookTask := &HookTask{
|
|
RepoID: 2,
|
|
HookID: 4,
|
|
Payloader: &api.PushPayload{},
|
|
IsDelivered: true,
|
|
Delivered: time.Now().UnixNano(),
|
|
}
|
|
unittest.AssertNotExistsBean(t, hookTask)
|
|
assert.NoError(t, CreateHookTask(hookTask))
|
|
unittest.AssertExistsAndLoadBean(t, hookTask)
|
|
|
|
assert.NoError(t, CleanupHookTaskTable(context.Background(), PerWebhook, 168*time.Hour, 1))
|
|
unittest.AssertExistsAndLoadBean(t, hookTask)
|
|
}
|
|
|
|
func TestCleanupHookTaskTable_OlderThan_DeletesDelivered(t *testing.T) {
|
|
assert.NoError(t, unittest.PrepareTestDatabase())
|
|
hookTask := &HookTask{
|
|
RepoID: 3,
|
|
HookID: 3,
|
|
Payloader: &api.PushPayload{},
|
|
IsDelivered: true,
|
|
Delivered: time.Now().AddDate(0, 0, -8).UnixNano(),
|
|
}
|
|
unittest.AssertNotExistsBean(t, hookTask)
|
|
assert.NoError(t, CreateHookTask(hookTask))
|
|
unittest.AssertExistsAndLoadBean(t, hookTask)
|
|
|
|
assert.NoError(t, CleanupHookTaskTable(context.Background(), OlderThan, 168*time.Hour, 0))
|
|
unittest.AssertNotExistsBean(t, hookTask)
|
|
}
|
|
|
|
func TestCleanupHookTaskTable_OlderThan_LeavesUndelivered(t *testing.T) {
|
|
assert.NoError(t, unittest.PrepareTestDatabase())
|
|
hookTask := &HookTask{
|
|
RepoID: 2,
|
|
HookID: 4,
|
|
Payloader: &api.PushPayload{},
|
|
IsDelivered: false,
|
|
}
|
|
unittest.AssertNotExistsBean(t, hookTask)
|
|
assert.NoError(t, CreateHookTask(hookTask))
|
|
unittest.AssertExistsAndLoadBean(t, hookTask)
|
|
|
|
assert.NoError(t, CleanupHookTaskTable(context.Background(), OlderThan, 168*time.Hour, 0))
|
|
unittest.AssertExistsAndLoadBean(t, hookTask)
|
|
}
|
|
|
|
func TestCleanupHookTaskTable_OlderThan_LeavesTaskEarlierThanAgeToDelete(t *testing.T) {
|
|
assert.NoError(t, unittest.PrepareTestDatabase())
|
|
hookTask := &HookTask{
|
|
RepoID: 2,
|
|
HookID: 4,
|
|
Payloader: &api.PushPayload{},
|
|
IsDelivered: true,
|
|
Delivered: time.Now().AddDate(0, 0, -6).UnixNano(),
|
|
}
|
|
unittest.AssertNotExistsBean(t, hookTask)
|
|
assert.NoError(t, CreateHookTask(hookTask))
|
|
unittest.AssertExistsAndLoadBean(t, hookTask)
|
|
|
|
assert.NoError(t, CleanupHookTaskTable(context.Background(), OlderThan, 168*time.Hour, 0))
|
|
unittest.AssertExistsAndLoadBean(t, hookTask)
|
|
}
|