feat: do not output kube version label in selector

Fixes #823

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

Author: metacosm

bundle-generator/deployment/src/main/java/io/quarkiverse/operatorsdk/bundle/deployment/KubernetesLabelConfigOverrider.java

@@ -0,0 +1,21 @@
+package io.quarkiverse.operatorsdk.bundle.deployment;
+
+import java.util.Map;
+
+import io.smallrye.config.PropertiesConfigSource;
+import io.smallrye.config.SmallRyeConfigBuilder;
+import io.smallrye.config.SmallRyeConfigBuilderCustomizer;
+
+/**
+ * Overrides the default value for the Kubernetes extension-provided {@code add-version-to-label-selectors} when the bundle
+ * generator is used. See <a href="https://github.com/quarkiverse/quarkus-operator-sdk/issues/823">this issue</a> for more
+ * details.
+ */
+public class KubernetesLabelConfigOverrider implements SmallRyeConfigBuilderCustomizer {
+    @Override
+    public void configBuilder(SmallRyeConfigBuilder builder) {
+        // not sure what value for the priority should be used since they seem pretty random
+        builder.withSources(new PropertiesConfigSource(Map.of("quarkus.kubernetes.add-version-to-label-selectors", "false"),
+                "KubernetesLabelConfigOverrider", 50));
+    }
+}

bundle-generator/deployment/src/main/resources/META-INF/services/io.smallrye.config.SmallRyeConfigBuilderCustomizer

@@ -0,0 +1 @@
+io.quarkiverse.operatorsdk.bundle.deployment.KubernetesLabelConfigOverrider

bundle-generator/deployment/src/test/java/io/quarkiverse/operatorsdk/bundle/DefaultBundleWhenNoCsvMetadataTest.java

@@ -1,10 +1,12 @@
 package io.quarkiverse.operatorsdk.bundle;
 
 import static io.quarkiverse.operatorsdk.bundle.Utils.BUNDLE;
+import static io.quarkiverse.operatorsdk.bundle.Utils.getCSVFor;
+import static org.junit.jupiter.api.Assertions.*;
 
+import java.io.IOException;
 import java.nio.file.Files;
 
-import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.RegisterExtension;
 
@@ -26,9 +28,15 @@ public class DefaultBundleWhenNoCsvMetadataTest {
     private ProdModeTestResults prodModeTestResults;
 
     @Test
-    public void shouldWriteBundleEvenWhenCsvMetadataIsNotUsed() {
-        Assertions.assertTrue(
-                Files.exists(prodModeTestResults.getBuildDir().resolve(BUNDLE).resolve("reconciler-with-no-csv-metadata")));
+    public void shouldWriteBundleEvenWhenCsvMetadataIsNotUsed() throws IOException {
+        final var name = "reconciler-with-no-csv-metadata";
+        final var bundle = prodModeTestResults.getBuildDir().resolve(BUNDLE);
+        assertTrue(Files.exists(bundle.resolve(name)));
+        final var csv = getCSVFor(bundle, name);
+        final var deployment = csv.getSpec().getInstall().getSpec().getDeployments().get(0);
+        assertEquals(name, deployment.getName());
+        // by default, we shouldn't output the version label in the selector match labels as the default controlling this should be overridden by KubernetesLabelConfigOverrider
+        assertNull(deployment.getSpec().getSelector().getMatchLabels().get("app.kubernetes.io/version"));
     }
 
 }

bundle-generator/deployment/src/test/java/io/quarkiverse/operatorsdk/bundle/MultipleOperatorsBundleTest.java

@@ -47,7 +47,7 @@ public void shouldWriteBundleForTheOperators() throws IOException {
         var csv = getCSVFor(bundle, "first-operator");
         assertEquals(FirstReconciler.VERSION, csv.getSpec().getVersion());
         assertEquals(FirstReconciler.REPLACES, csv.getSpec().getReplaces());
-        var bundleMeta = getAnnotationFor(bundle, "first-operator");
+        var bundleMeta = getAnnotationsFor(bundle, "first-operator");
         assertEquals(BUNDLE_PACKAGE, bundleMeta.getAnnotations().get("operators.operatorframework.io.bundle.package.v1"));
 
         checkBundleFor(bundle, "second-operator", Second.class);

bundle-generator/deployment/src/test/java/io/quarkiverse/operatorsdk/bundle/OutputLabelSelectorsIfRequestedTest.java

@@ -0,0 +1,38 @@
+package io.quarkiverse.operatorsdk.bundle;
+
+import static io.quarkiverse.operatorsdk.bundle.Utils.BUNDLE;
+import static io.quarkiverse.operatorsdk.bundle.Utils.getCSVFor;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+
+import java.io.IOException;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import io.quarkiverse.operatorsdk.bundle.sources.First;
+import io.quarkiverse.operatorsdk.bundle.sources.ReconcilerWithNoCsvMetadata;
+import io.quarkus.test.ProdBuildResults;
+import io.quarkus.test.ProdModeTestResults;
+import io.quarkus.test.QuarkusProdModeTest;
+
+public class OutputLabelSelectorsIfRequestedTest {
+    @RegisterExtension
+    static final QuarkusProdModeTest config = new QuarkusProdModeTest()
+            .setApplicationName("output-kube-labels")
+            .overrideConfigKey("quarkus.kubernetes.add-version-to-label-selectors", "true")
+            .withApplicationRoot((jar) -> jar
+                    .addClasses(First.class, ReconcilerWithNoCsvMetadata.class));
+
+    @ProdBuildResults
+    private ProdModeTestResults prodModeTestResults;
+
+    @Test
+    public void shouldHaveVersionLabelWhenRequested() throws IOException {
+        final var name = "output-kube-labels";
+        final var csv = getCSVFor(prodModeTestResults.getBuildDir().resolve(BUNDLE), name);
+        final var deployment = csv.getSpec().getInstall().getSpec().getDeployments().get(0);
+        assertEquals(name, deployment.getName());
+        assertNotNull(deployment.getSpec().getSelector().getMatchLabels().get("app.kubernetes.io/version"));
+    }
+}

bundle-generator/deployment/src/test/java/io/quarkiverse/operatorsdk/bundle/Utils.java

@@ -41,7 +41,7 @@ static ClusterServiceVersion getCSVFor(Path bundle, String operatorName) throws
         return Serialization.unmarshal(csvAsString, ClusterServiceVersion.class);
     }
 
-    static ObjectMeta getAnnotationFor(Path bundle, String operatorName) throws IOException {
+    static ObjectMeta getAnnotationsFor(Path bundle, String operatorName) throws IOException {
         final var annotationPath = bundle.resolve(operatorName).resolve("metadata").resolve("annotations.yaml");
         final var annotationsaAsString = Files.readString(annotationPath);
         return Serialization.unmarshal(annotationsaAsString, ObjectMeta.class);