Merge pull request #10 from robertgates55/develop

Full refactor of DriverType/Setup and SauceLabs/BrowserStack Implementation

Author: jleeh

pom.xml

@@ -3,7 +3,7 @@
 
   <groupId>com.frameworkium</groupId>
   <artifactId>Frameworkium-core</artifactId>
-  <version>1.0.3</version>
+  <version>1.1.0</version>
 
   <name>Frameworkium-core</name>
   <description>Frameworkium core code. Referenced by the com.frameworkium project, with example tests.</description>
@@ -130,6 +130,11 @@
       <artifactId>aspectjweaver</artifactId>
       <version>1.8.5</version>
     </dependency>
+    <dependency>
+      <groupId>com.paulhammant</groupId>
+      <artifactId>ngwebdriver</artifactId>
+      <version>0.9.1</version>
+    </dependency>
   </dependencies>
 
   <repositories>

src/main/java/com/frameworkium/capture/ScreenshotCapture.java

@@ -4,6 +4,7 @@
 import java.net.URL;
 import java.net.UnknownHostException;
 
+import com.frameworkium.config.DriverSetup;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.openqa.selenium.OutputType;
@@ -74,7 +75,7 @@ private void initExecution(CreateExecution createExecutionMessage) {
     private String getNode(WebDriver webdriver) {
 
         String node = "n/a";
-        if (DriverType.useRemoteWebDriver) {
+        if (DriverSetup.useRemoteDriver()) {
             try {
                 RemoteWebDriver r = ((WebDriverWrapper) webdriver).getWrappedRemoteWebDriver();
                 URL gridURL = new URL(SystemProperty.GRID_URL.getValue());

src/main/java/com/frameworkium/config/DriverSetup.java

@@ -1,11 +1,144 @@
 package com.frameworkium.config;
 
-import org.openqa.selenium.WebDriver;
+import com.frameworkium.config.drivers.*;
+import com.frameworkium.config.remotes.BrowserStack;
+import com.frameworkium.config.remotes.Sauce;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 import org.openqa.selenium.remote.DesiredCapabilities;
 
-public interface DriverSetup {
+import static com.frameworkium.config.SystemProperty.*;
 
-    WebDriver getWebDriverObject(DesiredCapabilities desiredCapabilities);
+public class DriverSetup {
 
-    DesiredCapabilities getDesiredCapabilities();
+    private static final SupportedBrowsers DEFAULT_BROWSER = SupportedBrowsers.FIREFOX;
+
+    /**
+     * List of supported drivers
+     */
+    private enum SupportedBrowsers {
+        FIREFOX,CHROME,OPERA,IE,PHANTOMJS,SAFARI
+    }
+
+    /**
+     * List of supported remote grids
+     */
+    private enum SupportedRemotes {
+        SAUCE,BROWSERSTACK,GRID
+    }
+
+    /**
+     * List of supported platforms on remote grids
+     */
+    public enum SupportedPlatforms {
+        WINDOWS,OSX,IOS,ANDROID,NONE
+    }
+
+    protected final static Logger logger = LogManager.getLogger(DriverType.class);
+
+    /**
+     * Returns the driver type to the base test, which initialises it
+     *
+     * @return - Driver Type
+     */
+    public static DriverType returnDesiredDriverType() {
+        return initialiseDesiredDriverType();
+    }
+
+    /**
+     * Uses the paramaters given to determine which browser/remote/platform to use
+     *
+     * @return - The correct driver type based on parameters
+     */
+    private static DriverType initialiseDesiredDriverType() throws NullPointerException {
+        DriverType browserDriver = returnBrowserObject();
+        DesiredCapabilities browserDesiredCapabilities = browserDriver.getDesiredCapabilities();
+        if (useRemoteDriver()) {
+            SupportedPlatforms platform = returnPlatformType();
+            switch(returnRemoteType()) {
+                case SAUCE:
+                    return new SauceImpl(platform, browserDesiredCapabilities);
+                case BROWSERSTACK:
+                    return new BrowserStackImpl(platform, browserDesiredCapabilities);
+                case GRID:
+                    return new GridImpl(browserDesiredCapabilities);
+            }
+        }
+        return browserDriver;
+    }
+
+    /**
+     * @return the browser driver type object based on the browser passed in
+     */
+    private static DriverType returnBrowserObject() {
+        switch (returnBrowserType()) {
+            case FIREFOX:
+                return new FirefoxImpl();
+            case CHROME:
+                return new ChromeImpl();
+            case OPERA:
+                return new OperaImpl();
+            case IE:
+                return new InternetExporerImpl();
+            case PHANTOMJS:
+                return new PhantomJSImpl();
+            case SAFARI:
+                return new SafariImpl();
+        }
+        return null;
+    }
+
+    /**
+     * Checks whether a remote driver is wanting to be used
+     *
+     * @return - True/False to whether to use a remote driver
+     */
+    public static boolean useRemoteDriver() {
+        return GRID_URL.isSpecified() || Sauce.isDesired() || BrowserStack.isDesired();
+    }
+
+    /**
+     * Returns the platform type, if it's been given
+     *
+     * @return - Platform type
+     */
+    private static SupportedPlatforms returnPlatformType() {
+        if (SystemProperty.PLATFORM.isSpecified()) {
+            return SupportedPlatforms.valueOf(SystemProperty.PLATFORM.getValue().toUpperCase());
+        }
+        else {
+            return SupportedPlatforms.NONE;
+        }
+    }
+
+    /**
+     * Returns the browser type and returns default if not specified
+     *
+     * @return - Browser Type
+     */
+    private static SupportedBrowsers returnBrowserType() {
+        if (!SystemProperty.BROWSER.isSpecified()) {
+           return DEFAULT_BROWSER;
+        }
+        else {
+            return SupportedBrowsers.valueOf(SystemProperty.BROWSER.getValue().toUpperCase());
+        }
+    }
+
+    /**
+     * Returns what type of remote driver has been specified to be used
+     *
+     * @return - Remote Driver Type
+     */
+    private static SupportedRemotes returnRemoteType() {
+        if (Sauce.isDesired()) {
+            return SupportedRemotes.SAUCE;
+        }
+        else if (BrowserStack.isDesired()) {
+            return SupportedRemotes.BROWSERSTACK;
+        }
+        else {
+            return SupportedRemotes.GRID;
+        }
+    }
 }