Skip to content

Commit f0ee0a3

Browse files
committed
feat: automatically derive the the dependent resource type if not specified
Signed-off-by: xstefank <[email protected]>
1 parent 4225645 commit f0ee0a3

File tree

76 files changed

+140
-315
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+140
-315
lines changed

bootstrapper-maven-plugin/src/main/resources/templates/ConfigMapDependentResource.java

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,6 @@ public class ConfigMapDependentResource
1717

1818
public static final String KEY = "key";
1919

20-
public ConfigMapDependentResource() {
21-
super(ConfigMap.class);
22-
}
23-
2420
@Override
2521
protected ConfigMap desired({{artifactClassId}}CustomResource primary,
2622
Context<{{artifactClassId}}CustomResource> context) {

docs/content/en/docs/documentation/dependent-resource-and-workflows/dependent-resources.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -136,10 +136,6 @@ Deleted (or set to be garbage collected). The following example shows how to cre
136136
@KubernetesDependent(labelSelector = WebPageManagedDependentsReconciler.SELECTOR)
137137
class DeploymentDependentResource extends CRUDKubernetesDependentResource<Deployment, WebPage> {
138138

139-
public DeploymentDependentResource() {
140-
super(Deployment.class);
141-
}
142-
143139
@Override
144140
protected Deployment desired(WebPage webPage, Context<WebPage> context) {
145141
var deploymentName = deploymentName(webPage);

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/Utils.java

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,32 @@ public static Class<?> getTypeArgumentFromExtendedClassByIndex(Class<?> clazz, i
134134
}
135135
}
136136

137+
public static Class<?> getTypeArgumentFromHierarchyByIndex(Class<?> clazz, int index) {
138+
return getTypeArgumentFromHierarchyByIndex(clazz, null, index);
139+
}
140+
141+
public static Class<?> getTypeArgumentFromHierarchyByIndex(
142+
Class<?> clazz, Class<?> expectedImplementedInterface, int index) {
143+
Class<?> c = clazz;
144+
while (!(c.getGenericSuperclass() instanceof ParameterizedType)) {
145+
c = c.getSuperclass();
146+
}
147+
Class<?> actualTypeArgument =
148+
(Class<?>) ((ParameterizedType) c.getGenericSuperclass()).getActualTypeArguments()[index];
149+
if (expectedImplementedInterface != null
150+
&& !expectedImplementedInterface.isAssignableFrom(actualTypeArgument)) {
151+
throw new IllegalArgumentException(
152+
GENERIC_PARAMETER_TYPE_ERROR_PREFIX
153+
+ clazz.getName()
154+
+ "because it doesn't extend a class that is parametrized with the type that"
155+
+ " implements "
156+
+ expectedImplementedInterface.getSimpleName()
157+
+ ". Please provide the resource type in the constructor (e.g.,"
158+
+ " super(Deployment.class).");
159+
}
160+
return actualTypeArgument;
161+
}
162+
137163
public static Class<?> getFirstTypeArgumentFromInterface(
138164
Class<?> clazz, Class<?> expectedImplementedInterface) {
139165
return getTypeArgumentFromInterfaceByIndex(clazz, expectedImplementedInterface, 0);

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

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
import java.util.Optional;
44

55
import io.fabric8.kubernetes.api.model.HasMetadata;
6+
import io.javaoperatorsdk.operator.api.config.Utils;
67
import io.javaoperatorsdk.operator.api.reconciler.Context;
78
import io.javaoperatorsdk.operator.api.reconciler.EventSourceContext;
89
import io.javaoperatorsdk.operator.api.reconciler.Ignore;
@@ -23,13 +24,22 @@ public abstract class AbstractEventSourceHolderDependentResource<
2324
private boolean isCacheFillerEventSource;
2425
protected String eventSourceNameToUse;
2526

27+
@SuppressWarnings("unchecked")
28+
protected AbstractEventSourceHolderDependentResource() {
29+
this(null, null);
30+
}
31+
2632
protected AbstractEventSourceHolderDependentResource(Class<R> resourceType) {
2733
this(resourceType, null);
2834
}
2935

3036
protected AbstractEventSourceHolderDependentResource(Class<R> resourceType, String name) {
3137
super(name);
32-
this.resourceType = resourceType;
38+
if (resourceType == null) {
39+
this.resourceType = (Class<R>) Utils.getTypeArgumentFromHierarchyByIndex(getClass(), 0);
40+
} else {
41+
this.resourceType = resourceType;
42+
}
3343
}
3444

3545
/**

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ public abstract class AbstractExternalDependentResource<
2121

2222
private InformerEventSource<?, P> externalStateEventSource;
2323

24+
protected AbstractExternalDependentResource() {}
25+
2426
@SuppressWarnings("unchecked")
2527
protected AbstractExternalDependentResource(Class<R> resourceType) {
2628
super(resourceType);

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ public abstract class AbstractPollingDependentResource<R, P extends HasMetadata>
1616
public static final Duration DEFAULT_POLLING_PERIOD = Duration.ofMillis(5000);
1717
private Duration pollingPeriod;
1818

19+
protected AbstractPollingDependentResource() {}
20+
1921
protected AbstractPollingDependentResource(Class<R> resourceType) {
2022
this(resourceType, DEFAULT_POLLING_PERIOD);
2123
}

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ public abstract class PerResourcePollingDependentResource<R, P extends HasMetada
1414
extends AbstractPollingDependentResource<R, P>
1515
implements PerResourcePollingEventSource.ResourceFetcher<R, P> {
1616

17+
public PerResourcePollingDependentResource() {}
18+
1719
public PerResourcePollingDependentResource(Class<R> resourceType) {
1820
super(resourceType);
1921
}

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ public abstract class CRUDKubernetesDependentResource<R extends HasMetadata, P e
1818
extends KubernetesDependentResource<R, P>
1919
implements Creator<R, P>, Updater<R, P>, GarbageCollected<P> {
2020

21+
public CRUDKubernetesDependentResource() {}
22+
2123
public CRUDKubernetesDependentResource(Class<R> resourceType) {
2224
super(resourceType);
2325
}

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@
2020
public class CRUDNoGCKubernetesDependentResource<R extends HasMetadata, P extends HasMetadata>
2121
extends KubernetesDependentResource<R, P> implements Creator<R, P>, Updater<R, P>, Deleter<P> {
2222

23+
public CRUDNoGCKubernetesDependentResource() {}
24+
2325
public CRUDNoGCKubernetesDependentResource(Class<R> resourceType) {
2426
super(resourceType);
2527
}

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ public abstract class KubernetesDependentResource<R extends HasMetadata, P exten
4141
private KubernetesDependentResourceConfig<R> kubernetesDependentResourceConfig;
4242
private volatile Boolean useSSA;
4343

44+
public KubernetesDependentResource() {}
45+
4446
public KubernetesDependentResource(Class<R> resourceType) {
4547
this(resourceType, null);
4648
}

0 commit comments

Comments
 (0)