Extracted IConditionalWait

src/main/java/aquality/selenium/core/application/AqualityModule.java → src/main/java/aquality/selenium/core/applications/AqualityModule.java

@@ -1,11 +1,15 @@
-package aquality.selenium.core.application;
+package aquality.selenium.core.applications;
 
 import aquality.selenium.core.configurations.*;
-import aquality.selenium.core.localization.*;
+import aquality.selenium.core.localization.ILocalizationManager;
+import aquality.selenium.core.localization.ILocalizationModule;
+import aquality.selenium.core.localization.ILocalizedLogger;
 import aquality.selenium.core.logging.Logger;
 import aquality.selenium.core.utilities.IElementActionRetrier;
 import aquality.selenium.core.utilities.ISettingsFile;
 import aquality.selenium.core.utilities.IUtilitiesModule;
+import aquality.selenium.core.waitings.IConditionalWait;
+import aquality.selenium.core.waitings.IWaitingsModule;
 import com.google.inject.AbstractModule;
 import com.google.inject.Provider;
 import com.google.inject.Singleton;
@@ -14,7 +18,7 @@
  * Describes all dependencies which is registered for the project.
  */
 public class AqualityModule<T extends IApplication> extends AbstractModule
-        implements ILocalizationModule, IUtilitiesModule {
+        implements ILocalizationModule, IUtilitiesModule, IWaitingsModule {
 
     private final Provider<T> applicationProvider;
 
@@ -37,5 +41,6 @@ protected void configure() {
         bind(IElementActionRetrier.class).to(getElementActionRetrierImplementation()).in(Singleton.class);
         bind(ILocalizationManager.class).to(getLocalizationManagerImplementation()).in(Singleton.class);
         bind(ILocalizedLogger.class).to(getLocalizedLoggerImplementation()).in(Singleton.class);
+        bind(IConditionalWait.class).to(getConditionalWaitImplementation());
     }
 }

src/main/java/aquality/selenium/core/application/AqualityServices.java → src/main/java/aquality/selenium/core/applications/AqualityServices.java

@@ -1,4 +1,4 @@
-package aquality.selenium.core.application;
+package aquality.selenium.core.applications;
 
 import com.google.inject.Guice;
 import com.google.inject.Injector;

src/main/java/aquality/selenium/core/application/IApplication.java → src/main/java/aquality/selenium/core/applications/IApplication.java

@@ -1,4 +1,4 @@
-package aquality.selenium.core.application;
+package aquality.selenium.core.applications;
 
 import org.openqa.selenium.remote.RemoteWebDriver;
 

src/main/java/aquality/selenium/core/localization/ILocalizationManager.java

@@ -6,6 +6,7 @@
 public interface ILocalizationManager {
     /**
      * Gets localized message from resources by its key.
+     *
      * @param messageKey Key in resource file.
      * @param args Arguments, which will be provided to template of localized message.
      * @return Localized message.

src/main/java/aquality/selenium/core/waitings/ConditionalWait.java

@@ -0,0 +1,112 @@
+package aquality.selenium.core.waitings;
+
+import aquality.selenium.core.applications.IApplication;
+import aquality.selenium.core.configurations.ITimeoutConfiguration;
+import com.google.common.base.Strings;
+import com.google.inject.Inject;
+import com.google.inject.Provider;
+import org.openqa.selenium.StaleElementReferenceException;
+import org.openqa.selenium.support.ui.ExpectedCondition;
+import org.openqa.selenium.support.ui.WebDriverWait;
+
+import java.time.Duration;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.Optional;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
+import java.util.function.BooleanSupplier;
+
+public class ConditionalWait implements IConditionalWait {
+
+    private final Provider<IApplication> applicationProvider;
+    private final ITimeoutConfiguration timeoutConfiguration;
+
+    @Inject
+    public ConditionalWait(Provider<IApplication> applicationProvider, ITimeoutConfiguration timeoutConfiguration) {
+        this.applicationProvider = applicationProvider;
+        this.timeoutConfiguration = timeoutConfiguration;
+    }
+
+    @Override
+    public boolean waitFor(BooleanSupplier condition, Long timeoutInSeconds, Long pollingIntervalInMilliseconds, String message, Collection<Class<? extends Throwable>> exceptionsToIgnore) {
+        try {
+            waitForTrue(condition, timeoutInSeconds, pollingIntervalInMilliseconds, message, exceptionsToIgnore);
+            return true;
+        } catch (TimeoutException e) {
+            return false;
+        }
+    }
+
+    @Override
+    public void waitForTrue(BooleanSupplier condition, Long timeoutInSeconds, Long pollingIntervalInMilliseconds, String message, Collection<Class<? extends Throwable>> exceptionsToIgnore) throws TimeoutException {
+        BooleanSupplier supplier = Optional.ofNullable(condition).orElseThrow(() -> new IllegalArgumentException("Condition cannot be null"));
+        Long timeout = resolveConditionTimeout(timeoutInSeconds);
+        Long pollingInterval = resolvePollingInterval(pollingIntervalInMilliseconds);
+        String exMessage = resolveMessage(message);
+        double startTime = getCurrentTime();
+        while (true) {
+            if (isConditionSatisfied(supplier, exceptionsToIgnore)) {
+                return;
+            }
+
+            double currentTime = getCurrentTime();
+            if ((currentTime - startTime) > timeout) {
+                String exceptionMessage = String.format("Timed out after %1$s seconds during wait for condition '%2$s'", timeout, exMessage);
+                throw new TimeoutException(exceptionMessage);
+            }
+
+            try {
+                Thread.sleep(pollingInterval);
+            } catch (InterruptedException e) {
+                Thread.currentThread().interrupt();
+            }
+        }
+    }
+
+    @Override
+    public <T> T waitFor(ExpectedCondition<T> condition, Long timeoutInSeconds, Long pollingIntervalInMilliseconds, String message, Collection<Class<? extends Throwable>> exceptionsToIgnore) {
+        IApplication app = applicationProvider.get();
+        app.setImplicitWaitTimeout(0, TimeUnit.SECONDS);
+        Long timeout = resolveConditionTimeout(timeoutInSeconds);
+        Long pollingInterval = resolvePollingInterval(pollingIntervalInMilliseconds);
+        String exMessage = resolveMessage(message);
+        WebDriverWait wait = new WebDriverWait(app.getDriver(), timeout);
+        wait.pollingEvery(Duration.ofMillis(pollingInterval));
+        wait.withMessage(exMessage);
+        wait.ignoreAll(exceptionsToIgnore == null ? Collections.singleton(StaleElementReferenceException.class) : exceptionsToIgnore);
+        try {
+            return wait.until(condition);
+        } finally {
+            app.setImplicitWaitTimeout(timeoutConfiguration.getImplicit(), TimeUnit.SECONDS);
+        }
+    }
+
+    private double getCurrentTime() {
+        return System.nanoTime() / Math.pow(10, 9);
+    }
+
+    private boolean isConditionSatisfied(BooleanSupplier condition, Collection<Class<? extends Throwable>> exceptionsToIgnore) {
+        try {
+            return condition.getAsBoolean();
+        } catch (Exception e) {
+            if (exceptionsToIgnore == null || !exceptionsToIgnore.contains(e.getClass())) {
+                throw e;
+            }
+
+            return false;
+        }
+    }
+
+    private Long resolveConditionTimeout(Long timeout) {
+        return Optional.ofNullable(timeout).orElse(timeoutConfiguration.getCommand());
+    }
+
+    private Long resolvePollingInterval(Long timeout) {
+        return Optional.ofNullable(timeout).orElse(timeoutConfiguration.getPollingInterval());
+    }
+
+    private String resolveMessage(String message) {
+        return Strings.isNullOrEmpty(message) ? "" : message;
+    }
+}