Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Enable usage of random port for the Management Interface
In testing scenarios, setting the management interface port to a random value can be beneficial. This can be achieved by configuring `quarkus.management.test-port` to `0`. However, previously, retrieving the actual port in tests was not feasible. This commit addresses this limitation by introducing the following enhancements: - It stores the actual management port in a system property when it differs from the configured port. - It enables the injection of the actual management port using @TestHTTPResource(management=true,...).
- Loading branch information
1 parent
886b78e
commit d0d5ef5
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| package io.quarkus.vertx.http.management; | ||
|
|
||
| import java.net.URL; | ||
| import java.util.function.Consumer; | ||
|
|
||
| import jakarta.enterprise.event.Observes; | ||
| import jakarta.inject.Singleton; | ||
|
|
||
| import org.eclipse.microprofile.config.inject.ConfigProperty; | ||
| import org.hamcrest.Matchers; | ||
| import org.jboss.shrinkwrap.api.asset.StringAsset; | ||
| import org.junit.jupiter.api.Assertions; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.api.extension.RegisterExtension; | ||
|
|
||
| import io.quarkus.builder.BuildChainBuilder; | ||
| import io.quarkus.builder.BuildContext; | ||
| import io.quarkus.builder.BuildStep; | ||
| import io.quarkus.test.QuarkusUnitTest; | ||
| import io.quarkus.test.common.http.TestHTTPResource; | ||
| import io.quarkus.vertx.http.deployment.NonApplicationRootPathBuildItem; | ||
| import io.quarkus.vertx.http.deployment.RouteBuildItem; | ||
| import io.restassured.RestAssured; | ||
| import io.vertx.core.Handler; | ||
| import io.vertx.ext.web.Router; | ||
| import io.vertx.ext.web.RoutingContext; | ||
|
|
||
| public class ManagementAndPrimaryOnPortZeroTest { | ||
| private static final String APP_PROPS = """ | ||
| quarkus.management.enabled=true | ||
| quarkus.management.test-port=0 | ||
| quarkus.http.test-port=0 | ||
| """; | ||
|
|
||
| @RegisterExtension | ||
| static final QuarkusUnitTest config = new QuarkusUnitTest() | ||
| .withApplicationRoot((jar) -> jar | ||
| .addAsResource(new StringAsset(APP_PROPS), "application.properties") | ||
| .addClasses(MyObserver.class)) | ||
| .addBuildChainCustomizer(buildCustomizer()); | ||
|
|
||
| static Consumer<BuildChainBuilder> buildCustomizer() { | ||
| return new Consumer<BuildChainBuilder>() { | ||
| @Override | ||
| public void accept(BuildChainBuilder builder) { | ||
| builder.addBuildStep(new BuildStep() { | ||
| @Override | ||
| public void execute(BuildContext context) { | ||
| NonApplicationRootPathBuildItem buildItem = context.consume(NonApplicationRootPathBuildItem.class); | ||
| context.produce(buildItem.routeBuilder() | ||
| .management() | ||
| .route("management") | ||
| .handler(new MyHandler()) | ||
| .blockingRoute() | ||
| .build()); | ||
| } | ||
| }).produces(RouteBuildItem.class) | ||
| .consumes(NonApplicationRootPathBuildItem.class) | ||
| .build(); | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| public static class MyHandler implements Handler<RoutingContext> { | ||
| @Override | ||
| public void handle(RoutingContext routingContext) { | ||
| routingContext.response() | ||
| .setStatusCode(200) | ||
| .end("Hello management"); | ||
| } | ||
| } | ||
|
|
||
| @TestHTTPResource(value = "/route") | ||
| URL url; | ||
|
|
||
| @TestHTTPResource(value = "/management", management = true) | ||
| URL management; | ||
|
|
||
| @ConfigProperty(name = "quarkus.management.test-port") | ||
| int managementPort; | ||
|
|
||
| @ConfigProperty(name = "quarkus.http.test-port") | ||
| int primaryPort; | ||
|
|
||
| @Test | ||
| public void test() { | ||
| Assertions.assertNotEquals(url.getPort(), management.getPort()); | ||
| Assertions.assertEquals(url.getPort(), primaryPort); | ||
| Assertions.assertEquals(management.getPort(), managementPort); | ||
|
|
||
| for (int i = 0; i < 10; i++) { | ||
| RestAssured.given().get(url.toExternalForm()).then().body(Matchers.is("Hello primary")); | ||
| } | ||
|
|
||
| for (int i = 0; i < 10; i++) { | ||
| RestAssured.given().get(management.toExternalForm()).then().body(Matchers.is("Hello management")); | ||
| } | ||
|
|
||
| } | ||
|
|
||
| @Singleton | ||
| static class MyObserver { | ||
|
|
||
| void register(@Observes Router router) { | ||
| router.get("/route").handler(rc -> rc.response().end("Hello primary")); | ||
| } | ||
|
|
||
| void test(@Observes String event) { | ||
| //Do Nothing | ||
| } | ||
|
|
||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.