feat: Make @configured, @GradualRetry and @ratelimited Inherited (#2091…

…) (#2092) Signed-off-by: Bram Meerten <bram.mee@gmail.com> Co-authored-by: Attila Mészáros <csviri@gmail.com>
operator-framework · Nov 13, 2023 · b9e0b82 · b9e0b82
1 parent 0112410
commit b9e0b82
Show file tree

Hide file tree

Showing 3 changed files with 51 additions and 0 deletions.
diff --git a/...ork-core/src/main/java/io/javaoperatorsdk/operator/processing/event/rate/RateLimited.java b/...ork-core/src/main/java/io/javaoperatorsdk/operator/processing/event/rate/RateLimited.java
@@ -1,11 +1,13 @@
 package io.javaoperatorsdk.operator.processing.event.rate;
 
 import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 import java.util.concurrent.TimeUnit;
 
+@Inherited
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.TYPE})
 public @interface RateLimited {

diff --git a/...amework-core/src/main/java/io/javaoperatorsdk/operator/processing/retry/GradualRetry.java b/...amework-core/src/main/java/io/javaoperatorsdk/operator/processing/retry/GradualRetry.java
@@ -1,10 +1,12 @@
 package io.javaoperatorsdk.operator.processing.retry;
 
 import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+@Inherited
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.TYPE)
 public @interface GradualRetry {

diff --git a/...mework/src/test/java/io/javaoperatorsdk/operator/config/BaseConfigurationServiceTest.java b/...mework/src/test/java/io/javaoperatorsdk/operator/config/BaseConfigurationServiceTest.java
@@ -190,6 +190,24 @@ void configuringRateAndRetryViaAnnotationsShouldWork() {
     assertEquals(Duration.ofSeconds(3), rateLimiter.getRefreshPeriod());
   }
 
+  @Test
+  void configuringRateLimitAndGradualRetryViaSuperClassShouldWork() {
+    var config = configFor(new GradualRetryAndRateLimitedOnSuperClass());
+    final var retry = config.getRetry();
+    final var testRetry = assertInstanceOf(GenericRetry.class, retry);
+    assertEquals(
+        BaseClassWithGradualRetryAndRateLimited.RETRY_MAX_ATTEMPTS,
+        testRetry.getMaxAttempts());
+
+    final var rateLimiter = assertInstanceOf(LinearRateLimiter.class, config.getRateLimiter());
+    assertEquals(
+        BaseClassWithGradualRetryAndRateLimited.RATE_LIMITED_MAX_RECONCILIATIONS,
+        rateLimiter.getLimitForPeriod());
+    assertEquals(
+        Duration.ofSeconds(BaseClassWithGradualRetryAndRateLimited.RATE_LIMITED_WITHIN_SECONDS),
+        rateLimiter.getRefreshPeriod());
+  }
+
   @Test
   void checkingRetryingGraduallyWorks() {
     var config = configFor(new CheckRetryingGraduallyConfiguration());
@@ -250,6 +268,7 @@ public UpdateControl<ConfigMap> reconcile(ConfigMap resource, Context<ConfigMap>
   @ControllerConfiguration(
       dependents = @Dependent(type = ReadOnlyDependent.class, name = NamedDepReconciler.NAME))
   private static class NamedDepReconciler implements Reconciler<ConfigMap> {
+
     private static final String NAME = "foo";
 
     @Override
@@ -325,6 +344,7 @@ public UpdateControl<ConfigMap> reconcile(ConfigMap resource, Context<ConfigMap>
   }
 
   public static class TestRetry implements Retry, AnnotationConfigurable<TestRetryConfiguration> {
+
     private int value;
 
     public TestRetry() {}
@@ -347,6 +367,7 @@ public void initFrom(TestRetryConfiguration configuration) {
   @Target(ElementType.TYPE)
   @Retention(RetentionPolicy.RUNTIME)
   private @interface TestRetryConfiguration {
+
     int value() default 42;
   }
 
@@ -382,7 +403,30 @@ public UpdateControl<ConfigMap> reconcile(ConfigMap resource, Context<ConfigMap>
     }
   }
 
+  @ControllerConfiguration
+  private static class GradualRetryAndRateLimitedOnSuperClass
+      extends BaseClassWithGradualRetryAndRateLimited
+      implements Reconciler<ConfigMap> {
+
+    @Override
+    public UpdateControl<ConfigMap> reconcile(ConfigMap resource, Context<ConfigMap> context) {
+      return null;
+    }
+  }
+
+  @RateLimited(
+      maxReconciliations = BaseClassWithGradualRetryAndRateLimited.RATE_LIMITED_MAX_RECONCILIATIONS,
+      within = BaseClassWithGradualRetryAndRateLimited.RATE_LIMITED_WITHIN_SECONDS)
+  @GradualRetry(maxAttempts = BaseClassWithGradualRetryAndRateLimited.RETRY_MAX_ATTEMPTS)
+  private static class BaseClassWithGradualRetryAndRateLimited {
+
+    public static final int RATE_LIMITED_MAX_RECONCILIATIONS = 7;
+    public static final int RATE_LIMITED_WITHIN_SECONDS = 3;
+    public static final int RETRY_MAX_ATTEMPTS = 3;
+  }
+
   private static class ControllerConfigurationOnSuperClass extends BaseClass {
+
   }
 
   @ControllerConfiguration
@@ -443,10 +487,12 @@ private static class ChildCustomAnnotatedDep extends CustomAnnotatedDep {
 
   @Retention(RetentionPolicy.RUNTIME)
   private @interface CustomAnnotation {
+
     int value();
   }
 
   private static class CustomConfig {
+
     private final int value;
 
     private CustomConfig(int value) {
@@ -460,6 +506,7 @@ public int getValue() {
 
   private static class CustomConfigConverter
       implements ConfigurationConverter<CustomAnnotation, CustomConfig, CustomAnnotatedDep> {
+
     static final int CONVERTER_PROVIDED_DEFAULT = 7;
 
     @Override