Dev console and UI for listing dev services

quarkusio · Jan 20, 2022 · 742a6b7 · 742a6b7
1 parent 0ffce57
commit 742a6b7
Show file tree

Hide file tree

Showing 58 changed files with 1,235 additions and 632 deletions.
diff --git a/bom/application/pom.xml b/bom/application/pom.xml
@@ -633,6 +633,16 @@
                 <artifactId>quarkus-devservices-common</artifactId>
                 <version>${project.version}</version>
             </dependency>
+            <dependency>
+                <groupId>io.quarkus</groupId>
+                <artifactId>quarkus-devservices-deployment</artifactId>
+                <version>${project.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>io.quarkus</groupId>
+                <artifactId>quarkus-devservices</artifactId>
+                <version>${project.version}</version>
+            </dependency>
             <dependency>
                 <groupId>io.quarkus</groupId>
                 <artifactId>quarkus-elasticsearch-rest-client-common</artifactId>

diff --git a/...yment/src/main/java/io/quarkus/deployment/builditem/DevServicesConfigResultBuildItem.java b/...yment/src/main/java/io/quarkus/deployment/builditem/DevServicesConfigResultBuildItem.java
@@ -8,7 +8,10 @@
  * Used to start and configure dev services, any processor starting dev services should produce these items.
  *
  * Quarkus will make sure the relevant settings are present in both JVM and native modes.
+ *
+ * @deprecated use {@link DevServicesResultBuildItem}
  */
+@Deprecated
 public final class DevServicesConfigResultBuildItem extends MultiBuildItem {
 
     final String key;

diff --git a/.../deployment/src/main/java/io/quarkus/deployment/builditem/DevServicesResultBuildItem.java b/.../deployment/src/main/java/io/quarkus/deployment/builditem/DevServicesResultBuildItem.java
@@ -0,0 +1,91 @@
+package io.quarkus.deployment.builditem;
+
+import java.io.Closeable;
+import java.io.IOException;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
+
+import io.quarkus.builder.item.MultiBuildItem;
+
+/**
+ * TODO
+ */
+public final class DevServicesResultBuildItem extends MultiBuildItem {
+
+    private final String name;
+    private final String containerId;
+    private final Map<String, String> config;
+
+    public DevServicesResultBuildItem(String name, String containerId, Map<String, String> config) {
+        this.name = name;
+        this.containerId = containerId;
+        this.config = config;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public String getContainerId() {
+        return containerId;
+    }
+
+    public Map<String, String> getConfig() {
+        return config;
+    }
+
+    public static class RunningDevService implements Closeable {
+
+        private final String name;
+        private final String containerId;
+        private final Map<String, String> config;
+        private final Closeable closeable;
+
+        private static Map<String, String> mapOf(String key, String value) {
+            Map<String, String> map = new HashMap<>();
+            map.put(key, value);
+            return map;
+        }
+
+        public RunningDevService(String name, String containerId, Closeable closeable, String key, String value) {
+            this(name, containerId, closeable, mapOf(key, value));
+        }
+
+        public RunningDevService(String name, String containerId, Closeable closeable, Map<String, String> config) {
+            this.name = name;
+            this.containerId = containerId;
+            this.closeable = closeable;
+            this.config = Collections.unmodifiableMap(config);
+        }
+
+        public String getName() {
+            return name;
+        }
+
+        public String getContainerId() {
+            return containerId;
+        }
+
+        public Map<String, String> getConfig() {
+            return config;
+        }
+
+        public Closeable getCloseable() {
+            return closeable;
+        }
+
+        public boolean isOwner() {
+            return closeable != null;
+        }
+
+        @Override
+        public void close() throws IOException {
+            this.closeable.close();
+        }
+
+        public DevServicesResultBuildItem toBuildItem() {
+            return new DevServicesResultBuildItem(name, containerId, config);
+        }
+    }
+}
diff --git a/core/deployment/src/main/java/io/quarkus/deployment/steps/DevServicesConfigBuildStep.java b/core/deployment/src/main/java/io/quarkus/deployment/steps/DevServicesConfigBuildStep.java
@@ -16,6 +16,7 @@
 import io.quarkus.deployment.builditem.DevServicesConfigResultBuildItem;
 import io.quarkus.deployment.builditem.DevServicesLauncherConfigResultBuildItem;
 import io.quarkus.deployment.builditem.DevServicesNativeConfigResultBuildItem;
+import io.quarkus.deployment.builditem.DevServicesResultBuildItem;
 import io.quarkus.deployment.builditem.RunTimeConfigurationDefaultBuildItem;
 import io.quarkus.deployment.builditem.ServiceStartBuildItem;
 
@@ -32,9 +33,13 @@ List<DevServicesConfigResultBuildItem> deprecated(List<DevServicesNativeConfigRe
     @Produce(ServiceStartBuildItem.class)
     DevServicesLauncherConfigResultBuildItem setup(BuildProducer<RunTimeConfigurationDefaultBuildItem> runtimeConfig,
             List<DevServicesConfigResultBuildItem> devServicesConfigResultBuildItems,
+            List<DevServicesResultBuildItem> devServicesResultBuildItems,
             CuratedApplicationShutdownBuildItem shutdownBuildItem) {
         Map<String, String> newProperties = new HashMap<>(devServicesConfigResultBuildItems.stream().collect(
                 Collectors.toMap(DevServicesConfigResultBuildItem::getKey, DevServicesConfigResultBuildItem::getValue)));
+        for (DevServicesResultBuildItem resultBuildItem : devServicesResultBuildItems) {
+            newProperties.putAll(resultBuildItem.getConfig());
+        }
         Config config = ConfigProvider.getConfig();
         //check if there are existing already started dev services
         //if there were no changes to the processors they don't produce config

diff --git a/extensions/apicurio-registry-avro/deployment/pom.xml b/extensions/apicurio-registry-avro/deployment/pom.xml
@@ -49,7 +49,7 @@
         </dependency>
         <dependency>
             <groupId>io.quarkus</groupId>
-            <artifactId>quarkus-devservices-common</artifactId>
+            <artifactId>quarkus-devservices-deployment</artifactId>
         </dependency>
 
         <dependency>

diff --git a/...src/main/java/io/quarkus/apicurio/registry/avro/DevServicesApicurioRegistryProcessor.java b/...src/main/java/io/quarkus/apicurio/registry/avro/DevServicesApicurioRegistryProcessor.java
@@ -11,12 +11,13 @@
 import org.testcontainers.containers.GenericContainer;
 import org.testcontainers.utility.DockerImageName;
 
+import io.quarkus.deployment.Feature;
 import io.quarkus.deployment.IsDockerWorking;
 import io.quarkus.deployment.IsNormal;
-import io.quarkus.deployment.annotations.BuildProducer;
 import io.quarkus.deployment.annotations.BuildStep;
 import io.quarkus.deployment.builditem.CuratedApplicationShutdownBuildItem;
-import io.quarkus.deployment.builditem.DevServicesConfigResultBuildItem;
+import io.quarkus.deployment.builditem.DevServicesResultBuildItem;
+import io.quarkus.deployment.builditem.DevServicesResultBuildItem.RunningDevService;
 import io.quarkus.deployment.builditem.DevServicesSharedNetworkBuildItem;
 import io.quarkus.deployment.builditem.LaunchModeBuildItem;
 import io.quarkus.deployment.console.ConsoleInstalledBuildItem;
@@ -50,56 +51,50 @@ public class DevServicesApicurioRegistryProcessor {
     private static final ContainerLocator apicurioRegistryContainerLocator = new ContainerLocator(DEV_SERVICE_LABEL,
             APICURIO_REGISTRY_PORT);
 
-    static volatile AutoCloseable closeable;
+    static volatile RunningDevService devService;
     static volatile ApicurioRegistryDevServiceCfg cfg;
     static volatile boolean first = true;
 
     private final IsDockerWorking isDockerWorking = new IsDockerWorking(true);
 
     @BuildStep(onlyIfNot = IsNormal.class, onlyIf = GlobalDevServicesConfig.Enabled.class)
-    public void startApicurioRegistryDevService(LaunchModeBuildItem launchMode,
+    public DevServicesResultBuildItem startApicurioRegistryDevService(LaunchModeBuildItem launchMode,
             ApicurioRegistryDevServicesBuildTimeConfig apicurioRegistryDevServices,
             List<DevServicesSharedNetworkBuildItem> devServicesSharedNetworkBuildItem,
-            BuildProducer<DevServicesConfigResultBuildItem> devServicesConfiguration,
             Optional<ConsoleInstalledBuildItem> consoleInstalledBuildItem,
             CuratedApplicationShutdownBuildItem closeBuildItem,
             LoggingSetupBuildItem loggingSetupBuildItem, GlobalDevServicesConfig devServicesConfig) {
 
         ApicurioRegistryDevServiceCfg configuration = getConfiguration(apicurioRegistryDevServices);
 
-        if (closeable != null) {
+        if (devService != null) {
             boolean restartRequired = !configuration.equals(cfg);
             if (!restartRequired) {
-                return;
+                return devService.toBuildItem();
             }
             shutdownApicurioRegistry();
             cfg = null;
         }
-        ApicurioRegistry apicurioRegistry;
         StartupLogCompressor compressor = new StartupLogCompressor(
                 (launchMode.isTest() ? "(test) " : "") + "Apicurio Registry Dev Services Starting:",
                 consoleInstalledBuildItem, loggingSetupBuildItem);
         try {
-            apicurioRegistry = startApicurioRegistry(configuration, launchMode,
+            devService = startApicurioRegistry(configuration, launchMode,
                     !devServicesSharedNetworkBuildItem.isEmpty(), devServicesConfig.timeout);
-            if (apicurioRegistry == null) {
-                compressor.close();
-                return;
-            }
             compressor.close();
         } catch (Throwable t) {
             compressor.closeAndDumpCaptured();
             throw new RuntimeException(t);
         }
 
-        cfg = configuration;
-        closeable = apicurioRegistry.getCloseable();
+        if (devService == null) {
+            return null;
+        }
 
-        devServicesConfiguration.produce(new DevServicesConfigResultBuildItem(
-                REGISTRY_URL_CONFIG, apicurioRegistry.getUrl() + "/apis/registry/v2"));
+        cfg = configuration;
 
-        if (apicurioRegistry.isOwner()) {
-            log.infof("Dev Services for Apicurio Registry started. The registry is available at %s", apicurioRegistry.getUrl());
+        if (devService.isOwner()) {
+            log.infof("Dev Services for Apicurio Registry started. The registry is available at %s", getRegistryUrlConfig());
         }
 
         // Configure the watch dog
@@ -108,31 +103,36 @@ public void startApicurioRegistryDevService(LaunchModeBuildItem launchMode,
             Runnable closeTask = new Runnable() {
                 @Override
                 public void run() {
-                    if (closeable != null) {
+                    if (devService != null) {
                         shutdownApicurioRegistry();
                     }
                     first = true;
-                    closeable = null;
+                    devService = null;
                     cfg = null;
                 }
             };
             closeBuildItem.addCloseTask(closeTask, true);
         }
+        return devService.toBuildItem();
+    }
+
+    private String getRegistryUrlConfig() {
+        return devService.getConfig().get(REGISTRY_URL_CONFIG) + "/apis/registry/v2";
     }
 
     private void shutdownApicurioRegistry() {
-        if (closeable != null) {
+        if (devService != null) {
             try {
-                closeable.close();
+                devService.close();
             } catch (Throwable e) {
                 log.error("Failed to stop Apicurio Registry", e);
             } finally {
-                closeable = null;
+                devService = null;
             }
         }
     }
 
-    private ApicurioRegistry startApicurioRegistry(ApicurioRegistryDevServiceCfg config, LaunchModeBuildItem launchMode,
+    private RunningDevService startApicurioRegistry(ApicurioRegistryDevServiceCfg config, LaunchModeBuildItem launchMode,
             boolean useSharedNetwork, Optional<Duration> timeout) {
         if (!config.devServicesEnabled) {
             // explicitly disabled
@@ -157,7 +157,8 @@ private ApicurioRegistry startApicurioRegistry(ApicurioRegistryDevServiceCfg con
 
         // Starting the broker
         return apicurioRegistryContainerLocator.locateContainer(config.serviceName, config.shared, launchMode.getLaunchMode())
-                .map(containerAddress -> new ApicurioRegistry(containerAddress.getUrl(), null))
+                .map(containerAddress -> new RunningDevService(Feature.APICURIO_REGISTRY_AVRO.getName(),
+                        containerAddress.getId(), null, REGISTRY_URL_CONFIG, containerAddress.getUrl()))
                 .orElseGet(() -> {
                     ApicurioRegistryContainer container = new ApicurioRegistryContainer(
                             DockerImageName.parse(config.imageName), config.fixedExposedPort,
@@ -166,7 +167,8 @@ private ApicurioRegistry startApicurioRegistry(ApicurioRegistryDevServiceCfg con
                     timeout.ifPresent(container::withStartupTimeout);
                     container.start();
 
-                    return new ApicurioRegistry(container.getUrl(), container);
+                    return new RunningDevService(Feature.APICURIO_REGISTRY_AVRO.getName(), container.getContainerId(),
+                            container::close, REGISTRY_URL_CONFIG, container.getUrl());
                 });
     }
 
@@ -193,28 +195,6 @@ private ApicurioRegistryDevServiceCfg getConfiguration(ApicurioRegistryDevServic
         return new ApicurioRegistryDevServiceCfg(cfg);
     }
 
-    private static class ApicurioRegistry {
-        private final String url;
-        private final AutoCloseable closeable;
-
-        public ApicurioRegistry(String url, AutoCloseable closeable) {
-            this.url = url;
-            this.closeable = closeable;
-        }
-
-        public String getUrl() {
-            return url;
-        }
-
-        public AutoCloseable getCloseable() {
-            return closeable;
-        }
-
-        public boolean isOwner() {
-            return closeable != null;
-        }
-    }
-
     private static final class ApicurioRegistryDevServiceCfg {
         private final boolean devServicesEnabled;
         private final String imageName;

diff --git a/extensions/apicurio-registry-avro/runtime/pom.xml b/extensions/apicurio-registry-avro/runtime/pom.xml
@@ -51,6 +51,10 @@
         <groupId>org.apache.commons</groupId>
         <artifactId>commons-lang3</artifactId>
       </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-devservices</artifactId>
+        </dependency>
     </dependencies>
 
     <build>

diff --git a/...spi/src/main/java/io/quarkus/datasource/deployment/spi/DevServicesDatasourceProvider.java b/...spi/src/main/java/io/quarkus/datasource/deployment/spi/DevServicesDatasourceProvider.java
@@ -23,18 +23,24 @@ default boolean isDockerRequired() {
 
     class RunningDevServicesDatasource {
 
+        private final String id;
         private final String url;
         private final String username;
         private final String password;
         private final Closeable closeTask;
 
-        public RunningDevServicesDatasource(String url, String username, String password, Closeable closeTask) {
+        public RunningDevServicesDatasource(String id, String url, String username, String password, Closeable closeTask) {
+            this.id = id;
             this.url = url;
             this.username = username;
             this.password = password;
             this.closeTask = closeTask;
         }
 
+        public String getId() {
+            return id;
+        }
+
         public String getUrl() {
             return url;
         }