Skip to content

Commit e6bc310

Browse files
committed
refactor: move provider name warning outside of constructor
Signed-off-by: Chris Laprun <[email protected]>
1 parent 2281691 commit e6bc310

File tree

3 files changed

+18
-22
lines changed

3 files changed

+18
-22
lines changed

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

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ public class BundleProcessor {
5353
private static final DotName SHARED_CSV_METADATA = DotName.createSimple(SharedCSVMetadata.class.getName());
5454
private static final DotName CSV_METADATA = DotName.createSimple(CSVMetadata.class.getName());
5555
private static final String BUNDLE = "bundle";
56+
private static final String DEFAULT_PROVIDER_NAME = System.getProperty("user.name");
5657
public static final String CRD_DISPLAY_NAME = "CRD_DISPLAY_NAME";
5758
public static final String CRD_DESCRIPTION = "CRD_DESCRIPTION";
5859

@@ -85,8 +86,9 @@ CSVMetadataBuildItem gatherCSVMetadata(KubernetesConfig kubernetesConfig,
8586

8687
final var defaultReplaces = bundleConfiguration.replaces.orElse(null);
8788

88-
final var vcsUrl = getDefaultProviderURLFromSCMInfo(appConfiguration, jarBuildItem);
89-
final var sharedMetadataHolders = getSharedMetadataHolders(defaultName, defaultVersion, defaultReplaces, index, vcsUrl);
89+
final var defaultProviderURL = getDefaultProviderURLFromSCMInfo(appConfiguration, jarBuildItem);
90+
final var sharedMetadataHolders = getSharedMetadataHolders(defaultName, defaultVersion, defaultReplaces, index,
91+
defaultProviderURL);
9092
final var csvGroups = new HashMap<CSVMetadataHolder, List<ReconcilerAugmentedClassInfo>>();
9193

9294
ClassUtils.getKnownReconcilers(index, log)
@@ -118,7 +120,13 @@ CSVMetadataBuildItem gatherCSVMetadata(KubernetesConfig kubernetesConfig,
118120
}
119121
}
120122
csvMetadata = createMetadataHolder(csvMetadataAnnotation,
121-
new CSVMetadataHolder(sharedMetadataName, defaultVersion, defaultReplaces, vcsUrl, origin));
123+
new CSVMetadataHolder(sharedMetadataName, defaultVersion, defaultReplaces,
124+
DEFAULT_PROVIDER_NAME, defaultProviderURL, origin));
125+
if (DEFAULT_PROVIDER_NAME.equals(csvMetadata.providerName)) {
126+
log.warnv(
127+
"It is recommended that you provide a provider name provided for {0}: ''{1}'' was used as default value.",
128+
origin, DEFAULT_PROVIDER_NAME);
129+
}
122130
}
123131
log.infov("Assigning ''{0}'' reconciler to {1}",
124132
reconcilerInfo.nameOrFailIfUnset(),
@@ -140,7 +148,6 @@ private static String getDefaultProviderURLFromSCMInfo(ApplicationInfoBuildItem
140148
if (scmInfo != null) {
141149
var origin = scmInfo.getRemote().get("origin");
142150
if (origin != null) {
143-
System.out.println(origin);
144151
try {
145152
int atSign = origin.indexOf('@');
146153
if (atSign > 0) {
@@ -292,7 +299,8 @@ void generateBundle(ApplicationInfoBuildItem configuration,
292299

293300
private Map<String, CSVMetadataHolder> getSharedMetadataHolders(String name, String version, String defaultReplaces,
294301
IndexView index, String vcsUrl) {
295-
CSVMetadataHolder csvMetadata = new CSVMetadataHolder(name, version, defaultReplaces, vcsUrl, "default");
302+
CSVMetadataHolder csvMetadata = new CSVMetadataHolder(name, version, defaultReplaces, vcsUrl, DEFAULT_PROVIDER_NAME,
303+
"default");
296304
final var sharedMetadataImpls = index.getAllKnownImplementors(SHARED_CSV_METADATA);
297305
final var result = new HashMap<String, CSVMetadataHolder>(sharedMetadataImpls.size() + 1);
298306
sharedMetadataImpls.forEach(sharedMetadataImpl -> {

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ public void shouldWriteBundleEvenWhenCsvMetadataIsNotUsed() throws IOException {
3737
assertEquals(name, deployment.getName());
3838
// by default, we shouldn't output the version label in the selector match labels as the default controlling this should be overridden by KubernetesLabelConfigOverrider
3939
assertNull(deployment.getSpec().getSelector().getMatchLabels().get("app.kubernetes.io/version"));
40-
assertNotNull(csv.getSpec().getProvider().getName());
40+
assertEquals(System.getProperty("user.name"), csv.getSpec().getProvider().getName());
4141
assertNotNull(csv.getSpec().getProvider().getUrl());
4242
}
4343

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

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,7 @@
44
import java.util.Map;
55
import java.util.Objects;
66

7-
import org.jboss.logging.Logger;
8-
97
public class CSVMetadataHolder {
10-
private static final Logger log = Logger.getLogger(CSVMetadataHolder.class.getName());
118
public final String bundleName;
129
public final String csvName;
1310
private final String origin;
@@ -121,8 +118,10 @@ public RequiredCRD(String kind, String name, String version) {
121118

122119
}
123120

124-
public CSVMetadataHolder(String bundleName, String version, String replaces, String providerURL, String origin) {
125-
this(bundleName, null, null, null, null, null, null, providerURL, replaces, null, version, null, null, null, null, null,
121+
public CSVMetadataHolder(String bundleName, String version, String replaces, String providerName, String providerURL,
122+
String origin) {
123+
this(bundleName, null, null, null, null, null, providerName, providerURL, replaces, null, version, null, null, null,
124+
null, null,
126125
null, null,
127126
null,
128127
origin);
@@ -155,17 +154,6 @@ public CSVMetadataHolder(String bundleName, String csvName, String description,
155154
this.permissionRules = permissionRules;
156155
this.requiredCRDs = requiredCRDs;
157156
this.origin = origin;
158-
159-
// provide a default provider name and output warning if none is provided
160-
if (providerName == null) {
161-
String msg = "";
162-
final var userName = System.getProperty("user.name");
163-
if (userName != null) {
164-
providerName = userName;
165-
msg = ". Using user name " + userName + " as default.";
166-
}
167-
log.warnv("It is recommended that you provide a provider name provided for {0}{1}", bundleName, msg);
168-
}
169157
this.providerName = providerName;
170158
}
171159

0 commit comments

Comments
 (0)