mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-12-04 10:30:19 -05:00
1f90147f39
* Add template capability for issue mail subject * Remove test string * Fix trim subject length * Add comment to template and run make fmt * Add information for the template * Rename defaultMailSubject() to fallbackMailSubject() * General rewrite of the mail template code * Fix .Doer name * Use text/template for subject instead of html * Fix subject Re: prefix * Fix mail tests * Fix static templates * [skip ci] Updated translations via Crowdin * Expose db.SetMaxOpenConns and allow non MySQL dbs to set conn pool params (#8528) * Expose db.SetMaxOpenConns and allow other dbs to set their connection params * Add note about port exhaustion Co-Authored-By: guillep2k <18600385+guillep2k@users.noreply.github.com> * Prevent .code-view from overriding font on icon fonts (#8614) * Correct some outdated statements in the contributing guidelines (#8612) * More information for drone-cli in CONTRIBUTING.md * Increases the version of drone-cli to 1.2.0 * Adds a note for the Docker Toolbox on Windows Signed-off-by: LukBukkit <luk.bukkit@gmail.com> * Fix the url for the blog repository (now on gitea.com) Signed-off-by: LukBukkit <luk.bukkit@gmail.com> * Remove TrN due to lack of lang context * Redo templates to match previous code * Fix extra character in template * Unify PR & Issue tempaltes, fix format * Remove default subject * Add template tests * Fix template * Remove replaced function * Provide User as models.User for better consistency * Add docs * Fix doc inaccuracies, improve examples * Change mail footer to math AppName * Add test for mail subject/body template separation * Add support for code review comments * Update docs/content/doc/advanced/mail-templates-us.md Co-Authored-By: 6543 <24977596+6543@users.noreply.github.com>
204 lines
7.9 KiB
Go
204 lines
7.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 mailer
|
|
|
|
import (
|
|
"bytes"
|
|
"html/template"
|
|
"testing"
|
|
texttmpl "text/template"
|
|
|
|
"code.gitea.io/gitea/models"
|
|
"code.gitea.io/gitea/modules/setting"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
const subjectTpl = `
|
|
{{.SubjectPrefix}}[{{.Repo}}] @{{.Doer.Name}} #{{.Issue.Index}} - {{.Issue.Title}}
|
|
`
|
|
|
|
const bodyTpl = `
|
|
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<title>{{.Subject}}</title>
|
|
</head>
|
|
|
|
<body>
|
|
<p>{{.Body}}</p>
|
|
<p>
|
|
---
|
|
<br>
|
|
<a href="{{.Link}}">View it on Gitea</a>.
|
|
</p>
|
|
</body>
|
|
</html>
|
|
`
|
|
|
|
func TestComposeIssueCommentMessage(t *testing.T) {
|
|
assert.NoError(t, models.PrepareTestDatabase())
|
|
var mailService = setting.Mailer{
|
|
From: "test@gitea.com",
|
|
}
|
|
|
|
setting.MailService = &mailService
|
|
setting.Domain = "localhost"
|
|
|
|
doer := models.AssertExistsAndLoadBean(t, &models.User{ID: 2}).(*models.User)
|
|
repo := models.AssertExistsAndLoadBean(t, &models.Repository{ID: 1, Owner: doer}).(*models.Repository)
|
|
issue := models.AssertExistsAndLoadBean(t, &models.Issue{ID: 1, Repo: repo, Poster: doer}).(*models.Issue)
|
|
comment := models.AssertExistsAndLoadBean(t, &models.Comment{ID: 2, Issue: issue}).(*models.Comment)
|
|
|
|
stpl := texttmpl.Must(texttmpl.New("issue/comment").Parse(subjectTpl))
|
|
btpl := template.Must(template.New("issue/comment").Parse(bodyTpl))
|
|
InitMailRender(stpl, btpl)
|
|
|
|
tos := []string{"test@gitea.com", "test2@gitea.com"}
|
|
msg := composeIssueCommentMessage(issue, doer, models.ActionCommentIssue, false, "test body", comment, tos, "issue comment")
|
|
|
|
subject := msg.GetHeader("Subject")
|
|
inreplyTo := msg.GetHeader("In-Reply-To")
|
|
references := msg.GetHeader("References")
|
|
|
|
assert.Equal(t, "Re: ", subject[0][:4], "Comment reply subject should contain Re:")
|
|
assert.Equal(t, "Re: [user2/repo1] @user2 #1 - issue1", subject[0])
|
|
assert.Equal(t, inreplyTo[0], "<user2/repo1/issues/1@localhost>", "In-Reply-To header doesn't match")
|
|
assert.Equal(t, references[0], "<user2/repo1/issues/1@localhost>", "References header doesn't match")
|
|
}
|
|
|
|
func TestComposeIssueMessage(t *testing.T) {
|
|
assert.NoError(t, models.PrepareTestDatabase())
|
|
var mailService = setting.Mailer{
|
|
From: "test@gitea.com",
|
|
}
|
|
|
|
setting.MailService = &mailService
|
|
setting.Domain = "localhost"
|
|
|
|
doer := models.AssertExistsAndLoadBean(t, &models.User{ID: 2}).(*models.User)
|
|
repo := models.AssertExistsAndLoadBean(t, &models.Repository{ID: 1, Owner: doer}).(*models.Repository)
|
|
issue := models.AssertExistsAndLoadBean(t, &models.Issue{ID: 1, Repo: repo, Poster: doer}).(*models.Issue)
|
|
|
|
stpl := texttmpl.Must(texttmpl.New("issue/new").Parse(subjectTpl))
|
|
btpl := template.Must(template.New("issue/new").Parse(bodyTpl))
|
|
InitMailRender(stpl, btpl)
|
|
|
|
tos := []string{"test@gitea.com", "test2@gitea.com"}
|
|
msg := composeIssueCommentMessage(issue, doer, models.ActionCreateIssue, false, "test body", nil, tos, "issue create")
|
|
|
|
subject := msg.GetHeader("Subject")
|
|
messageID := msg.GetHeader("Message-ID")
|
|
|
|
assert.Equal(t, "[user2/repo1] @user2 #1 - issue1", subject[0])
|
|
assert.Nil(t, msg.GetHeader("In-Reply-To"))
|
|
assert.Nil(t, msg.GetHeader("References"))
|
|
assert.Equal(t, messageID[0], "<user2/repo1/issues/1@localhost>", "Message-ID header doesn't match")
|
|
}
|
|
|
|
func TestTemplateSelection(t *testing.T) {
|
|
assert.NoError(t, models.PrepareTestDatabase())
|
|
var mailService = setting.Mailer{
|
|
From: "test@gitea.com",
|
|
}
|
|
|
|
setting.MailService = &mailService
|
|
setting.Domain = "localhost"
|
|
|
|
doer := models.AssertExistsAndLoadBean(t, &models.User{ID: 2}).(*models.User)
|
|
repo := models.AssertExistsAndLoadBean(t, &models.Repository{ID: 1, Owner: doer}).(*models.Repository)
|
|
issue := models.AssertExistsAndLoadBean(t, &models.Issue{ID: 1, Repo: repo, Poster: doer}).(*models.Issue)
|
|
tos := []string{"test@gitea.com"}
|
|
|
|
stpl := texttmpl.Must(texttmpl.New("issue/default").Parse("issue/default/subject"))
|
|
texttmpl.Must(stpl.New("issue/new").Parse("issue/new/subject"))
|
|
texttmpl.Must(stpl.New("pull/comment").Parse("pull/comment/subject"))
|
|
texttmpl.Must(stpl.New("issue/close").Parse("")) // Must default to fallback subject
|
|
|
|
btpl := template.Must(template.New("issue/default").Parse("issue/default/body"))
|
|
template.Must(btpl.New("issue/new").Parse("issue/new/body"))
|
|
template.Must(btpl.New("pull/comment").Parse("pull/comment/body"))
|
|
template.Must(btpl.New("issue/close").Parse("issue/close/body"))
|
|
|
|
InitMailRender(stpl, btpl)
|
|
|
|
expect := func(t *testing.T, msg *Message, expSubject, expBody string) {
|
|
subject := msg.GetHeader("Subject")
|
|
msgbuf := new(bytes.Buffer)
|
|
_, _ = msg.WriteTo(msgbuf)
|
|
wholemsg := msgbuf.String()
|
|
assert.Equal(t, []string{expSubject}, subject)
|
|
assert.Contains(t, wholemsg, expBody)
|
|
}
|
|
|
|
msg := composeIssueCommentMessage(issue, doer, models.ActionCreateIssue, false, "test body", nil, tos, "TestTemplateSelection")
|
|
expect(t, msg, "issue/new/subject", "issue/new/body")
|
|
|
|
comment := models.AssertExistsAndLoadBean(t, &models.Comment{ID: 2, Issue: issue}).(*models.Comment)
|
|
msg = composeIssueCommentMessage(issue, doer, models.ActionCommentIssue, false, "test body", comment, tos, "TestTemplateSelection")
|
|
expect(t, msg, "issue/default/subject", "issue/default/body")
|
|
|
|
pull := models.AssertExistsAndLoadBean(t, &models.Issue{ID: 2, Repo: repo, Poster: doer}).(*models.Issue)
|
|
comment = models.AssertExistsAndLoadBean(t, &models.Comment{ID: 4, Issue: pull}).(*models.Comment)
|
|
msg = composeIssueCommentMessage(pull, doer, models.ActionCommentIssue, false, "test body", comment, tos, "TestTemplateSelection")
|
|
expect(t, msg, "pull/comment/subject", "pull/comment/body")
|
|
|
|
msg = composeIssueCommentMessage(issue, doer, models.ActionCloseIssue, false, "test body", nil, tos, "TestTemplateSelection")
|
|
expect(t, msg, "[user2/repo1] issue1 (#1)", "issue/close/body")
|
|
}
|
|
|
|
func TestTemplateServices(t *testing.T) {
|
|
assert.NoError(t, models.PrepareTestDatabase())
|
|
var mailService = setting.Mailer{
|
|
From: "test@gitea.com",
|
|
}
|
|
|
|
setting.MailService = &mailService
|
|
setting.Domain = "localhost"
|
|
|
|
doer := models.AssertExistsAndLoadBean(t, &models.User{ID: 2}).(*models.User)
|
|
repo := models.AssertExistsAndLoadBean(t, &models.Repository{ID: 1, Owner: doer}).(*models.Repository)
|
|
issue := models.AssertExistsAndLoadBean(t, &models.Issue{ID: 1, Repo: repo, Poster: doer}).(*models.Issue)
|
|
comment := models.AssertExistsAndLoadBean(t, &models.Comment{ID: 2, Issue: issue}).(*models.Comment)
|
|
assert.NoError(t, issue.LoadRepo())
|
|
|
|
expect := func(t *testing.T, issue *models.Issue, comment *models.Comment, doer *models.User,
|
|
actionType models.ActionType, fromMention bool, tplSubject, tplBody, expSubject, expBody string) {
|
|
|
|
stpl := texttmpl.Must(texttmpl.New("issue/default").Parse(tplSubject))
|
|
btpl := template.Must(template.New("issue/default").Parse(tplBody))
|
|
InitMailRender(stpl, btpl)
|
|
|
|
tos := []string{"test@gitea.com"}
|
|
msg := composeIssueCommentMessage(issue, doer, actionType, fromMention, "test body", comment, tos, "TestTemplateServices")
|
|
|
|
subject := msg.GetHeader("Subject")
|
|
msgbuf := new(bytes.Buffer)
|
|
_, _ = msg.WriteTo(msgbuf)
|
|
wholemsg := msgbuf.String()
|
|
|
|
assert.Equal(t, []string{expSubject}, subject)
|
|
assert.Contains(t, wholemsg, "\r\n"+expBody+"\r\n")
|
|
}
|
|
|
|
expect(t, issue, comment, doer, models.ActionCommentIssue, false,
|
|
"{{.SubjectPrefix}}[{{.Repo}}]: @{{.Doer.Name}} commented on #{{.Issue.Index}} - {{.Issue.Title}}",
|
|
"//{{.ActionType}},{{.ActionName}},{{if .IsMention}}norender{{end}}//",
|
|
"Re: [user2/repo1]: @user2 commented on #1 - issue1",
|
|
"//issue,comment,//")
|
|
|
|
expect(t, issue, comment, doer, models.ActionCommentIssue, true,
|
|
"{{if .IsMention}}must render{{end}}",
|
|
"//subject is: {{.Subject}}//",
|
|
"must render",
|
|
"//subject is: must render//")
|
|
|
|
expect(t, issue, comment, doer, models.ActionCommentIssue, true,
|
|
"{{.FallbackSubject}}",
|
|
"//{{.SubjectPrefix}}//",
|
|
"Re: [user2/repo1] issue1 (#1)",
|
|
"//Re: //")
|
|
}
|