feat: spec now holds optional configuration

metacosm · metacosm · commit a9692d5637a8 · 2024-05-29T18:11:54.000+02:00
Signed-off-by: Chris Laprun &lt;claprun@redhat.com&gt;
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/BaseConfigurationService.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/BaseConfigurationService.java
@@ -224,7 +224,7 @@ private static List<DependentResourceSpec> dependentResources(
           Utils.instantiate(dependent.reconcilePrecondition(), Condition.class, context),
           Utils.instantiate(dependent.deletePostcondition(), Condition.class, context),
           Utils.instantiate(dependent.activationCondition(), Condition.class, context),
-          eventSourceName);
+          eventSourceName, null); // todo: actually compute the configuration
       specsMap.put(dependentName, spec);
     }
     return specsMap.values().stream().toList();
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/dependent/ConfigurationConverter.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/dependent/ConfigurationConverter.java
@@ -8,5 +8,5 @@
 public interface ConfigurationConverter<A extends Annotation, C> {
 
   C configFrom(A configAnnotation, ControllerConfiguration<?> parentConfiguration,
-      DependentResourceSpec<?, ?> spec, DependentResource<?, ?> dependentResource);
+      DependentResourceSpec<?, ?, ?> spec, DependentResource<?, ?> dependentResource);
 }
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/dependent/DependentResourceSpec.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/dependent/DependentResourceSpec.java
@@ -8,7 +8,7 @@
 import io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResource;
 import io.javaoperatorsdk.operator.processing.dependent.workflow.Condition;
 
-public class DependentResourceSpec<R, P extends HasMetadata> {
+public class DependentResourceSpec<R, P extends HasMetadata, C> {
 
   private final Class<? extends DependentResource<R, P>> dependentResourceClass;
 
@@ -25,11 +25,12 @@ public class DependentResourceSpec<R, P extends HasMetadata> {
   private final Condition<?, ?> activationCondition;
 
   private final String useEventSourceWithName;
+  private final C nullableConfiguation;
 
   public DependentResourceSpec(Class<? extends DependentResource<R, P>> dependentResourceClass,
       String name, Set<String> dependsOn, Condition<?, ?> readyCondition,
       Condition<?, ?> reconcileCondition, Condition<?, ?> deletePostCondition,
-      Condition<?, ?> activationCondition, String useEventSourceWithName) {
+      Condition<?, ?> activationCondition, String useEventSourceWithName, C nullableConfiguration) {
     this.dependentResourceClass = dependentResourceClass;
     this.name = name;
     this.dependsOn = dependsOn;
@@ -38,6 +39,7 @@ public DependentResourceSpec(Class<? extends DependentResource<R, P>> dependentR
     this.deletePostCondition = deletePostCondition;
     this.activationCondition = activationCondition;
     this.useEventSourceWithName = useEventSourceWithName;
+    this.nullableConfiguation = nullableConfiguration;
   }
 
   public Class<? extends DependentResource<R, P>> getDependentResourceClass() {
@@ -62,7 +64,7 @@ public boolean equals(Object o) {
     if (o == null || getClass() != o.getClass()) {
       return false;
     }
-    DependentResourceSpec<?, ?> that = (DependentResourceSpec<?, ?>) o;
+    DependentResourceSpec<?, ?, ?> that = (DependentResourceSpec<?, ?, ?>) o;
     return name.equals(that.name);
   }
 
@@ -98,4 +100,8 @@ public Condition getActivationCondition() {
   public Optional<String> getUseEventSourceWithName() {
     return Optional.ofNullable(useEventSourceWithName);
   }
+
+  public Optional<C> getConfiguration() {
+    return Optional.ofNullable(nullableConfiguation);
+  }
 }
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/KubernetesDependentConverter.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/KubernetesDependentConverter.java
@@ -34,7 +34,7 @@ public class KubernetesDependentConverter<R extends HasMetadata, P extends HasMe
   @SuppressWarnings({"unchecked", "rawtypes"})
   public KubernetesDependentResourceConfig<R> configFrom(KubernetesDependent configAnnotation,
       ControllerConfiguration<?> controllerConfig,
-      DependentResourceSpec<?, ?> spec, DependentResource<?, ?> dependentResource) {
+      DependentResourceSpec<?, ?, ?> spec, DependentResource<?, ?> dependentResource) {
 
     var createResourceOnlyIfNotExistingWithSSA =
         DEFAULT_CREATE_RESOURCE_ONLY_IF_NOT_EXISTING_WITH_SSA;
@@ -48,7 +48,7 @@ public KubernetesDependentResourceConfig<R> configFrom(KubernetesDependent confi
 
     var informerConfiguration = createInformerConfiguration(configAnnotation,
         controllerConfig,
-        (DependentResourceSpec<R, P>) spec,
+        (DependentResourceSpec<R, P, KubernetesDependentResourceConfig<R>>) spec,
         (DependentResource<R, P>) dependentResource);
 
     return new KubernetesDependentResourceConfig(useSSA, createResourceOnlyIfNotExistingWithSSA,
@@ -59,7 +59,8 @@ public KubernetesDependentResourceConfig<R> configFrom(KubernetesDependent confi
   @SuppressWarnings({"unchecked", "rawtypes"})
   private InformerConfiguration<R> createInformerConfiguration(KubernetesDependent configAnnotation,
       ControllerConfiguration<?> controllerConfig,
-      DependentResourceSpec<R, P> spec, DependentResource<R, P> dependentResource) {
+      DependentResourceSpec<R, P, KubernetesDependentResourceConfig<R>> spec,
+      DependentResource<R, P> dependentResource) {
     Class<? extends KubernetesDependentResource<?, ?>> dependentResourceClass =
         (Class<? extends KubernetesDependentResource<?, ?>>) spec.getDependentResourceClass();
     var resourceType = dependentResource.resourceType();
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/workflow/DefaultManagedWorkflow.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/workflow/DefaultManagedWorkflow.java
@@ -31,7 +31,7 @@ protected DefaultManagedWorkflow(List<DependentResourceSpec> orderedSpecs, boole
         .map(DependentResourceSpec::getName)
         .collect(Collectors.toSet());
     this.orderedSpecs = orderedSpecs;
-    for (DependentResourceSpec<?, ?> spec : orderedSpecs) {
+    for (DependentResourceSpec<?, ?, ?> spec : orderedSpecs) {
       // add cycle detection?
       if (spec.getDependsOn().isEmpty()) {
         topLevelResources.add(spec.getName());
@@ -99,7 +99,7 @@ public Workflow<P> resolve(KubernetesClient client,
   }
 
   @SuppressWarnings({"rawtypes", "unchecked"})
-  private <R> DependentResource<R, P> resolve(DependentResourceSpec<R, P> spec,
+  private <R> DependentResource<R, P> resolve(DependentResourceSpec<R, P, ?> spec,
       KubernetesClient client,
       ControllerConfiguration<P> configuration) {
     final DependentResource<R, P> dependentResource =
diff --git a/operator-framework-core/src/test/java/io/javaoperatorsdk/operator/api/config/dependent/DependentResourceConfigurationResolverTest.java b/operator-framework-core/src/test/java/io/javaoperatorsdk/operator/api/config/dependent/DependentResourceConfigurationResolverTest.java
@@ -136,7 +136,7 @@ public Object configFrom(Annotation configAnnotation,
     assertEquals(overriddenConverter, converter);
   }
 
-  private DependentResourceSpec<?, ?> specWithDependentClass(
+  private DependentResourceSpec<?, ?, ?> specWithDependentClass(
       Class<? extends DependentResource> dr) {
     var spec = mock(DependentResourceSpec.class);
     when(spec.getDependentResourceClass()).thenReturn(dr);
@@ -243,7 +243,7 @@ private static class CustomConfigConverter
     @Override
     public CustomConfig configFrom(CustomAnnotation configAnnotation,
         io.javaoperatorsdk.operator.api.config.ControllerConfiguration<?> parentConfiguration,
-        DependentResourceSpec<?, ?> spec, DependentResource<?, ?> dependentResource) {
+        DependentResourceSpec<?, ?, ?> spec, DependentResource<?, ?> dependentResource) {
       if (configAnnotation == null) {
         return new CustomConfig(CONVERTER_PROVIDED_DEFAULT);
       } else {
diff --git a/operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/dependent/workflow/ManagedWorkflowTestUtils.java b/operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/dependent/workflow/ManagedWorkflowTestUtils.java
@@ -11,17 +11,15 @@
 import io.javaoperatorsdk.operator.processing.dependent.EmptyTestDependentResource;
 import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependentResource;
 
-import static org.mockito.Mockito.mock;
-import static org.mockito.Mockito.when;
-import static org.mockito.Mockito.withSettings;
+import static org.mockito.Mockito.*;
 
 @SuppressWarnings("rawtypes")
 public class ManagedWorkflowTestUtils {
 
   @SuppressWarnings("unchecked")
   public static DependentResourceSpec createDRS(String name, String... dependOns) {
     return new DependentResourceSpec(EmptyTestDependentResource.class, name, Set.of(dependOns),
-        null, null, null, null, null);
+        null, null, null, null, null, null);
   }
 
   public static DependentResourceSpec createDRSWithTraits(String name,
diff --git a/operator-framework/src/test/java/io/javaoperatorsdk/operator/config/BaseConfigurationServiceTest.java b/operator-framework/src/test/java/io/javaoperatorsdk/operator/config/BaseConfigurationServiceTest.java
@@ -509,7 +509,7 @@ private static class CustomConfigConverter
     @Override
     public CustomConfig configFrom(CustomAnnotation configAnnotation,
         io.javaoperatorsdk.operator.api.config.ControllerConfiguration<?> parentConfiguration,
-        DependentResourceSpec<?, ?> spec, DependentResource<?, ?> dependentResource) {
+        DependentResourceSpec<?, ?, ?> spec, DependentResource<?, ?> dependentResource) {
       if (configAnnotation == null) {
         return new CustomConfig(CONVERTER_PROVIDED_DEFAULT);
       } else {
diff --git a/sample-operators/mysql-schema/src/main/java/io/javaoperatorsdk/operator/sample/dependent/SchemaDependentResource.java b/sample-operators/mysql-schema/src/main/java/io/javaoperatorsdk/operator/sample/dependent/SchemaDependentResource.java
@@ -128,7 +128,7 @@ static class ResourcePollerConfigConverter implements
     @Override
     public ResourcePollerConfig configFrom(SchemaConfig configAnnotation,
         ControllerConfiguration<?> parentConfiguration,
-        DependentResourceSpec<?, ?> spec, DependentResource<?, ?> dependentResource) {
+        DependentResourceSpec<?, ?, ?> spec, DependentResource<?, ?> dependentResource) {
       if (configAnnotation != null) {
         return new ResourcePollerConfig(Duration.ofMillis(configAnnotation.pollPeriod()),
             new MySQLDbConfig(configAnnotation.host(), String.valueOf(configAnnotation.port()),

Original file line number	Diff line number	Diff line change
`@@ -224,7 +224,7 @@ private static List<DependentResourceSpec> dependentResources(`
`224`	`224`	`Utils.instantiate(dependent.reconcilePrecondition(), Condition.class, context),`
`225`	`225`	`Utils.instantiate(dependent.deletePostcondition(), Condition.class, context),`
`226`	`226`	`Utils.instantiate(dependent.activationCondition(), Condition.class, context),`
`227`		`- eventSourceName);`
	`227`	`+ eventSourceName, null); // todo: actually compute the configuration`
`228`	`228`	`specsMap.put(dependentName, spec);`
`229`	`229`	`}`
`230`	`230`	`return specsMap.values().stream().toList();`
Original file line number	Diff line number	Diff line change
`@@ -8,5 +8,5 @@`
`8`	`8`	`public interface ConfigurationConverter<A extends Annotation, C> {`
`9`	`9`
`10`	`10`	`C configFrom(A configAnnotation, ControllerConfiguration<?> parentConfiguration,`
`11`		`- DependentResourceSpec<?, ?> spec, DependentResource<?, ?> dependentResource);`
	`11`	`+ DependentResourceSpec<?, ?, ?> spec, DependentResource<?, ?> dependentResource);`
`12`	`12`	`}`