Modified methods in ChangeRequest.

mderka · mderka · commit 52567fd5a1a3 · 2016-04-04T09:26:13.000-07:00
Added reload() and isDone() to change request.
Also changed signature of applyTo().
diff --git a/gcloud-java-dns/src/main/java/com/google/gcloud/dns/ChangeRequest.java b/gcloud-java-dns/src/main/java/com/google/gcloud/dns/ChangeRequest.java
@@ -148,10 +148,34 @@ public Dns dns() {
   }
 
   /**
-   * Applies this change request to the associated zone.
+   * Applies this change request to the zone identified by {@code zoneName}.
    */
-  public ChangeRequest applyTo(Dns.ChangeRequestOption... options) {
-    return dns.applyChangeRequest(zone, this, options);
+  public ChangeRequest applyTo(String zoneName, Dns.ChangeRequestOption... options) {
+    return dns.applyChangeRequest(zoneName, this, options);
+  }
+
+  /**
+   * Retrieves the up-to-date information about the change request from Google Cloud DNS. Parameter
+   * {@code options} can be used to restrict the fields to be updated in the same way as in {@link
+   * Dns#getChangeRequest(String, String, Dns.ChangeRequestOption...)}. If {@code options} are
+   * provided, any field other than generatedId which is not included in the {@code options} will be
+   * {@code null} regardless whether they are initialized or not in {@code this} instance.
+   */
+  public ChangeRequest reload(Dns.ChangeRequestOption... options) {
+    return dns.getChangeRequest(zone, this.generatedId(), options);
+  }
+
+  /**
+   * Returns {@code true} if the change request has been completed. The function makes an API call
+   * to Google Cloud DNS in order request the status update.
+   */
+  public boolean isDone() {
+    if (status() == Status.DONE) {
+      return true;
+    } else {
+      ChangeRequest updated = reload(Dns.ChangeRequestOption.fields(Dns.ChangeRequestField.STATUS));
+      return updated.status() == Status.DONE;
+    }
   }
 
   @Override
diff --git a/gcloud-java-dns/src/test/java/com/google/gcloud/dns/ChangeRequestTest.java b/gcloud-java-dns/src/test/java/com/google/gcloud/dns/ChangeRequestTest.java
@@ -43,19 +43,26 @@ public class ChangeRequestTest {
 
   private Dns dns;
   private ChangeRequest changeRequest;
+  private ChangeRequest changeRequestPending;
   private ChangeRequest changeRequestPartial;
 
   @Before
   public void setUp() throws Exception {
     dns = createStrictMock(Dns.class);
-    expect(dns.options()).andReturn(OPTIONS).times(2);
+    expect(dns.options()).andReturn(OPTIONS).times(3);
     replay(dns);
     changeRequest = new ChangeRequest(dns, ZONE_NAME, new ChangeRequestInfo.BuilderImpl(
         CHANGE_REQUEST_INFO.toBuilder()
             .startTimeMillis(132L)
             .generatedId("12")
             .status(ChangeRequest.Status.DONE)
             .build()));
+    changeRequestPending = new ChangeRequest(dns, ZONE_NAME, new ChangeRequestInfo.BuilderImpl(
+        CHANGE_REQUEST_INFO.toBuilder()
+            .startTimeMillis(132L)
+            .generatedId("12")
+            .status(ChangeRequest.Status.PENDING)
+            .build()));
     changeRequestPartial = new ChangeRequest(dns, ZONE_NAME,
         new ChangeRequest.BuilderImpl(CHANGE_REQUEST_INFO));
     reset(dns);
@@ -133,8 +140,34 @@ public void testApplyTo() {
         Dns.ChangeRequestOption.fields(Dns.ChangeRequestField.START_TIME)))
         .andReturn(changeRequest);
     replay(dns);
-    assertSame(changeRequest, changeRequest.applyTo());
-    assertSame(changeRequest,
-        changeRequest.applyTo(Dns.ChangeRequestOption.fields(Dns.ChangeRequestField.START_TIME)));
+    assertSame(changeRequest, changeRequest.applyTo(ZONE_NAME));
+    assertSame(changeRequest, changeRequest.applyTo(ZONE_NAME,
+        Dns.ChangeRequestOption.fields(Dns.ChangeRequestField.START_TIME)));
+  }
+
+  @Test
+  public void testReload() {
+    expect(dns.getChangeRequest(ZONE_NAME, changeRequest.generatedId())).andReturn(changeRequest);
+    expect(dns.getChangeRequest(ZONE_NAME, changeRequest.generatedId(),
+        Dns.ChangeRequestOption.fields(Dns.ChangeRequestField.START_TIME)))
+        .andReturn(changeRequest);
+    replay(dns);
+    assertSame(changeRequest, changeRequest.reload());
+    assertSame(changeRequest, changeRequest.reload(
+        Dns.ChangeRequestOption.fields(Dns.ChangeRequestField.START_TIME)));
+  }
+
+  @Test
+  public void testIsDone() {
+    replay(dns);
+    assertTrue(changeRequest.isDone());
+    verify(dns);
+    reset(dns);
+    expect(dns.getChangeRequest(ZONE_NAME, changeRequest.generatedId(),
+        Dns.ChangeRequestOption.fields(Dns.ChangeRequestField.STATUS)))
+        .andReturn(changeRequest);
+    replay(dns);
+    assertTrue(changeRequestPending.isDone());
+    verify(dns);
   }
 }
diff --git a/gcloud-java-dns/src/test/java/com/google/gcloud/dns/it/ITDnsTest.java b/gcloud-java-dns/src/test/java/com/google/gcloud/dns/it/ITDnsTest.java
@@ -147,12 +147,9 @@ private static void assertEqChangesIgnoreStatus(ChangeRequest expected, ChangeRe
   }
 
   private static void waitForChangeToComplete(String zoneName, String changeId) {
-    while (true) {
-      ChangeRequest changeRequest = DNS.getChangeRequest(zoneName, changeId,
-          Dns.ChangeRequestOption.fields(Dns.ChangeRequestField.STATUS));
-      if (ChangeRequest.Status.DONE.equals(changeRequest.status())) {
-        return;
-      }
+    ChangeRequest changeRequest = DNS.getChangeRequest(zoneName, changeId,
+        Dns.ChangeRequestOption.fields(Dns.ChangeRequestField.STATUS));
+    while (!changeRequest.isDone()) {
       try {
         Thread.sleep(500);
       } catch (InterruptedException e) {
