feat: automatically add provider name and URL based on user and git repo

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

Author: metacosm

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

@@ -41,7 +41,9 @@
 import io.quarkus.deployment.builditem.ApplicationInfoBuildItem;
 import io.quarkus.deployment.builditem.CombinedIndexBuildItem;
 import io.quarkus.deployment.builditem.GeneratedFileSystemResourceBuildItem;
+import io.quarkus.deployment.pkg.builditem.JarBuildItem;
 import io.quarkus.deployment.pkg.builditem.OutputTargetBuildItem;
+import io.quarkus.kubernetes.deployment.KubernetesCommonHelper;
 import io.quarkus.kubernetes.deployment.KubernetesConfig;
 import io.quarkus.kubernetes.deployment.ResourceNameUtil;
 
@@ -69,7 +71,8 @@ public boolean getAsBoolean() {
     CSVMetadataBuildItem gatherCSVMetadata(KubernetesConfig kubernetesConfig,
             ApplicationInfoBuildItem appConfiguration,
             BundleGenerationConfiguration bundleConfiguration,
-            CombinedIndexBuildItem combinedIndexBuildItem) {
+            CombinedIndexBuildItem combinedIndexBuildItem,
+            JarBuildItem jarBuildItem) {
         final var index = combinedIndexBuildItem.getIndex();
         final var defaultName = bundleConfiguration.packageName
                 .orElse(ResourceNameUtil.getResourceName(kubernetesConfig, appConfiguration));
@@ -82,7 +85,8 @@ CSVMetadataBuildItem gatherCSVMetadata(KubernetesConfig kubernetesConfig,
 
         final var defaultReplaces = bundleConfiguration.replaces.orElse(null);
 
-        final var sharedMetadataHolders = getSharedMetadataHolders(defaultName, defaultVersion, defaultReplaces, index);
+        final var vcsUrl = getDefaultProviderURLFromSCMInfo(appConfiguration, jarBuildItem);
+        final var sharedMetadataHolders = getSharedMetadataHolders(defaultName, defaultVersion, defaultReplaces, index, vcsUrl);
         final var csvGroups = new HashMap<CSVMetadataHolder, List<ReconcilerAugmentedClassInfo>>();
 
         ClassUtils.getKnownReconcilers(index, log)
@@ -114,7 +118,7 @@ CSVMetadataBuildItem gatherCSVMetadata(KubernetesConfig kubernetesConfig,
                             }
                         }
                         csvMetadata = createMetadataHolder(csvMetadataAnnotation,
-                                new CSVMetadataHolder(csvMetadataName, defaultVersion, defaultReplaces, origin));
+                                new CSVMetadataHolder(csvMetadataName, defaultVersion, defaultReplaces, vcsUrl, origin));
                     }
                     log.infov("Assigning ''{0}'' reconciler to {1}",
                             reconcilerInfo.nameOrFailIfUnset(),
@@ -127,6 +131,33 @@ CSVMetadataBuildItem gatherCSVMetadata(KubernetesConfig kubernetesConfig,
         return new CSVMetadataBuildItem(csvGroups);
     }
 
+    private static String getDefaultProviderURLFromSCMInfo(ApplicationInfoBuildItem appConfiguration,
+            JarBuildItem jarBuildItem) {
+        final var maybeProject = KubernetesCommonHelper.createProject(appConfiguration, Optional.empty(),
+                jarBuildItem.getPath());
+        return maybeProject.map(project -> {
+            final var scmInfo = project.getScmInfo();
+            if (scmInfo != null) {
+                var origin = scmInfo.getRemote().get("origin");
+                if (origin != null) {
+                    int atSign = origin.indexOf('@');
+                    if (atSign > 0) {
+                        origin = origin.substring(atSign + 1);
+                        origin = origin.replaceFirst(":", "/");
+                        origin = "https://" + origin;
+                    }
+
+                    int dotGit = origin.indexOf(".git");
+                    if (dotGit < origin.length() - 1) {
+                        origin = origin.substring(0, dotGit);
+                    }
+                    return origin;
+                }
+            }
+            return null;
+        }).orElse(null);
+    }
+
     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
@@ -255,8 +286,8 @@ void generateBundle(ApplicationInfoBuildItem configuration,
     }
 
     private Map<String, CSVMetadataHolder> getSharedMetadataHolders(String name, String version, String defaultReplaces,
-            IndexView index) {
-        CSVMetadataHolder csvMetadata = new CSVMetadataHolder(name, version, defaultReplaces, "default");
+            IndexView index, String vcsUrl) {
+        CSVMetadataHolder csvMetadata = new CSVMetadataHolder(name, version, defaultReplaces, vcsUrl, "default");
         final var sharedMetadataImpls = index.getAllKnownImplementors(SHARED_CSV_METADATA);
         final var result = new HashMap<String, CSVMetadataHolder>(sharedMetadataImpls.size() + 1);
         sharedMetadataImpls.forEach(sharedMetadataImpl -> {

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

@@ -37,6 +37,8 @@ public void shouldWriteBundleEvenWhenCsvMetadataIsNotUsed() throws IOException {
         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"));
+        assertNotNull(csv.getSpec().getProvider().getName());
+        assertNotNull(csv.getSpec().getProvider().getUrl());
     }
 
 }

bundle-generator/runtime/src/main/java/io/quarkiverse/operatorsdk/bundle/runtime/CSVMetadataHolder.java

@@ -4,7 +4,10 @@
 import java.util.Map;
 import java.util.Objects;
 
+import org.jboss.logging.Logger;
+
 public class CSVMetadataHolder {
+    private static final Logger log = Logger.getLogger(CSVMetadataHolder.class.getName());
     public final String name;
     private final String origin;
     public final String description;
@@ -117,8 +120,9 @@ public RequiredCRD(String kind, String name, String version) {
 
     }
 
-    public CSVMetadataHolder(String name, String version, String replaces, String origin) {
-        this(name, null, null, null, null, null, null, replaces, null, version, null, null, null, null, null, null, null, null,
+    public CSVMetadataHolder(String name, String version, String replaces, String providerURL, String origin) {
+        this(name, null, null, null, null, null, providerURL, replaces, null, version, null, null, null, null, null, null, null,
+                null,
                 origin);
     }
 
@@ -133,7 +137,6 @@ public CSVMetadataHolder(String name, String description, String displayName, An
         this.displayName = displayName;
         this.annotations = annotations;
         this.keywords = keywords;
-        this.providerName = providerName;
         this.providerURL = providerURL;
         this.replaces = replaces;
         this.skips = skips;
@@ -147,6 +150,18 @@ public CSVMetadataHolder(String name, String description, String displayName, An
         this.permissionRules = permissionRules;
         this.requiredCRDs = requiredCRDs;
         this.origin = origin;
+
+        // provide a default provider name and output warning if none is provided
+        if (providerName == null) {
+            String msg = "";
+            final var userName = System.getProperty("user.name");
+            if (userName != null) {
+                providerName = userName;
+                msg = ". Using user name " + userName + " as default.";
+            }
+            log.warnv("It is recommended that you provide a provider name provided for {0}{1}", name, msg);
+        }
+        this.providerName = providerName;
     }
 
     @Override