Allow using query string in a GET request to HubStatusServlet (#2771)

Author: tommywo

java/server/src/org/openqa/grid/web/servlet/HubStatusServlet.java

@@ -33,6 +33,7 @@
 import java.io.IOException;
 import java.io.InputStreamReader;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.List;
 import java.util.Map;
 
@@ -55,9 +56,9 @@
  *      ]
  * }
  *
- * if no param is specified, all params known to the hub are returned.
+ * alternatively you can use a query string ?configuration=timeout,servlets
  *
- * {"configuration": []  }
+ * if no param is specified, all params known to the hub are returned.
  *
  */
 public class HubStatusServlet extends RegistryBasedServlet {
@@ -101,7 +102,10 @@ private JsonObject getResponse(HttpServletRequest request) throws IOException {
       if (request.getInputStream() != null) {
         JsonObject requestJSON = getRequestJSON(request);
         List<String> keysToReturn = null;
-        if (requestJSON != null && requestJSON.has("configuration")) {
+
+        if (request.getParameter("configuration") != null && !"".equals(request.getParameter("configuration"))) {
+          keysToReturn = Arrays.asList(request.getParameter("configuration").split(","));
+        } else if (requestJSON != null && requestJSON.has("configuration")) {
           keysToReturn = new Gson().fromJson(requestJSON.getAsJsonArray("configuration"), ArrayList.class);
         }
 

java/server/test/org/openqa/grid/internal/StatusServletTests.java

@@ -52,6 +52,7 @@
 import java.io.InputStreamReader;
 import java.net.URL;
 import java.net.URLEncoder;
+import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.Map;
 
@@ -273,6 +274,34 @@ public void testHubGetSpecifiedConfig() throws IOException {
 
   }
 
+  /**
+   * if a certain set of parameters are requested to the hub, only those params are returned.
+   * @throws IOException
+   */
+  @Test
+  public void testHubGetSpecifiedConfigWithQueryString() throws IOException {
+
+    HttpClient client = httpClientFactory.getHttpClient();
+
+    ArrayList<String> keys = new ArrayList<>();
+    keys.add(URLEncoder.encode("timeout", "UTF-8"));
+    keys.add(URLEncoder.encode("I'm not a valid key", "UTF-8"));
+    keys.add(URLEncoder.encode("servlets", "UTF-8"));
+
+    String query = "?configuration=" + String.join(",",keys);
+    String url = hubApi.toExternalForm() + query ;
+    BasicHttpEntityEnclosingRequest r = new BasicHttpEntityEnclosingRequest("GET", url);
+
+    HttpResponse response = client.execute(host, r);
+    assertEquals(200, response.getStatusLine().getStatusCode());
+    JsonObject o = extractObject(response);
+
+    assertTrue(o.get("success").getAsBoolean());
+    assertEquals(12345, o.get("timeout").getAsInt());
+    assertNull(o.get("I'm not a valid key"));
+    assertTrue(o.getAsJsonArray("servlets").size() == 0);
+    assertFalse(o.has("capabilityMatcher"));
+  }
 
   /**
    * when no param is specified, a call to the hub API returns all the config params the hub