refactor: extract constants from ControllerConfiguration

metacosm · metacosm · commit 1809d354a2c9 · 2021-12-13T11:09:54.000+01:00
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/ReconcilerUtils.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/ReconcilerUtils.java
@@ -2,6 +2,7 @@
 
 import java.util.Locale;
 
+import io.javaoperatorsdk.operator.api.reconciler.Constants;
 import io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration;
 import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
 
@@ -19,7 +20,7 @@ public static String getNameFor(Class<? extends Reconciler> reconcilerClass) {
     final var annotation = reconcilerClass.getAnnotation(ControllerConfiguration.class);
     if (annotation != null) {
       final var name = annotation.name();
-      if (!ControllerConfiguration.EMPTY_STRING.equals(name)) {
+      if (!Constants.EMPTY_STRING.equals(name)) {
         return name;
       }
     }
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ControllerConfiguration.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ControllerConfiguration.java
@@ -5,6 +5,7 @@
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.javaoperatorsdk.operator.ReconcilerUtils;
+import io.javaoperatorsdk.operator.api.reconciler.Constants;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResource;
 import io.javaoperatorsdk.operator.processing.event.source.ResourceEventFilter;
 
@@ -30,8 +31,7 @@ default RetryConfiguration getRetryConfiguration() {
   }
 
   default boolean useFinalizer() {
-    return !io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration.NO_FINALIZER
-        .equals(getFinalizer());
+    return !Constants.NO_FINALIZER.equals(getFinalizer());
   }
 
   @Override
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ResourceConfiguration.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ResourceConfiguration.java
@@ -5,6 +5,7 @@
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.fabric8.kubernetes.client.CustomResource;
+import io.javaoperatorsdk.operator.api.reconciler.Constants;
 import io.javaoperatorsdk.operator.processing.event.source.ResourceEventFilter;
 import io.javaoperatorsdk.operator.processing.event.source.ResourceEventFilters;
 
@@ -50,8 +51,7 @@ default boolean watchCurrentNamespace() {
   static boolean currentNamespaceWatched(Set<String> namespaces) {
     return namespaces != null
         && namespaces.size() == 1
-        && namespaces.contains(
-            io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration.WATCH_CURRENT_NAMESPACE);
+        && namespaces.contains(Constants.WATCH_CURRENT_NAMESPACE);
   }
 
   /**
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/dependent/DefaultDependentResourceConfiguration.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/dependent/DefaultDependentResourceConfiguration.java
@@ -1,11 +1,11 @@
 package io.javaoperatorsdk.operator.api.config.dependent;
 
-import io.javaoperatorsdk.operator.api.config.ConfigurationService;
-import io.javaoperatorsdk.operator.api.config.DefaultResourceConfiguration;
 import java.util.Set;
 import java.util.function.Function;
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
+import io.javaoperatorsdk.operator.api.config.ConfigurationService;
+import io.javaoperatorsdk.operator.api.config.DefaultResourceConfiguration;
 import io.javaoperatorsdk.operator.processing.event.ResourceID;
 
 public class DefaultDependentResourceConfiguration<R extends HasMetadata>
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/dependent/DependentResourceConfiguration.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/dependent/DependentResourceConfiguration.java
@@ -1,10 +1,10 @@
 package io.javaoperatorsdk.operator.api.config.dependent;
 
-import io.javaoperatorsdk.operator.api.config.ResourceConfiguration;
 import java.util.Set;
 import java.util.function.Function;
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
+import io.javaoperatorsdk.operator.api.config.ResourceConfiguration;
 import io.javaoperatorsdk.operator.processing.event.ResourceID;
 import io.javaoperatorsdk.operator.processing.event.source.Mappers;
 
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/Constants.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/Constants.java
@@ -0,0 +1,10 @@
+package io.javaoperatorsdk.operator.api.reconciler;
+
+public final class Constants {
+
+  public static final String EMPTY_STRING = "";
+  public static final String WATCH_CURRENT_NAMESPACE = "JOSDK_WATCH_CURRENT";
+  public static final String NO_FINALIZER = "JOSDK_NO_FINALIZER";
+
+  private Constants() {}
+}
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/ControllerConfiguration.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/ControllerConfiguration.java
@@ -1,32 +1,28 @@
 package io.javaoperatorsdk.operator.api.reconciler;
 
-import io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResource;
-import io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResourceConfiguration;
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+import io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResource;
+import io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResourceConfiguration;
 import io.javaoperatorsdk.operator.processing.event.source.ResourceEventFilter;
 
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.TYPE})
 public @interface ControllerConfiguration {
 
-  String EMPTY_STRING = "";
-  String WATCH_CURRENT_NAMESPACE = "JOSDK_WATCH_CURRENT";
-  String NO_FINALIZER = "JOSDK_NO_FINALIZER";
-
-  String name() default EMPTY_STRING;
+  String name() default Constants.EMPTY_STRING;
 
   /**
    * Optional finalizer name, if it is not provided, one will be automatically generated. If the
-   * provided value is the value specified by {@link #NO_FINALIZER}, then no finalizer will be added
-   * to custom resources.
+   * provided value is the value specified by {@link Constants#NO_FINALIZER}, then no finalizer will
+   * be added to custom resources.
    *
    * @return the finalizer name
    */
-  String finalizerName() default EMPTY_STRING;
+  String finalizerName() default Constants.EMPTY_STRING;
 
   /**
    * If true, will dispatch new event to the controller if generation increased since the last
@@ -52,7 +48,7 @@
    *
    * @return the label selector
    */
-  String labelSelector() default EMPTY_STRING;
+  String labelSelector() default Constants.EMPTY_STRING;
 
 
   /**
diff --git a/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/errorstatushandler/ErrorStatusHandlerTestReconciler.java b/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/errorstatushandler/ErrorStatusHandlerTestReconciler.java
@@ -9,7 +9,7 @@
 import io.javaoperatorsdk.operator.api.reconciler.*;
 import io.javaoperatorsdk.operator.support.TestExecutionInfoProvider;
 
-import static io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration.NO_FINALIZER;
+import static io.javaoperatorsdk.operator.api.reconciler.Constants.NO_FINALIZER;
 
 @ControllerConfiguration(finalizerName = NO_FINALIZER)
 public class ErrorStatusHandlerTestReconciler
diff --git a/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/informereventsource/InformerEventSourceTestCustomReconciler.java b/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/informereventsource/InformerEventSourceTestCustomReconciler.java
@@ -16,7 +16,7 @@
 import io.javaoperatorsdk.operator.processing.event.source.InformerEventSource;
 import io.javaoperatorsdk.operator.processing.event.source.Mappers;
 
-import static io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration.NO_FINALIZER;
+import static io.javaoperatorsdk.operator.api.reconciler.Constants.NO_FINALIZER;
 
 /**
  * Copies the config map value from spec into status. The main purpose is to test and demonstrate
diff --git a/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/observedgeneration/ObservedGenerationTestReconciler.java b/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/observedgeneration/ObservedGenerationTestReconciler.java
@@ -5,7 +5,7 @@
 
 import io.javaoperatorsdk.operator.api.reconciler.*;
 
-import static io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration.NO_FINALIZER;
+import static io.javaoperatorsdk.operator.api.reconciler.Constants.NO_FINALIZER;
 
 @ControllerConfiguration(finalizerName = NO_FINALIZER)
 public class ObservedGenerationTestReconciler

Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`
`3`	`3`	`import java.util.Locale;`
`4`	`4`
	`5`	`+import io.javaoperatorsdk.operator.api.reconciler.Constants;`
`5`	`6`	`import io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration;`
`6`	`7`	`import io.javaoperatorsdk.operator.api.reconciler.Reconciler;`
`7`	`8`
`@@ -19,7 +20,7 @@ public static String getNameFor(Class<? extends Reconciler> reconcilerClass) {`
`19`	`20`	`final var annotation = reconcilerClass.getAnnotation(ControllerConfiguration.class);`
`20`	`21`	`if (annotation != null) {`
`21`	`22`	`final var name = annotation.name();`
`22`		`- if (!ControllerConfiguration.EMPTY_STRING.equals(name)) {`
	`23`	`+ if (!Constants.EMPTY_STRING.equals(name)) {`
`23`	`24`	`return name;`
`24`	`25`	`}`
`25`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`
`6`	`6`	`import io.fabric8.kubernetes.api.model.HasMetadata;`
`7`	`7`	`import io.javaoperatorsdk.operator.ReconcilerUtils;`
	`8`	`+import io.javaoperatorsdk.operator.api.reconciler.Constants;`
`8`	`9`	`import io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResource;`
`9`	`10`	`import io.javaoperatorsdk.operator.processing.event.source.ResourceEventFilter;`
`10`	`11`
`@@ -30,8 +31,7 @@ default RetryConfiguration getRetryConfiguration() {`
`30`	`31`	`}`
`31`	`32`
`32`	`33`	`default boolean useFinalizer() {`
`33`		`- return !io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration.NO_FINALIZER`
`34`		`- .equals(getFinalizer());`
	`34`	`+ return !Constants.NO_FINALIZER.equals(getFinalizer());`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`@Override`