improve: resource creation api in JUnit extension

Signed-off-by: Attila Mészáros <[email protected]>

Author: csviri

caffeine-bounded-cache-support/src/test/java/io/javaoperatorsdk/operator/processing/event/source/cache/BoundedCacheTestBase.java

@@ -63,7 +63,7 @@ private void updateTestResources() {
     IntStream.range(0, NUMBER_OF_RESOURCE_TO_TEST).forEach(i -> {
       var cm = extension().get(ConfigMap.class, RESOURCE_NAME_PREFIX + i);
       cm.getData().put(DATA_KEY, UPDATED_PREFIX + i);
-      extension().replace(cm);
+      extension().createOrUpdate(cm);
     });
   }
 

operator-framework-junit5/src/main/java/io/javaoperatorsdk/operator/junit/AbstractOperatorExtension.java

@@ -20,6 +20,7 @@
 import io.fabric8.kubernetes.api.model.*;
 import io.fabric8.kubernetes.client.KubernetesClient;
 import io.fabric8.kubernetes.client.KubernetesClientBuilder;
+import io.fabric8.kubernetes.client.dsl.NonDeletingOperation;
 import io.fabric8.kubernetes.client.dsl.NonNamespaceOperation;
 import io.fabric8.kubernetes.client.dsl.Resource;
 import io.fabric8.kubernetes.client.utils.Utils;
@@ -107,6 +108,16 @@ public <T extends HasMetadata> T get(Class<T> type, String name) {
     return kubernetesClient.resources(type).inNamespace(namespace).withName(name).get();
   }
 
+  public <T extends HasMetadata> T createOr(T resource,
+      Function<NonDeletingOperation<T>, T> conflictAction) {
+    return kubernetesClient.resource(resource).inNamespace(namespace).createOr(conflictAction);
+  }
+
+  public <T extends HasMetadata> T createOrUpdate(T resource) {
+    return kubernetesClient.resource(resource).inNamespace(namespace)
+        .createOr(NonDeletingOperation::update);
+  }
+
   public <T extends HasMetadata> T create(T resource) {
     return kubernetesClient.resource(resource).inNamespace(namespace).create();
   }
@@ -116,6 +127,10 @@ public <T extends HasMetadata> T create(Class<T> type, T resource) {
     return create(resource);
   }
 
+  /**
+   * Use createOrUpdate instead.
+   */
+  @Deprecated(forRemoval = true)
   public <T extends HasMetadata> T replace(T resource) {
     return kubernetesClient.resource(resource).inNamespace(namespace).replace();
   }

operator-framework/src/test/java/io/javaoperatorsdk/operator/ChangeNamespaceIT.java

@@ -71,7 +71,7 @@ void addNewAndRemoveOldNamespaceTest() {
 
     ConfigMap firstMap = operator.get(ConfigMap.class, TEST_RESOURCE_NAME_1);
     firstMap.setData(Map.of("data", "newdata"));
-    operator.replace(firstMap);
+    operator.createOrUpdate(firstMap);
     assertReconciled(reconciler, defaultNamespaceResource);
   }
 

operator-framework/src/test/java/io/javaoperatorsdk/operator/CleanupConflictIT.java

@@ -39,7 +39,7 @@ void cleanupRemovesFinalizerWithoutConflict() throws InterruptedException {
     testResource = operator.get(CleanupConflictCustomResource.class, TEST_RESOURCE_NAME);
     testResource.getMetadata().getFinalizers().remove(ADDITIONAL_FINALIZER);
     testResource.getMetadata().setResourceVersion(null);
-    operator.replace(testResource);
+    operator.createOrUpdate(testResource);
 
     await().pollDelay(Duration.ofMillis(WAIT_TIME * 2)).untilAsserted(
         () -> assertThat(operator.getReconcilerOfType(CleanupConflictReconciler.class)

operator-framework/src/test/java/io/javaoperatorsdk/operator/ClusterScopedResourceIT.java

@@ -40,7 +40,7 @@ void crudOperationOnClusterScopedCustomResource() {
     });
 
     resource.getSpec().setData(UPDATED_DATA);
-    operator.replace(resource);
+    operator.createOrUpdate(resource);
     await().untilAsserted(() -> {
       var cm = operator.get(ConfigMap.class, TEST_NAME);
       assertThat(cm).isNotNull();

operator-framework/src/test/java/io/javaoperatorsdk/operator/CreateUpdateInformerEventSourceEventFilterIT.java

@@ -37,7 +37,7 @@ void updateEventNotReceivedAfterCreateOrUpdate() {
         operator.get(CreateUpdateEventFilterTestCustomResource.class,
             resource.getMetadata().getName());
     actualCreatedResource.getSpec().setValue("2");
-    operator.replace(actualCreatedResource);
+    operator.createOrUpdate(actualCreatedResource);
 
     assertData(operator, actualCreatedResource, 2, 2);
   }

operator-framework/src/test/java/io/javaoperatorsdk/operator/DependentAnnotationSecondaryMapperIT.java

@@ -46,7 +46,7 @@ void mapsSecondaryByAnnotation() {
     assertThat(configMap.getMetadata().getOwnerReferences()).isEmpty();
 
     configMap.getData().put("additional_data", "data");
-    operator.replace(configMap);
+    operator.createOrUpdate(configMap);
 
     await().pollDelay(Duration.ofMillis(150))
         .untilAsserted(() -> assertThat(reconciler.getNumberOfExecutions()).isEqualTo(2));

operator-framework/src/test/java/io/javaoperatorsdk/operator/DependentCustomMappingAnnotationIT.java

@@ -35,7 +35,7 @@ void testCustomMappingAnnotationForDependent() {
     assertConfigMapData(INITIAL_VALUE);
 
     cr.getSpec().setValue(CHANGED_VALUE);
-    cr = extension.replace(cr);
+    cr = extension.createOrUpdate(cr);
     assertConfigMapData(CHANGED_VALUE);
 
     extension.delete(cr);

operator-framework/src/test/java/io/javaoperatorsdk/operator/DependentDifferentNamespaceIT.java

@@ -38,7 +38,7 @@ void managesCRUDOperationsForDependentInDifferentNamespace() {
     });
 
     resource.getSpec().setValue(CHANGED_VALUE);
-    resource = extension.replace(resource);
+    resource = extension.createOrUpdate(resource);
 
     await().untilAsserted(() -> {
       var cm = getDependentConfigMap();

operator-framework/src/test/java/io/javaoperatorsdk/operator/DependentFilterIT.java

@@ -39,7 +39,7 @@ void filtersUpdateOnConfigMap() {
 
     var configMap = operator.get(ConfigMap.class, RESOURCE_NAME);
     configMap.setData(Map.of(CM_VALUE_KEY, CONFIG_MAP_FILTER_VALUE));
-    operator.replace(configMap);
+    operator.createOrUpdate(configMap);
 
     await().pollDelay(Duration.ofMillis(150)).untilAsserted(() -> {
       assertThat(operator.getReconcilerOfType(DependentFilterTestReconciler.class)

operator-framework/src/test/java/io/javaoperatorsdk/operator/DependentOperationEventFilterIT.java

@@ -43,7 +43,7 @@ void reconcileNotTriggeredWithDependentResourceCreateOrUpdate() {
         .containsEntry(ConfigMapDependentResource.KEY, SPEC_VAL_1);
 
     resource.getSpec().setValue(SPEC_VAL_2);
-    operator.replace(resource);
+    operator.createOrUpdate(resource);
 
     await().pollDelay(Duration.ofSeconds(1)).atMost(Duration.ofSeconds(3))
         .until(

operator-framework/src/test/java/io/javaoperatorsdk/operator/DependentSSAMatchingIT.java

@@ -74,7 +74,7 @@ void testMatchingAndUpdate() {
     });
 
     resource.getSpec().setValue(CHANGED_VALUE);
-    extension.replace(resource);
+    extension.createOrUpdate(resource);
 
     await().untilAsserted(() -> {
       var cm = extension.get(ConfigMap.class, TEST_RESOURCE_NAME);

operator-framework/src/test/java/io/javaoperatorsdk/operator/DynamicGenericEventSourceRegistrationIT.java

@@ -43,7 +43,7 @@ void registersEventSourcesDynamically() {
     var cm = extension.get(ConfigMap.class, TEST_RESOURCE_NAME);
     cm.getData().put("key2", "val2");
 
-    extension.replace(cm); // triggers the reconciliation
+    extension.createOrUpdate(cm); // triggers the reconciliation
 
     await().untilAsserted(() -> {
       assertThat(reconciler.getNumberOfExecutions() - executions).isEqualTo(2);

operator-framework/src/test/java/io/javaoperatorsdk/operator/ExternalStateBulkIT.java

@@ -39,15 +39,15 @@ void reconcilesResourceWithPersistentState() throws InterruptedException {
     assertResources(resource, INITIAL_TEST_DATA, INITIAL_BULK_SIZE);
 
     resource.getSpec().setData(UPDATED_DATA);
-    resource = operator.replace(resource);
+    resource = operator.createOrUpdate(resource);
     assertResources(resource, UPDATED_DATA, INITIAL_BULK_SIZE);
 
     resource.getSpec().setNumber(INCREASED_BULK_SIZE);
-    resource = operator.replace(resource);
+    resource = operator.createOrUpdate(resource);
     assertResources(resource, UPDATED_DATA, INCREASED_BULK_SIZE);
 
     resource.getSpec().setNumber(DECREASED_BULK_SIZE);
-    resource = operator.replace(resource);
+    resource = operator.createOrUpdate(resource);
     assertResources(resource, UPDATED_DATA, DECREASED_BULK_SIZE);
 
     operator.delete(resource);

operator-framework/src/test/java/io/javaoperatorsdk/operator/ExternalStateIT.java

@@ -35,7 +35,7 @@ public void reconcilesResourceWithPersistentState() {
     assertResourcesCreated(resource, INITIAL_TEST_DATA);
 
     resource.getSpec().setData(UPDATED_DATA);
-    operator.replace(resource);
+    operator.createOrUpdate(resource);
     assertResourcesCreated(resource, UPDATED_DATA);
 
     operator.delete(resource);

operator-framework/src/test/java/io/javaoperatorsdk/operator/ExternalStateTestBase.java

@@ -28,7 +28,7 @@ public void reconcilesResourceWithPersistentState() {
     assertResourcesCreated(resource, INITIAL_TEST_DATA);
 
     resource.getSpec().setData(UPDATED_DATA);
-    extension().replace(resource);
+    extension().createOrUpdate(resource);
     assertResourcesCreated(resource, UPDATED_DATA);
 
     extension().delete(resource);

operator-framework/src/test/java/io/javaoperatorsdk/operator/FilterIT.java

@@ -34,7 +34,7 @@ void filtersControllerResourceUpdate() {
             .getNumberOfExecutions()).isEqualTo(2));
 
     res.getSpec().setValue(FilterTestReconciler.CUSTOM_RESOURCE_FILTER_VALUE);
-    operator.replace(res);
+    operator.createOrUpdate(res);
 
     // not more reconciliation with the filtered value
     await().pollDelay(Duration.ofMillis(POLL_DELAY))
@@ -51,7 +51,7 @@ void filtersSecondaryResourceUpdate() {
             .getNumberOfExecutions()).isEqualTo(2));
 
     res.getSpec().setValue(CONFIG_MAP_FILTER_VALUE);
-    operator.replace(res);
+    operator.createOrUpdate(res);
 
     // the CM event filtered out
     await().pollDelay(Duration.ofMillis(POLL_DELAY))

operator-framework/src/test/java/io/javaoperatorsdk/operator/GenericKubernetesDependentTestBase.java

@@ -30,7 +30,7 @@ void testReconciliation() {
     });
 
     resource.getSpec().setValue(CHANGED_DATA);
-    resource = extension().replace(resource);
+    resource = extension().createOrUpdate(resource);
 
     await().untilAsserted(() -> {
       var cm = extension().get(ConfigMap.class, TEST_RESOURCE_NAME);

operator-framework/src/test/java/io/javaoperatorsdk/operator/GracefulStopIT.java

@@ -48,7 +48,7 @@ private void testGracefulStop(String resourceName, int stopTimeout, int expected
     });
 
     testRes.getSpec().setValue(2);
-    operator.replace(testRes);
+    operator.createOrUpdate(testRes);
 
     await().pollDelay(Duration.ofMillis(50)).untilAsserted(
         () -> assertThat(operator.getReconcilerOfType(GracefulStopTestReconciler.class)

operator-framework/src/test/java/io/javaoperatorsdk/operator/IndexDiscriminatorIT.java

@@ -39,7 +39,7 @@ void resourcesFoundAndReconciled() {
     });
 
     res.getSpec().setValue(CHANGED_SPEC_VALUE);
-    res = operator.replace(res);
+    res = operator.createOrUpdate(res);
 
     await().untilAsserted(() -> {
       assertThat(reconciler.getNumberOfExecutions()).isEqualTo(2);

operator-framework/src/test/java/io/javaoperatorsdk/operator/InformerEventSourceIT.java

@@ -40,7 +40,7 @@ void testUsingInformerToWatchChangesOfConfigMap() {
     waitForCRStatusValue(INITIAL_STATUS_MESSAGE);
 
     configMap.getData().put(TARGET_CONFIG_MAP_KEY, UPDATE_STATUS_MESSAGE);
-    operator.replace(configMap);
+    operator.createOrUpdate(configMap);
 
     waitForCRStatusValue(UPDATE_STATUS_MESSAGE);
   }

operator-framework/src/test/java/io/javaoperatorsdk/operator/KubernetesDependentGarbageCollectionIT.java

@@ -62,7 +62,7 @@ void deletesSecondaryResource() {
     });
 
     createdResources.getSpec().setCreateConfigMap(false);
-    operator.replace(createdResources);
+    operator.createOrUpdate(createdResources);
 
     await().untilAsserted(() -> {
       ConfigMap cm = operator.get(ConfigMap.class, TEST_RESOURCE_NAME);

operator-framework/src/test/java/io/javaoperatorsdk/operator/ManagedDependentDeleteConditionIT.java

@@ -45,7 +45,7 @@ void resourceNotDeletedUntilDependentDeleted() {
 
     var secret = extension.get(Secret.class, RESOURCE_NAME);
     secret.getMetadata().getFinalizers().add(CUSTOM_FINALIZER);
-    secret = extension.replace(secret);
+    secret = extension.createOrUpdate(secret);
 
     extension.delete(resource);
 
@@ -58,7 +58,7 @@ void resourceNotDeletedUntilDependentDeleted() {
     });
 
     secret.getMetadata().getFinalizers().clear();
-    extension.replace(secret);
+    extension.createOrUpdate(secret);
 
     await().untilAsserted(() -> {
       var cm = extension.get(ConfigMap.class, RESOURCE_NAME);

operator-framework/src/test/java/io/javaoperatorsdk/operator/MultiOwnerDependentTriggeringIT.java

@@ -47,7 +47,7 @@ void multiOwnerTriggeringAndManagement() {
     });
 
     res1.getSpec().setValue(NEW_VALUE_1);
-    extension.replace(res1);
+    extension.createOrUpdate(res1);
 
     await().untilAsserted(() -> {
       var cm = extension.get(ConfigMap.class, MultipleOwnerDependentConfigMap.RESOURCE_NAME);
@@ -59,7 +59,7 @@ void multiOwnerTriggeringAndManagement() {
     });
 
     res2.getSpec().setValue(NEW_VALUE_2);
-    extension.replace(res2);
+    extension.createOrUpdate(res2);
 
     await().untilAsserted(() -> {
       var cm = extension.get(ConfigMap.class, MultipleOwnerDependentConfigMap.RESOURCE_NAME);

operator-framework/src/test/java/io/javaoperatorsdk/operator/MultipleDependentSameTypeMultiInformerIT.java

@@ -37,7 +37,7 @@ void handlesCrudOperations() {
 
     var updatedResource = testResource();
     updatedResource.getSpec().setValue(UPDATED_SPEC_VALUE);
-    operator.replace(updatedResource);
+    operator.createOrUpdate(updatedResource);
     assertConfigMapsPresent(UPDATED_SPEC_VALUE);
 
     operator.delete(testResource());

operator-framework/src/test/java/io/javaoperatorsdk/operator/MultipleManagedDependentSameTypeIT.java

@@ -38,7 +38,7 @@ void handlesCrudOperations() {
 
     var updatedResource = testResource();
     updatedResource.getSpec().setValue(UPDATED_SPEC_VALUE);
-    operator.replace(updatedResource);
+    operator.createOrUpdate(updatedResource);
     assertConfigMapsPresent(UPDATED_SPEC_VALUE);
 
     operator.delete(testResource());

operator-framework/src/test/java/io/javaoperatorsdk/operator/MultipleManagedExternalDependentSameTypeIT.java

@@ -34,7 +34,7 @@ void handlesExternalCrudOperations() {
 
     var updatedResource = testResource();
     updatedResource.getSpec().setValue(UPDATED_SPEC_VALUE);
-    operator.replace(updatedResource);
+    operator.createOrUpdate(updatedResource);
     assertResourceCreatedWithData(UPDATED_SPEC_VALUE);
 
     operator.delete(testResource());

operator-framework/src/test/java/io/javaoperatorsdk/operator/MultipleSecondaryEventSourceIT.java

@@ -51,7 +51,7 @@ private void updateConfigMap(MultipleSecondaryEventSourceCustomResource resource
         number == 1 ? MultipleSecondaryEventSourceReconciler.getName1(resource)
             : MultipleSecondaryEventSourceReconciler.getName2(resource));
     map1.getData().put("value2", "value2");
-    operator.replace(map1);
+    operator.createOrUpdate(map1);
   }
 
   public MultipleSecondaryEventSourceCustomResource createTestCustomResource() {

operator-framework/src/test/java/io/javaoperatorsdk/operator/PreviousAnnotationDisabledIT.java

@@ -30,7 +30,7 @@ void updateEventReceivedAfterCreateOrUpdate() {
         operator.get(CreateUpdateEventFilterTestCustomResource.class,
             resource.getMetadata().getName());
     actualCreatedResource.getSpec().setValue("2");
-    operator.replace(actualCreatedResource);
+    operator.createOrUpdate(actualCreatedResource);
 
     CreateUpdateInformerEventSourceEventFilterIT.assertData(operator, actualCreatedResource, 2, 4);
   }

operator-framework/src/test/java/io/javaoperatorsdk/operator/PrimaryToSecondaryDependentIT.java

@@ -44,7 +44,7 @@ void testPrimaryToSecondaryInDependentResources() {
 
     cm.setData(Map.of(DATA_KEY, TEST_DATA));
     var executions = reconciler.getNumberOfExecutions();
-    operator.replace(cm);
+    operator.createOrUpdate(cm);
 
     await().pollDelay(Duration.ofMillis(250)).untilAsserted(() -> {
       assertThat(reconciler.getNumberOfExecutions()).isGreaterThan(executions);

operator-framework/src/test/java/io/javaoperatorsdk/operator/RateLimitIT.java

@@ -35,7 +35,7 @@ void rateLimitsExecution() {
       log.debug("replacing resource version: {}", i);
       var resource = createResource();
       resource.getSpec().setNumber(i);
-      operator.replace(resource);
+      operator.createOrUpdate(resource);
     });
     await().pollInterval(Duration.ofMillis(100))
         .pollDelay(Duration.ofMillis(REFRESH_PERIOD / 2))

operator-framework/src/test/java/io/javaoperatorsdk/operator/ServiceStrictMatcherIT.java

@@ -34,7 +34,7 @@ void testTheMatchingDoesNoTTriggersFurtherUpdates() {
 
     // make an update to spec to reconcile again
     resource.getSpec().setValue(2);
-    operator.replace(resource);
+    operator.createOrUpdate(resource);
 
     await().pollDelay(Duration.ofMillis(300)).untilAsserted(() -> {
       assertThat(operator.getReconcilerOfType(ServiceStrictMatcherTestReconciler.class)

operator-framework/src/test/java/io/javaoperatorsdk/operator/SpecialResourcesDependentIT.java

@@ -39,7 +39,7 @@ void specialCRUDReconciler() {
     });
 
     resource.getSpec().setValue(CHANGED_VALUE);
-    extension.replace(resource);
+    extension.createOrUpdate(resource);
 
     await().untilAsserted(() -> {
       var sa = extension.get(ServiceAccount.class, RESOURCE_NAME);

operator-framework/src/test/java/io/javaoperatorsdk/operator/StandaloneDependentResourceIT.java

@@ -57,7 +57,7 @@ void executeUpdateForTestingCacheUpdateForGetResource() {
 
     var clonedCr = cloner().clone(createdCR);
     clonedCr.getSpec().setReplicaCount(2);
-    operator.replace(clonedCr);
+    operator.createOrUpdate(clonedCr);
 
     awaitForDeploymentReadyReplicas(2);
     assertThat(

operator-framework/src/test/java/io/javaoperatorsdk/operator/StatefulSetDesiredSanitizerIT.java

@@ -36,7 +36,7 @@ void testSSAMatcher() {
     });
     // make sure reconciliation happens at least once more
     resource.getSpec().setValue("changed value");
-    extension.replace(resource);
+    extension.createOrUpdate(resource);
 
     await().untilAsserted(
         () -> assertThat(StatefulSetDesiredSanitizerDependentResource.nonMatchedAtLeastOnce)

operator-framework/src/test/java/io/javaoperatorsdk/operator/StatusPatchNotLockingIT.java

@@ -31,7 +31,7 @@ void noOptimisticLockingDoneOnStatusUpdate() throws InterruptedException {
     var resource = operator.create(createResource());
     Thread.sleep(WAIT_TIME / 2);
     resource.getMetadata().setAnnotations(Map.of("key", "value"));
-    operator.replace(resource);
+    operator.createOrUpdate(resource);
 
     await().pollDelay(Duration.ofMillis(WAIT_TIME)).untilAsserted(() -> {
       assertThat(
@@ -59,7 +59,7 @@ void valuesAreDeletedIfSetToNull() {
     });
 
     resource.getSpec().setMessageInStatus(false);
-    operator.replace(resource);
+    operator.createOrUpdate(resource);
 
     await().untilAsserted(() -> {
       var actual = operator.get(StatusPatchLockingCustomResource.class,