Renamed Waiter to DefaultWaiter and extracted interface to fit better in the naming scheme for single implementation interfaces

Author: slu-it

webtester-core/src/main/java/info/novatec/testit/webtester/waiting/ConfiguredWait.java

@@ -18,13 +18,9 @@
 @Getter(AccessLevel.PACKAGE)
 public class ConfiguredWait {
 
-    /**
-     * The {@link Waiter} to use when executing wait operations.
-     */
+    /** The {@link Waiter} to use when executing wait operations. */
     private final Waiter waiter;
-    /**
-     * The {@link WaitConfig} to use when deciding how long to wait.
-     */
+    /** The {@link WaitConfig} to use when deciding how long to wait. */
     private final WaitConfig config;
 
     /**

webtester-core/src/main/java/info/novatec/testit/webtester/waiting/Wait.java

@@ -25,8 +25,8 @@
  */
 public final class Wait {
 
-    /** The default {@link Waiter} supplier. Generates a new {@link Waiter} for each call. */
-    public static final Supplier<Waiter> DEFAULT_WAITER = Waiter::new;
+    /** The default {@link Waiter} supplier. Generates a new {@link DefaultWaiter} for each call. */
+    public static final Supplier<Waiter> DEFAULT_WAITER = DefaultWaiter::new;
 
     /**
      * A supplier used to get a {@link Waiter} instance to use when executing any wait operations.

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

@@ -5,7 +5,6 @@
 
 import info.novatec.testit.webtester.conditions.Condition;
 import info.novatec.testit.webtester.conditions.Conditions;
-import info.novatec.testit.webtester.pagefragments.PageFragment;
 
 
 /**
@@ -22,7 +21,7 @@ public class WaitUntil<T> {
     private final T object;
 
     /**
-     * Creates a new {@link WaitUntil} instance for the given {@link PageFragment} and {@link WaitConfig}.
+     * Creates a new {@link WaitUntil} instance for the given object and {@link WaitConfig}.
      *
      * @param config the configuration to use
      * @param object the object to use

webtester-core/src/main/java/info/novatec/testit/webtester/waiting/Waiter.java

@@ -1,68 +1,16 @@
 package info.novatec.testit.webtester.waiting;
 
-import java.time.Clock;
 import java.util.concurrent.TimeUnit;
 import java.util.function.Supplier;
 
-import lombok.AccessLevel;
-import lombok.Getter;
-import lombok.extern.slf4j.Slf4j;
-
 
 /**
- * Provides different kinds of wait operations. The two basic types are 'wait exactly X amount of time' and 'wait until X
- * passes a certain condition check'.
+ * Implementations of this interface provide different kinds of wait operations.
+ * The two basic types are 'wait exactly X amount of time' and 'wait until X passes a certain condition check'.
  *
  * @since 2.0
  */
-@Slf4j
-@Getter(AccessLevel.PROTECTED)
-public class Waiter {
-
-    /**
-     * The {@link Sleeper} to use when actually needing to pass time.
-     */
-    private final Sleeper sleeper;
-    /**
-     * The {@link Clock} to use for tracking the passing of time.
-     */
-    private final Clock clock;
-
-    /**
-     * Creates a new default {@link Waiter}. It has a {@link CurrentThreadSleeper} as a sleeper and a {@link
-     * Clock#systemDefaultZone()} clock.
-     *
-     * @see Sleeper
-     * @see Clock
-     * @since 2.0
-     */
-    public Waiter() {
-        this(new CurrentThreadSleeper());
-    }
-
-    /**
-     * Creates a new custom {@link Waiter}. It will use the given {@link Sleeper} and a {@link Clock#systemDefaultZone()}
-     * clock.
-     *
-     * @see Sleeper
-     * @see Clock
-     * @since 2.0
-     */
-    public Waiter(Sleeper sleeper) {
-        this(sleeper, Clock.systemDefaultZone());
-    }
-
-    /**
-     * Creates a new custom {@link Waiter}. It will use the given {@link Sleeper} and a {@link Clock}.
-     *
-     * @see Sleeper
-     * @see Clock
-     * @since 2.0
-     */
-    public Waiter(Sleeper sleeper, Clock clock) {
-        this.sleeper = sleeper;
-        this.clock = clock;
-    }
+public interface Waiter {
 
     /**
      * Waits the given amount of time using the {@link TimeUnit time unit}.
@@ -74,16 +22,7 @@ public Waiter(Sleeper sleeper, Clock clock) {
      * @param timeUnit the time unit to use
      * @since 2.0
      */
-    public void waitExactly(long duration, TimeUnit timeUnit) {
-        try {
-            long millisToSleep = timeUnit.toMillis(duration);
-            if (millisToSleep > 0) {
-                sleeper.sleep(millisToSleep);
-            }
-        } catch (InterruptionException e) {
-            log.debug("wait was interrupted", e);
-        }
-    }
+    void waitExactly(long duration, TimeUnit timeUnit);
 
     /**
      * Waits until the given boolean {@link Supplier} returns <code>true</code> or the {@link WaitConfig configured} timeout
@@ -94,46 +33,6 @@ public void waitExactly(long duration, TimeUnit timeUnit) {
      * @see WaitConfig
      * @since 2.0
      */
-    @SuppressWarnings("PMD.AvoidCatchingGenericException")
-    public void waitUntil(WaitConfig config, Supplier<Boolean> condition) {
-
-        long effectiveTimeout = config.getTimeoutInMillis();
-        long start = now();
-
-        boolean conditionMet = false;
-        RuntimeException lastException = null;
-
-        do {
-            try {
-                conditionMet = condition.get();
-            } catch (RuntimeException e) {
-                lastException = e;
-            }
-            log.trace("condition '{}' met: {}", condition, conditionMet);
-            if (!conditionMet) {
-                waitExactly(config.getInterval(), TimeUnit.MILLISECONDS);
-            }
-        } while (!conditionMet && timeSince(start) < effectiveTimeout);
-
-        if (!conditionMet) {
-            String message = "condition not met within the given timeout";
-            log.debug("condition not met: {}", condition);
-            if (lastException != null) {
-                throw new TimeoutException(message, lastException);
-            }
-            throw new TimeoutException(message);
-        } else {
-            log.debug("condition met: {}", condition);
-        }
-
-    }
-
-    private long timeSince(long start) {
-        return now() - start;
-    }
-
-    private long now() {
-        return clock.millis();
-    }
+    void waitUntil(WaitConfig config, Supplier<Boolean> condition);
 
 }

webtester-core/src/test/java/info/novatec/testit/webtester/waiting/WaiterTest.java renamed to webtester-core/src/test/java/info/novatec/testit/webtester/waiting/DefaultWaiterTest.java

@@ -24,21 +24,21 @@
 
 
 @RunWith(Enclosed.class)
-public class WaiterTest {
+public class DefaultWaiterTest {
 
     public static class Construction {
 
         @Test
         public void defaultWaiterCanBeInitialized() {
-            Waiter waiter = new Waiter();
+            DefaultWaiter waiter = new DefaultWaiter();
             assertThat(waiter.getSleeper()).isInstanceOf(CurrentThreadSleeper.class);
             assertThat(waiter.getClock()).isNotNull();
         }
 
         @Test
         public void sleeperCanBeCustomized() {
             Sleeper sleeper = mock(Sleeper.class);
-            Waiter waiter = new Waiter(sleeper);
+            DefaultWaiter waiter = new DefaultWaiter(sleeper);
             assertThat(waiter.getSleeper()).isSameAs(sleeper);
             assertThat(waiter.getClock()).isNotNull();
         }
@@ -47,7 +47,7 @@ public void sleeperCanBeCustomized() {
         public void sleeperAndClockCanBeCustomized() {
             Sleeper sleeper = mock(Sleeper.class);
             Clock clock = mock(Clock.class);
-            Waiter waiter = new Waiter(sleeper, clock);
+            DefaultWaiter waiter = new DefaultWaiter(sleeper, clock);
             assertThat(waiter.getSleeper()).isSameAs(sleeper);
             assertThat(waiter.getClock()).isSameAs(clock);
         }
@@ -60,7 +60,7 @@ public static class WaitExactly {
         @Mock
         Sleeper sleeper;
         @InjectMocks
-        Waiter cut;
+        DefaultWaiter cut;
 
         @Test
         public void waitingOneSecondsSleepsForOneThousandMilliseconds() {
@@ -105,7 +105,7 @@ public static class WaitUntil {
         @Mock
         Clock clock;
         @InjectMocks
-        Waiter cut;
+        DefaultWaiter cut;
 
         @Mock
         Supplier<Boolean> condition;