Merge pull request #3 from aquality-automation/basic/reference-aquality-selenium

Basic/reference aquality selenium

Author: DmitryBogatko

pom.xml

@@ -21,19 +21,14 @@
     </build>
     <dependencies>
         <dependency>
-            <groupId>com.fasterxml.jackson.core</groupId>
-            <artifactId>jackson-databind</artifactId>
-            <version>2.9.9</version>
-        </dependency>
-        <dependency>
-            <groupId>log4j</groupId>
-            <artifactId>log4j</artifactId>
-            <version>1.2.17</version>
+            <groupId>com.github.aquality-automation</groupId>
+            <artifactId>aquality-selenium</artifactId>
+            <version>LATEST</version>
         </dependency>
         <dependency>
             <groupId>io.appium</groupId>
             <artifactId>java-client</artifactId>
-            <version>5.0.0-BETA6</version>
+            <version>7.2.0</version>
         </dependency>
         <dependency>
             <groupId>org.testng</groupId>

src/main/java/aquality/appium/application/Application.java

@@ -2,10 +2,13 @@
 
 import aquality.appium.configuration.IConfiguration;
 import aquality.appium.configuration.ITimeoutConfiguration;
-import aquality.appium.logger.Logger;
+import aquality.selenium.localization.LocalizationManager;
+import aquality.selenium.logger.Logger;
 import io.appium.java_client.AppiumDriver;
 import org.openqa.selenium.remote.service.DriverService;
 
+import java.util.concurrent.TimeUnit;
+
 public class Application {
 
     private final Logger logger = Logger.getInstance();
@@ -21,12 +24,7 @@ public Application(AppiumDriver appiumDriver, IConfiguration configuration) {
         this.configuration = configuration;
         this.timeouts = configuration.getTimeoutConfiguration();
         this.timeoutImpl = timeouts.getImplicit();
-        /*
-        todo: determine if all of these timeouts are necessary to be set this way
         getDriver().manage().timeouts().implicitlyWait(timeoutImpl, TimeUnit.SECONDS);
-        setPageLoadTimeout(timeouts.getPageLoad());
-        setScriptTimeout(timeouts.getScript());
-         */
     }
 
     public Application(DriverService driverService, AppiumDriver appiumDriver, IConfiguration configuration) {
@@ -35,6 +33,7 @@ public Application(DriverService driverService, AppiumDriver appiumDriver, IConf
         this.configuration = configuration;
         this.timeouts = configuration.getTimeoutConfiguration();
         this.timeoutImpl = timeouts.getImplicit();
+        getDriver().manage().timeouts().implicitlyWait(timeoutImpl, TimeUnit.SECONDS);
     }
 
     /**
@@ -61,8 +60,21 @@ public final PlatformName getPlatformName() {
         return configuration.getApplicationProfile().getPlatformName();
     }
 
+    /**
+     * Sets web driver implicit wait timeout
+     * Be careful with using this method. Implicit timeout can affect to duration of driver operations
+     * @param timeout seconds to wait
+     */
+    public void setImplicitWaitTimeout(Long timeout) {
+        logger.debug(String.format(getLocManager().getValue("loc.browser.implicit.timeout"), timeout));
+        if(!timeout.equals(getImplicitWaitTimeout())){
+            getDriver().manage().timeouts().implicitlyWait(timeout, TimeUnit.SECONDS);
+            timeoutImpl = timeout;
+        }
+    }
+
     public void quit() {
-        // todo: logger.info(getLocManager().getValue("loc.browser.driver.quit"));
+        logger.info(LocalizationManager.getInstance().getValue("loc.browser.driver.quit"));
         if (getDriver() != null) {
             getDriver().quit();
         }
@@ -71,4 +83,12 @@ public void quit() {
             getDriverService().stop();
         }
     }
+
+    private Long getImplicitWaitTimeout() {
+        return timeoutImpl;
+    }
+
+    private LocalizationManager getLocManager(){
+        return LocalizationManager.getInstance();
+    }
 }

src/main/java/aquality/appium/application/ApplicationFactory.java

@@ -1,15 +1,22 @@
 package aquality.appium.application;
 
 import aquality.appium.configuration.IConfiguration;
-import aquality.appium.localization.LocalizationManager;
-import aquality.appium.logger.Logger;
+import aquality.selenium.localization.LocalizationManager;
+import aquality.selenium.logger.Logger;
 import io.appium.java_client.AppiumDriver;
 import io.appium.java_client.android.AndroidDriver;
+import io.appium.java_client.android.AndroidElement;
 import io.appium.java_client.ios.IOSDriver;
+import io.appium.java_client.ios.IOSElement;
 import io.appium.java_client.windows.WindowsDriver;
+import io.appium.java_client.windows.WindowsElement;
 import org.openqa.selenium.Capabilities;
+import org.openqa.selenium.remote.http.HttpClient;
+import org.openqa.selenium.remote.http.HttpClient.Builder;
+import org.openqa.selenium.remote.http.HttpClient.Factory;
 
 import java.net.URL;
+import java.time.Duration;
 
 abstract class ApplicationFactory implements IApplicationFactory {
 
@@ -24,23 +31,49 @@ IllegalArgumentException getLoggedWrongPlatformNameException() {
     AppiumDriver getDriver(URL serviceUrl, IConfiguration configuration) {
         PlatformName platformName = configuration.getApplicationProfile().getPlatformName();
         Capabilities capabilities = configuration.getApplicationProfile().getDriverSettings().getCapabilities();
+        Factory httpClientFactory = new ClientFactory(configuration);
         AppiumDriver driver;
         switch (platformName) {
             case ANDROID:
-                driver = new AndroidDriver<>(serviceUrl, capabilities);
+                driver = new AndroidDriver<AndroidElement>(serviceUrl, httpClientFactory, capabilities);
                 break;
             case IOS:
-                driver = new IOSDriver<>(serviceUrl, capabilities);
+                driver = new IOSDriver<IOSElement>(serviceUrl, httpClientFactory, capabilities);
                 break;
             case WINDOWS:
-                driver = new WindowsDriver<>(serviceUrl, capabilities);
+                driver = new WindowsDriver<WindowsElement>(serviceUrl, httpClientFactory, capabilities);
                 break;
             default:
                 throw getLoggedWrongPlatformNameException();
         }
         return driver;
     }
 
+    class ClientFactory implements Factory{
+
+        private final Factory defaultClientFactory = Factory.createDefault();
+        private final Duration timeoutCommand;
+
+        ClientFactory(IConfiguration configuration){
+            timeoutCommand = Duration.ofSeconds(configuration.getTimeoutConfiguration().getCommand());
+        }
+
+        @Override
+        public Builder builder() {
+            return defaultClientFactory.builder().readTimeout(timeoutCommand);
+        }
+
+        @Override
+        public HttpClient createClient(URL url) {
+            return this.builder().createClient(url);
+        }
+
+        @Override
+        public void cleanupIdleClients() {
+            defaultClientFactory.cleanupIdleClients();
+        }
+    }
+
     void logApplicationIsReady(PlatformName platformName) {
         Logger.getInstance().info(getLocManager().getValue("loc.browser.ready"), platformName.toString());
     }

src/main/java/aquality/appium/application/RemoteApplicationFactory.java

@@ -2,8 +2,8 @@
 
 import aquality.appium.configuration.IApplicationProfile;
 import aquality.appium.configuration.IConfiguration;
-import aquality.appium.localization.LocalizationManager;
-import aquality.appium.logger.Logger;
+import aquality.selenium.localization.LocalizationManager;
+import aquality.selenium.logger.Logger;
 import io.appium.java_client.AppiumDriver;
 import org.openqa.selenium.remote.LocalFileDetector;
 

src/main/java/aquality/appium/configuration/ApplicationProfile.java

@@ -5,7 +5,7 @@
 import aquality.appium.configuration.driversettings.IDriverSettings;
 import aquality.appium.configuration.driversettings.IOSSettings;
 import aquality.appium.configuration.driversettings.WindowsSettings;
-import aquality.appium.utils.JsonFile;
+import aquality.selenium.utils.JsonFile;
 import org.openqa.selenium.InvalidArgumentException;
 
 import java.net.MalformedURLException;

src/main/java/aquality/appium/configuration/Configuration.java

@@ -1,9 +1,10 @@
 package aquality.appium.configuration;
 
-import aquality.appium.utils.JsonFile;
-
-import java.io.IOException;
-import java.io.UncheckedIOException;
+import aquality.selenium.configuration.ILoggerConfiguration;
+import aquality.selenium.configuration.IRetryConfiguration;
+import aquality.selenium.configuration.LoggerConfiguration;
+import aquality.selenium.configuration.RetryConfiguration;
+import aquality.selenium.utils.JsonFile;
 
 public class Configuration implements IConfiguration{
 
@@ -16,8 +17,8 @@ public class Configuration implements IConfiguration{
     private Configuration() {
         JsonFile settings = getSettings();
         timeoutConfiguration = new TimeoutConfiguration(settings);
-        retryConfiguration = new RetryConfiguration(settings);
         applicationProfile = new ApplicationProfile(settings);
+        retryConfiguration = new RetryConfiguration(settings);
         loggerConfiguration = new LoggerConfiguration(settings);
     }
 
@@ -47,10 +48,6 @@ public ILoggerConfiguration getLoggerConfiguration() {
 
     private JsonFile getSettings() {
         String settingsProfile = System.getProperty("profile") == null ? "settings.json" : "settings." + System.getProperty("profile") + ".json";
-        try{
-            return new JsonFile(settingsProfile);
-        }catch (IOException e){
-            throw new UncheckedIOException(String.format("Browser profile assigned in file %1$s was not found in the root of resources directory", settingsProfile), e);
-        }
+        return new JsonFile(settingsProfile);
     }
 }

src/main/java/aquality/appium/configuration/IConfiguration.java

@@ -1,5 +1,8 @@
 package aquality.appium.configuration;
 
+import aquality.selenium.configuration.ILoggerConfiguration;
+import aquality.selenium.configuration.IRetryConfiguration;
+
 public interface IConfiguration {
 
     IApplicationProfile getApplicationProfile();

src/main/java/aquality/appium/configuration/ILoggerConfiguration.java

@@ -6,10 +6,7 @@ public interface ITimeoutConfiguration {
 
     long getCondition();
 
-    long getScript();
-
-    long getPageLoad();
-
     long getPollingInterval();
 
+    long getCommand();
 }