opendev/gerrit
Code Issues Proposed changes

CreateChange: Strip comment lines out of input commit message

Browse Source 
Attempting to create a change with only a commit message subject where
the subject begins with a # fails due to an invalid (zeros) Change-Id.

The zero Change-Id is appended to the change because the JGit utility
method used to generate it strips the commit message of any comment
lines, which in this case results in an empty commit message, and then
the commit message does not have enough content.

Strip comment lines out of the input commit message before attempting
to use it to create the change. If it is empty after stripping the
comments, return 400 Bad Request.

Update the 'ChangeInput' documentation to mention that comment lines
will be stripped. Also change the description to reflect the fact that
the `subject` field is actually used for the entire commit message,
rather than only the subject.

Bug: Issue 9195
Change-Id: I5a2eed97aeb187801550f3a6b35e3dcfd2baf34e
This commit is contained in:
David Pursehouse
2018-06-07 14:44:33 +09:00
parent 70428fc5da
commit 38cb32d7b7
3 changed files with 33 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
gerrit-server/src/main/java/com/google/gerrit/server/change/CreateChange.java
View File

@@ -156,7 +156,8 @@ public class CreateChange implements RestModifyView<TopLevelResource, ChangeInpu
throw new BadRequestException("branch must be non-empty");
}
if (Strings.isNullOrEmpty(input.subject)) {
String subject = clean(Strings.nullToEmpty(input.subject));
if (Strings.isNullOrEmpty(subject)) {
throw new BadRequestException("commit message must be non-empty");
}
@@ -229,7 +230,7 @@ public class CreateChange implements RestModifyView<TopLevelResource, ChangeInpu
GeneralPreferencesInfo info = account.getAccount().getGeneralPreferencesInfo();
// Add a Change-Id line if there isn't already one
String commitMessage = input.subject;
String commitMessage = subject;
if (ChangeIdUtil.indexOfChangeId(commitMessage, "\n") == -1) {
ObjectId treeId = mergeTip == null ? emptyTreeId(oi) : mergeTip.getTree();
ObjectId id = ChangeIdUtil.computeChangeId(treeId, mergeTip, author, author, commitMessage);
@@ -347,4 +348,16 @@ public class CreateChange implements RestModifyView<TopLevelResource, ChangeInpu
private static ObjectId emptyTreeId(ObjectInserter inserter) throws IOException {
return inserter.insert(new TreeFormatter());
}
/**
* Remove comment lines from a commit message.
*
* <p>Based on {@link org.eclipse.jgit.util.ChangeIdUtil#clean}.
*
* @param msg
* @return message without comment lines, possibly empty.
*/
private String clean(String msg) {
return msg.replaceAll("(?m)^#.*$\n?", "").trim();
}
}