opendev/gerrit
Code Issues Proposed changes

Trim leading and trailing whitespaces in topic name in PutTopic

Browse Source 
Whitespaces in the topic name can lead to undesired effects when
querying for the topic. This commit just sanitizes whitespaces of any
kind from the start and end of the topic name.

Change-Id: I0bd032e8f43c3d344af8c31eac449f04b8c5d1d2
This commit is contained in:
Patrick Hiesel 2018-06-19 15:07:50 +02:00
parent 4927231419
commit 4aa14560a9
3 changed files with 30 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Documentation/rest-api-changes.txt
View File

@ -889,7 +889,8 @@ If the change does not have a topic an empty string is returned.
Sets the topic of a change.
The new topic must be provided in the request body inside a
link:#topic-input[TopicInput] entity.
link:#topic-input[TopicInput] entity. Any leading or trailing whitespace
in the topic name will be removed.
.Request
----

7
java/com/google/gerrit/server/restapi/change/PutTopic.java
View File

@ -75,7 +75,12 @@ public class PutTopic extends RetryingRestModifyView<ChangeResource, TopicInput,
String.format("topic length exceeds the limit (%s)", ChangeUtil.TOPIC_MAX_LENGTH));
}
Op op = new Op(input != null ? input : new TopicInput());
TopicInput sanitizedInput = input == null ? new TopicInput() : input;
if (sanitizedInput.topic != null) {
sanitizedInput.topic = sanitizedInput.topic.trim();
}
Op op = new Op(sanitizedInput);
try (BatchUpdate u =
updateFactory.create(
dbProvider.get(), req.getChange().getProject(), req.getUser(), TimeUtil.nowTs())) {

22
javatests/com/google/gerrit/acceptance/rest/change/TopicIT.java
View File

@ -14,6 +14,8 @@
package com.google.gerrit.acceptance.rest.change;
import static com.google.common.truth.Truth.assertThat;
import com.google.gerrit.acceptance.AbstractDaemonTest;
import com.google.gerrit.acceptance.PushOneCommit.Result;
import com.google.gerrit.acceptance.RestResponse;
@ -36,4 +38,24 @@ public class TopicIT extends AbstractDaemonTest {
response = adminRestSession.put(endpoint, "");
response.assertNoContent();
}
@Test
public void leadingAndTrailingWhitespaceGetsSanitized() throws Exception {
Result result = createChange();
String endpoint = "/changes/" + result.getChangeId() + "/topic";
RestResponse response = adminRestSession.put(endpoint, "\t \t topic\t ");
response.assertOK();
assertThat(response.getEntityContent()).isEqualTo(")]}'\n\"topic\"");
}
@Test
public void containedWhitespaceDoesNotGetSanitized() throws Exception {
Result result = createChange();
String endpoint = "/changes/" + result.getChangeId() + "/topic";
RestResponse response = adminRestSession.put(endpoint, "t opic");
response.assertOK();
assertThat(response.getEntityContent()).isEqualTo(")]}'\n\"t opic\"");
}
}