Move batch/upload_report to api/analysis_reports/submit_report

server/sonar-server/src/main/java/org/sonar/server/batch/BatchWs.java

@@ -35,14 +35,11 @@ public class BatchWs implements WebService {
   private final BatchIndex batchIndex;
   private final GlobalReferentialsAction globalReferentialsAction;
   private final ProjectReferentialsAction projectReferentialsAction;
-  private final UploadReportAction uploadReportAction;
 
-  public BatchWs(BatchIndex batchIndex, GlobalReferentialsAction globalReferentialsAction, ProjectReferentialsAction projectReferentialsAction,
-                 UploadReportAction uploadReportAction) {
+  public BatchWs(BatchIndex batchIndex, GlobalReferentialsAction globalReferentialsAction, ProjectReferentialsAction projectReferentialsAction) {
     this.batchIndex = batchIndex;
     this.globalReferentialsAction = globalReferentialsAction;
     this.projectReferentialsAction = projectReferentialsAction;
-    this.uploadReportAction = uploadReportAction;
   }
 
   @Override
@@ -55,7 +52,6 @@ public void define(Context context) {
     defineFileAction(controller);
     globalReferentialsAction.define(controller);
     projectReferentialsAction.define(controller);
-    uploadReportAction.define(controller);
 
     controller.done();
   }

server/sonar-server/src/main/java/org/sonar/server/batch/UploadReportAction.java → server/sonar-server/src/main/java/org/sonar/server/computation/ws/SubmitReportWsAction.java

@@ -18,9 +18,8 @@
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
 
-package org.sonar.server.batch;
+package org.sonar.server.computation.ws;
 
-import org.apache.commons.io.IOUtils;
 import org.sonar.api.server.ws.Request;
 import org.sonar.api.server.ws.RequestHandler;
 import org.sonar.api.server.ws.Response;
@@ -30,26 +29,25 @@
 
 import java.io.InputStream;
 
-public class UploadReportAction implements RequestHandler {
+public class SubmitReportWsAction implements ComputationWsAction, RequestHandler {
 
-  public static final String UPLOAD_REPORT_ACTION = "upload_report";
+  public static final String ACTION = "submit_report";
+  public static final String PARAM_PROJECT_KEY = "projectKey";
+  public static final String PARAM_SNAPSHOT = "snapshot";
+  public static final String PARAM_REPORT_DATA = "report";
 
-  static final String PARAM_PROJECT_KEY = "project";
-  static final String PARAM_SNAPSHOT = "snapshot";
-  static final String PARAM_REPORT_DATA = "report";
+  private final AnalysisReportQueue queue;
+  private final AnalysisReportTaskLauncher taskLauncher;
 
-  private final AnalysisReportQueue analysisReportQueue;
-  private final AnalysisReportTaskLauncher analysisTaskLauncher;
-
-  public UploadReportAction(AnalysisReportQueue analysisReportQueue, AnalysisReportTaskLauncher analysisTaskLauncher) {
-    this.analysisReportQueue = analysisReportQueue;
-    this.analysisTaskLauncher = analysisTaskLauncher;
+  public SubmitReportWsAction(AnalysisReportQueue queue, AnalysisReportTaskLauncher taskLauncher) {
+    this.queue = queue;
+    this.taskLauncher = taskLauncher;
   }
 
-  void define(WebService.NewController controller) {
-    WebService.NewAction action = controller.createAction(UPLOAD_REPORT_ACTION)
-      .setDescription("Update analysis report")
-      .setSince("5.0")
+  @Override
+  public void define(WebService.NewController controller) {
+    WebService.NewAction action = controller.createAction(ACTION)
+      .setDescription("Submit an analysis report to the queue. Report is integrated asynchronously.")
       .setPost(true)
       .setInternal(true)
       .setHandler(this);
@@ -63,26 +61,22 @@ void define(WebService.NewController controller) {
     action
       .createParam(PARAM_SNAPSHOT)
       .setRequired(true)
-      .setDescription("Snapshot id")
+      .setDescription("Snapshot ID")
       .setExampleValue("123");
 
     action
       .createParam(PARAM_REPORT_DATA)
       .setRequired(false)
-      .setDescription("Report file");
+      .setDescription("Report file. Format is not an API, it changes among SonarQube versions.");
   }
 
   @Override
   public void handle(Request request, Response response) throws Exception {
     String projectKey = request.mandatoryParam(PARAM_PROJECT_KEY);
-    String snapshotId = request.mandatoryParam(PARAM_SNAPSHOT);
-    InputStream reportData = request.paramAsInputStream(PARAM_REPORT_DATA);
-
-    try {
-      analysisReportQueue.add(projectKey, Long.valueOf(snapshotId), reportData);
-      analysisTaskLauncher.startAnalysisTaskNow();
-    } finally {
-      IOUtils.closeQuietly(reportData);
+    long snapshotId = request.mandatoryParamAsLong(PARAM_SNAPSHOT);
+    try (InputStream reportData = request.paramAsInputStream(PARAM_REPORT_DATA)) {
+      queue.add(projectKey, snapshotId, reportData);
+      taskLauncher.startAnalysisTaskNow();
     }
   }
 }

server/sonar-server/src/main/java/org/sonar/server/platform/ServerComponents.java

@@ -96,6 +96,7 @@
 import org.sonar.server.computation.ws.HistoryWsAction;
 import org.sonar.server.computation.ws.ComputationWebService;
 import org.sonar.server.computation.ws.IsQueueEmptyWsAction;
+import org.sonar.server.computation.ws.SubmitReportWsAction;
 import org.sonar.server.config.ws.PropertiesWs;
 import org.sonar.server.dashboard.db.DashboardDao;
 import org.sonar.server.dashboard.db.WidgetDao;
@@ -355,7 +356,7 @@ void startLevel4Components(ComponentContainer pico) {
     pico.addSingleton(GlobalReferentialsAction.class);
     pico.addSingleton(ProjectReferentialsAction.class);
     pico.addSingleton(ProjectReferentialsLoader.class);
-    pico.addSingleton(UploadReportAction.class);
+    pico.addSingleton(SubmitReportWsAction.class);
     pico.addSingleton(BatchWs.class);
 
     // update center

server/sonar-server/src/test/java/org/sonar/server/batch/BatchWsTest.java

@@ -29,8 +29,6 @@
 import org.mockito.Mock;
 import org.mockito.runners.MockitoJUnitRunner;
 import org.sonar.core.properties.PropertiesDao;
-import org.sonar.server.computation.AnalysisReportQueue;
-import org.sonar.server.computation.AnalysisReportTaskLauncher;
 import org.sonar.server.db.DbClient;
 import org.sonar.server.ws.WsTester;
 
@@ -59,8 +57,7 @@ public class BatchWsTest {
   public void before() throws IOException {
     tester = new WsTester(new BatchWs(batchIndex,
       new GlobalReferentialsAction(mock(DbClient.class), mock(PropertiesDao.class)),
-      new ProjectReferentialsAction(mock(ProjectReferentialsLoader.class)),
-      new UploadReportAction(mock(AnalysisReportQueue.class), mock(AnalysisReportTaskLauncher.class))));
+      new ProjectReferentialsAction(mock(ProjectReferentialsLoader.class))));
   }
 
   @Test

server/sonar-server/src/test/java/org/sonar/server/batch/GlobalReferentialsActionTest.java

@@ -59,7 +59,7 @@ public void setUp() throws Exception {
     when(dbClient.openSession(false)).thenReturn(session);
     when(dbClient.metricDao()).thenReturn(metricDao);
 
-    tester = new WsTester(new BatchWs(mock(BatchIndex.class), new GlobalReferentialsAction(dbClient, propertiesDao), mock(ProjectReferentialsAction.class), mock(UploadReportAction.class)));
+    tester = new WsTester(new BatchWs(mock(BatchIndex.class), new GlobalReferentialsAction(dbClient, propertiesDao), mock(ProjectReferentialsAction.class)));
   }
 
   @Test

server/sonar-server/src/test/java/org/sonar/server/batch/ProjectReferentialsActionTest.java

@@ -44,7 +44,7 @@ public class ProjectReferentialsActionTest {
   @Before
   public void setUp() throws Exception {
     tester = new WsTester(new BatchWs(mock(BatchIndex.class), mock(GlobalReferentialsAction.class),
-      new ProjectReferentialsAction(projectReferentialsLoader), mock(UploadReportAction.class)));
+      new ProjectReferentialsAction(projectReferentialsLoader)));
   }
 
   @Test

server/sonar-server/src/test/java/org/sonar/server/batch/UploadReportActionTest.java → server/sonar-server/src/test/java/org/sonar/server/computation/ws/SubmitReportWsActionTest.java

@@ -18,24 +18,26 @@
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
 
-package org.sonar.server.batch;
+package org.sonar.server.computation.ws;
 
 import org.apache.commons.io.IOUtils;
 import org.junit.Before;
 import org.junit.Test;
 import org.sonar.api.server.ws.Request;
 import org.sonar.api.server.ws.Response;
+import org.sonar.api.server.ws.WebService;
 import org.sonar.server.computation.AnalysisReportQueue;
 import org.sonar.server.computation.AnalysisReportTaskLauncher;
 
 import java.io.InputStream;
 
+import static org.fest.assertions.Assertions.assertThat;
 import static org.mockito.Mockito.*;
 
-public class UploadReportActionTest {
+public class SubmitReportWsActionTest {
 
   private static final String DEFAULT_PROJECT_KEY = "123456789-987654321";
-  private UploadReportAction sut;
+  private SubmitReportWsAction sut;
 
   private AnalysisReportTaskLauncher analysisTaskLauncher;
   private AnalysisReportQueue queue;
@@ -45,18 +47,30 @@ public void before() {
     analysisTaskLauncher = mock(AnalysisReportTaskLauncher.class);
     queue = mock(AnalysisReportQueue.class);
 
-    sut = new UploadReportAction(queue, analysisTaskLauncher);
+    sut = new SubmitReportWsAction(queue, analysisTaskLauncher);
+  }
+
+  @Test
+  public void define_metadata() throws Exception {
+    WebService.Context context = new WebService.Context();
+    WebService.NewController controller = context.createController("api/computation");
+    sut.define(controller);
+    controller.done();
+
+    WebService.Action action = context.controller("api/computation").action("submit_report");
+    assertThat(action).isNotNull();
+    assertThat(action.params()).hasSize(3);
   }
 
   @Test
   public void add_element_to_queue_and_launch_analysis_task() throws Exception {
     Response response = mock(Response.class);
     Request request = mock(Request.class);
 
-    when(request.mandatoryParam(UploadReportAction.PARAM_PROJECT_KEY)).thenReturn(DEFAULT_PROJECT_KEY);
-    when(request.mandatoryParam(UploadReportAction.PARAM_SNAPSHOT)).thenReturn("123");
+    when(request.mandatoryParam(SubmitReportWsAction.PARAM_PROJECT_KEY)).thenReturn(DEFAULT_PROJECT_KEY);
+    when(request.mandatoryParamAsLong(SubmitReportWsAction.PARAM_SNAPSHOT)).thenReturn(123L);
     InputStream reportData = IOUtils.toInputStream("report-data");
-    when(request.paramAsInputStream(UploadReportAction.PARAM_REPORT_DATA)).thenReturn(reportData);
+    when(request.paramAsInputStream(SubmitReportWsAction.PARAM_REPORT_DATA)).thenReturn(reportData);
 
     sut.handle(request, response);
 

sonar-batch/src/main/java/org/sonar/batch/report/PublishReportJob.java

@@ -102,7 +102,7 @@ void uploadMultiPartReport(File report) {
     URL url;
     try {
       int snapshotId = resourceCache.get(project.getEffectiveKey()).snapshotId();
-      url = new URL(serverClient.getURL() + "/batch/upload_report?project=" + project.getEffectiveKey() + "&snapshot=" + snapshotId);
+      url = new URL(serverClient.getURL() + "/api/analysis_reports/submit_report?projectKey=" + project.getEffectiveKey() + "&snapshot=" + snapshotId);
     } catch (MalformedURLException e) {
       throw new IllegalArgumentException("Invalid URL", e);
     }