feat: use ConfigMapping (#918)

Signed-off-by: Chris Laprun <[email protected]>

Author: metacosm

core/deployment/src/main/java/io/quarkiverse/operatorsdk/deployment/AddRoleBindingsDecorator.java

@@ -64,7 +64,7 @@ private List<HasMetadata> bindingsFor(QuarkusControllerConfiguration<?> controll
 
         // if we validate the CRDs, also create a binding for the CRD validating role
         List<HasMetadata> itemsToAdd;
-        if (operatorConfiguration.crd.validate) {
+        if (operatorConfiguration.crd().validate()) {
             final var crBindingName = getCRDValidatingBindingName(controllerName);
             final var crdValidatorRoleBinding = createClusterRoleBinding(serviceAccountName, controllerName,
                     crBindingName, "validate CRDs", CRD_VALIDATING_ROLE_REF);

core/deployment/src/main/java/io/quarkiverse/operatorsdk/deployment/BuildTimeHybridControllerConfiguration.java

@@ -29,24 +29,25 @@ public BuildTimeHybridControllerConfiguration(
     boolean generationAware() {
         return ConfigurationUtils.extract(
                 externalConfiguration,
-                controllerAnnotation, c -> c.generationAware,
+                controllerAnnotation, BuildTimeControllerConfiguration::generationAware,
                 "generationAwareEventProcessing",
                 AnnotationValue::asBoolean,
-                () -> operatorConfiguration.generationAware.orElse(true));
+                () -> operatorConfiguration.generationAware().orElse(true));
     }
 
     Set<String> generateWithWatchedNamespaces(boolean wereNamespacesSet) {
         Set<String> namespaces = null;
         if (externalConfiguration != null) {
-            Optional<List<String>> overrideNamespaces = externalConfiguration.generateWithWatchedNamespaces;
+            Optional<List<String>> overrideNamespaces = externalConfiguration.generateWithWatchedNamespaces();
             if (overrideNamespaces.isPresent()) {
                 namespaces = new HashSet<>(overrideNamespaces.get());
             }
         }
 
         // check if we have an operator-level configuration only if namespaces haven't been explicitly set already
-        if (!wereNamespacesSet && namespaces == null && operatorConfiguration.generateWithWatchedNamespaces.isPresent()) {
-            namespaces = new HashSet<>(operatorConfiguration.generateWithWatchedNamespaces.get());
+        final var watchedNamespaces = operatorConfiguration.generateWithWatchedNamespaces();
+        if (!wereNamespacesSet && namespaces == null && watchedNamespaces.isPresent()) {
+            namespaces = new HashSet<>(watchedNamespaces.get());
         }
 
         return namespaces;

core/deployment/src/main/java/io/quarkiverse/operatorsdk/deployment/CRDGeneration.java

@@ -49,7 +49,7 @@ static boolean shouldApply(Optional<Boolean> configuredApply, LaunchMode launchM
     }
 
     boolean shouldApply() {
-        return shouldApply(crdConfiguration.apply, mode);
+        return shouldApply(crdConfiguration.apply(), mode);
     }
 
     /**
@@ -73,14 +73,14 @@ CRDGenerationInfo generate(OutputTargetBuildItem outputTarget,
         final var generated = new HashSet<String>();
 
         if (needGeneration) {
-            Path targetDirectory = crdConfiguration.outputDirectory
+            Path targetDirectory = crdConfiguration.outputDirectory()
                     .map(d -> Paths.get("").toAbsolutePath().resolve(d))
                     .orElse(outputTarget.getOutputDirectory().resolve(KUBERNETES));
             final var outputDir = targetDirectory.toFile();
             FileUtils.ensureDirectoryExists(outputDir);
 
             // generate CRDs with detailed information
-            final var info = generator.forCRDVersions(crdConfiguration.versions).inOutputDir(outputDir).detailedGenerate();
+            final var info = generator.forCRDVersions(crdConfiguration.versions()).inOutputDir(outputDir).detailedGenerate();
             final var crdDetailsPerNameAndVersion = info.getCRDDetailsPerNameAndVersion();
 
             crdDetailsPerNameAndVersion.forEach((crdName, initialVersionToCRDInfoMap) -> {
@@ -103,7 +103,7 @@ CRDGenerationInfo generate(OutputTargetBuildItem outputTarget,
 
     private boolean needsGeneration(Map<String, CRDInfo> existingCRDInfos, Set<String> changedClassNames, String targetCRName) {
         final boolean[] generateCurrent = { true }; // request CRD generation by default
-        crdConfiguration.versions.forEach(v -> {
+        crdConfiguration.versions().forEach(v -> {
             final var crd = existingCRDInfos.get(v);
             // if we don't have any information about this CRD version, we need to generate the CRD
             if (crd == null) {
@@ -147,7 +147,7 @@ boolean scheduleForGenerationIfNeeded(CustomResourceAugmentedClassInfo crInfo,
     public void withCustomResource(Class<? extends CustomResource<?, ?>> crClass, String crdName,
             String associatedControllerName) {
         // first check if the CR is not filtered out
-        if (crdConfiguration.excludeResources.map(excluded -> excluded.contains(crClass.getName())).orElse(false)) {
+        if (crdConfiguration.excludeResources().map(excluded -> excluded.contains(crClass.getName())).orElse(false)) {
             log.infov("CRD generation was skipped for ''{0}'' because it was excluded from generation", crClass.getName());
             return;
         }
@@ -156,7 +156,7 @@ public void withCustomResource(Class<? extends CustomResource<?, ?>> crClass, St
             // generator MUST be initialized before we start processing classes as initializing it
             // will reset the types information held by the generator
             if (generator == null) {
-                generator = new CRDGenerator().withParallelGenerationEnabled(crdConfiguration.generateInParallel);
+                generator = new CRDGenerator().withParallelGenerationEnabled(crdConfiguration.generateInParallel());
             }
             final var info = CustomResourceInfo.fromClass(crClass);
             crMappings.add(info, crdName, associatedControllerName);

core/deployment/src/main/java/io/quarkiverse/operatorsdk/deployment/CRDGenerationBuildStep.java

@@ -28,8 +28,8 @@ GeneratedCRDInfoBuildItem generateCRDs(
             LiveReloadBuildItem liveReload,
             OutputTargetBuildItem outputTarget,
             CombinedIndexBuildItem combinedIndexBuildItem) {
-        final var crdConfig = operatorConfiguration.crd;
-        final boolean validateCustomResources = ConfigurationUtils.shouldValidateCustomResources(crdConfig.validate);
+        final var crdConfig = operatorConfiguration.crd();
+        final boolean validateCustomResources = ConfigurationUtils.shouldValidateCustomResources(crdConfig.validate());
 
         //apply should imply generate: we cannot apply if we're not generating!
         final var launchMode = launchModeBuildItem.getLaunchMode();
@@ -41,7 +41,7 @@ GeneratedCRDInfoBuildItem generateCRDs(
             stored = new ContextStoredCRDInfos();
         }
 
-        final var generate = CRDGeneration.shouldGenerate(crdConfig.generate, crdConfig.apply, launchMode);
+        final var generate = CRDGeneration.shouldGenerate(crdConfig.generate(), crdConfig.apply(), launchMode);
         final var storedCRDInfos = stored;
         final var changedClasses = ConfigurationUtils.getChangedClasses(liveReload);
         final var scheduledForGeneration = new HashSet<String>(7);
@@ -74,7 +74,7 @@ GeneratedCRDInfoBuildItem generateCRDs(
             });
 
             // generate non-reconciler associated CRDs if requested
-            if (crdConfig.generateAll) {
+            if (crdConfig.generateAll()) {
                 ClassUtils.getProcessableSubClassesOf(Constants.CUSTOM_RESOURCE, combinedIndexBuildItem.getIndex(), log,
                         // pass already generated CRD names so that we can only keep the unhandled ones
                         Map.of(CustomResourceAugmentedClassInfo.EXISTING_CRDS_KEY, scheduledForGeneration))

core/deployment/src/main/java/io/quarkiverse/operatorsdk/deployment/QuarkusControllerConfigurationBuildStep.java

@@ -149,7 +149,7 @@ static QuarkusControllerConfiguration createConfiguration(
         // extract the configuration from annotation and/or external configuration
         final var controllerAnnotation = info.declaredAnnotation(CONTROLLER_CONFIGURATION);
 
-        final var externalConfiguration = buildTimeConfiguration.controllers.get(name);
+        final var externalConfiguration = buildTimeConfiguration.controllers().get(name);
         final var configExtractor = new BuildTimeHybridControllerConfiguration(buildTimeConfiguration,
                 externalConfiguration,
                 controllerAnnotation);

core/deployment/src/main/java/io/quarkiverse/operatorsdk/deployment/RBACAugmentationStep.java

@@ -15,7 +15,7 @@ private static class IsRBACEnabled implements BooleanSupplier {
 
         @Override
         public boolean getAsBoolean() {
-            return !config.disableRbacGeneration;
+            return !config.disableRbacGeneration();
         }
     }
 
@@ -26,7 +26,7 @@ void augmentRBACForResources(BuildTimeOperatorConfiguration buildTimeConfigurati
 
         final var configs = configurations.getControllerConfigs().values();
         decorators.produce(new DecoratorBuildItem(
-                new AddClusterRolesDecorator(configs, buildTimeConfiguration.crd.validate)));
+                new AddClusterRolesDecorator(configs, buildTimeConfiguration.crd().validate())));
         decorators.produce(new DecoratorBuildItem(
                 new AddRoleBindingsDecorator(configs, buildTimeConfiguration)));
     }

core/deployment/src/main/java/io/quarkiverse/operatorsdk/deployment/VersionAlignmentCheckingStep.java

@@ -50,7 +50,7 @@ private void checkVersionCompatibility(BuildTimeOperatorConfiguration buildTimeC
         if (!expectedVersion.equals(foundVersion)) {
             String message = "Mismatched " + name + " version found: \"" + found + "\", expected: \"" + expected
                     + "\"";
-            if (buildTimeConfiguration.failOnVersionCheck) {
+            if (buildTimeConfiguration.failOnVersionCheck()) {
                 throw new RuntimeException(message);
             } else {
                 final var diff = expectedVersion.diff(foundVersion);

core/deployment/src/main/java/io/quarkiverse/operatorsdk/deployment/helm/HelmGenerationEnabled.java

@@ -9,6 +9,6 @@ class HelmGenerationEnabled implements BooleanSupplier {
 
     @Override
     public boolean getAsBoolean() {
-        return config.helm.enabled;
+        return config.helm().enabled();
     }
 }

core/runtime/src/main/java/io/quarkiverse/operatorsdk/runtime/BuildTimeControllerConfiguration.java

@@ -4,17 +4,16 @@
 import java.util.Optional;
 
 import io.quarkus.runtime.annotations.ConfigGroup;
-import io.quarkus.runtime.annotations.ConfigItem;
+import io.smallrye.config.WithDefault;
 
 @ConfigGroup
-public class BuildTimeControllerConfiguration {
+public interface BuildTimeControllerConfiguration {
 
     /**
      * Whether the controller should only process events if the associated resource generation has
      * increased since last reconciliation, otherwise will process all events.
      */
-    @ConfigItem
-    public Optional<Boolean> generationAware;
+    Optional<Boolean> generationAware();
 
     /**
      * An optional list of comma-separated watched namespace names that will be used to generate manifests at build time.
@@ -39,8 +38,7 @@ public class BuildTimeControllerConfiguration {
      * were concerned.
      * </p>
      */
-    @ConfigItem
-    public Optional<List<String>> generateWithWatchedNamespaces;
+    Optional<List<String>> generateWithWatchedNamespaces();
 
     /**
      * Indicates whether the primary resource for the associated controller is unowned, meaning that another controller is the
@@ -49,6 +47,6 @@ public class BuildTimeControllerConfiguration {
      * required even though another controller already handles reconciliations of resources of that type. Set this property to
      * {@code true} if you want to indicate that the controller doesn't own its primary resource
      */
-    @ConfigItem(defaultValue = "false")
-    public boolean unownedPrimary;
+    @WithDefault("false")
+    boolean unownedPrimary();
 }

core/runtime/src/main/java/io/quarkiverse/operatorsdk/runtime/BuildTimeOperatorConfiguration.java

@@ -4,59 +4,60 @@
 import java.util.Map;
 import java.util.Optional;
 
-import io.quarkus.runtime.annotations.ConfigItem;
 import io.quarkus.runtime.annotations.ConfigPhase;
 import io.quarkus.runtime.annotations.ConfigRoot;
+import io.smallrye.config.ConfigMapping;
+import io.smallrye.config.WithDefault;
+import io.smallrye.config.WithName;
 
-@ConfigRoot(name = "operator-sdk", phase = ConfigPhase.BUILD_AND_RUN_TIME_FIXED)
-public class BuildTimeOperatorConfiguration {
+@ConfigMapping(prefix = "quarkus.operator-sdk")
+@ConfigRoot(phase = ConfigPhase.BUILD_AND_RUN_TIME_FIXED)
+public interface BuildTimeOperatorConfiguration {
 
     /**
      * Maps a controller name to its configuration.
      */
-    @ConfigItem
-    public Map<String, BuildTimeControllerConfiguration> controllers;
+    Map<String, BuildTimeControllerConfiguration> controllers();
 
     /**
      * The optional CRD-related configuration options
      */
-    @ConfigItem
-    public CRDConfiguration crd;
+    CRDConfiguration crd();
 
     /**
      * Whether controllers should only process events if the associated resource generation has
      * increased since last reconciliation, otherwise will process all events. Sets the default value
      * for all controllers.
      */
-    @ConfigItem(defaultValue = "true")
-    public Optional<Boolean> generationAware;
+    @WithDefault("true")
+    Optional<Boolean> generationAware();
 
     /**
      * Whether Role-Based Access Control (RBAC) resources generated by the Kubernetes extension should be augmented by this
      * extension.
      */
-    @ConfigItem(defaultValue = "false")
-    public Boolean disableRbacGeneration;
+    @WithDefault("false")
+    Boolean disableRbacGeneration();
 
     /**
      * Whether the operator should be automatically started or not. Mostly useful for testing
      * scenarios.
      */
-    @ConfigItem(defaultValue = "true")
-    public Boolean startOperator;
+    @WithDefault("true")
+    Boolean startOperator();
 
     /**
      * Whether the injected Kubernetes client should be stopped when the operator is stopped.
      */
-    @ConfigItem(defaultValue = "true")
-    public Boolean closeClientOnStop;
+    @WithDefault("true")
+    Boolean closeClientOnStop();
 
     /**
      * Whether the operator should stop if an informer error (such as one caused by missing / improper
      * RBACs) occurs during startup.
      */
-    @ConfigItem(defaultValue = "true")
-    public Boolean stopOnInformerErrorDuringStartup;
+    @WithDefault("true")
+    Boolean stopOnInformerErrorDuringStartup();
 
     /**
      * Whether to fail or emit a debug-level (warning-level when misalignment is at the minor or above version level) log when
@@ -69,38 +70,37 @@ public class BuildTimeOperatorConfiguration {
      * <li>Fabric8 client version used by Quarkus vs. actually used Fabric8 client version</li>
      * </ul>
      */
-    @ConfigItem(defaultValue = "false")
-    public Boolean failOnVersionCheck;
+    @WithDefault("false")
+    Boolean failOnVersionCheck();
 
     /**
      * The list of profile names for which leader election should be activated. This is mostly useful for testing scenarios
      * where leader election behavior might lead to issues.
      */
-    @ConfigItem(defaultValue = "prod")
-    public List<String> activateLeaderElectionForProfiles;
+    @WithDefault("prod")
+    List<String> activateLeaderElectionForProfiles();
 
     /**
      * The optional Server-Side Apply (SSA) related configuration.
      */
-    @ConfigItem(name = "enable-ssa", defaultValue = "true")
-    public boolean enableSSA;
+    @WithName("enable-ssa")
+    @WithDefault("true")
+    boolean enableSSA();
 
     /**
      * An optional list of comma-separated watched namespace names that will be used to generate manifests at build time if
      * controllers do <strong>NOT</strong> specify a value individually. See
      * {@link BuildTimeControllerConfiguration#generateWithWatchedNamespaces} for more information.
      */
-    @ConfigItem
-    public Optional<List<String>> generateWithWatchedNamespaces;
+    Optional<List<String>> generateWithWatchedNamespaces();
 
     /**
      * Helm Chart related configurations.
      */
-    @ConfigItem
-    public HelmConfiguration helm;
+    HelmConfiguration helm();
 
-    public boolean isControllerOwningPrimary(String controllerName) {
-        final var controllerConfiguration = controllers.get(controllerName);
-        return controllerConfiguration == null || !controllerConfiguration.unownedPrimary;
+    default boolean isControllerOwningPrimary(String controllerName) {
+        final var controllerConfiguration = controllers().get(controllerName);
+        return controllerConfiguration == null || !controllerConfiguration.unownedPrimary();
     }
 }