Enhanced logging of elements search failure (#91)

* Enhanced logging of elements search failure

Author: mialeska

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

@@ -45,7 +45,7 @@ protected virtual IElementCacheHandler Cache
             {
                 if (elementCacheHandler == null)
                 {
-                    elementCacheHandler = new ElementCacheHandler(Locator, elementState, Finder);
+                    elementCacheHandler = new ElementCacheHandler(Locator, Name, elementState, Finder);
                 }
 
                 return elementCacheHandler;
@@ -124,7 +124,7 @@ public virtual RemoteWebElement GetElement(TimeSpan? timeout = null)
             {
                 return CacheConfiguration.IsEnabled
                     ? Cache.GetElement(timeout)
-                    : (RemoteWebElement) Finder.FindElement(Locator, elementState, timeout);
+                    : (RemoteWebElement) Finder.FindElement(Locator, elementState, timeout, Name);
             }
             catch (NoSuchElementException ex) when (LoggerConfiguration.LogPageSource)
             {

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

@@ -8,14 +8,16 @@ namespace Aquality.Selenium.Core.Elements
     public class ElementCacheHandler : IElementCacheHandler
     {
         private readonly By locator;
+        private readonly string name;
         private readonly ElementState state;
         private readonly IElementFinder elementFinder;
 
         private RemoteWebElement remoteElement;
 
-        public ElementCacheHandler(By locator, ElementState state, IElementFinder finder)
+        public ElementCacheHandler(By locator, string name, ElementState state, IElementFinder finder)
         {
             this.locator = locator;
+            this.name = name;
             this.state = state;
             elementFinder = finder;
         }
@@ -46,7 +48,7 @@ public RemoteWebElement GetElement(TimeSpan? timeout = null, ElementState? custo
 
             if (IsRefreshNeeded(customState))
             {
-                remoteElement = (RemoteWebElement)elementFinder.FindElement(locator, customState ?? state, timeout);
+                remoteElement = (RemoteWebElement)elementFinder.FindElement(locator, customState ?? state, timeout, name);
             }
 
             return remoteElement;

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

@@ -56,21 +56,21 @@ public virtual IList<T> FindElements<T>(By locator, string name = null, ElementS
             switch (expectedCount)
             {
                 case ElementsCount.Zero:
-                    ConditionalWait.WaitForTrue(() => !ElementFinder.FindElements(locator, state, TimeSpan.Zero).Any(), 
-                        message: LocalizationManager.GetLocalizedMessage("loc.elements.found.but.should.not", locator.ToString(), state.ToString()));
+                    ConditionalWait.WaitForTrue(() => !ElementFinder.FindElements(locator, state, TimeSpan.Zero, name).Any(), 
+                        message: LocalizationManager.GetLocalizedMessage("loc.elements.with.name.found.but.should.not", name, locator.ToString(), state.ToString()));
                     break;
                 case ElementsCount.MoreThenZero:
-                    ConditionalWait.WaitForTrue(() => ElementFinder.FindElements(locator, state, TimeSpan.Zero).Any(), 
-                        message: LocalizationManager.GetLocalizedMessage("loc.no.elements.found.by.locator", locator.ToString()));
+                    ConditionalWait.WaitForTrue(() => ElementFinder.FindElements(locator, state, TimeSpan.Zero, name).Any(), 
+                        message: LocalizationManager.GetLocalizedMessage("loc.no.elements.with.name.found.by.locator", name, locator.ToString()));
                     break;
                 case ElementsCount.Any:
-                    ConditionalWait.WaitFor(() => ElementFinder.FindElements(locator, state, TimeSpan.Zero) != null);
+                    ConditionalWait.WaitFor(() => ElementFinder.FindElements(locator, state, TimeSpan.Zero, name) != null);
                     break;
                 default:
                     throw new ArgumentOutOfRangeException($"No such expected value: {expectedCount}");
             }
 
-            var webElements = ElementFinder.FindElements(locator, state, TimeSpan.Zero);
+            var webElements = ElementFinder.FindElements(locator, state, TimeSpan.Zero, name);
             IEnumerable<T> elements = webElements.Select((webElement, index) =>
             {
                 var elementIndex = index + 1;

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

@@ -24,44 +24,44 @@ public ElementFinder(ILocalizedLogger logger, IConditionalWait conditionalWait)
 
         private IConditionalWait ConditionalWait { get; }
 
-        public virtual IWebElement FindElement(By locator, ElementState state = ElementState.ExistsInAnyState, TimeSpan? timeout = null)
+        public virtual IWebElement FindElement(By locator, ElementState state = ElementState.ExistsInAnyState, TimeSpan? timeout = null, string name = null)
         {
             var desiredState = ResolveState(state);
-            return FindElement(locator, desiredState.ElementStateCondition, desiredState.StateName, timeout);
+            return FindElement(locator, desiredState.ElementStateCondition, desiredState.StateName, timeout, name);
         }
 
-        public virtual IWebElement FindElement(By locator, Func<IWebElement, bool> elementStateCondition, TimeSpan? timeout = null)
+        public virtual IWebElement FindElement(By locator, Func<IWebElement, bool> elementStateCondition, TimeSpan? timeout = null, string name = null)
         {
-            return FindElement(locator, elementStateCondition, "desired", timeout);
+            return FindElement(locator, elementStateCondition, "desired", timeout, name);
         }
 
-        public virtual IWebElement FindElement(By locator, Func<IWebElement, bool> elementStateCondition, string stateName, TimeSpan? timeout = null)
+        public virtual IWebElement FindElement(By locator, Func<IWebElement, bool> elementStateCondition, string stateName, TimeSpan? timeout = null, string name = null)
         {
             var desiredState = new DesiredState(elementStateCondition, stateName)
             {
                 IsCatchingTimeoutException = false,
                 IsThrowingNoSuchElementException = true
             };
-            return FindElements(locator, desiredState, timeout).First();
+            return FindElements(locator, desiredState, timeout, name).First();
         }
 
-        public virtual ReadOnlyCollection<IWebElement> FindElements(By locator, ElementState state = ElementState.ExistsInAnyState, TimeSpan? timeout = null)
+        public virtual ReadOnlyCollection<IWebElement> FindElements(By locator, ElementState state = ElementState.ExistsInAnyState, TimeSpan? timeout = null, string name = null)
         {
             var elementStateCondition = ResolveState(state);
             elementStateCondition.IsCatchingTimeoutException = true;
-            return FindElements(locator, elementStateCondition, timeout);
+            return FindElements(locator, elementStateCondition, timeout, name);
         }
 
-        public virtual ReadOnlyCollection<IWebElement> FindElements(By locator, Func<IWebElement, bool> elementStateCondition, TimeSpan? timeout = null)
+        public virtual ReadOnlyCollection<IWebElement> FindElements(By locator, Func<IWebElement, bool> elementStateCondition, TimeSpan? timeout = null, string name = null)
         {
             var desiredState = new DesiredState(elementStateCondition, "desired")
             {
-                IsCatchingTimeoutException = true
+                IsCatchingTimeoutException = true,
             };
-            return FindElements(locator, desiredState, timeout);
+            return FindElements(locator, desiredState, timeout, name);
         }
 
-        public virtual ReadOnlyCollection<IWebElement> FindElements(By locator, DesiredState desiredState, TimeSpan? timeout = null)
+        public virtual ReadOnlyCollection<IWebElement> FindElements(By locator, DesiredState desiredState, TimeSpan? timeout = null, string name = null)
         {
             var foundElements = new List<IWebElement>();
             var resultElements = new List<IWebElement>();
@@ -76,14 +76,16 @@ public virtual ReadOnlyCollection<IWebElement> FindElements(By locator, DesiredS
             }
             catch (WebDriverTimeoutException ex)
             {
-                HandleTimeoutException(ex, desiredState, locator, foundElements);
+                HandleTimeoutException(ex, desiredState, locator, foundElements, name);
             }
             return resultElements.AsReadOnly();
         }
 
-        protected virtual void HandleTimeoutException(WebDriverTimeoutException ex, DesiredState desiredState, By locator, List<IWebElement> foundElements)
+        protected virtual void HandleTimeoutException(WebDriverTimeoutException ex, DesiredState desiredState, By locator, List<IWebElement> foundElements, string name = null)
         {
-            var message = $"No elements with locator '{locator.ToString()}' were found in {desiredState.StateName} state";
+            var message = string.IsNullOrEmpty(name) 
+                ? $"No elements with locator '{locator}' were found in {desiredState.StateName} state"
+                : $"Element [{name}] was not found by locator '{locator}' in {desiredState.StateName} state";
             if (desiredState.IsCatchingTimeoutException)
             {
                 if (!foundElements.Any())
@@ -101,12 +103,11 @@ protected virtual void HandleTimeoutException(WebDriverTimeoutException ex, Desi
             }
             else
             {
-                var combinedMessage = $"{ex.Message}: {message}";
                 if (desiredState.IsThrowingNoSuchElementException && !foundElements.Any())
                 {
-                    throw new NoSuchElementException(combinedMessage);
+                    throw new NoSuchElementException($"{message}: {ex.Message}");
                 }
-                throw new WebDriverTimeoutException(combinedMessage);
+                throw new WebDriverTimeoutException($"{ex.Message}: {message}");
             }
         }
 

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

@@ -16,45 +16,50 @@ public interface IElementFinder
         /// <param name="locator">element locator</param>
         /// <param name="state">desired ElementState</param>
         /// <param name="timeout">timeout for search</param>
+        /// <param name="name">element name to be used for logging and exception message</param>
         /// <exception cref="NoSuchElementException">Thrown if element was not found in time in desired state</exception> 
         /// <returns>Found element</returns>
-        IWebElement FindElement(By locator, ElementState state = ElementState.ExistsInAnyState, TimeSpan? timeout = null);
+        IWebElement FindElement(By locator, ElementState state = ElementState.ExistsInAnyState, TimeSpan? timeout = null, string name = null);
 
         /// <summary>
         /// Finds element in state defined by predicate.
         /// </summary>
         /// <param name="locator">elements locator</param>
         /// <param name="elementStateCondition">predicate to define element state</param>
         /// <param name="timeout">timeout for search</param>
+        /// <param name="name">element name to be used for logging and exception message</param>
         /// <exception cref="NoSuchElementException">Thrown if element was not found in time in desired state</exception> 
         /// <returns>Found element</returns>
-        IWebElement FindElement(By locator, Func<IWebElement, bool> elementStateCondition, TimeSpan? timeout = null);
+        IWebElement FindElement(By locator, Func<IWebElement, bool> elementStateCondition, TimeSpan? timeout = null, string name = null);
 
         /// <summary>
         /// Finds elements in desired ElementState.
         /// </summary>
         /// <param name="locator">elements locator</param>
         /// <param name="state">desired ElementState</param>
         /// <param name="timeout">timeout for search</param>
+        /// <param name="name">elements' name to be used for logging and exception message</param>
         /// <returns>List of found elements</returns>
-        ReadOnlyCollection<IWebElement> FindElements(By locator, ElementState state = ElementState.ExistsInAnyState, TimeSpan? timeout = null);
+        ReadOnlyCollection<IWebElement> FindElements(By locator, ElementState state = ElementState.ExistsInAnyState, TimeSpan? timeout = null, string name = null);
 
         /// <summary>
         /// Finds elements in state defined by predicate.
         /// </summary>
         /// <param name="locator">elements locator</param>
         /// <param name="elementStateCondition">predicate to define elements state</param>
         /// <param name="timeout">timeout for search</param>
+        /// <param name="name">elements' name to be used for logging and exception message</param>
         /// <returns>List of found elements</returns>
-        ReadOnlyCollection<IWebElement> FindElements(By locator, Func<IWebElement, bool> elementStateCondition, TimeSpan? timeout = null);
+        ReadOnlyCollection<IWebElement> FindElements(By locator, Func<IWebElement, bool> elementStateCondition, TimeSpan? timeout = null, string name = null);
 
         /// <summary>
         /// Finds elements in state defined by desired state.
         /// </summary>
         /// <param name="locator">elements locator</param>
         /// <param name="desiredState">desired elements state</param>
         /// <param name="timeout">timeout for search</param>
+        /// <param name="name">elements' name to be used for logging and exception message</param>
         /// <returns>List of found elements</returns>
-        ReadOnlyCollection<IWebElement> FindElements(By locator, DesiredState desiredState, TimeSpan? timeout = null);
+        ReadOnlyCollection<IWebElement> FindElements(By locator, DesiredState desiredState, TimeSpan? timeout = null, string name = null);
     }
 }

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

@@ -25,7 +25,7 @@ public RelativeElementFinder(ILocalizedLogger logger, IConditionalWait condition
 
         private Func<ISearchContext> SearchContextSupplier { get; }
 
-        public override ReadOnlyCollection<IWebElement> FindElements(By locator, DesiredState desiredState, TimeSpan? timeout = null)
+        public override ReadOnlyCollection<IWebElement> FindElements(By locator, DesiredState desiredState, TimeSpan? timeout = null, string name = null)
         {
             var foundElements = new List<IWebElement>();
             var resultElements = new List<IWebElement>();
@@ -40,7 +40,7 @@ public override ReadOnlyCollection<IWebElement> FindElements(By locator, Desired
             }
             catch (TimeoutException ex)
             {
-                HandleTimeoutException(new WebDriverTimeoutException(ex.Message, ex), desiredState, locator, foundElements);
+                HandleTimeoutException(new WebDriverTimeoutException(ex.Message, ex), desiredState, locator, foundElements, name);
             }
             return resultElements.AsReadOnly();
         }