Change pull request status to NEEDS_WORK instead of resetting approval.

Author: tommywo

src/main/java/org/sonar/plugins/stash/StashIssueReportingPostJob.java

@@ -145,6 +145,14 @@ private void postInfoAndPRsActions(
         stashRequestFacade.resetPullRequestApproval(pr, stashClient);
       }
     }
+
+    if (config.canMarkPullRequestNeedsWork()) {
+      if (shouldApprovePullRequest(config.getApprovalSeverityThreshold(), issueReport)) {
+        stashRequestFacade.resetPullRequestApproval(pr, stashClient);
+      } else {
+        stashRequestFacade.markPullRequestNeedsWork(pr, stashClient);
+      }
+    }
   }
 
   static boolean shouldApprovePullRequest(Optional<Severity> approvalSeverityThreshold, List<PostJobIssue> report) {

src/main/java/org/sonar/plugins/stash/StashPlugin.java

@@ -69,6 +69,7 @@ public enum IssueType {
   public static final String STASH_PASSWORD = "sonar.stash.password";
   public static final String STASH_PASSWORD_ENVIRONMENT_VARIABLE = "sonar.stash.password.variable";
   public static final String STASH_REVIEWER_APPROVAL = "sonar.stash.reviewer.approval";
+  public static final String STASH_REVIEWER_MARK_NEEDS_WORK = "sonar.stash.reviewer.mark.needs.work";
   public static final String STASH_REVIEWER_APPROVAL_SEVERITY_THRESHOLD = "sonar.stash.reviewer.approval.severity.threshold";
   public static final String STASH_ISSUE_THRESHOLD = "sonar.stash.issue.threshold";
   public static final String STASH_ISSUE_SEVERITY_THRESHOLD = "sonar.stash.issue.severity.threshold";
@@ -191,7 +192,14 @@ public void define(Context context) {
                           .type(PropertyType.STRING)
                           .subCategory(CONFIG_PAGE_SUB_CATEGORY_STASH)
                           .onQualifiers(Qualifiers.PROJECT)
-                          .defaultValue(DEFAULT_STASH_EXCLUDE_RULES).build()
+                          .defaultValue(DEFAULT_STASH_EXCLUDE_RULES).build(),
+        PropertyDefinition.builder(STASH_REVIEWER_MARK_NEEDS_WORK)
+                          .name("Stash reviewer marking NEEDS WORK")
+                          .description("Does SonarQube mark the pull-request NEEDS WORK if there are new issues?")
+                          .subCategory(CONFIG_PAGE_SUB_CATEGORY_STASH)
+                          .onQualifiers(Qualifiers.PROJECT)
+                          .type(PropertyType.BOOLEAN)
+                          .defaultValue("false").build()
     );
   }
 }

src/main/java/org/sonar/plugins/stash/StashPluginConfiguration.java

@@ -89,6 +89,9 @@ public int getStashTimeout() {
   public boolean canApprovePullRequest() {
     return settings.getBoolean(StashPlugin.STASH_REVIEWER_APPROVAL);
   }
+  public boolean canMarkPullRequestNeedsWork() {
+    return settings.getBoolean(StashPlugin.STASH_REVIEWER_MARK_NEEDS_WORK);
+  }
 
   public boolean resetComments() {
     return settings.getBoolean(StashPlugin.STASH_RESET_COMMENTS);

src/main/java/org/sonar/plugins/stash/StashRequestFacade.java

@@ -93,6 +93,24 @@ public void approvePullRequest(PullRequestRef pr, StashClient stashClient) {
     }
   }
 
+  /**
+   * Mark pull-request needs work
+   */
+  public void markPullRequestNeedsWork(PullRequestRef pr, StashClient stashClient) {
+    try {
+      stashClient.markPullRequestNeedsWork(pr);
+
+      // squid:S2629 : no evaluation required if the logging level is not activated
+      if (LOGGER.isInfoEnabled()) {
+        LOGGER.info("Pull-request {} ({}/{}) marked NEEDS WORK by user \"{}\"",
+                    pr.pullRequestId(), pr.project(), pr.repository(), stashClient.getLogin());
+      }
+
+    } catch (StashClientException e) {
+      LOGGER.error("Unable to mark pull-request NEEDS WORK", e);
+    }
+  }
+
   /**
    * Reset pull-request approval
    */

src/main/java/org/sonar/plugins/stash/client/StashClient.java

@@ -64,10 +64,12 @@ public class StashClient implements AutoCloseable {
   private static final String API_ONE_PR_ALL_COMMENTS = API_ONE_PR + "/comments";
   private static final String API_ONE_PR_DIFF = API_ONE_PR + "/diff?withComments=true";
   private static final String API_ONE_PR_APPROVAL = API_ONE_PR + "/approve";
+  private static final String API_ONE_PR_NEEDS_WORK = API_ONE_PR + "/participants/{4}";
   private static final String API_ONE_PR_COMMENT_PATH = API_ONE_PR + "/comments?path={4}&start={5,number,#}";
 
   private static final String API_ONE_PR_ONE_COMMENT = API_ONE_PR_ALL_COMMENTS + "/{4}?version={5}";
 
+  private static final String PULL_REQUEST_MARK_NEEDS_WORK_PUT_ERROR_MESSAGE = "Unable to set NEEDS WORK status of pull-request {0}";
   private static final String PULL_REQUEST_APPROVAL_POST_ERROR_MESSAGE = "Unable to change status of pull-request {0}"
                                                                        + " #{1,number,#}.";
   private static final String PULL_REQUEST_GET_ERROR_MESSAGE = "Unable to retrieve pull-request {0} #{1,number,#}.";
@@ -278,6 +280,21 @@ public void resetPullRequestApproval(PullRequestRef pr) throws StashClientExcept
            MessageFormat.format(PULL_REQUEST_APPROVAL_POST_ERROR_MESSAGE, pr.repository(), pr.pullRequestId()));
   }
 
+  public void markPullRequestNeedsWork(PullRequestRef pr ) throws StashClientException {
+    String request = MessageFormat.format(API_ONE_PR_NEEDS_WORK,
+                                          baseUrl,
+                                          pr.project(),
+                                          pr.repository(),
+                                          pr.pullRequestId(),
+                                          credentials.getUserSlug());
+    JsonObject json = new JsonObject();
+    json.put("status", "NEEDS_WORK");
+    put(request,
+        json,
+        MessageFormat
+            .format(PULL_REQUEST_MARK_NEEDS_WORK_PUT_ERROR_MESSAGE, pr.repository(), pr.pullRequestId()));
+  }
+
   public void postTaskOnComment(String message, Long commentId) throws StashClientException {
     String request = baseUrl + TASKS_API;
 

src/test/java/org/sonar/plugins/stash/StashRequestFacadeTest.java

@@ -771,6 +771,12 @@ public void testApprovePullRequest() throws Exception {
     verify(stashClient, times(1)).approvePullRequest(pr);
   }
 
+  @Test
+  public void testmarkPullRequestNeedsWork() throws Exception {
+
+    myFacade.markPullRequestNeedsWork(pr, stashClient);
+    verify(stashClient, times(1)).markPullRequestNeedsWork(pr);
+  }
 
   @Test
   public void testApprovePullRequestException() throws Exception {