mirror of https://github.com/go-gitea/gitea
Refactor webhooks to reduce code duplication (#9422)
* Start webhook refactoring to reduce code duplication * More webhook refactoring * Unify webhook release messages * Fix webhook release link * Remove sql import * More webhook refactoring * More webhook refactoring * Webhook tests extended * Fixed issue opened webhook Co-authored-by: Lauris BH <lauris@nix.lv> Co-authored-by: zeripath <art27@cantab.net> Co-authored-by: techknowlogick <matti@mdranta.net>pull/9526/head^2
Cornel
5 years ago
committed by
zeripath
parent
10455a88dc
commit
81e63d0714
@ -0,0 +1,31 @@ |
||||
// 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" |
||||
|
||||
api "code.gitea.io/gitea/modules/structs" |
||||
"github.com/stretchr/testify/assert" |
||||
"github.com/stretchr/testify/require" |
||||
) |
||||
|
||||
func TestGetDingTalkIssuesPayload(t *testing.T) { |
||||
p := issueTestPayload() |
||||
|
||||
p.Action = api.HookIssueOpened |
||||
pl, err := getDingtalkIssuesPayload(p) |
||||
require.Nil(t, err) |
||||
require.NotNil(t, pl) |
||||
assert.Equal(t, "#2 crash", pl.ActionCard.Title) |
||||
assert.Equal(t, "[test/repo] Issue opened: #2 crash by user1\r\n\r\n", pl.ActionCard.Text) |
||||
|
||||
p.Action = api.HookIssueClosed |
||||
pl, err = getDingtalkIssuesPayload(p) |
||||
require.Nil(t, err) |
||||
require.NotNil(t, pl) |
||||
assert.Equal(t, "#2 crash", pl.ActionCard.Title) |
||||
assert.Equal(t, "[test/repo] Issue closed: #2 crash by user1\r\n\r\n", pl.ActionCard.Text) |
||||
} |
||||
@ -0,0 +1,185 @@ |
||||
// 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 ( |
||||
"fmt" |
||||
"html" |
||||
"strings" |
||||
|
||||
"code.gitea.io/gitea/modules/setting" |
||||
api "code.gitea.io/gitea/modules/structs" |
||||
) |
||||
|
||||
type linkFormatter = func(string, string) string |
||||
|
||||
// noneLinkFormatter does not create a link but just returns the text
|
||||
func noneLinkFormatter(url string, text string) string { |
||||
return text |
||||
} |
||||
|
||||
// htmlLinkFormatter creates a HTML link
|
||||
func htmlLinkFormatter(url string, text string) string { |
||||
return fmt.Sprintf(`<a href="%s">%s</a>`, url, html.EscapeString(text)) |
||||
} |
||||
|
||||
func getIssuesPayloadInfo(p *api.IssuePayload, linkFormatter linkFormatter) (string, string, string, int) { |
||||
senderLink := linkFormatter(setting.AppURL+p.Sender.UserName, p.Sender.UserName) |
||||
repoLink := linkFormatter(p.Repository.HTMLURL, p.Repository.FullName) |
||||
issueTitle := fmt.Sprintf("#%d %s", p.Index, p.Issue.Title) |
||||
titleLink := linkFormatter(fmt.Sprintf("%s/issues/%d", p.Repository.HTMLURL, p.Index), issueTitle) |
||||
var text string |
||||
color := yellowColor |
||||
|
||||
switch p.Action { |
||||
case api.HookIssueOpened: |
||||
text = fmt.Sprintf("[%s] Issue opened: %s by %s", repoLink, titleLink, senderLink) |
||||
color = orangeColor |
||||
case api.HookIssueClosed: |
||||
text = fmt.Sprintf("[%s] Issue closed: %s by %s", repoLink, titleLink, senderLink) |
||||
color = redColor |
||||
case api.HookIssueReOpened: |
||||
text = fmt.Sprintf("[%s] Issue re-opened: %s by %s", repoLink, titleLink, senderLink) |
||||
case api.HookIssueEdited: |
||||
text = fmt.Sprintf("[%s] Issue edited: %s by %s", repoLink, titleLink, senderLink) |
||||
case api.HookIssueAssigned: |
||||
text = fmt.Sprintf("[%s] Issue assigned to %s: %s by %s", repoLink, |
||||
linkFormatter(setting.AppURL+p.Issue.Assignee.UserName, p.Issue.Assignee.UserName), |
||||
titleLink, senderLink) |
||||
color = greenColor |
||||
case api.HookIssueUnassigned: |
||||
text = fmt.Sprintf("[%s] Issue unassigned: %s by %s", repoLink, titleLink, senderLink) |
||||
case api.HookIssueLabelUpdated: |
||||
text = fmt.Sprintf("[%s] Issue labels updated: %s by %s", repoLink, titleLink, senderLink) |
||||
case api.HookIssueLabelCleared: |
||||
text = fmt.Sprintf("[%s] Issue labels cleared: %s by %s", repoLink, titleLink, senderLink) |
||||
case api.HookIssueSynchronized: |
||||
text = fmt.Sprintf("[%s] Issue synchronized: %s by %s", repoLink, titleLink, senderLink) |
||||
case api.HookIssueMilestoned: |
||||
mileStoneLink := fmt.Sprintf("%s/milestone/%d", p.Repository.HTMLURL, p.Issue.Milestone.ID) |
||||
text = fmt.Sprintf("[%s] Issue milestoned to %s: %s by %s", repoLink, |
||||
linkFormatter(mileStoneLink, p.Issue.Milestone.Title), titleLink, senderLink) |
||||
case api.HookIssueDemilestoned: |
||||
text = fmt.Sprintf("[%s] Issue milestone cleared: %s by %s", repoLink, titleLink, senderLink) |
||||
} |
||||
|
||||
var attachmentText string |
||||
if p.Action == api.HookIssueOpened || p.Action == api.HookIssueEdited { |
||||
attachmentText = p.Issue.Body |
||||
} |
||||
|
||||
return text, issueTitle, attachmentText, color |
||||
} |
||||
|
||||
func getPullRequestPayloadInfo(p *api.PullRequestPayload, linkFormatter linkFormatter) (string, string, string, int) { |
||||
senderLink := linkFormatter(setting.AppURL+p.Sender.UserName, p.Sender.UserName) |
||||
repoLink := linkFormatter(p.Repository.HTMLURL, p.Repository.FullName) |
||||
issueTitle := fmt.Sprintf("#%d %s", p.Index, p.PullRequest.Title) |
||||
titleLink := linkFormatter(p.PullRequest.URL, issueTitle) |
||||
var text string |
||||
color := yellowColor |
||||
|
||||
switch p.Action { |
||||
case api.HookIssueOpened: |
||||
text = fmt.Sprintf("[%s] Pull request %s opened by %s", repoLink, titleLink, senderLink) |
||||
color = greenColor |
||||
case api.HookIssueClosed: |
||||
if p.PullRequest.HasMerged { |
||||
text = fmt.Sprintf("[%s] Pull request %s merged by %s", repoLink, titleLink, senderLink) |
||||
color = purpleColor |
||||
} else { |
||||
text = fmt.Sprintf("[%s] Pull request %s closed by %s", repoLink, titleLink, senderLink) |
||||
color = redColor |
||||
} |
||||
case api.HookIssueReOpened: |
||||
text = fmt.Sprintf("[%s] Pull request %s re-opened by %s", repoLink, titleLink, senderLink) |
||||
case api.HookIssueEdited: |
||||
text = fmt.Sprintf("[%s] Pull request %s edited by %s", repoLink, titleLink, senderLink) |
||||
case api.HookIssueAssigned: |
||||
list := make([]string, len(p.PullRequest.Assignees)) |
||||
for i, user := range p.PullRequest.Assignees { |
||||
list[i] = linkFormatter(setting.AppURL+user.UserName, user.UserName) |
||||
} |
||||
text = fmt.Sprintf("[%s] Pull request %s assigned to %s by %s", repoLink, |
||||
strings.Join(list, ", "), |
||||
titleLink, senderLink) |
||||
color = greenColor |
||||
case api.HookIssueUnassigned: |
||||
text = fmt.Sprintf("[%s] Pull request %s unassigned by %s", repoLink, titleLink, senderLink) |
||||
case api.HookIssueLabelUpdated: |
||||
text = fmt.Sprintf("[%s] Pull request %s labels updated by %s", repoLink, titleLink, senderLink) |
||||
case api.HookIssueLabelCleared: |
||||
text = fmt.Sprintf("[%s] Pull request %s labels cleared by %s", repoLink, titleLink, senderLink) |
||||
case api.HookIssueSynchronized: |
||||
text = fmt.Sprintf("[%s] Pull request %s synchronized by %s", repoLink, titleLink, senderLink) |
||||
case api.HookIssueMilestoned: |
||||
mileStoneLink := fmt.Sprintf("%s/milestone/%d", p.Repository.HTMLURL, p.PullRequest.Milestone.ID) |
||||
text = fmt.Sprintf("[%s] Pull request %s milestoned to %s by %s", repoLink, |
||||
linkFormatter(mileStoneLink, p.PullRequest.Milestone.Title), titleLink, senderLink) |
||||
case api.HookIssueDemilestoned: |
||||
text = fmt.Sprintf("[%s] Pull request %s milestone cleared by %s", repoLink, titleLink, senderLink) |
||||
} |
||||
|
||||
var attachmentText string |
||||
if p.Action == api.HookIssueOpened || p.Action == api.HookIssueEdited { |
||||
attachmentText = p.PullRequest.Body |
||||
} |
||||
|
||||
return text, issueTitle, attachmentText, color |
||||
} |
||||
|
||||
func getReleasePayloadInfo(p *api.ReleasePayload, linkFormatter linkFormatter) (text string, color int) { |
||||
senderLink := linkFormatter(setting.AppURL+p.Sender.UserName, p.Sender.UserName) |
||||
repoLink := linkFormatter(p.Repository.HTMLURL, p.Repository.FullName) |
||||
refLink := linkFormatter(p.Repository.HTMLURL+"/src/"+p.Release.TagName, p.Release.TagName) |
||||
|
||||
switch p.Action { |
||||
case api.HookReleasePublished: |
||||
text = fmt.Sprintf("[%s] Release %s created by %s", repoLink, refLink, senderLink) |
||||
color = greenColor |
||||
case api.HookReleaseUpdated: |
||||
text = fmt.Sprintf("[%s] Release %s updated by %s", repoLink, refLink, senderLink) |
||||
color = yellowColor |
||||
case api.HookReleaseDeleted: |
||||
text = fmt.Sprintf("[%s] Release %s deleted by %s", repoLink, refLink, senderLink) |
||||
color = redColor |
||||
} |
||||
|
||||
return text, color |
||||
} |
||||
|
||||
func getIssueCommentPayloadInfo(p *api.IssueCommentPayload, linkFormatter linkFormatter) (string, string, int) { |
||||
senderLink := linkFormatter(setting.AppURL+p.Sender.UserName, p.Sender.UserName) |
||||
repoLink := linkFormatter(p.Repository.HTMLURL, p.Repository.FullName) |
||||
issueTitle := fmt.Sprintf("#%d %s", p.Issue.Index, p.Issue.Title) |
||||
|
||||
var text, typ, titleLink string |
||||
color := yellowColor |
||||
|
||||
if p.IsPull { |
||||
typ = "pull request" |
||||
titleLink = linkFormatter(p.Comment.PRURL, issueTitle) |
||||
} else { |
||||
typ = "issue" |
||||
titleLink = linkFormatter(p.Comment.IssueURL, issueTitle) |
||||
} |
||||
|
||||
switch p.Action { |
||||
case api.HookIssueCommentCreated: |
||||
text = fmt.Sprintf("[%s] New comment on %s %s by %s", repoLink, typ, titleLink, senderLink) |
||||
if p.IsPull { |
||||
color = greenColorLight |
||||
} else { |
||||
color = orangeColorLight |
||||
} |
||||
case api.HookIssueCommentEdited: |
||||
text = fmt.Sprintf("[%s] Comment on %s %s edited by %s", repoLink, typ, titleLink, senderLink) |
||||
case api.HookIssueCommentDeleted: |
||||
text = fmt.Sprintf("[%s] Comment on %s %s deleted by %s", repoLink, typ, titleLink, senderLink) |
||||
color = redColor |
||||
} |
||||
|
||||
return text, issueTitle, color |
||||
} |
||||
@ -0,0 +1,125 @@ |
||||
// 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 ( |
||||
api "code.gitea.io/gitea/modules/structs" |
||||
) |
||||
|
||||
func issueTestPayload() *api.IssuePayload { |
||||
return &api.IssuePayload{ |
||||
Index: 2, |
||||
Sender: &api.User{ |
||||
UserName: "user1", |
||||
}, |
||||
Repository: &api.Repository{ |
||||
HTMLURL: "http://localhost:3000/test/repo", |
||||
Name: "repo", |
||||
FullName: "test/repo", |
||||
}, |
||||
Issue: &api.Issue{ |
||||
ID: 2, |
||||
Index: 2, |
||||
URL: "http://localhost:3000/api/v1/repos/test/repo/issues/2", |
||||
Title: "crash", |
||||
}, |
||||
} |
||||
} |
||||
|
||||
func issueCommentTestPayload() *api.IssueCommentPayload { |
||||
return &api.IssueCommentPayload{ |
||||
Action: api.HookIssueCommentCreated, |
||||
Sender: &api.User{ |
||||
UserName: "user1", |
||||
}, |
||||
Repository: &api.Repository{ |
||||
HTMLURL: "http://localhost:3000/test/repo", |
||||
Name: "repo", |
||||
FullName: "test/repo", |
||||
}, |
||||
Comment: &api.Comment{ |
||||
HTMLURL: "http://localhost:3000/test/repo/issues/2#issuecomment-4", |
||||
IssueURL: "http://localhost:3000/test/repo/issues/2", |
||||
Body: "more info needed", |
||||
}, |
||||
Issue: &api.Issue{ |
||||
ID: 2, |
||||
Index: 2, |
||||
URL: "http://localhost:3000/api/v1/repos/test/repo/issues/2", |
||||
Title: "crash", |
||||
Body: "this happened", |
||||
}, |
||||
} |
||||
} |
||||
|
||||
func pullRequestCommentTestPayload() *api.IssueCommentPayload { |
||||
return &api.IssueCommentPayload{ |
||||
Action: api.HookIssueCommentCreated, |
||||
Sender: &api.User{ |
||||
UserName: "user1", |
||||
}, |
||||
Repository: &api.Repository{ |
||||
HTMLURL: "http://localhost:3000/test/repo", |
||||
Name: "repo", |
||||
FullName: "test/repo", |
||||
}, |
||||
Comment: &api.Comment{ |
||||
HTMLURL: "http://localhost:3000/test/repo/pulls/2#issuecomment-4", |
||||
PRURL: "http://localhost:3000/test/repo/pulls/2", |
||||
Body: "changes requested", |
||||
}, |
||||
Issue: &api.Issue{ |
||||
ID: 2, |
||||
Index: 2, |
||||
URL: "http://localhost:3000/api/v1/repos/test/repo/issues/2", |
||||
Title: "Fix bug", |
||||
Body: "fixes bug #2", |
||||
}, |
||||
IsPull: true, |
||||
} |
||||
} |
||||
|
||||
func pullReleaseTestPayload() *api.ReleasePayload { |
||||
return &api.ReleasePayload{ |
||||
Action: api.HookReleasePublished, |
||||
Sender: &api.User{ |
||||
UserName: "user1", |
||||
}, |
||||
Repository: &api.Repository{ |
||||
HTMLURL: "http://localhost:3000/test/repo", |
||||
Name: "repo", |
||||
FullName: "test/repo", |
||||
}, |
||||
Release: &api.Release{ |
||||
TagName: "v1.0", |
||||
Target: "master", |
||||
Title: "First stable release", |
||||
URL: "http://localhost:3000/api/v1/repos/test/repo/releases/2", |
||||
}, |
||||
} |
||||
} |
||||
|
||||
func pullRequestTestPayload() *api.PullRequestPayload { |
||||
return &api.PullRequestPayload{ |
||||
Action: api.HookIssueOpened, |
||||
Index: 2, |
||||
Sender: &api.User{ |
||||
UserName: "user1", |
||||
}, |
||||
Repository: &api.Repository{ |
||||
HTMLURL: "http://localhost:3000/test/repo", |
||||
Name: "repo", |
||||
FullName: "test/repo", |
||||
}, |
||||
PullRequest: &api.PullRequest{ |
||||
ID: 2, |
||||
Index: 2, |
||||
URL: "http://localhost:3000/test/repo/pulls/12", |
||||
Title: "Fix bug", |
||||
Body: "fixes bug #2", |
||||
Mergeable: true, |
||||
}, |
||||
} |
||||
} |
||||
@ -0,0 +1,88 @@ |
||||
// 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" |
||||
|
||||
api "code.gitea.io/gitea/modules/structs" |
||||
"github.com/stretchr/testify/assert" |
||||
"github.com/stretchr/testify/require" |
||||
) |
||||
|
||||
func TestSlackIssuesPayloadOpened(t *testing.T) { |
||||
p := issueTestPayload() |
||||
sl := &SlackMeta{ |
||||
Username: p.Sender.UserName, |
||||
} |
||||
|
||||
p.Action = api.HookIssueOpened |
||||
pl, err := getSlackIssuesPayload(p, sl) |
||||
require.Nil(t, err) |
||||
require.NotNil(t, 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.Text) |
||||
|
||||
p.Action = api.HookIssueClosed |
||||
pl, err = getSlackIssuesPayload(p, sl) |
||||
require.Nil(t, err) |
||||
require.NotNil(t, 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.Text) |
||||
} |
||||
|
||||
func TestSlackIssueCommentPayload(t *testing.T) { |
||||
p := issueCommentTestPayload() |
||||
|
||||
sl := &SlackMeta{ |
||||
Username: p.Sender.UserName, |
||||
} |
||||
|
||||
pl, err := getSlackIssueCommentPayload(p, sl) |
||||
require.Nil(t, err) |
||||
require.NotNil(t, 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.Text) |
||||
} |
||||
|
||||
func TestSlackPullRequestCommentPayload(t *testing.T) { |
||||
p := pullRequestCommentTestPayload() |
||||
|
||||
sl := &SlackMeta{ |
||||
Username: p.Sender.UserName, |
||||
} |
||||
|
||||
pl, err := getSlackIssueCommentPayload(p, sl) |
||||
require.Nil(t, err) |
||||
require.NotNil(t, pl) |
||||
|
||||
assert.Equal(t, "[<http://localhost:3000/test/repo|test/repo>] New comment on pull request <http://localhost:3000/test/repo/pulls/2|#2 Fix bug> by <https://try.gitea.io/user1|user1>", pl.Text) |
||||
} |
||||
|
||||
func TestSlackReleasePayload(t *testing.T) { |
||||
p := pullReleaseTestPayload() |
||||
|
||||
sl := &SlackMeta{ |
||||
Username: p.Sender.UserName, |
||||
} |
||||
|
||||
pl, err := getSlackReleasePayload(p, sl) |
||||
require.Nil(t, err) |
||||
require.NotNil(t, pl) |
||||
|
||||
assert.Equal(t, "[<http://localhost:3000/test/repo|test/repo>] Release <http://localhost:3000/test/repo/src/v1.0|v1.0> created by <https://try.gitea.io/user1|user1>", pl.Text) |
||||
} |
||||
|
||||
func TestSlackPullRequestPayload(t *testing.T) { |
||||
p := pullRequestTestPayload() |
||||
|
||||
sl := &SlackMeta{ |
||||
Username: p.Sender.UserName, |
||||
} |
||||
|
||||
pl, err := getSlackPullRequestPayload(p, sl) |
||||
require.Nil(t, err) |
||||
require.NotNil(t, pl) |
||||
|
||||
assert.Equal(t, "[<http://localhost:3000/test/repo|test/repo>] Pull request <http://localhost:3000/test/repo/pulls/12|#2 Fix bug> opened by <https://try.gitea.io/user1|user1>", pl.Text) |
||||
} |
||||
@ -0,0 +1,24 @@ |
||||
// 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" |
||||
|
||||
api "code.gitea.io/gitea/modules/structs" |
||||
"github.com/stretchr/testify/assert" |
||||
"github.com/stretchr/testify/require" |
||||
) |
||||
|
||||
func TestGetTelegramIssuesPayload(t *testing.T) { |
||||
p := issueTestPayload() |
||||
p.Action = api.HookIssueClosed |
||||
|
||||
pl, err := getTelegramIssuesPayload(p) |
||||
require.Nil(t, err) |
||||
require.NotNil(t, pl) |
||||
|
||||
assert.Equal(t, "[<a href=\"http://localhost:3000/test/repo\">test/repo</a>] Issue closed: <a href=\"http://localhost:3000/test/repo/issues/2\">#2 crash</a> by <a href=\"https://try.gitea.io/user1\">user1</a>\n\n", pl.Message) |
||||
} |
||||
Loading…
Reference in new issue