Merge pull request #23 from digital-delivery-academy/tolerant-click-new-feature-#22

Adding new tolerantClick method

Author: stevewalton28

src/main/java/uk/co/evoco/webdriver/utils/ClickUtils.java

@@ -1,5 +1,6 @@
 package uk.co.evoco.webdriver.utils;
 
+import org.openqa.selenium.By;
 import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.WebElement;
 import org.openqa.selenium.support.ui.ExpectedConditions;
@@ -50,7 +51,45 @@ public static void tolerantClick(WebDriver webDriver, WebElement webElement) thr
         }
     }
 
+    /**
+     *
+     * Use this method if you're experiencing exceptions that are UN-FIXABLE in your application
+     * and you find that you're getting intermittent (and unhelpful) exceptions.
+     *
+     * This method takes its configuration from the configuration file (see documentation for how to add exceptions
+     * to the list of exceptions that this method will tolerate).
+     *
+     * It retries only once and waits for 3 seconds.  This may become configurable in the future.
+     *
+     * @param webDriver active WebDriver instance
+     * @param locator locator we will use to re-lookup the element on retry
+     * @throws InterruptedException
+     */
+    public static void tolerantClick(WebDriver webDriver, By locator) throws InterruptedException {
+        try {
+            click(webDriver, locator, TestConfigManager.getInstance().getWebDriverConfig().getWebDriverWaitTimeout());
+        } catch(Exception e) {
+            logger.error("Encountered an issue while trying to click, will check to see if we tolerate this exception. Debug this issue to make your tests more stable. Stacktrace follows.");
+            e.printStackTrace();
+            for(String exceptionToHandle : TestConfigManager.getInstance().getWebDriverConfig().getExceptionsToHandleOnTolerantActions()) {
+                if(e.getClass().getName().contains(exceptionToHandle)) {
+                    logger.error("Exception {} is tolerated, retrying after a 3 second wait", exceptionToHandle);
+                    Thread.sleep(3);
+                    logger.error("Waited 3 seconds after {}, now retrying", exceptionToHandle);
+                    click(webDriver, locator, TestConfigManager.getInstance().getWebDriverConfig().getWebDriverWaitTimeout());
+                }
+            }
+            // Can't handle the exception with a retry so re-throwing the exception
+            throw e;
+        }
+    }
+
     private static void click(WebDriver webDriver, WebElement webElement, long timeout) {
         new WebDriverWait(webDriver, timeout).until(ExpectedConditions.elementToBeClickable(webElement)).click();
     }
+
+    private static void click(WebDriver webDriver, By locator, long timeout) {
+        WebElement webElement = webDriver.findElement(locator);
+        new WebDriverWait(webDriver, timeout).until(ExpectedConditions.elementToBeClickable(webElement)).click();
+    }
 }