server: Separating help messages for various server roles

Author: barancev

Diff for: java/server/src/org/openqa/grid/common/GridDocHelper.java

@@ -25,31 +25,54 @@
 
 
 public class GridDocHelper {
-  private static Properties gridProperties = load("org/openqa/grid/common/defaults/GridParameters.properties");
+  private static Properties hubProperties = load(
+    "org/openqa/grid/common/defaults/HubParameters.properties");
+  private static Properties nodeProperties = load(
+    "org/openqa/grid/common/defaults/NodeParameters.properties");
 
-  public static void printHelp(String msg) {
-    printHelpInConsole(msg, true);
+  public static void printHubHelp(String msg) {
+    printHubHelp(msg, true);
   }
 
-  public static void printHelp(String msg, boolean error) {
-    printHelpInConsole(msg, error);
+  public static void printHubHelp(String msg, boolean error) {
+    printHelpInConsole(msg, hubProperties, error);
+    RemoteControlLauncher.printWrappedLine(
+      "",
+      "This synopsis lists options available in hub role only. To get help on the command line options available for other roles run the server with both -role and -help options.");
   }
 
+  public static void printNodeHelp(String msg) {
+    printNodeHelp(msg, true);
+  }
+
+  public static void printNodeHelp(String msg, boolean error) {
+    printHelpInConsole(msg, nodeProperties, error);
+    RemoteControlLauncher.printWrappedLine(
+      "",
+      "This synopsis lists options available in node role only. To get help on the command line options available for other roles run the server with both -role and -help options.");
+  }
 
-  public static String getGridParam(String param) {
+  private static String getParam(Properties properties, String param) {
     if (param == null) {
       return "";
     }
-    String s = (String) gridProperties.get(param);
+    String s = (String) properties.get(param);
     if (s == null) {
       return "No help specified for " + param;
     } else {
       return s;
     }
   }
 
+  public static String getHubParam(String param) {
+    return getParam(hubProperties, param);
+  }
+
+  public static String getNodeParam(String param) {
+    return getParam(nodeProperties, param);
+  }
 
-  private static void printHelpInConsole(String msg, boolean error) {
+  private static void printHelpInConsole(String msg, Properties properties, boolean error) {
     String indent = "  ";
     String indent2x = indent + indent;
     if (msg != null) {
@@ -61,9 +84,9 @@ private static void printHelpInConsole(String msg, boolean error) {
     }
 
     System.out.println("Usage :");
-    for (Object key : gridProperties.keySet()) {
-      System.out.println(indent + "-" + key + ":\t");
-      RemoteControlLauncher.printWrappedLine(System.out, indent2x, getGridParam(key.toString()), true);
+    for (Object key : properties.keySet()) {
+      System.out.println(indent + "-" + key + ":");
+      RemoteControlLauncher.printWrappedLine(System.out, indent2x, getParam(properties, key.toString()), true);
       System.out.println("");
     }
   }
@@ -82,6 +105,4 @@ private static Properties load(String resource) {
       throw new RuntimeException(resource + " cannot be loaded.");
     }
   }
-
-
 }

Diff for: java/server/src/org/openqa/grid/common/defaults/GridParameters.properties

@@ -0,0 +1,13 @@
+host = <IP | hostname> : usually not needed and determined automatically. For exotic network configuration, network with VPN, specifying the host might be necessary.
+port = <xxxx> : the port the remote/hub will listen on. Default to 4444.
+
+throwOnCapabilityNotPresent = <true | false> default to true. If true, the hub will reject test requests right away if no proxy is currently registered that can host that capability.Set it to false to have the request queued until a node supporting the capability is added to the grid.
+newSessionWaitTimeout = <XXXX>. Default to no timeout ( -1 ) the time in ms after which a new test waiting for a node to become available will time out.When that happens, the test will throw an exception before starting a browser.
+
+capabilityMatcher = a class implementing the CapabilityMatcher interface. Defaults to org.openqa.grid.internal.utils.DefaultCapabilityMatcher. Specify the logic the hub will follow to define if a request can be assigned to a node.Change this class if you want to have the matching process use regular expression instead of exact match for the version of the browser for instance. All the nodes of a grid instance will use the same matcher, defined by the registry.
+prioritizer = a class implementing the Prioritizer interface. Default to null ( no priority = FIFO ).Specify a custom prioritizer if you need the grid to process the tests from the CI, or the IE tests first for instance.
+servlets = <com.mycompany.MyServlet,com.mycompany.MyServlet2> to register a new servlet on the hub/node. The servlet will accessible under the path  /grid/admin/MyServlet /grid/admin/MyServlet2
+
+grid1Yml = a YML file following grid1 format.
+hubConfig = a JSON file following grid2 format that defines the hub properties.
+browserTimeout = The timeout in seconds a browser can hang

Diff for: java/server/src/org/openqa/grid/common/defaults/HubParameters.properties

@@ -0,0 +1,18 @@
+host = <IP | hostname> : usually not needed and determined automatically. For exotic network configuration, network with VPN, specifying the host might be necessary.
+port = <xxxx> : the port the remote/hub will listen on. Default to 4444.
+
+cleanupCycle = <XXXX> in ms. How often a proxy will check for timed out thread.
+timeout = <XXXX>  the timeout in seconds before the hub automatically ends a test that hasn't had any activity in the last X seconds. The browser will be released for another test to use. This typically takes care of the client crashes.
+browserTimeout= The timeout in seconds a browser can hang
+
+hub = <http://localhost:4444/grid/register> : the url that will be used to post the registration request. This option takes precedence over -hubHost and -hubPort options.
+hubHost = <IP | hostname> : the host address of a hub the registration request should be sent to. Default to localhost. Option -hub takes precedence over this option.
+hubPort = <xxxx> : the port listened by a hub the registration request should be sent to. Default to 4444. Option -hub takes precedence over this option.
+proxy = the class that will be used to represent the node. By default org.openqa.grid.selenium.proxy.DefaultRemoteProxy.
+maxSession = max number of tests that can run at the same time on the node, independently of the browser used.
+
+registerCycle = how often in ms the node will try to register itself again.Allow to restart the hub without having to restart the nodes.
+nodePolling = in ms. Interval between alive checks of node how often the hub checks if the node is still alive.
+unregisterIfStillDownAfter = in ms. If the node remains down for more than unregisterIfStillDownAfter millisec, it will disappear from the hub.Default is 1min.
+downPollingLimit = node is marked as down after downPollingLimit alive checks.
+nodeStatusCheckTimeout = in ms. Connection and socket timeout which is used for node alive check.

Diff for: java/server/src/org/openqa/grid/common/defaults/NodeParameters.properties

@@ -57,15 +57,25 @@ public static void main(String[] args) throws Exception {
         "    node        as a node of a Selenium grid\n" +
         "    standalone  as a standalone server not being a part of a grid\n" +
         "\n" +
-        "If -role option is not specified the server runs standalone" +
+        "If -role option is not specified the server runs standalone\n" +
         "\n");
+      RemoteControlLauncher.printWrappedLine("",
+        "To get help on the command line options available for each role run the server with both -role and -help options");
       return;
     }
 
     if (helper.isParamPresent("-help") || helper.isParamPresent("-h")){
-      String separator = "\n----------------------------------\n";
-      RemoteControlLauncher.usage(separator+"To use as a standalone server"+separator);
-      GridDocHelper.printHelp(separator+"To use in a grid environment :"+separator,false);
+      String separator = "\n-----------------------------------------\n";
+      if (role == GridRole.NOT_GRID) {
+        RemoteControlLauncher.usage(separator+"To use as a standalone server"+separator);
+      } else if (role == GridRole.HUB) {
+        GridDocHelper.printHubHelp(
+          separator + "To use in a grid environment as the hub:" + separator, false);
+      } else if (role == GridRole.NODE) {
+        GridDocHelper.printNodeHelp(separator + "To use in a grid environment as a node:" + separator, false);
+      } else {
+        GridDocHelper.printHubHelp(separator + "To use in a grid environment :" + separator, false);
+      }
       return;
     }
 
@@ -86,7 +96,7 @@ public static void main(String[] args) throws Exception {
           log.info("Nodes should register to " + h.getRegistrationURL());
           log.info("Selenium Grid hub is up and running");
         } catch (GridConfigurationException e) {
-          GridDocHelper.printHelp(e.getMessage());
+          GridDocHelper.printHubHelp(e.getMessage());
           e.printStackTrace();
         }
         break;
@@ -99,7 +109,7 @@ public static void main(String[] args) throws Exception {
           log.info("Selenium Grid node is up and ready to register to the hub");
           remote.startRegistrationProcess();
         } catch (GridConfigurationException e) {
-          GridDocHelper.printHelp(e.getMessage());
+          GridDocHelper.printNodeHelp(e.getMessage());
           e.printStackTrace();
         }
         break;

Diff for: java/server/src/org/openqa/grid/selenium/GridLauncher.java

@@ -200,7 +200,7 @@ private String getConfigInfo(boolean verbose) {
   }
 
   private String key(String key) {
-    return "<abbr title='" + GridDocHelper.getGridParam(key) + "'>" + key + " : </abbr>";
+    return "<abbr title='" + GridDocHelper.getHubParam(key) + "'>" + key + " : </abbr>";
   }
 
   private String prettyHtmlPrint(GridHubConfiguration config) {

Diff for: java/server/src/org/openqa/grid/web/servlet/ConsoleServlet.java

@@ -266,7 +266,7 @@ private String getConfigInfo(boolean verbose) {
   }
 
   private String key(String key) {
-    return "<abbr title='" + GridDocHelper.getGridParam(key) + "'>" + key + " : </abbr>";
+    return "<abbr title='" + GridDocHelper.getHubParam(key) + "'>" + key + " : </abbr>";
   }
 
   private String prettyHtmlPrint(GridHubConfiguration config) {

Diff for: java/server/src/org/openqa/grid/web/servlet/beta/ConsoleServlet.java

@@ -107,6 +107,9 @@ public static void usage(String msg) {
             "number of times.  A simple example of how this could be useful: if you add \"-userContentTransformation https http\" "
             +
             "then all \"https\" strings in the HTML of the test application will be changed to be \"http\".");
+    printWrappedLine(
+      "",
+      "\nThis synopsis lists options available in standalone role only. To get help on the command line options available for other roles run the server with both -role and -help options.");
   }
 
   public static RemoteControlConfiguration parseLauncherOptions(String[] args) {