feat: desired method aware of actual resource

Author: csviri

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/AbstractDependentResource.java

@@ -33,7 +33,7 @@ public ReconcileResult<R> reconcile(P primary, Context<P> context) {
     if (creatable || updatable) {
       if (maybeActual.isEmpty()) {
         if (creatable) {
-          var desired = desired(primary, context);
+          var desired = desired(primary, null, context);
           throwIfNull(desired, primary, "Desired");
           logForOperation("Creating", primary, desired);
           var createdResource = handleCreate(desired, primary, context);
@@ -44,7 +44,7 @@ public ReconcileResult<R> reconcile(P primary, Context<P> context) {
         if (updatable) {
           final var match = updater.match(actual, primary, context);
           if (!match.matched()) {
-            final var desired = match.computedDesired().orElse(desired(primary, context));
+            final var desired = match.computedDesired().orElse(desired(primary, actual, context));
             throwIfNull(desired, primary, "Desired");
             logForOperation("Updating", primary, desired);
             var updatedResource = handleUpdate(actual, desired, primary, context);
@@ -114,7 +114,7 @@ protected R handleUpdate(R actual, R desired, P primary, Context<P> context) {
     return updated;
   }
 
-  protected R desired(P primary, Context<P> context) {
+  protected R desired(P primary, R actual, Context<P> context) {
     throw new IllegalStateException(
         "desired method must be implemented if this DependentResource can be created and/or updated");
   }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/DesiredEqualsMatcher.java

@@ -13,7 +13,7 @@ public DesiredEqualsMatcher(AbstractDependentResource<R, P> abstractDependentRes
 
   @Override
   public Result<R> match(R actualResource, P primary, Context<P> context) {
-    var desired = abstractDependentResource.desired(primary, context);
+    var desired = abstractDependentResource.desired(primary, actualResource, context);
     return Result.computed(actualResource.equals(desired), desired);
   }
 }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/GenericKubernetesResourceMatcher.java

@@ -25,13 +25,13 @@ static <R extends HasMetadata, P extends HasMetadata> Matcher<R, P> matcherFor(
       Class<R> resourceType, KubernetesDependentResource<R, P> dependentResource) {
     if (Secret.class.isAssignableFrom(resourceType)) {
       return (actual, primary, context) -> {
-        final var desired = dependentResource.desired(primary, context);
+        final var desired = dependentResource.desired(primary, actual, context);
         return Result.computed(
             ResourceComparators.compareSecretData((Secret) desired, (Secret) actual), desired);
       };
     } else if (ConfigMap.class.isAssignableFrom(resourceType)) {
       return (actual, primary, context) -> {
-        final var desired = dependentResource.desired(primary, context);
+        final var desired = dependentResource.desired(primary, actual, context);
         return Result.computed(
             ResourceComparators.compareConfigMapData((ConfigMap) desired, (ConfigMap) actual),
             desired);
@@ -68,7 +68,7 @@ public Result<R> match(R actualResource, P primary, Context<P> context) {
   public static <R extends HasMetadata, P extends HasMetadata> Result<R> match(
       KubernetesDependentResource<R, P> dependentResource, R actualResource, P primary,
       Context<P> context, boolean considerMetadata) {
-    final var desired = dependentResource.desired(primary, context);
+    final var desired = dependentResource.desired(primary, actualResource, context);
     if (considerMetadata) {
       final var desiredMetadata = desired.getMetadata();
       final var actualMetadata = actualResource.getMetadata();

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/KubernetesDependentResource.java

@@ -224,8 +224,8 @@ public KubernetesClient getKubernetesClient() {
   }
 
   @Override
-  protected R desired(P primary, Context<P> context) {
-    return super.desired(primary, context);
+  protected R desired(P primary, R actual, Context<P> context) {
+    return super.desired(primary, actual, context);
   }
 
   private void prepareEventFiltering(R desired, ResourceID resourceID) {

operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/dependent/AbstractDependentResourceTest.java

@@ -91,7 +91,8 @@ protected void onCreated(ResourceID primaryResourceId, ConfigMap created) {}
     protected void onUpdated(ResourceID primaryResourceId, ConfigMap updated, ConfigMap actual) {}
 
     @Override
-    protected ConfigMap desired(TestCustomResource primary, Context<TestCustomResource> context) {
+    protected ConfigMap desired(TestCustomResource primary, ConfigMap actual,
+        Context<TestCustomResource> context) {
       return desired;
     }
 

operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/dependent/external/AbstractSimpleDependentResourceTest.java

@@ -137,7 +137,7 @@ public SampleExternalResource update(
 
     @Override
     protected SampleExternalResource desired(TestCustomResource primary,
-        Context<TestCustomResource> context) {
+        SampleExternalResource actual, Context<TestCustomResource> context) {
       return SampleExternalResource.testResource1();
     }
 

operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/GenericKubernetesResourceMatcherTest.java

@@ -93,7 +93,7 @@ public TestDependentResource(Deployment desired) {
     }
 
     @Override
-    protected Deployment desired(HasMetadata primary, Context context) {
+    protected Deployment desired(HasMetadata primary, Deployment actual, Context context) {
       final var currentCase = Optional.ofNullable(primary)
           .map(p -> p.getMetadata().getLabels().get("case"))
           .orElse(null);

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/cleanermanageddependent/ConfigMapDependentResource.java

@@ -25,7 +25,7 @@ public ConfigMapDependentResource() {
 
   @Override
   protected ConfigMap desired(CleanerForManagedDependentCustomResource primary,
-      Context<CleanerForManagedDependentCustomResource> context) {
+      ConfigMap actual, Context<CleanerForManagedDependentCustomResource> context) {
 
     ConfigMap configMap = new ConfigMap();
     configMap.setMetadata(new ObjectMeta());

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/dependentannotationsecondarymapper/DependentAnnotationSecondaryMapperReconciler.java

@@ -44,7 +44,7 @@ public ConfigMapDependentResource() {
 
     @Override
     protected ConfigMap desired(DependentAnnotationSecondaryMapperResource primary,
-        Context<DependentAnnotationSecondaryMapperResource> context) {
+        ConfigMap actual, Context<DependentAnnotationSecondaryMapperResource> context) {
       ConfigMap configMap = new ConfigMap();
       configMap.setMetadata(new ObjectMetaBuilder()
           .withName(primary.getMetadata().getName())

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/dependentfilter/FilteredDependentConfigMap.java

@@ -20,7 +20,7 @@ public FilteredDependentConfigMap() {
 
   @Override
   protected ConfigMap desired(DependentFilterTestCustomResource primary,
-      Context<DependentFilterTestCustomResource> context) {
+      ConfigMap actual, Context<DependentFilterTestCustomResource> context) {
     ConfigMap configMap = new ConfigMap();
     configMap.setMetadata(new ObjectMetaBuilder()
         .withName(primary.getMetadata().getName())

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/dependentoperationeventfiltering/ConfigMapDependentResource.java

@@ -18,7 +18,7 @@ public ConfigMapDependentResource() {
 
   @Override
   protected ConfigMap desired(DependentOperationEventFilterCustomResource primary,
-      Context<DependentOperationEventFilterCustomResource> context) {
+      ConfigMap actual, Context<DependentOperationEventFilterCustomResource> context) {
 
     ConfigMap configMap = new ConfigMap();
     configMap.setMetadata(new ObjectMeta());

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/dependentresourcecrossref/DependentResourceCrossRefReconciler.java

@@ -60,7 +60,7 @@ public SecretDependentResource() {
 
     @Override
     protected Secret desired(DependentResourceCrossRefResource primary,
-        Context<DependentResourceCrossRefResource> context) {
+        Secret actual, Context<DependentResourceCrossRefResource> context) {
       Secret secret = new Secret();
       secret.setMetadata(new ObjectMetaBuilder()
           .withName(primary.getMetadata().getName())
@@ -80,7 +80,7 @@ public ConfigMapDependentResource() {
 
     @Override
     protected ConfigMap desired(DependentResourceCrossRefResource primary,
-        Context<DependentResourceCrossRefResource> context) {
+        ConfigMap actual, Context<DependentResourceCrossRefResource> context) {
       var secret = context.getSecondaryResource(Secret.class);
       if (secret.isEmpty()) {
         throw new IllegalStateException("Secret is empty");

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/kubernetesdependentgarbagecollection/DependentGarbageCollectionTestReconciler.java

@@ -89,7 +89,7 @@ public ConfigMapDependentResource() {
 
     @Override
     protected ConfigMap desired(DependentGarbageCollectionTestCustomResource primary,
-        Context<DependentGarbageCollectionTestCustomResource> context) {
+        ConfigMap actual, Context<DependentGarbageCollectionTestCustomResource> context) {
       ConfigMap configMap = new ConfigMap();
       configMap.setMetadata(new ObjectMetaBuilder()
           .withName(primary.getMetadata().getName())

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/multipledependentresource/MultipleDependentResourceConfigMap.java

@@ -23,7 +23,7 @@ public MultipleDependentResourceConfigMap(int value) {
 
   @Override
   protected ConfigMap desired(MultipleDependentResourceCustomResource primary,
-      Context<MultipleDependentResourceCustomResource> context) {
+      ConfigMap actual, Context<MultipleDependentResourceCustomResource> context) {
     Map<String, String> data = new HashMap<>();
     data.put(DATA_KEY, String.valueOf(value));
 

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/orderedmanageddependent/ConfigMapDependentResource1.java

@@ -27,7 +27,7 @@ public ReconcileResult<ConfigMap> reconcile(OrderedManagedDependentCustomResourc
 
   @Override
   protected ConfigMap desired(OrderedManagedDependentCustomResource primary,
-      Context<OrderedManagedDependentCustomResource> context) {
+      ConfigMap actual, Context<OrderedManagedDependentCustomResource> context) {
 
     ConfigMap configMap = new ConfigMap();
     configMap.setMetadata(new ObjectMeta());

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/orderedmanageddependent/ConfigMapDependentResource2.java

@@ -27,7 +27,7 @@ public ReconcileResult<ConfigMap> reconcile(OrderedManagedDependentCustomResourc
 
   @Override
   protected ConfigMap desired(OrderedManagedDependentCustomResource primary,
-      Context<OrderedManagedDependentCustomResource> context) {
+      ConfigMap actual, Context<OrderedManagedDependentCustomResource> context) {
 
     ConfigMap configMap = new ConfigMap();
     configMap.setMetadata(new ObjectMeta());

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/standalonedependent/StandaloneDependentTestReconciler.java

@@ -95,7 +95,7 @@ public DeploymentDependentResource() {
 
     @Override
     protected Deployment desired(StandaloneDependentTestCustomResource primary,
-        Context<StandaloneDependentTestCustomResource> context) {
+        Deployment actual, Context<StandaloneDependentTestCustomResource> context) {
       Deployment deployment =
           ReconcilerUtils.loadYaml(Deployment.class, StandaloneDependentResourceIT.class,
               "nginx-deployment.yaml");

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/workflowallfeature/ConfigMapDependentResource.java

@@ -31,7 +31,7 @@ public ConfigMapDependentResource() {
 
   @Override
   protected ConfigMap desired(WorkflowAllFeatureCustomResource primary,
-      Context<WorkflowAllFeatureCustomResource> context) {
+      ConfigMap actual, Context<WorkflowAllFeatureCustomResource> context) {
     ConfigMap configMap = new ConfigMap();
     configMap.setMetadata(new ObjectMetaBuilder()
         .withName(primary.getMetadata().getName())

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/workflowallfeature/DeploymentDependentResource.java

@@ -15,7 +15,7 @@ public DeploymentDependentResource() {
 
   @Override
   protected Deployment desired(WorkflowAllFeatureCustomResource primary,
-      Context<WorkflowAllFeatureCustomResource> context) {
+      Deployment actual, Context<WorkflowAllFeatureCustomResource> context) {
     Deployment deployment =
         ReconcilerUtils.loadYaml(Deployment.class, WorkflowAllFeatureIT.class,
             "nginx-deployment.yaml");

sample-operators/mysql-schema/src/main/java/io/javaoperatorsdk/operator/sample/dependent/SchemaDependentResource.java

@@ -46,7 +46,7 @@ public void configureWith(ResourcePollerConfig config) {
   }
 
   @Override
-  public Schema desired(MySQLSchema primary, Context<MySQLSchema> context) {
+  public Schema desired(MySQLSchema primary, Schema actual, Context<MySQLSchema> context) {
     return new Schema(primary.getMetadata().getName(), primary.getSpec().getEncoding());
   }
 

sample-operators/mysql-schema/src/main/java/io/javaoperatorsdk/operator/sample/dependent/SecretDependentResource.java

@@ -33,7 +33,7 @@ private static String encode(String value) {
   }
 
   @Override
-  protected Secret desired(MySQLSchema schema, Context<MySQLSchema> context) {
+  protected Secret desired(MySQLSchema schema, Secret actual, Context<MySQLSchema> context) {
     final var password = RandomStringUtils
         .randomAlphanumeric(16); // NOSONAR: we don't need cryptographically-strong randomness here
     final var name = schema.getMetadata().getName();

sample-operators/tomcat-operator/src/main/java/io/javaoperatorsdk/operator/sample/DeploymentDependentResource.java

@@ -21,7 +21,7 @@ private static String tomcatImage(Tomcat tomcat) {
   }
 
   @Override
-  protected Deployment desired(Tomcat tomcat, Context<Tomcat> context) {
+  protected Deployment desired(Tomcat tomcat, Deployment actual, Context<Tomcat> context) {
     Deployment deployment =
         ReconcilerUtils.loadYaml(Deployment.class, getClass(), "deployment.yaml");
     final ObjectMeta tomcatMetadata = tomcat.getMetadata();

sample-operators/tomcat-operator/src/main/java/io/javaoperatorsdk/operator/sample/ServiceDependentResource.java

@@ -16,7 +16,7 @@ public ServiceDependentResource() {
   }
 
   @Override
-  protected Service desired(Tomcat tomcat, Context<Tomcat> context) {
+  protected Service desired(Tomcat tomcat, Service actual, Context<Tomcat> context) {
     final ObjectMeta tomcatMetadata = tomcat.getMetadata();
     return new ServiceBuilder(ReconcilerUtils.loadYaml(Service.class, getClass(), "service.yaml"))
         .editMetadata()

sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/ConfigMapDependentResource.java

@@ -29,7 +29,7 @@ public ConfigMapDependentResource() {
   }
 
   @Override
-  protected ConfigMap desired(WebPage webPage, Context<WebPage> context) {
+  protected ConfigMap desired(WebPage webPage, ConfigMap actual, Context<WebPage> context) {
     Map<String, String> data = new HashMap<>();
     data.put("index.html", webPage.getSpec().getHtml());
     Map<String, String> labels = new HashMap<>();

sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/DeploymentDependentResource.java

@@ -24,7 +24,7 @@ public DeploymentDependentResource() {
   }
 
   @Override
-  protected Deployment desired(WebPage webPage, Context<WebPage> context) {
+  protected Deployment desired(WebPage webPage, Deployment actual, Context<WebPage> context) {
     Map<String, String> labels = new HashMap<>();
     labels.put(SELECTOR, "true");
     var deploymentName = deploymentName(webPage);

sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/IngressDependentResource.java

@@ -16,7 +16,7 @@ public IngressDependentResource() {
   }
 
   @Override
-  protected Ingress desired(WebPage webPage, Context<WebPage> context) {
+  protected Ingress desired(WebPage webPage, Ingress actual, Context<WebPage> context) {
     return makeDesiredIngress(webPage);
   }
 

sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/ServiceDependentResource.java

@@ -22,7 +22,7 @@ public ServiceDependentResource() {
   }
 
   @Override
-  protected Service desired(WebPage webPage, Context<WebPage> context) {
+  protected Service desired(WebPage webPage, Service actual, Context<WebPage> context) {
     Map<String, String> serviceLabels = new HashMap<>();
     serviceLabels.put(SELECTOR, "true");
     Service service = loadYaml(Service.class, getClass(), "service.yaml");