From 1a89a3e75f84374d2104dbf3b97dd81ef40128ae Mon Sep 17 00:00:00 2001 From: Chris Laprun Date: Mon, 8 Mar 2021 11:01:38 +0100 Subject: [PATCH] refactor: validateCustomResources -> checkCRDAndValidateLocalModel --- .../java/io/javaoperatorsdk/operator/Operator.java | 2 +- .../operator/api/config/ConfigurationService.java | 2 +- .../io/javaoperatorsdk/operator/api/config/Utils.java | 8 ++++---- .../deployment/QuarkusExtensionProcessor.java | 4 ++-- .../quarkus/extension/ExternalConfiguration.java | 7 ++++--- .../quarkus/extension/QuarkusConfigurationService.java | 10 +++++----- .../io/javaoperatorsdk/quarkus/it/TestOperatorApp.java | 2 +- .../tests/src/main/resources/application.properties | 2 +- .../config/runtime/DefaultConfigurationService.java | 4 ++-- 9 files changed, 21 insertions(+), 20 deletions(-) diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/Operator.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/Operator.java index 77b6ba8c09..62d57e0b1f 100644 --- a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/Operator.java +++ b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/Operator.java @@ -101,7 +101,7 @@ public void register( // check that the custom resource is known by the cluster if configured that way final CustomResourceDefinition crd; - if (configurationService.validateCustomResources()) { + if (configurationService.checkCRDAndValidateLocalModel()) { final var crdName = configuration.getCRDName(); crd = k8sClient.apiextensions().v1().customResourceDefinitions().withName(crdName).get(); if (crd == null) { diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationService.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationService.java index 7c3bc5bd7c..1fc5ec610d 100644 --- a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationService.java +++ b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationService.java @@ -52,7 +52,7 @@ default Config getClientConfiguration() { * * @return {@code true} if CRDs should be checked (default), {@code false} otherwise */ - default boolean validateCustomResources() { + default boolean checkCRDAndValidateLocalModel() { return true; } } diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/Utils.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/Utils.java index ebd9e94d51..d47837593b 100644 --- a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/Utils.java +++ b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/Utils.java @@ -12,7 +12,7 @@ public class Utils { private static final Logger log = LoggerFactory.getLogger(Utils.class); - public static final String VALIDATE_CR_ENV_KEY = "JAVA_OPERATOR_SDK_VALIDATE_CR"; + public static final String CHECK_CRD_ENV_KEY = "JAVA_OPERATOR_SDK_CHECK_CRD"; /** * Attempts to load version information from a properties file produced at build time, currently @@ -51,11 +51,11 @@ public static Version loadFromProperties() { } public static boolean isValidateCustomResourcesEnvVarSet() { - return System.getProperty(VALIDATE_CR_ENV_KEY) != null; + return System.getProperty(CHECK_CRD_ENV_KEY) != null; } - public static boolean shouldValidateCustomResources() { - final var value = System.getProperty(VALIDATE_CR_ENV_KEY); + public static boolean shouldCheckCRDAndValidateLocalModel() { + final var value = System.getProperty(CHECK_CRD_ENV_KEY); return value == null || Boolean.getBoolean(value); } } diff --git a/operator-framework-quarkus-extension/deployment/src/main/java/io/javaoperatorsdk/quarkus/extension/deployment/QuarkusExtensionProcessor.java b/operator-framework-quarkus-extension/deployment/src/main/java/io/javaoperatorsdk/quarkus/extension/deployment/QuarkusExtensionProcessor.java index be545e5904..db4a84f96b 100644 --- a/operator-framework-quarkus-extension/deployment/src/main/java/io/javaoperatorsdk/quarkus/extension/deployment/QuarkusExtensionProcessor.java +++ b/operator-framework-quarkus-extension/deployment/src/main/java/io/javaoperatorsdk/quarkus/extension/deployment/QuarkusExtensionProcessor.java @@ -83,8 +83,8 @@ void createConfigurationServiceAndOperator( final var version = Utils.loadFromProperties(); final var validateCustomResources = Utils.isValidateCustomResourcesEnvVarSet() - ? Utils.shouldValidateCustomResources() - : externalConfiguration.validateCustomResources.orElse(true); + ? Utils.shouldCheckCRDAndValidateLocalModel() + : externalConfiguration.checkCRDAndValidateLocalModel.orElse(true); final var supplier = recorder.configurationServiceSupplier( diff --git a/operator-framework-quarkus-extension/runtime/src/main/java/io/javaoperatorsdk/quarkus/extension/ExternalConfiguration.java b/operator-framework-quarkus-extension/runtime/src/main/java/io/javaoperatorsdk/quarkus/extension/ExternalConfiguration.java index cdd73213a9..0134cae1da 100644 --- a/operator-framework-quarkus-extension/runtime/src/main/java/io/javaoperatorsdk/quarkus/extension/ExternalConfiguration.java +++ b/operator-framework-quarkus-extension/runtime/src/main/java/io/javaoperatorsdk/quarkus/extension/ExternalConfiguration.java @@ -14,9 +14,10 @@ public class ExternalConfiguration { @ConfigItem public Map controllers; /** - * Whether the operator should validate the {@link CustomResource} implementation before - * registering the associated controller. + * Whether the operator should check that the CRD is properly deployed and that the associated + * {@link CustomResource} implementation matches its information before registering the associated + * controller. */ @ConfigItem(defaultValue = "true") - public Optional validateCustomResources; + public Optional checkCRDAndValidateLocalModel; } diff --git a/operator-framework-quarkus-extension/runtime/src/main/java/io/javaoperatorsdk/quarkus/extension/QuarkusConfigurationService.java b/operator-framework-quarkus-extension/runtime/src/main/java/io/javaoperatorsdk/quarkus/extension/QuarkusConfigurationService.java index 940e7a31e4..a38f354c1e 100644 --- a/operator-framework-quarkus-extension/runtime/src/main/java/io/javaoperatorsdk/quarkus/extension/QuarkusConfigurationService.java +++ b/operator-framework-quarkus-extension/runtime/src/main/java/io/javaoperatorsdk/quarkus/extension/QuarkusConfigurationService.java @@ -13,19 +13,19 @@ public class QuarkusConfigurationService extends AbstractConfigurationService { private static final ClientProxyUnwrapper unwrapper = new ClientProxyUnwrapper(); private final KubernetesClient client; - private final boolean validateCustomResources; + private final boolean checkCRDAndValidateLocalModel; public QuarkusConfigurationService( Version version, List configurations, KubernetesClient client, - boolean validateCustomResources) { + boolean checkCRDAndValidateLocalModel) { super(version); this.client = client; if (configurations != null && !configurations.isEmpty()) { configurations.forEach(this::register); } - this.validateCustomResources = validateCustomResources; + this.checkCRDAndValidateLocalModel = checkCRDAndValidateLocalModel; } @Override @@ -41,8 +41,8 @@ public ControllerConfiguration getConfigurationFor } @Override - public boolean validateCustomResources() { - return validateCustomResources; + public boolean checkCRDAndValidateLocalModel() { + return checkCRDAndValidateLocalModel; } private static ResourceController unwrap( diff --git a/operator-framework-quarkus-extension/tests/src/main/java/io/javaoperatorsdk/quarkus/it/TestOperatorApp.java b/operator-framework-quarkus-extension/tests/src/main/java/io/javaoperatorsdk/quarkus/it/TestOperatorApp.java index 591549f6c2..555cb7430b 100644 --- a/operator-framework-quarkus-extension/tests/src/main/java/io/javaoperatorsdk/quarkus/it/TestOperatorApp.java +++ b/operator-framework-quarkus-extension/tests/src/main/java/io/javaoperatorsdk/quarkus/it/TestOperatorApp.java @@ -21,7 +21,7 @@ public class TestOperatorApp { @GET @Path("validateCR") public boolean validateCR() { - return configurationService.validateCustomResources(); + return configurationService.checkCRDAndValidateLocalModel(); } @GET diff --git a/operator-framework-quarkus-extension/tests/src/main/resources/application.properties b/operator-framework-quarkus-extension/tests/src/main/resources/application.properties index c0a57c523d..3ae3e71e08 100644 --- a/operator-framework-quarkus-extension/tests/src/main/resources/application.properties +++ b/operator-framework-quarkus-extension/tests/src/main/resources/application.properties @@ -1,3 +1,3 @@ quarkus.operator-sdk.controllers.annotation.finalizer=from-property/finalizer quarkus.operator-sdk.controllers.annotation.namespaces=bar -quarkus.operator-sdk.validate-custom-resources=false \ No newline at end of file +quarkus.operator-sdk.check-crd-and-validate-local-model=false \ No newline at end of file diff --git a/operator-framework/src/main/java/io/javaoperatorsdk/operator/config/runtime/DefaultConfigurationService.java b/operator-framework/src/main/java/io/javaoperatorsdk/operator/config/runtime/DefaultConfigurationService.java index 2bc0d1e2e7..3a7664378f 100644 --- a/operator-framework/src/main/java/io/javaoperatorsdk/operator/config/runtime/DefaultConfigurationService.java +++ b/operator-framework/src/main/java/io/javaoperatorsdk/operator/config/runtime/DefaultConfigurationService.java @@ -38,7 +38,7 @@ public ControllerConfiguration getConfigurationFor } @Override - public boolean validateCustomResources() { - return Utils.shouldValidateCustomResources(); + public boolean checkCRDAndValidateLocalModel() { + return Utils.shouldCheckCRDAndValidateLocalModel(); } }