Add Build Tool support at the /supportMatrix/servers endpoint (#439)

Author: rdebusscher

src/main/java/org/eclipse/microprofile/starter/rest/APIEndpointV6.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright (c) 2021 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * 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 org.eclipse.microprofile.starter.rest;
+
+import javax.inject.Inject;
+import javax.ws.rs.GET;
+import javax.ws.rs.HeaderParam;
+import javax.ws.rs.Path;
+import javax.ws.rs.Produces;
+import javax.ws.rs.core.HttpHeaders;
+import javax.ws.rs.core.Response;
+
+/**
+ *
+ */
+@Path("/6")
+public class APIEndpointV6 extends APIEndpointLatest {
+
+    @Inject
+    private APIService api;
+
+    @Path("/supportMatrix/servers")
+    @GET
+    @Produces({"application/json"})
+    public Response supportMatrixServers(@HeaderParam(HttpHeaders.IF_NONE_MATCH) String ifNoneMatch) {
+        return api.supportMatrixServersv6(ifNoneMatch);
+    }
+
+
+
+}

src/main/java/org/eclipse/microprofile/starter/rest/APIService.java

@@ -120,7 +120,8 @@ public void init() {
 
                 List<JavaSEVersion> supportedJavaVersions = selector.getSupportedVersion(s, mpv);
                 List<StandaloneMPSpec> mpStandaloneSpecs = defineStandaloneSpecs(mpv, s);
-                serverOptions.add(new ServerOptions(mpv, mpSpec, mpStandaloneSpecs, supportedJavaVersions));
+                List<BuildTool> buildTools = defineBuildTools(s);
+                serverOptions.add(new ServerOptions(mpv, mpSpec, buildTools, mpStandaloneSpecs, supportedJavaVersions));
             });
             serversToOptions.put(s, serverOptions);
         }
@@ -135,6 +136,15 @@ public void init() {
         }
     }
 
+    private List<BuildTool> defineBuildTools(SupportedServer supportedServer) {
+        List<BuildTool> result = new ArrayList<>();
+        result.add(BuildTool.MAVEN);
+        if (supportedServer.hasGradleSupport()) {
+            result.add(BuildTool.GRADLE);
+        }
+        return result;
+    }
+
     private List<StandaloneMPSpec> defineStandaloneSpecs(MicroProfileVersion version, SupportedServer supportedServer) {
         List<StandaloneMPSpec> result = new ArrayList<>();
         for (StandaloneMPSpec standaloneMPSpec : StandaloneMPSpec.values()) {
@@ -265,6 +275,30 @@ public Response supportMatrixServersV3(String ifNoneMatch) {
         return Response.ok(serversAndSpecsDescriptions, MediaType.APPLICATION_JSON_TYPE).tag(serversToOptionsEtag).build();
     }
 
+    public Response supportMatrixServersv6(String ifNoneMatch) {
+        if (ifNoneMatch != null) {
+            if (serversToOptionsEtag.toString().equals(ifNoneMatch)) {
+                return Response.notModified().build();
+            }
+        }
+        List<SupportedServer> servers = new ArrayList<>(serversToOptions.keySet());
+        Collections.shuffle(servers);
+        Map<SupportedServer, List<ServerOptions>> rndServersToOptions = new LinkedHashMap<>(servers.size());
+        for (SupportedServer s : servers) {
+            List<ServerOptions> options = serversToOptions.get(s);
+            // Without the buildTool
+            List<ServerOptions> newOptions = options.stream()
+                    .map(se -> new ServerOptions(se.mpVersion, se.mpSpecs, se.javaSEVersions))
+                    .collect(Collectors.toList());
+            rndServersToOptions.put(s, newOptions);
+        }
+        Map<String, Map> serversAndSpecsDescriptions = new HashMap<>(2);
+        serversAndSpecsDescriptions.put("configs", rndServersToOptions);
+        serversAndSpecsDescriptions.put("descriptions", specsDescriptions);
+
+        return Response.ok(serversAndSpecsDescriptions, MediaType.APPLICATION_JSON_TYPE).tag(serversToOptionsEtag).build();
+    }
+
     public Response supportMatrixServers(String ifNoneMatch) {
         if (ifNoneMatch != null) {
             if (serversToOptionsEtag.toString().equals(ifNoneMatch)) {

src/main/java/org/eclipse/microprofile/starter/rest/model/ServerOptions.java

@@ -21,6 +21,7 @@
 
 import org.eclipse.microprofile.starter.addon.microprofile.servers.model.MicroprofileSpec;
 import org.eclipse.microprofile.starter.addon.microprofile.servers.model.StandaloneMPSpec;
+import org.eclipse.microprofile.starter.core.model.BuildTool;
 import org.eclipse.microprofile.starter.core.model.JavaSEVersion;
 import org.eclipse.microprofile.starter.core.model.MicroProfileVersion;
 
@@ -35,14 +36,26 @@ public class ServerOptions {
     public final MicroProfileVersion mpVersion;
     public final List<String> mpSpecs;
     public final List<JavaSEVersion> javaSEVersions;
+    public final List<String> buildTools;
 
     public ServerOptions(MicroProfileVersion mpVersion,
                          List<MicroprofileSpec> mpSpecs,
+                         List<BuildTool> buildTools,
                          List<StandaloneMPSpec> mpStandaloneSpecs,
                          List<JavaSEVersion> javaSEVersions) {
         this.mpVersion = mpVersion;
         this.mpSpecs =  mpSpecs.stream().map(spec -> spec.getCode().toUpperCase()).collect(Collectors.toList());
+        this.buildTools = buildTools.stream().map(Enum::name).collect(Collectors.toList());
         this.mpSpecs.addAll(mpStandaloneSpecs.stream().map(spec -> spec.getCode().toUpperCase()).collect(Collectors.toList()));
         this.javaSEVersions = javaSEVersions;
     }
+
+    public ServerOptions(MicroProfileVersion mpVersion,
+                         List<String> mpSpecs,
+                         List<JavaSEVersion> javaSEVersions) {
+        this.mpVersion = mpVersion;
+        this.mpSpecs =  mpSpecs;
+        this.buildTools = null;
+        this.javaSEVersions = javaSEVersions;
+    }
 }

src/main/resources/REST-README.md

@@ -25,7 +25,7 @@ The latest mpVersion with no specs but the basic hello world JAX-RS endpoint is
 
 # Versions
 
-There are currently 3 versions of the API to retain backward compatibility. ```/api/``` is the latest;
+There are currently 6 versions of the API to retain backward compatibility. ```/api/``` is the latest;
 use e.g. ```/api/1/``` to get the legacy behaviour.
 
 # Get available MicroProfile versions
@@ -282,6 +282,8 @@ If it is preferred to acquire all valid options in a one request the ```supportM
 The integration code [SHOULD](https://tools.ietf.org/html/rfc2119) use [Etag](https://tools.ietf.org/html/rfc7232#section-2.3) response header
 and [If-None-Match](https://tools.ietf.org/html/rfc7232#section-3.2) request header so as to avoid unnecessary deserialization of identical responses.
 
+The ```supportMatrix/servers``` endpoint returns the support for a Build Tool (Maven and or Gradle) for each MP version and runtime combination.
+
 ## MicroProfile versions as keys
 
 ```