blob: 1f22fc1d5f1c86e61fd3d4b63a414661daf7c155 [file] [log] [blame]
// Copyright (C) 2014 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.server.notedb;
import static com.google.common.truth.Truth.assertThat;
import static com.google.gerrit.server.notedb.ReviewerStateInternal.CC;
import static com.google.gerrit.server.notedb.ReviewerStateInternal.REVIEWER;
import com.google.common.collect.ImmutableList;
import com.google.gerrit.entities.Account;
import com.google.gerrit.entities.Address;
import com.google.gerrit.entities.Change;
import com.google.gerrit.entities.LabelId;
import com.google.gerrit.entities.SubmissionId;
import com.google.gerrit.server.CurrentUser;
import com.google.gerrit.server.util.time.TimeUtil;
import com.google.gerrit.testing.TestChanges;
import java.time.ZoneId;
import org.eclipse.jgit.lib.ObjectId;
import org.eclipse.jgit.lib.PersonIdent;
import org.eclipse.jgit.revwalk.RevCommit;
import org.eclipse.jgit.revwalk.RevWalk;
import org.junit.Test;
public class CommitMessageOutputTest extends AbstractChangeNotesTest {
@Test
public void approvalsCommitFormatSimple() throws Exception {
Change c = TestChanges.newChange(project, changeOwner.getAccountId(), 1);
ChangeUpdate update = newUpdateForNewChange(c, changeOwner);
update.putApproval(LabelId.CODE_REVIEW, (short) -1);
update.putApproval(LabelId.VERIFIED, (short) 1);
update.putReviewer(changeOwner.getAccount().id(), REVIEWER);
update.putReviewer(otherUser.getAccount().id(), CC);
update.commit();
assertThat(update.getRefName()).isEqualTo("refs/changes/01/1/meta");
RevCommit commit = parseCommit(update.getResult());
assertBodyEquals(
"Update patch set 1\n"
+ "\n"
+ "Patch-set: 1\n"
+ "Change-id: "
+ c.getKey().get()
+ "\n"
+ "Subject: Change subject\n"
+ "Branch: refs/heads/master\n"
+ "Commit: "
+ update.getCommit().name()
+ "\n"
+ "Reviewer: Gerrit User 1 <1@gerrit>\n"
+ "CC: Gerrit User 2 <2@gerrit>\n"
+ "Label: Code-Review=-1, 1_1_1_code_review__1_1\n"
+ "Label: Verified=+1, 1_1_1_verified_1_2\n",
commit);
PersonIdent author = commit.getAuthorIdent();
assertThat(author.getName()).isEqualTo("Gerrit User 1");
assertThat(author.getEmailAddress()).isEqualTo("1@gerrit");
assertThat(author.getWhenAsInstant().toEpochMilli())
.isEqualTo(c.getCreatedOn().toEpochMilli() + 1000);
assertThat(author.getZoneId()).isEqualTo(ZoneId.of("GMT-7"));
PersonIdent committer = commit.getCommitterIdent();
assertThat(committer.getName()).isEqualTo("Gerrit Server");
assertThat(committer.getEmailAddress()).isEqualTo("noreply@gerrit.com");
assertThat(committer.getWhenAsInstant()).isEqualTo(author.getWhenAsInstant());
assertThat(committer.getZoneId()).isEqualTo(author.getZoneId());
}
@Test
public void changeMessageCommitFormatSimple() throws Exception {
Change c = TestChanges.newChange(project, changeOwner.getAccountId(), 1);
ChangeUpdate update = newUpdateForNewChange(c, changeOwner);
update.setChangeMessage("Just a little code change.\nHow about a new line");
update.commit();
assertThat(update.getRefName()).isEqualTo("refs/changes/01/1/meta");
assertBodyEquals(
"Update patch set 1\n"
+ "\n"
+ "Just a little code change.\n"
+ "How about a new line\n"
+ "\n"
+ "Patch-set: 1\n"
+ "Change-id: "
+ c.getKey().get()
+ "\n"
+ "Subject: Change subject\n"
+ "Branch: refs/heads/master\n"
+ "Commit: "
+ update.getCommit().name()
+ "\n",
update.getResult());
}
@Test
public void changeWithRevision() throws Exception {
Change c = TestChanges.newChange(project, changeOwner.getAccountId(), 1);
ChangeUpdate update = newUpdateForNewChange(c, changeOwner);
update.setChangeMessage("Foo");
RevCommit commit = tr.commit().message("Subject").create();
update.setCommit(rw, commit);
update.commit();
assertThat(update.getRefName()).isEqualTo("refs/changes/01/1/meta");
assertBodyEquals(
"Update patch set 1\n"
+ "\n"
+ "Foo\n"
+ "\n"
+ "Patch-set: 1\n"
+ "Change-id: "
+ c.getKey().get()
+ "\n"
+ "Subject: Subject\n"
+ "Branch: refs/heads/master\n"
+ "Commit: "
+ commit.name()
+ "\n",
update.getResult());
}
@Test
public void approvalTombstoneCommitFormat() throws Exception {
Change c = newChange();
ChangeUpdate update = newUpdate(c, changeOwner);
update.removeApproval(LabelId.CODE_REVIEW);
update.commit();
assertBodyEquals(
"Update patch set 1\n\nPatch-set: 1\nLabel: -Code-Review\n", update.getResult());
}
@Test
public void submitCommitFormat() throws Exception {
Change c = newChange();
ChangeUpdate update = newUpdate(c, changeOwner);
update.setSubjectForCommit("Submit patch set 1");
SubmissionId submissionId = new SubmissionId(c);
update.merge(
submissionId,
ImmutableList.of(
submitRecord(
"NOT_READY",
null,
submitLabel(LabelId.VERIFIED, "OK", changeOwner.getAccountId()),
submitLabel(LabelId.CODE_REVIEW, "NEED", null)),
submitRecord(
"NOT_READY",
null,
submitLabel(LabelId.VERIFIED, "OK", changeOwner.getAccountId()),
submitLabel("Alternative-Code-Review", "NEED", null))));
update.commit();
RevCommit commit = parseCommit(update.getResult());
assertBodyEquals(
"Submit patch set 1\n"
+ "\n"
+ "Patch-set: 1\n"
+ "Status: merged\n"
+ "Submission-id: "
+ submissionId.toString()
+ "\n"
+ "Submitted-with: NOT_READY\n"
+ "Submitted-with: OK: Verified: Gerrit User 1 <1@gerrit>\n"
+ "Submitted-with: NEED: Code-Review\n"
+ "Submitted-with: NOT_READY\n"
+ "Submitted-with: OK: Verified: Gerrit User 1 <1@gerrit>\n"
+ "Submitted-with: NEED: Alternative-Code-Review\n",
commit);
PersonIdent author = commit.getAuthorIdent();
assertThat(author.getName()).isEqualTo("Gerrit User 1");
assertThat(author.getEmailAddress()).isEqualTo("1@gerrit");
assertThat(author.getWhenAsInstant().toEpochMilli())
.isEqualTo(c.getCreatedOn().toEpochMilli() + 2000);
assertThat(author.getZoneId()).isEqualTo(ZoneId.of("GMT-7"));
PersonIdent committer = commit.getCommitterIdent();
assertThat(committer.getName()).isEqualTo("Gerrit Server");
assertThat(committer.getEmailAddress()).isEqualTo("noreply@gerrit.com");
assertThat(committer.getWhenAsInstant()).isEqualTo(author.getWhenAsInstant());
assertThat(committer.getZoneId()).isEqualTo(author.getZoneId());
}
@Test
public void anonymousUser() throws Exception {
Account anon =
Account.builder(Account.id(3), TimeUtil.now())
.setMetaId("1234567812345678123456781234567812345678")
.build();
accountCache.put(anon);
Change c = newChange();
ChangeUpdate update = newUpdate(c, userFactory.create(anon.id()));
update.setChangeMessage("Comment on the change.");
update.commit();
RevCommit commit = parseCommit(update.getResult());
assertBodyEquals("Update patch set 1\n\nComment on the change.\n\nPatch-set: 1\n", commit);
PersonIdent author = commit.getAuthorIdent();
assertThat(author.getName()).isEqualTo("Gerrit User 3");
assertThat(author.getEmailAddress()).isEqualTo("3@gerrit");
}
@Test
public void submitWithErrorMessage() throws Exception {
Change c = newChange();
ChangeUpdate update = newUpdate(c, changeOwner);
update.setSubjectForCommit("Submit patch set 1");
SubmissionId submissionId = new SubmissionId(c);
update.merge(
submissionId, ImmutableList.of(submitRecord("RULE_ERROR", "Problem with patch set:\n1")));
update.commit();
assertBodyEquals(
"Submit patch set 1\n"
+ "\n"
+ "Patch-set: 1\n"
+ "Status: merged\n"
+ "Submission-id: "
+ submissionId.toString()
+ "\n"
+ "Submitted-with: RULE_ERROR Problem with patch set: 1\n",
update.getResult());
}
@Test
public void noChangeMessage() throws Exception {
Change c = newChange();
ChangeUpdate update = newUpdate(c, changeOwner);
update.putReviewer(changeOwner.getAccount().id(), REVIEWER);
update.commit();
assertBodyEquals(
"Update patch set 1\n\nPatch-set: 1\nReviewer: Gerrit User 1 <1@gerrit>\n",
update.getResult());
}
@Test
public void changeMessageWithTrailingDoubleNewline() throws Exception {
Change c = newChange();
ChangeUpdate update = newUpdate(c, changeOwner);
update.setChangeMessage("Testing trailing double newline\n\n");
update.commit();
assertBodyEquals(
"Update patch set 1\n"
+ "\n"
+ "Testing trailing double newline\n"
+ "\n"
+ "\n"
+ "\n"
+ "Patch-set: 1\n",
update.getResult());
}
@Test
public void changeMessageWithMultipleParagraphs() throws Exception {
Change c = newChange();
ChangeUpdate update = newUpdate(c, changeOwner);
update.setChangeMessage("Testing paragraph 1\n\nTesting paragraph 2\n\nTesting paragraph 3");
update.commit();
assertBodyEquals(
"Update patch set 1\n"
+ "\n"
+ "Testing paragraph 1\n"
+ "\n"
+ "Testing paragraph 2\n"
+ "\n"
+ "Testing paragraph 3\n"
+ "\n"
+ "Patch-set: 1\n",
update.getResult());
}
@Test
public void changeMessageWithTag() throws Exception {
Change c = newChange();
ChangeUpdate update = newUpdate(c, changeOwner);
update.setChangeMessage("Change message with tag");
update.setTag("jenkins");
update.commit();
assertBodyEquals(
"Update patch set 1\n"
+ "\n"
+ "Change message with tag\n"
+ "\n"
+ "Patch-set: 1\n"
+ "Tag: jenkins\n",
update.getResult());
}
@Test
public void leadingWhitespace() throws Exception {
Change c = TestChanges.newChange(project, changeOwner.getAccountId());
c.setCurrentPatchSet(c.currentPatchSetId(), " " + c.getSubject(), c.getOriginalSubject());
ChangeUpdate update = newUpdateForNewChange(c, changeOwner);
update.setChangeId(c.getKey().get());
update.setBranch(c.getDest().branch());
update.commit();
assertBodyEquals(
"Update patch set 1\n"
+ "\n"
+ "Patch-set: 1\n"
+ "Change-id: "
+ c.getKey().get()
+ "\n"
+ "Subject: Change subject\n"
+ "Branch: refs/heads/master\n"
+ "Commit: "
+ update.getCommit().name()
+ "\n",
update.getResult());
c = TestChanges.newChange(project, changeOwner.getAccountId());
c.setCurrentPatchSet(c.currentPatchSetId(), "\t\t" + c.getSubject(), c.getOriginalSubject());
update = newUpdateForNewChange(c, changeOwner);
update.setChangeId(c.getKey().get());
update.setBranch(c.getDest().branch());
update.commit();
assertBodyEquals(
"Update patch set 1\n"
+ "\n"
+ "Patch-set: 1\n"
+ "Change-id: "
+ c.getKey().get()
+ "\n"
+ "Subject: \t\tChange subject\n"
+ "Branch: refs/heads/master\n"
+ "Commit: "
+ update.getCommit().name()
+ "\n",
update.getResult());
}
@Test
public void realUser() throws Exception {
Change c = newChange();
CurrentUser ownerAsOtherUser =
userFactory.runAs(/* remotePeer= */ null, otherUserId, changeOwner);
ChangeUpdate update = newUpdate(c, ownerAsOtherUser);
update.setChangeMessage("Message on behalf of other user");
update.commit();
RevCommit commit = parseCommit(update.getResult());
PersonIdent author = commit.getAuthorIdent();
assertThat(author.getName()).isEqualTo("Gerrit User 2");
assertThat(author.getEmailAddress()).isEqualTo("2@gerrit");
assertBodyEquals(
"Update patch set 1\n"
+ "\n"
+ "Message on behalf of other user\n"
+ "\n"
+ "Patch-set: 1\n"
+ "Real-user: Gerrit User 1 <1@gerrit>\n",
commit);
}
@Test
public void currentPatchSet() throws Exception {
Change c = newChange();
ChangeUpdate update = newUpdate(c, changeOwner);
update.setCurrentPatchSet();
update.commit();
assertBodyEquals("Update patch set 1\n\nPatch-set: 1\nCurrent: true\n", update.getResult());
}
@Test
public void reviewerByEmail() throws Exception {
Change c = newChange();
ChangeUpdate update = newUpdate(c, changeOwner);
update.putReviewerByEmail(
Address.create("John Doe", "j.doe@example.com"), ReviewerStateInternal.REVIEWER);
update.commit();
assertBodyEquals(
"Update patch set 1\n\nPatch-set: 1\n" + "Reviewer-email: John Doe <j.doe@example.com>\n",
update.getResult());
}
@Test
public void ccByEmail() throws Exception {
Change c = newChange();
ChangeUpdate update = newUpdate(c, changeOwner);
update.putReviewerByEmail(Address.create("j.doe@example.com"), ReviewerStateInternal.CC);
update.commit();
assertBodyEquals(
"Update patch set 1\n\nPatch-set: 1\nCC-email: j.doe@example.com\n", update.getResult());
}
private RevCommit parseCommit(ObjectId id) throws Exception {
if (id instanceof RevCommit) {
return (RevCommit) id;
}
try (RevWalk walk = new RevWalk(repo)) {
RevCommit commit = walk.parseCommit(id);
walk.parseBody(commit);
return commit;
}
}
private void assertBodyEquals(String expected, ObjectId commitId) throws Exception {
RevCommit commit = parseCommit(commitId);
assertThat(commit.getFullMessage()).isEqualTo(expected);
}
}