Make test resource config override dev service config (and system properties)

Author: holly-cummins

core/deployment/src/main/java/io/quarkus/deployment/builditem/DevServicesResultBuildItem.java

@@ -174,9 +174,6 @@ public Map<String, Function<Startable, String>> getApplicationConfigProvider() {
 
     public Map<String, String> getConfig(Startable startable) {
         SupplierMap<String, String> map = new SupplierMap<>();
-        if (config != null && !config.isEmpty()) {
-            map.putAll(config);
-        }
         for (Map.Entry<String, Function<Startable, String>> entry : applicationConfigProvider.entrySet()) {
             map.put(entry.getKey(), () -> entry.getValue().apply(startable));
         }

core/runtime/src/main/java/io/quarkus/devservice/runtime/config/DevServicesConfigBuilder.java

@@ -14,11 +14,6 @@ public SmallRyeConfigBuilder configBuilder(SmallRyeConfigBuilder builder) {
 
     @Override
     public int priority() {
-        // What's the right priority? This is a cheeky dynamic override, so a high priority seems correct, but dev services are supposed to fill in gaps in existing information.
-        // Dev services should be looking at those sources and not doing anything if there's existing config,
-        // so a very low priority is also arguably correct.
-        // In principle the priority actually shouldn't matter much, but in practice it needs to not be higher than Arquillian config overrides or some tests fail
-
         return 10;
     }
 }

core/runtime/src/main/java/io/quarkus/devservice/runtime/config/DevServicesConfigSource.java

@@ -56,7 +56,7 @@ public String getName() {
 
     @Override
     public int getOrdinal() {
-        // See discussion on DevServicesConfigBuilder about what the right value here is
-        return 10;
+        // This is a dynamic override, so it needs a high priority to be able to override ephemeral port (0) with real values
+        return 410; // a bit more than system properties, but less than the TestResource config overrides done via RuntimeOverrideConfigSource
     }
 }

core/runtime/src/main/java/io/quarkus/runtime/configuration/RuntimeOverrideConfigSource.java

@@ -49,7 +49,7 @@ public Set<String> getPropertyNames() {
 
     @Override
     public int getOrdinal() {
-        return 399; //one less that system properties
+        return 420; // higher than dev services config source
     }
 
     @Override

devtools/gradle/gradle-application-plugin/src/main/java/io/quarkus/gradle/tasks/EffectiveConfig.java

@@ -49,6 +49,8 @@ private EffectiveConfig(Builder builder) {
         // (see also https://quarkus.io/guides/config-reference#configuration-sources)
         // 600 -> forcedProperties
         // 500 -> taskProperties
+        // 420 -> RuntimeOverride (used by TestResource and other Startup actions)
+        // 410 -> Dev Service overrides
         // 400 -> System.getProperties() (provided by default sources)
         // 300 -> System.getenv() (provided by default sources)
         // 290 -> quarkusBuildProperties

extensions/amazon-lambda/common-deployment/pom.xml

@@ -39,6 +39,10 @@
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-amazon-lambda-event-server</artifactId>
         </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-devservices-deployment</artifactId>
+        </dependency>
         <dependency>
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-junit5-internal</artifactId>

extensions/amazon-lambda/common-deployment/src/main/java/io/quarkus/amazon/lambda/deployment/DevServicesLambdaProcessor.java

@@ -2,10 +2,9 @@
 
 import static io.quarkus.deployment.annotations.ExecutionTime.STATIC_INIT;
 
-import java.util.HashMap;
+import java.io.IOException;
 import java.util.Map;
 import java.util.Optional;
-import java.util.function.Supplier;
 
 import org.jboss.logging.Logger;
 
@@ -18,18 +17,15 @@
 import io.quarkus.deployment.annotations.BuildStep;
 import io.quarkus.deployment.annotations.Produce;
 import io.quarkus.deployment.annotations.Record;
-import io.quarkus.deployment.builditem.CuratedApplicationShutdownBuildItem;
 import io.quarkus.deployment.builditem.DevServicesResultBuildItem;
 import io.quarkus.deployment.builditem.LaunchModeBuildItem;
 import io.quarkus.deployment.builditem.ServiceStartBuildItem;
+import io.quarkus.deployment.builditem.Startable;
 import io.quarkus.runtime.LaunchMode;
 
 public class DevServicesLambdaProcessor {
     private static final Logger log = Logger.getLogger(DevServicesLambdaProcessor.class);
 
-    static MockEventServer server;
-    static LaunchMode startMode;
-
     @BuildStep(onlyIfNot = IsNormal.class)
     @Record(STATIC_INIT)
     public void enableHotReplacementChecker(LaunchModeBuildItem launchMode,
@@ -53,61 +49,81 @@ private boolean legacyTestingEnabled() {
 
     @Produce(ServiceStartBuildItem.class)
     @BuildStep(onlyIfNot = IsNormal.class) // This is required for testing so run it even if devservices.enabled=false
-    public void startEventServer(LaunchModeBuildItem launchMode,
+    public void startEventServer(LaunchModeBuildItem launchModeBuildItem,
             LambdaConfig config,
             Optional<EventServerOverrideBuildItem> override,
-            BuildProducer<DevServicesResultBuildItem> devServicePropertiesProducer,
-            CuratedApplicationShutdownBuildItem closeBuildItem)
-            throws Exception {
-        if (!launchMode.getLaunchMode().isDevOrTest())
+            BuildProducer<DevServicesResultBuildItem> devServicePropertiesProducer) {
+        LaunchMode launchMode = launchModeBuildItem.getLaunchMode();
+        if (!launchMode.isDevOrTest())
             return;
         if (legacyTestingEnabled())
             return;
         if (!config.mockEventServer().enabled()) {
             return;
         }
-        if (server != null) {
-            return;
-        }
-        Supplier<MockEventServer> supplier = null;
+
+        MockEventServer server;
         if (override.isPresent()) {
-            supplier = override.get().getServer();
+            server = override.get().getServer().get();
         } else {
-            supplier = () -> new MockEventServer();
+            server = new MockEventServer();
         }
 
-        server = supplier.get();
-        int port = launchMode.getLaunchMode() == LaunchMode.TEST ? config.mockEventServer().testPort()
+        int configuredPort = launchMode == LaunchMode.TEST ? config.mockEventServer().testPort()
                 : config.mockEventServer().devPort();
-        startMode = launchMode.getLaunchMode();
-        server.start(port);
-        int actualPort = server.getPort();
-        String baseUrl = "localhost:" + actualPort + MockEventServer.BASE_PATH;
-        Map<String, String> properties = new HashMap<>();
-        properties.put(AmazonLambdaApi.QUARKUS_INTERNAL_AWS_LAMBDA_TEST_API, baseUrl);
-
-        if (actualPort != port) {
-            String portPropertyValue = String.valueOf(actualPort);
-            String portPropertySuffix = launchMode.getLaunchMode() == LaunchMode.TEST ? "test-port" : "dev-port";
-            String propName = "quarkus.lambda.mock-event-server." + portPropertySuffix;
-            System.setProperty(propName, portPropertyValue);
+        String portPropertySuffix = launchMode == LaunchMode.TEST ? "test-port" : "dev-port";
+        String propName = "quarkus.lambda.mock-event-server." + portPropertySuffix;
+
+        // No compose support, and no using of external services, so no need to discover existing services
+
+        DevServicesResultBuildItem buildItem = DevServicesResultBuildItem.owned().feature(Feature.AMAZON_LAMBDA)
+                .serviceName(Feature.AMAZON_LAMBDA.getName())
+                .serviceConfig(config)
+                .startable(() -> new StartableEventServer(
+                        server, configuredPort))
+                .configProvider(
+                        Map.of(propName, s -> String.valueOf(s.getExposedPort()),
+                                AmazonLambdaApi.QUARKUS_INTERNAL_AWS_LAMBDA_TEST_API,
+                                StartableEventServer::getConnectionInfo))
+                .build();
+
+        devServicePropertiesProducer.produce(buildItem);
+
+    }
+
+    private static class StartableEventServer implements Startable {
+
+        private final MockEventServer server;
+        private final int configuredPort;
+
+        public StartableEventServer(MockEventServer server, int configuredPort) {
+            this.server = server;
+            this.configuredPort = configuredPort;
         }
 
-        devServicePropertiesProducer.produce(
-                new DevServicesResultBuildItem(Feature.AMAZON_LAMBDA.getName(), null, properties));
-        Runnable closeTask = () -> {
-            if (server != null) {
-                try {
-                    server.close();
-                } catch (Throwable e) {
-                    log.error("Failed to stop the Lambda Mock Event Server", e);
-                } finally {
-                    server = null;
-                }
-            }
-            startMode = null;
-            server = null;
-        };
-        closeBuildItem.addCloseTask(closeTask, true);
+        @Override
+        public void start() {
+            server.start(configuredPort);
+            log.debugf("Starting event server on port %d", configuredPort);
+        }
+
+        public int getExposedPort() {
+            return server.getPort();
+        }
+
+        @Override
+        public String getConnectionInfo() {
+            return "localhost:" + getExposedPort() + MockEventServer.BASE_PATH;
+        }
+
+        @Override
+        public String getContainerId() {
+            return "";
+        }
+
+        @Override
+        public void close() throws IOException {
+            server.close();
+        }
     }
 }

extensions/amazon-lambda/event-server/src/main/java/io/quarkus/amazon/lambda/runtime/MockEventServer.java

@@ -74,10 +74,18 @@ public void start(int port) {
         vertx = Vertx.vertx(new VertxOptions().setMaxWorkerExecuteTime(60).setMaxWorkerExecuteTimeUnit(TimeUnit.MINUTES));
         HttpServerOptions options = new HttpServerOptions();
         options.setPort(port == 0 ? -1 : port);
-        Optional<MemorySize> maybeMaxHeadersSize = ConfigProvider.getConfig()
-                .getOptionalValue("quarkus.http.limits.max-header-size", MemorySize.class);
-        if (maybeMaxHeadersSize.isPresent()) {
-            options.setMaxHeaderSize(maybeMaxHeadersSize.get().asBigInteger().intValueExact());
+
+        ClassLoader original = Thread.currentThread().getContextClassLoader();
+        try {
+            Thread.currentThread().setContextClassLoader(MockEventServer.class.getClassLoader());
+            Optional<MemorySize> maybeMaxHeadersSize = ConfigProvider.getConfig()
+                    .getOptionalValue("quarkus.http.limits.max-header-size", MemorySize.class);
+
+            if (maybeMaxHeadersSize.isPresent()) {
+                options.setMaxHeaderSize(maybeMaxHeadersSize.get().asBigInteger().intValueExact());
+            }
+        } finally {
+            Thread.currentThread().setContextClassLoader(original);
         }
         httpServer = vertx.createHttpServer(options);
         router = Router.router(vertx);

integration-tests/amazon-lambda/src/test/java/io/quarkus/it/amazon/lambda/AmazonLambdaEphemeralPortTestCase.java

@@ -3,14 +3,12 @@
 import static io.restassured.RestAssured.given;
 import static org.hamcrest.CoreMatchers.containsString;
 
-import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 
 import io.quarkus.it.amazon.lambda.profiles.EphemeralPortProfile;
 import io.quarkus.test.junit.QuarkusTest;
 import io.quarkus.test.junit.TestProfile;
 
-@Disabled("Failing since 3.22, should be fixed by by https://github.com/quarkusio/quarkus/issues/48006")
 @TestProfile(EphemeralPortProfile.class)
 @QuarkusTest
 public class AmazonLambdaEphemeralPortTestCase {

integration-tests/amazon-lambda/src/test/java/io/quarkus/it/amazon/lambda/AmazonLambdaWithProfileSimpleTestCase.java

@@ -3,14 +3,12 @@
 import static io.restassured.RestAssured.given;
 import static org.hamcrest.CoreMatchers.containsString;
 
-import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 
 import io.quarkus.it.amazon.lambda.profiles.TrivialProfile;
 import io.quarkus.test.junit.QuarkusTest;
 import io.quarkus.test.junit.TestProfile;
 
-@Disabled("Failing, tracked by https://github.com/quarkusio/quarkus/issues/48006")
 @TestProfile(TrivialProfile.class)
 @QuarkusTest
 public class AmazonLambdaWithProfileSimpleTestCase {