Merge pull request quarkusio#34223 from gsmet/container-env

Provide a way to push env variables to dev services containers

Author: gsmet

extensions/datasource/deployment-spi/src/main/java/io/quarkus/datasource/deployment/spi/DevServicesDatasourceContainerConfig.java

@@ -7,6 +7,7 @@
 public class DevServicesDatasourceContainerConfig {
 
     private final Optional<String> imageName;
+    private final Map<String, String> containerEnv;
     private final Map<String, String> containerProperties;
     private final Map<String, String> additionalJdbcUrlProperties;
     private final OptionalInt fixedExposedPort;
@@ -18,6 +19,7 @@ public class DevServicesDatasourceContainerConfig {
     private final Map<String, String> volumes;
 
     public DevServicesDatasourceContainerConfig(Optional<String> imageName,
+            Map<String, String> containerEnv,
             Map<String, String> containerProperties,
             Map<String, String> additionalJdbcUrlProperties,
             OptionalInt port,
@@ -28,6 +30,7 @@ public DevServicesDatasourceContainerConfig(Optional<String> imageName,
             Optional<String> initScriptPath,
             Map<String, String> volumes) {
         this.imageName = imageName;
+        this.containerEnv = containerEnv;
         this.containerProperties = containerProperties;
         this.additionalJdbcUrlProperties = additionalJdbcUrlProperties;
         this.fixedExposedPort = port;
@@ -43,6 +46,10 @@ public Optional<String> getImageName() {
         return imageName;
     }
 
+    public Map<String, String> getContainerEnv() {
+        return containerEnv;
+    }
+
     public Map<String, String> getContainerProperties() {
         return containerProperties;
     }

extensions/datasource/deployment/src/main/java/io/quarkus/datasource/deployment/devservices/DevServicesDatasourceProcessor.java

@@ -276,6 +276,7 @@ private RunningDevService startDevDb(
         try {
             DevServicesDatasourceContainerConfig containerConfig = new DevServicesDatasourceContainerConfig(
                     dataSourceBuildTimeConfig.devservices.imageName,
+                    dataSourceBuildTimeConfig.devservices.containerEnv,
                     dataSourceBuildTimeConfig.devservices.containerProperties,
                     dataSourceBuildTimeConfig.devservices.properties,
                     dataSourceBuildTimeConfig.devservices.port,

extensions/datasource/runtime/src/main/java/io/quarkus/datasource/runtime/DevServicesBuildTimeConfig.java

@@ -28,6 +28,12 @@ public class DevServicesBuildTimeConfig {
     @ConfigItem
     public Optional<String> imageName;
 
+    /**
+     * Environment variables that are passed to the container.
+     */
+    @ConfigItem
+    public Map<String, String> containerEnv;
+
     /**
      * Generic properties that are passed for additional container configuration.
      * <p>

extensions/devservices/db2/src/main/java/io/quarkus/devservices/db2/deployment/DB2DevServicesProcessor.java

@@ -53,6 +53,8 @@ public RunningDevServicesDatasource startDatabase(Optional<String> username, Opt
                 Labels.addDataSourceLabel(container, datasourceName);
                 Volumes.addVolumes(container, containerConfig.getVolumes());
 
+                container.withEnv(containerConfig.getContainerEnv());
+
                 containerConfig.getAdditionalJdbcUrlProperties().forEach(container::withUrlParam);
                 containerConfig.getCommand().ifPresent(container::setCommand);
                 containerConfig.getInitScriptPath().ifPresent(container::withInitScript);

extensions/devservices/mariadb/src/main/java/io/quarkus/devservices/mariadb/deployment/MariaDBDevServicesProcessor.java

@@ -36,6 +36,7 @@ public class MariaDBDevServicesProcessor {
     DevServicesDatasourceProviderBuildItem setupMariaDB(
             List<DevServicesSharedNetworkBuildItem> devServicesSharedNetworkBuildItem) {
         return new DevServicesDatasourceProviderBuildItem(DatabaseKind.MARIADB, new DevServicesDatasourceProvider() {
+            @SuppressWarnings("unchecked")
             @Override
             public RunningDevServicesDatasource startDatabase(Optional<String> username, Optional<String> password,
                     Optional<String> datasourceName, DevServicesDatasourceContainerConfig containerConfig,
@@ -56,6 +57,8 @@ public RunningDevServicesDatasource startDatabase(Optional<String> username, Opt
                 Labels.addDataSourceLabel(container, datasourceName);
                 Volumes.addVolumes(container, containerConfig.getVolumes());
 
+                container.withEnv(containerConfig.getContainerEnv());
+
                 if (containerConfig.getContainerProperties().containsKey(MY_CNF_CONFIG_OVERRIDE_PARAM_NAME)) {
                     container.withConfigurationOverride(
                             containerConfig.getContainerProperties().get(MY_CNF_CONFIG_OVERRIDE_PARAM_NAME));

extensions/devservices/mssql/src/main/java/io/quarkus/devservices/mssql/deployment/MSSQLDevServicesProcessor.java

@@ -27,10 +27,16 @@ public class MSSQLDevServicesProcessor {
 
     private static final Logger LOG = Logger.getLogger(MSSQLDevServicesProcessor.class);
 
+    /**
+     * Using SA doesn't work with all collations so let's use the lowercase version instead.
+     */
+    private static final String DEFAULT_USERNAME = "sa";
+
     @BuildStep
     DevServicesDatasourceProviderBuildItem setupMSSQL(
             List<DevServicesSharedNetworkBuildItem> devServicesSharedNetworkBuildItem) {
         return new DevServicesDatasourceProviderBuildItem(DatabaseKind.MSSQL, new DevServicesDatasourceProvider() {
+            @SuppressWarnings("unchecked")
             @Override
             public RunningDevServicesDatasource startDatabase(Optional<String> username, Optional<String> password,
                     Optional<String> datasourceName, DevServicesDatasourceContainerConfig containerConfig,
@@ -49,6 +55,8 @@ public RunningDevServicesDatasource startDatabase(Optional<String> username, Opt
                 Labels.addDataSourceLabel(container, datasourceName);
                 Volumes.addVolumes(container, containerConfig.getVolumes());
 
+                container.withEnv(containerConfig.getContainerEnv());
+
                 containerConfig.getAdditionalJdbcUrlProperties().forEach(container::withUrlParam);
                 containerConfig.getCommand().ifPresent(container::setCommand);
                 containerConfig.getInitScriptPath().ifPresent(container::withInitScript);
@@ -60,7 +68,7 @@ public RunningDevServicesDatasource startDatabase(Optional<String> username, Opt
                 return new RunningDevServicesDatasource(container.getContainerId(),
                         container.getEffectiveJdbcUrl(),
                         container.getReactiveUrl(),
-                        container.getUsername(),
+                        DEFAULT_USERNAME,
                         container.getPassword(),
                         new ContainerShutdownCloseable(container, "Microsoft SQL Server"));
             }

extensions/devservices/mysql/src/main/java/io/quarkus/devservices/mysql/deployment/MySQLDevServicesProcessor.java

@@ -35,6 +35,7 @@ public class MySQLDevServicesProcessor {
     DevServicesDatasourceProviderBuildItem setupMysql(
             List<DevServicesSharedNetworkBuildItem> devServicesSharedNetworkBuildItem) {
         return new DevServicesDatasourceProviderBuildItem(DatabaseKind.MYSQL, new DevServicesDatasourceProvider() {
+            @SuppressWarnings("unchecked")
             @Override
             public RunningDevServicesDatasource startDatabase(Optional<String> username, Optional<String> password,
                     Optional<String> datasourceName, DevServicesDatasourceContainerConfig containerConfig,
@@ -55,6 +56,8 @@ public RunningDevServicesDatasource startDatabase(Optional<String> username, Opt
                 Labels.addDataSourceLabel(container, datasourceName);
                 Volumes.addVolumes(container, containerConfig.getVolumes());
 
+                container.withEnv(containerConfig.getContainerEnv());
+
                 if (containerConfig.getContainerProperties().containsKey(MY_CNF_CONFIG_OVERRIDE_PARAM_NAME)) {
                     container.withConfigurationOverride(
                             containerConfig.getContainerProperties().get(MY_CNF_CONFIG_OVERRIDE_PARAM_NAME));

extensions/devservices/oracle/src/main/java/io/quarkus/devservices/oracle/deployment/OracleDevServicesProcessor.java

@@ -60,6 +60,8 @@ public RunningDevServicesDatasource startDatabase(Optional<String> username, Opt
                 Labels.addDataSourceLabel(container, datasourceName);
                 Volumes.addVolumes(container, containerConfig.getVolumes());
 
+                container.withEnv(containerConfig.getContainerEnv());
+
                 // We need to limit the maximum amount of CPUs being used by the container;
                 // otherwise the hardcoded memory configuration of the DB might not be enough to successfully boot it.
                 // See https://github.com/gvenzl/oci-oracle-xe/issues/64

extensions/devservices/postgresql/src/main/java/io/quarkus/devservices/postgresql/deployment/PostgresqlDevServicesProcessor.java

@@ -42,6 +42,7 @@ ConsoleCommandBuildItem psqlCommand(DevServicesLauncherConfigResultBuildItem dev
     DevServicesDatasourceProviderBuildItem setupPostgres(
             List<DevServicesSharedNetworkBuildItem> devServicesSharedNetworkBuildItem) {
         return new DevServicesDatasourceProviderBuildItem(DatabaseKind.POSTGRESQL, new DevServicesDatasourceProvider() {
+            @SuppressWarnings("unchecked")
             @Override
             public RunningDevServicesDatasource startDatabase(Optional<String> username, Optional<String> password,
                     Optional<String> datasourceName, DevServicesDatasourceContainerConfig containerConfig,
@@ -62,6 +63,8 @@ public RunningDevServicesDatasource startDatabase(Optional<String> username, Opt
                 Labels.addDataSourceLabel(container, datasourceName);
                 Volumes.addVolumes(container, containerConfig.getVolumes());
 
+                container.withEnv(containerConfig.getContainerEnv());
+
                 containerConfig.getAdditionalJdbcUrlProperties().forEach(container::withUrlParam);
                 containerConfig.getCommand().ifPresent(container::setCommand);
                 containerConfig.getInitScriptPath().ifPresent(container::withInitScript);

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

@@ -207,6 +207,8 @@ private DevServicesResultBuildItem.RunningDevService startElasticsearch(
                 container.setPortBindings(List.of(config.port.get() + ":" + config.port.get()));
             }
             timeout.ifPresent(container::withStartupTimeout);
+
+            container.withEnv(config.containerEnv);
             container.addEnv("ES_JAVA_OPTS", config.javaOpts);
             // Disable security as else we would need to configure it correctly to avoid tons of WARNING in the log
             container.addEnv("xpack.security.enabled", "false");