Increment the clock in expand recurring billings events test

Also adds some clarity on when to use the non-incrementing version.

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=143037508

javatests/google/registry/batch/DeleteContactsAndHostsActionTest.java

@@ -142,6 +142,7 @@ public class DeleteContactsAndHostsActionTest
     createTld("tld");
     clock.advanceOneMilli();
   }
+
   @Test
   public void testSuccess_contact_referencedByActiveDomain_doesNotGetDeleted() throws Exception {
     ContactResource contact = persistContactPendingDelete("blah8221");

javatests/google/registry/batch/ExpandRecurringBillingEventsActionTest.java

@@ -38,11 +38,13 @@ import google.registry.model.billing.BillingEvent.Flag;
 import google.registry.model.billing.BillingEvent.Reason;
 import google.registry.model.common.Cursor;
 import google.registry.model.domain.DomainResource;
+import google.registry.model.ofy.Ofy;
 import google.registry.model.registry.Registry;
 import google.registry.model.reporting.HistoryEntry;
 import google.registry.testing.ExceptionRule;
 import google.registry.testing.FakeClock;
 import google.registry.testing.FakeResponse;
+import google.registry.testing.InjectRule;
 import google.registry.testing.mapreduce.MapreduceTestCase;
 import java.util.ArrayList;
 import java.util.List;
@@ -62,7 +64,11 @@ public class ExpandRecurringBillingEventsActionTest
   @Rule
   public final ExceptionRule thrown = new ExceptionRule();
 
-  final FakeClock clock = new FakeClock(DateTime.parse("2000-10-02T00:00:00Z"));
+  @Rule
+  public final InjectRule inject = new InjectRule();
+
+  private final DateTime beginningOfTest = DateTime.parse("2000-10-02T00:00:00Z");
+  private final FakeClock clock = new FakeClock(beginningOfTest);
 
   DomainResource domain;
   HistoryEntry historyEntry;
@@ -70,6 +76,7 @@ public class ExpandRecurringBillingEventsActionTest
 
   @Before
   public void init() {
+    inject.setStaticField(Ofy.class, "clock", clock);
     action = new ExpandRecurringBillingEventsAction();
     action.mrRunner = makeDefaultRunner();
     action.clock = clock;
@@ -100,7 +107,7 @@ public class ExpandRecurringBillingEventsActionTest
   void runMapreduce() throws Exception {
     action.response = new FakeResponse();
     action.run();
-    executeTasksUntilEmpty("mapreduce");
+    executeTasksUntilEmpty("mapreduce", clock);
     ofy().clearSessionCache();
   }
 
@@ -125,12 +132,12 @@ public class ExpandRecurringBillingEventsActionTest
         .setParent(historyEntry)
         .setPeriodYears(1)
         .setReason(Reason.RENEW)
-        .setSyntheticCreationTime(clock.nowUtc())
+        .setSyntheticCreationTime(beginningOfTest)
         .setCancellationMatchingBillingEvent(Key.create(recurring))
         .setTargetId(domain.getFullyQualifiedDomainName())
         .build();
     assertBillingEventsForResource(domain, expected, recurring);
-    assertCursorAt(clock.nowUtc());
+    assertCursorAt(beginningOfTest);
   }
 
   @Test
@@ -148,14 +155,15 @@ public class ExpandRecurringBillingEventsActionTest
         .setParent(historyEntry)
         .setPeriodYears(1)
         .setReason(Reason.RENEW)
-        .setSyntheticCreationTime(clock.nowUtc())
+        .setSyntheticCreationTime(beginningOfTest)
         .setCancellationMatchingBillingEvent(Key.create(recurring))
         .setTargetId(domain.getFullyQualifiedDomainName())
         .build();
-    assertCursorAt(clock.nowUtc());
+    assertCursorAt(beginningOfTest);
+    DateTime beginningOfSecondRun = clock.nowUtc();
     action.response = new FakeResponse();
     runMapreduce();
-    assertCursorAt(clock.nowUtc());
+    assertCursorAt(beginningOfSecondRun);
     assertBillingEventsForResource(domain, expected, recurring);
   }
 
@@ -172,13 +180,13 @@ public class ExpandRecurringBillingEventsActionTest
         .setParent(historyEntry)
         .setPeriodYears(1)
         .setReason(Reason.RENEW)
-        .setSyntheticCreationTime(clock.nowUtc())
+        .setSyntheticCreationTime(beginningOfTest)
         .setCancellationMatchingBillingEvent(Key.create(recurring))
         .setTargetId(domain.getFullyQualifiedDomainName())
         .build());
     action.cursorTimeParam = Optional.of(START_OF_TIME);
     runMapreduce();
-    assertCursorAt(clock.nowUtc());
+    assertCursorAt(beginningOfTest);
     assertBillingEventsForResource(domain, persisted, recurring); // no additional billing events
   }
 
@@ -195,7 +203,7 @@ public class ExpandRecurringBillingEventsActionTest
         .setParent(historyEntry)
         .setPeriodYears(1)
         .setReason(Reason.RENEW)
-        .setSyntheticCreationTime(clock.nowUtc())
+        .setSyntheticCreationTime(beginningOfTest)
         .setCancellationMatchingBillingEvent(Key.create(recurring))
         .setTargetId(domain.getFullyQualifiedDomainName())
         .build();
@@ -206,7 +214,7 @@ public class ExpandRecurringBillingEventsActionTest
         .build());
     action.cursorTimeParam = Optional.of(START_OF_TIME);
     runMapreduce();
-    assertCursorAt(clock.nowUtc());
+    assertCursorAt(beginningOfTest);
     assertBillingEventsForResource(domain, persisted, expected, recurring);
   }
 
@@ -226,7 +234,7 @@ public class ExpandRecurringBillingEventsActionTest
         .setParent(historyEntry)
         .setPeriodYears(1)
         .setReason(Reason.RENEW)
-        .setSyntheticCreationTime(clock.nowUtc())
+        .setSyntheticCreationTime(beginningOfTest)
         .setCancellationMatchingBillingEvent(Key.create(recurring))
         .setTargetId(domain.getFullyQualifiedDomainName())
         .build();
@@ -236,7 +244,7 @@ public class ExpandRecurringBillingEventsActionTest
         .build());
     action.cursorTimeParam = Optional.of(START_OF_TIME);
     runMapreduce();
-    assertCursorAt(clock.nowUtc());
+    assertCursorAt(beginningOfTest);
     assertBillingEventsForResource(domain, persisted, expected, recurring, recurring2);
   }
 
@@ -249,7 +257,7 @@ public class ExpandRecurringBillingEventsActionTest
     action.cursorTimeParam = Optional.of(DateTime.parse("2000-01-01T00:00:00Z"));
     runMapreduce();
     assertBillingEventsForResource(domain, recurring);
-    assertCursorAt(clock.nowUtc());
+    assertCursorAt(beginningOfTest);
   }
 
   @Test
@@ -277,12 +285,12 @@ public class ExpandRecurringBillingEventsActionTest
         .setParent(historyEntry)
         .setPeriodYears(1)
         .setReason(Reason.RENEW)
-        .setSyntheticCreationTime(clock.nowUtc())
+        .setSyntheticCreationTime(beginningOfTest)
         .setCancellationMatchingBillingEvent(Key.create(recurring))
         .setTargetId(domain.getFullyQualifiedDomainName())
         .build();
     assertBillingEventsForResource(domain, expected, recurring);
-    assertCursorAt(clock.nowUtc());
+    assertCursorAt(beginningOfTest);
   }
 
   @Test
@@ -301,35 +309,37 @@ public class ExpandRecurringBillingEventsActionTest
         .setParent(historyEntry)
         .setPeriodYears(1)
         .setReason(Reason.RENEW)
-        .setSyntheticCreationTime(clock.nowUtc())
+        .setSyntheticCreationTime(beginningOfTest)
         .setCancellationMatchingBillingEvent(Key.create(recurring))
         .setTargetId(domain.getFullyQualifiedDomainName())
         .build();
     assertBillingEventsForResource(domain, expected, recurring);
-    assertCursorAt(clock.nowUtc());
+    assertCursorAt(beginningOfTest);
   }
 
   @Test
   public void testSuccess_expandSingleEvent_billingTimeAtExecutionTime() throws Exception {
+    DateTime testTime = DateTime.parse("2000-02-19T00:00:00Z").minusMillis(1);
     persistResource(recurring);
     action.cursorTimeParam = Optional.of(START_OF_TIME);
     // Clock is advanced one milli in runMapreduce()
-    clock.setTo(DateTime.parse("2000-02-19T00:00:00Z").minusMillis(1));
+    clock.setTo(testTime);
     runMapreduce();
     // A candidate billing event is set to be billed exactly on 2/19/00 @ 00:00,
     // but these should not be generated as the interval is closed on cursorTime, open on
     // executeTime.
     assertBillingEventsForResource(domain, recurring);
-    assertCursorAt(clock.nowUtc());
+    assertCursorAt(testTime);
   }
 
   @Test
   public void testSuccess_expandSingleEvent_multipleYearCreate() throws Exception {
+    DateTime testTime = beginningOfTest.plusYears(2);
     action.cursorTimeParam = Optional.of(recurring.getEventTime());
-    recurring = persistResource(recurring.asBuilder()
+    recurring =
-        .setEventTime(recurring.getEventTime().plusYears(2))
+        persistResource(
-        .build());
+            recurring.asBuilder().setEventTime(recurring.getEventTime().plusYears(2)).build());
-    clock.setTo(clock.nowUtc().plusYears(2));
+    clock.setTo(testTime);
     runMapreduce();
     BillingEvent.OneTime expected = new BillingEvent.OneTime.Builder()
         // Default renew grace period of 45 days.
@@ -341,12 +351,12 @@ public class ExpandRecurringBillingEventsActionTest
         .setParent(historyEntry)
         .setPeriodYears(1)
         .setReason(Reason.RENEW)
-        .setSyntheticCreationTime(clock.nowUtc())
+        .setSyntheticCreationTime(testTime)
         .setCancellationMatchingBillingEvent(Key.create(recurring))
         .setTargetId(domain.getFullyQualifiedDomainName())
         .build();
     assertBillingEventsForResource(domain, expected, recurring);
-    assertCursorAt(clock.nowUtc());
+    assertCursorAt(testTime);
   }
 
   @Test
@@ -364,12 +374,12 @@ public class ExpandRecurringBillingEventsActionTest
         .setParent(historyEntry)
         .setPeriodYears(1)
         .setReason(Reason.RENEW)
-        .setSyntheticCreationTime(clock.nowUtc())
+        .setSyntheticCreationTime(beginningOfTest)
         .setCancellationMatchingBillingEvent(Key.create(recurring))
         .setTargetId(domain.getFullyQualifiedDomainName())
         .build();
     assertBillingEventsForResource(domain, expected, recurring);
-    assertCursorAt(clock.nowUtc());
+    assertCursorAt(beginningOfTest);
   }
 
   @Test
@@ -379,7 +389,7 @@ public class ExpandRecurringBillingEventsActionTest
     saveCursor(clock.nowUtc().minusSeconds(1));
     runMapreduce();
     assertBillingEventsForResource(domain, recurring);
-    assertCursorAt(clock.nowUtc());
+    assertCursorAt(beginningOfTest);
   }
 
   @Test
@@ -394,7 +404,8 @@ public class ExpandRecurringBillingEventsActionTest
 
   @Test
   public void testSuccess_expandSingleEvent_multipleYears() throws Exception {
-    clock.setTo(clock.nowUtc().plusYears(5));
+    DateTime testTime = clock.nowUtc().plusYears(5);
+    clock.setTo(testTime);
     List<BillingEvent> expectedEvents = new ArrayList<>();
     expectedEvents.add(persistResource(recurring));
     action.cursorTimeParam = Optional.of(START_OF_TIME);
@@ -413,18 +424,19 @@ public class ExpandRecurringBillingEventsActionTest
           .setParent(historyEntry)
           .setPeriodYears(1)
           .setReason(Reason.RENEW)
-          .setSyntheticCreationTime(clock.nowUtc())
+          .setSyntheticCreationTime(testTime)
           .setCancellationMatchingBillingEvent(Key.create(recurring))
           .setTargetId(domain.getFullyQualifiedDomainName())
           .build());
     }
     assertBillingEventsForResource(domain, Iterables.toArray(expectedEvents, BillingEvent.class));
-    assertCursorAt(clock.nowUtc());
+    assertCursorAt(testTime);
   }
 
   @Test
   public void testSuccess_expandSingleEvent_multipleYears_cursorInBetweenYears() throws Exception {
-    clock.setTo(clock.nowUtc().plusYears(5));
+    DateTime testTime = clock.nowUtc().plusYears(5);
+    clock.setTo(testTime);
     List<BillingEvent> expectedEvents = new ArrayList<>();
     expectedEvents.add(persistResource(recurring));
     saveCursor(DateTime.parse("2003-10-02T00:00:00Z"));
@@ -443,28 +455,30 @@ public class ExpandRecurringBillingEventsActionTest
           .setParent(historyEntry)
           .setPeriodYears(1)
           .setReason(Reason.RENEW)
-          .setSyntheticCreationTime(clock.nowUtc())
+          .setSyntheticCreationTime(testTime)
           .setCancellationMatchingBillingEvent(Key.create(recurring))
           .setTargetId(domain.getFullyQualifiedDomainName())
           .build());
     }
     assertBillingEventsForResource(domain, Iterables.toArray(expectedEvents, BillingEvent.class));
-    assertCursorAt(clock.nowUtc());
+    assertCursorAt(testTime);
   }
 
   @Test
   public void testSuccess_singleEvent_beforeRenewal() throws Exception {
-    clock.setTo(DateTime.parse("2000-01-04T00:00:00Z"));
+    DateTime testTime = DateTime.parse("2000-01-04T00:00:00Z");
+    clock.setTo(testTime);
     persistResource(recurring);
     action.cursorTimeParam = Optional.of(START_OF_TIME);
     runMapreduce();
     assertBillingEventsForResource(domain, recurring);
-    assertCursorAt(clock.nowUtc());
+    assertCursorAt(testTime);
   }
 
   @Test
   public void testSuccess_singleEvent_afterRecurrenceEnd() throws Exception {
-    clock.setTo(clock.nowUtc().plusYears(2));
+    DateTime testTime = beginningOfTest.plusYears(2);
+    clock.setTo(testTime);
     recurring = persistResource(recurring.asBuilder()
         // Set between event time and billing time (i.e. before the grace period expires) for 2000.
         // We should still expect a billing event.
@@ -481,19 +495,19 @@ public class ExpandRecurringBillingEventsActionTest
         .setParent(historyEntry)
         .setPeriodYears(1)
         .setReason(Reason.RENEW)
-        .setSyntheticCreationTime(clock.nowUtc())
+        .setSyntheticCreationTime(testTime)
         .setCancellationMatchingBillingEvent(Key.create(recurring))
         .setTargetId(domain.getFullyQualifiedDomainName())
         .build();
     assertBillingEventsForResource(domain, recurring, expected);
-    assertCursorAt(clock.nowUtc());
+    assertCursorAt(testTime);
   }
 
   @Test
   public void testSuccess_expandSingleEvent_billingTimeOnLeapYear() throws Exception {
-    recurring = persistResource(recurring.asBuilder()
+    recurring =
-        .setEventTime(DateTime.parse("2000-01-15T00:00:00Z"))
+        persistResource(
-        .build());
+            recurring.asBuilder().setEventTime(DateTime.parse("2000-01-15T00:00:00Z")).build());
     action.cursorTimeParam = Optional.of(START_OF_TIME);
     runMapreduce();
     BillingEvent.OneTime expected = new BillingEvent.OneTime.Builder()
@@ -506,38 +520,39 @@ public class ExpandRecurringBillingEventsActionTest
         .setParent(historyEntry)
         .setPeriodYears(1)
         .setReason(Reason.RENEW)
-        .setSyntheticCreationTime(clock.nowUtc())
+        .setSyntheticCreationTime(beginningOfTest)
         .setCancellationMatchingBillingEvent(Key.create(recurring))
         .setTargetId(domain.getFullyQualifiedDomainName())
         .build();
     assertBillingEventsForResource(domain, expected, recurring);
-    assertCursorAt(clock.nowUtc());
+    assertCursorAt(beginningOfTest);
   }
 
   @Test
   public void testSuccess_expandSingleEvent_billingTimeNotOnLeapYear() throws Exception {
-    recurring = persistResource(recurring.asBuilder()
+    DateTime testTime = DateTime.parse("2001-12-01T00:00:00Z");
-        .setEventTime(DateTime.parse("1999-01-15T00:00:00Z"))
+    recurring =
-        .build());
+        persistResource(
+            recurring.asBuilder().setEventTime(DateTime.parse("2001-01-15T00:00:00Z")).build());
     action.cursorTimeParam = Optional.of(START_OF_TIME);
-    clock.setTo(DateTime.parse("1999-12-01T00:00:00Z"));
+    clock.setTo(testTime);
     runMapreduce();
     BillingEvent.OneTime expected = new BillingEvent.OneTime.Builder()
         // Default renew grace period of 45 days.
-        .setBillingTime(DateTime.parse("1999-03-01T00:00:00Z"))
+        .setBillingTime(DateTime.parse("2001-03-01T00:00:00Z"))
         .setClientId("TheRegistrar")
         .setCost(Money.of(USD, 11))
-        .setEventTime(DateTime.parse("1999-01-15T00:00:00Z"))
+        .setEventTime(DateTime.parse("2001-01-15T00:00:00Z"))
         .setFlags(ImmutableSet.of(Flag.AUTO_RENEW, Flag.SYNTHETIC))
         .setParent(historyEntry)
         .setPeriodYears(1)
         .setReason(Reason.RENEW)
-        .setSyntheticCreationTime(clock.nowUtc())
+        .setSyntheticCreationTime(testTime)
         .setCancellationMatchingBillingEvent(Key.create(recurring))
         .setTargetId(domain.getFullyQualifiedDomainName())
         .build();
     assertBillingEventsForResource(domain, expected, recurring);
-    assertCursorAt(clock.nowUtc());
+    assertCursorAt(testTime);
   }
 
   @Test
@@ -559,7 +574,7 @@ public class ExpandRecurringBillingEventsActionTest
         .setParent(historyEntry)
         .setPeriodYears(1)
         .setReason(Reason.RENEW)
-        .setSyntheticCreationTime(clock.nowUtc())
+        .setSyntheticCreationTime(beginningOfTest)
         .setCancellationMatchingBillingEvent(Key.create(recurring))
         .setTargetId(domain.getFullyQualifiedDomainName())
         .build();
@@ -573,12 +588,12 @@ public class ExpandRecurringBillingEventsActionTest
         .setParent(historyEntry)
         .setPeriodYears(1)
         .setReason(Reason.RENEW)
-        .setSyntheticCreationTime(clock.nowUtc())
+        .setSyntheticCreationTime(beginningOfTest)
         .setCancellationMatchingBillingEvent(Key.create(recurring2))
         .setTargetId(domain.getFullyQualifiedDomainName())
         .build();
     assertBillingEventsForResource(domain, expected, expected2, recurring, recurring2);
-    assertCursorAt(clock.nowUtc());
+    assertCursorAt(beginningOfTest);
   }
 
   @Test
@@ -601,16 +616,17 @@ public class ExpandRecurringBillingEventsActionTest
         .setParent(historyEntry)
         .setPeriodYears(1)
         .setReason(Reason.RENEW)
-        .setSyntheticCreationTime(clock.nowUtc())
+        .setSyntheticCreationTime(beginningOfTest)
         .setCancellationMatchingBillingEvent(Key.create(recurring))
         .setTargetId(domain.getFullyQualifiedDomainName())
         .build();
     assertBillingEventsForResource(domain, expected, recurring);
-    assertCursorAt(clock.nowUtc());
+    assertCursorAt(beginningOfTest);
   }
 
   @Test
   public void testSuccess_varyingRenewPrices() throws Exception {
+    DateTime testTime = beginningOfTest.plusYears(1);
     persistResource(
         Registry.get("tld")
             .asBuilder()
@@ -619,7 +635,7 @@ public class ExpandRecurringBillingEventsActionTest
                     START_OF_TIME, Money.of(USD, 8),
                     DateTime.parse("2000-06-01T00:00:00Z"), Money.of(USD, 10)))
             .build());
-    clock.setTo(clock.nowUtc().plusYears(1));
+    clock.setTo(testTime);
     persistResource(recurring);
     action.cursorTimeParam = Optional.of(START_OF_TIME);
     runMapreduce();
@@ -635,7 +651,7 @@ public class ExpandRecurringBillingEventsActionTest
         .setParent(historyEntry)
         .setPeriodYears(1)
         .setReason(Reason.RENEW)
-        .setSyntheticCreationTime(clock.nowUtc())
+        .setSyntheticCreationTime(testTime)
         .setCancellationMatchingBillingEvent(Key.create(recurring))
         .setTargetId(domain.getFullyQualifiedDomainName())
         .build();
@@ -645,7 +661,7 @@ public class ExpandRecurringBillingEventsActionTest
         .setEventTime(eventDate.plusYears(1))
         .build();
     assertBillingEventsForResource(domain, recurring, cheaper, expensive);
-    assertCursorAt(clock.nowUtc());
+    assertCursorAt(testTime);
   }
 
   @Test

javatests/google/registry/testing/DatastoreHelper.java

@@ -643,7 +643,6 @@ public class DatastoreHelper {
             FluentIterable.from(asList(expected)).transform(BILLING_EVENT_ID_STRIPPER));
   }
 
-
   /** Assert that there are no billing events. */
   public static void assertNoBillingEvents() {
     assertThat(getBillingEvents()).isEmpty();

javatests/google/registry/testing/mapreduce/MapreduceTestCase.java

@@ -158,6 +158,12 @@ public abstract class MapreduceTestCase<T> extends ShardableTestCase {
     }
   }
 
+  /**
+   * Executes tasks in the mapreduce queue until all are finished.
+   *
+   * <p>If you are mocking a clock in your tests, use the
+   * {@link #executeTasksUntilEmpty(String, FakeClock)} version instead.
+   */
   protected void executeTasksUntilEmpty(String queueName) throws Exception {
     executeTasksUntilEmpty(queueName, null);
   }
@@ -168,8 +174,8 @@ public abstract class MapreduceTestCase<T> extends ShardableTestCase {
    * <p>Incrementing the clock between tasks is important if tasks have transactions inside the
    * mapper or reducer, which don't have access to the fake clock.
    */
-  protected void
+  protected void executeTasksUntilEmpty(String queueName, @Nullable FakeClock clock)
-      executeTasksUntilEmpty(String queueName, @Nullable FakeClock clock) throws Exception {
+      throws Exception {
     while (true) {
       ofy().clearSessionCache();
       // We have to re-acquire task list every time, because local implementation returns a copy.