Merge changes from topic "commit-validators-cleanup" into stable-2.15
* changes:
CommitValidators: trim "ERROR" shouting from "forge committer" check
ReceiveCommits: uniformize commit validation error messages.
Inline "Change-Id" string into error messages
Always end the "Change-Id missing" error message with \n.
Print only one hint about Change-Ids at a time
Clean up Change-Id hint text
CommitValidators: Replace indexOf calls with String#contains
CommitValidators: Prefer using Splitter to String.split
diff --git a/Documentation/error-missing-changeid.txt b/Documentation/error-missing-changeid.txt
index 9cddd85..08f2c09 100644
--- a/Documentation/error-missing-changeid.txt
+++ b/Documentation/error-missing-changeid.txt
@@ -1,4 +1,4 @@
-= missing Change-Id in commit message footer
+= commit xxxxxxx: missing Change-Id in message footer
With this error message Gerrit rejects to push a commit to a project
which is configured to always require a Change-Id in the commit
diff --git a/Documentation/error-missing-subject.txt b/Documentation/error-missing-subject.txt
index 3703ade..6ef37a4 100644
--- a/Documentation/error-missing-subject.txt
+++ b/Documentation/error-missing-subject.txt
@@ -1,4 +1,4 @@
-= missing subject; Change-Id must be in commit message footer
+= commit xxxxxxx: missing subject; Change-Id must be in message footer
With this error message Gerrit rejects to push a commit to a project
which is configured to always require a Change-Id in the commit
diff --git a/Documentation/error-multiple-changeid-lines.txt b/Documentation/error-multiple-changeid-lines.txt
index 0729547..31567f4 100644
--- a/Documentation/error-multiple-changeid-lines.txt
+++ b/Documentation/error-multiple-changeid-lines.txt
@@ -1,4 +1,4 @@
-= multiple Change-Id lines in commit message footer
+= commit xxxxxxx: multiple Change-Id lines in message footer
With this error message Gerrit rejects to push a commit if the commit
message footer of the pushed commit contains several Change-Id lines.
diff --git a/gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/git/AbstractPushForReview.java b/gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/git/AbstractPushForReview.java
index e053d13..02d3802 100644
--- a/gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/git/AbstractPushForReview.java
+++ b/gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/git/AbstractPushForReview.java
@@ -1098,7 +1098,7 @@
pushFactory.create(
db, admin.getIdent(), testRepo, PushOneCommit.SUBJECT, "b.txt", "anotherContent");
r = push.to("refs/for/master");
- r.assertErrorStatus("not Signed-off-by author/committer/uploader in commit message footer");
+ r.assertErrorStatus("not Signed-off-by author/committer/uploader in message footer");
}
@Test
@@ -1293,7 +1293,7 @@
private void testPushWithoutChangeId() throws Exception {
RevCommit c = createCommit(testRepo, "Message without Change-Id");
assertThat(GitUtil.getChangeId(testRepo, c)).isEmpty();
- pushForReviewRejected(testRepo, "missing Change-Id in commit message footer");
+ pushForReviewRejected(testRepo, "missing Change-Id in message footer");
setRequireChangeId(InheritableBoolean.FALSE);
pushForReviewOk(testRepo);
@@ -1317,10 +1317,10 @@
+ "\n"
+ "Change-Id: I10f98c2ef76e52e23aa23be5afeb71e40b350e86\n"
+ "Change-Id: Ie9a132e107def33bdd513b7854b50de911edba0a\n");
- pushForReviewRejected(testRepo, "multiple Change-Id lines in commit message footer");
+ pushForReviewRejected(testRepo, "multiple Change-Id lines in message footer");
setRequireChangeId(InheritableBoolean.FALSE);
- pushForReviewRejected(testRepo, "multiple Change-Id lines in commit message footer");
+ pushForReviewRejected(testRepo, "multiple Change-Id lines in message footer");
}
@Test
@@ -1336,10 +1336,10 @@
private void testpushWithInvalidChangeId() throws Exception {
createCommit(testRepo, "Message with invalid Change-Id\n\nChange-Id: X\n");
- pushForReviewRejected(testRepo, "invalid Change-Id line format in commit message footer");
+ pushForReviewRejected(testRepo, "invalid Change-Id line format in message footer");
setRequireChangeId(InheritableBoolean.FALSE);
- pushForReviewRejected(testRepo, "invalid Change-Id line format in commit message footer");
+ pushForReviewRejected(testRepo, "invalid Change-Id line format in message footer");
}
@Test
@@ -1360,19 +1360,19 @@
"Message with invalid Change-Id\n"
+ "\n"
+ "Change-Id: I0000000000000000000000000000000000000000\n");
- pushForReviewRejected(testRepo, "invalid Change-Id line format in commit message footer");
+ pushForReviewRejected(testRepo, "invalid Change-Id line format in message footer");
setRequireChangeId(InheritableBoolean.FALSE);
- pushForReviewRejected(testRepo, "invalid Change-Id line format in commit message footer");
+ pushForReviewRejected(testRepo, "invalid Change-Id line format in message footer");
}
@Test
public void pushWithChangeIdInSubjectLine() throws Exception {
createCommit(testRepo, "Change-Id: I1234000000000000000000000000000000000000");
- pushForReviewRejected(testRepo, "missing subject; Change-Id must be in commit message footer");
+ pushForReviewRejected(testRepo, "missing subject; Change-Id must be in message footer");
setRequireChangeId(InheritableBoolean.FALSE);
- pushForReviewRejected(testRepo, "missing subject; Change-Id must be in commit message footer");
+ pushForReviewRejected(testRepo, "missing subject; Change-Id must be in message footer");
}
@Test
diff --git a/gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/rest/account/ExternalIdIT.java b/gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/rest/account/ExternalIdIT.java
index 0f8308c..33313d1 100644
--- a/gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/rest/account/ExternalIdIT.java
+++ b/gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/rest/account/ExternalIdIT.java
@@ -968,6 +968,6 @@
private void assertRefUpdateFailure(RemoteRefUpdate update, String msg) {
assertThat(update.getStatus()).isEqualTo(Status.REJECTED_OTHER_REASON);
- assertThat(update.getMessage()).isEqualTo(msg);
+ assertThat(update.getMessage()).contains(msg);
}
}
diff --git a/gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/rest/change/CreateChangeIT.java b/gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/rest/change/CreateChangeIT.java
index ba37248d..216eb3a 100644
--- a/gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/rest/change/CreateChangeIT.java
+++ b/gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/rest/change/CreateChangeIT.java
@@ -102,9 +102,7 @@
ChangeInput ci = newChangeInput(ChangeStatus.NEW);
ci.subject = "Subject\n\nChange-Id: I0000000000000000000000000000000000000000";
assertCreateFails(
- ci,
- ResourceConflictException.class,
- "invalid Change-Id line format in commit message footer");
+ ci, ResourceConflictException.class, "invalid Change-Id line format in message footer");
}
@Test
@@ -114,7 +112,7 @@
assertCreateFails(
ci,
ResourceConflictException.class,
- "missing subject; Change-Id must be in commit message footer");
+ "missing subject; Change-Id must be in message footer");
}
@Test
diff --git a/gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/rest/project/BanCommitIT.java b/gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/rest/project/BanCommitIT.java
index 90d51e0..00a11de 100644
--- a/gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/rest/project/BanCommitIT.java
+++ b/gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/rest/project/BanCommitIT.java
@@ -46,7 +46,7 @@
pushHead(testRepo, "refs/heads/master", false).getRemoteUpdate("refs/heads/master");
assertThat(u).isNotNull();
assertThat(u.getStatus()).isEqualTo(REJECTED_OTHER_REASON);
- assertThat(u.getMessage()).startsWith("contains banned commit");
+ assertThat(u.getMessage()).contains("contains banned commit");
}
@Test
diff --git a/gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/ssh/BanCommitIT.java b/gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/ssh/BanCommitIT.java
index 7a80f2e..2b00718 100644
--- a/gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/ssh/BanCommitIT.java
+++ b/gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/ssh/BanCommitIT.java
@@ -42,6 +42,6 @@
pushHead(testRepo, "refs/heads/master", false).getRemoteUpdate("refs/heads/master");
assertThat(u).isNotNull();
assertThat(u.getStatus()).isEqualTo(REJECTED_OTHER_REASON);
- assertThat(u.getMessage()).startsWith("contains banned commit");
+ assertThat(u.getMessage()).contains("contains banned commit");
}
}
diff --git a/gerrit-server/src/main/java/com/google/gerrit/server/git/receive/ReceiveCommits.java b/gerrit-server/src/main/java/com/google/gerrit/server/git/receive/ReceiveCommits.java
index 35259bb..80e0da8 100644
--- a/gerrit-server/src/main/java/com/google/gerrit/server/git/receive/ReceiveCommits.java
+++ b/gerrit-server/src/main/java/com/google/gerrit/server/git/receive/ReceiveCommits.java
@@ -2777,6 +2777,10 @@
}
}
+ private String messageForCommit(RevCommit c, String msg) {
+ return String.format("commit %s: %s", c.abbreviate(RevId.ABBREV_LEN).name(), msg);
+ }
+
private boolean validCommit(
RevWalk rw,
PermissionBackend.ForRef perm,
@@ -2803,11 +2807,16 @@
? commitValidatorsFactory.forMergedCommits(perm, user.asIdentifiedUser())
: commitValidatorsFactory.forReceiveCommits(
perm, branch, user.asIdentifiedUser(), sshInfo, repo, rw);
- messages.addAll(validators.validate(receiveEvent));
+ for (CommitValidationMessage m : validators.validate(receiveEvent)) {
+ messages.add(new CommitValidationMessage(messageForCommit(c, m.getMessage()), m.isError()));
+ }
} catch (CommitValidationException e) {
logDebug("Commit validation failed on {}", c.name());
- messages.addAll(e.getMessages());
- reject(cmd, e.getMessage());
+ for (CommitValidationMessage m : e.getMessages()) {
+ // TODO(hanwen): drop the non-error messages?
+ messages.add(new CommitValidationMessage(messageForCommit(c, m.getMessage()), m.isError()));
+ }
+ reject(cmd, messageForCommit(c, e.getMessage()));
return false;
}
validCommits.add(c.copy());
diff --git a/gerrit-server/src/main/java/com/google/gerrit/server/git/validators/CommitValidators.java b/gerrit-server/src/main/java/com/google/gerrit/server/git/validators/CommitValidators.java
index 541cbfa..9395ffb 100644
--- a/gerrit-server/src/main/java/com/google/gerrit/server/git/validators/CommitValidators.java
+++ b/gerrit-server/src/main/java/com/google/gerrit/server/git/validators/CommitValidators.java
@@ -20,7 +20,9 @@
import static java.util.stream.Collectors.toList;
import com.google.common.base.CharMatcher;
+import com.google.common.base.Splitter;
import com.google.common.collect.ImmutableList;
+import com.google.common.collect.Iterables;
import com.google.gerrit.common.FooterConstants;
import com.google.gerrit.common.Nullable;
import com.google.gerrit.common.PageLinks;
@@ -30,7 +32,6 @@
import com.google.gerrit.reviewdb.client.Account;
import com.google.gerrit.reviewdb.client.Branch;
import com.google.gerrit.reviewdb.client.RefNames;
-import com.google.gerrit.reviewdb.client.RevId;
import com.google.gerrit.server.GerritPersonIdent;
import com.google.gerrit.server.IdentifiedUser;
import com.google.gerrit.server.account.WatchConfig;
@@ -207,18 +208,13 @@
public static class ChangeIdValidator implements CommitValidationListener {
private static final String CHANGE_ID_PREFIX = FooterConstants.CHANGE_ID.getName() + ":";
- private static final String MISSING_CHANGE_ID_MSG =
- "[%s] missing " + FooterConstants.CHANGE_ID.getName() + " in commit message footer";
+ private static final String MISSING_CHANGE_ID_MSG = "missing Change-Id in message footer";
private static final String MISSING_SUBJECT_MSG =
- "[%s] missing subject; "
- + FooterConstants.CHANGE_ID.getName()
- + " must be in commit message footer";
+ "missing subject; Change-Id must be in message footer";
private static final String MULTIPLE_CHANGE_ID_MSG =
- "[%s] multiple " + FooterConstants.CHANGE_ID.getName() + " lines in commit message footer";
+ "multiple Change-Id lines in message footer";
private static final String INVALID_CHANGE_ID_MSG =
- "[%s] invalid "
- + FooterConstants.CHANGE_ID.getName()
- + " line format in commit message footer";
+ "invalid Change-Id line format in message footer";
private static final Pattern CHANGE_ID = Pattern.compile(CHANGE_ID_PATTERN);
private final ProjectState projectState;
@@ -249,31 +245,26 @@
RevCommit commit = receiveEvent.commit;
List<CommitValidationMessage> messages = new ArrayList<>();
List<String> idList = commit.getFooterLines(FooterConstants.CHANGE_ID);
- String sha1 = commit.abbreviate(RevId.ABBREV_LEN).name();
if (idList.isEmpty()) {
String shortMsg = commit.getShortMessage();
if (shortMsg.startsWith(CHANGE_ID_PREFIX)
&& CHANGE_ID.matcher(shortMsg.substring(CHANGE_ID_PREFIX.length()).trim()).matches()) {
- String errMsg = String.format(MISSING_SUBJECT_MSG, sha1);
- throw new CommitValidationException(errMsg);
+ throw new CommitValidationException(MISSING_SUBJECT_MSG);
}
if (projectState.isRequireChangeID()) {
- String errMsg = String.format(MISSING_CHANGE_ID_MSG, sha1);
- messages.add(getMissingChangeIdErrorMsg(errMsg, commit));
- throw new CommitValidationException(errMsg, messages);
+ messages.add(getMissingChangeIdErrorMsg(MISSING_CHANGE_ID_MSG, commit));
+ throw new CommitValidationException(MISSING_CHANGE_ID_MSG, messages);
}
} else if (idList.size() > 1) {
- String errMsg = String.format(MULTIPLE_CHANGE_ID_MSG, sha1);
- throw new CommitValidationException(errMsg, messages);
+ throw new CommitValidationException(MULTIPLE_CHANGE_ID_MSG, messages);
} else {
String v = idList.get(idList.size() - 1).trim();
// Reject Change-Ids with wrong format and invalid placeholder ID from
// Egit (I0000000000000000000000000000000000000000).
if (!CHANGE_ID.matcher(v).matches() || v.matches("^I00*$")) {
- String errMsg = String.format(INVALID_CHANGE_ID_MSG, sha1);
- messages.add(getMissingChangeIdErrorMsg(errMsg, receiveEvent.commit));
- throw new CommitValidationException(errMsg, messages);
+ messages.add(getMissingChangeIdErrorMsg(INVALID_CHANGE_ID_MSG, receiveEvent.commit));
+ throw new CommitValidationException(INVALID_CHANGE_ID_MSG, messages);
}
}
return Collections.emptyList();
@@ -286,31 +277,28 @@
private CommitValidationMessage getMissingChangeIdErrorMsg(String errMsg, RevCommit c) {
StringBuilder sb = new StringBuilder();
- sb.append("ERROR: ").append(errMsg);
+ sb.append("ERROR: ").append(errMsg).append("\n");
- if (c.getFullMessage().indexOf(CHANGE_ID_PREFIX) >= 0) {
- String[] lines = c.getFullMessage().trim().split("\n");
- String lastLine = lines.length > 0 ? lines[lines.length - 1] : "";
-
- if (lastLine.indexOf(CHANGE_ID_PREFIX) == -1) {
- sb.append('\n');
- sb.append('\n');
- sb.append("Hint: A potential ");
- sb.append(FooterConstants.CHANGE_ID.getName());
- sb.append(" was found, but it was not in the ");
- sb.append("footer (last paragraph) of the commit message.");
+ boolean hinted = false;
+ if (c.getFullMessage().contains(CHANGE_ID_PREFIX)) {
+ String lastLine = Iterables.getLast(Splitter.on('\n').split(c.getFullMessage()), "");
+ if (!lastLine.contains(CHANGE_ID_PREFIX)) {
+ hinted = true;
+ sb.append("\n")
+ .append("Hint: run\n")
+ .append(" git commit --amend\n")
+ .append("and move 'Change-Id: Ixxx..' to the bottom on a separate line\n");
}
}
- sb.append('\n');
- sb.append('\n');
- sb.append("Hint: To automatically insert ");
- sb.append(FooterConstants.CHANGE_ID.getName());
- sb.append(", install the hook:\n");
- sb.append(getCommitMessageHookInstallationHint());
- sb.append('\n');
- sb.append("And then amend the commit:\n");
- sb.append(" git commit --amend\n");
+ // Print only one hint to avoid overwhelming the user.
+ if (!hinted) {
+ sb.append("\nHint: to automatically insert a Change-Id, install the hook:\n")
+ .append(getCommitMessageHookInstallationHint())
+ .append("\n")
+ .append("and then amend the commit:\n")
+ .append(" git commit --amend\n");
+ }
return new CommitValidationMessage(sb.toString(), false);
}
@@ -521,7 +509,7 @@
perm.check(RefPermission.FORGE_COMMITTER);
} catch (AuthException denied) {
throw new CommitValidationException(
- "not Signed-off-by author/committer/uploader in commit message footer");
+ "not Signed-off-by author/committer/uploader in message footer");
} catch (PermissionBackendException e) {
log.error("cannot check FORGE_COMMITTER", e);
throw new CommitValidationException("internal auth error");
@@ -556,8 +544,7 @@
return Collections.emptyList();
} catch (AuthException e) {
throw new CommitValidationException(
- "invalid author",
- invalidEmail(receiveEvent.commit, "author", author, user, canonicalWebUrl));
+ "invalid author", invalidEmail("author", author, user, canonicalWebUrl));
} catch (PermissionBackendException e) {
log.error("cannot check FORGE_AUTHOR", e);
throw new CommitValidationException("internal auth error");
@@ -590,8 +577,7 @@
return Collections.emptyList();
} catch (AuthException e) {
throw new CommitValidationException(
- "invalid committer",
- invalidEmail(receiveEvent.commit, "committer", committer, user, canonicalWebUrl));
+ "invalid committer", invalidEmail("committer", committer, user, canonicalWebUrl));
} catch (PermissionBackendException e) {
log.error("cannot check FORGE_COMMITTER", e);
throw new CommitValidationException("internal auth error");
@@ -759,42 +745,30 @@
}
private static CommitValidationMessage invalidEmail(
- RevCommit c,
- String type,
- PersonIdent who,
- IdentifiedUser currentUser,
- String canonicalWebUrl) {
+ String type, PersonIdent who, IdentifiedUser currentUser, String canonicalWebUrl) {
StringBuilder sb = new StringBuilder();
- sb.append("\n");
- sb.append("ERROR: In commit ").append(c.name()).append("\n");
- sb.append("ERROR: ")
- .append(type)
- .append(" email address ")
+
+ sb.append("email address ")
.append(who.getEmailAddress())
- .append("\n");
- sb.append("ERROR: does not match your user account and you have no 'forge ")
+ .append(" is not registered in your account, and you lack 'forge ")
.append(type)
.append("' permission.\n");
- sb.append("ERROR:\n");
+
if (currentUser.getEmailAddresses().isEmpty()) {
- sb.append("ERROR: You have not registered any email addresses.\n");
+ sb.append("You have not registered any email addresses.\n");
} else {
- sb.append("ERROR: The following addresses are currently registered:\n");
+ sb.append("The following addresses are currently registered:\n");
for (String address : currentUser.getEmailAddresses()) {
- sb.append("ERROR: ").append(address).append("\n");
+ sb.append(" ").append(address).append("\n");
}
}
- sb.append("ERROR:\n");
+
if (canonicalWebUrl != null) {
- sb.append("ERROR: To register an email address, please visit:\n");
- sb.append("ERROR: ")
- .append(canonicalWebUrl)
- .append("#")
- .append(PageLinks.SETTINGS_CONTACT)
- .append("\n");
+ sb.append("To register an email address, visit:\n");
+ sb.append(canonicalWebUrl).append("#").append(PageLinks.SETTINGS_CONTACT).append("\n");
}
sb.append("\n");
- return new CommitValidationMessage(sb.toString(), false);
+ return new CommitValidationMessage(sb.toString(), true);
}
/**
