Tidying up the configured driver interface and removing some duped code into a default implementation in the interface away from the implementations. Simplifying the interface for the TestConfigManager (it was an unwiedly set of calls). Adding in a polling tolerant click that is based on our tolerated exception list. Adding some additional tools around the embedded jetty for the test app we use to test our helper classes

Author: travis-ci

README.md

@@ -38,7 +38,7 @@ submit an issue ticket.
 ## Documentation
 
 - A full reference guide is here: https://github.com/digital-delivery-academy/selenium-pom-framework/wiki
-- Technical reference documentation (javadocs) are here: https://digital-delivery-academy.github.io/selenium-pom-framework/javadoc-0.0.8
+- Technical reference documentation (javadocs) are here: https://digital-delivery-academy.github.io/selenium-pom-framework/javadoc-0.0.9
 
 ## Example tests
 
@@ -52,7 +52,7 @@ Put this in your POM.xml.
 <dependency>
   <groupId>uk.co.evoco</groupId>
   <artifactId>selenium-pom-framework</artifactId>
-  <version>0.0.8</version>
+  <version>0.0.9</version>
 </dependency>
 ```
 

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>uk.co.evoco</groupId>
     <artifactId>selenium-pom-framework</artifactId>
-    <version>0.0.8</version>
+    <version>0.0.9</version>
 
     <contributors>
         <contributor>

src/main/java/uk/co/evoco/pageobjects/BasePageObject.java

@@ -2,6 +2,8 @@
 
 import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.support.PageFactory;
+import org.openqa.selenium.support.ui.WebDriverWait;
+import uk.co.evoco.webdriver.configuration.TestConfigManager;
 
 /**
  * This class is a base that all page objects can inherit from.  It ensures that we have
@@ -13,6 +15,7 @@
 public abstract class BasePageObject {
 
     protected WebDriver webDriver;
+    protected WebDriverWait wait;
 
     /**
      * Initiates page elements that are declared as fields annotated @FindBy and makes the WebDriver
@@ -22,5 +25,6 @@ public abstract class BasePageObject {
     public BasePageObject(WebDriver webDriver) {
         PageFactory.initElements(webDriver, this);
         this.webDriver = webDriver;
+        this.wait = new WebDriverWait(this.webDriver, TestConfigManager.get().getWebDriverWaitTimeout());
      }
 }

src/main/java/uk/co/evoco/tests/BaseAbstractTest.java

@@ -40,7 +40,7 @@ public void setUp() throws IOException {
         this.webDriver = new WebDriverBuilder()
                 .setResultsDirectory(this.resultsManager.getScreenshotDirectory())
                 .build();
-        this.webDriver.get(TestConfigManager.getInstance().getWebDriverConfig().getBaseUrl());
+        this.webDriver.get(TestConfigManager.get().getBaseUrl());
         this.webDriver.manage().window().maximize();
     }
 

src/main/java/uk/co/evoco/webdriver/WebDriverBuilder.java

@@ -37,7 +37,7 @@ public WebDriverBuilder setResultsDirectory(File screenshotDirectory) {
      * @throws IOException if log file for browser driver logs cannot be created
      */
     public EventFiringWebDriver build() throws IOException {
-        switch(TestConfigManager.getInstance().getWebDriverConfig().getBrowserType()) {
+        switch(TestConfigManager.get().getBrowserType()) {
             case CHROME:
                 return new ConfiguredChromeDriver().getDriver(this.screenshotDirectory);
             case FIREFOX:

src/main/java/uk/co/evoco/webdriver/WebDriverListener.java

@@ -1,16 +1,13 @@
 package uk.co.evoco.webdriver;
 
 import org.apache.commons.io.FileUtils;
-import org.openqa.selenium.By;
-import org.openqa.selenium.TakesScreenshot;
-import org.openqa.selenium.OutputType;
-import org.openqa.selenium.WebDriver;
-import org.openqa.selenium.WebElement;
+import org.openqa.selenium.*;
 import org.openqa.selenium.support.events.WebDriverEventListener;
 import org.openqa.selenium.support.ui.ExpectedConditions;
 import org.openqa.selenium.support.ui.WebDriverWait;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import uk.co.evoco.webdriver.configuration.TestConfigManager;
 
 import java.io.File;
 import java.util.UUID;
@@ -26,18 +23,9 @@
  */
 public class WebDriverListener implements WebDriverEventListener {
 
-    private static long WEBDRIVER_WAIT_TIMEOUT = 30L;
     private static final Logger logger = LoggerFactory.getLogger(WebDriverListener.class);
     private File screenshotDirectory;
 
-    /**
-     * Sets the wait for all of the ExpectedConditions calls that we make here
-     * @param webDriverWaitTimeout the timeout used for WebDriverWaits
-     */
-    public void setWebdriverWaitTimeout(long webDriverWaitTimeout) {
-        this.WEBDRIVER_WAIT_TIMEOUT = webDriverWaitTimeout;
-    }
-
     /**
      * Sets the screenshot target directory that will be used for screenshots generated inside onException()
      * @param screenshotDirectory the path to the screenshot directory used in onException
@@ -153,7 +141,7 @@ public void afterNavigateRefresh(WebDriver webDriver) {
      * @param webDriver active WebDriver instance
      */
     public void beforeFindBy(By by, WebElement webElement, WebDriver webDriver) {
-        new WebDriverWait(webDriver, WEBDRIVER_WAIT_TIMEOUT).until(ExpectedConditions.presenceOfElementLocated(by));
+        new WebDriverWait(webDriver, TestConfigManager.get().getWebDriverWaitTimeout()).until(ExpectedConditions.presenceOfElementLocated(by));
     }
 
     /**
@@ -176,7 +164,7 @@ public void afterFindBy(By by, WebElement webElement, WebDriver webDriver) {
      * @param webDriver active WebDriver instance
      */
     public void beforeClickOn(WebElement webElement, WebDriver webDriver) {
-        new WebDriverWait(webDriver, WEBDRIVER_WAIT_TIMEOUT).until(ExpectedConditions.elementToBeClickable(webElement));
+        new WebDriverWait(webDriver, TestConfigManager.get().getWebDriverWaitTimeout()).until(ExpectedConditions.elementToBeClickable(webElement));
     }
 
     /**

src/main/java/uk/co/evoco/webdriver/configuration/TestConfigManager.java

@@ -6,7 +6,7 @@
 public class TestConfigManager {
 
     private static TestConfigManager testConfigManager;
-    private WebDriverConfig webDriverConfig;
+    private static WebDriverConfig webDriverConfig;
 
     /**
      *
@@ -21,18 +21,10 @@ private TestConfigManager() {
      *
      * @return TestConfigManager returns the instance of the singleton to access the member methods
      */
-    public static TestConfigManager getInstance() {
+    public static WebDriverConfig get() {
         if(null == testConfigManager) {
             testConfigManager = new TestConfigManager();
         }
-        return testConfigManager;
-    }
-
-    /**
-     *
-     * @return provides the globally available WebDriverConfig
-     */
-    public WebDriverConfig getWebDriverConfig() {
         return webDriverConfig;
     }
 }

src/main/java/uk/co/evoco/webdriver/configuration/driver/ConfiguredChromeDriver.java

@@ -2,14 +2,11 @@
 
 import io.github.bonigarcia.wdm.WebDriverManager;
 import org.openqa.selenium.WebDriver;
-import org.openqa.selenium.WebDriverException;
 import org.openqa.selenium.chrome.ChromeDriver;
 import org.openqa.selenium.chrome.ChromeOptions;
 import org.openqa.selenium.remote.RemoteWebDriver;
-import org.openqa.selenium.support.events.EventFiringWebDriver;
 import uk.co.evoco.webdriver.configuration.TestConfigManager;
 
-import java.io.File;
 import java.io.IOException;
 
 public class ConfiguredChromeDriver implements ConfiguredDriver {
@@ -20,7 +17,7 @@ public class ConfiguredChromeDriver implements ConfiguredDriver {
      */
     public WebDriver getRemoteDriver() {
         return new RemoteWebDriver(
-                TestConfigManager.getInstance().getWebDriverConfig().getGridConfig().getGridUrl(), this.getOptions());
+                TestConfigManager.get().getGridConfig().getGridUrl(), this.getOptions());
     }
 
     /**
@@ -41,32 +38,7 @@ public WebDriver getLocalDriver() throws IOException {
      */
     private ChromeOptions getOptions() {
         ChromeOptions chromeOptions = new ChromeOptions();
-        chromeOptions.setHeadless(TestConfigManager.getInstance().getWebDriverConfig().isHeadless());
+        chromeOptions.setHeadless(TestConfigManager.get().isHeadless());
         return chromeOptions;
     }
-
-    /**
-     *
-     * @param screenshotPath path to store screenshots
-     * @return configured EventFiringWebDriver
-     * @throws IOException if log directory doesn't exist
-     */
-    @Override
-    public EventFiringWebDriver getDriver(File screenshotPath) throws IOException {
-        WebDriver webDriver;
-        switch(TestConfigManager.getInstance().getWebDriverConfig().getRunType()) {
-            case LOCAL:
-                webDriver = getLocalDriver();
-                break;
-            case GRID:
-                webDriver = getRemoteDriver();
-                break;
-            default:
-                throw new WebDriverException("Must set runType to either LOCAL or GRID in configuration file");
-        }
-        return configureEventFiringWebDriver(
-                webDriver,
-                TestConfigManager.getInstance().getWebDriverConfig().getWebDriverWaitTimeout(),
-                screenshotPath);
-    }
 }

src/main/java/uk/co/evoco/webdriver/configuration/driver/ConfiguredDriver.java

@@ -2,21 +2,42 @@
 
 import org.apache.commons.io.FileUtils;
 import org.openqa.selenium.WebDriver;
+import org.openqa.selenium.WebDriverException;
 import org.openqa.selenium.support.events.EventFiringWebDriver;
 import uk.co.evoco.webdriver.WebDriverListener;
+import uk.co.evoco.webdriver.configuration.TestConfigManager;
 
 import java.io.File;
 import java.io.IOException;
 
 public interface ConfiguredDriver {
 
+     WebDriver getLocalDriver() throws IOException;
+     WebDriver getRemoteDriver();
+
     /**
-     *
+     *ß
      * @param screenshotPath path to store screenshots
      * @return configured EventFiringWebDriver
      * @throws IOException if log directory doesn't exist
      */
-    EventFiringWebDriver getDriver(File screenshotPath) throws IOException;
+    default EventFiringWebDriver getDriver(File screenshotPath) throws IOException {
+        WebDriver webDriver;
+        switch(TestConfigManager.get().getRunType()) {
+            case LOCAL:
+                webDriver = getLocalDriver();
+                break;
+            case GRID:
+                webDriver = getRemoteDriver();
+                break;
+            default:
+                throw new WebDriverException("Must set runType to either LOCAL or GRID in configuration file");
+        }
+        return configureEventFiringWebDriver(
+                webDriver,
+                TestConfigManager.get().getWebDriverWaitTimeout(),
+                screenshotPath);
+    }
 
     /**
      *
@@ -29,7 +50,6 @@ default EventFiringWebDriver configureEventFiringWebDriver(
             WebDriver webDriver, long timeout, File screenshotDirectory) {
         EventFiringWebDriver eventFiringWebDriver = new EventFiringWebDriver(webDriver);
         WebDriverListener eventListener = new WebDriverListener();
-        eventListener.setWebdriverWaitTimeout(timeout);
         eventListener.setScreenshotDirectory(screenshotDirectory);
         eventFiringWebDriver.register(eventListener);
 

src/main/java/uk/co/evoco/webdriver/configuration/driver/ConfiguredEdgeDriver.java

@@ -2,15 +2,11 @@
 
 import io.github.bonigarcia.wdm.WebDriverManager;
 import org.openqa.selenium.WebDriver;
-import org.openqa.selenium.WebDriverException;
 import org.openqa.selenium.edge.EdgeDriver;
 import org.openqa.selenium.edge.EdgeOptions;
 import org.openqa.selenium.remote.RemoteWebDriver;
-import org.openqa.selenium.support.events.EventFiringWebDriver;
 import uk.co.evoco.webdriver.configuration.TestConfigManager;
 
-import java.io.File;
-
 public class ConfiguredEdgeDriver implements ConfiguredDriver {
 
     /**
@@ -19,7 +15,7 @@ public class ConfiguredEdgeDriver implements ConfiguredDriver {
      */
     public WebDriver getRemoteDriver() {
         return new RemoteWebDriver(
-                TestConfigManager.getInstance().getWebDriverConfig().getGridConfig().getGridUrl(), this.getOptions());
+                TestConfigManager.get().getGridConfig().getGridUrl(), this.getOptions());
     }
 
     /**
@@ -38,28 +34,4 @@ public WebDriver getLocalDriver() {
     public EdgeOptions getOptions() {
         return new EdgeOptions();
     }
-
-    /**
-     *
-     * @param screenshotPath path to store screenshots
-     * @return configured EventFiringWebDriver
-     */
-    @Override
-    public EventFiringWebDriver getDriver(File screenshotPath) {
-        WebDriver webDriver;
-        switch(TestConfigManager.getInstance().getWebDriverConfig().getRunType()) {
-            case LOCAL:
-                webDriver = getLocalDriver();
-                break;
-            case GRID:
-                webDriver = getRemoteDriver();
-                break;
-            default:
-                throw new WebDriverException("Must set runType to either LOCAL or GRID in configuration file");
-        }
-        return configureEventFiringWebDriver(
-                webDriver,
-                TestConfigManager.getInstance().getWebDriverConfig().getWebDriverWaitTimeout(),
-                screenshotPath);
-    }
 }