Edge specific functionality

Microsoft Edge is implemented with Chromium, with the earliest supported version of v79. Similar to Chrome, the major version number of edgedriver must match the major version of the Edge browser.

Options

Capabilities common to all browsers are described on the Options page.

Capabilities unique to Chromium are documented at Google’s page for Capabilities & ChromeOptions

Starting an Edge session with basic defined options looks like this:

• Java
• Python
• CSharp
• Ruby
• JavaScript
• Kotlin

    EdgeOptions options = new EdgeOptions();
    driver = new EdgeDriver(options);

    options = webdriver.EdgeOptions()
    driver = webdriver.Edge(options=options)

            var options = new EdgeOptions();
            driver = new EdgeDriver(options);

      options = Selenium::WebDriver::Options.edge
      @driver = Selenium::WebDriver.for :edge, options: options

    let options = new edge.Options();
    driver = new Builder()
      .forBrowser(Browser.EDGE)
      .setEdgeOptions(options)
      .build();

Arguments

The args parameter is for a list of command line switches to be used when starting the browser. There are two excellent resources for investigating these arguments:

• Chrome Flags for Tooling
• List of Chromium Command Line Switches

Commonly used args include --start-maximized, --headless=new and --user-data-dir=...

Add an argument to options:

• Java
• Python
• CSharp
• Ruby
• JavaScript
• Kotlin

    options.addArguments("--start-maximized");

    options.add_argument("--start-maximized")

            options.AddArgument("--start-maximized");

      options.args << '--start-maximized'

      .setEdgeOptions(options.addArguments('--headless=new'))

Start browser in a specified location

The binary parameter takes the path of an alternate location of browser to use. With this parameter you can use chromedriver to drive various Chromium based browsers.

Add a browser location to options:

• Java
• Python
• CSharp
• Ruby
• JavaScript
• Kotlin

    options.setBinary(getEdgeLocation());

    options.binary_location = edge_bin

            options.BinaryLocation = GetEdgeLocation();

      options.binary = edge_location

Add extensions

The extensions parameter accepts crx files. As for unpacked directories, please use the load-extension argument instead, as mentioned in this post.

Add an extension to options:

• Java
• Python
• CSharp
• Ruby
• JavaScript
• Kotlin

    options.addExtensions(extensionFilePath);

    options.add_extension(extension_file_path)

            options.AddExtension(extensionFilePath);

      options.add_extension(extension_file_path)

      .setEdgeOptions(options.addExtensions(['./test/resources/extensions/webextensions-selenium-example.crx']))

Keeping browser open

Setting the detach parameter to true will keep the browser open after the process has ended, so long as the quit command is not sent to the driver.

• Java
• Python
• CSharp
• Ruby
• JavaScript
• Kotlin

    options.add_experimental_option("detach", True)

      options.detach = true

      .setEdgeOptions(options.detachDriver(true))

Excluding arguments

MSEdgedriver has several default arguments it uses to start the browser. If you do not want those arguments added, pass them into excludeSwitches. A common example is to turn the popup blocker back on. A full list of default arguments can be parsed from the Chromium Source Code

Set excluded arguments on options:

• Java
• Python
• CSharp
• Ruby
• JavaScript
• Kotlin

    options.setExperimentalOption("excludeSwitches", List.of("disable-popup-blocking"));

    options.add_experimental_option('excludeSwitches', ['disable-popup-blocking'])

            options.AddExcludedArgument("disable-popup-blocking");

      options.exclude_switches << 'disable-popup-blocking'

      .setEdgeOptions(options.excludeSwitches('enable-automation'))

Service

Examples for creating a default Service object, and for setting driver location and port can be found on the Driver Service page.

Log output

Getting driver logs can be helpful for debugging issues. The Service class lets you direct where the logs will go. Logging output is ignored unless the user directs it somewhere.

File output

To change the logging output to save to a specific file:

• Java
• Python
• CSharp
• Ruby
• JavaScript
• Kotlin

    EdgeDriverService service = new EdgeDriverService.Builder().withLogFile(logLocation).build();

    service = webdriver.EdgeService(log_output=log_path)

            service.LogPath = GetLogLocation();

      service.log = file_name

Console output

To change the logging output to display in the console as STDOUT:

• Java
• Python
• CSharp
• Ruby
• JavaScript
• Kotlin

    EdgeDriverService service = new EdgeDriverService.Builder().withLogOutput(System.out).build();

    service = webdriver.EdgeService(log_output=subprocess.STDOUT)

      service.log = $stdout

Log level

There are 6 available log levels: ALL, DEBUG, INFO, WARNING, SEVERE, and OFF. Note that --verbose is equivalent to --log-level=ALL and --silent is equivalent to --log-level=OFF, so this example is just setting the log level generically:

• Java
• Python
• CSharp
• Ruby
• JavaScript
• Kotlin

    EdgeDriverService service =
        new EdgeDriverService.Builder().withLoglevel(ChromiumDriverLogLevel.DEBUG).build();

    service = webdriver.EdgeService(service_args=['--log-level=DEBUG'], log_output=log_path)

      service.args << '--log-level=DEBUG'

Log file features

There are 2 features that are only available when logging to a file:

• append log
• readable timestamps

To use them, you need to also explicitly specify the log path and log level. The log output will be managed by the driver, not the process, so minor differences may be seen.

• Java
• Python
• CSharp
• Ruby
• JavaScript
• Kotlin

    EdgeDriverService service =
        new EdgeDriverService.Builder().withAppendLog(true).withReadableTimestamp(true).build();

    service = webdriver.EdgeService(service_args=['--append-log', '--readable-timestamp'], log_output=log_path)

      service.args << '--append-log'
      service.args << '--readable-timestamp'

Disabling build check

Edge browser and msedgedriver versions should match, and if they don’t the driver will error. If you disable the build check, you can force the driver to be used with any version of Edge. Note that this is an unsupported feature, and bugs will not be investigated.

• Java
• Python
• CSharp
• Ruby
• JavaScript
• Kotlin

    EdgeDriverService service =
        new EdgeDriverService.Builder().withBuildCheckDisabled(true).build();

    service = webdriver.EdgeService(service_args=['--disable-build-check'], log_output=log_path)

            service.DisableBuildCheck = true;

      service.args << '--disable-build-check'

Internet Explorer Mode

Microsoft Edge can be driven in “Internet Explorer Compatibility Mode”, which uses the Internet Explorer Driver classes in conjunction with Microsoft Edge. Read the Internet Explorer page for more details.

Special Features

Some browsers have implemented additional features that are unique to them.

Casting

You can drive Chrome Cast devices with Edge, including sharing tabs

• Java
• Python
• CSharp
• Ruby
• JavaScript
• Kotlin

      sinks = @driver.cast_sinks
      unless sinks.empty?
        device_name = sinks.first['name']
        @driver.start_cast_tab_mirroring(device_name)
        expect { @driver.stop_casting(device_name) }.not_to raise_exception

Network conditions

You can simulate various network conditions.

• Java
• Python
• CSharp
• Ruby
• JavaScript
• Kotlin

    network_conditions = {
        "offline": False,
        "latency": 20,  # 20 ms of latency
        "download_throughput": 2000 * 1024 / 8,  # 2000 kbps
        "upload_throughput": 2000 * 1024 / 8,    # 2000 kbps
    }
    driver.set_network_conditions(**network_conditions)

      @driver.network_conditions = {offline: false, latency: 100, throughput: 200}

Logs

• Java
• Python
• CSharp
• Ruby
• JavaScript
• Kotlin

      logs = @driver.logs.get(:browser)

Permissions

• Java
• Python
• CSharp
• Ruby
• JavaScript
• Kotlin

    driver.setPermission("camera", "denied");

    driver.set_permissions('camera', 'denied')

      @driver.add_permission('camera', 'denied')
      @driver.add_permissions('clipboard-read' => 'denied', 'clipboard-write' => 'prompt')

DevTools

See the Chrome DevTools section for more information about using DevTools in Edge