org.openqa.selenium.edge.EdgeDriver.java Source code

Introduction

Here is the source code for org.openqa.selenium.edge.EdgeDriver.java

Source

// 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.Capabilities;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.WebDriverException;
import org.openqa.selenium.chromium.ChromiumDriver;
import org.openqa.selenium.chromium.ChromiumDriverCommandExecutor;
import org.openqa.selenium.remote.CommandExecutor;
import org.openqa.selenium.remote.RemoteWebDriver;
import org.openqa.selenium.remote.service.DriverCommandExecutor;
import org.openqa.selenium.remote.service.DriverService;

import java.util.Objects;
import java.util.ServiceLoader;
import java.util.stream.StreamSupport;

/**
 * A {@link WebDriver} implementation that controls an Edge browser running on the local machine.
 * This class is provided as a convenience for easily testing the Edge browser. The control server
 * which each instance communicates with will live and die with the instance.
 *
 * To avoid unnecessarily restarting the Microsoft WebDriver server with each instance, use a
 * {@link RemoteWebDriver} coupled with the desired {@link EdgeDriverService}, which is managed
 * separately. For example: <pre>{@code
 *
 * import org.junit.jupiter.api.*;
 * import org.openqa.selenium.By;
 * import org.openqa.selenium.WebDriver;
 * import org.openqa.selenium.WebDriverException;
 * import org.openqa.selenium.WebElement;
 * import org.openqa.selenium.edge.EdgeDriverService;
 * import org.openqa.selenium.edge.EdgeOptions;
 * import org.openqa.selenium.remote.RemoteWebDriver;
 * import org.openqa.selenium.remote.service.DriverService;
 *
 * import java.io.IOException;
 * import java.util.ServiceLoader;
 * import java.util.stream.StreamSupport;
 *
 * import static org.junit.jupiter.api.Assertions.assertEquals;
 *
 * public class EdgeTest {
 *
 *     private static EdgeDriverService service;
 *     private WebDriver driver;
 *
 *     {@Literal @BeforeAll}
 *     public static void createAndStartService() {
 *         // Setting this property to false in order to launch Chromium Edge
 *         // Otherwise, old Edge will be launched by default
 *         System.setProperty("webdriver.edge.edgehtml", "false");
 *         EdgeDriverService.Builder<?, ?> builder =
 *                 StreamSupport.stream(ServiceLoader.load(DriverService.Builder.class).spliterator(), false)
 *                         .filter(b -> b instanceof EdgeDriverService.Builder)
 *                         .map(b -> (EdgeDriverService.Builder) b)
 *                         .filter(b -> b.isLegacy() == Boolean.getBoolean("webdriver.edge.edgehtml"))
 *                         .findFirst().orElseThrow(WebDriverException::new);
 *         service = builder.build();
 *         try {
 *             service.start();
 *         }
 *         catch (IOException e) {
 *             throw new RuntimeException(e);
 *         }
 *     }
 *
 *     {@Literal @AfterAll}
 *     public static void createAndStopService() {
 *         service.stop();
 *     }
 *
 *     {@Literal @BeforeEach}
 *     public void createDriver() {
 *         driver = new RemoteWebDriver(service.getUrl(),
 *                 new EdgeOptions());
 *     }
 *
 *     {@Literal @AfterEach}
 *     public void quitDriver() {
 *         driver.quit();
 *     }
 *
 *     {@Literal @Test}
 *     public void testBingSearch() {
 *         driver.get("http://www.bing.com");
 *         WebElement searchBox = driver.findElement(By.name("q"));
 *         searchBox.sendKeys("webdriver");
 *         searchBox.submit();
 *         assertEquals("webdriver - Bing", driver.getTitle());
 *     }
 * }}</pre>
 */
public class EdgeDriver extends ChromiumDriver {

    /**
     * Boolean system property that defines whether the msedgedriver executable (Chromium Edge)
     * should be used.
     */
    public static final String DRIVER_USE_EDGE_EDGEHTML = "webdriver.edge.edgehtml";

    public EdgeDriver() {
        this(new EdgeOptions());
    }

    public EdgeDriver(EdgeOptions options) {
        super(toExecutor(options), options, EdgeOptions.CAPABILITY);
    }

    @Deprecated
    public EdgeDriver(Capabilities capabilities) {
        super(toExecutor(new EdgeOptions()), capabilities, EdgeOptions.CAPABILITY);
    }

    private static CommandExecutor toExecutor(EdgeOptions options) {
        Objects.requireNonNull(options, "No options to construct executor from");

        boolean isLegacy = System.getProperty(DRIVER_USE_EDGE_EDGEHTML) == null
                || Boolean.getBoolean(DRIVER_USE_EDGE_EDGEHTML);

        EdgeDriverService.Builder<?, ?> builder = StreamSupport
                .stream(ServiceLoader.load(DriverService.Builder.class).spliterator(), false)
                .filter(b -> b instanceof EdgeDriverService.Builder).map(b -> (EdgeDriverService.Builder) b)
                .filter(b -> b.isLegacy() == isLegacy).findFirst().orElseThrow(WebDriverException::new);

        if (isLegacy)
            return new DriverCommandExecutor(builder.build());

        return new ChromiumDriverCommandExecutor(builder.build());
    }
}