Architecture refactor 1v.9.9

pom.xml

@@ -98,8 +98,7 @@
     <dependency>
       <groupId>io.appium</groupId>
       <artifactId>java-client</artifactId>
-      <version>8.3.0</version>
-      <scope>compile</scope>
+      <version>${appium.version}</version>
     </dependency>
 
     <!-- Gson -->

src/main/java/pickleib/driver/DriverFactory.java

@@ -1,11 +1,14 @@
 package pickleib.driver;
 
 import org.jetbrains.annotations.Nullable;
+import org.openqa.selenium.Platform;
 
 public interface DriverFactory {
     enum DriverType {
         Web,
-        Mobile;
+        Mobile,
+        iOS,
+        Android;
 
         public static DriverType fromString(String text) {
             if (text != null)
@@ -18,5 +21,21 @@ public static DriverType fromString(String text) {
         public static DriverType getType(@Nullable String text) {
             return fromString(text);
         }
+
+        public static DriverType getParentType(Platform platform) {
+            return switch (platform) {
+                case WINDOWS, LINUX, UNIX, VENTURA, MONTEREY, BIG_SUR, CATALINA, MOJAVE, HIGH_SIERRA, SIERRA, EL_CAPITAN, YOSEMITE, MAVERICKS, MOUNTAIN_LION, SNOW_LEOPARD, MAC, WIN11, WIN10, WIN8_1, WIN8, WIN7, VISTA, XP -> Web;
+                case ANDROID -> Android;
+                case IOS -> iOS;
+                case ANY -> null;
+            };
+        }
+
+        public static DriverType getGeneralType(DriverType driverType){
+            return switch (driverType){
+                case Web -> Web;
+                case Mobile, iOS, Android -> Mobile;
+            };
+        }
     }
 }

src/main/java/pickleib/driver/DriverLoader.java

@@ -0,0 +1,30 @@
+package pickleib.driver;
+
+import collections.Pair;
+import io.appium.java_client.AppiumDriver;
+import org.openqa.selenium.remote.RemoteWebDriver;
+import pickleib.mobile.driver.PickleibAppiumDriver;
+import pickleib.web.driver.PickleibWebDriver;
+
+public class DriverLoader {
+
+    public RemoteWebDriver loadWebDriver(){
+        PickleibWebDriver.initialize();
+        return PickleibWebDriver.get();
+    }
+
+    public AppiumDriver loadMobileDriver(){
+        PickleibAppiumDriver.initialize();
+        return PickleibAppiumDriver.get();
+    }
+
+    public void load(DriverFactory.DriverType... driverTypes){
+        for (DriverFactory.DriverType type:driverTypes) {
+            switch (type){
+                case Mobile -> PickleibAppiumDriver.initialize();
+                case Web -> PickleibWebDriver.initialize();
+                default -> throw new EnumConstantNotPresentException(DriverFactory.DriverType.class, type.name());
+            }
+        }
+    }
+}

src/main/java/pickleib/mobile/PickleibScreenObject.java

@@ -0,0 +1,69 @@
+package pickleib.mobile;
+
+import context.ContextStore;
+import io.appium.java_client.pagefactory.AppiumFieldDecorator;
+import org.openqa.selenium.remote.RemoteWebDriver;
+import org.openqa.selenium.support.PageFactory;
+import org.openqa.selenium.support.pagefactory.DefaultFieldDecorator;
+import pickleib.mobile.driver.PickleibAppiumDriver;
+import pickleib.mobile.utilities.MobileUtilities;
+import pickleib.web.driver.PickleibWebDriver;
+
+import java.time.Duration;
+
+public abstract class PickleibScreenObject extends MobileUtilities {
+    /**
+     * PickleibScreenObject for frameworks that use the Pickleib driver
+     *
+     */
+    protected PickleibScreenObject(){
+        super(PickleibAppiumDriver.get());
+        PageFactory.initElements(
+                new AppiumFieldDecorator(
+                        PickleibAppiumDriver.get(),
+                        Duration.ofSeconds(
+                                Long.parseLong(ContextStore.get("element-timeout", "15000"))/1000
+                        )
+                ),
+                this
+        );
+    }
+
+    /**
+     * PickleibScreenObject for frameworks that do not use the Pickleib driver
+     *
+     */
+    protected PickleibScreenObject(RemoteWebDriver driver){
+        super(driver);
+        PageFactory.initElements(
+                new AppiumFieldDecorator(
+                        driver,
+                        Duration.ofSeconds(
+                                Long.parseLong(ContextStore.get("element-timeout", "15000"))/1000
+                        )
+                ),
+                this
+        );
+    }
+
+    /**
+     * PickleibScreenObject for frameworks with custom field decorator that use the Pickleib driver
+     *
+     */
+    protected <CustomFieldDecorator extends DefaultFieldDecorator> PickleibScreenObject(CustomFieldDecorator fieldDecorator){
+        super(PickleibWebDriver.get());
+        PageFactory.initElements(fieldDecorator, this);
+    }
+
+    /**
+     * PickleibScreenObject for frameworks with custom field decorator that do not use the Pickleib driver
+     *
+     */
+    protected <CustomFieldDecorator extends DefaultFieldDecorator> PickleibScreenObject(
+            CustomFieldDecorator fieldDecorator,
+            RemoteWebDriver driver
+    ){
+        super(driver);
+        PageFactory.initElements(fieldDecorator, this);
+    }
+}

src/main/java/pickleib/mobile/driver/AppiumDriverFactory.java

@@ -5,23 +5,20 @@
 import org.json.simple.JSONObject;
 import org.openqa.selenium.remote.DesiredCapabilities;
 import pickleib.driver.DriverFactory;
-import utils.FileUtilities;
 import utils.Printer;
 import java.net.URL;
-import java.time.Duration;
 
 import static pickleib.mobile.driver.ServiceFactory.service;
-import static pickleib.utilities.element.ElementAcquisition.strUtils;
 import static utils.StringUtilities.Color.*;
+import static utils.StringUtilities.*;
 
 public class AppiumDriverFactory implements DriverFactory {
 
     static Printer log = new Printer(AppiumDriverFactory.class);
-    static FileUtilities.Json jsonUtils = new FileUtilities.Json();
 
     public static AppiumDriver getDriver(String deviceName, JSONObject capabilities){
         DesiredCapabilities desiredCapabilities = getConfig(capabilities);
-        desiredCapabilities.setCapability("app", strUtils.contextCheck("UPLOAD-" + capabilities.get("app")));
+        desiredCapabilities.setCapability("app", contextCheck("UPLOAD-" + capabilities.get("app")));
         try {
             URL url;
             if (service == null) {
@@ -30,18 +27,15 @@ public static AppiumDriver getDriver(String deviceName, JSONObject capabilities)
                 url = new URL("http://" + address + ":" + port + "/wd/hub");
             }
             else url = service.getUrl();
-
-            AppiumDriver driver = new AppiumDriver(url, desiredCapabilities);
-            driver.manage().timeouts().implicitlyWait(Duration.ofSeconds(15));
-            log.important(deviceName + strUtils.markup(GRAY, " was selected"));
-            return driver;
+            log.important(deviceName + markup(GRAY, " was selected"));
+            return new AppiumDriver(url, desiredCapabilities);
         }
         catch (Exception gamma) {
             if(gamma.toString().contains("Could not start a new session. Possible causes are invalid address of the remote server or browser start-up failure")){
-                log.info("Please make sure " + strUtils.markup(PURPLE, "Appium ") + "is on & verify the port that its running on at 'resources/test.properties'.");
-                throw new RuntimeException(strUtils.markup(YELLOW, gamma.getMessage()));
+                log.info("Please make sure " + markup(PURPLE, "Appium ") + "is on & verify the port that its running on at 'resources/test.properties'.");
+                throw new RuntimeException(markup(YELLOW, gamma.getMessage()));
             }
-            else throw new RuntimeException(strUtils.markup(YELLOW, "Something went wrong while selecting a driver") + "\n" + strUtils.markup(RED, gamma.getMessage()));
+            else throw new RuntimeException(markup(YELLOW, "Something went wrong while selecting a driver") + "\n" + markup(RED, gamma.getMessage()));
         }
     }
 

src/main/java/pickleib/mobile/driver/PickleibAppiumDriver.java

@@ -2,24 +2,32 @@
 
 import context.ContextStore;
 import io.appium.java_client.AppiumDriver;
+import io.appium.java_client.AppiumFluentWait;
 import org.json.simple.JSONObject;
+import org.openqa.selenium.remote.RemoteWebDriver;
+import org.openqa.selenium.support.ui.FluentWait;
 import org.openqa.selenium.support.ui.WebDriverWait;
 import pickleib.utilities.PropertyLoader;
+import pickleib.utilities.screenshot.ScreenCaptureUtility;
 import properties.PropertiesReader;
 import utils.*;
 import java.io.IOException;
 import java.net.ServerSocket;
 
 @SuppressWarnings("unused")
-public class PickleibAppiumDriver {
+public abstract class PickleibAppiumDriver {
+
+	public static ScreenCaptureUtility capture = new ScreenCaptureUtility();
 
 	static {PropertyLoader.load();}
 
-	public static AppiumDriver driver;
-	public static WebDriverWait wait;
+	private static AppiumDriver driver;
+	private static AppiumFluentWait<RemoteWebDriver> wait;
 
+	public static AppiumDriver get(){
+		return driver;
+	}
 	private static final PropertiesReader reader = new PropertiesReader("properties-from-pom.properties");
-	private static final StringUtilities strUtils = new StringUtilities();
 	private static final Printer log = new Printer(PickleibAppiumDriver.class);
 
 	public static void startService(){
@@ -45,16 +53,28 @@ public static void initialize() {
 
 		String directory = ContextStore.get("config", "src/test/resources/configurations");
 
-		JSONObject json = AppiumDriverFactory.jsonUtils.parseJSONFile(directory+"/"+device+".json");
-		driver = AppiumDriverFactory.getDriver(strUtils.firstLetterCapped(device), json);
+		JSONObject json = FileUtilities.Json.parseJSONFile(directory+"/"+device+".json");
+		driver = AppiumDriverFactory.getDriver(StringUtilities.firstLetterCapped(device), json);
 	}
 
 	public static void terminate(){
+		log.info("Finalizing driver...");
+		try {driver.quit();}
+		catch (Exception exception){exception.printStackTrace();}
+		finally {
+			if (ServiceFactory.service != null) ServiceFactory.service.stop(); //TODO: Verify socket & log success
+		}
+	}
+
+	public static void captureAndTerminate(boolean success, String screenshotTag){
 		log.info("Finalizing driver...");
 		try {
+			capture.captureScreen(screenshotTag, "png", driver);
 			driver.quit();
+		}
+		catch (Exception exception){exception.printStackTrace();}
+		finally {
 			if (ServiceFactory.service != null) ServiceFactory.service.stop(); //TODO: Verify socket & log success
 		}
-		catch (Exception ignored){}
 	}
 }

src/main/java/pickleib/mobile/driver/ServiceFactory.java

@@ -5,6 +5,8 @@
 import io.appium.java_client.service.local.AppiumServiceBuilder;
 import utils.Printer;
 
+import java.time.Duration;
+
 import static utils.StringUtilities.Color.*;
 
 public class ServiceFactory {
@@ -21,6 +23,7 @@ public static void startService(String address, Integer port){
         service = new AppiumServiceBuilder()
                 .withIPAddress(address)
                 .usingPort(port)
+                .withTimeout(Duration.ofSeconds(Integer.parseInt(ContextStore.get("appium-server-launch-timeout", "45"))))
                 .build();
         if(!Boolean.parseBoolean(ContextStore.get("detailed-logging", "false")))
             ServiceFactory.service.clearOutPutStreams();