feat: improve OLM support #851
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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; | ||
|
|
||
|
|
@@ -51,6 +53,7 @@ public class BundleProcessor { | |
| 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"; | ||
| private static final String DEFAULT_PROVIDER_NAME = System.getProperty("user.name"); | ||
| public static final String CRD_DISPLAY_NAME = "CRD_DISPLAY_NAME"; | ||
| public static final String CRD_DESCRIPTION = "CRD_DESCRIPTION"; | ||
|
|
||
|
|
@@ -69,7 +72,8 @@ public boolean getAsBoolean() { | |
| CSVMetadataBuildItem gatherCSVMetadata(KubernetesConfig kubernetesConfig, | ||
| ApplicationInfoBuildItem appConfiguration, | ||
| BundleGenerationConfiguration bundleConfiguration, | ||
| CombinedIndexBuildItem combinedIndexBuildItem, | ||
| JarBuildItem jarBuildItem) { | ||
| final var index = combinedIndexBuildItem.getIndex(); | ||
| final var defaultName = bundleConfiguration.packageName | ||
| .orElse(ResourceNameUtil.getResourceName(kubernetesConfig, appConfiguration)); | ||
|
|
@@ -94,31 +98,37 @@ CSVMetadataBuildItem gatherCSVMetadata(KubernetesConfig kubernetesConfig, | |
| // Check whether the reconciler must be shipped using a custom bundle | ||
| final var csvMetadataAnnotation = reconcilerInfo.classInfo() | ||
| .declaredAnnotation(CSV_METADATA); | ||
| final var sharedMetadataName = getBundleName(csvMetadataAnnotation, defaultName); | ||
| final var isNameInferred = defaultName.equals(sharedMetadataName); | ||
|
|
||
| var csvMetadata = sharedMetadataHolders.get(sharedMetadataName); | ||
| if (csvMetadata == null) { | ||
| final var origin = reconcilerInfo.classInfo().name().toString(); | ||
|
|
||
| if (!sharedMetadataName.equals(defaultName)) { | ||
| final var maybeExistingOrigin = csvGroups.keySet().stream() | ||
| .filter(mh -> mh.bundleName.equals(sharedMetadataName)) | ||
| .map(CSVMetadataHolder::getOrigin) | ||
| .findFirst(); | ||
| if (maybeExistingOrigin.isPresent()) { | ||
| throw new IllegalStateException("Reconcilers '" + maybeExistingOrigin.get() | ||
| + "' and '" + origin | ||
| + "' are using the same bundle name '" + sharedMetadataName | ||
| + "' but no SharedCSVMetadata implementation with that name exists. Please create a SharedCSVMetadata with that name to have one single source of truth and reference it via CSVMetadata annotations using that name on your reconcilers."); | ||
| } | ||
| } | ||
| csvMetadata = createMetadataHolder(csvMetadataAnnotation, | ||
| new CSVMetadataHolder(sharedMetadataName, defaultVersion, defaultReplaces, | ||
| DEFAULT_PROVIDER_NAME, origin)); | ||
| if (DEFAULT_PROVIDER_NAME.equals(csvMetadata.providerName)) { | ||
| log.warnv( | ||
| "It is recommended that you provide a provider name provided for {0}: ''{1}'' was used as default value.", | ||
| origin, DEFAULT_PROVIDER_NAME); | ||
| } | ||
| } | ||
| log.infov("Assigning ''{0}'' reconciler to {1}", | ||
| reconcilerInfo.nameOrFailIfUnset(), | ||
| getMetadataOriginInformation(csvMetadataAnnotation, isNameInferred, csvMetadata)); | ||
|
|
||
| csvGroups.computeIfAbsent(csvMetadata, m -> new ArrayList<>()).add( | ||
| augmentReconcilerInfo(reconcilerInfo)); | ||
|
|
@@ -127,6 +137,37 @@ 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"); | ||
|
There was a problem hiding this comment. Again.. same as with that CVE. We should make sure that this can be explicitly overridable -- there are cases when origin might point actually be a fork which one doesn't want to publicly advertise (e.g. when builds are for whatever reason using a mirror URL or when you simply have manual steps in your workflow) There was a problem hiding this comment. I absolutely must echo @jcechace concern here. In almost all use cases, There was a problem hiding this comment. Yes, it's very tricky so maybe I'll just remove this and let people deal with it using There was a problem hiding this comment.
Note that this is for the default value and is overridable using |
||
| if (origin != null) { | ||
| try { | ||
| 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 > 0 && dotGit < origin.length() - 1) { | ||
| origin = origin.substring(0, dotGit); | ||
| } | ||
| return origin; | ||
| } catch (Exception e) { | ||
| log.warnv("Couldn't parse SCM information: {0}", 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 | ||
|
|
@@ -161,14 +202,14 @@ private static void augmentResourceInfoIfCR(ReconciledAugmentedClassInfo<?> reco | |
| } | ||
| } | ||
|
|
||
| private String getMetadataOriginInformation(AnnotationInstance csvMetadataAnnotation, boolean isNameInferred, | ||
| CSVMetadataHolder metadataHolder) { | ||
| final var isDefault = csvMetadataAnnotation == null; | ||
| final var actualName = metadataHolder.bundleName; | ||
| if (isDefault) { | ||
| return "default bundle automatically named '" + actualName + "'"; | ||
| } else { | ||
| return "bundle " + (isNameInferred ? "automatically " : "") + "named '" | ||
| + actualName + "' defined by '" + metadataHolder.getOrigin() + "'"; | ||
| } | ||
| } | ||
|
|
@@ -256,30 +297,40 @@ 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_PROVIDER_NAME, | ||
| "default"); | ||
| final var sharedMetadataImpls = index.getAllKnownImplementors(SHARED_CSV_METADATA); | ||
| final var result = new HashMap<String, CSVMetadataHolder>(sharedMetadataImpls.size() + 1); | ||
| sharedMetadataImpls.forEach(sharedMetadataImpl -> { | ||
| final var csvMetadataAnn = sharedMetadataImpl.declaredAnnotation(CSV_METADATA); | ||
| if (csvMetadataAnn != null) { | ||
| final var origin = sharedMetadataImpl.name().toString(); | ||
| final var metadataHolder = createMetadataHolder(csvMetadataAnn, csvMetadata, origin); | ||
| final var existing = result.get(metadataHolder.bundleName); | ||
| if (existing != null) { | ||
| throw new IllegalStateException( | ||
| "Only one SharedCSVMetadata named " + metadataHolder.bundleName | ||
| + " can be defined. Was defined on (at least): " + existing.getOrigin() + " and " + origin); | ||
| } | ||
| result.put(metadataHolder.bundleName, metadataHolder); | ||
| } | ||
| }); | ||
| return result; | ||
| } | ||
|
|
||
| private static String getBundleName(AnnotationInstance csvMetadata, String defaultName) { | ||
| if (csvMetadata == null) { | ||
| return defaultName; | ||
| } else { | ||
| final var bundleName = csvMetadata.value("bundleName"); | ||
| if (bundleName != null) { | ||
| return bundleName.asString(); | ||
| } else { | ||
| return Optional.ofNullable(csvMetadata.value("name")) | ||
| .map(AnnotationValue::asString) | ||
| .orElse(defaultName); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private CSVMetadataHolder createMetadataHolder(AnnotationInstance csvMetadata, | ||
|
|
@@ -294,8 +345,8 @@ private CSVMetadataHolder createMetadataHolder(AnnotationInstance csvMetadata, C | |
| } | ||
|
|
||
| final var providerField = csvMetadata.value("provider"); | ||
| String providerName = mh.providerName; | ||
| String providerURL = mh.providerURL; | ||
| if (providerField != null) { | ||
| final var provider = providerField.asNested(); | ||
| providerName = ConfigurationUtils.annotationValueOrDefault(provider, "name", | ||
|
|
@@ -441,8 +492,9 @@ private CSVMetadataHolder createMetadataHolder(AnnotationInstance csvMetadata, C | |
| } | ||
|
|
||
| return new CSVMetadataHolder( | ||
| getBundleName(csvMetadata, mh.bundleName), | ||
| ConfigurationUtils.annotationValueOrDefault(csvMetadata, "csvName", | ||
| AnnotationValue::asString, () -> mh.csvName), | ||
| ConfigurationUtils.annotationValueOrDefault(csvMetadata, "description", | ||
| AnnotationValue::asString, () -> mh.description), | ||
| ConfigurationUtils.annotationValueOrDefault(csvMetadata, "displayName", | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@metacosm need to be extremely careful here. This class uses Dekorate to get the URL info directly from local git config. Personally I consider this unexpected (compared to using VCS info from pom configuration) and it was also the source of the recent Quarkus CVE .