mirror of
https://github.com/go-gitea/gitea
synced 2024-11-04 17:24:26 +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>
221 lines
6.9 KiB
Go
221 lines
6.9 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 (
|
|
"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 TestSlackPayload(t *testing.T) {
|
|
t.Run("Create", func(t *testing.T) {
|
|
p := createTestPayload()
|
|
|
|
d := new(SlackPayload)
|
|
pl, err := d.Create(p)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, pl)
|
|
require.IsType(t, &SlackPayload{}, pl)
|
|
|
|
assert.Equal(t, "[<http://localhost:3000/test/repo|test/repo>:<http://localhost:3000/test/repo/src/branch/test|test>] branch created by user1", pl.(*SlackPayload).Text)
|
|
})
|
|
|
|
t.Run("Delete", func(t *testing.T) {
|
|
p := deleteTestPayload()
|
|
|
|
d := new(SlackPayload)
|
|
pl, err := d.Delete(p)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, pl)
|
|
require.IsType(t, &SlackPayload{}, pl)
|
|
|
|
assert.Equal(t, "[<http://localhost:3000/test/repo|test/repo>:test] branch deleted by user1", pl.(*SlackPayload).Text)
|
|
})
|
|
|
|
t.Run("Fork", func(t *testing.T) {
|
|
p := forkTestPayload()
|
|
|
|
d := new(SlackPayload)
|
|
pl, err := d.Fork(p)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, pl)
|
|
require.IsType(t, &SlackPayload{}, pl)
|
|
|
|
assert.Equal(t, "<http://localhost:3000/test/repo2|test/repo2> is forked to <http://localhost:3000/test/repo|test/repo>", pl.(*SlackPayload).Text)
|
|
})
|
|
|
|
t.Run("Push", func(t *testing.T) {
|
|
p := pushTestPayload()
|
|
|
|
d := new(SlackPayload)
|
|
pl, err := d.Push(p)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, pl)
|
|
require.IsType(t, &SlackPayload{}, pl)
|
|
|
|
assert.Equal(t, "[<http://localhost:3000/test/repo|test/repo>:<http://localhost:3000/test/repo/src/branch/test|test>] 2 new commits pushed by user1", pl.(*SlackPayload).Text)
|
|
})
|
|
|
|
t.Run("Issue", func(t *testing.T) {
|
|
p := issueTestPayload()
|
|
|
|
d := new(SlackPayload)
|
|
p.Action = api.HookIssueOpened
|
|
pl, err := d.Issue(p)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, pl)
|
|
require.IsType(t, &SlackPayload{}, pl)
|
|
|
|
assert.Equal(t, "[<http://localhost:3000/test/repo|test/repo>] Issue opened: <http://localhost:3000/test/repo/issues/2|#2 crash> by <https://try.gitea.io/user1|user1>", pl.(*SlackPayload).Text)
|
|
|
|
p.Action = api.HookIssueClosed
|
|
pl, err = d.Issue(p)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, pl)
|
|
require.IsType(t, &SlackPayload{}, pl)
|
|
|
|
assert.Equal(t, "[<http://localhost:3000/test/repo|test/repo>] Issue closed: <http://localhost:3000/test/repo/issues/2|#2 crash> by <https://try.gitea.io/user1|user1>", pl.(*SlackPayload).Text)
|
|
})
|
|
|
|
t.Run("IssueComment", func(t *testing.T) {
|
|
p := issueCommentTestPayload()
|
|
|
|
d := new(SlackPayload)
|
|
pl, err := d.IssueComment(p)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, pl)
|
|
require.IsType(t, &SlackPayload{}, pl)
|
|
|
|
assert.Equal(t, "[<http://localhost:3000/test/repo|test/repo>] New comment on issue <http://localhost:3000/test/repo/issues/2|#2 crash> by <https://try.gitea.io/user1|user1>", pl.(*SlackPayload).Text)
|
|
})
|
|
|
|
t.Run("PullRequest", func(t *testing.T) {
|
|
p := pullRequestTestPayload()
|
|
|
|
d := new(SlackPayload)
|
|
pl, err := d.PullRequest(p)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, pl)
|
|
require.IsType(t, &SlackPayload{}, pl)
|
|
|
|
assert.Equal(t, "[<http://localhost:3000/test/repo|test/repo>] Pull request opened: <http://localhost:3000/test/repo/pulls/12|#12 Fix bug> by <https://try.gitea.io/user1|user1>", pl.(*SlackPayload).Text)
|
|
})
|
|
|
|
t.Run("PullRequestComment", func(t *testing.T) {
|
|
p := pullRequestCommentTestPayload()
|
|
|
|
d := new(SlackPayload)
|
|
pl, err := d.IssueComment(p)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, pl)
|
|
require.IsType(t, &SlackPayload{}, pl)
|
|
|
|
assert.Equal(t, "[<http://localhost:3000/test/repo|test/repo>] New comment on pull request <http://localhost:3000/test/repo/pulls/12|#12 Fix bug> by <https://try.gitea.io/user1|user1>", pl.(*SlackPayload).Text)
|
|
})
|
|
|
|
t.Run("Review", func(t *testing.T) {
|
|
p := pullRequestTestPayload()
|
|
p.Action = api.HookIssueReviewed
|
|
|
|
d := new(SlackPayload)
|
|
pl, err := d.Review(p, webhook_model.HookEventPullRequestReviewApproved)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, pl)
|
|
require.IsType(t, &SlackPayload{}, pl)
|
|
|
|
assert.Equal(t, "[<http://localhost:3000/test/repo|test/repo>] Pull request review approved: [#12 Fix bug](http://localhost:3000/test/repo/pulls/12) by <https://try.gitea.io/user1|user1>", pl.(*SlackPayload).Text)
|
|
})
|
|
|
|
t.Run("Repository", func(t *testing.T) {
|
|
p := repositoryTestPayload()
|
|
|
|
d := new(SlackPayload)
|
|
pl, err := d.Repository(p)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, pl)
|
|
require.IsType(t, &SlackPayload{}, pl)
|
|
|
|
assert.Equal(t, "[<http://localhost:3000/test/repo|test/repo>] Repository created by <https://try.gitea.io/user1|user1>", pl.(*SlackPayload).Text)
|
|
})
|
|
|
|
t.Run("Wiki", func(t *testing.T) {
|
|
p := wikiTestPayload()
|
|
|
|
d := new(SlackPayload)
|
|
p.Action = api.HookWikiCreated
|
|
pl, err := d.Wiki(p)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, pl)
|
|
require.IsType(t, &SlackPayload{}, pl)
|
|
|
|
assert.Equal(t, "[<http://localhost:3000/test/repo|test/repo>] New wiki page '<http://localhost:3000/test/repo/wiki/index|index>' (Wiki change comment) by <https://try.gitea.io/user1|user1>", pl.(*SlackPayload).Text)
|
|
|
|
p.Action = api.HookWikiEdited
|
|
pl, err = d.Wiki(p)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, pl)
|
|
require.IsType(t, &SlackPayload{}, pl)
|
|
|
|
assert.Equal(t, "[<http://localhost:3000/test/repo|test/repo>] Wiki page '<http://localhost:3000/test/repo/wiki/index|index>' edited (Wiki change comment) by <https://try.gitea.io/user1|user1>", pl.(*SlackPayload).Text)
|
|
|
|
p.Action = api.HookWikiDeleted
|
|
pl, err = d.Wiki(p)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, pl)
|
|
require.IsType(t, &SlackPayload{}, pl)
|
|
|
|
assert.Equal(t, "[<http://localhost:3000/test/repo|test/repo>] Wiki page '<http://localhost:3000/test/repo/wiki/index|index>' deleted by <https://try.gitea.io/user1|user1>", pl.(*SlackPayload).Text)
|
|
})
|
|
|
|
t.Run("Release", func(t *testing.T) {
|
|
p := pullReleaseTestPayload()
|
|
|
|
d := new(SlackPayload)
|
|
pl, err := d.Release(p)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, pl)
|
|
require.IsType(t, &SlackPayload{}, pl)
|
|
|
|
assert.Equal(t, "[<http://localhost:3000/test/repo|test/repo>] Release created: <http://localhost:3000/test/repo/releases/tag/v1.0|v1.0> by <https://try.gitea.io/user1|user1>", pl.(*SlackPayload).Text)
|
|
})
|
|
}
|
|
|
|
func TestSlackJSONPayload(t *testing.T) {
|
|
p := pushTestPayload()
|
|
|
|
pl, err := new(SlackPayload).Push(p)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, pl)
|
|
require.IsType(t, &SlackPayload{}, pl)
|
|
|
|
json, err := pl.JSONPayload()
|
|
require.NoError(t, err)
|
|
assert.NotEmpty(t, json)
|
|
}
|
|
|
|
func TestIsValidSlackChannel(t *testing.T) {
|
|
tt := []struct {
|
|
channelName string
|
|
expected bool
|
|
}{
|
|
{"gitea", true},
|
|
{"#gitea", true},
|
|
{" ", false},
|
|
{"#", false},
|
|
{" #", false},
|
|
{"gitea ", false},
|
|
{" gitea", false},
|
|
}
|
|
|
|
for _, v := range tt {
|
|
assert.Equal(t, v.expected, IsValidSlackChannel(v.channelName))
|
|
}
|
|
}
|