Refactor .NET bindings class inheritance hierarchy

Author: jimevans

dotnet/src/support/Events/EventFiringWebDriver.cs

@@ -1469,12 +1469,41 @@ public string GetAttribute(string attributeName)
                 return attribute;
             }
 
+            /// <summary>
+            /// Gets the value of a declared HTML attribute of this element.
+            /// </summary>
+            /// <param name="attributeName">The name of the HTML attribute to get the value of.</param>
+            /// <returns>The HTML attribute's current value. Returns a <see langword="null"/> if the
+            /// value is not set or the declared attribute does not exist.</returns>
+            /// <remarks>
+            /// As opposed to the <see cref="GetAttribute(string)"/> method, this method
+            /// only returns attributes declared in the element's HTML markup. To access the value
+            /// of an IDL property of the element, either use the <see cref="GetAttribute(string)"/>
+            /// method or the <see cref="GetDomProperty(string)"/> method.
+            /// </remarks>
+            public string GetDomAttribute(string attributeName)
+            {
+                string attribute = string.Empty;
+                try
+                {
+                    attribute = this.underlyingElement.GetDomAttribute(attributeName);
+                }
+                catch (Exception ex)
+                {
+                    this.parentDriver.OnException(new WebDriverExceptionEventArgs(this.parentDriver, ex));
+                    throw;
+                }
+
+                return attribute;
+            }
+
             /// <summary>
             /// Gets the value of a JavaScript property of this element.
             /// </summary>
             /// <param name="propertyName">The name JavaScript the JavaScript property to get the value of.</param>
             /// <returns>The JavaScript property's current value. Returns a <see langword="null"/> if the
             /// value is not set or the property does not exist.</returns>
+            [Obsolete("Use the GetDomProperty method instead.")]
             public string GetProperty(string propertyName)
             {
                 string elementProperty = string.Empty;
@@ -1491,6 +1520,28 @@ public string GetProperty(string propertyName)
                 return elementProperty;
             }
 
+            /// <summary>
+            /// Gets the value of a JavaScript property of this element.
+            /// </summary>
+            /// <param name="propertyName">The name JavaScript the JavaScript property to get the value of.</param>
+            /// <returns>The JavaScript property's current value. Returns a <see langword="null"/> if the
+            /// value is not set or the property does not exist.</returns>
+            public string GetDomProperty(string propertyName)
+            {
+                string elementProperty = string.Empty;
+                try
+                {
+                    elementProperty = this.underlyingElement.GetDomProperty(propertyName);
+                }
+                catch (Exception ex)
+                {
+                    this.parentDriver.OnException(new WebDriverExceptionEventArgs(this.parentDriver, ex));
+                    throw;
+                }
+
+                return elementProperty;
+            }
+
             /// <summary>
             /// Method to return the value of a CSS Property
             /// </summary>

dotnet/src/webdriver/Remote/RemoteAlert.cs renamed to dotnet/src/webdriver/Alert.cs

@@ -1,4 +1,4 @@
-// <copyright file="RemoteAlert.cs" company="WebDriver Committers">
+// <copyright file="Alert.cs" company="WebDriver Committers">
 // 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
@@ -19,20 +19,20 @@
 using System;
 using System.Collections.Generic;
 
-namespace OpenQA.Selenium.Remote
+namespace OpenQA.Selenium
 {
     /// <summary>
     /// Defines the interface through which the user can manipulate JavaScript alerts.
     /// </summary>
-    internal class RemoteAlert : IAlert
+    internal class Alert : IAlert
     {
-        private RemoteWebDriver driver;
+        private WebDriver driver;
 
         /// <summary>
-        /// Initializes a new instance of the <see cref="RemoteAlert"/> class.
+        /// Initializes a new instance of the <see cref="Alert"/> class.
         /// </summary>
-        /// <param name="driver">The <see cref="RemoteWebDriver"/> for which the alerts will be managed.</param>
-        public RemoteAlert(RemoteWebDriver driver)
+        /// <param name="driver">The <see cref="WebDriver"/> for which the alerts will be managed.</param>
+        public Alert(WebDriver driver)
         {
             this.driver = driver;
         }

dotnet/src/webdriver/Remote/CapabilityType.cs renamed to dotnet/src/webdriver/CapabilityType.cs

@@ -18,7 +18,7 @@
 
 using System.Collections.Generic;
 
-namespace OpenQA.Selenium.Remote
+namespace OpenQA.Selenium
 {
     /// <summary>
     /// Provides types of capabilities for the DesiredCapabilities object.

dotnet/src/webdriver/Chrome/ChromeWebElement.cs

@@ -31,7 +31,7 @@ namespace OpenQA.Selenium.Chromium
     /// <summary>
     /// Provides an abstract way to access Chromium-based browsers to run tests.
     /// </summary>
-    public abstract class ChromiumDriver : RemoteWebDriver, ISupportsLogs, IDevTools
+    public abstract class ChromiumDriver : WebDriver, ISupportsLogs, IDevTools
     {
         /// <summary>
         /// Accept untrusted SSL Certificates
@@ -70,11 +70,11 @@ public ChromiumDriver(ChromiumDriverService service, ChromiumOptions options, Ti
             this.optionsCapabilityName = options.CapabilityName;
 
             // Add the custom commands unique to Chrome
-            this.AddCustomChromeCommand(GetNetworkConditionsCommand, CommandInfo.GetCommand, "/session/{sessionId}/chromium/network_conditions");
-            this.AddCustomChromeCommand(SetNetworkConditionsCommand, CommandInfo.PostCommand, "/session/{sessionId}/chromium/network_conditions");
-            this.AddCustomChromeCommand(DeleteNetworkConditionsCommand, CommandInfo.DeleteCommand, "/session/{sessionId}/chromium/network_conditions");
-            this.AddCustomChromeCommand(SendChromeCommand, CommandInfo.PostCommand, "/session/{sessionId}/chromium/send_command");
-            this.AddCustomChromeCommand(SendChromeCommandWithResult, CommandInfo.PostCommand, "/session/{sessionId}/chromium/send_command_and_get_result");
+            this.AddCustomChromeCommand(GetNetworkConditionsCommand, HttpCommandInfo.GetCommand, "/session/{sessionId}/chromium/network_conditions");
+            this.AddCustomChromeCommand(SetNetworkConditionsCommand, HttpCommandInfo.PostCommand, "/session/{sessionId}/chromium/network_conditions");
+            this.AddCustomChromeCommand(DeleteNetworkConditionsCommand, HttpCommandInfo.DeleteCommand, "/session/{sessionId}/chromium/network_conditions");
+            this.AddCustomChromeCommand(SendChromeCommand, HttpCommandInfo.PostCommand, "/session/{sessionId}/chromium/send_command");
+            this.AddCustomChromeCommand(SendChromeCommandWithResult, HttpCommandInfo.PostCommand, "/session/{sessionId}/chromium/send_command_and_get_result");
         }
 
         /// <summary>
@@ -241,8 +241,8 @@ private static ICapabilities ConvertOptionsToCapabilities(ChromiumOptions option
 
         private void AddCustomChromeCommand(string commandName, string method, string resourcePath)
         {
-            CommandInfo commandInfoToAdd = new CommandInfo(method, resourcePath);
-            this.CommandExecutor.CommandInfoRepository.TryAddCommand(commandName, commandInfoToAdd);
+            HttpCommandInfo commandInfoToAdd = new HttpCommandInfo(method, resourcePath);
+            this.CommandExecutor.TryAddCommand(commandName, commandInfoToAdd);
         }
     }
 }

dotnet/src/webdriver/Chromium/ChromiumDriver.cs

@@ -1,4 +1,4 @@
-// <copyright file="Command.cs" company="WebDriver Committers">
+// <copyright file="Command.cs" company="WebDriver Committers">
 // 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
@@ -17,9 +17,11 @@
 // </copyright>
 
 using System.Collections.Generic;
+using System.Collections.ObjectModel;
 using Newtonsoft.Json;
+using OpenQA.Selenium.Internal;
 
-namespace OpenQA.Selenium.Remote
+namespace OpenQA.Selenium
 {
     /// <summary>
     /// Provides a way to send commands to the remote server
@@ -112,7 +114,7 @@ public string ParametersAsJsonString
         /// <returns>A string representation of the Command Object</returns>
         public override string ToString()
         {
-            return string.Concat("[", this.SessionId, "]: ", this.Name, " ", this.Parameters.ToString());
+            return string.Concat("[", this.SessionId, "]: ", this.Name, " ", this.ParametersAsJsonString);
         }
 
         /// <summary>

dotnet/src/webdriver/Chromium/ChromiumWebElement.cs

@@ -1,4 +1,4 @@
-// <copyright file="EdgeWebElement.cs" company="WebDriver Committers">
+// <copyright file="CommandInfo.cs" company="WebDriver Committers">
 // 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
@@ -16,23 +16,22 @@
 // limitations under the License.
 // </copyright>
 
-using OpenQA.Selenium.Chromium;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
 
-namespace OpenQA.Selenium.Edge
+namespace OpenQA.Selenium
 {
     /// <summary>
-    /// Provides a mechanism to get elements off the page for test
+    /// Represents the information about a command.
     /// </summary>
-    public class EdgeWebElement : ChromiumWebElement
+    public abstract class CommandInfo
     {
         /// <summary>
-        /// Initializes a new instance of the <see cref="EdgeWebElement"/> class
+        /// Gets the unique identifier for this command within the scope of its protocol definition
         /// </summary>
-        /// <param name="parent">Driver in use</param>
-        /// <param name="elementId">Id of the element</param>
-        public EdgeWebElement(EdgeDriver parent, string elementId)
-            : base(parent, elementId)
-        {
-        }
+        public abstract string CommandIdentifier { get; }
     }
 }

dotnet/src/webdriver/Remote/Command.cs renamed to dotnet/src/webdriver/Command.cs

@@ -1,4 +1,4 @@
-// <copyright file="CommandInfoRepository.cs" company="WebDriver Committers">
+// <copyright file="CommandInfoRepository.cs" company="WebDriver Committers">
 // 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
@@ -18,8 +18,9 @@
 
 using System;
 using System.Collections.Generic;
+using System.Globalization;
 
-namespace OpenQA.Selenium.Remote
+namespace OpenQA.Selenium
 {
     /// <summary>
     /// Holds the information about all commands specified by the JSON wire protocol.
@@ -45,16 +46,21 @@ protected CommandInfoRepository()
         public abstract int SpecificationLevel { get; }
 
         /// <summary>
-        /// Gets the <see cref="CommandInfo"/> for a <see cref="DriverCommand"/>.
+        /// Gets the <see cref="Type"/> that is valid for this <see cref="CommandInfoRepository"/>
+        /// </summary>
+        protected abstract Type RepositoryCommandInfoType { get; }
+
+        /// <summary>
+        /// Gets the <see cref="HttpCommandInfo"/> for a <see cref="DriverCommand"/>.
         /// </summary>
         /// <param name="commandName">The <see cref="DriverCommand"/> for which to get the information.</param>
-        /// <returns>The <see cref="CommandInfo"/> for the specified command.</returns>
-        public CommandInfo GetCommandInfo(string commandName)
+        /// <returns>The <see cref="HttpCommandInfo"/> for the specified command.</returns>
+        public T GetCommandInfo<T>(string commandName) where T : CommandInfo
         {
-            CommandInfo toReturn = null;
+            T toReturn = default(T);
             if (this.commandDictionary.ContainsKey(commandName))
             {
-                toReturn = this.commandDictionary[commandName];
+                toReturn = this.commandDictionary[commandName] as T;
             }
 
             return toReturn;
@@ -71,7 +77,7 @@ public CommandInfo GetCommandInfo(string commandName)
         /// This method will not overwrite existing commands for a specific name, and will return <see langword="false"/>
         /// in that case.
         /// </remarks>
-        public bool TryAddCommand(string commandName, CommandInfo commandInfo)
+        public bool TryAddCommand<T>(string commandName, T commandInfo) where T : CommandInfo
         {
             if (string.IsNullOrEmpty(commandName))
             {
@@ -83,6 +89,12 @@ public bool TryAddCommand(string commandName, CommandInfo commandInfo)
                 throw new ArgumentNullException("commandInfo", "The command information object cannot be null.");
             }
 
+            if (!typeof(T).IsAssignableFrom(this.RepositoryCommandInfoType))
+            {
+                string message = string.Format(CultureInfo.InvariantCulture, "{0} is not a valid command type for this repository; command info must be of type {1}", typeof(T), this.RepositoryCommandInfoType);
+                throw new ArgumentException(message, "commandInfo");
+            }
+
             if (this.commandDictionary.ContainsKey(commandName))
             {
                 return false;

dotnet/src/webdriver/Edge/EdgeWebElement.cs renamed to dotnet/src/webdriver/CommandInfo.cs

@@ -1,4 +1,4 @@
-// <copyright file="RemoteCookieJar.cs" company="WebDriver Committers">
+// <copyright file="CookieJar.cs" company="WebDriver Committers">
 // 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
@@ -20,20 +20,20 @@
 using System.Collections.Generic;
 using System.Collections.ObjectModel;
 
-namespace OpenQA.Selenium.Remote
+namespace OpenQA.Selenium
 {
     /// <summary>
     /// Defines an interface allowing the user to manipulate cookies on the current page.
     /// </summary>
-    internal class RemoteCookieJar : ICookieJar
+    internal class CookieJar : ICookieJar
     {
-        private RemoteWebDriver driver;
+        private WebDriver driver;
 
         /// <summary>
-        /// Initializes a new instance of the <see cref="RemoteCookieJar"/> class.
+        /// Initializes a new instance of the <see cref="CookieJar"/> class.
         /// </summary>
         /// <param name="driver">The driver that is currently in use</param>
-        public RemoteCookieJar(RemoteWebDriver driver)
+        public CookieJar(WebDriver driver)
         {
             this.driver = driver;
         }