Allow registry offering configuration with an environment variable

(cherry picked from commit 2c3f9ad)

Author: aloubyansky

docs/src/main/asciidoc/extension-registry-user.adoc

@@ -214,3 +214,26 @@ image:registry-nexus-repository.png[Nexus Repository Proxy]
 - Set the `Remote Storage` URL to `https://registry.quarkus.io/maven`
 
 image:registry-nexus3-repository.png[Nexus Repository Proxy]
+
+==== Environment Variables
+
+Applications using a registry client can be configured using environment variables.
+
+`QUARKUS_REGISTRIES` environment variable can be used to specify which registries should be enabled as a comma-separated list of registry IDs.
+For example
+```
+QUARKUS_REGISTRIES=registry.acme.org,registry.quarkus.io
+```
+That alone will be enough to initialize a registry client to pull extension catalogs from two registries using their default configurations.
+
+Certain registry options could be initialized with their specific environment variables. Each such option will have the following environment variable prefix:
+```
+QUARKUS_REGISTRY_<UPPERCASED_AND_UNDERSCORED_REGISTRY_ID>_
+```
+where `<UPPERCASED_AND_UNDERSCORED_REGISTRY_ID>` is a registry ID with each character converted to uppercase and a `.` replaced with `_`. For example, `REGISTRY_ACME_ORG`.
+
+The following options can be configured with this approach:
+
+- Repository URL, for example `QUARKUS_REGISTRY_REGISTRY_ACME_ORG_REPO_URL=https://internal.registry.acme.org/maven`
+- Update policy, for example `QUARKUS_REGISTRY_REGISTRY_ACME_ORG_UPDATE_POLICY=always`
+- Offering, for example `QUARKUS_REGISTRY_REGISTRY_ACME_ORG_OFFERING=acme-magic`

independent-projects/tools/registry-client/src/main/java/io/quarkus/registry/client/maven/MavenRegistryClientFactory.java

@@ -57,15 +57,7 @@ public MavenRegistryClientFactory(MavenArtifactResolver resolver, MessageWriter
     public RegistryClient buildRegistryClient(RegistryConfig config) throws RegistryResolutionException {
         Objects.requireNonNull(config, "The registry config is null");
 
-        final RegistryDescriptorConfig descriptorConfig = config.getDescriptor();
-        if (descriptorConfig == null) {
-            throw new IllegalArgumentException("The registry descriptor configuration is missing for " + config.getId());
-        }
-
-        final ArtifactCoords originalDescrCoords = descriptorConfig.getArtifact();
-        final Artifact registryDescriptorCoords = new DefaultArtifact(originalDescrCoords.getGroupId(),
-                originalDescrCoords.getArtifactId(), originalDescrCoords.getClassifier(), originalDescrCoords.getType(),
-                originalDescrCoords.getVersion());
+        final Artifact registryDescriptorCoords = getDescriptorCoords(config);
 
         final boolean cleanupTimestampedArtifacts = isCleanupTimestampedArtifacts(config);
 
@@ -172,6 +164,17 @@ public RegistryClient buildRegistryClient(RegistryConfig config) throws Registry
                 new MavenRegistryCache(config, defaultResolver, log));
     }
 
+    private static Artifact getDescriptorCoords(RegistryConfig config) {
+        final RegistryDescriptorConfig descriptorConfig = config.getDescriptor();
+        if (descriptorConfig == null) {
+            throw new IllegalArgumentException("The registry descriptor configuration is missing for " + config.getId());
+        }
+        final ArtifactCoords originalDescrCoords = descriptorConfig.getArtifact();
+        return new DefaultArtifact(originalDescrCoords.getGroupId(),
+                originalDescrCoords.getArtifactId(), originalDescrCoords.getClassifier(), originalDescrCoords.getType(),
+                originalDescrCoords.getVersion());
+    }
+
     private static boolean isCleanupTimestampedArtifacts(RegistryConfig config) {
         final Object o = config.getExtra().get(CLEANUP_TIMESTAMPED_ARTIFACTS);
         return o == null || Boolean.parseBoolean(o.toString());

independent-projects/tools/registry-client/src/main/java/io/quarkus/registry/config/RegistriesConfigLocator.java

@@ -8,6 +8,8 @@
 import java.nio.file.Paths;
 import java.util.Map;
 
+import io.quarkus.registry.Constants;
+
 /**
  * A helper class set utility methods to locate the registry client configuration file
  * in the default locations (e.g. user home <code>.quarkus</code> dir, or the project dir) or in
@@ -188,6 +190,8 @@ static RegistriesConfig initFromEnvironmentOrNull(Map<String, String> map) {
                                     .setUrl(var.getValue())
                                     .build())
                             .build());
+                } else if (isEnvVarOption(var.getKey(), envvarPrefix, "OFFERING")) {
+                    builder.setExtra(Map.of(Constants.OFFERING, var.getValue()));
                 }
             }
 

independent-projects/tools/registry-client/src/test/java/io/quarkus/registry/config/RegistriesConfigLocatorTest.java

@@ -4,13 +4,13 @@
 
 import java.io.StringReader;
 import java.io.StringWriter;
-import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
 
 import org.junit.jupiter.api.Test;
 
 import io.quarkus.maven.dependency.ArtifactCoords;
+import io.quarkus.registry.Constants;
 
 public class RegistriesConfigLocatorTest {
 
@@ -36,7 +36,7 @@ void configCompletion() throws Exception {
 
     @Test
     void testSimpleRegistryListFromEnvironment() throws Exception {
-        final Map<String, String> env = Collections.singletonMap(RegistriesConfigLocator.QUARKUS_REGISTRIES,
+        final Map<String, String> env = Map.of(RegistriesConfigLocator.QUARKUS_REGISTRIES,
                 "registry.acme.org,registry.other.io");
 
         final RegistriesConfig actualConfig = RegistriesConfigLocator.initFromEnvironmentOrNull(env);
@@ -135,6 +135,32 @@ void testRegistryRepositoryURLFromEnvironment() throws Exception {
         assertThat(completeConfig).isEqualTo(expectedConfig);
     }
 
+    @Test
+    void testRegistryOfferingFromEnvironment() throws Exception {
+        final Map<String, String> env = new HashMap<>();
+        env.put(RegistriesConfigLocator.QUARKUS_REGISTRIES, "registry.acme.org,registry.other.io");
+        env.put(RegistriesConfigLocator.QUARKUS_REGISTRY_ENV_VAR_PREFIX + "REGISTRY_ACME_ORG_OFFERING", "acme-magic");
+        env.put(RegistriesConfigLocator.QUARKUS_REGISTRY_ENV_VAR_PREFIX + "REGISTRY_OTHER_IO_OFFERING", "other-cloud");
+
+        final RegistriesConfig actualConfig = RegistriesConfigLocator.initFromEnvironmentOrNull(env);
+
+        final RegistriesConfig expectedConfig = RegistriesConfig.builder()
+                .setRegistry(RegistryConfig.builder()
+                        .setId("registry.acme.org")
+                        .setExtra(Constants.OFFERING, "acme-magic")
+                        .build())
+                .setRegistry(RegistryConfig.builder()
+                        .setId("registry.other.io")
+                        .setExtra(Constants.OFFERING, "other-cloud")
+                        .build())
+                .build();
+
+        assertThat(actualConfig).isEqualTo(expectedConfig);
+
+        final RegistriesConfig completeConfig = serializeDeserialize(actualConfig);
+        assertThat(completeConfig).isEqualTo(expectedConfig);
+    }
+
     private static RegistriesConfig serializeDeserialize(RegistriesConfig config) throws Exception {
         final StringWriter buf = new StringWriter();
         RegistriesConfigMapperHelper.toYaml(config, buf);