Extract interface from ConditionalWait (#55)

* Extract interface from ConditionalWait

* Correct thrown exception type at CachedElementStateProvider

Author: mialeska

Aquality.Selenium.Core/src/Aquality.Selenium.Core/Applications/Startup.cs

@@ -40,7 +40,7 @@ public virtual IServiceCollection ConfigureServices(IServiceCollection services,
             services.AddSingleton<ILocalizedLogger, LocalizedLogger>();
             services.AddSingleton<IElementActionRetrier, ElementActionRetrier>();
 
-            services.AddTransient<ConditionalWait>();
+            services.AddTransient<IConditionalWait, ConditionalWait>();
             services.AddTransient<IElementFinder, ElementFinder>();
             services.AddTransient<IElementFactory, ElementFactory>();
             return services;

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

@@ -11,10 +11,10 @@ namespace Aquality.Selenium.Core.Elements
     public class CachedElementStateProvider : IElementStateProvider
     {
         private readonly IElementCacheHandler elementCacheHandler;
-        private readonly ConditionalWait conditionalWait;
+        private readonly IConditionalWait conditionalWait;
         private readonly By locator;
 
-        public CachedElementStateProvider(By locator, ConditionalWait conditionalWait, IElementCacheHandler elementCacheHandler)
+        public CachedElementStateProvider(By locator, IConditionalWait conditionalWait, IElementCacheHandler elementCacheHandler)
         {
             this.elementCacheHandler = elementCacheHandler;
             this.conditionalWait = conditionalWait;
@@ -50,7 +50,15 @@ protected virtual bool TryInvokeFunction(Func<IWebElement, bool> func)
         public virtual void WaitForClickable(TimeSpan? timeout = null)
         {
             var errorMessage = $"Element {locator} has not become clickable after timeout.";
-            conditionalWait.WaitForTrue(() => IsClickable, timeout, message: errorMessage);
+            try
+            {
+                conditionalWait.WaitForTrue(() => IsClickable, timeout, message: errorMessage);
+            }
+            catch (TimeoutException e)
+            {
+                throw new WebDriverTimeoutException(e.Message, e);
+            }
+            
         }
 
         public virtual bool WaitForDisplayed(TimeSpan? timeout = null)

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

@@ -53,7 +53,7 @@ protected virtual IElementCacheHandler Cache
 
         protected abstract IElementCacheConfiguration CacheConfiguration { get; }
 
-        protected abstract ConditionalWait ConditionalWait { get; }
+        protected abstract IConditionalWait ConditionalWait { get; }
 
         protected abstract string ElementType { get; }
 

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

@@ -17,14 +17,14 @@ public class ElementFactory : IElementFactory
     {
         private const string ByXpathIdentifier = "By.XPath";
 
-        public ElementFactory(ConditionalWait conditionalWait, IElementFinder elementFinder, ILocalizationManager localizationManager)
+        public ElementFactory(IConditionalWait conditionalWait, IElementFinder elementFinder, ILocalizationManager localizationManager)
         {
             ConditionalWait = conditionalWait;
             ElementFinder = elementFinder;
             LocalizationManager = localizationManager;
         }
 
-        protected ConditionalWait ConditionalWait { get; }
+        protected IConditionalWait ConditionalWait { get; }
 
         protected IElementFinder ElementFinder { get; }
 

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

@@ -14,15 +14,15 @@ namespace Aquality.Selenium.Core.Elements
     /// </summary>
     public class ElementFinder : IElementFinder
     {
-        public ElementFinder(ILocalizedLogger logger, ConditionalWait conditionalWait)
+        public ElementFinder(ILocalizedLogger logger, IConditionalWait conditionalWait)
         {
             Logger = logger;
             ConditionalWait = conditionalWait;
         }
 
         private ILocalizedLogger Logger { get; }
 
-        private ConditionalWait ConditionalWait { get; }
+        private IConditionalWait ConditionalWait { get; }
 
         public virtual IWebElement FindElement(By locator, ElementState state = ElementState.ExistsInAnyState, TimeSpan? timeout = null)
         {

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

@@ -10,14 +10,14 @@ public class ElementStateProvider : IElementStateProvider
     {
         private readonly By elementLocator;
 
-        public ElementStateProvider(By elementLocator, ConditionalWait conditionalWait, IElementFinder elementFinder)
+        public ElementStateProvider(By elementLocator, IConditionalWait conditionalWait, IElementFinder elementFinder)
         {
             this.elementLocator = elementLocator;
             ConditionalWait = conditionalWait;
             ElementFinder = elementFinder;
         }
 
-        private ConditionalWait ConditionalWait { get; }
+        private IConditionalWait ConditionalWait { get; }
 
         private IElementFinder ElementFinder { get; }
 

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

@@ -14,14 +14,14 @@ namespace Aquality.Selenium.Core.Elements
     /// </summary>
     public class RelativeElementFinder : ElementFinder
     {
-        public RelativeElementFinder(ILocalizedLogger logger, ConditionalWait conditionalWait, Func<ISearchContext> searchContextSupplier) 
+        public RelativeElementFinder(ILocalizedLogger logger, IConditionalWait conditionalWait, Func<ISearchContext> searchContextSupplier) 
             : base(logger, conditionalWait)
         {
             ConditionalWait = conditionalWait;
             SearchContextSupplier = searchContextSupplier;
         }
 
-        private ConditionalWait ConditionalWait { get; }
+        private IConditionalWait ConditionalWait { get; }
 
         private Func<ISearchContext> SearchContextSupplier { get; }
 

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

@@ -12,9 +12,9 @@
 namespace Aquality.Selenium.Core.Waitings
 {
     /// <summary>
-    /// This class is using for waiting any conditions.
+    /// This class is used for waiting any conditions.
     /// </summary>
-    public class ConditionalWait
+    public class ConditionalWait : IConditionalWait
     {
         private readonly ITimeoutConfiguration timeoutConfiguration;
         private readonly IServiceProvider serviceProvider;
@@ -68,18 +68,15 @@ public T WaitFor<T>(Func<IWebDriver, T> condition, TimeSpan? timeout = null, Tim
         /// <param name="condition">Predicate for waiting</param>
         /// <param name="timeout">Condition timeout. Default value is <see cref="ITimeoutConfiguration.Condition"/></param>
         /// <param name="pollingInterval">Condition check interval. Default value is <see cref="ITimeoutConfiguration.PollingInterval"/></param>
+        /// <param name="exceptionsToIgnore">Possible exceptions that have to be ignored. </param>
         /// <returns>True if condition satisfied and false otherwise.</returns>
-        public bool WaitFor(Func<bool> condition, TimeSpan? timeout = null, TimeSpan? pollingInterval = null)
+        public bool WaitFor(Func<bool> condition, TimeSpan? timeout = null, TimeSpan? pollingInterval = null, IList<Type> exceptionsToIgnore = null)
         {
-            try
+            return IsConditionSatisfied(() =>
             {
-                WaitForTrue(condition, timeout, pollingInterval);
+                WaitForTrue(condition, timeout, pollingInterval, exceptionsToIgnore: exceptionsToIgnore);
                 return true;
-            }
-            catch (TimeoutException)
-            {
-                return false;
-            }
+            }, new List<Type> { typeof(TimeoutException) });
         }
 
         /// <summary>
@@ -89,8 +86,9 @@ public bool WaitFor(Func<bool> condition, TimeSpan? timeout = null, TimeSpan? po
         /// <param name="timeout">Condition timeout. Default value is <see cref="ITimeoutConfiguration.Condition"/></param>
         /// <param name="pollingInterval">Condition check interval. Default value is <see cref="ITimeoutConfiguration.PollingInterval"/></param>
         /// <param name="message">Part of error message in case of Timeout exception</param>
+        /// <param name="exceptionsToIgnore">Possible exceptions that have to be ignored. </param>
         /// <exception cref="TimeoutException">Throws when timeout exceeded and condition not satisfied.</exception>
-        public void WaitForTrue(Func<bool> condition, TimeSpan? timeout = null, TimeSpan? pollingInterval = null, string message = null)
+        public void WaitForTrue(Func<bool> condition, TimeSpan? timeout = null, TimeSpan? pollingInterval = null, string message = null, IList<Type> exceptionsToIgnore = null)
         {
             if (condition == null)
             {
@@ -102,7 +100,7 @@ public void WaitForTrue(Func<bool> condition, TimeSpan? timeout = null, TimeSpan
             var stopwatch = Stopwatch.StartNew();
             while (true)
             {
-                if (condition())
+                if (IsConditionSatisfied(condition, exceptionsToIgnore ?? new List<Type>()))
                 {
                     return;
                 }
@@ -122,6 +120,23 @@ public void WaitForTrue(Func<bool> condition, TimeSpan? timeout = null, TimeSpan
             }
         }
 
+        private bool IsConditionSatisfied(Func<bool> condition, IList<Type> exceptionsToIgnore)
+        {
+            try
+            {
+                return condition();
+            }
+            catch (Exception exception)
+            {
+                if (exceptionsToIgnore.Any(type => type.IsAssignableFrom(exception.GetType())))
+                {
+                    return false;
+                }
+
+                throw;
+            }
+        }
+
         private TimeSpan ResolveConditionTimeout(TimeSpan? timeout)
         {
             return timeout ?? timeoutConfiguration.Condition;

Aquality.Selenium.Core/src/Aquality.Selenium.Core/Waitings/ConditionalWait.cs

@@ -0,0 +1,47 @@
+using Aquality.Selenium.Core.Configurations;
+using OpenQA.Selenium;
+using System;
+using System.Collections.Generic;
+
+namespace Aquality.Selenium.Core.Waitings
+{
+    /// <summary>
+    /// Utility used to wait for some condition.
+    /// </summary>
+    public interface IConditionalWait
+    {
+        /// <summary>
+        /// Wait for some condition within timeout.
+        /// </summary>
+        /// <param name="condition">Predicate for waiting</param>
+        /// <param name="timeout">Condition timeout. Default value is <see cref="ITimeoutConfiguration.Condition"/></param>
+        /// <param name="pollingInterval">Condition check interval. Default value is <see cref="ITimeoutConfiguration.PollingInterval"/></param>
+        /// <param name="exceptionsToIgnore">Possible exceptions that have to be ignored. </param>
+        /// <returns>True if condition satisfied and false otherwise.</returns>
+        bool WaitFor(Func<bool> condition, TimeSpan? timeout = null, TimeSpan? pollingInterval = null, IList<Type> exceptionsToIgnore = null);
+        
+        /// <summary>
+        /// Wait for some object from condition with timeout using Selenium WebDriver.
+        /// </summary>
+        /// <typeparam name="T">Type of object which is waiting for</typeparam>
+        /// <param name="condition">Function for waiting</param>
+        /// <param name="timeout">Condition timeout. Default value is <see cref="ITimeoutConfiguration.Condition"/></param>
+        /// <param name="pollingInterval">Condition check interval. Default value is <see cref="ITimeoutConfiguration.PollingInterval"/></param>
+        /// <param name="message">Part of error message in case of Timeout exception</param>
+        /// <param name="exceptionsToIgnore">Possible exceptions that have to be ignored. Handles <see cref="StaleElementReferenceException"/> by default.</param>
+        /// <returns>Condition result which is waiting for.</returns>
+        /// <exception cref="WebDriverTimeoutException">Throws when timeout exceeded and condition not satisfied.</exception>
+        T WaitFor<T>(Func<IWebDriver, T> condition, TimeSpan? timeout = null, TimeSpan? pollingInterval = null, string message = null, IList<Type> exceptionsToIgnore = null);
+
+        /// <summary>
+        /// Wait for some condition within timeout.
+        /// </summary>
+        /// <param name="condition">Predicate for waiting</param>
+        /// <param name="timeout">Condition timeout. Default value is <see cref="ITimeoutConfiguration.Condition"/></param>
+        /// <param name="pollingInterval">Condition check interval. Default value is <see cref="ITimeoutConfiguration.PollingInterval"/></param>
+        /// <param name="message">Part of error message in case of Timeout exception</param>
+        /// <param name="exceptionsToIgnore">Possible exceptions that have to be ignored. </param>
+        /// <exception cref="TimeoutException">Throws when timeout exceeded and condition not satisfied.</exception>
+        void WaitForTrue(Func<bool> condition, TimeSpan? timeout = null, TimeSpan? pollingInterval = null, string message = null, IList<Type> exceptionsToIgnore = null);
+    }
+}