Adding option for .NET EdgeDriverService to use W3C protocol dialect

The Microsoft Edge driver specifies the use of the W3C WebDriver
Specification dialect of the JSON wire protocol via a command-line switch.
This commit exposes that behavior in the form of a property on the
EdgeDriverService object. Note that this command-line switch is only valid
for versions of the driver executable for Windows 10 versions later than
the 2018 Fall Creators Update version (this is the code-named "Redstone
4", or "RS4" builds). Attempting to use this property with versions of
MicrosoftWebDriver.exe before RS4 will result in errors, as the driver
executable will not start properly with an unknown command-line switch.
This commit also makes use of the fact that in RS4 and beyond, the driver
executable is a feature that is installed in the OS, not a separate
download, so the test projects have been updated to reflect this.

Author: jimevans

dotnet/src/webdriver/Edge/EdgeDriverService.cs

@@ -1,4 +1,4 @@
-// <copyright file="EdgeDriverService.cs" company="Microsoft">
+// <copyright file="EdgeDriverService.cs" company="Microsoft">
 // 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
@@ -33,6 +33,7 @@ public sealed class EdgeDriverService : DriverService
         private string host;
         private string package;
         private bool useVerboseLogging;
+        private bool useSpecCompliantProtocol;
 
         /// <summary>
         /// Initializes a new instance of the <see cref="EdgeDriverService"/> class.
@@ -72,6 +73,60 @@ public bool UseVerboseLogging
             set { this.useVerboseLogging = value; }
         }
 
+        /// <summary>
+        /// Gets or sets a value indicating whether the <see cref="EdgeDriverService"/> instance
+        /// should use the a protocol dialect compliant with the W3C WebDriver Specification.
+        /// </summary>
+        /// <remarks>
+        /// Setting this property for driver executables matched to versions of
+        /// Windows before the 2018 Fall Creators Update will result in a the
+        /// driver executable shutting down without execution, and all commands
+        /// will fail. Do not set this property unless you are certain your version
+        /// of the MicrosoftWebDriver.exe supports the --w3c command-line argument.
+        /// </remarks>
+        public bool UseSpecCompliantProtocol
+        {
+            get { return this.useSpecCompliantProtocol; }
+            set { this.useSpecCompliantProtocol = value; }
+        }
+
+        /// <summary>
+        /// Gets a value indicating whether the service has a shutdown API that can be called to terminate
+        /// it gracefully before forcing a termination.
+        /// </summary>
+        protected override bool HasShutdown
+        {
+            get
+            {
+                if (this.useSpecCompliantProtocol)
+                {
+                    return false;
+                }
+
+                return base.HasShutdown;
+            }
+        }
+
+        /// <summary>
+        /// Gets a value indicating the time to wait for the service to terminate before forcing it to terminate.
+        /// </summary>
+        protected override TimeSpan TerminationTimeout
+        {
+            // Use a very small timeout for terminating the Firefox driver,
+            // because the executable does not have a clean shutdown command,
+            // which means we have to kill the process. Using a short timeout
+            // gets us to the termination point much faster.
+            get
+            {
+                if (this.useSpecCompliantProtocol)
+                {
+                    return TimeSpan.FromMilliseconds(100);
+                }
+
+                return base.TerminationTimeout;
+            }
+        }
+
         /// <summary>
         /// Gets the command-line arguments for the driver service.
         /// </summary>
@@ -95,6 +150,16 @@ protected override string CommandLineArguments
                     argsBuilder.Append(" --verbose");
                 }
 
+                if (this.SuppressInitialDiagnosticInformation)
+                {
+                    argsBuilder.Append(" --silent");
+                }
+
+                if (this.useSpecCompliantProtocol)
+                {
+                    argsBuilder.Append(" --w3c");
+                }
+
                 return argsBuilder.ToString();
             }
         }

dotnet/test/common/Environment/DriverFactory.cs

@@ -53,14 +53,6 @@ public IWebDriver CreateDriver(Type driverType)
                 return (IWebDriver)ctorInfo.Invoke(new object[] { service });
             }
 
-            if (typeof(EdgeDriver).IsAssignableFrom(driverType))
-            {
-                EdgeDriverService service = EdgeDriverService.CreateDefaultService(this.driverPath);
-                constructorArgTypeList.Add(typeof(EdgeDriverService));
-                ConstructorInfo ctorInfo = driverType.GetConstructor(constructorArgTypeList.ToArray());
-                return (IWebDriver)ctorInfo.Invoke(new object[] { service });
-            }
-
             if (typeof(FirefoxDriver).IsAssignableFrom(driverType))
             {
                 FirefoxDriverService service = FirefoxDriverService.CreateDefaultService(this.driverPath);

dotnet/test/common/appconfig.json

@@ -40,6 +40,13 @@
       "RemoteCapabilities": "MicrosoftEdge"
     },
 
+    "EdgeSpec": {
+      "DriverTypeName": "OpenQA.Selenium.Edge.SpecCompliantEdgeDriver",
+      "AssemblyName": "WebDriver.Edge.Tests",
+      "BrowserValue": "Edge",
+      "RemoteCapabilities": "MicrosoftEdge"
+    },
+
     "Firefox": {
       "DriverTypeName": "OpenQA.Selenium.Firefox.ReleaseFirefoxWebDriver",
       "AssemblyName": "WebDriver.Firefox.Tests",

dotnet/test/edge/SpecCompliantEdgeDriver.cs

@@ -0,0 +1,23 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace OpenQA.Selenium.Edge
+{
+    public class SpecCompliantEdgeDriver : EdgeDriver
+    {
+        public SpecCompliantEdgeDriver() :
+            base(CreateSpecCompliantEdgeDriverService(), new EdgeOptions())
+        {
+        }
+
+        private static EdgeDriverService CreateSpecCompliantEdgeDriverService()
+        {
+            EdgeDriverService service = EdgeDriverService.CreateDefaultService();
+            service.UseSpecCompliantProtocol = true;
+            return service;
+        }
+    }
+}