SONAR-8116 Return rating metrics in api/qualitygates/app

server/sonar-server/src/main/java/org/sonar/server/qualitygate/QualityGates.java

@@ -51,7 +51,6 @@
 import org.sonar.server.exceptions.ForbiddenException;
 import org.sonar.server.exceptions.Message;
 import org.sonar.server.exceptions.NotFoundException;
-import org.sonar.server.exceptions.ServerException;
 import org.sonar.server.user.UserSession;
 import org.sonar.server.util.Validation;
 
@@ -242,23 +241,6 @@ public void dissociateProject(Long qGateId, Long projectId) {
     }
   }
 
-  public Collection<Metric> gateMetrics() {
-    return metricFinder.findAll().stream()
-      .filter(QualityGates::isAvailableForInit)
-      .collect(Collectors.toList());
-  }
-
-  public boolean currentUserHasWritePermission() {
-    boolean hasWritePermission = false;
-    try {
-      checkPermission();
-      hasWritePermission = true;
-    } catch (ServerException unallowed) {
-      // Ignored
-    }
-    return hasWritePermission;
-  }
-
   private Collection<QualityGateConditionDto> getConditions(long qGateId, @Nullable Long conditionId) {
     Collection<QualityGateConditionDto> conditions = conditionDao.selectForQualityGate(qGateId);
     if (conditionId == null) {
@@ -315,14 +297,14 @@ private static void validateMetric(Metric metric, Errors errors) {
     errors.check(isAlertable(metric), format("Metric '%s' cannot be used to define a condition.", metric.getKey()));
   }
 
-  private static boolean isAvailableForInit(Metric metric) {
-    return !metric.isDataType() && !CoreMetrics.ALERT_STATUS.equals(metric) && ValueType.RATING != metric.getType();
-  }
-
   private static boolean isAlertable(Metric metric) {
     return isAvailableForInit(metric) && BooleanUtils.isFalse(metric.isHidden());
   }
 
+  private static boolean isAvailableForInit(Metric metric) {
+    return !metric.isDataType() && !CoreMetrics.ALERT_STATUS.equals(metric) && ValueType.RATING != metric.getType();
+  }
+
   private boolean isDefault(QualityGateDto qGate) {
     return qGate.getId().equals(getDefaultId());
   }

server/sonar-server/src/main/java/org/sonar/server/qualitygate/ws/AppAction.java

@@ -19,20 +19,32 @@
  */
 package org.sonar.server.qualitygate.ws;
 
-import org.apache.commons.lang.BooleanUtils;
-import org.sonar.api.measures.Metric;
+import java.util.Collection;
+import java.util.stream.Collectors;
 import org.sonar.api.server.ws.Request;
 import org.sonar.api.server.ws.Response;
 import org.sonar.api.server.ws.WebService;
-import org.sonar.api.utils.text.JsonWriter;
-import org.sonar.server.qualitygate.QualityGates;
+import org.sonar.db.DbClient;
+import org.sonar.db.DbSession;
+import org.sonar.db.metric.MetricDto;
+import org.sonar.server.user.UserSession;
+import org.sonarqube.ws.WsQualityGates.AppWsResponse.Metric;
+
+import static org.sonar.api.measures.CoreMetrics.ALERT_STATUS_KEY;
+import static org.sonar.api.measures.Metric.ValueType.DATA;
+import static org.sonar.api.measures.Metric.ValueType.DISTRIB;
+import static org.sonar.core.permission.GlobalPermissions.QUALITY_GATE_ADMIN;
+import static org.sonar.server.ws.WsUtils.writeProtobuf;
+import static org.sonarqube.ws.WsQualityGates.AppWsResponse;
 
 public class AppAction implements QualityGatesWsAction {
 
-  private final QualityGates qualityGates;
+  private final UserSession userSession;
+  private final DbClient dbClient;
 
-  public AppAction(QualityGates qualityGates) {
-    this.qualityGates = qualityGates;
+  public AppAction(UserSession userSession, DbClient dbClient) {
+    this.userSession = userSession;
+    this.dbClient = dbClient;
   }
 
   @Override
@@ -47,39 +59,42 @@ public void define(WebService.NewController controller) {
 
   @Override
   public void handle(Request request, Response response) {
-    JsonWriter writer = response.newJsonWriter().beginObject();
-    addPermissions(writer);
-    addPeriods(writer);
-    addMetrics(writer);
-    writer.endObject().close();
+    writeProtobuf(AppWsResponse.newBuilder()
+      .setEdit(userSession.hasPermission(QUALITY_GATE_ADMIN))
+      .addAllMetrics(loadMetrics()
+        .stream()
+        .map(AppAction::toMetric)
+        .collect(Collectors.toList()))
+      .build(),
+      request, response);
   }
 
-  private void addPermissions(JsonWriter writer) {
-    writer.prop("edit", qualityGates.currentUserHasWritePermission());
+  private static Metric toMetric(MetricDto metricDto) {
+    String domain = metricDto.getDomain();
+    Metric.Builder metricBuilder = Metric.newBuilder()
+      .setKey(metricDto.getKey())
+      .setName(metricDto.getShortName())
+      .setType(metricDto.getValueType())
+      .setHidden(metricDto.isHidden());
+    if (domain != null) {
+      metricBuilder.setDomain(domain);
+    }
+    return metricBuilder.build();
   }
 
-  private static void addPeriods(JsonWriter writer) {
-    writer.name("periods").beginArray();
-    writer.beginObject()
-      .prop("key", 1L)
-      .prop("text", "Leak")
-      .endObject();
-    writer.endArray();
+  private Collection<MetricDto> loadMetrics() {
+    DbSession dbSession = dbClient.openSession(false);
+    try {
+      return dbClient.metricDao().selectEnabled(dbSession).stream()
+        .filter(metric -> !isDataType(metric) && !ALERT_STATUS_KEY.equals(metric.getKey()))
+        .collect(Collectors.toList());
+    } finally {
+      dbClient.closeSession(dbSession);
+    }
   }
 
-  private void addMetrics(JsonWriter writer) {
-    writer.name("metrics").beginArray();
-    for (Metric metric : qualityGates.gateMetrics()) {
-      writer.beginObject()
-        .prop("id", metric.getId())
-        .prop("key", metric.getKey())
-        .prop("name", metric.getName())
-        .prop("type", metric.getType().toString())
-        .prop("domain", metric.getDomain())
-        .prop("hidden", BooleanUtils.isNotFalse(metric.isHidden()))
-        .endObject();
-    }
-    writer.endArray();
+  private static boolean isDataType(MetricDto metric) {
+    return DATA.name().equals(metric.getValueType()) || DISTRIB.name().equals(metric.getValueType());
   }
 
 }

server/sonar-server/src/main/resources/org/sonar/server/qualitygate/ws/app-example.json

@@ -1,83 +1,19 @@
 {
   "edit": false,
-  "periods": [
-    {
-      "key": 1,
-      "text": "since previous analysis"
-    },
-    {
-      "key": 2,
-      "text": "over 365 days"
-    },
-    {
-      "key": 3,
-      "text": "since previous version"
-    },
-    {
-      "key": 4,
-      "text": "over period 4 - defined at project level"
-    },
-    {
-      "key": 5,
-      "text": "over period 5 - defined at project level"
-    }
-  ],
   "metrics": [
     {
-      "id": 10,
       "key": "accessors",
       "name": "Accessors",
       "type": "INT",
       "domain": "Size",
       "hidden": true
     },
     {
-      "id": 111,
-      "key": "clirr_api_behavior_changes",
-      "name": "API behavior changes",
-      "type": "INT",
-      "domain": "API compatibility",
-      "hidden": false
-    },
-    {
-      "id": 110,
-      "key": "clirr_api_breaks",
-      "name": "API breaks",
-      "type": "INT",
-      "domain": "API compatibility",
-      "hidden": false
-    },
-    {
-      "id": 62,
-      "key": "blocker_violations",
-      "name": "Blocker issues",
-      "type": "INT",
-      "domain": "Issues",
-      "hidden": false
-    },
-    {
-      "id": 138,
       "key": "blocker_remediation_cost",
       "name": "Blocker Technical Debt",
       "type": "WORK_DUR",
       "domain": "SQALE",
       "hidden": false
-    },
-    {
-      "id": 45,
-      "key": "conditions_to_cover",
-      "name": "Branches to cover",
-      "type": "INT",
-      "domain": "Tests",
-      "hidden": true
-    },
-    {
-      "id": 131,
-      "key": "new_it_conditions_to_cover",
-      "name": "Branches to cover by IT on new code",
-      "type": "INT",
-      "domain": "Tests (Integration)",
-      "hidden": true
     }
   ]
 }

server/sonar-server/src/test/java/org/sonar/server/qualitygate/QualityGatesTest.java

@@ -122,23 +122,6 @@ public void should_list_qgates() {
     assertThat(underTest.list()).isEqualTo(allQgates);
   }
 
-  @Test
-  public void should_create_qgate() {
-    String name = "SG-1";
-    QualityGateDto sg1 = underTest.create(name);
-    assertThat(sg1.getName()).isEqualTo(name);
-    verify(dao).selectByName(name);
-    verify(dao).insert(sg1);
-    assertThat(underTest.currentUserHasWritePermission()).isTrue();
-  }
-
-  @Test(expected = ForbiddenException.class)
-  public void should_fail_create_on_anonymous() {
-    userSessionRule.set(unauthenticatedUserSession);
-    assertThat(underTest.currentUserHasWritePermission()).isFalse();
-    underTest.create("polop");
-  }
-
   @Test(expected = ForbiddenException.class)
   public void should_fail_create_on_missing_permission() {
     userSessionRule.set(unauthorizedUserSession);
@@ -637,7 +620,6 @@ public void should_list_gate_metrics() {
     when(classicMetric.getType()).thenReturn(ValueType.BOOL);
     when(metricFinder.findAll()).thenReturn(ImmutableList.of(
       dataMetric, hiddenMetric, nullHiddenMetric, alertMetric, ratingMetric, classicMetric));
-    assertThat(underTest.gateMetrics()).hasSize(3).containsOnly(classicMetric, hiddenMetric, nullHiddenMetric);
   }
 
   private Metric addMetric(String metricKey, String metricName) {