Add REST endpoints for work in progress workflow
New endpoints are documented in the follow-up change.
Change-Id: I322ff79c70416932d1287f1ee4f38837eda3ef02
diff --git a/Documentation/rest-api-changes.txt b/Documentation/rest-api-changes.txt
index 3c3699c..050be86 100644
--- a/Documentation/rest-api-changes.txt
+++ b/Documentation/rest-api-changes.txt
@@ -5458,6 +5458,8 @@
problems with this change. Only set if link:#check[CHECK] is set.
|`is_private` |optional, not set if `false`|
When present, change is marked as private.
+|`work_in_progress` |optional, not set if `false`|
+When present, change is marked as Work In Progress.
|==================================
[[change-input]]
diff --git a/gerrit-extension-api/src/main/java/com/google/gerrit/extensions/common/ChangeInfo.java b/gerrit-extension-api/src/main/java/com/google/gerrit/extensions/common/ChangeInfo.java
index 49e4a05..a3750b9 100644
--- a/gerrit-extension-api/src/main/java/com/google/gerrit/extensions/common/ChangeInfo.java
+++ b/gerrit-extension-api/src/main/java/com/google/gerrit/extensions/common/ChangeInfo.java
@@ -46,6 +46,7 @@
public Integer deletions;
public Integer unresolvedCommentCount;
public Boolean isPrivate;
+ public Boolean workInProgress;
public int _number;
diff --git a/gerrit-server/src/main/java/com/google/gerrit/server/ChangeMessagesUtil.java b/gerrit-server/src/main/java/com/google/gerrit/server/ChangeMessagesUtil.java
index 459c604..c5d84c3 100644
--- a/gerrit-server/src/main/java/com/google/gerrit/server/ChangeMessagesUtil.java
+++ b/gerrit-server/src/main/java/com/google/gerrit/server/ChangeMessagesUtil.java
@@ -56,7 +56,9 @@
public static final String TAG_SET_DESCRIPTION = "autogenerated:gerrit:setPsDescription";
public static final String TAG_SET_HASHTAGS = "autogenerated:gerrit:setHashtag";
public static final String TAG_SET_PRIVATE = "autogenerated:gerrit:setPrivate";
+ public static final String TAG_SET_READY = "autogenerated:gerrit:setReadyForReview";
public static final String TAG_SET_TOPIC = "autogenerated:gerrit:setTopic";
+ public static final String TAG_SET_WIP = "autogenerated:gerrit:setWorkInProgress";
public static final String TAG_UNSET_PRIVATE = "autogenerated:gerrit:unsetPrivate";
public static final String TAG_UPLOADED_PATCH_SET = "autogenerated:gerrit:newPatchSet";
diff --git a/gerrit-server/src/main/java/com/google/gerrit/server/ChangeUtil.java b/gerrit-server/src/main/java/com/google/gerrit/server/ChangeUtil.java
index cfd1d5d..c9b726b 100644
--- a/gerrit-server/src/main/java/com/google/gerrit/server/ChangeUtil.java
+++ b/gerrit-server/src/main/java/com/google/gerrit/server/ChangeUtil.java
@@ -19,6 +19,7 @@
import com.google.common.collect.Maps;
import com.google.common.collect.Ordering;
import com.google.common.io.BaseEncoding;
+import com.google.gerrit.reviewdb.client.Change;
import com.google.gerrit.reviewdb.client.PatchSet;
import com.google.inject.Singleton;
import java.io.IOException;
@@ -131,5 +132,9 @@
return subject;
}
+ public static String status(Change c) {
+ return c != null ? c.getStatus().name().toLowerCase() : "deleted";
+ }
+
private ChangeUtil() {}
}
diff --git a/gerrit-server/src/main/java/com/google/gerrit/server/change/ChangeJson.java b/gerrit-server/src/main/java/com/google/gerrit/server/change/ChangeJson.java
index 4dc7d36..2282c79 100644
--- a/gerrit-server/src/main/java/com/google/gerrit/server/change/ChangeJson.java
+++ b/gerrit-server/src/main/java/com/google/gerrit/server/change/ChangeJson.java
@@ -448,6 +448,7 @@
info._number = c.getId().get();
info.problems = result.problems();
info.isPrivate = c.isPrivate();
+ info.workInProgress = c.isWorkInProgress();
finish(info);
} else {
info = new ChangeInfo();
@@ -503,6 +504,7 @@
out.deletions = changedLines.get().deletions;
}
out.isPrivate = in.isPrivate();
+ out.workInProgress = in.isWorkInProgress();
out.subject = in.getSubject();
out.status = in.getStatus().asChangeStatus();
out.owner = accountLoader.get(in.getOwner());
diff --git a/gerrit-server/src/main/java/com/google/gerrit/server/change/Module.java b/gerrit-server/src/main/java/com/google/gerrit/server/change/Module.java
index 5aee90c..5ddf9e9 100644
--- a/gerrit-server/src/main/java/com/google/gerrit/server/change/Module.java
+++ b/gerrit-server/src/main/java/com/google/gerrit/server/change/Module.java
@@ -91,6 +91,8 @@
put(CHANGE_KIND, "unignore").to(Unignore.class);
put(CHANGE_KIND, "mute").to(Mute.class);
put(CHANGE_KIND, "unmute").to(Unmute.class);
+ post(CHANGE_KIND, "wip").to(SetWorkInProgress.class);
+ post(CHANGE_KIND, "ready").to(SetReadyForReview.class);
post(CHANGE_KIND, "reviewers").to(PostReviewers.class);
get(CHANGE_KIND, "suggest_reviewers").to(SuggestChangeReviewers.class);
diff --git a/gerrit-server/src/main/java/com/google/gerrit/server/change/SetReadyForReview.java b/gerrit-server/src/main/java/com/google/gerrit/server/change/SetReadyForReview.java
new file mode 100644
index 0000000..dbc82b7
--- /dev/null
+++ b/gerrit-server/src/main/java/com/google/gerrit/server/change/SetReadyForReview.java
@@ -0,0 +1,85 @@
+// Copyright (C) 2017 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.change;
+
+import com.google.gerrit.common.TimeUtil;
+import com.google.gerrit.extensions.restapi.AuthException;
+import com.google.gerrit.extensions.restapi.ResourceConflictException;
+import com.google.gerrit.extensions.restapi.Response;
+import com.google.gerrit.extensions.restapi.RestApiException;
+import com.google.gerrit.extensions.restapi.RestModifyView;
+import com.google.gerrit.extensions.webui.UiAction;
+import com.google.gerrit.reviewdb.client.Change;
+import com.google.gerrit.reviewdb.client.Change.Status;
+import com.google.gerrit.reviewdb.server.ReviewDb;
+import com.google.gerrit.server.ChangeMessagesUtil;
+import com.google.gerrit.server.ChangeUtil;
+import com.google.gerrit.server.change.WorkInProgressOp.Input;
+import com.google.gerrit.server.update.BatchUpdate;
+import com.google.gerrit.server.update.UpdateException;
+import com.google.inject.Inject;
+import com.google.inject.Provider;
+import com.google.inject.Singleton;
+
+@Singleton
+public class SetReadyForReview
+ implements RestModifyView<ChangeResource, Input>, UiAction<ChangeResource> {
+ private final BatchUpdate.Factory batchUpdateFactory;
+ private final ChangeMessagesUtil cmUtil;
+ private final Provider<ReviewDb> db;
+
+ @Inject
+ SetReadyForReview(
+ BatchUpdate.Factory batchUpdateFactory, ChangeMessagesUtil cmUtil, Provider<ReviewDb> db) {
+ this.batchUpdateFactory = batchUpdateFactory;
+ this.cmUtil = cmUtil;
+ this.db = db;
+ }
+
+ @Override
+ public Response<?> apply(ChangeResource rsrc, Input input)
+ throws RestApiException, UpdateException {
+ Change change = rsrc.getChange();
+ if (!rsrc.isUserOwner()) {
+ throw new AuthException("not allowed to set ready for review");
+ }
+
+ if (change.getStatus() != Status.NEW) {
+ throw new ResourceConflictException("change is " + ChangeUtil.status(change));
+ }
+
+ if (!change.isWorkInProgress()) {
+ throw new ResourceConflictException("change is not work in progress");
+ }
+
+ try (BatchUpdate bu =
+ batchUpdateFactory.create(db.get(), rsrc.getProject(), rsrc.getUser(), TimeUtil.nowTs())) {
+ bu.addOp(rsrc.getChange().getId(), new WorkInProgressOp(cmUtil, false, input));
+ bu.execute();
+ return Response.ok("");
+ }
+ }
+
+ @Override
+ public Description getDescription(ChangeResource rsrc) {
+ return new Description()
+ .setLabel("Ready")
+ .setTitle("Set Ready For Review")
+ .setVisible(
+ rsrc.isUserOwner()
+ && rsrc.getChange().getStatus() == Status.NEW
+ && rsrc.getChange().isWorkInProgress());
+ }
+}
diff --git a/gerrit-server/src/main/java/com/google/gerrit/server/change/SetWorkInProgress.java b/gerrit-server/src/main/java/com/google/gerrit/server/change/SetWorkInProgress.java
new file mode 100644
index 0000000..aa93fc2
--- /dev/null
+++ b/gerrit-server/src/main/java/com/google/gerrit/server/change/SetWorkInProgress.java
@@ -0,0 +1,85 @@
+// Copyright (C) 2017 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.change;
+
+import com.google.gerrit.common.TimeUtil;
+import com.google.gerrit.extensions.restapi.AuthException;
+import com.google.gerrit.extensions.restapi.ResourceConflictException;
+import com.google.gerrit.extensions.restapi.Response;
+import com.google.gerrit.extensions.restapi.RestApiException;
+import com.google.gerrit.extensions.restapi.RestModifyView;
+import com.google.gerrit.extensions.webui.UiAction;
+import com.google.gerrit.reviewdb.client.Change;
+import com.google.gerrit.reviewdb.client.Change.Status;
+import com.google.gerrit.reviewdb.server.ReviewDb;
+import com.google.gerrit.server.ChangeMessagesUtil;
+import com.google.gerrit.server.ChangeUtil;
+import com.google.gerrit.server.change.WorkInProgressOp.Input;
+import com.google.gerrit.server.update.BatchUpdate;
+import com.google.gerrit.server.update.UpdateException;
+import com.google.inject.Inject;
+import com.google.inject.Provider;
+import com.google.inject.Singleton;
+
+@Singleton
+public class SetWorkInProgress
+ implements RestModifyView<ChangeResource, Input>, UiAction<ChangeResource> {
+ private final BatchUpdate.Factory batchUpdateFactory;
+ private final ChangeMessagesUtil cmUtil;
+ private final Provider<ReviewDb> db;
+
+ @Inject
+ SetWorkInProgress(
+ BatchUpdate.Factory batchUpdateFactory, ChangeMessagesUtil cmUtil, Provider<ReviewDb> db) {
+ this.batchUpdateFactory = batchUpdateFactory;
+ this.cmUtil = cmUtil;
+ this.db = db;
+ }
+
+ @Override
+ public Response<?> apply(ChangeResource rsrc, Input input)
+ throws RestApiException, UpdateException {
+ Change change = rsrc.getChange();
+ if (!rsrc.isUserOwner()) {
+ throw new AuthException("not allowed to set work in progress");
+ }
+
+ if (change.getStatus() != Status.NEW) {
+ throw new ResourceConflictException("change is " + ChangeUtil.status(change));
+ }
+
+ if (change.isWorkInProgress()) {
+ throw new ResourceConflictException("change is already work in progress");
+ }
+
+ try (BatchUpdate bu =
+ batchUpdateFactory.create(db.get(), rsrc.getProject(), rsrc.getUser(), TimeUtil.nowTs())) {
+ bu.addOp(rsrc.getChange().getId(), new WorkInProgressOp(cmUtil, true, input));
+ bu.execute();
+ return Response.ok("");
+ }
+ }
+
+ @Override
+ public Description getDescription(ChangeResource rsrc) {
+ return new Description()
+ .setLabel("WIP")
+ .setTitle("Set Work In Progress")
+ .setVisible(
+ rsrc.isUserOwner()
+ && rsrc.getChange().getStatus() == Status.NEW
+ && !rsrc.getChange().isWorkInProgress());
+ }
+}
diff --git a/gerrit-server/src/main/java/com/google/gerrit/server/change/WorkInProgressOp.java b/gerrit-server/src/main/java/com/google/gerrit/server/change/WorkInProgressOp.java
new file mode 100644
index 0000000..7f6e543
--- /dev/null
+++ b/gerrit-server/src/main/java/com/google/gerrit/server/change/WorkInProgressOp.java
@@ -0,0 +1,80 @@
+// Copyright (C) 2017 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.change;
+
+import com.google.common.base.Strings;
+import com.google.gerrit.reviewdb.client.Change;
+import com.google.gerrit.reviewdb.client.ChangeMessage;
+import com.google.gerrit.server.ChangeMessagesUtil;
+import com.google.gerrit.server.notedb.ChangeUpdate;
+import com.google.gerrit.server.update.BatchUpdateOp;
+import com.google.gerrit.server.update.ChangeContext;
+import com.google.gwtorm.server.OrmException;
+
+/* Set work in progress or ready for review state on a change */
+public class WorkInProgressOp implements BatchUpdateOp {
+ public static class Input {
+ String message;
+
+ public Input() {}
+
+ public Input(String message) {
+ this.message = message;
+ }
+ }
+
+ private final ChangeMessagesUtil cmUtil;
+ private final boolean workInProgress;
+ private final Input in;
+
+ WorkInProgressOp(ChangeMessagesUtil cmUtil, boolean workInProgress, Input in) {
+ this.cmUtil = cmUtil;
+ this.workInProgress = workInProgress;
+ this.in = in;
+ }
+
+ @Override
+ public boolean updateChange(ChangeContext ctx) throws OrmException {
+ Change change = ctx.getChange();
+ ChangeUpdate update = ctx.getUpdate(change.currentPatchSetId());
+ change.setWorkInProgress(workInProgress);
+ change.setLastUpdatedOn(ctx.getWhen());
+ update.setWorkInProgress(workInProgress);
+ addMessage(ctx, update);
+ return true;
+ }
+
+ private void addMessage(ChangeContext ctx, ChangeUpdate update) throws OrmException {
+ Change c = ctx.getChange();
+ StringBuilder buf =
+ new StringBuilder(c.isWorkInProgress() ? "Set Work In Progress" : "Set Ready For Review");
+
+ String m = Strings.nullToEmpty(in.message).trim();
+ if (!m.isEmpty()) {
+ buf.append("\n\n");
+ buf.append(m);
+ }
+
+ ChangeMessage cmsg =
+ ChangeMessagesUtil.newMessage(
+ ctx,
+ buf.toString(),
+ c.isWorkInProgress()
+ ? ChangeMessagesUtil.TAG_SET_WIP
+ : ChangeMessagesUtil.TAG_SET_READY);
+
+ cmUtil.addChangeMessage(ctx.getDb(), update, cmsg);
+ }
+}
