Add new WebDriver support for Edge - JAVA

README.md

@@ -184,12 +184,15 @@ really be able to run the tests too.  Try:
 ./go test_firefox
 ./go test_htmlunit
 ./go test_ie
+./go test_edge
 ```
 
 Note that the `test_chrome` target requires that you have the separate
 [Chrome Driver](https://github.com/SeleniumHQ/selenium/wiki/ChromeDriver)
 binary available on your `PATH`.
 
+`test_edge` target requires that you have separated [Edge Driver](https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver) binary available on your `PATH`.
+
 If you are interested in a single language binding, try one of:
 
 ```sh

Rakefile

@@ -114,6 +114,7 @@ JAVA_RELEASE_TARGETS = [
   '//java/client/src/org/openqa/selenium/support:support',
   '//java/client/src/org/openqa/selenium/chrome:chrome',
   '//java/client/src/org/openqa/selenium/edge:edge',
+  '//java/client/src/org/openqa/selenium/edge/edgehtml:edgehtml',
   '//java/client/src/org/openqa/selenium/firefox:firefox',
   '//java/client/src/org/openqa/selenium/firefox/xpi:firefox-xpi',
   '//java/client/src/org/openqa/selenium/ie:ie',
@@ -145,6 +146,7 @@ task :tests => [
   "//java/client/test/org/openqa/selenium/firefox:test-synthesized",
   "//java/client/test/org/openqa/selenium/ie:ie",
   "//java/client/test/org/openqa/selenium/chrome:chrome",
+  "//java/client/test/org/openqa/selenium/edge:edge",
   "//java/client/test/org/openqa/selenium/opera:opera",
   "//java/client/test/org/openqa/selenium/support:small-tests",
   "//java/client/test/org/openqa/selenium/support:large-tests",
@@ -178,6 +180,7 @@ task :test_javascript => [
   '//javascript/selenium-atoms:selenium-atoms-chrome:run',
   '//javascript/selenium-core:selenium-core-chrome:run']
 task :test_chrome => [ "//java/client/test/org/openqa/selenium/chrome:chrome:run" ]
+task :test_edge => [ "//java/client/test/org/openqa/selenium/edge:edge:run" ]
 task :test_chrome_atoms => [
   '//javascript/atoms:test_chrome:run',
   '//javascript/chrome-driver:test:run',
@@ -237,6 +240,9 @@ end
 if (present?("chromedriver"))
   task :test_java_webdriver => [:test_chrome]
 end
+if (present?("msedgedriver"))
+  task :test_java_webdriver => [:test_edge]
+end
 if (opera?)
   task :test_java_webdriver => [:test_opera]
 end

java/client/src/com/thoughtworks/selenium/BUCK

@@ -31,7 +31,7 @@ java_library(
         ":api",
     ],
     deps = [
-        "//java/client/src/org/openqa/selenium/edge:edge",
+        "//java/client/src/org/openqa/selenium/edge/edgehtml:edgehtml",
         "//third_party/java/guava:guava",
         "//third_party/java/junit:junit",
         "//third_party/java/testng:testng",

java/client/src/org/openqa/selenium/BUCK

@@ -56,7 +56,7 @@ java_library(
         "//java/client/src/org/openqa/selenium/chrome:chrome",
         "//java/client/src/org/openqa/selenium/firefox:firefox",
         "//java/client/src/org/openqa/selenium/firefox/xpi:firefox-xpi",
-        "//java/client/src/org/openqa/selenium/edge:edge",
+        "//java/client/src/org/openqa/selenium/edge/edgehtml:edgehtml",
         "//java/client/src/org/openqa/selenium/ie:ie",
         "//java/client/src/org/openqa/selenium/opera:opera",
         "//java/client/src/org/openqa/selenium/remote:remote",

java/client/src/org/openqa/selenium/chrome/ChromeDriver.java

@@ -32,6 +32,7 @@
 import org.openqa.selenium.interactions.HasTouchScreen;
 import org.openqa.selenium.interactions.TouchScreen;
 import org.openqa.selenium.mobile.NetworkConnection;
+import org.openqa.selenium.remote.CommandExecutor;
 import org.openqa.selenium.remote.FileDetector;
 import org.openqa.selenium.remote.RemoteTouchScreen;
 import org.openqa.selenium.remote.RemoteWebDriver;
@@ -186,7 +187,11 @@ public ChromeDriver(ChromeDriverService service, ChromeOptions options) {
    */
   @Deprecated
   public ChromeDriver(ChromeDriverService service, Capabilities capabilities) {
-    super(new ChromeDriverCommandExecutor(service), capabilities);
+    this(new ChromeDriverCommandExecutor(service), capabilities);
+  }
+
+  public ChromeDriver(CommandExecutor commandExecutor, Capabilities capabilities) {
+    super(commandExecutor, capabilities);
     locationContext = new RemoteLocationContext(getExecuteMethod());
     webStorage = new RemoteWebStorage(getExecuteMethod());
     touchScreen = new RemoteTouchScreen(getExecuteMethod());

java/client/src/org/openqa/selenium/chrome/ChromeDriverCommandExecutor.java

@@ -29,7 +29,7 @@
  *
  * @see <a href="https://chromium.googlesource.com/chromium/src/+/master/chrome/test/chromedriver/client/command_executor.py">List of ChromeWebdriver commands</a>
  */
-class ChromeDriverCommandExecutor extends DriverCommandExecutor {
+public class ChromeDriverCommandExecutor extends DriverCommandExecutor {
 
   private static final ImmutableMap<String, CommandInfo> CHROME_COMMAND_NAME_TO_URL = ImmutableMap.of(
       ChromeDriverCommand.LAUNCH_APP,

java/client/src/org/openqa/selenium/edge/BUCK

@@ -22,6 +22,7 @@ java_library(
         "com.google.auto.service.processor.AutoServiceProcessor",
     ],
     deps = [
+        "//java/client/src/org/openqa/selenium/chrome:chrome",
         "//third_party/java/guava:guava",
     ],
     visibility = ["PUBLIC"],

java/client/src/org/openqa/selenium/edge/ChromiumEdgeDriverInfo.java

@@ -0,0 +1,37 @@
+// Licensed to the Software Freedom Conservancy (SFC) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The SFC licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+package org.openqa.selenium.edge;
+
+import org.openqa.selenium.WebDriverException;
+
+public class ChromiumEdgeDriverInfo extends EdgeDriverInfo {
+
+  @Override
+  public boolean isAvailable() {
+    try {
+      ChromiumEdgeDriverService.createDefaultService();
+      return true;
+    } catch (IllegalStateException | WebDriverException e) {
+      return false;
+    }
+  }
+
+  @Override
+  public int getMaximumSimultaneousSessions() {
+    return Runtime.getRuntime().availableProcessors() + 1;
+  }
+}

java/client/src/org/openqa/selenium/edge/ChromiumEdgeDriverService.java

@@ -0,0 +1,180 @@
+// Licensed to the Software Freedom Conservancy (SFC) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The SFC licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+package org.openqa.selenium.edge;
+
+import com.google.auto.service.AutoService;
+import com.google.common.collect.ImmutableList;
+import com.google.common.collect.ImmutableMap;
+
+import org.openqa.selenium.Capabilities;
+import org.openqa.selenium.WebDriverException;
+import org.openqa.selenium.remote.BrowserType;
+import org.openqa.selenium.remote.service.DriverService;
+
+import java.io.File;
+import java.io.IOException;
+
+public class ChromiumEdgeDriverService extends EdgeDriverService{
+
+  /**
+   * Boolean system property that defines whether the MSEdgeDriver executable should be started
+   * in silent mode.
+   */
+  public static final String EDGE_DRIVER_SILENT_OUTPUT_PROPERTY = "webdriver.edge.silentOutput";
+
+  /**
+   * System property that defines comma-separated list of remote IPv4 addresses which are
+   * allowed to connect to MSEdgeDriver.
+   */
+  public final static String EDGE_DRIVER_WHITELISTED_IPS_PROPERTY = "webdriver.edge.whitelistedIps";
+
+  public ChromiumEdgeDriverService(
+      File executable,
+      int port,
+      ImmutableList<String> args,
+      ImmutableMap<String, String> environment) throws IOException {
+    super(executable, port, args, environment);
+  }
+
+  /**
+   * Configures and returns a new {@link ChromiumEdgeDriverService} using the default configuration. In
+   * this configuration, the service will use the MSEdgeDriver executable identified by the
+   * {@link #EDGE_DRIVER_EXE_PROPERTY} system property. Each service created by this method will
+   * be configured to use a free port on the current system.
+   *
+   * @return A new ChromiumEdgeDriverService using the default configuration.
+   */
+  public static ChromiumEdgeDriverService createDefaultService() {
+    return new ChromiumEdgeDriverService.Builder().build();
+  }
+
+  /**
+   * Builder used to configure new {@link ChromiumEdgeDriverService} instances.
+   */
+  @AutoService(DriverService.Builder.class)
+  public static class Builder extends EdgeDriverService.Builder<
+      ChromiumEdgeDriverService, ChromiumEdgeDriverService.Builder> {
+
+    private boolean verbose = Boolean.getBoolean(EDGE_DRIVER_VERBOSE_LOG_PROPERTY);
+    private boolean silent = Boolean.getBoolean(EDGE_DRIVER_SILENT_OUTPUT_PROPERTY);
+    private String whitelistedIps = System.getProperty(EDGE_DRIVER_WHITELISTED_IPS_PROPERTY);
+
+    @Override
+    public boolean isEdgeHTML() {
+      return false;
+    }
+
+    @Override
+    public int score(Capabilities capabilities) {
+      int score = 0;
+
+      if (BrowserType.EDGE.equals(capabilities.getBrowserName())) {
+        score++;
+      }
+
+      if (capabilities.getCapability(EdgeOptions.CAPABILITY) != null) {
+        score++;
+      }
+
+      return score;
+    }
+
+    /**
+     * Configures the driver server verbosity.
+     *
+     * @param verbose True for verbose output, false otherwise.
+     * @return A self reference.
+     */
+    @Override
+    public EdgeDriverService.Builder withVerbose(boolean verbose) {
+      this.verbose = verbose;
+      return this;
+    }
+
+    /**
+     * Configures the driver server for silent output.
+     *
+     * @param silent True for silent output, false otherwise.
+     * @return A self reference.
+     */
+    public ChromiumEdgeDriverService.Builder withSilent(boolean silent) {
+      this.silent = silent;
+      return this;
+    }
+
+    /**
+     * Configures the comma-separated list of remote IPv4 addresses which are allowed to connect
+     * to the driver server.
+     *
+     * @param whitelistedIps Comma-separated list of remote IPv4 addresses.
+     * @return A self reference.
+     */
+    public ChromiumEdgeDriverService.Builder withWhitelistedIps(String whitelistedIps) {
+      this.whitelistedIps = whitelistedIps;
+      return this;
+    }
+
+    @Override
+    protected File findDefaultExecutable() {
+      return findExecutable(
+          "msedgedriver", EDGE_DRIVER_EXE_PROPERTY,
+          "https://github.com/SeleniumHQ/selenium/wiki/MicrosoftWebDriver",
+          "https://msedgecdn.azurewebsites.net/webdriver/index.html");
+    }
+
+    @Override
+    protected ImmutableList<String> createArgs() {
+      if (getLogFile() == null) {
+        String logFilePath = System.getProperty(EDGE_DRIVER_LOG_PROPERTY);
+        if (logFilePath != null) {
+          withLogFile(new File(logFilePath));
+        }
+      }
+
+      ImmutableList.Builder<String> argsBuilder = ImmutableList.builder();
+      argsBuilder.add(String.format("--port=%d", getPort()));
+      if (getLogFile() != null) {
+        argsBuilder.add(String.format("--log-path=%s", getLogFile().getAbsolutePath()));
+      }
+      if (verbose) {
+        argsBuilder.add("--verbose");
+      }
+      if (silent) {
+        argsBuilder.add("--silent");
+      }
+      if (whitelistedIps != null) {
+        argsBuilder.add(String.format("--whitelisted-ips=%s", whitelistedIps));
+      }
+
+      return argsBuilder.build();
+    }
+
+    @Override
+    protected ChromiumEdgeDriverService createDriverService(
+        File exe,
+        int port,
+        ImmutableList<String> args,
+        ImmutableMap<String, String> environment) {
+      try {
+        return new ChromiumEdgeDriverService(exe, port, args, environment);
+      } catch (IOException e) {
+        throw new WebDriverException(e);
+      }
+    }
+  }
+
+}