Merge pull request #9 from Vertispan/gwt-driver-8

gwt-driver-8 - Added overloaded waitFor methods to support passing a timeout message

src/main/java/com/vertispan/webdriver/gwt/gwtdriver/models/GwtWidgetFinder.java

@@ -28,8 +28,11 @@
 
 import java.time.Duration;
 import java.time.temporal.TemporalUnit;
+import java.util.function.Supplier;
 
 public class GwtWidgetFinder<W extends GwtWidget<?>> {
+  public static final Duration DEFAULT_WAITFOR_DURATION = Duration.ofSeconds(10);
+
   protected WebDriver driver;
   protected WebElement elt;
 
@@ -57,16 +60,33 @@ assert getClass()
   }
 
   public W waitFor() {
-    return waitFor(Duration.ofSeconds(10));
+    return waitFor((Supplier<String>) null);
+  }
+
+  public W waitFor(String message) {
+    return waitFor(message == null ? null : () -> message);
+  }
+
+  public W waitFor(Supplier<String> messageSupplier) {
+    return waitFor(DEFAULT_WAITFOR_DURATION, messageSupplier);
   }
 
   public W waitFor(long duration, TemporalUnit unit) {
     return waitFor(Duration.of(duration, unit));
   }
 
   public W waitFor(Duration duration) {
+    return waitFor(duration, (Supplier<String>) null);
+  }
+
+  public W waitFor(Duration duration, String message) {
+    return waitFor(duration, message == null ? null : () -> message);
+  }
+
+  public W waitFor(Duration duration, Supplier<String> messageSupplier) {
     return new FluentWait<>(driver)
         .withTimeout(duration)
+        .withMessage(messageSupplier)
         .ignoring(NotFoundException.class)
         .until((Function<WebDriver, W>) webDriver -> done());
   }

src/test/java/com/vertispan/webdriver/gwt/gwtdriver/models/SimpleWidgetTest.java

@@ -38,11 +38,13 @@
 import org.junit.jupiter.api.Test;
 import org.openqa.selenium.By;
 import org.openqa.selenium.Point;
+import org.openqa.selenium.TimeoutException;
 import org.openqa.selenium.WebElement;
 import org.openqa.selenium.chrome.ChromeDriver;
 import org.openqa.selenium.chrome.ChromeOptions;
 import org.openqa.selenium.interactions.Actions;
 
+import java.time.Duration;
 import java.util.List;
 
 import io.github.bonigarcia.wdm.WebDriverManager;
@@ -219,4 +221,23 @@ void testFindDescedantWidgets() {
     assertEquals(5, elements.size());
     System.out.println(elements.size());
   }
+
+  @Test
+  void waitTimeout() {
+    driver.get(url);
+
+    WidgetContainer widget = new GwtRootPanel(driver);
+    assert widget.as(GwtRootPanel.class) != null;
+
+    String messageInTimeout = "This will be in the timeout message";
+
+    try {
+      GwtWidget.find(Button.class, driver)
+          .withText("Test Button Doesnt Exist")
+          .waitFor(Duration.ofMillis(1), messageInTimeout);
+      fail("This should fail when it doesn't find the widget");
+    } catch (TimeoutException e) {
+      assertTrue(e.getMessage().contains(messageInTimeout));
+    }
+  }
 }