Add optional parameter to Factory methods to set custom element's name (#42)

Author: mialeska

Aquality.Selenium.Core/src/Aquality.Selenium.Core/Aquality.Selenium.Core.xml

@@ -52,9 +52,9 @@ public void Click()
             DoWithRetry(() => GetElement().Click());
         }
 
-        public T FindChildElement<T>(By childLocator, ElementSupplier<T> supplier = null, ElementState state = ElementState.Displayed) where T : IElement
+        public T FindChildElement<T>(By childLocator, string name = null, ElementSupplier<T> supplier = null, ElementState state = ElementState.Displayed) where T : IElement
         {
-            return Factory.FindChildElement(this, childLocator, supplier, state);
+            return Factory.FindChildElement(this, childLocator, name, supplier, state);
         }
 
         public string GetAttribute(string attr)
@@ -71,11 +71,24 @@ public virtual RemoteWebElement GetElement(TimeSpan? timeout = null)
             }
             catch (NoSuchElementException ex)
             {
-                Logger.Debug($"Page source:{Environment.NewLine}{Application.Driver.PageSource}", ex);
+                LogPageSource(ex);
                 throw;
             }
         }
 
+        private void LogPageSource(WebDriverException exception)
+        {
+            try
+            {
+                Logger.Debug($"Page source:{Environment.NewLine}{Application.Driver.PageSource}", exception);
+            }
+            catch (WebDriverException e)
+            {
+                Logger.Error(exception.Message);
+                Logger.Fatal("An exception occured while tried to save the page source", e);
+            }
+        }
+
         public string Text
         {
             get

Aquality.Selenium.Core/src/Aquality.Selenium.Core/Elements/Element.cs

@@ -37,13 +37,13 @@ public ElementFactory(ConditionalWait conditionalWait, IElementFinder elementFin
         /// <returns>Dictionary where key is interface and value is its implementation.</returns>
         protected virtual IDictionary<Type, Type> ElementTypesMap => new Dictionary<Type, Type>();
 
-        public virtual T FindChildElement<T>(IElement parentElement, By childLocator, ElementSupplier<T> supplier = null, ElementState state = ElementState.Displayed) where T : IElement
+        public virtual T FindChildElement<T>(IElement parentElement, By childLocator, string name = null, ElementSupplier<T> supplier = null, ElementState state = ElementState.Displayed) where T : IElement
         {
             var elementSupplier = ResolveSupplier(supplier);
-            return elementSupplier(new ByChained(parentElement.Locator, childLocator), $"Child element of {parentElement.Name}", state);
+            return elementSupplier(new ByChained(parentElement.Locator, childLocator), name ?? $"Child element of {parentElement.Name}", state);
         }
 
-        public virtual IList<T> FindElements<T>(By locator, ElementSupplier<T> supplier = null, ElementsCount expectedCount = ElementsCount.Any, ElementState state = ElementState.Displayed) where T : IElement
+        public virtual IList<T> FindElements<T>(By locator, string name = null, ElementSupplier<T> supplier = null, ElementsCount expectedCount = ElementsCount.Any, ElementState state = ElementState.Displayed) where T : IElement
         {
             var elementSupplier = ResolveSupplier(supplier);
             switch (expectedCount)
@@ -67,7 +67,8 @@ public virtual IList<T> FindElements<T>(By locator, ElementSupplier<T> supplier
             IEnumerable<T> elements = webElements.Select((webElement, index) =>
             {
                 var elementIndex = index + 1;
-                return elementSupplier(GenerateXpathLocator(locator, webElement, elementIndex), $"element {elementIndex}", state);
+                var elementName = $"{name ?? "element"} {elementIndex}";
+                return elementSupplier(GenerateXpathLocator(locator, webElement, elementIndex), elementName, state);
             });
             return elements.ToList();
         }

Aquality.Selenium.Core/src/Aquality.Selenium.Core/Elements/ElementFactory.cs

@@ -1,4 +1,5 @@
 using OpenQA.Selenium;
+using System;
 using System.Collections.Generic;
 
 namespace Aquality.Selenium.Core.Elements.Interfaces
@@ -9,38 +10,40 @@ namespace Aquality.Selenium.Core.Elements.Interfaces
     public interface IElementFactory
     {
         /// <summary>
-        /// Create custom element according to passed parameters
+        /// Create custom element according to passed parameters.
         /// </summary>
-        /// <typeparam name="T">Type of the target element</typeparam>
-        /// <param name="elementSupplier">Delegate that defines constructor of element</param>
-        /// <param name="locator">Locator of the target element</param>
-        /// <param name="name">Name of the target element</param>
-        /// <param name="state">State of the target element</param>
-        /// <returns>Instance of custom element</returns>
+        /// <typeparam name="T">Type of the target element.</typeparam>
+        /// <param name="elementSupplier">Delegate that defines constructor of element.</param>
+        /// <param name="locator">Locator of the target element.</param>
+        /// <param name="name">Name of the target element.</param>
+        /// <param name="state">State of the target element.</param>
+        /// <returns>Instance of custom element.</returns>
         T GetCustomElement<T>(ElementSupplier<T> elementSupplier, By locator, string name, ElementState state = ElementState.Displayed) where T : IElement;
 
         /// <summary>
         /// Finds child element by its locator relative to parent element.
         /// </summary>
-        /// <typeparam name="T">Type of child element that has to implement IElement</typeparam>
-        /// <param name="parentElement">Parent element</param>
-        /// <param name="childLocator">Locator of child element relative to its parent</param>
-        /// <param name="supplier">Delegate that defines constructor of element in case of custom element</param>
-        /// <param name="state">Child element state</param>
-        /// <exception cref="System.InvalidOperationException">Thrown when the supplier is null, and no constructor with required arguments was found.</exception>
+        /// <typeparam name="T">Type of child element that has to implement IElement.</typeparam>
+        /// <param name="parentElement">Parent element.</param>
+        /// <param name="childLocator">Locator of child element relative to its parent.</param>
+        /// <param name="supplier">Delegate that defines constructor of element in case of custom element.</param>
+        /// <param name="state">Child element state.</param>
+        /// <param name="name">Child element name.</param>
+        /// <exception cref="InvalidOperationException">Thrown when the supplier is null, and no constructor with required arguments was found.</exception>
         /// <returns>Instance of child element</returns>
-        T FindChildElement<T>(IElement parentElement, By childLocator, ElementSupplier<T> supplier = null, ElementState state = ElementState.Displayed) where T : IElement;
+        T FindChildElement<T>(IElement parentElement, By childLocator, string name = null, ElementSupplier<T> supplier = null, ElementState state = ElementState.Displayed) where T : IElement;
 
         /// <summary>
         /// Finds list of elements by base locator.
         /// </summary>
-        /// <typeparam name="T">Type of elements that have to implement IElement</typeparam>
-        /// <param name="locator">Base elements locator</param>
-        /// <param name="supplier">Delegate that defines constructor of element in case of custom elements</param>
-        /// <param name="expectedCount">Expected number of elements that have to be found (zero, more then zero, any)</param>
-        /// <param name="state">Elements state</param>
-        /// <exception cref="System.InvalidOperationException">Thrown when the supplier is null, and no constructor with required arguments was found.</exception>
-        /// <returns>List of elements that found by locator</returns>
-        IList<T> FindElements<T>(By locator, ElementSupplier<T> supplier = null, ElementsCount expectedCount = ElementsCount.Any, ElementState state = ElementState.Displayed) where T : IElement;
+        /// <typeparam name="T">Type of elements that have to implement IElement.</typeparam>
+        /// <param name="locator">Base elements locator.</param>
+        /// <param name="supplier">Delegate that defines constructor of element in case of custom elements.</param>
+        /// <param name="expectedCount">Expected number of elements that have to be found (zero, more then zero, any).</param>
+        /// <param name="state">Elements state.</param>
+        /// <param name="name">Elements name.</param>
+        /// <exception cref="InvalidOperationException">Thrown when the supplier is null, and no constructor with required arguments was found.</exception>
+        /// <returns>List of elements that found by locator.</returns>
+        IList<T> FindElements<T>(By locator, string name = null, ElementSupplier<T> supplier = null, ElementsCount expectedCount = ElementsCount.Any, ElementState state = ElementState.Displayed) where T : IElement;
     }
 }

Aquality.Selenium.Core/src/Aquality.Selenium.Core/Elements/Interfaces/IElementFactory.cs

@@ -10,11 +10,12 @@ public interface IParent
         /// <summary>
         /// Finds child element of current element by its locator.
         /// </summary>
-        /// <typeparam name="T">Type of child element that has to implement IElement</typeparam>
+        /// <typeparam name="T">Type of child element that has to implement IElement.</typeparam>
         /// <param name="childLocator">Locator of child element.</param>
-        /// <param name="supplier">Delegate that defines constructor of child element in case of custom element</param>
-        /// <param name="state">Child element state</param>
-        /// <returns>Instance of child element</returns>
-        T FindChildElement<T>(By childLocator, ElementSupplier<T> supplier = null, ElementState state = ElementState.Displayed) where T : IElement;
+        /// <param name="name">Child element name.</param>
+        /// <param name="supplier">Delegate that defines constructor of child element in case of custom element.</param>
+        /// <param name="state">Child element state.</param>
+        /// <returns>Instance of child element.</returns>
+        T FindChildElement<T>(By childLocator, string name = null, ElementSupplier<T> supplier = null, ElementState state = ElementState.Displayed) where T : IElement;
     }
 }

Aquality.Selenium.Core/src/Aquality.Selenium.Core/Elements/Interfaces/IParent.cs

@@ -37,6 +37,40 @@ public void Should_FindElements_ViaElementFactory()
             Assert.IsTrue(Factory.FindButtons(By.XPath("//*")).Count > 1);
         }
 
+        [Test]
+        public void Should_FindElements_WithCustomName_ViaElementFactory()
+        {
+            const string name = "Custom Name";
+            var buttons = Factory.FindButtons(By.XPath("//*"), name);
+            Assert.Multiple(() =>
+            {
+                Assert.IsTrue(buttons.Count > 1);
+                for (var i = 0; i < buttons.Count; i++)
+                {
+                    var button = buttons[i];
+                    StringAssert.StartsWith(name, button.Name);
+                    StringAssert.EndsWith((i + 1).ToString(), button.Name);
+                }
+            });
+        }
+
+        [Test]
+        public void Should_FindElements_WithDefaultName_ViaElementFactory()
+        {
+            var buttons = Factory.FindButtons(By.XPath("//*"));
+            Assert.Multiple(() =>
+            {
+                Assert.IsTrue(buttons.Count > 1);
+                for (var i = 0; i < buttons.Count; i++)
+                {
+                    var button = buttons[i];
+                    var endOfName = (i + 1).ToString();
+                    StringAssert.AreNotEqualIgnoringCase(endOfName, button.Name);
+                    StringAssert.EndsWith(endOfName, button.Name);
+                }
+            });
+        }
+
         [Test]
         public void Should_ThrowInvalidOperationException_WhenConstructorIsNotDefined_ForFindChildElement()
         {

Aquality.Selenium.Core/tests/Aquality.Selenium.Core.Tests/Applications/WindowsApp/ElementFactoryTests.cs

@@ -12,14 +12,14 @@ public static Button GetButton(this IElementFactory elementFactory, By elementLo
             return elementFactory.GetCustomElement(GetButtonSupplier(), elementLocator, elementName);
         }
 
-        public static Button FindChildButton(this IElementFactory elementFactory, IElement parentElement, By elementLocator)
+        public static Button FindChildButton(this IElementFactory elementFactory, IElement parentElement, By elementLocator, string name = null)
         {
-            return elementFactory.FindChildElement(parentElement, elementLocator, GetButtonSupplier());
+            return elementFactory.FindChildElement(parentElement, elementLocator, name, GetButtonSupplier());
         }
 
-        public static IList<Button> FindButtons(this IElementFactory elementFactory, By elementLocator, ElementsCount elementsCount = ElementsCount.MoreThenZero)
+        public static IList<Button> FindButtons(this IElementFactory elementFactory, By elementLocator, string name = null, ElementsCount elementsCount = ElementsCount.MoreThenZero)
         {
-            return elementFactory.FindElements(elementLocator, GetButtonSupplier(), elementsCount);
+            return elementFactory.FindElements(elementLocator, name: name, GetButtonSupplier(), elementsCount);
         }
 
         private static ElementSupplier<Button> GetButtonSupplier()