mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-12-24 13:09:23 -05:00
53f6f62ad4
Refactor the webhook logic, to have the type-dependent processing happen only in one place. --- 1. An event happens 2. It is pre-processed (depending on the webhook type) and its body is added to a task queue 3. When the task is processed, some more logic (depending on the webhook type as well) is applied to make an HTTP request This means that webhook-type dependant logic is needed in step 2 and 3. This is cumbersome and brittle to maintain. Updated webhook flow with this PR: 1. An event happens 2. It is stored as-is and added to a task queue 3. When the task is processed, the event is processed (depending on the webhook type) to make an HTTP request So the only webhook-type dependent logic happens in one place (step 3) which should be much more robust. - the raw event must be stored in the hooktask (until now, the pre-processed body was stored) - to ensure that previous hooktasks are correctly sent, a `payload_version` is added (version 1: the body has already been pre-process / version 2: the body is the raw event) So future webhook additions will only have to deal with creating an http.Request based on the raw event (no need to adjust the code in multiple places, like currently). Moreover since this processing happens when fetching from the task queue, it ensures that the queuing of new events (upon a `git push` for instance) does not get slowed down by a slow webhook. As a concrete example, the PR #19307 for custom webhooks, should be substantially smaller: - no need to change `services/webhook/deliver.go` - minimal change in `services/webhook/webhook.go` (add the new webhook to the map) - no need to change all the individual webhook files (since with this refactor the `*webhook_model.Webhook` is provided as argument) (cherry picked from commit 26653b196bd1d15c532af41f60351596dd4330bd) Conflicts: services/webhook/deliver_test.go trivial context conflict
252 lines
9.6 KiB
Go
252 lines
9.6 KiB
Go
// Copyright 2019 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package webhook
|
|
|
|
import (
|
|
"context"
|
|
"net/url"
|
|
"testing"
|
|
|
|
webhook_model "code.gitea.io/gitea/models/webhook"
|
|
"code.gitea.io/gitea/modules/json"
|
|
api "code.gitea.io/gitea/modules/structs"
|
|
webhook_module "code.gitea.io/gitea/modules/webhook"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func TestDingTalkPayload(t *testing.T) {
|
|
parseRealSingleURL := func(singleURL string) string {
|
|
if u, err := url.Parse(singleURL); err == nil {
|
|
assert.Equal(t, "dingtalk", u.Scheme)
|
|
assert.Equal(t, "dingtalkclient", u.Host)
|
|
assert.Equal(t, "/page/link", u.Path)
|
|
return u.Query().Get("url")
|
|
}
|
|
return ""
|
|
}
|
|
dc := dingtalkConvertor{}
|
|
|
|
t.Run("Create", func(t *testing.T) {
|
|
p := createTestPayload()
|
|
|
|
pl, err := dc.Create(p)
|
|
require.NoError(t, err)
|
|
|
|
assert.Equal(t, "[test/repo] branch test created", pl.ActionCard.Text)
|
|
assert.Equal(t, "[test/repo] branch test created", pl.ActionCard.Title)
|
|
assert.Equal(t, "view ref test", pl.ActionCard.SingleTitle)
|
|
assert.Equal(t, "http://localhost:3000/test/repo/src/test", parseRealSingleURL(pl.ActionCard.SingleURL))
|
|
})
|
|
|
|
t.Run("Delete", func(t *testing.T) {
|
|
p := deleteTestPayload()
|
|
|
|
pl, err := dc.Delete(p)
|
|
require.NoError(t, err)
|
|
|
|
assert.Equal(t, "[test/repo] branch test deleted", pl.ActionCard.Text)
|
|
assert.Equal(t, "[test/repo] branch test deleted", pl.ActionCard.Title)
|
|
assert.Equal(t, "view ref test", pl.ActionCard.SingleTitle)
|
|
assert.Equal(t, "http://localhost:3000/test/repo/src/test", parseRealSingleURL(pl.ActionCard.SingleURL))
|
|
})
|
|
|
|
t.Run("Fork", func(t *testing.T) {
|
|
p := forkTestPayload()
|
|
|
|
pl, err := dc.Fork(p)
|
|
require.NoError(t, err)
|
|
|
|
assert.Equal(t, "test/repo2 is forked to test/repo", pl.ActionCard.Text)
|
|
assert.Equal(t, "test/repo2 is forked to test/repo", pl.ActionCard.Title)
|
|
assert.Equal(t, "view forked repo test/repo", pl.ActionCard.SingleTitle)
|
|
assert.Equal(t, "http://localhost:3000/test/repo", parseRealSingleURL(pl.ActionCard.SingleURL))
|
|
})
|
|
|
|
t.Run("Push", func(t *testing.T) {
|
|
p := pushTestPayload()
|
|
|
|
pl, err := dc.Push(p)
|
|
require.NoError(t, err)
|
|
|
|
assert.Equal(t, "[2020558](http://localhost:3000/test/repo/commit/2020558fe2e34debb818a514715839cabd25e778) commit message - user1\r\n[2020558](http://localhost:3000/test/repo/commit/2020558fe2e34debb818a514715839cabd25e778) commit message - user1", pl.ActionCard.Text)
|
|
assert.Equal(t, "[test/repo:test] 2 new commits", pl.ActionCard.Title)
|
|
assert.Equal(t, "view commits", pl.ActionCard.SingleTitle)
|
|
assert.Equal(t, "http://localhost:3000/test/repo/src/test", parseRealSingleURL(pl.ActionCard.SingleURL))
|
|
})
|
|
|
|
t.Run("Issue", func(t *testing.T) {
|
|
p := issueTestPayload()
|
|
|
|
p.Action = api.HookIssueOpened
|
|
pl, err := dc.Issue(p)
|
|
require.NoError(t, err)
|
|
|
|
assert.Equal(t, "[test/repo] Issue opened: #2 crash by user1\r\n\r\nissue body", pl.ActionCard.Text)
|
|
assert.Equal(t, "#2 crash", pl.ActionCard.Title)
|
|
assert.Equal(t, "view issue", pl.ActionCard.SingleTitle)
|
|
assert.Equal(t, "http://localhost:3000/test/repo/issues/2", parseRealSingleURL(pl.ActionCard.SingleURL))
|
|
|
|
p.Action = api.HookIssueClosed
|
|
pl, err = dc.Issue(p)
|
|
require.NoError(t, err)
|
|
|
|
assert.Equal(t, "[test/repo] Issue closed: #2 crash by user1", pl.ActionCard.Text)
|
|
assert.Equal(t, "#2 crash", pl.ActionCard.Title)
|
|
assert.Equal(t, "view issue", pl.ActionCard.SingleTitle)
|
|
assert.Equal(t, "http://localhost:3000/test/repo/issues/2", parseRealSingleURL(pl.ActionCard.SingleURL))
|
|
})
|
|
|
|
t.Run("IssueComment", func(t *testing.T) {
|
|
p := issueCommentTestPayload()
|
|
|
|
pl, err := dc.IssueComment(p)
|
|
require.NoError(t, err)
|
|
|
|
assert.Equal(t, "[test/repo] New comment on issue #2 crash by user1\r\n\r\nmore info needed", pl.ActionCard.Text)
|
|
assert.Equal(t, "#2 crash", pl.ActionCard.Title)
|
|
assert.Equal(t, "view issue comment", pl.ActionCard.SingleTitle)
|
|
assert.Equal(t, "http://localhost:3000/test/repo/issues/2#issuecomment-4", parseRealSingleURL(pl.ActionCard.SingleURL))
|
|
})
|
|
|
|
t.Run("PullRequest", func(t *testing.T) {
|
|
p := pullRequestTestPayload()
|
|
|
|
pl, err := dc.PullRequest(p)
|
|
require.NoError(t, err)
|
|
|
|
assert.Equal(t, "[test/repo] Pull request opened: #12 Fix bug by user1\r\n\r\nfixes bug #2", pl.ActionCard.Text)
|
|
assert.Equal(t, "#12 Fix bug", pl.ActionCard.Title)
|
|
assert.Equal(t, "view pull request", pl.ActionCard.SingleTitle)
|
|
assert.Equal(t, "http://localhost:3000/test/repo/pulls/12", parseRealSingleURL(pl.ActionCard.SingleURL))
|
|
})
|
|
|
|
t.Run("PullRequestComment", func(t *testing.T) {
|
|
p := pullRequestCommentTestPayload()
|
|
|
|
pl, err := dc.IssueComment(p)
|
|
require.NoError(t, err)
|
|
|
|
assert.Equal(t, "[test/repo] New comment on pull request #12 Fix bug by user1\r\n\r\nchanges requested", pl.ActionCard.Text)
|
|
assert.Equal(t, "#12 Fix bug", pl.ActionCard.Title)
|
|
assert.Equal(t, "view issue comment", pl.ActionCard.SingleTitle)
|
|
assert.Equal(t, "http://localhost:3000/test/repo/pulls/12#issuecomment-4", parseRealSingleURL(pl.ActionCard.SingleURL))
|
|
})
|
|
|
|
t.Run("Review", func(t *testing.T) {
|
|
p := pullRequestTestPayload()
|
|
p.Action = api.HookIssueReviewed
|
|
|
|
pl, err := dc.Review(p, webhook_module.HookEventPullRequestReviewApproved)
|
|
require.NoError(t, err)
|
|
|
|
assert.Equal(t, "[test/repo] Pull request review approved : #12 Fix bug\r\n\r\ngood job", pl.ActionCard.Text)
|
|
assert.Equal(t, "[test/repo] Pull request review approved : #12 Fix bug", pl.ActionCard.Title)
|
|
assert.Equal(t, "view pull request", pl.ActionCard.SingleTitle)
|
|
assert.Equal(t, "http://localhost:3000/test/repo/pulls/12", parseRealSingleURL(pl.ActionCard.SingleURL))
|
|
})
|
|
|
|
t.Run("Repository", func(t *testing.T) {
|
|
p := repositoryTestPayload()
|
|
|
|
pl, err := dc.Repository(p)
|
|
require.NoError(t, err)
|
|
|
|
assert.Equal(t, "[test/repo] Repository created", pl.ActionCard.Text)
|
|
assert.Equal(t, "[test/repo] Repository created", pl.ActionCard.Title)
|
|
assert.Equal(t, "view repository", pl.ActionCard.SingleTitle)
|
|
assert.Equal(t, "http://localhost:3000/test/repo", parseRealSingleURL(pl.ActionCard.SingleURL))
|
|
})
|
|
|
|
t.Run("Package", func(t *testing.T) {
|
|
p := packageTestPayload()
|
|
|
|
pl, err := dc.Package(p)
|
|
require.NoError(t, err)
|
|
|
|
assert.Equal(t, "Package created: GiteaContainer:latest by user1", pl.ActionCard.Text)
|
|
assert.Equal(t, "Package created: GiteaContainer:latest by user1", pl.ActionCard.Title)
|
|
assert.Equal(t, "view package", pl.ActionCard.SingleTitle)
|
|
assert.Equal(t, "http://localhost:3000/user1/-/packages/container/GiteaContainer/latest", parseRealSingleURL(pl.ActionCard.SingleURL))
|
|
})
|
|
|
|
t.Run("Wiki", func(t *testing.T) {
|
|
p := wikiTestPayload()
|
|
|
|
p.Action = api.HookWikiCreated
|
|
pl, err := dc.Wiki(p)
|
|
require.NoError(t, err)
|
|
|
|
assert.Equal(t, "[test/repo] New wiki page 'index' (Wiki change comment) by user1", pl.ActionCard.Text)
|
|
assert.Equal(t, "[test/repo] New wiki page 'index' (Wiki change comment) by user1", pl.ActionCard.Title)
|
|
assert.Equal(t, "view wiki", pl.ActionCard.SingleTitle)
|
|
assert.Equal(t, "http://localhost:3000/test/repo/wiki/index", parseRealSingleURL(pl.ActionCard.SingleURL))
|
|
|
|
p.Action = api.HookWikiEdited
|
|
pl, err = dc.Wiki(p)
|
|
require.NoError(t, err)
|
|
|
|
assert.Equal(t, "[test/repo] Wiki page 'index' edited (Wiki change comment) by user1", pl.ActionCard.Text)
|
|
assert.Equal(t, "[test/repo] Wiki page 'index' edited (Wiki change comment) by user1", pl.ActionCard.Title)
|
|
assert.Equal(t, "view wiki", pl.ActionCard.SingleTitle)
|
|
assert.Equal(t, "http://localhost:3000/test/repo/wiki/index", parseRealSingleURL(pl.ActionCard.SingleURL))
|
|
|
|
p.Action = api.HookWikiDeleted
|
|
pl, err = dc.Wiki(p)
|
|
require.NoError(t, err)
|
|
|
|
assert.Equal(t, "[test/repo] Wiki page 'index' deleted by user1", pl.ActionCard.Text)
|
|
assert.Equal(t, "[test/repo] Wiki page 'index' deleted by user1", pl.ActionCard.Title)
|
|
assert.Equal(t, "view wiki", pl.ActionCard.SingleTitle)
|
|
assert.Equal(t, "http://localhost:3000/test/repo/wiki/index", parseRealSingleURL(pl.ActionCard.SingleURL))
|
|
})
|
|
|
|
t.Run("Release", func(t *testing.T) {
|
|
p := pullReleaseTestPayload()
|
|
|
|
pl, err := dc.Release(p)
|
|
require.NoError(t, err)
|
|
|
|
assert.Equal(t, "[test/repo] Release created: v1.0 by user1", pl.ActionCard.Text)
|
|
assert.Equal(t, "[test/repo] Release created: v1.0 by user1", pl.ActionCard.Title)
|
|
assert.Equal(t, "view release", pl.ActionCard.SingleTitle)
|
|
assert.Equal(t, "http://localhost:3000/test/repo/releases/tag/v1.0", parseRealSingleURL(pl.ActionCard.SingleURL))
|
|
})
|
|
}
|
|
|
|
func TestDingTalkJSONPayload(t *testing.T) {
|
|
p := pushTestPayload()
|
|
data, err := p.JSONPayload()
|
|
require.NoError(t, err)
|
|
|
|
hook := &webhook_model.Webhook{
|
|
RepoID: 3,
|
|
IsActive: true,
|
|
Type: webhook_module.DINGTALK,
|
|
URL: "https://dingtalk.example.com/",
|
|
Meta: ``,
|
|
HTTPMethod: "POST",
|
|
}
|
|
task := &webhook_model.HookTask{
|
|
HookID: hook.ID,
|
|
EventType: webhook_module.HookEventPush,
|
|
PayloadContent: string(data),
|
|
PayloadVersion: 2,
|
|
}
|
|
|
|
req, reqBody, err := newDingtalkRequest(context.Background(), hook, task)
|
|
require.NotNil(t, req)
|
|
require.NotNil(t, reqBody)
|
|
require.NoError(t, err)
|
|
|
|
assert.Equal(t, "POST", req.Method)
|
|
assert.Equal(t, "https://dingtalk.example.com/", req.URL.String())
|
|
assert.Equal(t, "sha256=", req.Header.Get("X-Hub-Signature-256"))
|
|
assert.Equal(t, "application/json", req.Header.Get("Content-Type"))
|
|
var body DingtalkPayload
|
|
err = json.NewDecoder(req.Body).Decode(&body)
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, "[2020558](http://localhost:3000/test/repo/commit/2020558fe2e34debb818a514715839cabd25e778) commit message - user1\r\n[2020558](http://localhost:3000/test/repo/commit/2020558fe2e34debb818a514715839cabd25e778) commit message - user1", body.ActionCard.Text)
|
|
}
|