opendev/gerrit
Code Issues Proposed changes

Merge "Add regression tests and new headers to email"

Browse Source
This commit is contained in:
ekempin 2016-11-16 03:11:56 +00:00 committed by Gerrit Code Review
commit 2b1a9cfc9e
5 changed files with 174 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

147
gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/server/mail/MailMetadataIT.java Normal file
View File

@ -0,0 +1,147 @@
// Copyright (C) 2016 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.gerrit.acceptance.server.mail;
import static com.google.common.truth.Truth.assertThat;
import com.google.common.collect.Iterables;
import com.google.gerrit.acceptance.AbstractDaemonTest;
import com.google.gerrit.acceptance.PushOneCommit;
import com.google.gerrit.extensions.api.changes.ReviewInput;
import com.google.gerrit.extensions.common.ChangeMessageInfo;
import com.google.gerrit.server.mail.MailUtil;
import com.google.gerrit.server.mail.send.EmailHeader;
import com.google.gerrit.testutil.FakeEmailSender;
import org.junit.Test;
import java.sql.Timestamp;
import java.time.ZoneId;
import java.time.ZonedDateTime;
import java.util.Collection;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/** Tests the presence of required metadata in email headers, text and html. */
public class MailMetadataIT extends AbstractDaemonTest {
@Test
public void metadataOnNewChange() throws Exception {
PushOneCommit.Result newChange = createChange();
gApi.changes()
.id(newChange.getChangeId())
.addReviewer(user.getId().toString());
List<FakeEmailSender.Message> emails = sender.getMessages();
assertThat(emails).hasSize(1);
FakeEmailSender.Message message = emails.get(0);
String changeURL = "<" + canonicalWebUrl.get() +
newChange.getChange().getId().get() + ">";
Map<String, Object> expectedHeaders = new HashMap<>();
expectedHeaders.put("Gerrit-PatchSet", "1");
expectedHeaders.put("Gerrit-Change-Id", newChange.getChangeId());
expectedHeaders.put("Gerrit-MessageType", "newchange");
expectedHeaders.put("Gerrit-Commit", newChange.getCommit().getId().name());
expectedHeaders.put("Gerrit-ChangeURL", changeURL);
assertHeaders(message.headers(), expectedHeaders);
// Remove metadata that is not present in email
expectedHeaders.remove("Gerrit-ChangeURL");
expectedHeaders.remove("Gerrit-Commit");
assertTextFooter(message.body(), expectedHeaders);
}
@Test
public void metadataOnNewComment() throws Exception {
PushOneCommit.Result newChange = createChange();
gApi.changes()
.id(newChange.getChangeId())
.addReviewer(user.getId().toString());
sender.clear();
// Review change
ReviewInput input = new ReviewInput();
input.message = "Test";
revision(newChange).review(input);
setApiUser(user);
Collection<ChangeMessageInfo> result =
gApi.changes().id(newChange.getChangeId()).get().messages;
assertThat(result).isNotEmpty();
List<FakeEmailSender.Message> emails = sender.getMessages();
assertThat(emails).hasSize(1);
FakeEmailSender.Message message = emails.get(0);
String changeURL = "<" + canonicalWebUrl.get() +
newChange.getChange().getId().get() + ">";
Map<String, Object> expectedHeaders = new HashMap<>();
expectedHeaders.put("Gerrit-PatchSet", "1");
expectedHeaders.put("Gerrit-Change-Id", newChange.getChangeId());
expectedHeaders.put("Gerrit-MessageType", "comment");
expectedHeaders.put("Gerrit-Commit",
newChange.getCommit().getId().name());
expectedHeaders.put("Gerrit-ChangeURL", changeURL);
expectedHeaders.put("Gerrit-Comment-Date",
Iterables.getLast(result).date);
assertHeaders(message.headers(), expectedHeaders);
// Remove metadata that is not present in email
expectedHeaders.remove("Gerrit-ChangeURL");
expectedHeaders.remove("Gerrit-Commit");
assertTextFooter(message.body(), expectedHeaders);
}
private static void assertHeaders(Map<String, EmailHeader> have,
Map<String, Object> want) throws Exception {
for (Map.Entry<String, Object> entry : want.entrySet()) {
if (entry.getValue() instanceof String) {
assertThat(have).containsEntry("X-" + entry.getKey(),
new EmailHeader.String((String) entry.getValue()));
} else if (entry.getValue() instanceof Date) {
assertThat(have).containsEntry("X-" + entry.getKey(),
new EmailHeader.Date((Date) entry.getValue()));
} else {
throw new Exception("Object has unsupported type: " +
entry.getValue().getClass().getName() +
" must be java.util.Date or java.lang.String for key " +
entry.getKey());
}
}
}
private static void assertTextFooter(String body,
Map<String, Object> want) throws Exception {
for (Map.Entry<String, Object> entry : want.entrySet()) {
if (entry.getValue() instanceof String) {
assertThat(body).contains(entry.getKey() + ": " + entry.getValue());
} else if (entry.getValue() instanceof Timestamp) {
assertThat(body).contains(entry.getKey() + ": " +
MailUtil.rfcDateformatter.format(ZonedDateTime.ofInstant(
((Timestamp) entry.getValue()).toInstant(),
ZoneId.of("UTC"))));
} else {
throw new Exception("Object has unsupported type: " +
entry.getValue().getClass().getName() +
" must be java.util.Date or java.lang.String for key " +
entry.getKey());
}
}
}
}

15
gerrit-server/src/main/java/com/google/gerrit/server/mail/send/ChangeEmail.java
View File

@ -156,12 +156,15 @@ public abstract class ChangeEmail extends NotificationEmail {
}
}
if (patchSet != null && patchSetInfo == null) {
try {
patchSetInfo = args.patchSetInfoFactory.get(
args.db.get(), changeData.notes(), patchSet.getId());
} catch (PatchSetInfoNotAvailableException | OrmException err) {
patchSetInfo = null;
if (patchSet != null) {
setHeader("X-Gerrit-PatchSet", patchSet.getPatchSetId() + "");
if (patchSetInfo == null) {
try {
patchSetInfo = args.patchSetInfoFactory.get(
args.db.get(), changeData.notes(), patchSet.getId());
} catch (PatchSetInfoNotAvailableException | OrmException err) {
patchSetInfo = null;
}
}
}
authors = getAuthors();

14
gerrit-server/src/main/java/com/google/gerrit/server/mail/send/CommentSender.java
View File

@ -27,6 +27,7 @@ import com.google.gerrit.reviewdb.client.Patch;
import com.google.gerrit.reviewdb.client.Project;
import com.google.gerrit.reviewdb.client.RobotComment;
import com.google.gerrit.server.CommentsUtil;
import com.google.gerrit.server.mail.MailUtil;
import com.google.gerrit.server.patch.PatchFile;
import com.google.gerrit.server.patch.PatchList;
import com.google.gerrit.server.patch.PatchListNotAvailableException;
@ -40,6 +41,8 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.IOException;
import java.time.ZoneId;
import java.time.ZonedDateTime;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
@ -133,6 +136,10 @@ public class CommentSender extends ReplyToChangeSender {
bccStarredBy();
includeWatchers(NotifyType.ALL_COMMENTS);
}
// Add header that enables identifying comments on parsed email.
// Grouping is currently done by timestamp.
setHeader("X-Gerrit-Comment-Date", timestamp);
}
@Override
@ -540,6 +547,7 @@ public class CommentSender extends ReplyToChangeSender {
try (Repository repo = getRepository()) {
soyContext.put("commentFiles", getCommentGroupsTemplateData(repo));
}
soyContext.put("commentTimestamp", getCommentTimestamp());
}
private String getLine(PatchFile fileInfo, short side, int lineNbr) {
@ -562,6 +570,12 @@ public class CommentSender extends ReplyToChangeSender {
}
}
private String getCommentTimestamp() {
// Grouping is currently done by timestamp.
return MailUtil.rfcDateformatter.format(
ZonedDateTime.ofInstant(timestamp.toInstant(), ZoneId.of("UTC")));
}
@Override
protected boolean supportsHtml() {
return true;

2
gerrit-server/src/main/resources/com/google/gerrit/server/mail/CommentFooter.soy
View File

@ -21,8 +21,10 @@
* that will be appended to emails related to a user submitting comments on
* changes.
* @param commentFiles
* @param commentTimestamp
*/
{template .CommentFooter autoescape="strict" kind="text"}
Gerrit-Comment-Date: {$commentTimestamp}
{if length($commentFiles) > 0}
Gerrit-HasComments: Yes
{else}

2
gerrit-server/src/main/resources/com/google/gerrit/server/mail/CommentFooterHtml.soy
View File

@ -18,6 +18,7 @@
/**
* @param commentFiles
* @param commentTimestamp
*/
{template .CommentFooterHtml autoescape="strict" kind="html"}
{let $footerStyle kind="css"}
@ -25,6 +26,7 @@
{/let}
<p style="{$footerStyle}">
Gerrit-Comment-Date: {$commentTimestamp}
{if length($commentFiles) > 0}
Gerrit-HasComments: Yes
{else}