123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373 |
- // Copyright 2019 The Gitea Authors. All rights reserved.
- // SPDX-License-Identifier: MIT
-
- package mailer
-
- import (
- "bytes"
- "context"
- "fmt"
- "html/template"
- "regexp"
- "strings"
- "testing"
- texttmpl "text/template"
-
- activities_model "code.gitea.io/gitea/models/activities"
- "code.gitea.io/gitea/models/db"
- issues_model "code.gitea.io/gitea/models/issues"
- repo_model "code.gitea.io/gitea/models/repo"
- "code.gitea.io/gitea/models/unittest"
- user_model "code.gitea.io/gitea/models/user"
- "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 prepareMailerTest(t *testing.T) (doer *user_model.User, repo *repo_model.Repository, issue *issues_model.Issue, comment *issues_model.Comment) {
- assert.NoError(t, unittest.PrepareTestDatabase())
- mailService := setting.Mailer{
- From: "test@gitea.com",
- }
-
- setting.MailService = &mailService
- setting.Domain = "localhost"
-
- doer = unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
- repo = unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 1, Owner: doer})
- issue = unittest.AssertExistsAndLoadBean(t, &issues_model.Issue{ID: 1, Repo: repo, Poster: doer})
- assert.NoError(t, issue.LoadRepo(db.DefaultContext))
- comment = unittest.AssertExistsAndLoadBean(t, &issues_model.Comment{ID: 2, Issue: issue})
- return doer, repo, issue, comment
- }
-
- func TestComposeIssueCommentMessage(t *testing.T) {
- doer, _, issue, comment := prepareMailerTest(t)
-
- setting.IncomingEmail.Enabled = true
- defer func() { setting.IncomingEmail.Enabled = false }()
-
- subjectTemplates = texttmpl.Must(texttmpl.New("issue/comment").Parse(subjectTpl))
- bodyTemplates = template.Must(template.New("issue/comment").Parse(bodyTpl))
-
- recipients := []*user_model.User{{Name: "Test", Email: "test@gitea.com"}, {Name: "Test2", Email: "test2@gitea.com"}}
- msgs, err := composeIssueCommentMessages(&mailCommentContext{
- Context: context.TODO(), // TODO: use a correct context
- Issue: issue, Doer: doer, ActionType: activities_model.ActionCommentIssue,
- Content: "test body", Comment: comment,
- }, "en-US", recipients, false, "issue comment")
- assert.NoError(t, err)
- assert.Len(t, msgs, 2)
- gomailMsg := msgs[0].ToMessage()
- replyTo := gomailMsg.GetHeader("Reply-To")[0]
- subject := gomailMsg.GetHeader("Subject")[0]
-
- assert.Len(t, gomailMsg.GetHeader("To"), 1, "exactly one recipient is expected in the To field")
- tokenRegex := regexp.MustCompile(`\Aincoming\+(.+)@localhost\z`)
- assert.Regexp(t, tokenRegex, replyTo)
- token := tokenRegex.FindAllStringSubmatch(replyTo, 1)[0][1]
- assert.Equal(t, "Re: ", subject[:4], "Comment reply subject should contain Re:")
- assert.Equal(t, "Re: [user2/repo1] @user2 #1 - issue1", subject)
- assert.Equal(t, "<user2/repo1/issues/1@localhost>", gomailMsg.GetHeader("In-Reply-To")[0], "In-Reply-To header doesn't match")
- assert.ElementsMatch(t, []string{"<user2/repo1/issues/1@localhost>", "<reply-" + token + "@localhost>"}, gomailMsg.GetHeader("References"), "References header doesn't match")
- assert.Equal(t, "<user2/repo1/issues/1/comment/2@localhost>", gomailMsg.GetHeader("Message-ID")[0], "Message-ID header doesn't match")
- assert.Equal(t, "<mailto:"+replyTo+">", gomailMsg.GetHeader("List-Post")[0])
- assert.Len(t, gomailMsg.GetHeader("List-Unsubscribe"), 2) // url + mailto
- }
-
- func TestComposeIssueMessage(t *testing.T) {
- doer, _, issue, _ := prepareMailerTest(t)
-
- subjectTemplates = texttmpl.Must(texttmpl.New("issue/new").Parse(subjectTpl))
- bodyTemplates = template.Must(template.New("issue/new").Parse(bodyTpl))
-
- recipients := []*user_model.User{{Name: "Test", Email: "test@gitea.com"}, {Name: "Test2", Email: "test2@gitea.com"}}
- msgs, err := composeIssueCommentMessages(&mailCommentContext{
- Context: context.TODO(), // TODO: use a correct context
- Issue: issue, Doer: doer, ActionType: activities_model.ActionCreateIssue,
- Content: "test body",
- }, "en-US", recipients, false, "issue create")
- assert.NoError(t, err)
- assert.Len(t, msgs, 2)
-
- gomailMsg := msgs[0].ToMessage()
- mailto := gomailMsg.GetHeader("To")
- subject := gomailMsg.GetHeader("Subject")
- messageID := gomailMsg.GetHeader("Message-ID")
- inReplyTo := gomailMsg.GetHeader("In-Reply-To")
- references := gomailMsg.GetHeader("References")
-
- assert.Len(t, mailto, 1, "exactly one recipient is expected in the To field")
- assert.Equal(t, "[user2/repo1] @user2 #1 - issue1", subject[0])
- assert.Equal(t, "<user2/repo1/issues/1@localhost>", inReplyTo[0], "In-Reply-To header doesn't match")
- assert.Equal(t, "<user2/repo1/issues/1@localhost>", references[0], "References header doesn't match")
- assert.Equal(t, "<user2/repo1/issues/1@localhost>", messageID[0], "Message-ID header doesn't match")
- assert.Empty(t, gomailMsg.GetHeader("List-Post")) // incoming mail feature disabled
- assert.Len(t, gomailMsg.GetHeader("List-Unsubscribe"), 1) // url without mailto
- }
-
- func TestTemplateSelection(t *testing.T) {
- doer, repo, issue, comment := prepareMailerTest(t)
- recipients := []*user_model.User{{Name: "Test", Email: "test@gitea.com"}}
-
- subjectTemplates = texttmpl.Must(texttmpl.New("issue/default").Parse("issue/default/subject"))
- texttmpl.Must(subjectTemplates.New("issue/new").Parse("issue/new/subject"))
- texttmpl.Must(subjectTemplates.New("pull/comment").Parse("pull/comment/subject"))
- texttmpl.Must(subjectTemplates.New("issue/close").Parse("")) // Must default to fallback subject
-
- bodyTemplates = template.Must(template.New("issue/default").Parse("issue/default/body"))
- template.Must(bodyTemplates.New("issue/new").Parse("issue/new/body"))
- template.Must(bodyTemplates.New("pull/comment").Parse("pull/comment/body"))
- template.Must(bodyTemplates.New("issue/close").Parse("issue/close/body"))
-
- expect := func(t *testing.T, msg *Message, expSubject, expBody string) {
- subject := msg.ToMessage().GetHeader("Subject")
- msgbuf := new(bytes.Buffer)
- _, _ = msg.ToMessage().WriteTo(msgbuf)
- wholemsg := msgbuf.String()
- assert.Equal(t, []string{expSubject}, subject)
- assert.Contains(t, wholemsg, expBody)
- }
-
- msg := testComposeIssueCommentMessage(t, &mailCommentContext{
- Context: context.TODO(), // TODO: use a correct context
- Issue: issue, Doer: doer, ActionType: activities_model.ActionCreateIssue,
- Content: "test body",
- }, recipients, false, "TestTemplateSelection")
- expect(t, msg, "issue/new/subject", "issue/new/body")
-
- msg = testComposeIssueCommentMessage(t, &mailCommentContext{
- Context: context.TODO(), // TODO: use a correct context
- Issue: issue, Doer: doer, ActionType: activities_model.ActionCommentIssue,
- Content: "test body", Comment: comment,
- }, recipients, false, "TestTemplateSelection")
- expect(t, msg, "issue/default/subject", "issue/default/body")
-
- pull := unittest.AssertExistsAndLoadBean(t, &issues_model.Issue{ID: 2, Repo: repo, Poster: doer})
- comment = unittest.AssertExistsAndLoadBean(t, &issues_model.Comment{ID: 4, Issue: pull})
- msg = testComposeIssueCommentMessage(t, &mailCommentContext{
- Context: context.TODO(), // TODO: use a correct context
- Issue: pull, Doer: doer, ActionType: activities_model.ActionCommentPull,
- Content: "test body", Comment: comment,
- }, recipients, false, "TestTemplateSelection")
- expect(t, msg, "pull/comment/subject", "pull/comment/body")
-
- msg = testComposeIssueCommentMessage(t, &mailCommentContext{
- Context: context.TODO(), // TODO: use a correct context
- Issue: issue, Doer: doer, ActionType: activities_model.ActionCloseIssue,
- Content: "test body", Comment: comment,
- }, recipients, false, "TestTemplateSelection")
- expect(t, msg, "Re: [user2/repo1] issue1 (#1)", "issue/close/body")
- }
-
- func TestTemplateServices(t *testing.T) {
- doer, _, issue, comment := prepareMailerTest(t)
- assert.NoError(t, issue.LoadRepo(db.DefaultContext))
-
- expect := func(t *testing.T, issue *issues_model.Issue, comment *issues_model.Comment, doer *user_model.User,
- actionType activities_model.ActionType, fromMention bool, tplSubject, tplBody, expSubject, expBody string,
- ) {
- subjectTemplates = texttmpl.Must(texttmpl.New("issue/default").Parse(tplSubject))
- bodyTemplates = template.Must(template.New("issue/default").Parse(tplBody))
-
- recipients := []*user_model.User{{Name: "Test", Email: "test@gitea.com"}}
- msg := testComposeIssueCommentMessage(t, &mailCommentContext{
- Context: context.TODO(), // TODO: use a correct context
- Issue: issue, Doer: doer, ActionType: actionType,
- Content: "test body", Comment: comment,
- }, recipients, fromMention, "TestTemplateServices")
-
- subject := msg.ToMessage().GetHeader("Subject")
- msgbuf := new(bytes.Buffer)
- _, _ = msg.ToMessage().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, activities_model.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, activities_model.ActionCommentIssue, true,
- "{{if .IsMention}}must render{{end}}",
- "//subject is: {{.Subject}}//",
- "must render",
- "//subject is: must render//")
-
- expect(t, issue, comment, doer, activities_model.ActionCommentIssue, true,
- "{{.FallbackSubject}}",
- "//{{.SubjectPrefix}}//",
- "Re: [user2/repo1] issue1 (#1)",
- "//Re: //")
- }
-
- func testComposeIssueCommentMessage(t *testing.T, ctx *mailCommentContext, recipients []*user_model.User, fromMention bool, info string) *Message {
- msgs, err := composeIssueCommentMessages(ctx, "en-US", recipients, fromMention, info)
- assert.NoError(t, err)
- assert.Len(t, msgs, 1)
- return msgs[0]
- }
-
- func TestGenerateAdditionalHeaders(t *testing.T) {
- doer, _, issue, _ := prepareMailerTest(t)
-
- ctx := &mailCommentContext{Context: context.TODO() /* TODO: use a correct context */, Issue: issue, Doer: doer}
- recipient := &user_model.User{Name: "Test", Email: "test@gitea.com"}
-
- headers := generateAdditionalHeaders(ctx, "dummy-reason", recipient)
-
- expected := map[string]string{
- "List-ID": "user2/repo1 <repo1.user2.localhost>",
- "List-Archive": "<https://try.gitea.io/user2/repo1>",
- "X-Gitea-Reason": "dummy-reason",
- "X-Gitea-Sender": "< U<se>r Tw<o > ><",
- "X-Gitea-Recipient": "Test",
- "X-Gitea-Recipient-Address": "test@gitea.com",
- "X-Gitea-Repository": "repo1",
- "X-Gitea-Repository-Path": "user2/repo1",
- "X-Gitea-Repository-Link": "https://try.gitea.io/user2/repo1",
- "X-Gitea-Issue-ID": "1",
- "X-Gitea-Issue-Link": "https://try.gitea.io/user2/repo1/issues/1",
- }
-
- for key, value := range expected {
- if assert.Contains(t, headers, key) {
- assert.Equal(t, value, headers[key])
- }
- }
- }
-
- func Test_createReference(t *testing.T) {
- _, _, issue, comment := prepareMailerTest(t)
- _, _, pullIssue, _ := prepareMailerTest(t)
- pullIssue.IsPull = true
-
- type args struct {
- issue *issues_model.Issue
- comment *issues_model.Comment
- actionType activities_model.ActionType
- }
- tests := []struct {
- name string
- args args
- prefix string
- }{
- {
- name: "Open Issue",
- args: args{
- issue: issue,
- actionType: activities_model.ActionCreateIssue,
- },
- prefix: fmt.Sprintf("<%s/issues/%d@%s>", issue.Repo.FullName(), issue.Index, setting.Domain),
- },
- {
- name: "Open Pull",
- args: args{
- issue: pullIssue,
- actionType: activities_model.ActionCreatePullRequest,
- },
- prefix: fmt.Sprintf("<%s/pulls/%d@%s>", issue.Repo.FullName(), issue.Index, setting.Domain),
- },
- {
- name: "Comment Issue",
- args: args{
- issue: issue,
- comment: comment,
- actionType: activities_model.ActionCommentIssue,
- },
- prefix: fmt.Sprintf("<%s/issues/%d/comment/%d@%s>", issue.Repo.FullName(), issue.Index, comment.ID, setting.Domain),
- },
- {
- name: "Comment Pull",
- args: args{
- issue: pullIssue,
- comment: comment,
- actionType: activities_model.ActionCommentPull,
- },
- prefix: fmt.Sprintf("<%s/pulls/%d/comment/%d@%s>", issue.Repo.FullName(), issue.Index, comment.ID, setting.Domain),
- },
- {
- name: "Close Issue",
- args: args{
- issue: issue,
- actionType: activities_model.ActionCloseIssue,
- },
- prefix: fmt.Sprintf("<%s/issues/%d/close/", issue.Repo.FullName(), issue.Index),
- },
- {
- name: "Close Pull",
- args: args{
- issue: pullIssue,
- actionType: activities_model.ActionClosePullRequest,
- },
- prefix: fmt.Sprintf("<%s/pulls/%d/close/", issue.Repo.FullName(), issue.Index),
- },
- {
- name: "Reopen Issue",
- args: args{
- issue: issue,
- actionType: activities_model.ActionReopenIssue,
- },
- prefix: fmt.Sprintf("<%s/issues/%d/reopen/", issue.Repo.FullName(), issue.Index),
- },
- {
- name: "Reopen Pull",
- args: args{
- issue: pullIssue,
- actionType: activities_model.ActionReopenPullRequest,
- },
- prefix: fmt.Sprintf("<%s/pulls/%d/reopen/", issue.Repo.FullName(), issue.Index),
- },
- {
- name: "Merge Pull",
- args: args{
- issue: pullIssue,
- actionType: activities_model.ActionMergePullRequest,
- },
- prefix: fmt.Sprintf("<%s/pulls/%d/merge/", issue.Repo.FullName(), issue.Index),
- },
- {
- name: "Ready Pull",
- args: args{
- issue: pullIssue,
- actionType: activities_model.ActionPullRequestReadyForReview,
- },
- prefix: fmt.Sprintf("<%s/pulls/%d/ready/", issue.Repo.FullName(), issue.Index),
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- got := createReference(tt.args.issue, tt.args.comment, tt.args.actionType)
- if !strings.HasPrefix(got, tt.prefix) {
- t.Errorf("createReference() = %v, want %v", got, tt.prefix)
- }
- })
- }
- }
|