refactor to use a dedicated interface for setting the name

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

Author: csviri

Diff for: operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/dependent/DependentResource.java

@@ -69,7 +69,6 @@ default boolean isDeletable() {
     return this instanceof Deleter;
   }
 
-  String getName();
+  String name();
 
-  void setName(String name);
 }

Diff for: operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/dependent/NameSetter.java

@@ -0,0 +1,7 @@
+package io.javaoperatorsdk.operator.api.reconciler.dependent;
+
+public interface NameSetter {
+
+  void setName(String name);
+
+}

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

@@ -11,13 +11,14 @@
 import io.javaoperatorsdk.operator.api.reconciler.ResourceDiscriminator;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.Deleter;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResource;
+import io.javaoperatorsdk.operator.api.reconciler.dependent.NameSetter;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.ReconcileResult;
 import io.javaoperatorsdk.operator.processing.dependent.Matcher.Result;
 import io.javaoperatorsdk.operator.processing.event.ResourceID;
 
 @Ignore
 public abstract class AbstractDependentResource<R, P extends HasMetadata>
-    implements DependentResource<R, P> {
+    implements DependentResource<R, P>, NameSetter {
   private static final Logger log = LoggerFactory.getLogger(AbstractDependentResource.class);
 
   private final boolean creatable = this instanceof Creator;
@@ -180,7 +181,7 @@ public boolean isDeletable() {
   }
 
   @Override
-  public String getName() {
+  public String name() {
     return name;
   }
 

Diff for: operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/workflow/AbstractWorkflowExecutor.java

@@ -139,13 +139,13 @@ protected <R> void registerOrDeregisterEventSourceBasedOnActivation(
                 .eventSourceContextForDynamicRegistration());
         var es = eventSource.orElseThrow();
         context.eventSourceRetriever()
-            .dynamicallyRegisterEventSource(dependentResourceNode.getDependentResource().getName(),
+            .dynamicallyRegisterEventSource(dependentResourceNode.getDependentResource().name(),
                 es);
 
       } else {
         context.eventSourceRetriever()
             .dynamicallyDeRegisterEventSource(
-                dependentResourceNode.getDependentResource().getName());
+                dependentResourceNode.getDependentResource().name());
       }
     }
   }

Diff for: operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/workflow/DefaultManagedWorkflow.java

@@ -12,6 +12,7 @@
 import io.javaoperatorsdk.operator.api.config.dependent.DependentResourceSpec;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResource;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.EventSourceReferencer;
+import io.javaoperatorsdk.operator.api.reconciler.dependent.NameSetter;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.managed.KubernetesClientAware;
 
 import static io.javaoperatorsdk.operator.api.reconciler.Constants.NO_VALUE_SET;
@@ -84,7 +85,7 @@ public Workflow<P> resolve(KubernetesClient client,
           spec.getReadyCondition(),
           spec.getActivationCondition(),
           resolve(spec, client, configuration));
-      alreadyResolved.put(node.getDependentResource().getName(), node);
+      alreadyResolved.put(node.getDependentResource().name(), node);
       spec.getDependsOn()
           .forEach(depend -> node.addDependsOnRelation(alreadyResolved.get(depend)));
     }
@@ -105,8 +106,9 @@ private <R> DependentResource<R, P> resolve(DependentResourceSpec<R, P> spec,
         configuration.getConfigurationService().dependentResourceFactory()
             .createFrom(spec, configuration);
 
-    if (spec.getName() != null && !spec.getName().equals(NO_VALUE_SET)) {
-      dependentResource.setName(spec.getName());
+    if (spec.getName() != null && !spec.getName().equals(NO_VALUE_SET)
+        && dependentResource instanceof NameSetter) {
+      ((NameSetter) dependentResource).setName(spec.getName());
     }
 
     if (dependentResource instanceof KubernetesClientAware) {

Diff for: operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/workflow/DefaultWorkflow.java

@@ -77,7 +77,7 @@ private Map<String, DependentResourceNode> toMap(Set<DependentResourceNode> node
           bottomLevelResource.remove(dependsOn);
         }
       }
-      map.put(node.getDependentResource().getName(), node);
+      map.put(node.getDependentResource().name(), node);
     }
     if (topLevelResources.size() == 0) {
       throw new IllegalStateException(

Diff for: operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/workflow/DependentResourceNode.java

@@ -96,12 +96,12 @@ public boolean equals(Object o) {
       return false;
     }
     DependentResourceNode<?, ?> that = (DependentResourceNode<?, ?>) o;
-    return this.getDependentResource().getName().equals(that.getDependentResource().getName());
+    return this.getDependentResource().name().equals(that.getDependentResource().name());
   }
 
   @Override
   public int hashCode() {
-    return this.getDependentResource().getName().hashCode();
+    return this.getDependentResource().name().hashCode();
   }
 
   @SuppressWarnings("rawtypes")

Diff for: operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/workflow/WorkflowBuilder.java

@@ -23,7 +23,7 @@ public class WorkflowBuilder<P extends HasMetadata> {
   public WorkflowBuilder<P> addDependentResource(DependentResource dependentResource) {
     currentNode = new DependentResourceNode<>(dependentResource);
     isCleaner = isCleaner || dependentResource.isDeletable();
-    final var actualName = dependentResource.getName();
+    final var actualName = dependentResource.name();
     dependentResourceNodes.put(actualName, currentNode);
     return this;
   }
@@ -66,7 +66,7 @@ public WorkflowBuilder<P> withActivationCondition(Condition activationCondition)
   DependentResourceNode getNodeByDependentResource(DependentResource<?, ?> dependentResource) {
     // first check by name
     final var node =
-        dependentResourceNodes.get(dependentResource.getName());
+        dependentResourceNodes.get(dependentResource.name());
     if (node != null) {
       return node;
     } else {

Diff for: operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/workflow/WorkflowResult.java

@@ -38,7 +38,7 @@ public void throwAggregateExceptionIfErrorsPresent() {
     if (erroredDependentsExist()) {
       throw new AggregatedOperatorException("Exception(s) during workflow execution.",
           erroredDependents.entrySet().stream()
-              .collect(Collectors.toMap(e -> e.getKey().getName(), Entry::getValue)));
+              .collect(Collectors.toMap(e -> e.getKey().name(), Entry::getValue)));
     }
   }
 }

Diff for: operator-framework-core/src/test/java/io/javaoperatorsdk/operator/api/config/ControllerConfigurationOverriderTest.java

@@ -75,8 +75,7 @@ void overridingNSShouldPreserveUntouchedDependents() {
   private static class NamedDependentReconciler implements Reconciler<ConfigMap> {
 
     @Override
-    public UpdateControl<ConfigMap> reconcile(ConfigMap resource, Context<ConfigMap> context)
-        throws Exception {
+    public UpdateControl<ConfigMap> reconcile(ConfigMap resource, Context<ConfigMap> context) {
       return null;
     }
 
@@ -104,13 +103,10 @@ public Class<Object> resourceType() {
       }
 
       @Override
-      public String getName() {
+      public String name() {
         return null;
       }
 
-      @Override
-      public void setName(String name) {}
-
       @Override
       public void configureWith(String config) {
         this.config = config;

Diff for: operator-framework-core/src/test/java/io/javaoperatorsdk/operator/api/config/dependent/DependentResourceConfigurationResolverTest.java

@@ -176,13 +176,10 @@ public Class<ConfigMap> resourceType() {
     }
 
     @Override
-    public String getName() {
+    public String name() {
       return null;
     }
 
-    @Override
-    public void setName(String name) {}
-
     @Override
     public void configureWith(CustomConfig config) {
       this.config = config;

Diff for: operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/dependent/EmptyTestDependentResource.java

@@ -23,11 +23,10 @@ public Class<Deployment> resourceType() {
   }
 
   @Override
-  public String getName() {
+  public String name() {
     return name;
   }
 
-  @Override
   public void setName(String name) {
     this.name = name;
   }

Diff for: operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/dependent/workflow/AbstractWorkflowExecutorTest.java

@@ -110,15 +110,10 @@ public Class<String> resourceType() {
     }
 
     @Override
-    public String getName() {
+    public String name() {
       return name;
     }
 
-    @Override
-    public void setName(String name) {
-      this.name = name;
-    }
-
     @Override
     public String toString() {
       return name;

Diff for: operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/dependent/workflow/WorkflowBuilderTest.java

@@ -13,10 +13,10 @@ class WorkflowBuilderTest {
   @Test
   void workflowIsCleanerIfAtLeastOneDRIsCleaner() {
     var dr = mock(DependentResource.class);
-    when(dr.getName()).thenReturn("dr");
+    when(dr.name()).thenReturn("dr");
     var deleter = mock(DependentResource.class);
     when(deleter.isDeletable()).thenReturn(true);
-    when(deleter.getName()).thenReturn("deleter");
+    when(deleter.name()).thenReturn("deleter");
 
     var workflow = new WorkflowBuilder<TestCustomResource>()
         .addDependentResource(deleter)

Diff for: operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/dependent/workflow/WorkflowTest.java

@@ -102,7 +102,7 @@ void isDeletableShouldWork() {
 
   static DependentResource mockDependent(String name) {
     var res = mock(DependentResource.class);
-    when(res.getName()).thenReturn(name);
+    when(res.name()).thenReturn(name);
     return res;
   }
 

Diff for: operator-framework/src/test/java/io/javaoperatorsdk/operator/config/BaseConfigurationServiceTest.java

@@ -471,13 +471,10 @@ public Class<ConfigMap> resourceType() {
     }
 
     @Override
-    public String getName() {
+    public String name() {
       return null;
     }
 
-    @Override
-    public void setName(String name) {}
-
     @Override
     public void configureWith(CustomConfig config) {
       this.config = config;