added ability to configure other driver locations in WebTester configuration as well

slu-it · slu-it · commit b89664d42991 · 2017-03-23T21:16:34.000+01:00
diff --git a/pom.xml b/pom.xml
@@ -61,7 +61,7 @@
 
 		<!-- dependency versions -->
 
-		<version.testutils>0.1.beta1</version.testutils>
+		<version.testutils>0.2</version.testutils>
 		<version.junit4>4.12</version.junit4>
 		<version.junit5.jupiter>5.0.0-M3</version.junit5.jupiter>
 		<version.junit5.vintage>4.12.0-M3</version.junit5.vintage>
diff --git a/webtester-core/src/main/java/info/novatec/testit/webtester/browser/BrowserFactory.java b/webtester-core/src/main/java/info/novatec/testit/webtester/browser/BrowserFactory.java
@@ -12,12 +12,10 @@
  * <p>
  * The most important method of a browser factory is {@link #createBrowser()}.
  * It is used by all kinds of reflection based operations to initialize a
- * browser using all the implemented defaults of the actual factory
- * implementation. For more flexibility the
- * {@link #createBrowser(DesiredCapabilities)} and
- * {@link #createBrowser(WebDriver)} methods can be used to create instances
- * based on pre-initialized objects while still setting some common properties
- * with a default implementation.
+ * browser using all the defaults of the actual factory implementation.
+ * For more flexibility the {@link #createBrowser(DesiredCapabilities)} method
+ * can be used to create instances based on your desired capabilities while still setting
+ * some common properties with a default implementation.
  * <p>
  * The difference between a browser factory and a {@link BrowserBuilder browser
  * builder} is in how they are used. Factories are used to initialize a
@@ -77,17 +75,6 @@ public interface BrowserFactory {
      */
     Browser createBrowser(DesiredCapabilities capabilities);
 
-    /**
-     * Creates a {@link Browser browser} using the given pre-initialized
-     * {@link WebDriver web driver} and the {@link BrowserFactory factory's}
-     * defaults.
-     *
-     * @param webDriver the web driver to use
-     * @return the created browser
-     * @since 2.0
-     */
-    Browser createBrowser(WebDriver webDriver);
-
     /**
      * Defines a {@link ProxyConfiguration proxy configuration} to use when
      * creating a {@link Browser browser} with this {@link BrowserFactory
diff --git a/webtester-core/src/main/java/info/novatec/testit/webtester/browser/factories/BaseBrowserFactory.java b/webtester-core/src/main/java/info/novatec/testit/webtester/browser/factories/BaseBrowserFactory.java
@@ -60,13 +60,6 @@ public Browser createBrowser(DesiredCapabilities capabilities) {
         return WebDriverBrowser.forWebDriver(webDriverProducer.apply(capabilities)).withConfiguration(configuration).build();
     }
 
-    @Override
-    public Browser createBrowser(WebDriver webDriver) {
-        Configuration configuration = new DefaultConfigurationBuilder().build();
-        postProcessConfiguration(configuration);
-        return WebDriverBrowser.forWebDriver(webDriver).withConfiguration(configuration).build();
-    }
-
     protected void setOptionalProxyConfiguration(DesiredCapabilities capabilities) {
         if (proxyConfiguration != null && !(proxyConfiguration instanceof NoProxyConfiguration)) {
             Proxy proxy = new Proxy();
diff --git a/webtester-core/src/main/java/info/novatec/testit/webtester/browser/factories/ChromeFactory.java b/webtester-core/src/main/java/info/novatec/testit/webtester/browser/factories/ChromeFactory.java
@@ -25,16 +25,16 @@
  */
 public class ChromeFactory extends BaseBrowserFactory<ChromeFactory> {
 
-    private static final String CHROME_DRIVER_LOCATION = "webdriver.chrome.driver";
+    private static final String DRIVER_LOCATION = "webdriver.chrome.driver";
 
     public ChromeFactory() {
         super(ChromeDriver::new);
     }
 
     @Override
     protected void postProcessConfiguration(Configuration configuration) {
-        configuration.getStringProperty(CHROME_DRIVER_LOCATION).ifPresent(driverLocation -> {
-            System.setProperty(CHROME_DRIVER_LOCATION, driverLocation);
+        configuration.getStringProperty(DRIVER_LOCATION).ifPresent(driverLocation -> {
+            System.setProperty(DRIVER_LOCATION, driverLocation);
         });
     }
 
diff --git a/webtester-core/src/main/java/info/novatec/testit/webtester/browser/factories/EdgeFactory.java b/webtester-core/src/main/java/info/novatec/testit/webtester/browser/factories/EdgeFactory.java
@@ -1,9 +1,10 @@
 package info.novatec.testit.webtester.browser.factories;
 
-import info.novatec.testit.webtester.browser.Browser;
 import org.openqa.selenium.edge.EdgeDriver;
-import org.openqa.selenium.edge.EdgeDriverService;
-import org.openqa.selenium.remote.DesiredCapabilities;
+
+import info.novatec.testit.webtester.browser.Browser;
+import info.novatec.testit.webtester.config.Configuration;
+
 
 /**
  * Factory class for creating Microsoft Edge {@link Browser} instances.
@@ -21,14 +22,17 @@
  */
 public class EdgeFactory extends BaseBrowserFactory<EdgeFactory> {
 
+    private static final String DRIVER_LOCATION = "webdriver.edge.driver";
+
     public EdgeFactory() {
         super(EdgeDriver::new);
     }
 
-    public Browser createBrowser() {
-        EdgeDriverService service = EdgeDriverService.createDefaultService();
-        DesiredCapabilities capabilities = getDefaultCapabilities();
-        return createBrowser(new EdgeDriver(service, capabilities));
+    @Override
+    protected void postProcessConfiguration(Configuration configuration) {
+        configuration.getStringProperty(DRIVER_LOCATION).ifPresent(driverLocation -> {
+            System.setProperty(DRIVER_LOCATION, driverLocation);
+        });
     }
 
 }
diff --git a/webtester-core/src/main/java/info/novatec/testit/webtester/browser/factories/InternetExplorerFactory.java b/webtester-core/src/main/java/info/novatec/testit/webtester/browser/factories/InternetExplorerFactory.java
@@ -1,10 +1,9 @@
 package info.novatec.testit.webtester.browser.factories;
 
 import org.openqa.selenium.ie.InternetExplorerDriver;
-import org.openqa.selenium.ie.InternetExplorerDriverService;
-import org.openqa.selenium.remote.DesiredCapabilities;
 
 import info.novatec.testit.webtester.browser.Browser;
+import info.novatec.testit.webtester.config.Configuration;
 
 
 /**
@@ -26,14 +25,17 @@
  */
 public class InternetExplorerFactory extends BaseBrowserFactory<InternetExplorerFactory> {
 
+    private static final String DRIVER_LOCATION = "webdriver.ie.driver";
+
     public InternetExplorerFactory() {
         super(InternetExplorerDriver::new);
     }
 
-    public Browser createBrowser(int port) {
-        InternetExplorerDriverService service = InternetExplorerDriverService.createDefaultService();
-        DesiredCapabilities capabilities = getDefaultCapabilities();
-        return createBrowser(new InternetExplorerDriver(service, capabilities, port));
+    @Override
+    protected void postProcessConfiguration(Configuration configuration) {
+        configuration.getStringProperty(DRIVER_LOCATION).ifPresent(driverLocation -> {
+            System.setProperty(DRIVER_LOCATION, driverLocation);
+        });
     }
 
 }
diff --git a/webtester-core/src/main/java/info/novatec/testit/webtester/browser/factories/MarionetteFactory.java b/webtester-core/src/main/java/info/novatec/testit/webtester/browser/factories/MarionetteFactory.java
@@ -3,10 +3,12 @@
 import org.openqa.selenium.firefox.FirefoxDriver;
 
 import info.novatec.testit.webtester.browser.Browser;
+import info.novatec.testit.webtester.config.Configuration;
 
 
 /**
  * Factory class for creating Firefox {@link Browser} instances.
+ * Needs the {@code webdriver.gecko.driver} system property pointing to the driver proxy server executable.
  * This will only work for Firefox browsers version 47 and above!
  * All older versions should be initialized using the {@link FirefoxFactory}.
  * <p>
@@ -16,8 +18,10 @@
  * <li>Unsigned certificates are accepted</li>
  * </ul>
  * <b>Additional information on using the {@link FirefoxDriver}:</b>
- * <p>
- * https://github.com/SeleniumHQ/selenium/wiki/FirefoxDriver
+ * <ul>
+ * <li>https://github.com/SeleniumHQ/selenium/wiki/FirefoxDriver</li>
+ * <li>https://github.com/mozilla/geckodriver</li>
+ * </ul>
  *
  * @see Browser
  * @see FirefoxDriver
@@ -26,11 +30,20 @@
  */
 public class MarionetteFactory extends BaseBrowserFactory<MarionetteFactory> {
 
+    private static final String DRIVER_LOCATION = "webdriver.gecko.driver";
+
     public MarionetteFactory() {
         super((capabilities) -> {
             capabilities.setCapability("marionette", true);
             return new FirefoxDriver(capabilities);
         });
     }
 
+    @Override
+    protected void postProcessConfiguration(Configuration configuration) {
+        configuration.getStringProperty(DRIVER_LOCATION).ifPresent(driverLocation -> {
+            System.setProperty(DRIVER_LOCATION, driverLocation);
+        });
+    }
+
 }
diff --git a/webtester-core/src/main/java/info/novatec/testit/webtester/browser/factories/RemoteFactory.java b/webtester-core/src/main/java/info/novatec/testit/webtester/browser/factories/RemoteFactory.java
@@ -88,7 +88,8 @@ public Browser createBrowser(DesiredCapabilities capabilities) {
         String url = "http://" + host + ":" + port + "/wd/hub";
         try {
             log.debug("creating remote driver instance for {} with capabilities: {}", url, capabilities);
-            return createBrowser(webDriverProducer.apply(new URL(url), capabilities));
+            WebDriver webDriver = webDriverProducer.apply(new URL(url), capabilities);
+            return WebDriverBrowser.forWebDriver(webDriver).withConfiguration(configuration).build();
         } catch (MalformedURLException e) {
             throw new MalformedRemoteFactoryUrlException(url, e);
         }
@@ -102,11 +103,6 @@ private void setOptionalProxyConfiguration(DesiredCapabilities capabilities) {
         }
     }
 
-    @Override
-    public Browser createBrowser(WebDriver webDriver) {
-        return WebDriverBrowser.forWebDriver(webDriver).withConfiguration(configuration).build();
-    }
-
     @Override
     public RemoteFactory withProxyConfiguration(ProxyConfiguration configuration) {
         proxyConfiguration = configuration;
diff --git a/webtester-core/src/test/java/utils/integration/TestBrowserFactory.java b/webtester-core/src/test/java/utils/integration/TestBrowserFactory.java
@@ -1,6 +1,5 @@
 package utils.integration;
 
-import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.remote.DesiredCapabilities;
 
 import info.novatec.testit.webtester.browser.Browser;
@@ -35,11 +34,6 @@ public Browser createBrowser(DesiredCapabilities capabilities) {
         throw new UnsupportedOperationException("createBrowser(DesiredCapabilities capabilities) not supported in test browser!");
     }
 
-    @Override
-    public Browser createBrowser(WebDriver webDriver) {
-        throw new UnsupportedOperationException("createBrowser(WebDriver webDriver) not supported in test browser!");
-    }
-
     @Override
     public BrowserFactory withProxyConfiguration(ProxyConfiguration configuration) {
         throw new UnsupportedOperationException("proxy not supported in test browser!");
diff --git a/webtester-documentation/src/main/asciidoc/chapters/browser-factories.asciidoc b/webtester-documentation/src/main/asciidoc/chapters/browser-factories.asciidoc
@@ -10,6 +10,7 @@ to their specific environment. In case you just want to get started, we provide
 factories for the most common browsers:
 
 * `ChromeFactory`
+* `EdgeFactory`
 * `FirefoxFactory`
 * `MarionetteFactory` (new Firefox driver)
 * `InternetExplorerFactory`
@@ -56,17 +57,46 @@ link:https://sites.google.com/a/chromium.org/chromedriver/downloads[here]. The
 path to the executable must be declared as a system or environment property
 named: `webdriver.chrome.driver`
 
+You can also declare this property within your WebTester configuration file(s).
+This will trigger the framework to expose this property for you.
+
 Additional Information:
 
 * https://github.com/SeleniumHQ/selenium/wiki/ChromeDriver
 
+==== EdgeFactory
+
+This `BrowserFactory` uses the `selenium-edge-driver` to create new Edge
+`Browser` instances.
+
+===== Default Driver Configuration
+
+In order to optimize testing the following properties are set when creating a
+`WebDriver` using the `EdgeFactory`:
+
+* Native events are disabled -> Selenium does not simulate human typing.
+* Untrusted certificates are always accepted.
+
+===== Additional Service Executable
+
+The `EdgeDriver` needs an additional executable to communicate with an Edge
+browser. It can be downloaded
+link:https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/[here].
+Please make sure to choose the release version equal to your Windows 10 build.
+The path to the executable must be declared as a system or environment property
+named: `webdriver.edge.driver`
+
+You can also declare this property within your WebTester configuration file(s).
+This will trigger the framework to expose this property for you.
+
 ==== FirefoxFactory and MarionetteFactory
 
 These `BrowserFactory` implementations use the `selenium-firefox-driver` to
 create new Firefox `Browser` instances. To drive Firefox browsers up to version
 46, the `FirefoxFactory` _can_ be used. In order to drive newer versions (47++),
 the `MarionetteFactory` _must_ be used. The only real difference between these
-two factories is the activation of the `marionnette` capability.
+two factories is the activation of the `marionnette` capability, but sadly in doing so
+you will need to provide the location of a `GeckoDriver` installation.
 
 ===== Default Driver Configuration
 
@@ -85,6 +115,9 @@ link:https://github.com/mozilla/geckodriver/releases[here] The path to the
 executable must be declared as a system or environment property named:
 `webdriver.gecko.driver`
 
+You can also declare this property within your WebTester configuration file(s).
+This will trigger the framework to expose this property for you.
+
 Additional Information:
 
 * https://github.com/SeleniumHQ/selenium/wiki/FirefoxDriver
@@ -112,32 +145,13 @@ link:http://selenium-release.storage.googleapis.com/index.html[here]. The path
 to the executable must be declared as a system or environment property named:
 `webdriver.ie.driver`
 
+You can also declare this property within your WebTester configuration file(s).
+This will trigger the framework to expose this property for you.
+
 Additional Information:
 
 * https://github.com/SeleniumHQ/selenium/wiki/InternetExplorerDriver
 
-==== EdgeFactory
-
-This `BrowserFactory` uses the `selenium-edge-driver` to create new Edge
-`Browser` instances.
-
-===== Default Driver Configuration
-
-In order to optimize testing the following properties are set when creating a
-`WebDriver` using the `EdgeFactory`:
-
-* Native events are disabled -> Selenium does not simulate human typing.
-* Untrusted certificates are always accepted.
-
-===== Additional Service Executable
-
-The `EdgeDriver` needs an additional executable to communicate with an Edge
-browser. It can be downloaded
-link:https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/[here].
-Please make sure to choose the release version equal to your Windows 10 build.
-The path to the executable must be declared as a system or environment property
-named: `webdriver.edge.driver`
-
 ==== RemoteFactory
 
 This `BrowserFactory` uses the `RemoteWebDriver` to connect to a
diff --git a/webtester-support-junit4/src/test/java/utils/MockedTestBrowserFactory.java b/webtester-support-junit4/src/test/java/utils/MockedTestBrowserFactory.java
@@ -3,7 +3,6 @@
 import static org.mockito.Mockito.doReturn;
 import static org.mockito.Mockito.mock;
 
-import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.remote.DesiredCapabilities;
 
 import info.novatec.testit.webtester.browser.Browser;
@@ -34,11 +33,6 @@ public Browser createBrowser() {
         return browser;
     }
 
-    @Override
-    public Browser createBrowser(WebDriver webDriver) {
-        return browser;
-    }
-
     @Override
     public Browser createBrowser(DesiredCapabilities capabilities) {
         return browser;
diff --git a/webtester-support-junit5/src/test/java/info/novatec/testit/webtester/junit5/extensions/BaseExtensionTest.java b/webtester-support-junit5/src/test/java/info/novatec/testit/webtester/junit5/extensions/BaseExtensionTest.java
@@ -19,8 +19,8 @@
 import org.junit.jupiter.api.extension.TestExtensionContext;
 import org.mockito.InjectMocks;
 import org.mockito.Mock;
+import org.testit.testutils.mockito.junit5.EnableMocking;
 
-import info.novatec.testit.testutils.mockito.junit5.EnableMocking;
 import info.novatec.testit.webtester.junit5.internal.ReflectionUtils;
 import info.novatec.testit.webtester.junit5.internal.TestClassModelFactory;
 
diff --git a/webtester-support-junit5/src/test/java/utils/SpyableEventsTestBrowserFactory.java b/webtester-support-junit5/src/test/java/utils/SpyableEventsTestBrowserFactory.java
@@ -5,7 +5,6 @@
 import static org.mockito.Mockito.spy;
 
 import org.apache.commons.lang.NotImplementedException;
-import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.remote.DesiredCapabilities;
 
 import info.novatec.testit.webtester.browser.Browser;
@@ -26,11 +25,6 @@ public Browser createBrowser() {
         return browser;
     }
 
-    @Override
-    public Browser createBrowser(WebDriver webDriver) {
-        throw new NotImplementedException();
-    }
-
     @Override
     public Browser createBrowser(DesiredCapabilities capabilities) {
         throw new NotImplementedException();
diff --git a/webtester-support-junit5/src/test/java/utils/TestBrowserFactory.java b/webtester-support-junit5/src/test/java/utils/TestBrowserFactory.java
@@ -19,11 +19,6 @@ public Browser createBrowser() {
         return WebDriverBrowser.buildForWebDriver(mock(WebDriver.class));
     }
 
-    @Override
-    public Browser createBrowser(WebDriver webDriver) {
-        throw new NotImplementedException();
-    }
-
     @Override
     public Browser createBrowser(DesiredCapabilities capabilities) {
         throw new NotImplementedException();
diff --git a/webtester-support-spring4/src/test/java/info/novatec/testit/webtester/spring4/config/adapters/SpringEnvironmentConfigurationAdapterTest.java b/webtester-support-spring4/src/test/java/info/novatec/testit/webtester/spring4/config/adapters/SpringEnvironmentConfigurationAdapterTest.java
