added support for EventFiringWebDriver

gmkumar2005 · gmkumar2005 · commit e39e487e6ffc · 2018-04-28T09:07:13.000+05:30
diff --git a/src/main/java/io/github/seleniumquery/browser/driver/DriverBuilder.java b/src/main/java/io/github/seleniumquery/browser/driver/DriverBuilder.java
@@ -16,12 +16,12 @@
 package io.github.seleniumquery.browser.driver;
 
 import java.util.function.Consumer;
-
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.remote.DesiredCapabilities;
-
+import org.openqa.selenium.support.events.EventFiringWebDriver;
+import org.openqa.selenium.support.events.WebDriverEventListener;
 import io.github.bonigarcia.wdm.WebDriverManager;
 
 /**
@@ -42,6 +42,8 @@ public abstract class DriverBuilder<T extends DriverBuilder<T>> {
 
     private boolean autoQuitAskedFor = false;
 
+    private WebDriverEventListener webDriverEventListener;
+
     /**
      * Configures the driver with the given capabilities.
      * @param desiredCapabilities The capabilities to be set.
@@ -144,4 +146,27 @@ protected void autoQuitDriverIfAskedFor(WebDriver driver) {
         }
     }
 
+    /**
+     * Configures the driver with the given WebDriverEventListener.
+     *
+     * @param webDriverEventListener The webDriverEventListener to be set.
+     * @return A self reference for further configuration.
+     * @since 0.18.0
+     */
+    @SuppressWarnings("unchecked")
+    public T withWebDriverEventListener(WebDriverEventListener webDriverEventListener) {
+        this.webDriverEventListener = webDriverEventListener;
+        return (T) this;
+    }
+
+    protected WebDriver attatchEventListner(WebDriver webDriver) {
+        if (webDriverEventListener != null) {
+            EventFiringWebDriver efwd = new EventFiringWebDriver(webDriver);
+            efwd.register(webDriverEventListener);
+            return efwd;
+        } else {
+            return webDriver;
+        }
+    }
+
 }
diff --git a/src/main/java/io/github/seleniumquery/browser/driver/builders/ChromeDriverBuilder.java b/src/main/java/io/github/seleniumquery/browser/driver/builders/ChromeDriverBuilder.java
@@ -124,7 +124,7 @@ protected WebDriver build() {
         autoDownloadDriverIfAskedFor(ChromeDriver.class);
         WebDriver webDriver = buildChrome();
         autoQuitDriverIfAskedFor(webDriver);
-        return webDriver;
+        return attatchEventListner(webDriver);
     }
 
     private WebDriver buildChrome() {
diff --git a/src/main/java/io/github/seleniumquery/browser/driver/builders/EdgeDriverBuilder.java b/src/main/java/io/github/seleniumquery/browser/driver/builders/EdgeDriverBuilder.java
@@ -65,7 +65,7 @@ protected WebDriver build() {
         autoDownloadDriverIfAskedFor(EdgeDriver.class);
         WebDriver webDriver = buildEdge();
         autoQuitDriverIfAskedFor(webDriver);
-        return webDriver;
+        return attatchEventListner(webDriver);
     }
 
     private WebDriver buildEdge() {
diff --git a/src/main/java/io/github/seleniumquery/browser/driver/builders/FirefoxDriverBuilder.java b/src/main/java/io/github/seleniumquery/browser/driver/builders/FirefoxDriverBuilder.java
@@ -126,7 +126,7 @@ protected WebDriver build() {
         autoDownloadDriverIfAskedFor(FirefoxDriver.class);
         WebDriver webDriver = buildFirefox();
         autoQuitDriverIfAskedFor(webDriver);
-        return webDriver;
+        return attatchEventListner(webDriver);
     }
 
     private WebDriver buildFirefox() {
diff --git a/src/main/java/io/github/seleniumquery/browser/driver/builders/HtmlUnitDriverBuilder.java b/src/main/java/io/github/seleniumquery/browser/driver/builders/HtmlUnitDriverBuilder.java
@@ -104,7 +104,7 @@ public HtmlUnitDriverBuilder emulatingInternetExplorer() {
     protected WebDriver build() {
         WebDriver webDriver = buildHtmlUnit();
         autoQuitDriverIfAskedFor(webDriver);
-        return webDriver;
+        return attatchEventListner(webDriver);
     }
 
     private WebDriver buildHtmlUnit() {
diff --git a/src/main/java/io/github/seleniumquery/browser/driver/builders/InternetExplorerDriverBuilder.java b/src/main/java/io/github/seleniumquery/browser/driver/builders/InternetExplorerDriverBuilder.java
@@ -75,7 +75,7 @@ protected WebDriver build() {
         autoDownloadDriverIfAskedFor(InternetExplorerDriver.class);
         WebDriver webDriver = buildIE();
         autoQuitDriverIfAskedFor(webDriver);
-        return webDriver;
+        return attatchEventListner(webDriver);
     }
 
     private WebDriver buildIE() {
diff --git a/src/main/java/io/github/seleniumquery/browser/driver/builders/OperaDriverBuilder.java b/src/main/java/io/github/seleniumquery/browser/driver/builders/OperaDriverBuilder.java
@@ -117,7 +117,7 @@ protected WebDriver build() {
         autoDownloadDriverIfAskedFor(OperaDriver.class);
         WebDriver webDriver = buildOpera();
         autoQuitDriverIfAskedFor(webDriver);
-        return webDriver;
+        return attatchEventListner(webDriver);
     }
 
     private WebDriver buildOpera() {
diff --git a/src/main/java/io/github/seleniumquery/browser/driver/builders/PhantomJSDriverBuilder.java b/src/main/java/io/github/seleniumquery/browser/driver/builders/PhantomJSDriverBuilder.java
@@ -88,7 +88,7 @@ protected WebDriver build() {
         autoDownloadDriverIfAskedFor(PhantomJSDriver.class);
         WebDriver webDriver = buildPhantomJS();
         autoQuitDriverIfAskedFor(webDriver);
-        return webDriver;
+        return attatchEventListner(webDriver);
     }
 
     private WebDriver buildPhantomJS() {

Original file line number	Diff line number	Diff line change
`@@ -124,7 +124,7 @@ protected WebDriver build() {`
`124`	`124`	`autoDownloadDriverIfAskedFor(ChromeDriver.class);`
`125`	`125`	`WebDriver webDriver = buildChrome();`
`126`	`126`	`autoQuitDriverIfAskedFor(webDriver);`
`127`		`- return webDriver;`
	`127`	`+ return attatchEventListner(webDriver);`
`128`	`128`	`}`
`129`	`129`
`130`	`130`	`private WebDriver buildChrome() {`
Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ protected WebDriver build() {`
`65`	`65`	`autoDownloadDriverIfAskedFor(EdgeDriver.class);`
`66`	`66`	`WebDriver webDriver = buildEdge();`
`67`	`67`	`autoQuitDriverIfAskedFor(webDriver);`
`68`		`- return webDriver;`
	`68`	`+ return attatchEventListner(webDriver);`
`69`	`69`	`}`
`70`	`70`
`71`	`71`	`private WebDriver buildEdge() {`
Original file line number	Diff line number	Diff line change
`@@ -126,7 +126,7 @@ protected WebDriver build() {`
`126`	`126`	`autoDownloadDriverIfAskedFor(FirefoxDriver.class);`
`127`	`127`	`WebDriver webDriver = buildFirefox();`
`128`	`128`	`autoQuitDriverIfAskedFor(webDriver);`
`129`		`- return webDriver;`
	`129`	`+ return attatchEventListner(webDriver);`
`130`	`130`	`}`
`131`	`131`
`132`	`132`	`private WebDriver buildFirefox() {`
Original file line number	Diff line number	Diff line change
`@@ -104,7 +104,7 @@ public HtmlUnitDriverBuilder emulatingInternetExplorer() {`
`104`	`104`	`protected WebDriver build() {`
`105`	`105`	`WebDriver webDriver = buildHtmlUnit();`
`106`	`106`	`autoQuitDriverIfAskedFor(webDriver);`
`107`		`- return webDriver;`
	`107`	`+ return attatchEventListner(webDriver);`
`108`	`108`	`}`
`109`	`109`
`110`	`110`	`private WebDriver buildHtmlUnit() {`
Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,7 @@ protected WebDriver build() {`
`75`	`75`	`autoDownloadDriverIfAskedFor(InternetExplorerDriver.class);`
`76`	`76`	`WebDriver webDriver = buildIE();`
`77`	`77`	`autoQuitDriverIfAskedFor(webDriver);`
`78`		`- return webDriver;`
	`78`	`+ return attatchEventListner(webDriver);`
`79`	`79`	`}`
`80`	`80`
`81`	`81`	`private WebDriver buildIE() {`
Original file line number	Diff line number	Diff line change
`@@ -117,7 +117,7 @@ protected WebDriver build() {`
`117`	`117`	`autoDownloadDriverIfAskedFor(OperaDriver.class);`
`118`	`118`	`WebDriver webDriver = buildOpera();`
`119`	`119`	`autoQuitDriverIfAskedFor(webDriver);`
`120`		`- return webDriver;`
	`120`	`+ return attatchEventListner(webDriver);`
`121`	`121`	`}`
`122`	`122`
`123`	`123`	`private WebDriver buildOpera() {`
Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,7 @@ protected WebDriver build() {`
`88`	`88`	`autoDownloadDriverIfAskedFor(PhantomJSDriver.class);`
`89`	`89`	`WebDriver webDriver = buildPhantomJS();`
`90`	`90`	`autoQuitDriverIfAskedFor(webDriver);`
`91`		`- return webDriver;`
	`91`	`+ return attatchEventListner(webDriver);`
`92`	`92`	`}`
`93`	`93`
`94`	`94`	`private WebDriver buildPhantomJS() {`