[grid] Allowing service config via CLI

diemol · diemol · commit f7a4c21aceb1 · 2021-12-14T11:29:24.000+01:00
When the relay feature was added, we forgot to add this CLI option. Fixes #10115
diff --git a/java/src/org/openqa/selenium/grid/node/relay/RelayFlags.java b/java/src/org/openqa/selenium/grid/node/relay/RelayFlags.java
@@ -26,37 +26,57 @@
 
 import org.openqa.selenium.grid.config.ConfigValue;
 import org.openqa.selenium.grid.config.HasRoles;
+import org.openqa.selenium.grid.config.NonSplittingSplitter;
 import org.openqa.selenium.grid.config.Role;
 
 import java.util.Collections;
+import java.util.List;
 import java.util.Set;
 
 @SuppressWarnings("unused")
 @AutoService(HasRoles.class)
 public class RelayFlags implements HasRoles {
 
+  @Parameter(
+    names = {"--service-configuration"},
+    description = "Configuration for the service where calls will be relayed to. " +
+                  "It is recommended to provide this type of configuration through a toml config " +
+                  "file to improve readability. Command line example: " +
+                  "--service-configuration max-sessions=2 " +
+                  "stereotype='{\"browserName\": \"safari\", \"platformName\": \"iOS\", " +
+                  "\"appium:platformVersion\": \"14.5\"}}'",
+    arity = 4,
+    variableArity = true,
+    splitter = NonSplittingSplitter.class)
+  @ConfigValue(
+    section = RELAY_SECTION,
+    name = "configs",
+    prefixed = true,
+    example = "\n" +
+              "max-sessions = 2\n" +
+              "stereotype = \"{\"browserName\": \"safari\", \"platformName\": \"iOS\", " +
+              "\"appium:platformVersion\": \"14.5\" }}\"")
+  public List<String> driverConfiguration;
+
   @Parameter(
     names = {"--service-url"},
     description = "URL for connecting to the service that supports WebDriver commands, "
                   + "like an Appium server or a cloud service."
   )
   @ConfigValue(section = RELAY_SECTION, name = "url", example = "http://localhost:4723")
   private String serviceUrl;
-
   @Parameter(
     names = {"--service-host"},
     description = "Host name where the service that supports WebDriver commands is running"
   )
   @ConfigValue(section = RELAY_SECTION, name = "host", example = "\"localhost\"")
   private String serviceHost;
-
   @Parameter(
     names = {"--service-port"},
     description = "Port where the service that supports WebDriver commands is running"
   )
   @ConfigValue(section = RELAY_SECTION, name = "port", example = "4723")
   private Integer servicePort;
-
   @Parameter(
     names = {"--service-status-endpoint"},
     description = "Endpoint to query the WebDriver service status, an HTTP 200 response "
diff --git a/java/src/org/openqa/selenium/grid/node/relay/RelayOptions.java b/java/src/org/openqa/selenium/grid/node/relay/RelayOptions.java
@@ -124,15 +124,17 @@ public Map<Capabilities, Collection<SessionFactory>> getSessionFactories(
     for (int i = 0; i < allConfigs.size(); i++) {
       int maxSessions;
       try {
-        maxSessions = Integer.parseInt(allConfigs.get(i));
+        maxSessions = Integer.parseInt(extractConfiguredValue(allConfigs.get(i)));
       } catch (NumberFormatException e) {
         throw new ConfigException("Unable parse value as number. " + allConfigs.get(i));
       }
       i++;
       if (i == allConfigs.size()) {
         throw new ConfigException("Unable to find stereotype config. " + allConfigs);
       }
-      Capabilities stereotype = JSON.toType(allConfigs.get(i), Capabilities.class);
+      Capabilities stereotype = JSON.toType(
+        extractConfiguredValue(allConfigs.get(i)),
+        Capabilities.class);
       parsedConfigs.put(maxSessions, stereotype);
     }
 
@@ -153,4 +155,11 @@ public Map<Capabilities, Collection<SessionFactory>> getSessionFactories(
     return factories.build().asMap();
   }
 
+  private String extractConfiguredValue(String keyValue) {
+    if (keyValue.contains("=")) {
+      return keyValue.substring(keyValue.indexOf("=") + 1);
+    }
+    return keyValue;
+  }
+
 }

Original file line number	Diff line number	Diff line change
`@@ -124,15 +124,17 @@ public Map<Capabilities, Collection<SessionFactory>> getSessionFactories(`
`124`	`124`	`for (int i = 0; i < allConfigs.size(); i++) {`
`125`	`125`	`int maxSessions;`
`126`	`126`	`try {`
`127`		`- maxSessions = Integer.parseInt(allConfigs.get(i));`
	`127`	`+ maxSessions = Integer.parseInt(extractConfiguredValue(allConfigs.get(i)));`
`128`	`128`	`} catch (NumberFormatException e) {`
`129`	`129`	`throw new ConfigException("Unable parse value as number. " + allConfigs.get(i));`
`130`	`130`	`}`
`131`	`131`	`i++;`
`132`	`132`	`if (i == allConfigs.size()) {`
`133`	`133`	`throw new ConfigException("Unable to find stereotype config. " + allConfigs);`
`134`	`134`	`}`
`135`		`- Capabilities stereotype = JSON.toType(allConfigs.get(i), Capabilities.class);`
	`135`	`+ Capabilities stereotype = JSON.toType(`
	`136`	`+ extractConfiguredValue(allConfigs.get(i)),`
	`137`	`+ Capabilities.class);`
`136`	`138`	`parsedConfigs.put(maxSessions, stereotype);`
`137`	`139`	`}`
`138`	`140`
`@@ -153,4 +155,11 @@ public Map<Capabilities, Collection<SessionFactory>> getSessionFactories(`
`153`	`155`	`return factories.build().asMap();`
`154`	`156`	`}`
`155`	`157`
	`158`	`+ private String extractConfiguredValue(String keyValue) {`
	`159`	`+ if (keyValue.contains("=")) {`
	`160`	`+ return keyValue.substring(keyValue.indexOf("=") + 1);`
	`161`	`+ }`
	`162`	`+ return keyValue;`
	`163`	`+ }`
	`164`	`+`
`156`	`165`	`}`