feat: support CSVMetadata displayName & description on CRs (#622)

metacosm · web-flow · commit af2628618067 · 2023-06-09T23:11:13.000+02:00
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
@@ -2,6 +2,7 @@
 
 import static io.quarkiverse.operatorsdk.deployment.AddClusterRolesDecorator.ALL_VERBS;
 
+import io.quarkiverse.operatorsdk.common.DependentResourceAugmentedClassInfo;
 import java.io.ByteArrayInputStream;
 import java.io.IOException;
 import java.nio.file.Path;
@@ -35,6 +36,7 @@
 import io.quarkiverse.operatorsdk.bundle.runtime.SharedCSVMetadata;
 import io.quarkiverse.operatorsdk.common.ClassUtils;
 import io.quarkiverse.operatorsdk.common.ConfigurationUtils;
+import io.quarkiverse.operatorsdk.common.ReconciledAugmentedClassInfo;
 import io.quarkiverse.operatorsdk.common.ReconcilerAugmentedClassInfo;
 import io.quarkiverse.operatorsdk.deployment.GeneratedCRDInfoBuildItem;
 import io.quarkiverse.operatorsdk.deployment.VersionBuildItem;
@@ -48,10 +50,13 @@
 import io.quarkus.kubernetes.spi.GeneratedKubernetesResourceBuildItem;
 
 public class BundleProcessor {
+
     private static final Logger log = Logger.getLogger(BundleProcessor.class);
     private static final DotName SHARED_CSV_METADATA = DotName.createSimple(SharedCSVMetadata.class.getName());
     private static final DotName CSV_METADATA = DotName.createSimple(CSVMetadata.class.getName());
     private static final String BUNDLE = "bundle";
+    public static final String CRD_DISPLAY_NAME = "CRD_DISPLAY_NAME";
+    public static final String CRD_DESCRIPTION = "CRD_DESCRIPTION";
 
     @SuppressWarnings({ "unused" })
     @BuildStep
@@ -98,12 +103,47 @@ CSVMetadataBuildItem gatherCSVMetadata(ApplicationInfoBuildItem configuration,
                             reconcilerInfo.nameOrFailIfUnset(),
                             getMetadataOriginInformation(csvMetadataAnnotation, maybeCSVMetadataName, csvMetadata));
 
-                    csvGroups.computeIfAbsent(csvMetadata, m -> new ArrayList<>()).add(reconcilerInfo);
+                    csvGroups.computeIfAbsent(csvMetadata, m -> new ArrayList<>()).add(
+                            augmentReconcilerInfo(reconcilerInfo));
                 });
 
         return new CSVMetadataBuildItem(csvGroups);
     }
 
+    private static ReconcilerAugmentedClassInfo augmentReconcilerInfo(
+            ReconcilerAugmentedClassInfo reconcilerInfo) {
+        // if primary resource is a CR, check if it is annotated with CSVMetadata and augment it if it is
+        final ReconciledAugmentedClassInfo<?> primaryCI = reconcilerInfo.associatedResourceInfo();
+        augmentResourceInfoIfCR(primaryCI);
+
+        reconcilerInfo.getDependentResourceInfos().forEach(draci -> {
+            // if the dependent is a CR, check if it is annotated with CSVMetadata and augment it if it is
+            final ReconciledAugmentedClassInfo<?> reconciledAugmentedClassInfo = draci.associatedResourceInfo();
+            augmentResourceInfoIfCR(reconciledAugmentedClassInfo);
+        });
+        return reconcilerInfo;
+    }
+
+    private static void augmentResourceInfoIfCR(ReconciledAugmentedClassInfo<?> reconciledAugmentedClassInfo) {
+        if (reconciledAugmentedClassInfo.isCR()) {
+            final var csvMetadata = reconciledAugmentedClassInfo.classInfo().annotation(CSV_METADATA);
+            if (csvMetadata != null) {
+                // extract display name and description
+                final var displayName = ConfigurationUtils.annotationValueOrDefault(csvMetadata,
+                        "displayName", AnnotationValue::asString,
+                        () -> reconciledAugmentedClassInfo.asResourceTargeting().kind());
+                reconciledAugmentedClassInfo.setExtendedInfo(CRD_DISPLAY_NAME, displayName);
+                final var description = ConfigurationUtils.annotationValueOrDefault(
+                        csvMetadata,
+                        "description", AnnotationValue::asString,
+                        () -> null);
+                if (description != null) {
+                    reconciledAugmentedClassInfo.setExtendedInfo(CRD_DESCRIPTION, description);
+                }
+            }
+        }
+    }
+
     private String getMetadataOriginInformation(AnnotationInstance csvMetadataAnnotation, Optional<String> csvMetadataName,
             CSVMetadataHolder metadataHolder) {
         final var isDefault = csvMetadataAnnotation == null;
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
@@ -1,7 +1,10 @@
 package io.quarkiverse.operatorsdk.bundle.deployment.builders;
 
 import static io.quarkiverse.operatorsdk.bundle.deployment.BundleGenerator.MANIFESTS;
+import static io.quarkiverse.operatorsdk.bundle.deployment.BundleProcessor.CRD_DESCRIPTION;
+import static io.quarkiverse.operatorsdk.bundle.deployment.BundleProcessor.CRD_DISPLAY_NAME;
 
+import io.quarkiverse.operatorsdk.common.ReconciledResourceAugmentedClassInfo;
 import java.io.FileInputStream;
 import java.io.IOException;
 import java.nio.file.Path;
@@ -143,12 +146,7 @@ public CsvManifestsBuilder(CSVMetadataHolder metadata, List<ReconcilerAugmentedC
             final var resourceInfo = raci.associatedResourceInfo();
             if (resourceInfo.isCR()) {
                 final var asResource = resourceInfo.asResourceTargeting();
-                final var fullResourceName = asResource.fullResourceName();
-                ownedCRs.add(new CRDDescriptionBuilder()
-                        .withName(fullResourceName)
-                        .withVersion(asResource.version())
-                        .withKind(asResource.kind())
-                        .build());
+                ownedCRs.add(createCRDDescription(asResource));
             }
 
             // add required CRD for each dependent that targets a CR
@@ -159,12 +157,7 @@ public CsvManifestsBuilder(CSVMetadataHolder metadata, List<ReconcilerAugmentedC
                         .map(ReconciledAugmentedClassInfo::asResourceTargeting)
                         .forEach(secondaryResource -> {
                             if (secondaryResource.isCR()) {
-                                final var fullResourceName = secondaryResource.fullResourceName();
-                                requiredCRs.add(new CRDDescriptionBuilder()
-                                        .withName(fullResourceName)
-                                        .withVersion(secondaryResource.version())
-                                        .withKind(secondaryResource.kind())
-                                        .build());
+                                requiredCRs.add(createCRDDescription(secondaryResource));
                             } else {
                                 nativeApis.add(new GroupVersionKind(secondaryResource.group(), secondaryResource.kind(),
                                         secondaryResource.version()));
@@ -196,6 +189,17 @@ public CsvManifestsBuilder(CSVMetadataHolder metadata, List<ReconcilerAugmentedC
                 .endSpec();
     }
 
+    private CRDDescription createCRDDescription(ReconciledResourceAugmentedClassInfo<?> secondaryResource) {
+        final var fullResourceName = secondaryResource.fullResourceName();
+        return new CRDDescriptionBuilder()
+            .withName(fullResourceName)
+            .withDisplayName(secondaryResource.getExtendedInfo(CRD_DISPLAY_NAME, String.class))
+            .withDescription(secondaryResource.getExtendedInfo(CRD_DESCRIPTION, String.class))
+            .withVersion(secondaryResource.version())
+            .withKind(secondaryResource.kind())
+            .build();
+    }
+
     private static String asString(GroupVersionKind gvk) {
         return gvk.getGroup() + " " + gvk.getKind() + gvk.getVersion();
     }
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
@@ -5,6 +5,7 @@
 import static io.quarkiverse.operatorsdk.bundle.Utils.getCRDNameFor;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
+import io.fabric8.openshift.api.model.operatorhub.v1alpha1.CRDDescription;
 import java.io.IOException;
 import java.nio.file.Files;
 
@@ -19,6 +20,7 @@
 import io.quarkus.test.ProdBuildResults;
 import io.quarkus.test.ProdModeTestResults;
 import io.quarkus.test.QuarkusProdModeTest;
+import org.testcontainers.shaded.org.apache.commons.lang3.ThreadUtils.ThreadIdPredicate;
 
 public class MultipleOperatorsBundleTest {
 
@@ -47,9 +49,15 @@ public void shouldWriteBundleForTheOperators() throws IOException {
         final var csvAsString = Files.readString(thirdManifests.resolve("third-operator.clusterserviceversion.yaml"));
         final var csv = Serialization.unmarshal(csvAsString, ClusterServiceVersion.class);
         final var crds = csv.getSpec().getCustomresourcedefinitions();
-        assertEquals(HasMetadata.getFullResourceName(Third.class), crds.getOwned().get(0).getName());
+        final var thirdCRD = crds.getOwned().get(0);
+        assertEquals(HasMetadata.getFullResourceName(Third.class), thirdCRD.getName());
+        assertEquals(Third.DISPLAY, thirdCRD.getDisplayName());
+        assertEquals(Third.DESCRIPTION, thirdCRD.getDescription());
         // CRDs should be alphabetically ordered
-        assertEquals(HasMetadata.getFullResourceName(External.class), crds.getRequired().get(0).getName());
+        final var externalCRD = crds.getRequired().get(0);
+        assertEquals(HasMetadata.getFullResourceName(External.class), externalCRD.getName());
+        assertEquals(External.DISPLAY_NAME, externalCRD.getDisplayName());
+        assertEquals(External.DESCRIPTION, externalCRD.getDescription());
         assertEquals(HasMetadata.getFullResourceName(SecondExternal.class), crds.getRequired().get(1).getName());
         // should list native APIs as well
         final var podGVK = csv.getSpec().getNativeAPIs().get(0);
diff --git a/bundle-generator/deployment/src/test/java/io/quarkiverse/operatorsdk/bundle/sources/External.java b/bundle-generator/deployment/src/test/java/io/quarkiverse/operatorsdk/bundle/sources/External.java
@@ -3,9 +3,13 @@
 import io.fabric8.kubernetes.client.CustomResource;
 import io.fabric8.kubernetes.model.annotation.Group;
 import io.fabric8.kubernetes.model.annotation.Version;
+import io.quarkiverse.operatorsdk.bundle.runtime.CSVMetadata;
 
 @Group("halkyon.io")
 @Version("v1alpha1")
+@CSVMetadata(displayName = External.DISPLAY_NAME, description = External.DESCRIPTION)
 public class External extends CustomResource<Void, Void> {
 
+    public static final String DISPLAY_NAME = "External display name";
+    public static final String DESCRIPTION = "External description";
 }
diff --git a/bundle-generator/deployment/src/test/java/io/quarkiverse/operatorsdk/bundle/sources/Third.java b/bundle-generator/deployment/src/test/java/io/quarkiverse/operatorsdk/bundle/sources/Third.java
@@ -4,9 +4,13 @@
 import io.fabric8.kubernetes.client.CustomResource;
 import io.fabric8.kubernetes.model.annotation.Group;
 import io.fabric8.kubernetes.model.annotation.Version;
+import io.quarkiverse.operatorsdk.bundle.runtime.CSVMetadata;
 
 @Group("samples.javaoperatorsdk.io")
 @Version("v1alpha1")
+@CSVMetadata(displayName = Third.DISPLAY, description = Third.DESCRIPTION)
 public class Third extends CustomResource<Void, Void> implements Namespaced {
 
+  public static final String DESCRIPTION = "Third description";
+  public static final String DISPLAY = "Third display";
 }
diff --git a/common-deployment/src/main/java/io/quarkiverse/operatorsdk/common/SelectiveAugmentedClassInfo.java b/common-deployment/src/main/java/io/quarkiverse/operatorsdk/common/SelectiveAugmentedClassInfo.java
@@ -7,6 +7,7 @@
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
 
 import org.jboss.jandex.ClassInfo;
 import org.jboss.jandex.DotName;
@@ -22,6 +23,7 @@ public abstract class SelectiveAugmentedClassInfo {
     private Type[] types;
     private final DotName extendedOrImplementedClass;
     private final int expectedParameterTypesCardinality;
+    private final Map<Object, Object> extendedInfos = new ConcurrentHashMap<>();
 
     private final List<String> classNamesToRegisterForReflection = new ArrayList<>();
 
@@ -105,4 +107,13 @@ protected void augmentIfKept(IndexView index, Logger log, Map<String, Object> co
     }
 
     protected abstract void doAugment(IndexView index, Logger log, Map<String, Object> context);
+
+    @SuppressWarnings({ "unchecked", "unused" })
+    public <T> T getExtendedInfo(Object key, Class<T> expectedValueType) {
+        return (T) extendedInfos.get(key);
+    }
+
+    public void setExtendedInfo(Object key, Object value) {
+        extendedInfos.put(key, value);
+    }
 }
