server: Adding a help message for the case when -role option is not specified

Author: barancev

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

@@ -45,6 +45,29 @@ public boolean isParamPresent(String name) {
     return false;
   }
 
+  public boolean hasParamValue(String name) {
+    int index = -1;
+    for (int i = 0; i < args.length; i++) {
+      if (name.equals(args[i])) {
+        index = i;
+        break;
+      }
+    }
+    if (index == -1) {
+      throw new GridConfigurationException("The parameter " + name + " isn't specified.");
+    }
+
+    if (args.length == index) {
+      return false;
+    }
+
+    if (((index + 1) < args.length) && !args[index + 1].startsWith("-")) {
+      return true;
+    } else {
+      return false;
+    }
+  }
+
   public String getParamValue(String name) {
     int index = -1;
     for (int i = 0; i < args.length; i++) {

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

@@ -38,7 +38,7 @@ 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.");
+      "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 -help option and the corresponding -role option value.");
   }
 
   public static void printNodeHelp(String msg) {
@@ -49,7 +49,7 @@ 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.");
+      "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 -help option and the corresponding -role option value.");
   }
 
   private static String getParam(Properties properties, String param) {

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

@@ -56,8 +56,7 @@ public static GridRole find(String[] args) {
     for (int i = 0; i < args.length; i++) {
       if ("-role".equals(args[i])) {
         if (i == args.length - 1) {
-          throw new GridConfigurationException(
-              "-role needs to be followed by the role of this component in the grid.");
+          return null;
         } else {
           String role = args[i + 1].toLowerCase();
           if (nodeAliases.contains(role)) {

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

@@ -43,39 +43,16 @@ public class GridLauncher {
   private static final Logger log = Logger.getLogger(GridLauncher.class.getName());
 
   public static void main(String[] args) throws Exception {
-
     CommandLineOptionHelper helper = new CommandLineOptionHelper(args);
     GridRole role = GridRole.find(args);
 
     if (role == null) {
-      System.out.println(
-        "\n" +
-        "The role '" + helper.getParamValue("-role") + "' does not match a recognized role for Selenium server\n" +
-        "\n" +
-        "Selenium server can run in one of the following roles:\n" +
-        "    hub         as a hub of a Selenium grid\n" +
-        "    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\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");
+      printInfoAboutRoles(helper);
       return;
     }
 
-    if (helper.isParamPresent("-help") || helper.isParamPresent("-h")){
-      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);
-      }
+    if (helper.isParamPresent("-help") || helper.isParamPresent("-h")) {
+      printInfoAboutOptionsForRole(role);
       return;
     }
 
@@ -114,7 +91,47 @@ public static void main(String[] args) throws Exception {
         }
         break;
       default:
-        throw new RuntimeException("NI");
+        throw new GridConfigurationException("Unknown role: " + role);
+    }
+  }
+
+  private static void printInfoAboutRoles(CommandLineOptionHelper helper) {
+    if (helper.hasParamValue("-role")) {
+      RemoteControlLauncher.printWrappedLine(
+        "",
+        "Error: the role '" + helper.getParamValue("-role") + "' does not match a recognized server role\n");
+    } else {
+      RemoteControlLauncher.printWrappedLine(
+        "",
+        "Error: -role option needs to be followed by the value that defines role of this component in the grid\n");
+    }
+    System.out.println(
+      "Selenium server can run in one of the following roles:\n" +
+      "  hub         as a hub of a Selenium grid\n" +
+      "  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 omitted the server runs standalone\n");
+    RemoteControlLauncher.printWrappedLine(
+      "",
+      "To get help on the options available for a specific role run the server"
+      + " with -help option and the corresponding -role option value");
+  }
+
+  private static void printInfoAboutOptionsForRole(GridRole role) {
+    String separator = "\n-------------------------------\n";
+    switch (role) {
+      case NOT_GRID:
+        RemoteControlLauncher.usage(separator + "Running as a standalone server:" + separator);
+        break;
+      case HUB:
+        GridDocHelper.printHubHelp(separator + "Running as a grid hub:" + separator, false);
+        break;
+      case NODE:
+        GridDocHelper.printNodeHelp(separator + "Running as a grid node:" + separator, false);
+        break;
+      default:
+        throw new GridConfigurationException("Unknown role: " + role);
     }
   }
 

Diff for: java/server/src/org/openqa/selenium/server/cli/RemoteControlLauncher.java

@@ -31,7 +31,7 @@ public class RemoteControlLauncher {
 
   public static void usage(String msg) {
     if (msg != null) {
-      System.out.println(msg + ":");
+      System.out.println(msg);
     }
     String INDENT = "  ";
     String INDENT2X = INDENT + INDENT;
@@ -109,7 +109,7 @@ public static void usage(String msg) {
             "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.");
+      "\nThis synopsis lists options available in standalone role only. To get help on the options available for other roles run the server with -help option and the corresponding -role option value.");
   }
 
   public static RemoteControlConfiguration parseLauncherOptions(String[] args) {