Attempt better backwards compatability with the old html suite runner command line flags

The 2.x `htmlSuite` option was one of many passed to the
standalone server. With this change, we handle lots of the
original flags that could be used.

Author: shs96c

java/server/src/org/openqa/selenium/server/htmlrunner/BUCK

@@ -21,6 +21,7 @@ java_library(
     '//java/client/src/org/openqa/selenium/remote:remote',
     '//java/client/src/org/openqa/selenium/safari:safari',
     '//third_party/java/guava:guava',
+    '//third_party/java/beust:jcommander',
     '//third_party/java/jetty:jetty',
   ],
   visibility = [

java/server/src/org/openqa/selenium/server/htmlrunner/HTMLLauncher.java

@@ -19,6 +19,8 @@
 
 import static org.openqa.selenium.firefox.FirefoxDriver.MARIONETTE;
 
+import com.beust.jcommander.JCommander;
+import com.beust.jcommander.Parameter;
 import com.thoughtworks.selenium.Selenium;
 import com.thoughtworks.selenium.webdriven.WebDriverBackedSelenium;
 
@@ -52,6 +54,7 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.util.ArrayList;
 import java.util.List;
 import java.util.logging.Level;
 import java.util.logging.Logger;
@@ -76,31 +79,16 @@ public class HTMLLauncher {
    * @param suiteURL - the relative URL to the HTML suite
    * @param outputFile - The file to which we'll output the HTML results
    * @param timeoutInSeconds - the amount of time (in seconds) to wait for the browser to finish
-   * @param multiWindow TODO
    * @return PASS or FAIL
    * @throws IOException if we can't write the output file
    */
-  public String runHTMLSuite(String browser, String browserURL, String suiteURL, File outputFile,
-      long timeoutInSeconds, boolean multiWindow) throws IOException {
-    return runHTMLSuite(browser, browserURL, suiteURL, outputFile,
-        timeoutInSeconds, multiWindow, "info");
-  }
-
-  /**
-   * Launches a single HTML Selenium test suite.
-   *
-   * @param browser - the browserString ("*firefox", "*iexplore" or an executable path)
-   * @param browserURL - the start URL for the browser
-   * @param suiteURL - the relative URL to the HTML suite
-   * @param outputFile - The file to which we'll output the HTML results
-   * @param multiWindow TODO
-   * @param defaultLogLevel TODO
-   * @param timeoutInSeconds - the amount of time (in seconds) to wait for the browser to finish
-   * @return PASS or FAIL
-   * @throws IOException if we can't write the output file
-   */
-  private String runHTMLSuite(String browser, String browserURL, String suiteURL, File outputFile,
-      long timeoutInSeconds, boolean multiWindow, String defaultLogLevel) throws IOException {
+  public String runHTMLSuite(
+    String browser,
+    String browserURL,
+    String suiteURL,
+    File outputFile,
+    long timeoutInSeconds,
+    String userExtensions) throws IOException {
     File parent = outputFile.getParentFile();
     if (parent != null && !parent.exists()) {
       parent.mkdirs();
@@ -121,6 +109,10 @@ private String runHTMLSuite(String browser, String browserURL, String suiteURL,
 
       driver.get(suiteUrl.toString());
       Selenium selenium = new WebDriverBackedSelenium(driver, browserURL);
+      selenium.setTimeout(String.valueOf(timeoutInMs));
+      if (userExtensions != null) {
+        selenium.setExtensionJs(userExtensions);
+      }
       List<WebElement> allTables = driver.findElements(By.id("suiteTable"));
       if (allTables.isEmpty()) {
         throw new RuntimeException("Unable to find suite table: " + driver.getPageSource());
@@ -211,31 +203,46 @@ private URL verifySuiteUrl(URL url) throws IOException {
  }
 
   public static int mainInt(String... args) throws Exception {
-    if (args.length != 4) {
-      throw new IllegalAccessException(
-          "Usage: HTMLLauncher outputDir testSuite startUrl browser");
+    Args processed = new Args();
+    JCommander jCommander = new JCommander(processed);
+    jCommander.setCaseSensitiveOptions(false);
+    jCommander.parse(args);
+
+    if (processed.help) {
+      StringBuilder help = new StringBuilder();
+      jCommander.usage(help);
+      System.err.print(help);
+      return 0;
     }
 
-    File dir = new File(args[0]);
-    if (!dir.exists() && !dir.mkdirs()) {
-      throw new RuntimeException("Cannot create output directory for: " + dir);
+    if (!validateArgs(processed)) {
+      return -1;
     }
 
-    String suite = args[1];
-    String startURL = args[2];
-    String[] browsers;
-    browsers = new String[] {args[3]};
+    Path resultsPath = Paths.get(processed.htmlSuite.get(3));
+    Files.createDirectories(resultsPath);
+
+    String suite = processed.htmlSuite.get(2);
+    String startURL = processed.htmlSuite.get(1);
+    String[] browsers = new String[] {processed.htmlSuite.get(0)};
 
     HTMLLauncher launcher = new HTMLLauncher();
 
     boolean passed = true;
     for (String browser : browsers) {
       // Turns out that Windows doesn't like "*" in a path name
-      File results = new File(dir, browser.substring(1) + ".results");
+      File results = resultsPath.resolve(browser.substring(1) + ".results").toFile();
       String result = "FAILED";
 
       try {
-        result = launcher.runHTMLSuite(browser, startURL, suite, results, 600, true);
+        long timeout;
+        try {
+          timeout = Long.parseLong(processed.timeout);
+        } catch (NumberFormatException e) {
+          System.err.println("Timeout does not appear to be a number: " + processed.timeout);
+          return -2;
+        }
+        result = launcher.runHTMLSuite(browser, startURL, suite, results, timeout, processed.userExtensions);
         passed &= "PASSED".equals(result);
       } catch (Throwable e) {
         log.log(Level.WARNING, "Test of browser failed: " + browser, e);
@@ -246,6 +253,22 @@ public static int mainInt(String... args) throws Exception {
     return passed ? 1 : 0;
   }
 
+  private static boolean validateArgs(Args processed) {
+    if (processed.multiWindow) {
+      System.err.println("Multi-window mode is longer used as an option and will be ignored.");
+    }
+
+    if (processed.port != 0) {
+      System.err.println("Port is longer used as an option and will be ignored.");
+    }
+
+    if (processed.trustAllSSLCertificates) {
+      System.err.println("Trusting all ssl certificates is no longer a user-settable option.");
+    }
+
+    return true;
+  }
+
   public static void main(String[] args) throws Exception {
     System.exit(mainInt(args));
   }
@@ -285,4 +308,45 @@ private WebDriver createDriver(String browser) {
         throw new RuntimeException("Unrecognized browser: " + browser);
     }
   }
+
+  public static class Args {
+    @Parameter(
+      names = "-htmlSuite",
+      required = true,
+      arity = 4,
+      description = "Run an HTML Suite: '*browser' 'http://baseUrl.com' 'path\\to\\HTMLSuite.html' 'c:\\absolute\\path\\to\\my\\results.html'")
+    private List<String> htmlSuite;
+
+    @Parameter(
+      names = "-timeout",
+      description = "Timeout to use in seconds")
+    private String timeout = "30";
+
+    @Parameter(
+      names = "-userExtensions",
+      description = "User extensions to attempt to use."
+    )
+    private String userExtensions;
+
+    @Parameter(
+      names = "-multiwindow",
+      hidden = true)
+    private boolean multiWindow = true;
+
+    @Parameter(
+      names = "-port",
+      hidden = true)
+    private Integer port;
+
+    @Parameter(
+      names = "-trustAllSSLCertificates",
+      hidden = true)
+    private boolean trustAllSSLCertificates;
+
+    @Parameter(
+      names = {"-help", "--help", "-h"},
+      description = "This help message",
+      help = true)
+    private boolean help;
+  }
 }

java/server/test/org/openqa/selenium/server/htmlrunner/CoreSelfTest.java

@@ -79,8 +79,8 @@ public void executeTests() throws IOException {
         testBase + "/TestSuite.html",
         testBase + "/TestSuite.html",
         outputFile.toFile(),
-        TimeUnit.MINUTES.toMillis(5),
-        true);
+        TimeUnit.MINUTES.toSeconds(5),
+        null);
 
     assertEquals("PASSED", result);
   }

third_party/java/beust/BUCK

@@ -7,6 +7,7 @@ prebuilt_jar(
     '//java/server/src/org/openqa/grid:grid',
     '//java/server/src/org/openqa/grid/selenium:classes',
     '//java/server/src/org/openqa/selenium/remote/server:standalone-server-lib',
+    '//java/server/src/org/openqa/selenium/server/htmlrunner:htmlrunner',
     '//java/server/test/...',
     '//third_party/java/testng:testng'
   ],