StyleCop and FxCop changes

Author: jimevans

dotnet/src/webdriver/GlobalSuppressions.cs

@@ -41,9 +41,15 @@
 [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1056:UriPropertiesShouldNotBeStrings", Scope = "member", Target = "OpenQA.Selenium.Chrome.ChromeDriverService.#UrlPathPrefix", Justification = "UrlPathPrefix is a prefix for use with ChromeDriver, and should be a string.")]
 [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1056:UriPropertiesShouldNotBeStrings", Scope = "member", Target = "OpenQA.Selenium.Opera.OperaDriverService.#UrlPathPrefix", Justification = "UrlPathPrefix is a prefix for use with OperaDriver, and should be a string.")]
 [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1056:UriPropertiesShouldNotBeStrings", Scope = "member", Target = "OpenQA.Selenium.PhantomJS.PhantomJSDriverService.#GridHubUrl", Justification = "GridHubUrl is a command line for use with PhantomJS, and should properly be a string.")]
+[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Globalization", "CA1303:Do not pass literals as localized parameters", MessageId = "System.Console.WriteLine(System.String,System.Object)", Scope = "member", Target = "OpenQA.Selenium.Internal.FileUtilities.#DeleteDirectory(System.String)", Justification = "Informational message only.")]
 [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Globalization", "CA1308:NormalizeStringsToUppercase", Scope = "member", Target = "OpenQA.Selenium.Firefox.Preferences.#SetPreferenceValue(System.String,System.Object)", Justification = "Strings are normalized to lower case by JSON wire protocol.")]
 [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Globalization", "CA1308:NormalizeStringsToUppercase", Scope = "member", Target = "OpenQA.Selenium.Remote.RemoteWebElement.#GetAttribute(System.String)", Justification = "Strings are normalized to lower case by JSON wire protocol.")]
 [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Globalization", "CA1308:NormalizeStringsToUppercase", Scope = "member", Target = "OpenQA.Selenium.Firefox.FirefoxDriverService.#CommandLineArguments", Justification = "Strings are normalized to lower case by JSON wire protocol.")]
+[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Globalization", "CA1308:NormalizeStringsToUppercase", Scope = "member", Target = "OpenQA.Selenium.Interactions.PointerInputDevice+PointerMoveInteraction.#Serialize()", Justification = "Strings are normalized to lower case by JSON wire protocol.")]
+[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Globalization", "CA1308:NormalizeStringsToUppercase", Scope = "member", Target = "OpenQA.Selenium.Interactions.PointerInputDevice.#Serialize()", Justification = "Strings are normalized to lower case by JSON wire protocol.")]
+[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Globalization", "CA1308:NormalizeStringsToUppercase", Scope = "member", Target = "OpenQA.Selenium.Firefox.FirefoxOptions.#GenerateFirefoxOptionsDictionary()", Justification = "Strings are normalized to lower case by JSON wire protocol.")]
+[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Globalization", "CA1308:NormalizeStringsToUppercase", Scope = "member", Target = "OpenQA.Selenium.Interactions.PointerInputDevice+PointerMoveInteraction.#ToDictionary()", Justification = "Strings are normalized to lower case by JSON wire protocol.")]
+[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Globalization", "CA1308:NormalizeStringsToUppercase", Scope = "member", Target = "OpenQA.Selenium.Interactions.PointerInputDevice.#ToDictionary()", Justification = "Strings are normalized to lower case by JSON wire protocol.")]
 [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Maintainability", "CA1506:AvoidExcessiveClassCoupling", Scope = "type", Target = "OpenQA.Selenium.Remote.RemoteWebDriver", Justification = "RemoteWebDriver is a large class, and will have tight couplings with a lot of classes.")]
 [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1702:CompoundWordsShouldBeCasedCorrectly", MessageId = "OnScreen", Scope = "member", Target = "OpenQA.Selenium.Interactions.Internal.ICoordinates.#LocationOnScreen", Justification = "On Screen is properly used as two-word discrete term.")]
 [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1702:CompoundWordsShouldBeCasedCorrectly", MessageId = "OnScreen", Scope = "member", Target = "OpenQA.Selenium.ILocatable.#LocationOnScreenOnceScrolledIntoView", Justification = "On Screen is properly used as two-word discrete term.")]
@@ -62,6 +68,8 @@
 [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Api", Scope = "member", Target = "OpenQA.Selenium.IE.InternetExplorerOptions.#ForceShellWindowsApi", Justification = "API is spelled and cased correctly for use in method names.")]
 [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Uncached", Scope = "member", Target = "OpenQA.Selenium.Html5.AppCacheStatus.#Uncached", Justification = "Uncached property is correctly spelled.")]
 [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Multiprocess", Scope = "member", Target = "OpenQA.Selenium.Firefox.FirefoxDriverService.#DisableBrowserMultiprocessSupport", Justification = "Multiprocess is correctly spelled.")]
+[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "x", Scope = "member", Target = "OpenQA.Selenium.Interactions.PointerInputDevice.#CreatePointerMove(OpenQA.Selenium.IWebElement,OpenQA.Selenium.Interactions.CoordinateOrigin,System.Int32,System.Int32,System.TimeSpan)", Justification = "An x-offset is an appropriate name for the parameter.")]
+[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "y", Scope = "member", Target = "OpenQA.Selenium.Interactions.PointerInputDevice.#CreatePointerMove(OpenQA.Selenium.IWebElement,OpenQA.Selenium.Interactions.CoordinateOrigin,System.Int32,System.Int32,System.TimeSpan)", Justification = "A y-offset is an appropriate name for the parameter.")]
 [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode", Scope = "member", Target = "OpenQA.Selenium.Cookie.#ExpirySeconds", Justification = "This property only exists so that the JSON serializer can serialize a cookie without resorting to a custom converter.")]
 [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays", Scope = "member", Target = "OpenQA.Selenium.Remote.ErrorResponse.#StackTrace", Justification = "Specification compliance demands use of an array.")]
 [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays", Scope = "member", Target = "OpenQA.Selenium.Screenshot.#AsByteArray", Justification = "Specification compliance demands use of an array.")]
@@ -91,4 +99,3 @@
 [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA2204:Literals should be spelled correctly", MessageId = "HasWebStorage", Scope = "member", Target = "OpenQA.Selenium.Remote.RemoteWebDriver.#WebStorage", Justification = "HasWebStorage property name is properly spelled")]
 [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA2204:Literals should be spelled correctly", MessageId = "geolocation", Scope = "member", Target = "OpenQA.Selenium.Remote.RemoteWebDriver.#LocationContext", Justification = "Geolocation is properly spelled")]
 [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2214:DoNotCallOverridableMethodsInConstructors", Scope = "member", Target = "OpenQA.Selenium.Remote.RemoteWebDriver.#.ctor(OpenQA.Selenium.Remote.ICommandExecutor,OpenQA.Selenium.ICapabilities)", Justification = "Class provides a hook for subclasses to modify functionality, so virtual method call in constructor is appropriate.")]
-[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Globalization", "CA1303:Do not pass literals as localized parameters", MessageId = "System.Console.WriteLine(System.String,System.Object)", Scope = "member", Target = "OpenQA.Selenium.Internal.FileUtilities.#DeleteDirectory(System.String)", Justification = "Informational message only.")]

dotnet/src/webdriver/Interactions/ActionSequence.cs

@@ -18,6 +18,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.Globalization;
 using System.Linq;
 using System.Text;
 
@@ -51,6 +52,9 @@ public ActionSequence(InputDevice device, int initialSize)
             }
         }
 
+        /// <summary>
+        /// Gets the count of actions in the sequence.
+        /// </summary>
         public int Count
         {
             get { return this.interactions.Count; }
@@ -70,13 +74,17 @@ public ActionSequence AddAction(Interaction interactionToAdd)
 
             if (!interactionToAdd.IsValidFor(this.device.DeviceKind))
             {
-                throw new ArgumentException(string.Format("Interaction {0} is invalid for device type {1}."), "interactionToAdd");
+                throw new ArgumentException(string.Format(CultureInfo.InvariantCulture, "Interaction {0} is invalid for device type {1}.", interactionToAdd.GetType(), this.device.DeviceKind), "interactionToAdd");
             }
 
             this.interactions.Add(interactionToAdd);
             return this;
         }
 
+        /// <summary>
+        /// Converts this action sequence into an object suitable for serializing across the wire.
+        /// </summary>
+        /// <returns>A <see cref="Dictionary{TKey, TValue}"/> containing the actions in this sequence.</returns>
         public Dictionary<string, object> ToDictionary()
         {
             Dictionary<string, object> toReturn = this.device.ToDictionary();

dotnet/src/webdriver/Interactions/Actions.cs

@@ -91,6 +91,11 @@ public Actions KeyDown(string theKey)
         /// of <see cref="Keys.Shift"/>, <see cref="Keys.Control"/>, or <see cref="Keys.Alt"/>.</exception>
         public Actions KeyDown(IWebElement element, string theKey)
         {
+            if (string.IsNullOrEmpty(theKey))
+            {
+                throw new ArgumentException("The key value must not be null or empty", "theKey");
+            }
+
             ILocatable target = GetLocatableFromElement(element);
             this.action.AddAction(new KeyDownAction(this.keyboard, this.mouse, target, theKey));
             this.actionBuilder.AddAction(this.defaultKeyboard.CreateKeyDown(theKey[0]));
@@ -119,6 +124,11 @@ public Actions KeyUp(string theKey)
         /// of <see cref="Keys.Shift"/>, <see cref="Keys.Control"/>, or <see cref="Keys.Alt"/>.</exception>
         public Actions KeyUp(IWebElement element, string theKey)
         {
+            if (string.IsNullOrEmpty(theKey))
+            {
+                throw new ArgumentException("The key value must not be null or empty", "theKey");
+            }
+
             ILocatable target = GetLocatableFromElement(element);
             this.action.AddAction(new KeyUpAction(this.keyboard, this.mouse, target, theKey));
             this.actionBuilder.AddAction(this.defaultKeyboard.CreateKeyUp(theKey[0]));
@@ -143,6 +153,11 @@ public Actions SendKeys(string keysToSend)
         /// <returns>A self-reference to this <see cref="Actions"/>.</returns>
         public Actions SendKeys(IWebElement element, string keysToSend)
         {
+            if (string.IsNullOrEmpty(keysToSend))
+            {
+                throw new ArgumentException("The key value must not be null or empty", "keysToSend");
+            }
+
             ILocatable target = GetLocatableFromElement(element);
             this.action.AddAction(new SendKeysAction(this.keyboard, this.mouse, target, keysToSend));
             foreach (char key in keysToSend)
@@ -331,7 +346,6 @@ public Actions DragAndDrop(IWebElement source, IWebElement target)
         /// <returns>A self-reference to this <see cref="Actions"/>.</returns>
         public Actions DragAndDropToOffset(IWebElement source, int offsetX, int offsetY)
         {
-            ILocatable startElement = GetLocatableFromElement(source);
             this.ClickAndHold(source).MoveByOffset(offsetX, offsetY).Release();
             return this;
         }

dotnet/src/webdriver/Interactions/InputDevice.cs

@@ -29,7 +29,11 @@ internal abstract class InputDevice
     {
         private string deviceName;
 
-        public InputDevice(string deviceName)
+        /// <summary>
+        /// Initializes a new instance of the <see cref="InputDevice"/> class.
+        /// </summary>
+        /// <param name="deviceName">The unique name of the input device represented by this class.</param>
+        protected InputDevice(string deviceName)
         {
             if (string.IsNullOrEmpty(deviceName))
             {
@@ -39,11 +43,17 @@ public InputDevice(string deviceName)
             this.deviceName = deviceName;
         }
 
+        /// <summary>
+        /// Gets the unique name of this input device.
+        /// </summary>
         public string DeviceName
         {
             get { return this.deviceName; }
         }
 
+        /// <summary>
+        /// Gets the kind of device for this input device.
+        /// </summary>
         public abstract InputDeviceKind DeviceKind { get; }
 
         /// <summary>

dotnet/src/webdriver/Interactions/InputDeviceKind.cs

@@ -23,8 +23,19 @@ namespace OpenQA.Selenium.Interactions
     /// </summary>
     internal enum InputDeviceKind
     {
+        /// <summary>
+        /// Represents the null device.
+        /// </summary>
         None,
+
+        /// <summary>
+        /// Represents a key-based device, primarily for entering text.
+        /// </summary>
         Key,
+
+        /// <summary>
+        /// Represents a pointer-based device, such as a mouse, pen, or stylus.
+        /// </summary>
         Pointer
     }
 }

dotnet/src/webdriver/Interactions/Interaction.cs

@@ -1,4 +1,22 @@
-using System;
+// <copyright file="Interaction.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
+// 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.
+// </copyright>
+
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
@@ -12,6 +30,10 @@ internal abstract class Interaction
     {
         private InputDevice sourceDevice;
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="Interaction"/> class.
+        /// </summary>
+        /// <param name="sourceDevice">The input device which performs this action.</param>
         protected Interaction(InputDevice sourceDevice)
         {
             if (sourceDevice == null)
@@ -22,6 +44,9 @@ protected Interaction(InputDevice sourceDevice)
             this.sourceDevice = sourceDevice;
         }
 
+        /// <summary>
+        /// Gets the device for which this action is intended.
+        /// </summary>
         public InputDevice SourceDevice
         {
             get { return this.sourceDevice; }
@@ -33,9 +58,15 @@ public InputDevice SourceDevice
         /// <returns>A <see cref="Dictionary{TKey, TValue}"/> representing this action.</returns>
         public abstract Dictionary<string, object> ToDictionary();
 
+        /// <summary>
+        /// Gets a value indicating whether this action is valid for the specified type of input device.
+        /// </summary>
+        /// <param name="sourceDeviceKind">The type of device to check.</param>
+        /// <returns><see langword="true"/> if the action is valid for the specified type of input device;
+        /// otherwise, <see langword="false"/>.</returns>
         public virtual bool IsValidFor(InputDeviceKind sourceDeviceKind)
         {
-            return sourceDevice.DeviceKind == sourceDeviceKind;
+            return this.sourceDevice.DeviceKind == sourceDeviceKind;
         }
     }
 }

dotnet/src/webdriver/Interactions/KeyInputDevice.cs

@@ -29,16 +29,26 @@ namespace OpenQA.Selenium.Interactions
     /// </summary>
     internal class KeyInputDevice : InputDevice
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="KeyInputDevice"/> class.
+        /// </summary>
         public KeyInputDevice()
             : this(Guid.NewGuid().ToString())
         {
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="KeyInputDevice"/> class, given the device's name.
+        /// </summary>
+        /// <param name="deviceName">The unique name of this input device.</param>
         public KeyInputDevice(string deviceName)
             : base(deviceName)
         {
         }
 
+        /// <summary>
+        /// Gets the type of device for this input device.
+        /// </summary>
         public override InputDeviceKind DeviceKind
         {
             get { return InputDeviceKind.Key; }
@@ -58,11 +68,21 @@ public override Dictionary<string, object> ToDictionary()
             return toReturn;
         }
 
+        /// <summary>
+        /// Creates a key-down action for simulating a press of a key.
+        /// </summary>
+        /// <param name="codePoint">The unicode character to be sent.</param>
+        /// <returns>The <see cref="Interaction"/> representing the action.</returns>
         public Interaction CreateKeyDown(char codePoint)
         {
             return new KeyDownInteraction(this, codePoint);
         }
 
+        /// <summary>
+        /// Creates a key-up action for simulating a release of a key.
+        /// </summary>
+        /// <param name="codePoint">The unicode character to be sent.</param>
+        /// <returns>The <see cref="Interaction"/> representing the action.</returns>
         public Interaction CreateKeyUp(char codePoint)
         {
             return new KeyUpInteraction(this, codePoint);
@@ -96,7 +116,6 @@ public override string ToString()
 
         private class TypingInteraction : Interaction
         {
-
             private string type;
             private string value;