2021-06-21 10:12:19 +08:00
// Copyright 2021 The Gitea Authors. All rights reserved.
2022-11-28 02:20:29 +08:00
// SPDX-License-Identifier: MIT
2021-06-21 10:12:19 +08:00
package webhook
import (
2024-03-08 06:18:38 +08:00
"context"
2021-06-21 10:12:19 +08:00
"testing"
2024-03-08 06:18:38 +08:00
webhook_model "code.gitea.io/gitea/models/webhook"
"code.gitea.io/gitea/modules/json"
2021-06-21 10:12:19 +08:00
"code.gitea.io/gitea/modules/setting"
api "code.gitea.io/gitea/modules/structs"
2023-01-01 23:23:15 +08:00
webhook_module "code.gitea.io/gitea/modules/webhook"
2021-06-21 10:12:19 +08:00
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestDiscordPayload ( t * testing . T ) {
2024-03-08 06:18:38 +08:00
dc := discordConvertor { }
2021-06-21 10:12:19 +08:00
t . Run ( "Create" , func ( t * testing . T ) {
p := createTestPayload ( )
2024-03-08 06:18:38 +08:00
pl , err := dc . Create ( p )
2021-06-21 10:12:19 +08:00
require . NoError ( t , err )
2024-03-08 06:18:38 +08:00
assert . Len ( t , pl . Embeds , 1 )
assert . Equal ( t , "[test/repo] branch test created" , pl . Embeds [ 0 ] . Title )
assert . Empty ( t , pl . Embeds [ 0 ] . Description )
assert . Equal ( t , "http://localhost:3000/test/repo/src/test" , pl . Embeds [ 0 ] . URL )
assert . Equal ( t , p . Sender . UserName , pl . Embeds [ 0 ] . Author . Name )
assert . Equal ( t , setting . AppURL + p . Sender . UserName , pl . Embeds [ 0 ] . Author . URL )
assert . Equal ( t , p . Sender . AvatarURL , pl . Embeds [ 0 ] . Author . IconURL )
2021-06-21 10:12:19 +08:00
} )
t . Run ( "Delete" , func ( t * testing . T ) {
p := deleteTestPayload ( )
2024-03-08 06:18:38 +08:00
pl , err := dc . Delete ( p )
2021-06-21 10:12:19 +08:00
require . NoError ( t , err )
2024-03-08 06:18:38 +08:00
assert . Len ( t , pl . Embeds , 1 )
assert . Equal ( t , "[test/repo] branch test deleted" , pl . Embeds [ 0 ] . Title )
assert . Empty ( t , pl . Embeds [ 0 ] . Description )
assert . Equal ( t , "http://localhost:3000/test/repo/src/test" , pl . Embeds [ 0 ] . URL )
assert . Equal ( t , p . Sender . UserName , pl . Embeds [ 0 ] . Author . Name )
assert . Equal ( t , setting . AppURL + p . Sender . UserName , pl . Embeds [ 0 ] . Author . URL )
assert . Equal ( t , p . Sender . AvatarURL , pl . Embeds [ 0 ] . Author . IconURL )
2021-06-21 10:12:19 +08:00
} )
t . Run ( "Fork" , func ( t * testing . T ) {
p := forkTestPayload ( )
2024-03-08 06:18:38 +08:00
pl , err := dc . Fork ( p )
2021-06-21 10:12:19 +08:00
require . NoError ( t , err )
2024-03-08 06:18:38 +08:00
assert . Len ( t , pl . Embeds , 1 )
assert . Equal ( t , "test/repo2 is forked to test/repo" , pl . Embeds [ 0 ] . Title )
assert . Empty ( t , pl . Embeds [ 0 ] . Description )
assert . Equal ( t , "http://localhost:3000/test/repo" , pl . Embeds [ 0 ] . URL )
assert . Equal ( t , p . Sender . UserName , pl . Embeds [ 0 ] . Author . Name )
assert . Equal ( t , setting . AppURL + p . Sender . UserName , pl . Embeds [ 0 ] . Author . URL )
assert . Equal ( t , p . Sender . AvatarURL , pl . Embeds [ 0 ] . Author . IconURL )
2021-06-21 10:12:19 +08:00
} )
t . Run ( "Push" , func ( t * testing . T ) {
p := pushTestPayload ( )
2024-03-08 06:18:38 +08:00
pl , err := dc . Push ( p )
2021-06-21 10:12:19 +08:00
require . NoError ( t , err )
2024-03-08 06:18:38 +08:00
assert . Len ( t , pl . Embeds , 1 )
assert . Equal ( t , "[test/repo:test] 2 new commits" , pl . Embeds [ 0 ] . Title )
assert . Equal ( t , "[2020558](http://localhost:3000/test/repo/commit/2020558fe2e34debb818a514715839cabd25e778) commit message - user1\n[2020558](http://localhost:3000/test/repo/commit/2020558fe2e34debb818a514715839cabd25e778) commit message - user1" , pl . Embeds [ 0 ] . Description )
assert . Equal ( t , "http://localhost:3000/test/repo/src/test" , pl . Embeds [ 0 ] . URL )
assert . Equal ( t , p . Sender . UserName , pl . Embeds [ 0 ] . Author . Name )
assert . Equal ( t , setting . AppURL + p . Sender . UserName , pl . Embeds [ 0 ] . Author . URL )
assert . Equal ( t , p . Sender . AvatarURL , pl . Embeds [ 0 ] . Author . IconURL )
2021-06-21 10:12:19 +08:00
} )
2024-11-08 03:56:53 +08:00
t . Run ( "PushWithMultilineCommitMessage" , func ( t * testing . T ) {
2024-09-24 11:38:08 +08:00
p := pushTestMultilineCommitMessagePayload ( )
pl , err := dc . Push ( p )
require . NoError ( t , err )
2024-11-08 03:56:53 +08:00
assert . Len ( t , pl . Embeds , 1 )
assert . Equal ( t , "[test/repo:test] 2 new commits" , pl . Embeds [ 0 ] . Title )
assert . Equal ( t , "[2020558](http://localhost:3000/test/repo/commit/2020558fe2e34debb818a514715839cabd25e778) chore: This is a commit summary - user1\n[2020558](http://localhost:3000/test/repo/commit/2020558fe2e34debb818a514715839cabd25e778) chore: This is a commit summary - user1" , pl . Embeds [ 0 ] . Description )
assert . Equal ( t , p . Sender . UserName , pl . Embeds [ 0 ] . Author . Name )
assert . Equal ( t , setting . AppURL + p . Sender . UserName , pl . Embeds [ 0 ] . Author . URL )
assert . Equal ( t , p . Sender . AvatarURL , pl . Embeds [ 0 ] . Author . IconURL )
} )
t . Run ( "PushWithLongCommitSummary" , func ( t * testing . T ) {
p := pushTestPayloadWithCommitMessage ( "This is a commit summary ⚠️⚠️⚠️⚠️ containing 你好 ⚠️⚠️️\n\nThis is the message body" )
pl , err := dc . Push ( p )
require . NoError ( t , err )
2024-09-24 11:38:08 +08:00
assert . Len ( t , pl . Embeds , 1 )
assert . Equal ( t , "[test/repo:test] 2 new commits" , pl . Embeds [ 0 ] . Title )
assert . Equal ( t , "[2020558](http://localhost:3000/test/repo/commit/2020558fe2e34debb818a514715839cabd25e778) This is a commit summary ⚠️⚠️⚠️⚠️ containing 你好... - user1\n[2020558](http://localhost:3000/test/repo/commit/2020558fe2e34debb818a514715839cabd25e778) This is a commit summary ⚠️⚠️⚠️⚠️ containing 你好... - user1" , pl . Embeds [ 0 ] . Description )
assert . Equal ( t , p . Sender . UserName , pl . Embeds [ 0 ] . Author . Name )
assert . Equal ( t , setting . AppURL + p . Sender . UserName , pl . Embeds [ 0 ] . Author . URL )
assert . Equal ( t , p . Sender . AvatarURL , pl . Embeds [ 0 ] . Author . IconURL )
} )
2021-06-21 10:12:19 +08:00
t . Run ( "Issue" , func ( t * testing . T ) {
p := issueTestPayload ( )
p . Action = api . HookIssueOpened
2024-03-08 06:18:38 +08:00
pl , err := dc . Issue ( p )
2021-06-21 10:12:19 +08:00
require . NoError ( t , err )
2024-03-08 06:18:38 +08:00
assert . Len ( t , pl . Embeds , 1 )
assert . Equal ( t , "[test/repo] Issue opened: #2 crash" , pl . Embeds [ 0 ] . Title )
assert . Equal ( t , "issue body" , pl . Embeds [ 0 ] . Description )
assert . Equal ( t , "http://localhost:3000/test/repo/issues/2" , pl . Embeds [ 0 ] . URL )
assert . Equal ( t , p . Sender . UserName , pl . Embeds [ 0 ] . Author . Name )
assert . Equal ( t , setting . AppURL + p . Sender . UserName , pl . Embeds [ 0 ] . Author . URL )
assert . Equal ( t , p . Sender . AvatarURL , pl . Embeds [ 0 ] . Author . IconURL )
2021-06-21 10:12:19 +08:00
p . Action = api . HookIssueClosed
2024-03-08 06:18:38 +08:00
pl , err = dc . Issue ( p )
2021-06-21 10:12:19 +08:00
require . NoError ( t , err )
2024-03-08 06:18:38 +08:00
assert . Len ( t , pl . Embeds , 1 )
assert . Equal ( t , "[test/repo] Issue closed: #2 crash" , pl . Embeds [ 0 ] . Title )
assert . Empty ( t , pl . Embeds [ 0 ] . Description )
assert . Equal ( t , "http://localhost:3000/test/repo/issues/2" , pl . Embeds [ 0 ] . URL )
assert . Equal ( t , p . Sender . UserName , pl . Embeds [ 0 ] . Author . Name )
assert . Equal ( t , setting . AppURL + p . Sender . UserName , pl . Embeds [ 0 ] . Author . URL )
assert . Equal ( t , p . Sender . AvatarURL , pl . Embeds [ 0 ] . Author . IconURL )
2021-06-21 10:12:19 +08:00
} )
t . Run ( "IssueComment" , func ( t * testing . T ) {
p := issueCommentTestPayload ( )
2024-03-08 06:18:38 +08:00
pl , err := dc . IssueComment ( p )
2021-06-21 10:12:19 +08:00
require . NoError ( t , err )
2024-03-08 06:18:38 +08:00
assert . Len ( t , pl . Embeds , 1 )
assert . Equal ( t , "[test/repo] New comment on issue #2 crash" , pl . Embeds [ 0 ] . Title )
assert . Equal ( t , "more info needed" , pl . Embeds [ 0 ] . Description )
assert . Equal ( t , "http://localhost:3000/test/repo/issues/2#issuecomment-4" , pl . Embeds [ 0 ] . URL )
assert . Equal ( t , p . Sender . UserName , pl . Embeds [ 0 ] . Author . Name )
assert . Equal ( t , setting . AppURL + p . Sender . UserName , pl . Embeds [ 0 ] . Author . URL )
assert . Equal ( t , p . Sender . AvatarURL , pl . Embeds [ 0 ] . Author . IconURL )
2021-06-21 10:12:19 +08:00
} )
t . Run ( "PullRequest" , func ( t * testing . T ) {
p := pullRequestTestPayload ( )
2024-03-08 06:18:38 +08:00
pl , err := dc . PullRequest ( p )
2021-06-21 10:12:19 +08:00
require . NoError ( t , err )
2024-03-08 06:18:38 +08:00
assert . Len ( t , pl . Embeds , 1 )
assert . Equal ( t , "[test/repo] Pull request opened: #12 Fix bug" , pl . Embeds [ 0 ] . Title )
assert . Equal ( t , "fixes bug #2" , pl . Embeds [ 0 ] . Description )
assert . Equal ( t , "http://localhost:3000/test/repo/pulls/12" , pl . Embeds [ 0 ] . URL )
assert . Equal ( t , p . Sender . UserName , pl . Embeds [ 0 ] . Author . Name )
assert . Equal ( t , setting . AppURL + p . Sender . UserName , pl . Embeds [ 0 ] . Author . URL )
assert . Equal ( t , p . Sender . AvatarURL , pl . Embeds [ 0 ] . Author . IconURL )
2021-06-21 10:12:19 +08:00
} )
t . Run ( "PullRequestComment" , func ( t * testing . T ) {
p := pullRequestCommentTestPayload ( )
2024-03-08 06:18:38 +08:00
pl , err := dc . IssueComment ( p )
2021-06-21 10:12:19 +08:00
require . NoError ( t , err )
2024-03-08 06:18:38 +08:00
assert . Len ( t , pl . Embeds , 1 )
assert . Equal ( t , "[test/repo] New comment on pull request #12 Fix bug" , pl . Embeds [ 0 ] . Title )
assert . Equal ( t , "changes requested" , pl . Embeds [ 0 ] . Description )
assert . Equal ( t , "http://localhost:3000/test/repo/pulls/12#issuecomment-4" , pl . Embeds [ 0 ] . URL )
assert . Equal ( t , p . Sender . UserName , pl . Embeds [ 0 ] . Author . Name )
assert . Equal ( t , setting . AppURL + p . Sender . UserName , pl . Embeds [ 0 ] . Author . URL )
assert . Equal ( t , p . Sender . AvatarURL , pl . Embeds [ 0 ] . Author . IconURL )
2021-06-21 10:12:19 +08:00
} )
t . Run ( "Review" , func ( t * testing . T ) {
p := pullRequestTestPayload ( )
p . Action = api . HookIssueReviewed
2024-03-08 06:18:38 +08:00
pl , err := dc . Review ( p , webhook_module . HookEventPullRequestReviewApproved )
2021-06-21 10:12:19 +08:00
require . NoError ( t , err )
2024-03-08 06:18:38 +08:00
assert . Len ( t , pl . Embeds , 1 )
assert . Equal ( t , "[test/repo] Pull request review approved: #12 Fix bug" , pl . Embeds [ 0 ] . Title )
assert . Equal ( t , "good job" , pl . Embeds [ 0 ] . Description )
assert . Equal ( t , "http://localhost:3000/test/repo/pulls/12" , pl . Embeds [ 0 ] . URL )
assert . Equal ( t , p . Sender . UserName , pl . Embeds [ 0 ] . Author . Name )
assert . Equal ( t , setting . AppURL + p . Sender . UserName , pl . Embeds [ 0 ] . Author . URL )
assert . Equal ( t , p . Sender . AvatarURL , pl . Embeds [ 0 ] . Author . IconURL )
2021-06-21 10:12:19 +08:00
} )
t . Run ( "Repository" , func ( t * testing . T ) {
p := repositoryTestPayload ( )
2024-03-08 06:18:38 +08:00
pl , err := dc . Repository ( p )
2021-06-21 10:12:19 +08:00
require . NoError ( t , err )
2024-03-08 06:18:38 +08:00
assert . Len ( t , pl . Embeds , 1 )
assert . Equal ( t , "[test/repo] Repository created" , pl . Embeds [ 0 ] . Title )
assert . Empty ( t , pl . Embeds [ 0 ] . Description )
assert . Equal ( t , "http://localhost:3000/test/repo" , pl . Embeds [ 0 ] . URL )
assert . Equal ( t , p . Sender . UserName , pl . Embeds [ 0 ] . Author . Name )
assert . Equal ( t , setting . AppURL + p . Sender . UserName , pl . Embeds [ 0 ] . Author . URL )
assert . Equal ( t , p . Sender . AvatarURL , pl . Embeds [ 0 ] . Author . IconURL )
2021-06-21 10:12:19 +08:00
} )
2023-11-17 19:17:33 +08:00
t . Run ( "Package" , func ( t * testing . T ) {
p := packageTestPayload ( )
2024-03-08 06:18:38 +08:00
pl , err := dc . Package ( p )
2023-11-17 19:17:33 +08:00
require . NoError ( t , err )
2024-03-08 06:18:38 +08:00
assert . Len ( t , pl . Embeds , 1 )
assert . Equal ( t , "Package created: GiteaContainer:latest" , pl . Embeds [ 0 ] . Title )
assert . Empty ( t , pl . Embeds [ 0 ] . Description )
assert . Equal ( t , "http://localhost:3000/user1/-/packages/container/GiteaContainer/latest" , pl . Embeds [ 0 ] . URL )
assert . Equal ( t , p . Sender . UserName , pl . Embeds [ 0 ] . Author . Name )
assert . Equal ( t , setting . AppURL + p . Sender . UserName , pl . Embeds [ 0 ] . Author . URL )
assert . Equal ( t , p . Sender . AvatarURL , pl . Embeds [ 0 ] . Author . IconURL )
2023-11-17 19:17:33 +08:00
} )
2022-09-05 03:54:23 +08:00
t . Run ( "Wiki" , func ( t * testing . T ) {
p := wikiTestPayload ( )
p . Action = api . HookWikiCreated
2024-03-08 06:18:38 +08:00
pl , err := dc . Wiki ( p )
2022-09-05 03:54:23 +08:00
require . NoError ( t , err )
2024-03-08 06:18:38 +08:00
assert . Len ( t , pl . Embeds , 1 )
assert . Equal ( t , "[test/repo] New wiki page 'index' (Wiki change comment)" , pl . Embeds [ 0 ] . Title )
assert . Equal ( t , "Wiki change comment" , pl . Embeds [ 0 ] . Description )
assert . Equal ( t , "http://localhost:3000/test/repo/wiki/index" , pl . Embeds [ 0 ] . URL )
assert . Equal ( t , p . Sender . UserName , pl . Embeds [ 0 ] . Author . Name )
assert . Equal ( t , setting . AppURL + p . Sender . UserName , pl . Embeds [ 0 ] . Author . URL )
assert . Equal ( t , p . Sender . AvatarURL , pl . Embeds [ 0 ] . Author . IconURL )
2022-09-05 03:54:23 +08:00
p . Action = api . HookWikiEdited
2024-03-08 06:18:38 +08:00
pl , err = dc . Wiki ( p )
2022-09-05 03:54:23 +08:00
require . NoError ( t , err )
2024-03-08 06:18:38 +08:00
assert . Len ( t , pl . Embeds , 1 )
assert . Equal ( t , "[test/repo] Wiki page 'index' edited (Wiki change comment)" , pl . Embeds [ 0 ] . Title )
assert . Equal ( t , "Wiki change comment" , pl . Embeds [ 0 ] . Description )
assert . Equal ( t , "http://localhost:3000/test/repo/wiki/index" , pl . Embeds [ 0 ] . URL )
assert . Equal ( t , p . Sender . UserName , pl . Embeds [ 0 ] . Author . Name )
assert . Equal ( t , setting . AppURL + p . Sender . UserName , pl . Embeds [ 0 ] . Author . URL )
assert . Equal ( t , p . Sender . AvatarURL , pl . Embeds [ 0 ] . Author . IconURL )
2022-09-05 03:54:23 +08:00
p . Action = api . HookWikiDeleted
2024-03-08 06:18:38 +08:00
pl , err = dc . Wiki ( p )
2022-09-05 03:54:23 +08:00
require . NoError ( t , err )
2024-03-08 06:18:38 +08:00
assert . Len ( t , pl . Embeds , 1 )
assert . Equal ( t , "[test/repo] Wiki page 'index' deleted" , pl . Embeds [ 0 ] . Title )
assert . Empty ( t , pl . Embeds [ 0 ] . Description )
assert . Equal ( t , "http://localhost:3000/test/repo/wiki/index" , pl . Embeds [ 0 ] . URL )
assert . Equal ( t , p . Sender . UserName , pl . Embeds [ 0 ] . Author . Name )
assert . Equal ( t , setting . AppURL + p . Sender . UserName , pl . Embeds [ 0 ] . Author . URL )
assert . Equal ( t , p . Sender . AvatarURL , pl . Embeds [ 0 ] . Author . IconURL )
2022-09-05 03:54:23 +08:00
} )
2021-06-21 10:12:19 +08:00
t . Run ( "Release" , func ( t * testing . T ) {
p := pullReleaseTestPayload ( )
2024-03-08 06:18:38 +08:00
pl , err := dc . Release ( p )
2021-06-21 10:12:19 +08:00
require . NoError ( t , err )
2024-03-08 06:18:38 +08:00
assert . Len ( t , pl . Embeds , 1 )
assert . Equal ( t , "[test/repo] Release created: v1.0" , pl . Embeds [ 0 ] . Title )
assert . Equal ( t , "Note of first stable release" , pl . Embeds [ 0 ] . Description )
assert . Equal ( t , "http://localhost:3000/test/repo/releases/tag/v1.0" , pl . Embeds [ 0 ] . URL )
assert . Equal ( t , p . Sender . UserName , pl . Embeds [ 0 ] . Author . Name )
assert . Equal ( t , setting . AppURL + p . Sender . UserName , pl . Embeds [ 0 ] . Author . URL )
assert . Equal ( t , p . Sender . AvatarURL , pl . Embeds [ 0 ] . Author . IconURL )
2021-06-21 10:12:19 +08:00
} )
}
func TestDiscordJSONPayload ( t * testing . T ) {
p := pushTestPayload ( )
2024-03-08 06:18:38 +08:00
data , err := p . JSONPayload ( )
2021-06-21 10:12:19 +08:00
require . NoError ( t , err )
2024-03-08 06:18:38 +08:00
hook := & webhook_model . Webhook {
RepoID : 3 ,
IsActive : true ,
Type : webhook_module . DISCORD ,
URL : "https://discord.example.com/" ,
Meta : ` { } ` ,
HTTPMethod : "POST" ,
}
task := & webhook_model . HookTask {
HookID : hook . ID ,
EventType : webhook_module . HookEventPush ,
PayloadContent : string ( data ) ,
PayloadVersion : 2 ,
}
req , reqBody , err := newDiscordRequest ( context . Background ( ) , hook , task )
require . NotNil ( t , req )
require . NotNil ( t , reqBody )
2021-06-21 10:12:19 +08:00
require . NoError ( t , err )
2024-03-08 06:18:38 +08:00
assert . Equal ( t , "POST" , req . Method )
assert . Equal ( t , "https://discord.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 DiscordPayload
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\n[2020558](http://localhost:3000/test/repo/commit/2020558fe2e34debb818a514715839cabd25e778) commit message - user1" , body . Embeds [ 0 ] . Description )
2021-06-21 10:12:19 +08:00
}