refactor: API changes of Update Control (#694)

csviri · web-flow · commit d842c1f426a4 · 2021-11-22T15:57:10.000+01:00
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/UpdateControl.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/UpdateControl.java
@@ -23,7 +23,7 @@ public static <T extends HasMetadata> UpdateControl<T> updateResource(T customRe
     return new UpdateControl<>(customResource, false, true);
   }
 
-  public static <T extends HasMetadata> UpdateControl<T> updateStatusSubResource(
+  public static <T extends HasMetadata> UpdateControl<T> updateStatus(
       T customResource) {
     return new UpdateControl<>(customResource, true, false);
   }
@@ -35,7 +35,7 @@ public static <T extends HasMetadata> UpdateControl<T> updateStatusSubResource(
    * @param customResource - custom resource to use in both API calls
    * @return UpdateControl instance
    */
-  public static <T extends HasMetadata> UpdateControl<T> updateCustomResourceAndStatus(
+  public static <T extends HasMetadata> UpdateControl<T> updateResourceAndStatus(
       T customResource) {
     return new UpdateControl<>(customResource, true, true);
   }
diff --git a/operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/ReconciliationDispatcherTest.java b/operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/ReconciliationDispatcherTest.java
@@ -92,7 +92,7 @@ void updatesOnlyStatusSubResourceIfFinalizerSet() {
     testCustomResource.addFinalizer(DEFAULT_FINALIZER);
 
     when(reconciler.reconcile(eq(testCustomResource), any()))
-        .thenReturn(UpdateControl.updateStatusSubResource(testCustomResource));
+        .thenReturn(UpdateControl.updateStatus(testCustomResource));
 
     reconciliationDispatcher.handleExecution(executionScopeWithCREvent(testCustomResource));
 
@@ -105,7 +105,7 @@ void updatesBothResourceAndStatusIfFinalizerSet() {
     testCustomResource.addFinalizer(DEFAULT_FINALIZER);
 
     when(reconciler.reconcile(eq(testCustomResource), any()))
-        .thenReturn(UpdateControl.updateCustomResourceAndStatus(testCustomResource));
+        .thenReturn(UpdateControl.updateResourceAndStatus(testCustomResource));
     when(customResourceFacade.replaceWithLock(testCustomResource)).thenReturn(testCustomResource);
 
     reconciliationDispatcher.handleExecution(executionScopeWithCREvent(testCustomResource));
@@ -281,7 +281,7 @@ void setReScheduleToPostExecutionControlFromUpdateControl() {
 
     when(reconciler.reconcile(eq(testCustomResource), any()))
         .thenReturn(
-            UpdateControl.updateStatusSubResource(testCustomResource).rescheduleAfter(1000L));
+            UpdateControl.updateStatus(testCustomResource).rescheduleAfter(1000L));
 
     PostExecutionControl control =
         reconciliationDispatcher.handleExecution(executionScopeWithCREvent(testCustomResource));
@@ -315,7 +315,7 @@ void setObservedGenerationForStatusIfNeeded() {
 
     when(lConfiguration.isGenerationAware()).thenReturn(true);
     when(lController.reconcile(eq(observedGenResource), any()))
-        .thenReturn(UpdateControl.updateStatusSubResource(observedGenResource));
+        .thenReturn(UpdateControl.updateStatus(observedGenResource));
     when(lFacade.updateStatus(observedGenResource)).thenReturn(observedGenResource);
 
     PostExecutionControl<ObservedGenCustomResource> control = lDispatcher.handleExecution(
diff --git a/operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/event/internal/CustomResourceSelectorTest.java b/operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/event/internal/CustomResourceSelectorTest.java
@@ -173,7 +173,7 @@ public UpdateControl<TestCustomResource> reconcile(
 
       consumer.accept(resource);
 
-      return UpdateControl.updateStatusSubResource(resource);
+      return UpdateControl.updateStatus(resource);
     }
   }
 }
diff --git a/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/deployment/DeploymentReconciler.java b/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/deployment/DeploymentReconciler.java
@@ -42,7 +42,7 @@ public UpdateControl<Deployment> reconcile(
     if (condition.isEmpty()) {
       conditions.add(new DeploymentCondition(null, null, STATUS_MESSAGE, null,
           "unknown", "DeploymentReconciler"));
-      return UpdateControl.updateStatusSubResource(resource);
+      return UpdateControl.updateStatus(resource);
     } else {
       return UpdateControl.noUpdate();
     }
diff --git a/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/doubleupdate/DoubleUpdateTestCustomReconciler.java b/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/doubleupdate/DoubleUpdateTestCustomReconciler.java
@@ -34,7 +34,7 @@ public UpdateControl<DoubleUpdateTestCustomResource> reconcile(
     ensureStatusExists(resource);
     resource.getStatus().setState(DoubleUpdateTestCustomResourceStatus.State.SUCCESS);
 
-    return UpdateControl.updateCustomResourceAndStatus(resource);
+    return UpdateControl.updateResourceAndStatus(resource);
   }
 
   private void ensureStatusExists(DoubleUpdateTestCustomResource resource) {
diff --git a/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/event/EventSourceTestCustomReconciler.java b/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/event/EventSourceTestCustomReconciler.java
@@ -27,7 +27,7 @@ public UpdateControl<EventSourceTestCustomResource> reconcile(
     ensureStatusExists(resource);
     resource.getStatus().setState(EventSourceTestCustomResourceStatus.State.SUCCESS);
 
-    return UpdateControl.updateStatusSubResource(resource).rescheduleAfter(TIMER_PERIOD);
+    return UpdateControl.updateStatus(resource).rescheduleAfter(TIMER_PERIOD);
   }
 
   private void ensureStatusExists(EventSourceTestCustomResource resource) {
diff --git a/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/informereventsource/InformerEventSourceTestCustomReconciler.java b/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/informereventsource/InformerEventSourceTestCustomReconciler.java
@@ -55,7 +55,7 @@ public UpdateControl<InformerEventSourceTestCustomResource> reconcile(
     LOGGER.debug("Setting target status for CR: {}", targetStatus);
     resource.setStatus(new InformerEventSourceTestCustomResourceStatus());
     resource.getStatus().setConfigMapValue(targetStatus);
-    return UpdateControl.updateStatusSubResource(resource);
+    return UpdateControl.updateStatus(resource);
   }
 
   @Override
diff --git a/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/retry/RetryTestCustomReconciler.java b/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/retry/RetryTestCustomReconciler.java
@@ -46,7 +46,7 @@ public UpdateControl<RetryTestCustomResource> reconcile(
     ensureStatusExists(resource);
     resource.getStatus().setState(RetryTestCustomResourceStatus.State.SUCCESS);
 
-    return UpdateControl.updateStatusSubResource(resource);
+    return UpdateControl.updateStatus(resource);
   }
 
   private void ensureStatusExists(RetryTestCustomResource resource) {
diff --git a/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/simple/TestReconciler.java b/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/simple/TestReconciler.java
@@ -128,7 +128,7 @@ public UpdateControl<TestCustomResource> reconcile(
       }
       resource.getStatus().setConfigMapStatus("ConfigMap Ready");
     }
-    return UpdateControl.updateStatusSubResource(resource);
+    return UpdateControl.updateStatus(resource);
   }
 
   private Map<String, String> configMapData(TestCustomResource resource) {
diff --git a/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/subresource/SubResourceTestCustomReconciler.java b/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/subresource/SubResourceTestCustomReconciler.java
@@ -36,7 +36,7 @@ public UpdateControl<SubResourceTestCustomResource> reconcile(
     ensureStatusExists(resource);
     resource.getStatus().setState(SubResourceTestCustomResourceStatus.State.SUCCESS);
 
-    return UpdateControl.updateStatusSubResource(resource);
+    return UpdateControl.updateStatus(resource);
   }
 
   private void ensureStatusExists(SubResourceTestCustomResource resource) {
diff --git a/sample-operators/tomcat-operator/src/main/java/io/javaoperatorsdk/operator/sample/TomcatReconciler.java b/sample-operators/tomcat-operator/src/main/java/io/javaoperatorsdk/operator/sample/TomcatReconciler.java
@@ -75,7 +75,7 @@ public UpdateControl<Tomcat> reconcile(Tomcat tomcat, Context context) {
           tomcat.getMetadata().getName(),
           tomcat.getMetadata().getNamespace(),
           tomcat.getStatus().getReadyReplicas());
-      return UpdateControl.updateStatusSubResource(updatedTomcat);
+      return UpdateControl.updateStatus(updatedTomcat);
     }
     return UpdateControl.noUpdate();
   }
diff --git a/sample-operators/tomcat-operator/src/main/java/io/javaoperatorsdk/operator/sample/WebappReconciler.java b/sample-operators/tomcat-operator/src/main/java/io/javaoperatorsdk/operator/sample/WebappReconciler.java
@@ -98,7 +98,7 @@ public UpdateControl<Webapp> reconcile(Webapp webapp, Context context) {
       }
       webapp.getStatus().setDeployedArtifact(webapp.getSpec().getUrl());
       webapp.getStatus().setDeploymentStatus(commandStatusInAllPods);
-      return UpdateControl.updateStatusSubResource(webapp);
+      return UpdateControl.updateStatus(webapp);
     } else {
       log.info("WebappController invoked but Tomcat not ready yet ({}/{})",
           tomcat.getStatus() != null ? tomcat.getStatus().getReadyReplicas() : 0,

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ public static <T extends HasMetadata> UpdateControl<T> updateResource(T customRe`
`23`	`23`	`return new UpdateControl<>(customResource, false, true);`
`24`	`24`	`}`
`25`	`25`
`26`		`- public static <T extends HasMetadata> UpdateControl<T> updateStatusSubResource(`
	`26`	`+ public static <T extends HasMetadata> UpdateControl<T> updateStatus(`
`27`	`27`	`T customResource) {`
`28`	`28`	`return new UpdateControl<>(customResource, true, false);`
`29`	`29`	`}`
`@@ -35,7 +35,7 @@ public static <T extends HasMetadata> UpdateControl<T> updateStatusSubResource(`
`35`	`35`	`* @param customResource - custom resource to use in both API calls`
`36`	`36`	`* @return UpdateControl instance`
`37`	`37`	`*/`
`38`		`- public static <T extends HasMetadata> UpdateControl<T> updateCustomResourceAndStatus(`
	`38`	`+ public static <T extends HasMetadata> UpdateControl<T> updateResourceAndStatus(`
`39`	`39`	`T customResource) {`
`40`	`40`	`return new UpdateControl<>(customResource, true, true);`
`41`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -173,7 +173,7 @@ public UpdateControl<TestCustomResource> reconcile(`
`173`	`173`
`174`	`174`	`consumer.accept(resource);`
`175`	`175`
`176`		`- return UpdateControl.updateStatusSubResource(resource);`
	`176`	`+ return UpdateControl.updateStatus(resource);`
`177`	`177`	`}`
`178`	`178`	`}`
`179`	`179`	`}`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ public UpdateControl<Deployment> reconcile(`
`42`	`42`	`if (condition.isEmpty()) {`
`43`	`43`	`conditions.add(new DeploymentCondition(null, null, STATUS_MESSAGE, null,`
`44`	`44`	`"unknown", "DeploymentReconciler"));`
`45`		`- return UpdateControl.updateStatusSubResource(resource);`
	`45`	`+ return UpdateControl.updateStatus(resource);`
`46`	`46`	`} else {`
`47`	`47`	`return UpdateControl.noUpdate();`
`48`	`48`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public UpdateControl<DoubleUpdateTestCustomResource> reconcile(`
`34`	`34`	`ensureStatusExists(resource);`
`35`	`35`	`resource.getStatus().setState(DoubleUpdateTestCustomResourceStatus.State.SUCCESS);`
`36`	`36`
`37`		`- return UpdateControl.updateCustomResourceAndStatus(resource);`
	`37`	`+ return UpdateControl.updateResourceAndStatus(resource);`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`private void ensureStatusExists(DoubleUpdateTestCustomResource resource) {`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ public UpdateControl<EventSourceTestCustomResource> reconcile(`
`27`	`27`	`ensureStatusExists(resource);`
`28`	`28`	`resource.getStatus().setState(EventSourceTestCustomResourceStatus.State.SUCCESS);`
`29`	`29`
`30`		`- return UpdateControl.updateStatusSubResource(resource).rescheduleAfter(TIMER_PERIOD);`
	`30`	`+ return UpdateControl.updateStatus(resource).rescheduleAfter(TIMER_PERIOD);`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`private void ensureStatusExists(EventSourceTestCustomResource resource) {`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ public UpdateControl<InformerEventSourceTestCustomResource> reconcile(`
`55`	`55`	`LOGGER.debug("Setting target status for CR: {}", targetStatus);`
`56`	`56`	`resource.setStatus(new InformerEventSourceTestCustomResourceStatus());`
`57`	`57`	`resource.getStatus().setConfigMapValue(targetStatus);`
`58`		`- return UpdateControl.updateStatusSubResource(resource);`
	`58`	`+ return UpdateControl.updateStatus(resource);`
`59`	`59`	`}`
`60`	`60`
`61`	`61`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ public UpdateControl<RetryTestCustomResource> reconcile(`
`46`	`46`	`ensureStatusExists(resource);`
`47`	`47`	`resource.getStatus().setState(RetryTestCustomResourceStatus.State.SUCCESS);`
`48`	`48`
`49`		`- return UpdateControl.updateStatusSubResource(resource);`
	`49`	`+ return UpdateControl.updateStatus(resource);`
`50`	`50`	`}`
`51`	`51`
`52`	`52`	`private void ensureStatusExists(RetryTestCustomResource resource) {`
Original file line number	Diff line number	Diff line change
`@@ -128,7 +128,7 @@ public UpdateControl<TestCustomResource> reconcile(`
`128`	`128`	`}`
`129`	`129`	`resource.getStatus().setConfigMapStatus("ConfigMap Ready");`
`130`	`130`	`}`
`131`		`- return UpdateControl.updateStatusSubResource(resource);`
	`131`	`+ return UpdateControl.updateStatus(resource);`
`132`	`132`	`}`
`133`	`133`
`134`	`134`	`private Map<String, String> configMapData(TestCustomResource resource) {`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ public UpdateControl<SubResourceTestCustomResource> reconcile(`
`36`	`36`	`ensureStatusExists(resource);`
`37`	`37`	`resource.getStatus().setState(SubResourceTestCustomResourceStatus.State.SUCCESS);`
`38`	`38`
`39`		`- return UpdateControl.updateStatusSubResource(resource);`
	`39`	`+ return UpdateControl.updateStatus(resource);`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`private void ensureStatusExists(SubResourceTestCustomResource resource) {`