Extended @Waituntil with the option to configure a custom timeout

Author: slu-it

webtester-core/src/main/java/info/novatec/testit/webtester/internal/proxies/impls/IdentifyUsingImpl.java

@@ -2,6 +2,7 @@
 
 import java.lang.reflect.Method;
 import java.util.Optional;
+import java.util.function.Predicate;
 import java.util.function.Supplier;
 
 import org.openqa.selenium.SearchContext;
@@ -87,9 +88,14 @@ private void waitIfAnnotationPresent(Method method, PageFragment fragment) {
         }
     }
 
-    private void doWaitUntil(WaitUntil waitAnnotation, PageFragment fragment) {
+    private void doWaitUntil(WaitUntil annotation, PageFragment fragment) {
         try {
-            Wait.until(fragment).is(waitAnnotation.value().newInstance());
+            Predicate<? super PageFragment> condition = annotation.value().newInstance();
+            if (annotation.timeout() > 0) {
+                Wait.withTimeoutOf(annotation.timeout(), annotation.unit()).until(fragment).is(condition);
+            } else {
+                Wait.until(fragment).is(condition);
+            }
         } catch (InstantiationException | IllegalAccessException e) {
             throw new IllegalSignatureException(COULD_NOT_CREATE_PREDICATE_INSTANCE_MSG, e);
         }

webtester-core/src/main/java/info/novatec/testit/webtester/pagefragments/annotations/WaitUntil.java

@@ -4,8 +4,10 @@
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
+import java.util.concurrent.TimeUnit;
 import java.util.function.Predicate;
 
+import info.novatec.testit.webtester.browser.Browser;
 import info.novatec.testit.webtester.conditions.Conditions;
 import info.novatec.testit.webtester.conditions.pagefragments.Disabled;
 import info.novatec.testit.webtester.conditions.pagefragments.Editable;
@@ -17,14 +19,16 @@
 import info.novatec.testit.webtester.conditions.pagefragments.ReadOnly;
 import info.novatec.testit.webtester.conditions.pagefragments.Selected;
 import info.novatec.testit.webtester.conditions.pagefragments.Visible;
+import info.novatec.testit.webtester.config.Configuration;
 import info.novatec.testit.webtester.pagefragments.PageFragment;
 import info.novatec.testit.webtester.pages.Page;
 
 
 /**
  * Identification methods of {@link Page pages} and {@link PageFragment page fragments} can be annotation with this
  * annotation. With it the framework will wait until the specified {@link #value() predicate} returns true or the timeout is
- * reached.
+ * reached. In case no custom timeout is configured, the defaults of the host {@link Browser browser's} {@link
+ * Configuration} is used.
  * <p>
  * <b>Important:</b> The used predicate class must provide a default constructor! Hence not all of our provided {@link
  * Conditions} will work. The following conditions can be used:
@@ -63,6 +67,23 @@
      */
     Class<? extends Predicate<PageFragment>> value();
 
-    // TODO: timeout
+    /**
+     * The timeout to use. Defaults to {@code 0} which will signal the framework to use the {@link Browser browser's}
+     * configured default timeout. The default unit of time is seconds. This can be changed by also setting the {@link
+     * #unit()} property.
+     *
+     * @return the timeout to use
+     * @since 2.0
+     */
+    int timeout() default 0;
+
+    /**
+     * The {@link TimeUnit} to use for the timeout. This will only be used in case {@link #timeout()} is set to a value
+     * greater than {@code 0}. The smallest unit that will have an effect is milliseconds!
+     *
+     * @return the time unit to use
+     * @since 2.0
+     */
+    TimeUnit unit() default TimeUnit.SECONDS;
 
 }

webtester-core/src/test/java/features/WaitUntilAnnotationFeatureTest.java

@@ -2,6 +2,8 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
+import java.util.concurrent.TimeUnit;
+
 import org.junit.Before;
 import org.junit.Test;
 
@@ -57,7 +59,7 @@ public interface FeaturePage extends Page {
         @IdentifyUsing("#becomesVisible")
         Button becomesVisible();
 
-        @WaitUntil(Present.class)
+        @WaitUntil(value = Present.class, timeout = 50, unit = TimeUnit.MILLISECONDS)
         @IdentifyUsing("#unknown")
         Button neverPresent();