SONAR-7966 field logs deprecated in /api/ce/{task/component/activity}

diff --git a/server/sonar-server/src/main/java/org/sonar/server/ce/ws/ActivityAction.java b/server/sonar-server/src/main/java/org/sonar/server/ce/ws/ActivityAction.java
index 7625e39e169d3fa1192e67518470031e31c76216..c13f5722252974b80ba8af592d8585500f05c6d7 100644 (file)
--- a/server/sonar-server/src/main/java/org/sonar/server/ce/ws/ActivityAction.java
+++ b/server/sonar-server/src/main/java/org/sonar/server/ce/ws/ActivityAction.java
@@ -98,7 +98,8 @@ public class ActivityAction implements CeWsAction {
       .setDescription(format("Search for tasks.<br> " +
         "Requires the system administration permission, " +
         "or project administration permission if %s is set.<br/>" +
-        "Since 5.5, it's no more possible to specify the page parameter", PARAM_COMPONENT_ID))
+        "Since 5.5, it's no more possible to specify the page parameter.<br/>" +
+        "Since 6.1, field \"logs\" is deprecated and its value will always be false", PARAM_COMPONENT_ID))
       .setResponseExample(getClass().getResource("activity-example.json"))
       .setHandler(this)
       .setSince("5.2");

diff --git a/server/sonar-server/src/main/java/org/sonar/server/ce/ws/ComponentAction.java b/server/sonar-server/src/main/java/org/sonar/server/ce/ws/ComponentAction.java
index ffb78a203bfafc25217f1e03db9ed3aab451e8cb..153bc667fd1b8d9098a31edda17ff634c9bfa1a6 100644 (file)
--- a/server/sonar-server/src/main/java/org/sonar/server/ce/ws/ComponentAction.java
+++ b/server/sonar-server/src/main/java/org/sonar/server/ce/ws/ComponentAction.java
@@ -28,8 +28,8 @@ import org.sonar.core.util.Uuids;
 import org.sonar.db.DbClient;
 import org.sonar.db.DbSession;
 import org.sonar.db.ce.CeActivityDto;
-import org.sonar.db.ce.CeTaskQuery;
 import org.sonar.db.ce.CeQueueDto;
+import org.sonar.db.ce.CeTaskQuery;
 import org.sonar.server.user.UserSession;
 import org.sonar.server.ws.WsUtils;
 
@@ -53,7 +53,8 @@ public class ComponentAction implements CeWsAction {
   public void define(WebService.NewController controller) {
     WebService.NewAction action = controller.createAction("component")
       .setDescription("Get the pending tasks, in-progress tasks and the last executed task of a given component " +
-        "(usually a project). Requires the administration permission on the component.")
+        "(usually a project). Requires the administration permission on the component.<br/>" +
+        "Since 6.1, field \"logs\" is deprecated and its value will always be false")
       .setSince("5.2")
       .setResponseExample(getClass().getResource("component-example.json"))
       .setHandler(this);

diff --git a/server/sonar-server/src/main/java/org/sonar/server/ce/ws/TaskAction.java b/server/sonar-server/src/main/java/org/sonar/server/ce/ws/TaskAction.java
index 55b61f8085095bddc4f6ec4bc76cd5ff405acf58..f89f41f0c58ff144f05c4d59676828fbbab19fb0 100644 (file)
--- a/server/sonar-server/src/main/java/org/sonar/server/ce/ws/TaskAction.java
+++ b/server/sonar-server/src/main/java/org/sonar/server/ce/ws/TaskAction.java
@@ -57,7 +57,8 @@ public class TaskAction implements CeWsAction {
   public void define(WebService.NewController controller) {
     WebService.NewAction action = controller.createAction(ACTION)
       .setDescription("Give Compute Engine task details such as type, status, duration and associated component.<br />" +
-        "Requires 'Administer System' or 'Execute Analysis' permission.")
+        "Requires 'Administer System' or 'Execute Analysis' permission.<br/>" +
+        "Since 6.1, field \"logs\" is deprecated and its value will always be false")
       .setResponseExample(getClass().getResource("task-example.json"))
       .setSince("5.2")
       .setHandler(this);
@@ -98,8 +99,7 @@ public class TaskAction implements CeWsAction {
   private void checkPermission(@Nullable String projectUuid) {
     if (!userSession.hasPermission(SYSTEM_ADMIN)
       && !userSession.hasPermission(SCAN_EXECUTION)
-      && (projectUuid == null || !userSession.hasComponentUuidPermission(SCAN_EXECUTION, projectUuid))
-      ) {
+      && (projectUuid == null || !userSession.hasComponentUuidPermission(SCAN_EXECUTION, projectUuid))) {
       throw insufficientPrivilegesException();
     }
   }

diff --git a/server/sonar-server/src/main/java/org/sonar/server/ce/ws/TaskFormatter.java b/server/sonar-server/src/main/java/org/sonar/server/ce/ws/TaskFormatter.java
index df0e5fcf9043375e30ae9e3ee0d89ed62f5ff03b..b13d5d7c353619b224cae4a8457635ceb599f6f4 100644 (file)
--- a/server/sonar-server/src/main/java/org/sonar/server/ce/ws/TaskFormatter.java
+++ b/server/sonar-server/src/main/java/org/sonar/server/ce/ws/TaskFormatter.java
@@ -34,7 +34,6 @@ import javax.annotation.Nullable;
 import org.sonar.api.utils.DateUtils;
 import org.sonar.api.utils.System2;
 import org.sonar.ce.log.CeLogging;
-import org.sonar.ce.log.LogFileRef;
 import org.sonar.db.DbClient;
 import org.sonar.db.DbSession;
 import org.sonar.db.ce.CeActivityDto;
@@ -72,7 +71,7 @@ public class TaskFormatter {
     builder.setId(dto.getUuid());
     builder.setStatus(WsCe.TaskStatus.valueOf(dto.getStatus().name()));
     builder.setType(dto.getTaskType());
-    builder.setLogs(ceLogging.getFile(LogFileRef.from(dto)).isPresent());
+    builder.setLogs(false);
     if (dto.getComponentUuid() != null) {
       builder.setComponentId(dto.getComponentUuid());
       buildComponent(builder, componentDtoCache.get(dto.getComponentUuid()));
@@ -106,7 +105,7 @@ public class TaskFormatter {
     builder.setId(dto.getUuid());
     builder.setStatus(WsCe.TaskStatus.valueOf(dto.getStatus().name()));
     builder.setType(dto.getTaskType());
-    builder.setLogs(ceLogging.getFile(LogFileRef.from(dto)).isPresent());
+    builder.setLogs(false);
     if (dto.getComponentUuid() != null) {
       builder.setComponentId(dto.getComponentUuid());
       buildComponent(builder, componentDtoCache.get(dto.getComponentUuid()));

diff --git a/server/sonar-server/src/main/resources/org/sonar/server/ce/ws/component-example.json b/server/sonar-server/src/main/resources/org/sonar/server/ce/ws/component-example.json
index 6adb3f0d7aac685a700e8fb544510228d2b8f8d9..488fec6cab27ee465813db9dc57488dbfd6d98b8 100644 (file)
--- a/server/sonar-server/src/main/resources/org/sonar/server/ce/ws/component-example.json
+++ b/server/sonar-server/src/main/resources/org/sonar/server/ce/ws/component-example.json
@@ -8,8 +8,7 @@
       "componentName": "HttpRequest",
       "componentQualifier": "TRK",
       "status": "PENDING",
-      "submittedAt": "2015-09-21T19:28:54+0200",
-      "logs": true
+      "submittedAt": "2015-09-21T19:28:54+0200"
     }
   ],
   "current": {
@@ -24,7 +23,6 @@
     "submittedAt": "2015-09-21T19:25:49+0200",
     "startedAt": "2015-09-21T19:25:57+0200",
     "finishedAt": "2015-09-21T19:25:58+0200",
-    "executionTimeMs": 1371,
-    "logs": true
+    "executionTimeMs": 1371
   }
 }

diff --git a/server/sonar-server/src/main/resources/org/sonar/server/ce/ws/task-example.json b/server/sonar-server/src/main/resources/org/sonar/server/ce/ws/task-example.json
index 089e277fb625cee3a3c06b9284d975cf0c43baac..fbf21cb98deb7fce2f2725e28504c55ccefe4ee1 100644 (file)
--- a/server/sonar-server/src/main/resources/org/sonar/server/ce/ws/task-example.json
+++ b/server/sonar-server/src/main/resources/org/sonar/server/ce/ws/task-example.json
@@ -11,7 +11,6 @@
     "submittedAt": "2015-10-02T11:32:15+0200",
     "startedAt": "2015-10-02T11:32:16+0200",
     "executedAt": "2015-10-02T11:32:22+0200",
-    "executionTimeMs": 5286,
-    "logs": true
+    "executionTimeMs": 5286
   }
 }

diff --git a/server/sonar-server/src/test/java/org/sonar/server/ce/ws/TaskFormatterTest.java b/server/sonar-server/src/test/java/org/sonar/server/ce/ws/TaskFormatterTest.java
index 0ed28fb9c582e93ee52f35925bda0098d00e602f..05435fb515664467d8115b5e2c9611f15aa7f8bc 100644 (file)
--- a/server/sonar-server/src/test/java/org/sonar/server/ce/ws/TaskFormatterTest.java
+++ b/server/sonar-server/src/test/java/org/sonar/server/ce/ws/TaskFormatterTest.java
@@ -19,7 +19,6 @@
  */
 package org.sonar.server.ce.ws;
 
-import com.google.common.base.Optional;
 import java.io.IOException;
 import java.util.Date;
 import org.junit.Rule;
@@ -29,7 +28,6 @@ import org.mockito.Mockito;
 import org.sonar.api.utils.DateUtils;
 import org.sonar.api.utils.System2;
 import org.sonar.ce.log.CeLogging;
-import org.sonar.ce.log.LogFileRef;
 import org.sonar.db.DbTester;
 import org.sonar.db.ce.CeActivityDto;
 import org.sonar.db.ce.CeQueueDto;
@@ -39,7 +37,6 @@ import org.sonarqube.ws.WsCe;
 
 import static java.util.Arrays.asList;
 import static org.assertj.core.api.Assertions.assertThat;
-import static org.mockito.Matchers.any;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.when;
 
@@ -83,7 +80,6 @@ public class TaskFormatterTest {
 
   @Test
   public void formatQueue_with_component_and_other_fields() throws IOException {
-    when(ceLogging.getFile(any(LogFileRef.class))).thenReturn(Optional.of(temp.newFile()));
     String uuid = "COMPONENT_UUID";
     db.getDbClient().componentDao().insert(db.getSession(),
       ComponentTesting.newProjectDto(uuid).setKey("COMPONENT_KEY").setName("Component Name"));
@@ -106,7 +102,7 @@ public class TaskFormatterTest {
     assertThat(wsTask.getComponentName()).isEqualTo("Component Name");
     assertThat(wsTask.getComponentQualifier()).isEqualTo("TRK");
     assertThat(wsTask.getStatus()).isEqualTo(WsCe.TaskStatus.IN_PROGRESS);
-    assertThat(wsTask.getLogs()).isTrue();
+    assertThat(wsTask.getLogs()).isFalse();
     assertThat(wsTask.getSubmitterLogin()).isEqualTo("rob");
     assertThat(wsTask.hasExecutionTimeMs()).isTrue();
     assertThat(wsTask.hasExecutedAt()).isFalse();
@@ -179,16 +175,6 @@ public class TaskFormatterTest {
     assertThat(wsTask.getLogs()).isFalse();
   }
 
-  @Test
-  public void formatActivity_has_logs() throws IOException {
-    when(ceLogging.getFile(any(LogFileRef.class))).thenReturn(Optional.of(temp.newFile()));
-    CeActivityDto dto = newActivity("UUID", "COMPONENT_UUID", CeActivityDto.Status.FAILED);
-
-    WsCe.Task wsTask = underTest.formatActivity(db.getSession(), dto);
-
-    assertThat(wsTask.getLogs()).isTrue();
-  }
-
   @Test
   public void formatActivities() {
     CeActivityDto dto1 = newActivity("UUID1", "COMPONENT_UUID", CeActivityDto.Status.FAILED);