Adding documentation to the new added method in the

davidtorres · davidtorres · commit 204438ca8171 · 2017-04-12T10:09:27.000-04:00
FakeScheduledExecutor that allow you to set expectations on scheduled
work.
diff --git a/google-cloud-pubsub/src/test/java/com/google/cloud/pubsub/spi/v1/FakeScheduledExecutorService.java b/google-cloud-pubsub/src/test/java/com/google/cloud/pubsub/spi/v1/FakeScheduledExecutorService.java
@@ -82,12 +82,23 @@ public ScheduledFuture<?> scheduleWithFixedDelay(
             Duration.millis(unit.toMillis(initialDelay)), command, PendingCallableType.FIXED_DELAY));
   }
 
+  /**
+   * This allows for adding expectations on future work to be scheduled (
+   * {@link FakeScheduledExecutorService#schedule}
+   * or {@link FakeScheduledExecutorService#scheduleAtFixedRate}
+   * or {@link FakeScheduledExecutorService#scheduleWithFixedDelay}) based on its delay.
+   */
   public void setupScheduleExpectation(Duration delay) {
     synchronized (expectedWorkQueue) {
       expectedWorkQueue.add(delay);
     }
   }
   
+  /**
+   * Blocks the current thread until all the work 
+   * {@link FakeScheduledExecutorService#setupScheduleExpectation(Duration) expected} has been
+   * scheduled in the executor. 
+   */
   public void waitForExpectedWork() {
     synchronized (expectedWorkQueue) {
       while (!expectedWorkQueue.isEmpty()) {
@@ -115,7 +126,8 @@ private void work() {
     for (;;) {
       PendingCallable<?> callable = null;
       synchronized (pendingCallables) {
-        if (pendingCallables.isEmpty() || pendingCallables.peek().getScheduledTime().isAfter(cmpTime)) {
+        if (pendingCallables.isEmpty()
+            || pendingCallables.peek().getScheduledTime().isAfter(cmpTime)) {
           break;
         }
         callable = pendingCallables.poll();
@@ -204,6 +216,9 @@ <V> ScheduledFuture<V> schedulePendingCallable(PendingCallable<V> callable) {
     }
     work();
     synchronized (expectedWorkQueue) {
+      // We compare by the callable delay in order decide when to remove expectations from the
+      // expected work queue, i.e. only the expected work that matches the delay of the scheduled
+      // callable is removed from the queue.
       if (!expectedWorkQueue.isEmpty() && expectedWorkQueue.peek().equals(callable.delay)) {
         expectedWorkQueue.poll();
       }
diff --git a/google-cloud-pubsub/src/test/java/com/google/cloud/pubsub/spi/v1/SubscriberImplTest.java b/google-cloud-pubsub/src/test/java/com/google/cloud/pubsub/spi/v1/SubscriberImplTest.java
@@ -284,7 +284,7 @@ public void testModifyAckDeadline() throws Exception {
     // Send messages to be acked
     List<String> testAckIdsBatch = ImmutableList.of("A", "B", "C");
     testReceiver.setExplicitAck(true);
-    // A modify ack deadline should be schedule for the next 9s
+    // A modify ack deadline should be scheduled for the next 9s
     fakeExecutor.setupScheduleExpectation(Duration.standardSeconds(9)); 
     sendMessages(testAckIdsBatch);
     // To ensure first modify ack deadline got scheduled
