blob: 06d934915a219709233d4bff80b7cd836b3d75d3 [file] [log] [blame]
// 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.collect.ImmutableSet.toImmutableSet;
import static com.google.common.truth.Truth.assertThat;
import static com.google.gerrit.acceptance.testsuite.project.TestProjectUpdate.block;
import static com.google.gerrit.entities.Patch.PATCHSET_LEVEL;
import static com.google.gerrit.server.group.SystemGroupBackend.REGISTERED_USERS;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.clearInvocations;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Iterables;
import com.google.common.collect.Streams;
import com.google.gerrit.acceptance.config.GerritConfig;
import com.google.gerrit.acceptance.testsuite.account.AccountOperations;
import com.google.gerrit.acceptance.testsuite.project.ProjectOperations;
import com.google.gerrit.entities.EmailHeader;
import com.google.gerrit.entities.Permission;
import com.google.gerrit.extensions.annotations.Exports;
import com.google.gerrit.extensions.api.changes.ReviewInput;
import com.google.gerrit.extensions.api.changes.ReviewInput.CommentInput;
import com.google.gerrit.extensions.api.changes.ReviewInput.RobotCommentInput;
import com.google.gerrit.extensions.common.ChangeInfo;
import com.google.gerrit.extensions.common.ChangeMessageInfo;
import com.google.gerrit.extensions.common.CommentInfo;
import com.google.gerrit.extensions.config.FactoryModule;
import com.google.gerrit.extensions.restapi.RestApiException;
import com.google.gerrit.extensions.validators.CommentForValidation;
import com.google.gerrit.extensions.validators.CommentValidationContext;
import com.google.gerrit.extensions.validators.CommentValidator;
import com.google.gerrit.mail.MailMessage;
import com.google.gerrit.mail.MailProcessingUtil;
import com.google.gerrit.server.mail.receive.MailProcessor;
import com.google.gerrit.server.util.time.TimeUtil;
import com.google.gerrit.testing.FakeEmailSender.Message;
import com.google.gerrit.testing.TestCommentHelper;
import com.google.inject.Inject;
import com.google.inject.Module;
import java.net.URL;
import java.time.ZoneId;
import java.time.ZonedDateTime;
import java.util.Collection;
import java.util.List;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;
public class MailProcessorIT extends AbstractMailIT {
@Inject private MailProcessor mailProcessor;
@Inject private AccountOperations accountOperations;
@Inject private TestCommentHelper testCommentHelper;
@Inject private ProjectOperations projectOperations;
private static final CommentValidator mockCommentValidator = mock(CommentValidator.class);
private static final String COMMENT_TEXT = "The comment text";
@Override
public Module createModule() {
return new FactoryModule() {
@Override
public void configure() {
bind(CommentValidator.class)
.annotatedWith(Exports.named(mockCommentValidator.getClass()))
.toInstance(mockCommentValidator);
bind(CommentValidator.class).toInstance(mockCommentValidator);
}
};
}
@BeforeClass
public static void setUpMock() {
// Let the mock comment validator accept all comments during test setup.
when(mockCommentValidator.validateComments(any(), any())).thenReturn(ImmutableList.of());
}
@Before
public void setUp() {
clearInvocations(mockCommentValidator);
}
@Test
public void parseAndPersistPatchsetLevelComment() throws Exception {
String changeId = createChangeWithReview();
ChangeInfo changeInfo = gApi.changes().id(changeId).get();
String ts =
MailProcessingUtil.rfcDateformatter.format(
ZonedDateTime.ofInstant(
gApi.changes().id(changeId).get().updated.toInstant(), ZoneId.of("UTC")));
// Build Message
MailMessage.Builder b = messageBuilderWithDefaultFields();
String txt = newPlaintextBody(getChangeUrl(changeInfo) + "/1", "Test Message", null, null);
b.textContent(txt + textFooterForChange(changeInfo._number, ts));
mailProcessor.process(b.build());
Collection<ChangeMessageInfo> messages = gApi.changes().id(changeId).get().messages;
assertThat(messages).hasSize(3);
assertThat(Iterables.getLast(messages).message).isEqualTo("Patch Set 1:\n\n(1 comment)");
assertThat(Iterables.getLast(messages).tag).isEqualTo("mailMessageId=some id");
// Assert comment
List<CommentInfo> comments = gApi.changes().id(changeId).current().commentsAsList();
assertThat(comments).hasSize(3);
assertThat(comments.get(0).path).isEqualTo(PATCHSET_LEVEL);
assertThat(comments.get(0).message).isEqualTo("Test Message");
assertThat(comments.get(0).tag).isEqualTo("mailMessageId=some id");
assertThat(comments.get(0).parent).isNull();
assertThat(comments.get(0).side).isNull();
assertThat(comments.get(0).line).isNull();
assertThat(comments.get(0).parent).isNull();
assertThat(comments.get(0).inReplyTo).isNull();
}
@Test
public void parseAndPersistInlineComment() throws Exception {
String changeId = createChangeWithReview();
ChangeInfo changeInfo = gApi.changes().id(changeId).get();
String ts =
MailProcessingUtil.rfcDateformatter.format(
ZonedDateTime.ofInstant(
gApi.changes().id(changeId).get().updated.toInstant(), ZoneId.of("UTC")));
// Build Message
MailMessage.Builder b = messageBuilderWithDefaultFields();
String txt =
newPlaintextBody(getChangeUrl(changeInfo) + "/1", null, "Some Inline Comment", null);
b.textContent(txt + textFooterForChange(changeInfo._number, ts));
mailProcessor.process(b.build());
// Assert messages
Collection<ChangeMessageInfo> messages = gApi.changes().id(changeId).get().messages;
assertThat(messages).hasSize(3);
assertThat(Iterables.getLast(messages).message).isEqualTo("Patch Set 1:\n\n(1 comment)");
assertThat(Iterables.getLast(messages).tag).isEqualTo("mailMessageId=some id");
// Assert comment
List<CommentInfo> comments = gApi.changes().id(changeId).current().commentsAsList();
assertThat(comments).hasSize(3);
assertThat(comments.get(2).message).isEqualTo("Some Inline Comment");
assertThat(comments.get(2).tag).isEqualTo("mailMessageId=some id");
assertThat(comments.get(2).inReplyTo).isEqualTo(comments.get(1).id);
}
@Test
public void parseAndPersistFileComment() throws Exception {
String changeId = createChangeWithReview();
ChangeInfo changeInfo = gApi.changes().id(changeId).get();
String ts =
MailProcessingUtil.rfcDateformatter.format(
ZonedDateTime.ofInstant(
gApi.changes().id(changeId).get().updated.toInstant(), ZoneId.of("UTC")));
// Build Message
MailMessage.Builder b = messageBuilderWithDefaultFields();
String txt =
newPlaintextBody(getChangeUrl(changeInfo) + "/1", null, null, "Some Comment on File 1");
b.textContent(txt + textFooterForChange(changeInfo._number, ts));
mailProcessor.process(b.build());
// Assert messages
Collection<ChangeMessageInfo> messages = gApi.changes().id(changeId).get().messages;
assertThat(messages).hasSize(3);
assertThat(Iterables.getLast(messages).message).isEqualTo("Patch Set 1:\n\n(1 comment)");
assertThat(Iterables.getLast(messages).tag).isEqualTo("mailMessageId=some id");
// Assert comment
List<CommentInfo> comments = gApi.changes().id(changeId).current().commentsAsList();
assertThat(comments).hasSize(3);
assertThat(comments.get(0).message).isEqualTo("Some Comment on File 1");
assertThat(comments.get(0).inReplyTo).isNull();
assertThat(comments.get(0).tag).isEqualTo("mailMessageId=some id");
assertThat(comments.get(0).path).isEqualTo("gerrit-server/test.txt");
}
@Test
public void parseAndPersistMessageTwice() throws Exception {
String changeId = createChangeWithReview();
ChangeInfo changeInfo = gApi.changes().id(changeId).get();
String ts =
MailProcessingUtil.rfcDateformatter.format(
ZonedDateTime.ofInstant(
gApi.changes().id(changeId).get().updated.toInstant(), ZoneId.of("UTC")));
// Build Message
MailMessage.Builder b = messageBuilderWithDefaultFields();
String txt =
newPlaintextBody(getChangeUrl(changeInfo) + "/1", null, "Some Inline Comment", null);
b.textContent(txt + textFooterForChange(changeInfo._number, ts));
mailProcessor.process(b.build());
List<CommentInfo> comments = gApi.changes().id(changeId).current().commentsAsList();
assertThat(comments).hasSize(3);
// Check that the comment has not been persisted a second time
mailProcessor.process(b.build());
comments = gApi.changes().id(changeId).current().commentsAsList();
assertThat(comments).hasSize(3);
}
@Test
public void parseAndPersistMessageFromInactiveAccount() throws Exception {
String changeId = createChangeWithReview();
ChangeInfo changeInfo = gApi.changes().id(changeId).get();
List<CommentInfo> comments = gApi.changes().id(changeId).current().commentsAsList();
String ts =
MailProcessingUtil.rfcDateformatter.format(
ZonedDateTime.ofInstant(
gApi.changes().id(changeId).get().updated.toInstant(), ZoneId.of("UTC")));
assertThat(comments).hasSize(2);
// Build Message
MailMessage.Builder b = messageBuilderWithDefaultFields();
String txt =
newPlaintextBody(getChangeUrl(changeInfo) + "/1", null, "Some Inline Comment", null);
b.textContent(txt + textFooterForChange(changeInfo._number, ts));
// Set account state to inactive
accountOperations.account(user.id()).forUpdate().inactive().update();
mailProcessor.process(b.build());
comments = gApi.changes().id(changeId).current().commentsAsList();
// Check that comment size has not changed
assertThat(comments).hasSize(2);
}
@Test
public void sendNotificationAfterPersistingComments() throws Exception {
String changeId = createChangeWithReview();
ChangeInfo changeInfo = gApi.changes().id(changeId).get();
List<CommentInfo> comments = gApi.changes().id(changeId).current().commentsAsList();
assertThat(comments).hasSize(2);
String ts =
MailProcessingUtil.rfcDateformatter.format(
ZonedDateTime.ofInstant(
gApi.changes().id(changeId).get().updated.toInstant(), ZoneId.of("UTC")));
// Build Message
String txt = newPlaintextBody(getChangeUrl(changeInfo) + "/1", "Test Message", null, null);
MailMessage.Builder b =
messageBuilderWithDefaultFields()
.from(user.getNameEmail())
.textContent(txt + textFooterForChange(changeInfo._number, ts));
sender.clear();
mailProcessor.process(b.build());
assertNotifyTo(admin);
}
@Test
public void sendNotificationOnMissingMetadatas() throws Exception {
String changeId = createChangeWithReview();
ChangeInfo changeInfo = gApi.changes().id(changeId).get();
List<CommentInfo> comments = gApi.changes().id(changeId).current().commentsAsList();
assertThat(comments).hasSize(2);
String ts = "null"; // Erroneous timestamp to be used in erroneous metadatas
// Build Message
String txt = newPlaintextBody(getChangeUrl(changeInfo) + "/1", "Test Message", null, null);
MailMessage.Builder b =
messageBuilderWithDefaultFields()
.from(user.getNameEmail())
.textContent(txt + textFooterForChange(changeInfo._number, ts));
sender.clear();
mailProcessor.process(b.build());
assertNotifyTo(user);
Message message = sender.nextMessage();
assertThat(message.body()).contains("was unable to parse your email");
assertThat(message.headers()).containsKey("Subject");
}
@Test
public void sendNotificationOnProjectNotFound() throws Exception {
String ts =
MailProcessingUtil.rfcDateformatter.format(
ZonedDateTime.ofInstant(TimeUtil.now(), ZoneId.of("UTC")));
String changeUrl = canonicalWebUrl.get() + "c/non-existing-project/+/123";
// Build Message
String txt = newPlaintextBody(changeUrl + "/1", "Test Message", null, null);
MailMessage.Builder b =
messageBuilderWithDefaultFields()
.from(user.getNameEmail())
.textContent(txt + textFooterForChange(123, ts));
sender.clear();
mailProcessor.process(b.build());
assertNotifyTo(user);
Message message = sender.nextMessage();
assertThat(message.body())
.contains(
"Gerrit Code Review was unable to process your email because the change was not"
+ " found.");
assertThat(message.headers()).containsKey("Subject");
}
@Test
public void sendNotificationOnProjectNotVisible() throws Exception {
String changeId = createChangeWithReview();
ChangeInfo changeInfo = gApi.changes().id(changeId).get();
String ts =
MailProcessingUtil.rfcDateformatter.format(
ZonedDateTime.ofInstant(
gApi.changes().id(changeId).get().updated.toInstant(), ZoneId.of("UTC")));
// Block read permissions on the project.
projectOperations
.project(project)
.forUpdate()
.add(block(Permission.READ).ref("refs/*").group(REGISTERED_USERS))
.update();
// Build Message
String txt = newPlaintextBody(getChangeUrl(changeInfo) + "/1", "Test Message", null, null);
MailMessage.Builder b =
messageBuilderWithDefaultFields()
.from(user.getNameEmail())
.textContent(txt + textFooterForChange(changeInfo._number, ts));
sender.clear();
mailProcessor.process(b.build());
assertNotifyTo(user);
Message message = sender.nextMessage();
assertThat(message.body())
.contains(
"Gerrit Code Review was unable to process your email because the change was not"
+ " found.");
assertThat(message.headers()).containsKey("Subject");
}
@Test
public void sendNotificationOnChangeNotFound() throws Exception {
String changeId = createChangeWithReview();
ChangeInfo changeInfo = gApi.changes().id(changeId).get();
String ts =
MailProcessingUtil.rfcDateformatter.format(
ZonedDateTime.ofInstant(
gApi.changes().id(changeId).get().updated.toInstant(), ZoneId.of("UTC")));
// Delete the change so that it's not found.
gApi.changes().id(changeId).delete();
// Build Message
String txt = newPlaintextBody(getChangeUrl(changeInfo) + "/1", "Test Message", null, null);
MailMessage.Builder b =
messageBuilderWithDefaultFields()
.from(user.getNameEmail())
.textContent(txt + textFooterForChange(changeInfo._number, ts));
sender.clear();
mailProcessor.process(b.build());
assertNotifyTo(user);
Message message = sender.nextMessage();
assertThat(message.body())
.contains(
"Gerrit Code Review was unable to process your email because the change was not"
+ " found.");
assertThat(message.headers()).containsKey("Subject");
}
@Test
public void sendNotificationOnChangeNotVisible() throws Exception {
String changeId = createChangeWithReview();
ChangeInfo changeInfo = gApi.changes().id(changeId).get();
String ts =
MailProcessingUtil.rfcDateformatter.format(
ZonedDateTime.ofInstant(
gApi.changes().id(changeId).get().updated.toInstant(), ZoneId.of("UTC")));
// Make change private so that it's no visible to user.
gApi.changes().id(changeId).setPrivate(true);
// Build Message
String txt = newPlaintextBody(getChangeUrl(changeInfo) + "/1", "Test Message", null, null);
MailMessage.Builder b =
messageBuilderWithDefaultFields()
.from(user.getNameEmail())
.textContent(txt + textFooterForChange(changeInfo._number, ts));
sender.clear();
mailProcessor.process(b.build());
assertNotifyTo(user);
Message message = sender.nextMessage();
assertThat(message.body())
.contains(
"Gerrit Code Review was unable to process your email because the change was not"
+ " found.");
assertThat(message.headers()).containsKey("Subject");
}
@Test
public void validateChangeMessage_rejected() throws Exception {
String changeId = createChangeWithReview();
ChangeInfo changeInfo = gApi.changes().id(changeId).get();
String ts =
MailProcessingUtil.rfcDateformatter.format(
ZonedDateTime.ofInstant(
gApi.changes().id(changeId).get().updated.toInstant(), ZoneId.of("UTC")));
setupFailValidation(
CommentForValidation.CommentType.CHANGE_MESSAGE, changeInfo.project, changeInfo._number);
MailMessage.Builder b = messageBuilderWithDefaultFields();
String txt = newPlaintextBody(getChangeUrl(changeInfo) + "/1", COMMENT_TEXT, null, null);
b.textContent(txt + textFooterForChange(changeInfo._number, ts));
Collection<CommentInfo> commentsBefore = testCommentHelper.getPublishedComments(changeId);
mailProcessor.process(b.build());
assertThat(testCommentHelper.getPublishedComments(changeId)).isEqualTo(commentsBefore);
assertNotifyTo(user);
Message message = sender.nextMessage();
assertThat(message.body()).contains("rejected one or more comments");
// ensure the message header contains a valid message id.
assertThat(((EmailHeader.String) (message.headers().get("Message-ID"))).getString())
.containsMatch("<someid-REJECTION-HTML@" + new URL(canonicalWebUrl.get()).getHost() + ">");
}
@Test
public void validateInlineComment_rejected() throws Exception {
String changeId = createChangeWithReview();
ChangeInfo changeInfo = gApi.changes().id(changeId).get();
String ts =
MailProcessingUtil.rfcDateformatter.format(
ZonedDateTime.ofInstant(
gApi.changes().id(changeId).get().updated.toInstant(), ZoneId.of("UTC")));
setupFailValidation(
CommentForValidation.CommentType.INLINE_COMMENT, changeInfo.project, changeInfo._number);
MailMessage.Builder b = messageBuilderWithDefaultFields();
String txt = newPlaintextBody(getChangeUrl(changeInfo) + "/1", null, COMMENT_TEXT, null);
b.textContent(txt + textFooterForChange(changeInfo._number, ts));
Collection<CommentInfo> commentsBefore = testCommentHelper.getPublishedComments(changeId);
mailProcessor.process(b.build());
assertThat(testCommentHelper.getPublishedComments(changeId)).isEqualTo(commentsBefore);
assertNotifyTo(user);
Message message = sender.nextMessage();
assertThat(message.body()).contains("rejected one or more comments");
}
@Test
public void validateFileComment_rejected() throws Exception {
String changeId = createChangeWithReview();
ChangeInfo changeInfo = gApi.changes().id(changeId).get();
String ts =
MailProcessingUtil.rfcDateformatter.format(
ZonedDateTime.ofInstant(
gApi.changes().id(changeId).get().updated.toInstant(), ZoneId.of("UTC")));
setupFailValidation(
CommentForValidation.CommentType.FILE_COMMENT, changeInfo.project, changeInfo._number);
MailMessage.Builder b = messageBuilderWithDefaultFields();
String txt = newPlaintextBody(getChangeUrl(changeInfo) + "/1", null, null, COMMENT_TEXT);
b.textContent(txt + textFooterForChange(changeInfo._number, ts));
Collection<CommentInfo> commentsBefore = testCommentHelper.getPublishedComments(changeId);
mailProcessor.process(b.build());
assertThat(testCommentHelper.getPublishedComments(changeId)).isEqualTo(commentsBefore);
assertNotifyTo(user);
Message message = sender.nextMessage();
assertThat(message.body()).contains("rejected one or more comments");
}
@Test
@GerritConfig(name = "change.maxComments", value = "9")
public void limitNumberOfComments() throws Exception {
// This change has 2 change messages and 2 comments.
String changeId = createChangeWithReview();
String ts =
MailProcessingUtil.rfcDateformatter.format(
ZonedDateTime.ofInstant(
gApi.changes().id(changeId).get().updated.toInstant(), ZoneId.of("UTC")));
CommentInput commentInput = new CommentInput();
commentInput.line = 1;
commentInput.message = "foo";
commentInput.path = FILE_NAME;
RobotCommentInput robotCommentInput =
TestCommentHelper.createRobotCommentInputWithMandatoryFields(FILE_NAME);
ReviewInput reviewInput = new ReviewInput();
reviewInput.comments = ImmutableMap.of(FILE_NAME, ImmutableList.of(commentInput));
reviewInput.robotComments = ImmutableMap.of(FILE_NAME, ImmutableList.of(robotCommentInput));
// Add 1 change message and another 2 comments. Total count is now 7, which is still OK.
gApi.changes().id(changeId).current().review(reviewInput);
ChangeInfo changeInfo = gApi.changes().id(changeId).get();
MailMessage.Builder mailMessage = messageBuilderWithDefaultFields();
String txt =
newPlaintextBody(
getChangeUrl(changeInfo) + "/1",
"1) change message",
"2) reply to comment",
"3) file comment");
mailMessage.textContent(txt + textFooterForChange(changeInfo._number, ts));
ImmutableSet<CommentInfo> commentsBefore = getCommentsAndRobotComments(changeId);
// Should have 4 comments (and 3 change messages).
assertThat(commentsBefore).hasSize(4);
// The email adds 3 new comments (of which 1 is the change message).
mailProcessor.process(mailMessage.build());
ImmutableSet<CommentInfo> commentsAfter = getCommentsAndRobotComments(changeId);
assertThat(commentsAfter).isEqualTo(commentsBefore);
assertNotifyTo(user);
Message message = sender.nextMessage();
assertThat(message.body()).contains("rejected one or more comments");
}
@Test
@GerritConfig(name = "change.cumulativeCommentSizeLimit", value = "7k")
public void limitCumulativeCommentSize() throws Exception {
// Use large sizes because autogenerated messages already have O(100) bytes.
String commentText2000Bytes = new String(new char[2000]).replace("\0", "x");
String changeId = createChangeWithReview();
CommentInput commentInput = new CommentInput();
commentInput.line = 1;
commentInput.message = commentText2000Bytes;
commentInput.path = FILE_NAME;
ReviewInput reviewInput = new ReviewInput().message(commentText2000Bytes);
reviewInput.comments = ImmutableMap.of(FILE_NAME, ImmutableList.of(commentInput));
// Use up ~4000 bytes.
gApi.changes().id(changeId).current().review(reviewInput);
ChangeInfo changeInfo = gApi.changes().id(changeId).get();
String ts =
MailProcessingUtil.rfcDateformatter.format(
ZonedDateTime.ofInstant(
gApi.changes().id(changeId).get().updated.toInstant(), ZoneId.of("UTC")));
// Hit the limit when trying that again.
MailMessage.Builder mailMessage = messageBuilderWithDefaultFields();
String txt =
newPlaintextBody(
getChangeUrl(changeInfo) + "/1",
"change message: " + commentText2000Bytes,
"reply to comment: " + commentText2000Bytes,
null);
mailMessage.textContent(txt + textFooterForChange(changeInfo._number, ts));
Collection<CommentInfo> commentsBefore = testCommentHelper.getPublishedComments(changeId);
mailProcessor.process(mailMessage.build());
assertThat(testCommentHelper.getPublishedComments(changeId)).isEqualTo(commentsBefore);
assertNotifyTo(user);
Message message = sender.nextMessage();
assertThat(message.body()).contains("rejected one or more comments");
}
private String getChangeUrl(ChangeInfo changeInfo) {
return canonicalWebUrl.get() + "c/" + changeInfo.project + "/+/" + changeInfo._number;
}
private void setupFailValidation(
CommentForValidation.CommentType type, String failProject, int failChange) {
CommentForValidation commentForValidation =
CommentForValidation.create(
CommentForValidation.CommentSource.HUMAN, type, COMMENT_TEXT, COMMENT_TEXT.length());
when(mockCommentValidator.validateComments(
CommentValidationContext.create(failChange, failProject),
ImmutableList.of(commentForValidation)))
.thenReturn(ImmutableList.of(commentForValidation.failValidation("Oh no!")));
}
private ImmutableSet<CommentInfo> getCommentsAndRobotComments(String changeId)
throws RestApiException {
return Streams.concat(
gApi.changes().id(changeId).commentsRequest().get().values().stream(),
gApi.changes().id(changeId).robotComments().values().stream())
.flatMap(Collection::stream)
.collect(toImmutableSet());
}
}