Fix casing of change states for /related endpoint
Our REST documentation mentions that the status contained in
RelatedChangeAndCommitInfo has one of the values NEW, MERGED,
and ABANDONED. It explicitly lists them in upper case. In addition,
our frontend depends on the exact casing of those values.
This regression was introduced as a side-effect of I9ed389b01. Add a
test to prevent future regressions.
Bug: Issue 10559
Change-Id: I7486b71899c57e185d90d7357873834539933637
diff --git a/java/com/google/gerrit/server/restapi/change/GetRelated.java b/java/com/google/gerrit/server/restapi/change/GetRelated.java
index d3961c1..9a605c0 100644
--- a/java/com/google/gerrit/server/restapi/change/GetRelated.java
+++ b/java/com/google/gerrit/server/restapi/change/GetRelated.java
@@ -44,6 +44,7 @@
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
+import java.util.Locale;
import java.util.Set;
import org.eclipse.jgit.errors.RepositoryNotFoundException;
import org.eclipse.jgit.revwalk.RevCommit;
@@ -148,7 +149,7 @@
info._revisionNumber = ps != null ? ps.getPatchSetId() : null;
PatchSet.Id curr = change.currentPatchSetId();
info._currentRevisionNumber = curr != null ? curr.get() : null;
- info.status = ChangeUtil.status(change);
+ info.status = ChangeUtil.status(change).toUpperCase(Locale.US);
}
info.commit = new CommitInfo();
diff --git a/javatests/com/google/gerrit/acceptance/server/change/GetRelatedIT.java b/javatests/com/google/gerrit/acceptance/server/change/GetRelatedIT.java
index b581977..183cfe2 100644
--- a/javatests/com/google/gerrit/acceptance/server/change/GetRelatedIT.java
+++ b/javatests/com/google/gerrit/acceptance/server/change/GetRelatedIT.java
@@ -22,6 +22,7 @@
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Iterables;
+import com.google.common.truth.Correspondence;
import com.google.gerrit.acceptance.AbstractDaemonTest;
import com.google.gerrit.acceptance.GerritConfig;
import com.google.gerrit.acceptance.NoHttpd;
@@ -33,6 +34,7 @@
import com.google.gerrit.common.data.GlobalCapability;
import com.google.gerrit.common.data.PermissionRule;
import com.google.gerrit.extensions.api.changes.RelatedChangeAndCommitInfo;
+import com.google.gerrit.extensions.api.changes.ReviewInput;
import com.google.gerrit.extensions.common.CommitInfo;
import com.google.gerrit.extensions.common.EditInfo;
import com.google.gerrit.index.IndexConfig;
@@ -56,6 +58,7 @@
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
+import java.util.Objects;
import java.util.Optional;
import org.eclipse.jgit.junit.TestRepository;
import org.eclipse.jgit.lib.Config;
@@ -618,6 +621,48 @@
assertRelated(lastPsId, expected);
}
+ @Test
+ public void stateOfRelatedChangesMatchesDocumentedValues() throws Exception {
+ // Set up three related changes, one new, the other abandoned, and the third merged.
+ RevCommit commit1 =
+ commitBuilder().add("a.txt", "File content 1").message("Subject 1").create();
+ RevCommit commit2 =
+ commitBuilder().add("b.txt", "File content 2").message("Subject 2").create();
+ RevCommit commit3 =
+ commitBuilder().add("c.txt", "File content 3").message("Subject 3").create();
+ pushHead(testRepo, "refs/for/master", false);
+ Change change1 = getChange(commit1).change();
+ Change change2 = getChange(commit2).change();
+ Change change3 = getChange(commit3).change();
+ gApi.changes().id(change1.getChangeId()).current().review(ReviewInput.approve());
+ gApi.changes().id(change1.getChangeId()).current().submit();
+ gApi.changes().id(change2.getChangeId()).abandon();
+
+ List<RelatedChangeAndCommitInfo> relatedChanges =
+ gApi.changes().id(change3.getChangeId()).current().related().changes;
+
+ // Ensure that our REST API returns the states exactly as documented (and required by the
+ // frontend).
+ assertThat(relatedChanges)
+ .comparingElementsUsing(getRelatedChangeToStatusCorrespondence())
+ .containsExactly("NEW", "ABANDONED", "MERGED");
+ }
+
+ private static Correspondence<RelatedChangeAndCommitInfo, String>
+ getRelatedChangeToStatusCorrespondence() {
+ return new Correspondence<RelatedChangeAndCommitInfo, String>() {
+ @Override
+ public boolean compare(RelatedChangeAndCommitInfo relatedChangeAndCommitInfo, String status) {
+ return Objects.equals(relatedChangeAndCommitInfo.status, status);
+ }
+
+ @Override
+ public String toString() {
+ return "has status";
+ }
+ };
+ }
+
private RevCommit parseBody(RevCommit c) throws Exception {
testRepo.getRevWalk().parseBody(c);
return c;
@@ -682,6 +727,7 @@
assertThat(a._currentRevisionNumber)
.named("current revision of " + name)
.isEqualTo(e._currentRevisionNumber);
+ assertThat(a.status).isEqualTo(e.status);
}
}
}
