New GridFactory for creating Selenium Grid Browsers

With this factory a RemoteDriver based Browser can be created. It will take the default configuration from the configuration, but also allow for overriding the Selenium Grid specific properties via System Properties. Since this is core functionallity, there are some new "named" properties for this factory.

Author: slu-it

documentation/chapters/configuration.md

@@ -75,7 +75,7 @@ The following shows all default properties loaded by the `DefaultFileConfigurati
 The values are the same as the fallback values of the `BaseConfiguration` implementation.
 
 ```properties
-# Weather or not the events should be fired.
+# Whether or not the events should be fired.
 # TYPE: boolean [true, false]
 events.enabled = true
 
@@ -85,7 +85,7 @@ actions.deceleration = 0
 
 # URL of the default entry point for the application under test.
 # TYPE: String [Resource URL]
-# defaults.entry-point = 
+# defaults.entry-point =
 
 # Folder in which to save screenshots if not otherwise specified.
 # TYPE: String [absolute or relative path to be initialized as a java.io.File instance]
@@ -126,6 +126,26 @@ wait.timeout = 2
 # Default interval in which to check a condition for wait operations.
 # TYPE: int [milliseconds]
 wait.interval = 100
+
+# Name of the browser to use in Selenium Grid
+# TYPE: String [firefox, chrome, safari, ...]
+remote.browser.name = firefox
+
+# Version of the browser to use in Selenium Grid. If not specified, any version will be used!
+# TYPE: String [eg. 46.0.1]
+# remote.browser.version =
+
+# Whether the Marionette driver (Firefox 47++) should be used.
+# TYPE: boolean [true, false]
+remote.firefox.marionette = true
+
+# Host or IO address where Selenium Grid is running
+# TYPE: String [localhost, 192.168.0.1, ...]
+remote.host = localhost
+
+# Host or IO address where Selenium Grid is running
+# TYPE: Integer
+remote.port = 4444
 ```
 
 # Linked Documentation

webtester-core/src/main/java/info/novatec/testit/webtester/browser/BrowserFactory.java

@@ -64,17 +64,6 @@ public interface BrowserFactory {
      */
     Browser createBrowser();
 
-    /**
-     * 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);
-
     /**
      * Creates a {@link Browser browser} with the given
      * {@link DesiredCapabilities desired capabilities} and the
@@ -88,6 +77,17 @@ 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

webtester-core/src/main/java/info/novatec/testit/webtester/browser/factories/RemoteFactory.java

@@ -0,0 +1,150 @@
+package info.novatec.testit.webtester.browser.factories;
+
+import java.net.MalformedURLException;
+import java.net.URL;
+import java.util.function.BiFunction;
+
+import org.openqa.selenium.Platform;
+import org.openqa.selenium.Proxy;
+import org.openqa.selenium.WebDriver;
+import org.openqa.selenium.remote.CapabilityType;
+import org.openqa.selenium.remote.DesiredCapabilities;
+import org.openqa.selenium.remote.RemoteWebDriver;
+
+import lombok.extern.slf4j.Slf4j;
+
+import info.novatec.testit.webtester.browser.Browser;
+import info.novatec.testit.webtester.browser.BrowserFactory;
+import info.novatec.testit.webtester.browser.WebDriverBrowser;
+import info.novatec.testit.webtester.browser.proxy.ProxyConfiguration;
+import info.novatec.testit.webtester.config.Configuration;
+import info.novatec.testit.webtester.config.ConfigurationAdapter;
+import info.novatec.testit.webtester.config.ConfigurationException;
+import info.novatec.testit.webtester.config.builders.DefaultConfigurationBuilder;
+import info.novatec.testit.webtester.internal.configuration.NamedProperties;
+
+
+/**
+ * Factory class for creating Selenium Grid remote {@link Browser} instances.
+ * <p>
+ * The remote driver can be configured by setting the following properties in your {@link Configuration} file(s):
+ * <ul>
+ * <li>{@link NamedProperties#REMOTE_BROWSER_NAME}</li>
+ * <li>{@link NamedProperties#REMOTE_BROWSER_VERSION}</li>
+ * <li>{@link NamedProperties#REMOTE_FIREFOX_MARIONETTE}</li>
+ * <li>{@link NamedProperties#REMOTE_HOST}</li>
+ * <li>{@link NamedProperties#REMOTE_PORT}</li>
+ * </ul>
+ * You can also override these properties by specifying new values as System Properties.
+ * <p>
+ * <b>The following capabilities are set by default:</b>
+ * <ul>
+ * <li>Native Events are disabled</li>
+ * <li>Unsigned certificates are accepted</li>
+ * </ul>
+ *
+ * @see Browser
+ * @see RemoteWebDriver
+ * @see Configuration
+ * @see Configuration#getRemoteBrowserName()
+ * @see Configuration#getRemoteBrowserVersion()
+ * @see Configuration#getRemoteFirefoxMarionette()
+ * @see Configuration#getRemoteHost()
+ * @see Configuration#getRemotePort()
+ * @since 2.1
+ */
+@Slf4j
+public class RemoteFactory implements BrowserFactory {
+
+    private final Configuration configuration;
+    private final BiFunction<URL, DesiredCapabilities, WebDriver> webDriverProducer;
+    private ProxyConfiguration proxyConfiguration;
+
+    public RemoteFactory() {
+        this(new RemoteConfigurationBuilder().build(), RemoteWebDriver::new);
+    }
+
+    RemoteFactory(Configuration configuration, BiFunction<URL, DesiredCapabilities, WebDriver> webDriverProducer) {
+        this.configuration = configuration;
+        this.webDriverProducer = webDriverProducer;
+    }
+
+    @Override
+    public Browser createBrowser() {
+        String browserName = configuration.getRemoteBrowserName();
+        String browserVersion = configuration.getRemoteBrowserVersion();
+        DesiredCapabilities capabilities = new DesiredCapabilities(browserName, browserVersion, Platform.ANY);
+        capabilities.setCapability(CapabilityType.ACCEPT_SSL_CERTS, true);
+        capabilities.setCapability(CapabilityType.HAS_NATIVE_EVENTS, false);
+        capabilities.setCapability("marionette", configuration.getRemoteFirefoxMarionette());
+        setOptionalProxyConfiguration(capabilities);
+        return createBrowser(capabilities);
+    }
+
+    @Override
+    public Browser createBrowser(DesiredCapabilities capabilities) {
+        String host = configuration.getRemoteHost();
+        Integer port = configuration.getRemotePort();
+        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));
+        } catch (MalformedURLException e) {
+            throw new MalformedRemoteFactoryUrlException(url, e);
+        }
+    }
+
+    private void setOptionalProxyConfiguration(DesiredCapabilities capabilities) {
+        if (proxyConfiguration != null) {
+            Proxy proxy = new Proxy();
+            proxyConfiguration.configureProxy(proxy);
+            capabilities.setCapability(CapabilityType.PROXY, proxy);
+        }
+    }
+
+    @Override
+    public Browser createBrowser(WebDriver webDriver) {
+        return WebDriverBrowser.forWebDriver(webDriver).withConfiguration(configuration).build();
+    }
+
+    @Override
+    public RemoteFactory withProxyConfiguration(ProxyConfiguration configuration) {
+        proxyConfiguration = configuration;
+        return this;
+    }
+
+    static class RemoteConfigurationBuilder extends DefaultConfigurationBuilder {
+        RemoteConfigurationBuilder() {
+            withAdapter(new SystemPropertyOverrideAdapter());
+        }
+    }
+
+    private static class SystemPropertyOverrideAdapter implements ConfigurationAdapter {
+
+        @Override
+        public boolean adapt(Configuration configuration) {
+            adaptIfNotNull(configuration, NamedProperties.REMOTE_BROWSER_NAME);
+            adaptIfNotNull(configuration, NamedProperties.REMOTE_BROWSER_VERSION);
+            adaptIfNotNull(configuration, NamedProperties.REMOTE_HOST);
+            adaptIfNotNull(configuration, NamedProperties.REMOTE_PORT);
+            adaptIfNotNull(configuration, NamedProperties.REMOTE_FIREFOX_MARIONETTE);
+            return true;
+        }
+
+        private void adaptIfNotNull(Configuration configuration, NamedProperties property) {
+            String key = property.getKey();
+            String value = System.getProperty(key);
+            if (value != null) {
+                configuration.setProperty(key, value);
+            }
+        }
+
+    }
+
+    public static class MalformedRemoteFactoryUrlException extends ConfigurationException {
+        public MalformedRemoteFactoryUrlException(String url, Throwable cause) {
+            super("The Selenium Grid Hub URL was malformed: " + url, cause);
+        }
+    }
+
+}

webtester-core/src/main/java/info/novatec/testit/webtester/config/BaseConfiguration.java

@@ -12,6 +12,7 @@
 import java.util.Set;
 import java.util.stream.Collectors;
 
+import org.openqa.selenium.remote.BrowserType;
 import org.openqa.selenium.support.Color;
 
 import lombok.extern.slf4j.Slf4j;
@@ -179,6 +180,56 @@ public BaseConfiguration setWaitInterval(long waitInterval) {
         return setProperty(key(NamedProperties.WAIT_INTERVAL), waitInterval);
     }
 
+    @Override
+    public String getRemoteBrowserName() {
+        return getStringProperty(key(NamedProperties.REMOTE_BROWSER_NAME), BrowserType.FIREFOX);
+    }
+
+    @Override
+    public Configuration setRemoteBrowserName(String name) {
+        return setProperty(key(NamedProperties.REMOTE_BROWSER_NAME), name);
+    }
+
+    @Override
+    public String getRemoteBrowserVersion() {
+        return getStringProperty(key(NamedProperties.REMOTE_BROWSER_VERSION), "");
+    }
+
+    @Override
+    public Configuration setRemoteBrowserVersion(String version) {
+        return setProperty(key(NamedProperties.REMOTE_BROWSER_VERSION), version);
+    }
+
+    @Override
+    public boolean getRemoteFirefoxMarionette() {
+        return getBooleanProperty(key(NamedProperties.REMOTE_FIREFOX_MARIONETTE), true);
+    }
+
+    @Override
+    public Configuration setRemoteFirefoxMarionette(boolean marionette) {
+        return setProperty(key(NamedProperties.REMOTE_FIREFOX_MARIONETTE), marionette);
+    }
+
+    @Override
+    public String getRemoteHost() {
+        return getStringProperty(key(NamedProperties.REMOTE_HOST), "localhost");
+    }
+
+    @Override
+    public Configuration setRemoteHost(String host) {
+        return setProperty(key(NamedProperties.REMOTE_HOST), host);
+    }
+
+    @Override
+    public int getRemotePort() {
+        return getIntegerProperty(key(NamedProperties.REMOTE_PORT), 4444);
+    }
+
+    @Override
+    public Configuration setRemotePort(int port) {
+        return setProperty(key(NamedProperties.REMOTE_PORT), port);
+    }
+
     private String key(NamedProperties property) {
         return property.getKey();
     }