forked from Shiloh/githaven
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>
258 lines
10 KiB
Go
258 lines
10 KiB
Go
// Copyright 2019 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 (
|
|
"net/url"
|
|
"testing"
|
|
|
|
webhook_model "code.gitea.io/gitea/models/webhook"
|
|
api "code.gitea.io/gitea/modules/structs"
|
|
|
|
"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 ""
|
|
}
|
|
|
|
t.Run("Create", func(t *testing.T) {
|
|
p := createTestPayload()
|
|
|
|
d := new(DingtalkPayload)
|
|
pl, err := d.Create(p)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, pl)
|
|
require.IsType(t, &DingtalkPayload{}, pl)
|
|
|
|
assert.Equal(t, "[test/repo] branch test created", pl.(*DingtalkPayload).ActionCard.Text)
|
|
assert.Equal(t, "[test/repo] branch test created", pl.(*DingtalkPayload).ActionCard.Title)
|
|
assert.Equal(t, "view ref test", pl.(*DingtalkPayload).ActionCard.SingleTitle)
|
|
assert.Equal(t, "http://localhost:3000/test/repo/src/test", parseRealSingleURL(pl.(*DingtalkPayload).ActionCard.SingleURL))
|
|
})
|
|
|
|
t.Run("Delete", func(t *testing.T) {
|
|
p := deleteTestPayload()
|
|
|
|
d := new(DingtalkPayload)
|
|
pl, err := d.Delete(p)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, pl)
|
|
require.IsType(t, &DingtalkPayload{}, pl)
|
|
|
|
assert.Equal(t, "[test/repo] branch test deleted", pl.(*DingtalkPayload).ActionCard.Text)
|
|
assert.Equal(t, "[test/repo] branch test deleted", pl.(*DingtalkPayload).ActionCard.Title)
|
|
assert.Equal(t, "view ref test", pl.(*DingtalkPayload).ActionCard.SingleTitle)
|
|
assert.Equal(t, "http://localhost:3000/test/repo/src/test", parseRealSingleURL(pl.(*DingtalkPayload).ActionCard.SingleURL))
|
|
})
|
|
|
|
t.Run("Fork", func(t *testing.T) {
|
|
p := forkTestPayload()
|
|
|
|
d := new(DingtalkPayload)
|
|
pl, err := d.Fork(p)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, pl)
|
|
require.IsType(t, &DingtalkPayload{}, pl)
|
|
|
|
assert.Equal(t, "test/repo2 is forked to test/repo", pl.(*DingtalkPayload).ActionCard.Text)
|
|
assert.Equal(t, "test/repo2 is forked to test/repo", pl.(*DingtalkPayload).ActionCard.Title)
|
|
assert.Equal(t, "view forked repo test/repo", pl.(*DingtalkPayload).ActionCard.SingleTitle)
|
|
assert.Equal(t, "http://localhost:3000/test/repo", parseRealSingleURL(pl.(*DingtalkPayload).ActionCard.SingleURL))
|
|
})
|
|
|
|
t.Run("Push", func(t *testing.T) {
|
|
p := pushTestPayload()
|
|
|
|
d := new(DingtalkPayload)
|
|
pl, err := d.Push(p)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, pl)
|
|
require.IsType(t, &DingtalkPayload{}, pl)
|
|
|
|
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.(*DingtalkPayload).ActionCard.Text)
|
|
assert.Equal(t, "[test/repo:test] 2 new commits", pl.(*DingtalkPayload).ActionCard.Title)
|
|
assert.Equal(t, "view commit 2020558...2020558", pl.(*DingtalkPayload).ActionCard.SingleTitle)
|
|
assert.Equal(t, "http://localhost:3000/test/repo/src/test", parseRealSingleURL(pl.(*DingtalkPayload).ActionCard.SingleURL))
|
|
})
|
|
|
|
t.Run("Issue", func(t *testing.T) {
|
|
p := issueTestPayload()
|
|
|
|
d := new(DingtalkPayload)
|
|
p.Action = api.HookIssueOpened
|
|
pl, err := d.Issue(p)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, pl)
|
|
require.IsType(t, &DingtalkPayload{}, pl)
|
|
|
|
assert.Equal(t, "[test/repo] Issue opened: #2 crash by user1\r\n\r\nissue body", pl.(*DingtalkPayload).ActionCard.Text)
|
|
assert.Equal(t, "#2 crash", pl.(*DingtalkPayload).ActionCard.Title)
|
|
assert.Equal(t, "view issue", pl.(*DingtalkPayload).ActionCard.SingleTitle)
|
|
assert.Equal(t, "http://localhost:3000/test/repo/issues/2", parseRealSingleURL(pl.(*DingtalkPayload).ActionCard.SingleURL))
|
|
|
|
p.Action = api.HookIssueClosed
|
|
pl, err = d.Issue(p)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, pl)
|
|
require.IsType(t, &DingtalkPayload{}, pl)
|
|
|
|
assert.Equal(t, "[test/repo] Issue closed: #2 crash by user1", pl.(*DingtalkPayload).ActionCard.Text)
|
|
assert.Equal(t, "#2 crash", pl.(*DingtalkPayload).ActionCard.Title)
|
|
assert.Equal(t, "view issue", pl.(*DingtalkPayload).ActionCard.SingleTitle)
|
|
assert.Equal(t, "http://localhost:3000/test/repo/issues/2", parseRealSingleURL(pl.(*DingtalkPayload).ActionCard.SingleURL))
|
|
})
|
|
|
|
t.Run("IssueComment", func(t *testing.T) {
|
|
p := issueCommentTestPayload()
|
|
|
|
d := new(DingtalkPayload)
|
|
pl, err := d.IssueComment(p)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, pl)
|
|
require.IsType(t, &DingtalkPayload{}, pl)
|
|
|
|
assert.Equal(t, "[test/repo] New comment on issue #2 crash by user1\r\n\r\nmore info needed", pl.(*DingtalkPayload).ActionCard.Text)
|
|
assert.Equal(t, "#2 crash", pl.(*DingtalkPayload).ActionCard.Title)
|
|
assert.Equal(t, "view issue comment", pl.(*DingtalkPayload).ActionCard.SingleTitle)
|
|
assert.Equal(t, "http://localhost:3000/test/repo/issues/2#issuecomment-4", parseRealSingleURL(pl.(*DingtalkPayload).ActionCard.SingleURL))
|
|
})
|
|
|
|
t.Run("PullRequest", func(t *testing.T) {
|
|
p := pullRequestTestPayload()
|
|
|
|
d := new(DingtalkPayload)
|
|
pl, err := d.PullRequest(p)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, pl)
|
|
require.IsType(t, &DingtalkPayload{}, pl)
|
|
|
|
assert.Equal(t, "[test/repo] Pull request opened: #12 Fix bug by user1\r\n\r\nfixes bug #2", pl.(*DingtalkPayload).ActionCard.Text)
|
|
assert.Equal(t, "#12 Fix bug", pl.(*DingtalkPayload).ActionCard.Title)
|
|
assert.Equal(t, "view pull request", pl.(*DingtalkPayload).ActionCard.SingleTitle)
|
|
assert.Equal(t, "http://localhost:3000/test/repo/pulls/12", parseRealSingleURL(pl.(*DingtalkPayload).ActionCard.SingleURL))
|
|
})
|
|
|
|
t.Run("PullRequestComment", func(t *testing.T) {
|
|
p := pullRequestCommentTestPayload()
|
|
|
|
d := new(DingtalkPayload)
|
|
pl, err := d.IssueComment(p)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, pl)
|
|
require.IsType(t, &DingtalkPayload{}, pl)
|
|
|
|
assert.Equal(t, "[test/repo] New comment on pull request #12 Fix bug by user1\r\n\r\nchanges requested", pl.(*DingtalkPayload).ActionCard.Text)
|
|
assert.Equal(t, "#12 Fix bug", pl.(*DingtalkPayload).ActionCard.Title)
|
|
assert.Equal(t, "view issue comment", pl.(*DingtalkPayload).ActionCard.SingleTitle)
|
|
assert.Equal(t, "http://localhost:3000/test/repo/pulls/12#issuecomment-4", parseRealSingleURL(pl.(*DingtalkPayload).ActionCard.SingleURL))
|
|
})
|
|
|
|
t.Run("Review", func(t *testing.T) {
|
|
p := pullRequestTestPayload()
|
|
p.Action = api.HookIssueReviewed
|
|
|
|
d := new(DingtalkPayload)
|
|
pl, err := d.Review(p, webhook_model.HookEventPullRequestReviewApproved)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, pl)
|
|
require.IsType(t, &DingtalkPayload{}, pl)
|
|
|
|
assert.Equal(t, "[test/repo] Pull request review approved : #12 Fix bug\r\n\r\ngood job", pl.(*DingtalkPayload).ActionCard.Text)
|
|
assert.Equal(t, "[test/repo] Pull request review approved : #12 Fix bug", pl.(*DingtalkPayload).ActionCard.Title)
|
|
assert.Equal(t, "view pull request", pl.(*DingtalkPayload).ActionCard.SingleTitle)
|
|
assert.Equal(t, "http://localhost:3000/test/repo/pulls/12", parseRealSingleURL(pl.(*DingtalkPayload).ActionCard.SingleURL))
|
|
})
|
|
|
|
t.Run("Repository", func(t *testing.T) {
|
|
p := repositoryTestPayload()
|
|
|
|
d := new(DingtalkPayload)
|
|
pl, err := d.Repository(p)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, pl)
|
|
require.IsType(t, &DingtalkPayload{}, pl)
|
|
|
|
assert.Equal(t, "[test/repo] Repository created", pl.(*DingtalkPayload).ActionCard.Text)
|
|
assert.Equal(t, "[test/repo] Repository created", pl.(*DingtalkPayload).ActionCard.Title)
|
|
assert.Equal(t, "view repository", pl.(*DingtalkPayload).ActionCard.SingleTitle)
|
|
assert.Equal(t, "http://localhost:3000/test/repo", parseRealSingleURL(pl.(*DingtalkPayload).ActionCard.SingleURL))
|
|
})
|
|
|
|
t.Run("Wiki", func(t *testing.T) {
|
|
p := wikiTestPayload()
|
|
|
|
d := new(DingtalkPayload)
|
|
p.Action = api.HookWikiCreated
|
|
pl, err := d.Wiki(p)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, pl)
|
|
require.IsType(t, &DingtalkPayload{}, pl)
|
|
|
|
assert.Equal(t, "[test/repo] New wiki page 'index' (Wiki change comment) by user1", pl.(*DingtalkPayload).ActionCard.Text)
|
|
assert.Equal(t, "[test/repo] New wiki page 'index' (Wiki change comment) by user1", pl.(*DingtalkPayload).ActionCard.Title)
|
|
assert.Equal(t, "view wiki", pl.(*DingtalkPayload).ActionCard.SingleTitle)
|
|
assert.Equal(t, "http://localhost:3000/test/repo/wiki/index", parseRealSingleURL(pl.(*DingtalkPayload).ActionCard.SingleURL))
|
|
|
|
p.Action = api.HookWikiEdited
|
|
pl, err = d.Wiki(p)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, pl)
|
|
require.IsType(t, &DingtalkPayload{}, pl)
|
|
|
|
assert.Equal(t, "[test/repo] Wiki page 'index' edited (Wiki change comment) by user1", pl.(*DingtalkPayload).ActionCard.Text)
|
|
assert.Equal(t, "[test/repo] Wiki page 'index' edited (Wiki change comment) by user1", pl.(*DingtalkPayload).ActionCard.Title)
|
|
assert.Equal(t, "view wiki", pl.(*DingtalkPayload).ActionCard.SingleTitle)
|
|
assert.Equal(t, "http://localhost:3000/test/repo/wiki/index", parseRealSingleURL(pl.(*DingtalkPayload).ActionCard.SingleURL))
|
|
|
|
p.Action = api.HookWikiDeleted
|
|
pl, err = d.Wiki(p)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, pl)
|
|
require.IsType(t, &DingtalkPayload{}, pl)
|
|
|
|
assert.Equal(t, "[test/repo] Wiki page 'index' deleted by user1", pl.(*DingtalkPayload).ActionCard.Text)
|
|
assert.Equal(t, "[test/repo] Wiki page 'index' deleted by user1", pl.(*DingtalkPayload).ActionCard.Title)
|
|
assert.Equal(t, "view wiki", pl.(*DingtalkPayload).ActionCard.SingleTitle)
|
|
assert.Equal(t, "http://localhost:3000/test/repo/wiki/index", parseRealSingleURL(pl.(*DingtalkPayload).ActionCard.SingleURL))
|
|
})
|
|
|
|
t.Run("Release", func(t *testing.T) {
|
|
p := pullReleaseTestPayload()
|
|
|
|
d := new(DingtalkPayload)
|
|
pl, err := d.Release(p)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, pl)
|
|
require.IsType(t, &DingtalkPayload{}, pl)
|
|
|
|
assert.Equal(t, "[test/repo] Release created: v1.0 by user1", pl.(*DingtalkPayload).ActionCard.Text)
|
|
assert.Equal(t, "[test/repo] Release created: v1.0 by user1", pl.(*DingtalkPayload).ActionCard.Title)
|
|
assert.Equal(t, "view release", pl.(*DingtalkPayload).ActionCard.SingleTitle)
|
|
assert.Equal(t, "http://localhost:3000/api/v1/repos/test/repo/releases/2", parseRealSingleURL(pl.(*DingtalkPayload).ActionCard.SingleURL))
|
|
})
|
|
}
|
|
|
|
func TestDingTalkJSONPayload(t *testing.T) {
|
|
p := pushTestPayload()
|
|
|
|
pl, err := new(DingtalkPayload).Push(p)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, pl)
|
|
require.IsType(t, &DingtalkPayload{}, pl)
|
|
|
|
json, err := pl.JSONPayload()
|
|
require.NoError(t, err)
|
|
assert.NotEmpty(t, json)
|
|
}
|