[java] Allow the SafariDriver Technology Preview to be used.

Author: shs96c

java/client/src/org/openqa/selenium/safari/SafariDriver.java

@@ -18,17 +18,13 @@
 package org.openqa.selenium.safari;
 
 import org.openqa.selenium.Capabilities;
-import org.openqa.selenium.OutputType;
 import org.openqa.selenium.WebDriverException;
 import org.openqa.selenium.remote.CommandExecutor;
 import org.openqa.selenium.remote.DesiredCapabilities;
-import org.openqa.selenium.remote.DriverCommand;
 import org.openqa.selenium.remote.FileDetector;
 import org.openqa.selenium.remote.RemoteWebDriver;
 import org.openqa.selenium.remote.service.DriverCommandExecutor;
 
-import java.io.IOException;
-
 /**
  * A WebDriver implementation that controls Safari using a browser extension
  * (consequently, only Safari 5.1+ is supported).

java/client/src/org/openqa/selenium/safari/SafariDriverService.java

@@ -29,20 +29,23 @@
 import java.io.File;
 import java.io.IOException;
 import java.net.MalformedURLException;
-import java.util.concurrent.ExecutionException;
 
 public class SafariDriverService extends DriverService {
 
   private static final File SAFARI_DRIVER_EXECUTABLE = new File("/usr/bin/safaridriver");
+  private static final File TP_SAFARI_DRIVER_EXECUTABLE =
+    new File("/Applications/Safari Technology Preview.app/Contents/MacOS/safaridriver");
 
   public SafariDriverService(File executable, int port, ImmutableList<String> args,
                              ImmutableMap<String, String> environment) throws IOException {
     super(executable, port, args, environment);
   }
 
   public static SafariDriverService createDefaultService(SafariOptions options) {
-    if (SAFARI_DRIVER_EXECUTABLE.exists()) {
-      return new Builder().usingPort(options.getPort()).build();
+    File exe = options.getUseTechnologyPreview() ?
+               TP_SAFARI_DRIVER_EXECUTABLE : SAFARI_DRIVER_EXECUTABLE;
+    if (exe.exists()) {
+      return new Builder().usingPort(options.getPort()).usingDriverExecutable(exe).build();
     }
     return null;
   }
@@ -59,6 +62,15 @@ protected void waitUntilAvailable() throws MalformedURLException {
   public static class Builder extends DriverService.Builder<
     SafariDriverService, SafariDriverService.Builder> {
 
+    public SafariDriverService.Builder usingTechnologyPreview(boolean useTechnologyPreview) {
+      if (useTechnologyPreview) {
+        usingDriverExecutable(TP_SAFARI_DRIVER_EXECUTABLE);
+      } else {
+        usingDriverExecutable(SAFARI_DRIVER_EXECUTABLE);
+      }
+      return this;
+    }
+
     protected File findDefaultExecutable() {
       return SAFARI_DRIVER_EXECUTABLE;
     }

java/client/src/org/openqa/selenium/safari/SafariOptions.java

@@ -56,6 +56,7 @@ private static class Option {
     private Option() {}  // Utility class.
 
     private static final String CLEAN_SESSION = "cleanSession";
+    private static final String TECHNOLOGY_PREVIEW = "technologyPreview";
     private static final String PORT = "port";
   }
 
@@ -69,6 +70,11 @@ private Option() {}  // Utility class.
    */
   private boolean useCleanSession = false;
 
+  /**
+   * @see #setUseTechnologyPreview(boolean)
+   */
+  private boolean useTechnologyPreview = false;
+
   /**
    * Construct a {@link SafariOptions} instance from given capabilites.
    * When the {@link #CAPABILITY} capability is set, all other capabilities will be ignored!
@@ -120,6 +126,17 @@ public void setUseCleanSession(boolean useCleanSession) {
     this.useCleanSession = useCleanSession;
   }
 
+  /**
+   * Instruct the SafariDriver to use the Safari Technology Preview if true, otherwise use the
+   * release version of Safari. Defaults to using the release version of Safari.
+   *
+   * @param useTechnologyPreview If true, the SafariDriver will use the Safari Technology Preview,
+   *     otherwise will use the release version of Safari.
+   */
+  public void setUseTechnologyPreview(boolean useTechnologyPreview) {
+    this.useTechnologyPreview = useTechnologyPreview;
+  }
+
   // Getters
 
   /**
@@ -139,6 +156,10 @@ public boolean getUseCleanSession() {
     return useCleanSession;
   }
 
+  public boolean getUseTechnologyPreview() {
+    return useTechnologyPreview;
+  }
+
   // (De)serialization of the options
 
   /**
@@ -151,6 +172,7 @@ public JsonObject toJson() throws IOException {
     JsonObject options = new JsonObject();
     options.addProperty(Option.PORT, port);
     options.addProperty(Option.CLEAN_SESSION, useCleanSession);
+    options.addProperty(Option.TECHNOLOGY_PREVIEW, useTechnologyPreview);
     return options;
   }
 
@@ -175,6 +197,12 @@ private static SafariOptions fromJsonMap(Map<?, ?> options) throws IOException {
     if (useCleanSession != null) {
       safariOptions.setUseCleanSession(useCleanSession);
     }
+
+    Boolean useTechnologyPreview = (Boolean) options.get(Option.TECHNOLOGY_PREVIEW);
+    if (useTechnologyPreview != null) {
+      safariOptions.setUseTechnologyPreview(useTechnologyPreview);
+    }
+
     return safariOptions;
   }
 
@@ -198,11 +226,12 @@ public boolean equals(Object other) {
     }
     SafariOptions that = (SafariOptions) other;
     return this.port == that.port
-        && this.useCleanSession == that.useCleanSession;
+        && this.useCleanSession == that.useCleanSession
+        && this.useTechnologyPreview == that.useTechnologyPreview;
   }
 
   @Override
   public int hashCode() {
-    return Objects.hashCode(this.port, this.useCleanSession);
+    return Objects.hashCode(this.port, this.useCleanSession, this.useTechnologyPreview);
   }
 }

java/client/test/org/openqa/selenium/safari/SafariDriverTests.java

@@ -33,6 +33,7 @@
     AlertsTest.class,
     CleanSessionTest.class,
     CrossDomainTest.class,
+    TechnologyPreviewTest.class,
     WebSocketConnectionTest.class
 })
 public class SafariDriverTests {

java/client/test/org/openqa/selenium/safari/TechnologyPreviewTest.java

@@ -0,0 +1,36 @@
+package org.openqa.selenium.safari;
+
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assume.assumeTrue;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.openqa.selenium.WebDriver;
+import org.openqa.selenium.testing.JUnit4TestBase;
+
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+
+public class TechnologyPreviewTest extends JUnit4TestBase {
+
+  @Before
+  public void checkTechnologyPreviewInstalled() {
+    Path driverShim =
+      Paths.get("/Applications/Safari Technology Preview.app/Contents/MacOS/safaridriver");
+    assumeTrue("Technology Preview not installed", Files.exists(driverShim));
+  }
+
+  @Test
+  public void canStartTechnologyPreview() {
+    SafariOptions options = new SafariOptions();
+    options.setUseTechnologyPreview(true);
+
+    WebDriver driver = new SafariDriver(options);
+
+    driver.get(pages.xhtmlTestPage);
+    assertEquals("XHTML Test Page", driver.getTitle());
+  }
+
+}