feat: properly output dependent native APIs (#619)

metacosm · web-flow · commit 1ccf0bc5b153 · 2023-06-08T23:48:34.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
@@ -189,12 +189,12 @@ void generateBundle(ApplicationInfoBuildItem configuration,
                                         Path.of(BUNDLE).resolve(manifestBuilder.getName()).resolve(fileName).toString(),
                                         manifestBuilder.getManifestData(serviceAccounts, clusterRoleBindings, clusterRoles,
                                                 roleBindings, roles, deployments)));
-                        log.infov("Generating {0} for {1} controller -> {2}",
+                        log.infov("Generating {0} for ''{1}'' controller -> {2}",
                                 manifestBuilder.getManifestType(),
                                 manifestBuilder.getName(),
                                 outputDir.resolve(manifestBuilder.getName()).resolve(fileName));
                     } catch (IOException e) {
-                        log.errorv("Cannot generate {0} for {1}: {2}",
+                        log.errorv("Cannot generate {0} for ''{1}'' controller: {2}",
                                 manifestBuilder.getManifestType(), manifestBuilder.getName(), e.getMessage());
                     }
                 });
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
@@ -7,9 +7,11 @@
 import java.nio.file.Path;
 import java.util.*;
 import java.util.function.Predicate;
+import java.util.stream.Collectors;
 
 import org.jboss.logging.Logger;
 
+import io.fabric8.kubernetes.api.model.GroupVersionKind;
 import io.fabric8.kubernetes.api.model.ServiceAccount;
 import io.fabric8.kubernetes.api.model.apps.Deployment;
 import io.fabric8.kubernetes.api.model.rbac.*;
@@ -31,12 +33,10 @@ public class CsvManifestsBuilder extends ManifestsBuilder {
     private static final String ROLE_KIND = "Role";
     private static final String NO_SERVICE_ACCOUNT = "";
     private static final Logger LOGGER = Logger.getLogger(CsvManifestsBuilder.class.getName());
-
     private static final String IMAGE_PNG = "image/png";
-
     private ClusterServiceVersionBuilder csvBuilder;
-    private final SortedSet<String> ownedCRs = new TreeSet<>();
-    private final SortedSet<String> requiredCRs = new TreeSet<>();
+    private final Set<CRDDescription> ownedCRs = new HashSet<>();
+    private final Set<CRDDescription> requiredCRs = new HashSet<>();
     private final Path kubernetesResources;
 
     public CsvManifestsBuilder(CSVMetadataHolder metadata, List<ReconcilerAugmentedClassInfo> controllers,
@@ -137,62 +137,81 @@ public CsvManifestsBuilder(CSVMetadataHolder metadata, List<ReconcilerAugmentedC
         }
 
         // add owned and required CRD, also collect them
-        final var crdsBuilder = csvSpecBuilder.editOrNewCustomresourcedefinitions();
+        final var nativeApis = new ArrayList<GroupVersionKind>();
         controllers.forEach(raci -> {
             // add owned CRD
             final var resourceInfo = raci.associatedResourceInfo();
             if (resourceInfo.isCR()) {
                 final var asResource = resourceInfo.asResourceTargeting();
                 final var fullResourceName = asResource.fullResourceName();
-                ownedCRs.add(fullResourceName);
-                crdsBuilder
-                        .addNewOwned()
+                ownedCRs.add(new CRDDescriptionBuilder()
                         .withName(fullResourceName)
                         .withVersion(asResource.version())
                         .withKind(asResource.kind())
-                        .endOwned();
+                        .build());
             }
 
             // add required CRD for each dependent that targets a CR
             final var dependents = raci.getDependentResourceInfos();
             if (dependents != null && !dependents.isEmpty()) {
                 dependents.stream()
                         .map(ResourceAssociatedAugmentedClassInfo::associatedResourceInfo)
-                        .filter(ReconciledAugmentedClassInfo::isCR)
                         .map(ReconciledAugmentedClassInfo::asResourceTargeting)
                         .forEach(secondaryResource -> {
-                            final var fullResourceName = secondaryResource.fullResourceName();
-                            requiredCRs.add(fullResourceName);
-                            crdsBuilder.addNewRequired()
-                                    .withName(fullResourceName)
-                                    .withVersion(secondaryResource.version())
-                                    .withKind(secondaryResource.kind())
-                                    .endRequired();
+                            if (secondaryResource.isCR()) {
+                                final var fullResourceName = secondaryResource.fullResourceName();
+                                requiredCRs.add(new CRDDescriptionBuilder()
+                                        .withName(fullResourceName)
+                                        .withVersion(secondaryResource.version())
+                                        .withKind(secondaryResource.kind())
+                                        .build());
+                            } else {
+                                nativeApis.add(new GroupVersionKind(secondaryResource.group(), secondaryResource.kind(),
+                                        secondaryResource.version()));
+                            }
                         });
             }
+        });
 
-            // add required CRDs from CSV metadata
-            if (metadata.requiredCRDs != null) {
-                for (RequiredCRD requiredCRD : metadata.requiredCRDs) {
-                    requiredCRs.add(requiredCRD.name);
-                    crdsBuilder.addNewRequired()
-                            .withKind(requiredCRD.kind)
-                            .withName(requiredCRD.name)
-                            .withVersion(requiredCRD.version)
-                            .endRequired();
-                }
+        // add required CRDs from CSV metadata
+        if (metadata.requiredCRDs != null) {
+            for (RequiredCRD requiredCRD : metadata.requiredCRDs) {
+                requiredCRs.add(new CRDDescriptionBuilder()
+                        .withKind(requiredCRD.kind)
+                        .withName(requiredCRD.name)
+                        .withVersion(requiredCRD.version)
+                        .build());
             }
+        }
 
-        });
-        crdsBuilder.endCustomresourcedefinitions().endSpec();
+        // add sorted native APIs
+        csvSpecBuilder.addAllToNativeAPIs(nativeApis.stream()
+                .sorted(Comparator.comparing(CsvManifestsBuilder::asString))
+                .collect(Collectors.toList()));
+
+        csvSpecBuilder.editOrNewCustomresourcedefinitions()
+                .addAllToOwned(ownedCRs)
+                .addAllToRequired(requiredCRs)
+                .endCustomresourcedefinitions()
+                .endSpec();
+    }
+
+    private static String asString(GroupVersionKind gvk) {
+        return gvk.getGroup() + " " + gvk.getKind() + gvk.getVersion();
     }
 
     public Set<String> getOwnedCRs() {
-        return Collections.unmodifiableSet(ownedCRs);
+        return ownedCRs.stream()
+                .map(CRDDescription::getName)
+                .sorted()
+                .collect(Collectors.toCollection(LinkedHashSet::new));
     }
 
     public Set<String> getRequiredCRs() {
-        return Collections.unmodifiableSet(requiredCRs);
+        return requiredCRs.stream()
+                .map(CRDDescription::getName)
+                .sorted()
+                .collect(Collectors.toCollection(LinkedHashSet::new));
     }
 
     @Override
diff --git a/bundle-generator/deployment/src/test/java/io/quarkiverse/operatorsdk/bundle/DefaultBundleWhenNoCsvMetadataTest.java b/bundle-generator/deployment/src/test/java/io/quarkiverse/operatorsdk/bundle/DefaultBundleWhenNoCsvMetadataTest.java
@@ -1,5 +1,7 @@
 package io.quarkiverse.operatorsdk.bundle;
 
+import static io.quarkiverse.operatorsdk.bundle.Utils.BUNDLE;
+
 import java.nio.file.Files;
 
 import org.junit.jupiter.api.Assertions;
@@ -14,8 +16,6 @@
 
 public class DefaultBundleWhenNoCsvMetadataTest {
 
-    private static final String BUNDLE = "bundle";
-
     @RegisterExtension
     static final QuarkusProdModeTest config = new QuarkusProdModeTest()
             .setApplicationName("reconciler-with-no-csv-metadata")
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
@@ -12,6 +12,7 @@
 import org.junit.jupiter.api.extension.RegisterExtension;
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
+import io.fabric8.kubernetes.api.model.Pod;
 import io.fabric8.kubernetes.client.utils.Serialization;
 import io.fabric8.openshift.api.model.operatorhub.v1alpha1.ClusterServiceVersion;
 import io.quarkiverse.operatorsdk.bundle.sources.*;
@@ -27,7 +28,7 @@ public class MultipleOperatorsBundleTest {
                     .addClasses(First.class, FirstReconciler.class,
                             Second.class, SecondReconciler.class,
                             Third.class, External.class, SecondExternal.class, ThirdReconciler.class,
-                            ExternalDependentResource.class))
+                            ExternalDependentResource.class, PodDependentResource.class))
             .overrideConfigKey("quarkus.operator-sdk.crd.generate-all", "true");
 
     @SuppressWarnings("unused")
@@ -50,6 +51,11 @@ public void shouldWriteBundleForTheOperators() throws IOException {
         // CRDs should be alphabetically ordered
         assertEquals(HasMetadata.getFullResourceName(External.class), crds.getRequired().get(0).getName());
         assertEquals(HasMetadata.getFullResourceName(SecondExternal.class), crds.getRequired().get(1).getName());
+        // should list native APIs as well
+        final var podGVK = csv.getSpec().getNativeAPIs().get(0);
+        assertEquals(HasMetadata.getGroup(Pod.class), podGVK.getGroup());
+        assertEquals(HasMetadata.getKind(Pod.class), podGVK.getKind());
+        assertEquals(HasMetadata.getVersion(Pod.class), podGVK.getVersion());
         assertEquals("1.0.0", csv.getSpec().getReplaces());
         assertEquals(">=1.0.0 <1.0.3", csv.getMetadata().getAnnotations().get("olm.skipRange"));
         assertEquals("Test", csv.getMetadata().getAnnotations().get("capabilities"));
diff --git a/bundle-generator/deployment/src/test/java/io/quarkiverse/operatorsdk/bundle/sources/PodDependentResource.java b/bundle-generator/deployment/src/test/java/io/quarkiverse/operatorsdk/bundle/sources/PodDependentResource.java
@@ -0,0 +1,11 @@
+package io.quarkiverse.operatorsdk.bundle.sources;
+
+import io.fabric8.kubernetes.api.model.Pod;
+import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependentResource;
+
+public class PodDependentResource extends KubernetesDependentResource<Pod, Third> {
+
+    public PodDependentResource() {
+        super(Pod.class);
+    }
+}
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
@@ -12,7 +12,10 @@
 
 @CSVMetadata(name = "third-operator", 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", others = @Annotation(name = "foo", value = "bar")))
-@ControllerConfiguration(dependents = @Dependent(type = ExternalDependentResource.class))
+@ControllerConfiguration(dependents = {
+        @Dependent(type = ExternalDependentResource.class),
+        @Dependent(type = PodDependentResource.class)
+})
 public class ThirdReconciler implements Reconciler<Third> {
 
     @Override
diff --git a/common-deployment/src/main/java/io/quarkiverse/operatorsdk/common/ReconciledResourceAugmentedClassInfo.java b/common-deployment/src/main/java/io/quarkiverse/operatorsdk/common/ReconciledResourceAugmentedClassInfo.java
@@ -26,6 +26,10 @@ public String version() {
         return HasMetadataUtils.getVersion(classInfo());
     }
 
+    public String group() {
+        return HasMetadataUtils.getGroup(classInfo());
+    }
+
     @Override
     public boolean isResource() {
         return true;
