feat: move ReconcileUtils methods to ResourceOperations accessible from Context

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/Context.java

@@ -58,6 +58,8 @@ default <R> Stream<R> getSecondaryResourcesAsStream(Class<R> expectedType) {
 
   KubernetesClient getClient();
 
+  ResourceOperations<P> resourceOperations();
+
   /** ExecutorService initialized by framework for workflows. Used for workflow standalone mode. */
   ExecutorService getWorkflowExecutorService();
 

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/DefaultContext.java

@@ -46,6 +46,7 @@ public class DefaultContext<P extends HasMetadata> implements Context<P> {
   private final boolean primaryResourceDeleted;
   private final boolean primaryResourceFinalStateUnknown;
   private final Map<DependentResource<?, P>, Object> desiredStates = new ConcurrentHashMap<>();
+  private final ResourceOperations<P> resourceOperations;
 
   public DefaultContext(
       RetryInfo retryInfo,
@@ -61,6 +62,7 @@ public DefaultContext(
     this.primaryResourceFinalStateUnknown = primaryResourceFinalStateUnknown;
     this.defaultManagedDependentResourceContext =
         new DefaultManagedWorkflowAndDependentResourceContext<>(controller, primaryResource, this);
+    this.resourceOperations = new ResourceOperations<>(this);
   }
 
   @Override
@@ -124,6 +126,11 @@ public KubernetesClient getClient() {
     return controller.getClient();
   }
 
+  @Override
+  public ResourceOperations<P> resourceOperations() {
+    return resourceOperations;
+  }
+
   @Override
   public ExecutorService getWorkflowExecutorService() {
     // note that this should be always received from executor service manager, so we are able to do

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/PrimaryUpdateAndCacheUtils.java

@@ -46,8 +46,8 @@
  * If the update fails, it reads the primary resource from the cluster, applies the modifications
  * again and retries the update.
  *
- * @deprecated Use {@link ReconcileUtils} that contains the more efficient up-to-date versions of
- *     the target utils.
+ * @deprecated Use {@link Context#resourceOperations()} that contains the more efficient up-to-date
+ *     versions of methods.
  */
 @Deprecated(forRemoval = true)
 public class PrimaryUpdateAndCacheUtils {

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/ReconciliationDispatcher.java

@@ -31,7 +31,6 @@
 import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.api.reconciler.DefaultContext;
 import io.javaoperatorsdk.operator.api.reconciler.DeleteControl;
-import io.javaoperatorsdk.operator.api.reconciler.ReconcileUtils;
 import io.javaoperatorsdk.operator.api.reconciler.RetryInfo;
 import io.javaoperatorsdk.operator.api.reconciler.UpdateControl;
 import io.javaoperatorsdk.operator.processing.Controller;
@@ -73,13 +72,14 @@ public ReconciliationDispatcher(Controller<P> controller) {
   public PostExecutionControl<P> handleExecution(ExecutionScope<P> executionScope) {
     validateExecutionScope(executionScope);
     try {
-      return handleDispatch(executionScope);
+      return handleDispatch(executionScope, null);
     } catch (Exception e) {
       return PostExecutionControl.exceptionDuringExecution(e);
     }
   }
 
-  private PostExecutionControl<P> handleDispatch(ExecutionScope<P> executionScope)
+  // visible for testing
+  PostExecutionControl<P> handleDispatch(ExecutionScope<P> executionScope, Context<P> context)
       throws Exception {
     P originalResource = executionScope.getResource();
     var resourceForExecution = cloneResource(originalResource);
@@ -98,13 +98,16 @@ && shouldNotDispatchToCleanupWhenMarkedForDeletion(originalResource)) {
           originalResource.getMetadata().getFinalizers());
       return PostExecutionControl.defaultDispatch();
     }
-    Context<P> context =
-        new DefaultContext<>(
-            executionScope.getRetryInfo(),
-            controller,
-            resourceForExecution,
-            executionScope.isDeleteEvent(),
-            executionScope.isDeleteFinalStateUnknown());
+    // context can be provided only for testing purposes
+    context =
+        context == null
+            ? new DefaultContext<>(
+                executionScope.getRetryInfo(),
+                controller,
+                resourceForExecution,
+                executionScope.isDeleteEvent(),
+                executionScope.isDeleteFinalStateUnknown())
+            : context;
 
     // checking the cleaner for all-event-mode
     if (!triggerOnAllEvents() && markedForDeletion) {
@@ -137,9 +140,9 @@ private PostExecutionControl<P> handleReconcile(
        */
       P updatedResource;
       if (useSSA) {
-        updatedResource = ReconcileUtils.addFinalizerWithSSA(context);
+        updatedResource = context.resourceOperations().addFinalizerWithSSA();
       } else {
-        updatedResource = ReconcileUtils.addFinalizer(context);
+        updatedResource = context.resourceOperations().addFinalizer();
       }
       return PostExecutionControl.onlyFinalizerAdded(updatedResource)
           .withReSchedule(BaseControl.INSTANT_RESCHEDULE);
@@ -321,7 +324,7 @@ private PostExecutionControl<P> handleCleanup(
       // cleanup is finished, nothing left to be done
       final var finalizerName = configuration().getFinalizerName();
       if (deleteControl.isRemoveFinalizer() && resourceForExecution.hasFinalizer(finalizerName)) {
-        P customResource = ReconcileUtils.removeFinalizer(context);
+        P customResource = context.resourceOperations().removeFinalizer();
         return PostExecutionControl.customResourceFinalizerRemoved(customResource);
       }
     }
@@ -387,9 +390,9 @@ public R patchResource(Context<R> context, R resource, R originalResource) {
             resource.getMetadata().getResourceVersion());
       }
       if (useSSA) {
-        return ReconcileUtils.serverSideApplyPrimary(context, resource);
+        return context.resourceOperations().serverSideApplyPrimary(resource);
       } else {
-        return ReconcileUtils.jsonPatchPrimary(context, originalResource, r -> resource);
+        return context.resourceOperations().jsonPatchPrimary(originalResource, r -> resource);
       }
     }
 
@@ -399,7 +402,7 @@ public R patchStatus(Context<R> context, R resource, R originalResource) {
         var managedFields = resource.getMetadata().getManagedFields();
         try {
           resource.getMetadata().setManagedFields(null);
-          return ReconcileUtils.serverSideApplyPrimaryStatus(context, resource);
+          return context.resourceOperations().serverSideApplyPrimaryStatus(resource);
         } finally {
           resource.getMetadata().setManagedFields(managedFields);
         }
@@ -416,13 +419,14 @@ private R editStatus(Context<R> context, R resource, R originalResource) {
       try {
         clonedOriginal.getMetadata().setResourceVersion(null);
         resource.getMetadata().setResourceVersion(null);
-        return ReconcileUtils.jsonPatchPrimaryStatus(
-            context,
-            clonedOriginal,
-            r -> {
-              ReconcilerUtilsInternal.setStatus(r, ReconcilerUtilsInternal.getStatus(resource));
-              return r;
-            });
+        return context
+            .resourceOperations()
+            .jsonPatchPrimaryStatus(
+                clonedOriginal,
+                r -> {
+                  ReconcilerUtilsInternal.setStatus(r, ReconcilerUtilsInternal.getStatus(resource));
+                  return r;
+                });
       } finally {
         // restore initial resource version
         clonedOriginal.getMetadata().setResourceVersion(resourceVersion);

operator-framework-core/src/test/java/io/javaoperatorsdk/operator/api/reconciler/ReconcileUtilsTest.java → operator-framework-core/src/test/java/io/javaoperatorsdk/operator/api/reconciler/ResourceOperationsTest.java

@@ -36,10 +36,9 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.jupiter.api.Assertions.*;
-import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.Mockito.*;
 
-class ReconcileUtilsTest {
+class ResourceOperationsTest {
 
   private static final String FINALIZER_NAME = "test.javaoperatorsdk.io/finalizer";
 
@@ -49,6 +48,7 @@ class ReconcileUtilsTest {
   private Resource resourceOp;
   private ControllerEventSource<TestCustomResource> controllerEventSource;
   private ControllerConfiguration<TestCustomResource> controllerConfiguration;
+  private ResourceOperations<TestCustomResource> resourceOperations;
 
   @BeforeEach
   @SuppressWarnings("unchecked")
@@ -71,6 +71,8 @@ void setupMocks() {
     when(client.resources(TestCustomResource.class)).thenReturn(mixedOperation);
     when(mixedOperation.inNamespace(any())).thenReturn(mixedOperation);
     when(mixedOperation.withName(any())).thenReturn(resourceOp);
+
+    resourceOperations = new ResourceOperations<>(context);
   }
 
   @Test
@@ -91,7 +93,7 @@ void addsFinalizer() {
               return res;
             });
 
-    var result = ReconcileUtils.addFinalizer(context, FINALIZER_NAME);
+    var result = resourceOperations.addFinalizer(FINALIZER_NAME);
 
     assertThat(result).isNotNull();
     assertThat(result.hasFinalizer(FINALIZER_NAME)).isTrue();
@@ -118,7 +120,7 @@ void addsFinalizerWithSSA() {
               return res;
             });
 
-    var result = ReconcileUtils.addFinalizerWithSSA(context, FINALIZER_NAME);
+    var result = resourceOperations.addFinalizerWithSSA(FINALIZER_NAME);
 
     assertThat(result).isNotNull();
     assertThat(result.hasFinalizer(FINALIZER_NAME)).isTrue();
@@ -146,7 +148,7 @@ void removesFinalizer() {
               return res;
             });
 
-    var result = ReconcileUtils.removeFinalizer(context, FINALIZER_NAME);
+    var result = resourceOperations.removeFinalizer(FINALIZER_NAME);
 
     assertThat(result).isNotNull();
     assertThat(result.hasFinalizer(FINALIZER_NAME)).isFalse();
@@ -177,7 +179,7 @@ void retriesAddingFinalizerWithoutSSA() {
     // Return fresh resource on retry
     when(resourceOp.get()).thenReturn(resource);
 
-    var result = ReconcileUtils.addFinalizer(context, FINALIZER_NAME);
+    var result = resourceOperations.addFinalizer(FINALIZER_NAME);
 
     assertThat(result).isNotNull();
     assertThat(result.hasFinalizer(FINALIZER_NAME)).isTrue();
@@ -202,7 +204,7 @@ void nullResourceIsGracefullyHandledOnFinalizerRemovalRetry() {
     // Return null on retry (resource was deleted)
     when(resourceOp.get()).thenReturn(null);
 
-    ReconcileUtils.removeFinalizer(context, FINALIZER_NAME);
+    resourceOperations.removeFinalizer(FINALIZER_NAME);
 
     verify(controllerEventSource, times(1))
         .eventFilteringUpdateAndCacheResource(any(), any(UnaryOperator.class));
@@ -235,7 +237,7 @@ void retriesFinalizerRemovalWithFreshResource() {
     freshResource.addFinalizer(FINALIZER_NAME);
     when(resourceOp.get()).thenReturn(freshResource);
 
-    var result = ReconcileUtils.removeFinalizer(context, FINALIZER_NAME);
+    var result = resourceOperations.removeFinalizer(FINALIZER_NAME);
 
     assertThat(result).isNotNull();
     assertThat(result.getMetadata().getResourceVersion()).isEqualTo("3");
@@ -262,7 +264,7 @@ void resourcePatchWithSingleEventSource() {
     when(managedEventSource.eventFilteringUpdateAndCacheResource(any(), any(UnaryOperator.class)))
         .thenReturn(updatedResource);
 
-    var result = ReconcileUtils.resourcePatch(context, resource, UnaryOperator.identity());
+    var result = resourceOperations.resourcePatch(resource, UnaryOperator.identity());
 
     assertThat(result).isNotNull();
     assertThat(result.getMetadata().getResourceVersion()).isEqualTo("2");
@@ -282,7 +284,7 @@ void resourcePatchThrowsWhenNoEventSourceFound() {
     var exception =
         assertThrows(
             IllegalStateException.class,
-            () -> ReconcileUtils.resourcePatch(context, resource, UnaryOperator.identity()));
+            () -> resourceOperations.resourcePatch(resource, UnaryOperator.identity()));
 
     assertThat(exception.getMessage()).contains("No event source found for type");
   }
@@ -301,7 +303,7 @@ void resourcePatchThrowsWhenMultipleEventSourcesFound() {
     var exception =
         assertThrows(
             IllegalStateException.class,
-            () -> ReconcileUtils.resourcePatch(context, resource, UnaryOperator.identity()));
+            () -> resourceOperations.resourcePatch(resource, UnaryOperator.identity()));
 
     assertThat(exception.getMessage()).contains("Multiple event sources found for");
     assertThat(exception.getMessage()).contains("please provide the target event source");
@@ -320,7 +322,7 @@ void resourcePatchThrowsWhenEventSourceIsNotManagedInformer() {
     var exception =
         assertThrows(
             IllegalStateException.class,
-            () -> ReconcileUtils.resourcePatch(context, resource, UnaryOperator.identity()));
+            () -> resourceOperations.resourcePatch(resource, UnaryOperator.identity()));
 
     assertThat(exception.getMessage()).contains("Target event source must be a subclass off");
     assertThat(exception.getMessage()).contains("ManagedInformerEventSource");