Fully tested version of dev services for kibana and opensearch dashboards

Author: Javatar81

build-parent/pom.xml

@@ -76,12 +76,13 @@
         <!-- Defaults for integration tests -->
         <elasticsearch-server.version>9.1.5</elasticsearch-server.version>
         <elasticsearch.image>docker.io/elastic/elasticsearch:${elasticsearch-server.version}</elasticsearch.image>
-        <kibana.server.version>docker.io/elastic/kibana:${elasticsearch-server.version}</kibana.server.version>
+        <kibana.image>docker.io/elastic/kibana:${elasticsearch-server.version}</kibana.image>
         <logstash.image>docker.io/elastic/logstash:${elasticsearch-server.version}</logstash.image>
         <kibana.image>docker.io/elastic/kibana:${elasticsearch-server.version}</kibana.image>
         <elasticsearch.protocol>http</elasticsearch.protocol>
         <opensearch-server.version>3.1.0</opensearch-server.version>
         <opensearch.image>docker.io/opensearchproject/opensearch:${opensearch-server.version}</opensearch.image>
+        <opensearch-dashboards.image>docker.io/opensearchproject/opensearch-dashboards:${opensearch-server.version}</opensearch-dashboards.image>
         <opensearch.protocol>http</opensearch.protocol>
         <junit-pioneer.version>2.2.0</junit-pioneer.version>
 

extensions/elasticsearch-rest-client-common/deployment/src/main/java/io/quarkus/elasticsearch/restclient/common/deployment/DevServicesElasticsearchProcessor.java

@@ -2,6 +2,9 @@
 
 import static io.quarkus.devservices.common.ContainerLocator.locateContainerWithLabels;
 
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.UncheckedIOException;
 import java.time.Duration;
 import java.util.Collections;
 import java.util.HashMap;
@@ -10,6 +13,7 @@
 import java.util.Locale;
 import java.util.Map;
 import java.util.Optional;
+import java.util.Properties;
 import java.util.Set;
 import java.util.function.Supplier;
 
@@ -59,19 +63,21 @@ public class DevServicesElasticsearchProcessor {
     static final String DEV_SERVICE_LABEL = "quarkus-dev-service-elasticsearch";
     static final String NEW_DEV_SERVICE_LABEL = "io.quarkus.devservice.elasticsearch";
     static final int ELASTICSEARCH_PORT = 9200;
-    static final int KIBANA_PORT = 5601;
+    static final int DASHBOARD_PORT = 5601;
 
     private static final ContainerLocator elasticsearchContainerLocator = locateContainerWithLabels(ELASTICSEARCH_PORT,
             DEV_SERVICE_LABEL, NEW_DEV_SERVICE_LABEL);
-    private static final ContainerLocator dashboardContainerLocator = locateContainerWithLabels(KIBANA_PORT,
+    private static final ContainerLocator dashboardContainerLocator = locateContainerWithLabels(DASHBOARD_PORT,
             DEV_SERVICE_LABEL, NEW_DEV_SERVICE_LABEL);
 
     private static final Distribution DEFAULT_DISTRIBUTION = Distribution.ELASTIC;
     private static final String DEV_SERVICE_ELASTICSEARCH = "elasticsearch";
-    private static final String DEV_SERVICE_KIBANA = "kibana";
     private static final String DEV_SERVICE_OPENSEARCH = "opensearch";
+    private static final String DEV_SERVICE_DASHBOARDS = "opensearch-dashboards";
+    private static final String DEV_SERVICE_KIBANA = "kibana";
 
     static volatile RunningDevService devService;
+    static volatile RunningDevService devDashboardService;
     static volatile ElasticsearchCommonBuildTimeConfig cfg;
     static volatile boolean first = true;
 
@@ -113,11 +119,11 @@ public DevServicesResultBuildItem startElasticsearchDevService(
                     devServicesSharedNetworkBuildItem);
             devService = startElasticsearchDevServices(dockerStatusBuildItem, composeProjectBuildItem,
                     configuration.devservices(), buildItemsConfig, launchMode, useSharedNetwork, devServicesConfig.timeout());
-            //BS
 
-            startDashboardDevServices(dockerStatusBuildItem, composeProjectBuildItem, configuration.devservices(),
+            devDashboardService = startDashboardDevServices(dockerStatusBuildItem, composeProjectBuildItem,
+                    configuration.devservices(),
                     buildItemsConfig, launchMode, useSharedNetwork, devServicesConfig.timeout());
-            //End BS
+
             if (devService == null) {
                 compressor.closeAndDumpCaptured();
             } else {
@@ -139,6 +145,9 @@ public DevServicesResultBuildItem startElasticsearchDevService(
                 if (devService != null) {
                     shutdownElasticsearch();
                 }
+                if (devDashboardService != null) {
+                    shutdownDashboard();
+                }
                 first = true;
                 devService = null;
                 cfg = null;
@@ -174,6 +183,18 @@ private void shutdownElasticsearch() {
         }
     }
 
+    private void shutdownDashboard() {
+        if (devService != null) {
+            try {
+                devDashboardService.close();
+            } catch (Throwable e) {
+                log.error("Failed to stop the Dashboard", e);
+            } finally {
+                devService = null;
+            }
+        }
+    }
+
     private RunningDevService startElasticsearchDevServices(
             DockerStatusBuildItem dockerStatusBuildItem,
             DevServicesComposeProjectBuildItem composeProjectBuildItem,
@@ -262,7 +283,7 @@ private RunningDevService startDashboardDevServices(
             return null;
         }
 
-        if (!config.kibana().enabled()) {
+        if (!config.dashboard().enabled()) {
             // Kibana explicitly disabled
             log.debug("Not starting Kibana Dev Service, as it has been disabled in the config.");
             return null;
@@ -284,15 +305,15 @@ private RunningDevService startDashboardDevServices(
         }
 
         Distribution resolvedDistribution = resolveDistribution(config, buildItemConfig);
-        DockerImageName resolvedImageName = resolveKibanaImageName(config, resolvedDistribution);
+        DockerImageName resolvedImageName = resolveDashboardImageName(config, resolvedDistribution);
 
         final Optional<ContainerAddress> maybeContainerAddress = dashboardContainerLocator.locateContainer(
                 config.serviceName(),
                 config.shared(),
                 launchMode.getLaunchMode())
                 .or(() -> ComposeLocator.locateContainer(composeProjectBuildItem,
                         List.of(resolvedImageName.getUnversionedPart(), "elasticsearch", "opensearch"),
-                        KIBANA_PORT,
+                        DASHBOARD_PORT,
                         launchMode.getLaunchMode(), useSharedNetwork));
 
         // Starting the server
@@ -302,25 +323,24 @@ private RunningDevService startDashboardDevServices(
             CreatedContainer createdContainer = resolvedDistribution.equals(Distribution.ELASTIC)
                     ? createKibanaContainer(config, resolvedImageName, defaultNetworkId, useSharedNetwork, launchMode,
                             composeProjectBuildItem)
-                    : createKibanaContainer(config, resolvedImageName, defaultNetworkId, useSharedNetwork, launchMode,
+                    : createDashboardsContainer(config, resolvedImageName, defaultNetworkId, useSharedNetwork, launchMode,
                             composeProjectBuildItem);
             GenericContainer<?> container = createdContainer.genericContainer();
 
             if (config.serviceName() != null) {
                 container.withLabel(DEV_SERVICE_LABEL, config.serviceName());
                 container.withLabel(Labels.QUARKUS_DEV_SERVICE, config.serviceName());
             }
-            if (config.port().isPresent()) {
-                //TODO port mapping configuration
-                container.setPortBindings(List.of(KIBANA_PORT + ":" + KIBANA_PORT));
+            if (config.dashboard().port().isPresent()) {
+                container.setPortBindings(List.of(config.dashboard().port().get() + ":" + DASHBOARD_PORT));
             }
             timeout.ifPresent(container::withStartupTimeout);
-            container.withEnv(config.containerEnv());
+            container.withEnv(config.dashboard().containerEnv());
             container.withReuse(config.reuse());
             container.start();
 
             var httpHost = createdContainer.hostName + ":"
-                    + (useSharedNetwork ? KIBANA_PORT : container.getMappedPort(KIBANA_PORT));
+                    + (useSharedNetwork ? DASHBOARD_PORT : container.getMappedPort(DASHBOARD_PORT));
             return new RunningDevService(Feature.ELASTICSEARCH_REST_CLIENT_COMMON.getName(),
                     container.getContainerId(),
                     new ContainerShutdownCloseable(container, "Kibana"),
@@ -389,9 +409,7 @@ private CreatedContainer createKibanaContainer(ElasticsearchDevServicesBuildTime
 
         String kibanaHostName = ConfigureUtil.configureNetwork(container, defaultNetworkId, useSharedNetwork,
                 DEV_SERVICE_KIBANA);
-        String elasticsearchHostName = ConfigureUtil.configureNetwork(container, defaultNetworkId, useSharedNetwork,
-                DEV_SERVICE_ELASTICSEARCH);
-        container.setExposedPorts(List.of(KIBANA_PORT));
+        container.setExposedPorts(List.of(DASHBOARD_PORT));
 
         final Optional<ContainerAddress> maybeContainerAddress = elasticsearchContainerLocator.locateContainer(
                 config.serviceName(),
@@ -407,9 +425,37 @@ private CreatedContainer createKibanaContainer(ElasticsearchDevServicesBuildTime
                         .replace("localhost", "host.docker.internal"))
                 .ifPresent(addressStr -> container.addEnv("ELASTICSEARCH_HOSTS",
                         addressStr));
-        container.addEnv("ELASTICSEARCH_USERNAME", "kibana_system");
-        container.addEnv("ELASTICSEARCH_PASSWORD", "test");
+        container.addEnv("NODE_OPTIONS", config.dashboard().nodeOpts());
+        return new CreatedContainer(container, kibanaHostName);
+    }
+
+    private CreatedContainer createDashboardsContainer(ElasticsearchDevServicesBuildTimeConfig config,
+            DockerImageName resolvedImageName, String defaultNetworkId, boolean useSharedNetwork,
+            LaunchModeBuildItem launchMode, DevServicesComposeProjectBuildItem composeProjectBuildItem) {
+        //Create Generic Kibana container
+        GenericContainer<?> container = new GenericContainer<>(
+                resolvedImageName.asCompatibleSubstituteFor("opensearchproject/opensearch-dashboards"));
+
+        String kibanaHostName = ConfigureUtil.configureNetwork(container, defaultNetworkId, useSharedNetwork,
+                DEV_SERVICE_DASHBOARDS);
+        container.setExposedPorts(List.of(DASHBOARD_PORT));
+
+        final Optional<ContainerAddress> maybeContainerAddress = elasticsearchContainerLocator.locateContainer(
+                config.serviceName(),
+                config.shared(),
+                launchMode.getLaunchMode())
+                .or(() -> ComposeLocator.locateContainer(composeProjectBuildItem,
+                        List.of(resolvedImageName.getUnversionedPart(), "elasticsearch", "opensearch"),
+                        ELASTICSEARCH_PORT,
+                        launchMode.getLaunchMode(), useSharedNetwork));
 
+        maybeContainerAddress
+                .map(containerAddress -> ("http://" + containerAddress.getHost() + ":" + containerAddress.getPort())
+                        .replace("localhost", "host.docker.internal"))
+                .ifPresent(addressStr -> container.addEnv("OPENSEARCH_HOSTS",
+                        addressStr));
+        container.addEnv("NODE_OPTIONS", config.dashboard().nodeOpts());
+        container.addEnv("DISABLE_SECURITY_DASHBOARDS_PLUGIN", "true");
         return new CreatedContainer(container, kibanaHostName);
     }
 
@@ -424,11 +470,27 @@ private DockerImageName resolveImageName(ElasticsearchDevServicesBuildTimeConfig
                         : DEV_SERVICE_OPENSEARCH)));
     }
 
-    private DockerImageName resolveKibanaImageName(ElasticsearchDevServicesBuildTimeConfig config,
+    private DockerImageName resolveDashboardImageName(ElasticsearchDevServicesBuildTimeConfig config,
             Distribution resolvedDistribution) {
-        return DockerImageName.parse("docker.io/elastic/kibana:9.1.5");
-        //return DockerImageName.parse(
-        //        config.imageKibanaName().orElseThrow(() -> new RuntimeException("Image name for Kibana is not configured")));
+        return DockerImageName.parse(config.dashboard().imageName().orElseGet(() -> loadProperties(
+                Distribution.ELASTIC.equals(resolvedDistribution)
+                        ? DEV_SERVICE_ELASTICSEARCH
+                        : DEV_SERVICE_OPENSEARCH)
+                .getProperty("default.dashboard.image")));
+    }
+
+    private static Properties loadProperties(String devserviceName) {
+        var fileName = devserviceName + "-devservice.properties";
+        try (InputStream in = Thread.currentThread().getContextClassLoader().getResourceAsStream(fileName)) {
+            if (in == null) {
+                throw new IllegalArgumentException(fileName + " not found on classpath");
+            }
+            var properties = new Properties();
+            properties.load(in);
+            return properties;
+        } catch (IOException e) {
+            throw new UncheckedIOException(e);
+        }
     }
 
     private Distribution resolveDistribution(ElasticsearchDevServicesBuildTimeConfig config,

extensions/elasticsearch-rest-client-common/deployment/src/main/java/io/quarkus/elasticsearch/restclient/common/deployment/ElasticsearchCommonBuildTimeConfig.java

@@ -35,12 +35,6 @@ interface ElasticsearchDevServicesBuildTimeConfig {
          */
         Optional<Boolean> enabled();
 
-        /**
-         * Kibana configuration for Dev Services.
-         */
-        @ConfigDocSection
-        KibanaDevServicesConfig kibana();
-
         /**
          * Optional fixed port the dev service will listen to.
          * <p>
@@ -151,22 +145,61 @@ interface ElasticsearchDevServicesBuildTimeConfig {
         @WithDefault("true")
         boolean reuse();
 
+        /**
+         * Kibana configuration for Dev Services.
+         */
+        @ConfigDocSection
+        DashboardDevServicesConfig dashboard();
+
         enum Distribution {
             ELASTIC,
             OPENSEARCH
         }
 
         @ConfigGroup
-        interface KibanaDevServicesConfig {
+        interface DashboardDevServicesConfig {
             /**
-             * Whether the Kibana Dev Service should start with the application in dev mode or tests.
+             * Whether the Dashboard Dev Service should start with the application in dev mode or tests.
              * <p>
              * Kibana Dev Services are disabled by default when Elasticsearch Dev Services are enabled.
              *
              * @asciidoclet
              */
             @WithDefault("false")
             boolean enabled();
+
+            /**
+             * Optional fixed port the dev service will listen to.
+             * <p>
+             * If not defined, the port will be chosen randomly.
+             */
+            Optional<Integer> port();
+
+            /**
+             * The Elasticsearch container image to use.
+             *
+             * Defaults depend on the configured `distribution`:
+             *
+             * * For the `elastic` distribution: {kibana-image}
+             * * For the `opensearch` distribution: {dashboardimage}
+             *
+             * @asciidoclet
+             */
+            Optional<String> imageName();
+
+            /**
+             * Environment variables that are passed to the container.
+             */
+            @ConfigDocMapKey("environment-variable-name")
+            Map<String, String> containerEnv();
+
+            /**
+             * The value for the NODE_OPTIONS env variable.
+             *
+             * @asciidoclet
+             */
+            @WithDefault(" ")
+            String nodeOpts();
         }
     }
 }

extensions/elasticsearch-rest-client-common/deployment/src/main/resources/elasticsearch-devservice.properties

@@ -1,2 +1,2 @@
 default.image=${elasticsearch.image}
-default.kibana.image=${kibana.image}
+default.dashboard.image=${kibana.image}

extensions/elasticsearch-rest-client-common/deployment/src/main/resources/opensearch-devservice.properties

@@ -1 +1,2 @@
 default.image=${opensearch.image}
+default.dashboard.image=${opensearch-dashboards.image}