fix: allow to add labels in CSVMetadata

xstefank · metacosm · commit ee19cf38ff42 · 2025-05-20T15:44:47.000+02:00
Fixes #1088 Signed-off-by: xstefank <xstefank122@gmail.com>
diff --git a/annotations/src/main/java/io/quarkiverse/operatorsdk/annotations/CSVMetadata.java b/annotations/src/main/java/io/quarkiverse/operatorsdk/annotations/CSVMetadata.java
@@ -49,6 +49,11 @@
      */
     Annotations annotations() default @Annotations;
 
+    /**
+     * Extra labels that should be added to the CSV metadata.
+     */
+    Label[] labels() default {};
+
     String description() default "";
 
     String displayName() default "";
@@ -101,6 +106,12 @@
         }
     }
 
+    @interface Label {
+        String name();
+
+        String value();
+    }
+
     @interface Icon {
         String DEFAULT_MEDIA_TYPE = "image/svg+xml";
 
diff --git a/bundle-generator/deployment/src/main/java/io/quarkiverse/operatorsdk/bundle/deployment/BundleProcessor.java b/bundle-generator/deployment/src/main/java/io/quarkiverse/operatorsdk/bundle/deployment/BundleProcessor.java
@@ -5,7 +5,6 @@
 import java.io.IOException;
 import java.nio.file.Path;
 import java.util.ArrayList;
-import java.util.Collections;
 import java.util.HashMap;
 import java.util.LinkedList;
 import java.util.List;
@@ -330,15 +329,7 @@ private CSVMetadataHolder createMetadataHolder(AnnotationInstance csvMetadata, C
         if (annotationsField != null) {
             final var annotationsAnn = annotationsField.asNested();
 
-            final var othersAnn = annotationsAnn.value("others");
-            Map<String, String> others = Collections.emptyMap();
-            if (othersAnn != null) {
-                final var othersArray = othersAnn.asNestedArray();
-                others = new HashMap<>(othersArray.length);
-                for (AnnotationInstance other : othersArray) {
-                    others.put(other.value("name").asString(), other.value("value").asString());
-                }
-            }
+            Map<String, String> others = extractNameValueMap(annotationsAnn.value("others"));
             annotations = new CSVMetadataHolder.Annotations(
                     ConfigurationUtils.annotationValueOrDefault(annotationsAnn, "containerImage",
                             AnnotationValue::asString, () -> null),
@@ -362,6 +353,8 @@ private CSVMetadataHolder createMetadataHolder(AnnotationInstance csvMetadata, C
             annotations = CSVMetadataHolder.Annotations.override(annotations, bundleConfig.annotations());
         }
 
+        Map<String, String> labels = extractNameValueMap(csvMetadata.value("labels"));
+
         final var maintainersField = csvMetadata.value("maintainers");
         CSVMetadataHolder.Maintainer[] maintainers;
         if (maintainersField != null) {
@@ -472,7 +465,7 @@ private CSVMetadataHolder createMetadataHolder(AnnotationInstance csvMetadata, C
                         AnnotationValue::asString, () -> mh.description),
                 ConfigurationUtils.annotationValueOrDefault(csvMetadata, "displayName",
                         AnnotationValue::asString, () -> mh.displayName),
-                annotations,
+                annotations, labels,
                 ConfigurationUtils.annotationValueOrDefault(csvMetadata, "keywords",
                         AnnotationValue::asStringArray, () -> mh.keywords),
                 providerName, providerURL,
@@ -495,6 +488,21 @@ private CSVMetadataHolder createMetadataHolder(AnnotationInstance csvMetadata, C
                 origin);
     }
 
+    private static Map<String, String> extractNameValueMap(AnnotationValue annotationValue) {
+        Map<String, String> map;
+        if (annotationValue != null) {
+            final var array = annotationValue.asNestedArray();
+            map = new HashMap<>(array.length);
+            for (AnnotationInstance instance : array) {
+                map.put(instance.value("name").asString(), instance.value("value").asString());
+            }
+        } else {
+            map = new HashMap<>();
+        }
+
+        return map;
+    }
+
     private static class IsGenerationEnabled implements BooleanSupplier {
 
         private BundleGenerationConfiguration config;
diff --git a/bundle-generator/deployment/src/main/java/io/quarkiverse/operatorsdk/bundle/deployment/builders/CsvManifestsBuilder.java b/bundle-generator/deployment/src/main/java/io/quarkiverse/operatorsdk/bundle/deployment/builders/CsvManifestsBuilder.java
@@ -102,6 +102,9 @@ public CsvManifestsBuilder(CSVMetadataHolder metadata, BuildTimeOperatorConfigur
                 metadata.annotations.others.forEach(metadataBuilder::addToAnnotations);
             }
         }
+        if (metadata.labels != null) {
+            metadata.labels.forEach(metadataBuilder::addToLabels);
+        }
         csvBuilder = metadataBuilder.endMetadata();
 
         final var csvSpecBuilder = csvBuilder
diff --git a/bundle-generator/deployment/src/test/java/io/quarkiverse/operatorsdk/bundle/MultipleOperatorsBundleTest.java b/bundle-generator/deployment/src/test/java/io/quarkiverse/operatorsdk/bundle/MultipleOperatorsBundleTest.java
@@ -117,6 +117,10 @@ public void shouldWriteBundleForTheOperators() throws IOException {
         assertEquals(OVERRIDEN_REPO_ANNOTATION, annotations.get(BundleConfiguration.REPOSITORY_ANNOTATION));
         assertEquals(OVERRIDEN_BY_THIRD_ANNOTATION_VALUE, annotations.get(OVERRIDDEN_DEFAULT_ANNOTATION_NAME));
         assertEquals("bar", annotations.get("foo"));
+        var labels = metadata.getLabels();
+        assertEquals(2, labels.size());
+        assertEquals("test-value", labels.get("test-label"));
+        assertEquals("test-value2", labels.get("test-label2"));
         // version should be the default application's version since it's not provided for this reconciler
         assertEquals(VERSION, spec.getVersion());
 
diff --git a/bundle-generator/deployment/src/test/java/io/quarkiverse/operatorsdk/bundle/sources/ThirdReconciler.java b/bundle-generator/deployment/src/test/java/io/quarkiverse/operatorsdk/bundle/sources/ThirdReconciler.java
@@ -9,6 +9,7 @@
 import io.quarkiverse.operatorsdk.annotations.CSVMetadata;
 import io.quarkiverse.operatorsdk.annotations.CSVMetadata.Annotations;
 import io.quarkiverse.operatorsdk.annotations.CSVMetadata.Annotations.Annotation;
+import io.quarkiverse.operatorsdk.annotations.CSVMetadata.Label;
 import io.quarkiverse.operatorsdk.annotations.CSVMetadata.RequiredCRD;
 
 @Workflow(dependents = {
@@ -17,7 +18,9 @@
         @Dependent(name = "pod2", type = PodDependentResource.class)
 })
 @CSVMetadata(bundleName = ThirdReconciler.BUNDLE_NAME, requiredCRDs = @RequiredCRD(kind = SecondExternal.KIND, name = "externalagains."
-        + SecondExternal.GROUP, version = SecondExternal.VERSION), replaces = "1.0.0", annotations = @Annotations(skipRange = ">=1.0.0 <1.0.3", capabilities = "Test", repository = "should be overridden by property", others = @Annotation(name = "foo", value = "bar")))
+        + SecondExternal.GROUP, version = SecondExternal.VERSION), replaces = "1.0.0", annotations = @Annotations(skipRange = ">=1.0.0 <1.0.3", capabilities = "Test", repository = "should be overridden by property", others = @Annotation(name = "foo", value = "bar")), labels = {
+                @Label(name = "test-label", value = "test-value"),
+                @Label(name = "test-label2", value = "test-value2") })
 @ControllerConfiguration(name = ThirdReconciler.NAME)
 public class ThirdReconciler implements Reconciler<Third> {
 
diff --git a/bundle-generator/runtime/src/main/java/io/quarkiverse/operatorsdk/bundle/runtime/CSVMetadataHolder.java b/bundle-generator/runtime/src/main/java/io/quarkiverse/operatorsdk/bundle/runtime/CSVMetadataHolder.java
@@ -14,6 +14,7 @@ public class CSVMetadataHolder {
     public final String description;
     public final String displayName;
     public final Annotations annotations;
+    public final Map<String, String> labels;
     public final String[] keywords;
     public final String providerName;
     public final String providerURL;
@@ -152,14 +153,15 @@ public RequiredCRD(String kind, String name, String version) {
     }
 
     public CSVMetadataHolder(String bundleName, String version, String replaces, String providerName, String origin) {
-        this(bundleName, null, null, null, null, null, providerName, null, replaces, null, version, null, null, null,
+        this(bundleName, null, null, null, null, null, null, providerName, null, replaces, null, version, null, null, null,
                 null, null,
                 null, null,
                 null,
                 origin);
     }
 
     public CSVMetadataHolder(String bundleName, String csvName, String description, String displayName, Annotations annotations,
+            Map<String, String> labels,
             String[] keywords,
             String providerName,
             String providerURL, String replaces, String[] skips, String version, String maturity,
@@ -173,6 +175,7 @@ public CSVMetadataHolder(String bundleName, String csvName, String description,
         this.description = description;
         this.displayName = displayName;
         this.annotations = annotations;
+        this.labels = labels;
         this.keywords = keywords;
         this.providerURL = providerURL;
         this.replaces = replaces;

Original file line number	Diff line number	Diff line change
`@@ -102,6 +102,9 @@ public CsvManifestsBuilder(CSVMetadataHolder metadata, BuildTimeOperatorConfigur`
`102`	`102`	`metadata.annotations.others.forEach(metadataBuilder::addToAnnotations);`
`103`	`103`	`}`
`104`	`104`	`}`
	`105`	`+ if (metadata.labels != null) {`
	`106`	`+ metadata.labels.forEach(metadataBuilder::addToLabels);`
	`107`	`+ }`
`105`	`108`	`csvBuilder = metadataBuilder.endMetadata();`
`106`	`109`
`107`	`110`	`final var csvSpecBuilder = csvBuilder`