Cover separate management interface

Now Quarkus can expose endpoints for metrics and health on a separate network interface. We verify, that this is supported, and we can use custom port, switch HTTPS on and off and change api path. This requires supports on the side of the FW and enabling one of the disabled tests. Test plans for the change: https://github.com/quarkus-qe/quarkus-test-plans/blob/main/QUARKUS-2738.md Related links: quarkusio/quarkus#30506 https://issues.redhat.com/browse/QUARKUS-2738
fedinskiy · Mar 30, 2023 · 2b483fa · 2b483fa
1 parent 1bc8d3c
commit 2b483fa
Show file tree

Hide file tree

Showing 14 changed files with 296 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -356,6 +356,9 @@ It also verifies multiple deployment strategies like:
 - Using OpenShift quarkus extension
 - Using OpenShift quarkus extension and Docker Build strategy
 
+### `http/management`
+Verifies, that management interface (micrometer metrics and health endpoints) can be hosted on a separate port 
+
 #### Additions
 * *@Deprecated* annotation has been added for test regression purposes to ensure `java.lang` annotations are allowed for resources
 * Resource with multipart body support, provided parts are text, image and binary data, charset checked with `us-ascii` and `utf-8`

diff --git a/http/management/pom.xml b/http/management/pom.xml
@@ -0,0 +1,47 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>io.quarkus.ts.qe</groupId>
+        <artifactId>parent</artifactId>
+        <version>1.0.0-SNAPSHOT</version>
+        <relativePath>../..</relativePath>
+    </parent>
+    <artifactId>http-management</artifactId>
+    <packaging>jar</packaging>
+    <name>Quarkus QE TS: HTTP: Management Interface</name>
+    <dependencies>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-resteasy</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-smallrye-health</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-micrometer-registry-prometheus</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-smallrye-openapi</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.quarkus.qe</groupId>
+            <artifactId>quarkus-test-openshift</artifactId>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+    <profiles>
+        <profile>
+            <id>deploy-to-openshift-using-extension</id>
+            <dependencies>
+                <dependency>
+                    <groupId>io.quarkus</groupId>
+                    <artifactId>quarkus-openshift</artifactId>
+                </dependency>
+            </dependencies>
+        </profile>
+    </profiles>
+</project>
diff --git a/http/management/src/main/java/io/quarkus/qe/HttpResource.java b/http/management/src/main/java/io/quarkus/qe/HttpResource.java
@@ -0,0 +1,16 @@
+package io.quarkus.qe;
+
+import jakarta.ws.rs.GET;
+import jakarta.ws.rs.Path;
+import jakarta.ws.rs.Produces;
+import jakarta.ws.rs.core.MediaType;
+
+@Path("/ping")
+public class HttpResource {
+
+    @GET
+    @Produces(MediaType.TEXT_PLAIN)
+    public String pong() {
+        return "pong";
+    }
+}
diff --git a/http/management/src/main/resources/META-INF/resources/server.keystore b/http/management/src/main/resources/META-INF/resources/server.keystore
diff --git a/http/management/src/main/resources/application.properties b/http/management/src/main/resources/application.properties
@@ -0,0 +1,3 @@
+# Only run tests annotated with @QuarkusTest
+quarkus.test.type=quarkus-test
+quarkus.management.enabled=true
diff --git a/http/management/src/test/java/io/quarkus/qe/LocalEndpointsIT.java b/http/management/src/test/java/io/quarkus/qe/LocalEndpointsIT.java
@@ -0,0 +1,57 @@
+package io.quarkus.qe;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import org.apache.http.HttpStatus;
+import org.junit.jupiter.api.MethodOrderer;
+import org.junit.jupiter.api.Order;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.TestMethodOrder;
+
+import io.quarkus.test.bootstrap.RestService;
+import io.quarkus.test.scenarios.QuarkusScenario;
+import io.quarkus.test.services.QuarkusApplication;
+import io.restassured.response.Response;
+
+@QuarkusScenario
+@TestMethodOrder(MethodOrderer.OrderAnnotation.class)
+public class LocalEndpointsIT {
+
+    @QuarkusApplication
+    static final RestService app = new RestService();
+
+    @Test
+    @Order(1)
+    public void greeting() {
+        Response response = app.given().get("/ping");
+        assertEquals(200, response.statusCode());
+        assertEquals("pong", response.body().asString());
+    }
+
+    @Test
+    public void health() {
+        app.management().get("q/health").then().statusCode(HttpStatus.SC_OK);
+    }
+
+    @Test
+    public void oldHealth() {
+        app.given().get("q/health").then().statusCode(HttpStatus.SC_NOT_FOUND);
+    }
+
+    @Test
+    public void metrics() {
+        Response response = app.management().get("q/metrics");
+        assertEquals(200, response.statusCode());
+        String metric = null;
+        String body = response.body().asString();
+        for (String line : body.split("\n")) {
+            if (line.contains("http_server_requests_seconds_count") && line.contains("SUCCESS")) {
+                metric = line;
+            }
+        }
+        assertNotNull(metric, "Metric 'http_server_requests_seconds_count' was not found in the response: " + body);
+        assertTrue(metric.endsWith("1.0"), "requests count is wrong: " + metric);
+    }
+}
diff --git a/http/management/src/test/java/io/quarkus/qe/LocalOptionsIT.java b/http/management/src/test/java/io/quarkus/qe/LocalOptionsIT.java
@@ -0,0 +1,94 @@
+package io.quarkus.qe;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import java.util.Arrays;
+
+import org.apache.http.HttpStatus;
+import org.junit.jupiter.api.Test;
+
+import io.quarkus.test.bootstrap.RestService;
+import io.quarkus.test.scenarios.QuarkusScenario;
+import io.quarkus.test.services.QuarkusApplication;
+import io.restassured.path.json.JsonPath;
+import io.restassured.response.Response;
+
+@QuarkusScenario
+public class LocalOptionsIT {
+
+    @QuarkusApplication
+    static final RestService app = new RestService();
+
+    @QuarkusApplication
+    static final RestService custom = new RestService()
+            .withProperty("quarkus.management.port", "9002");
+
+    @QuarkusApplication
+    static final RestService tls = new RestService()
+            .withProperty("quarkus.management.port", "9003")
+            .withProperty("quarkus.management.ssl.certificate.key-store-file", "META-INF/resources/server.keystore")
+            .withProperty("quarkus.management.ssl.certificate.key-store-password", "password");
+
+    @QuarkusApplication
+    static final RestService unmanaged = new RestService()
+            .withProperty("quarkus.management.enabled", "false");
+
+    @QuarkusApplication
+    static final RestService redirected = new RestService()
+            .withProperty("quarkus.management.port", "9004")
+            .withProperty("quarkus.http.root-path", "/api")
+            .withProperty("quarkus.http.non-application-root-path", "/query")
+            .withProperty("quarkus.management.root-path", "management");
+
+    @Test
+    public void greeting() {
+        for (RestService service : Arrays.asList(app, custom, tls, unmanaged)) {
+            Response response = service.given().get("/ping");
+            assertEquals(200, response.statusCode());
+            assertEquals("pong", response.body().asString());
+
+            Response openapi = service.given().get("/q/openapi?format=json"); //openapi should be on the old interface
+            assertEquals(200, openapi.statusCode());
+            JsonPath json = openapi.body().jsonPath();
+            assertEquals("OK", json.getString("paths.\"/ping\".get.responses.\"200\".description"));
+        }
+    }
+
+    @Test
+    public void unmanaged() {
+        unmanaged.given().get("q/health").then().statusCode(HttpStatus.SC_OK);
+    }
+
+    @Test
+    public void managed() {
+        app.management().get("q/health").then().statusCode(HttpStatus.SC_OK);
+    }
+
+    @Test
+    public void customPort() {
+        custom.management()
+                .get("q/health").then().statusCode(HttpStatus.SC_OK);
+    }
+
+    @Test
+    public void tls() {
+        tls.management()
+                .relaxedHTTPSValidation()
+                .get("q/health").then().statusCode(HttpStatus.SC_OK);
+    }
+
+    @Test
+    public void redirected() {
+        Response response = redirected.given().get("api/ping");
+        assertEquals(200, response.statusCode());
+        assertEquals("pong", response.body().asString());
+
+        redirected.management().get("management/health").then()
+                .statusCode(HttpStatus.SC_OK);
+
+        Response openapi = redirected.given().get("query/openapi?format=json");
+        assertEquals(200, openapi.statusCode());
+        JsonPath json = openapi.body().jsonPath();
+        assertEquals("OK", json.getString("paths.\"/api/ping\".get.responses.\"200\".description"));
+    }
+}
diff --git a/http/management/src/test/java/io/quarkus/qe/OpenShiftEndpointsIT.java b/http/management/src/test/java/io/quarkus/qe/OpenShiftEndpointsIT.java
@@ -0,0 +1,7 @@
+package io.quarkus.qe;
+
+import io.quarkus.test.scenarios.OpenShiftScenario;
+
+@OpenShiftScenario
+public class OpenShiftEndpointsIT extends LocalEndpointsIT {
+}
diff --git a/http/management/src/test/java/io/quarkus/qe/OpenShiftExtensionIT.java b/http/management/src/test/java/io/quarkus/qe/OpenShiftExtensionIT.java
@@ -0,0 +1,32 @@
+package io.quarkus.qe;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import org.apache.http.HttpStatus;
+import org.junit.jupiter.api.Disabled;
+import org.junit.jupiter.api.Test;
+
+import io.quarkus.test.bootstrap.RestService;
+import io.quarkus.test.scenarios.OpenShiftDeploymentStrategy;
+import io.quarkus.test.scenarios.OpenShiftScenario;
+import io.quarkus.test.services.QuarkusApplication;
+import io.restassured.response.Response;
+
+@OpenShiftScenario(deployment = OpenShiftDeploymentStrategy.UsingOpenShiftExtension)
+@Disabled("Requires fixing https://github.com/quarkusio/quarkus/issues/32135 and changes in the Framework")
+public class OpenShiftExtensionIT {
+    @QuarkusApplication
+    static final RestService app = new RestService();
+
+    @Test
+    public void payload() {
+        Response response = app.given().get("/ping");
+        assertEquals(200, response.statusCode());
+        assertEquals("pong", response.body().asString());
+    }
+
+    @Test
+    public void health() {
+        app.management().get("q/health").then().statusCode(HttpStatus.SC_OK);
+    }
+}
diff --git a/http/management/src/test/java/io/quarkus/qe/OpenShiftOptionsIT.java b/http/management/src/test/java/io/quarkus/qe/OpenShiftOptionsIT.java
@@ -0,0 +1,15 @@
+package io.quarkus.qe;
+
+import org.junit.jupiter.api.Disabled;
+import org.junit.jupiter.api.Test;
+
+import io.quarkus.test.scenarios.OpenShiftScenario;
+
+@OpenShiftScenario
+public class OpenShiftOptionsIT extends LocalOptionsIT {
+    @Test
+    @Override
+    @Disabled("SSL on openshift is not supported by the FW (yet)")
+    public void tls() {
+    }
+}
diff --git a/monitoring/micrometer-prometheus/src/main/resources/application.properties b/monitoring/micrometer-prometheus/src/main/resources/application.properties
@@ -1,4 +1,4 @@
 quarkus.openshift.labels.app-with-metrics=quarkus-app
 
 # MP Integration
-quarkus.micrometer.binder.mp-metrics.enabled=true
+quarkus.micrometer.binder.mp-metrics.enabled=true
diff --git a/...ter-prometheus/src/test/java/io/quarkus/ts/micrometer/prometheus/HttpServerMetricsIT.java b/...ter-prometheus/src/test/java/io/quarkus/ts/micrometer/prometheus/HttpServerMetricsIT.java
@@ -14,7 +14,9 @@
 import org.apache.http.HttpStatus;
 import org.junit.jupiter.api.Test;
 
+import io.quarkus.test.bootstrap.RestService;
 import io.quarkus.test.scenarios.QuarkusScenario;
+import io.quarkus.test.services.QuarkusApplication;
 
 @QuarkusScenario
 public class HttpServerMetricsIT {
@@ -31,6 +33,10 @@ public class HttpServerMetricsIT {
     private static final String HTTP_SERVER_REQUESTS_METRICS_FORMAT = "http_server_requests_seconds_%s{method=\"GET\",outcome=\"SUCCESS\",status=\"200\",uri=\"%s\"";
     private static final String PING_PONG_ENDPOINT = "/without-metrics-pingpong";
 
+    @QuarkusApplication
+    static RestService app = new RestService()
+            .withProperty("quarkus.management.enabled", "true");
+
     @Test
     public void testHttpServerRequestsCountShouldBeRegistered() {
         thenHttpServerRequestsMetricsAreNotPresent();
@@ -47,7 +53,7 @@ private void whenCallPingPong() {
     }
 
     private void thenHttpServerRequestsMetricsAreNotPresent() {
-        String metrics = when().get("/q/metrics").then()
+        String metrics = app.management().get("/q/metrics").then()
                 .statusCode(HttpStatus.SC_OK).extract().asString();
 
         for (String metricSuffix : HTTP_SERVER_REQUESTS_METRICS_SUFFIX) {
@@ -57,7 +63,7 @@ private void thenHttpServerRequestsMetricsAreNotPresent() {
     }
 
     private void thenHttpServerRequestsMetricsArePresent() {
-        String metrics = when().get("/q/metrics").then()
+        String metrics = app.management().get("/q/metrics").then()
                 .statusCode(HttpStatus.SC_OK).extract().asString();
 
         for (String metricSuffix : HTTP_SERVER_REQUESTS_METRICS_SUFFIX) {

diff --git a/...rometheus/src/test/java/io/quarkus/ts/micrometer/prometheus/OpenShiftCustomMetricsIT.java b/...rometheus/src/test/java/io/quarkus/ts/micrometer/prometheus/OpenShiftCustomMetricsIT.java
@@ -12,7 +12,6 @@
 import org.apache.http.HttpStatus;
 import org.jboss.logging.Logger;
 import org.junit.jupiter.api.BeforeEach;
-import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 
 import io.quarkus.test.bootstrap.RestService;
@@ -27,7 +26,6 @@
  * - `prime_number_max_{uniqueId}`: max prime number that is found.
  * - `prime_number_test_{uniqueId}`: with information about the calculation of the prime number.
  */
-@Disabled("https://github.com/quarkusio/quarkus/issues/31228")
 @OpenShiftScenario(deployment = OpenShiftDeploymentStrategy.UsingOpenShiftExtension)
 public class OpenShiftCustomMetricsIT {
 
@@ -51,7 +49,16 @@ public class OpenShiftCustomMetricsIT {
     static final Integer ANY_VALUE = null;
 
     @QuarkusApplication
-    static RestService app = new RestService().onPostStart(OpenShiftCustomMetricsIT::loadServiceMonitor);
+    static RestService app = new RestService()
+            /*
+             * TODO fix deployment with OpenShiftDeploymentStrategies in the Framework
+             * see https://github.com/quarkusio/quarkus/issues/32135#issuecomment-1486740862 for details
+             * .withProperty("quarkus.management.ssl.certificate.key-store-file",
+             * "META-INF/resources/server.keystore")
+             * .withProperty("quarkus.management.ssl.certificate.key-store-password", "password")
+             * .withProperty("quarkus.management.enabled", "true")
+             */
+            .onPostStart(OpenShiftCustomMetricsIT::loadServiceMonitor);
 
     @Inject
     static OpenShiftClient client;
@@ -121,7 +128,7 @@ private void thenMetricIsExposedInServiceEndpoint(String name, Integer expected)
                 shouldContain += " " + expected;
             }
 
-            app.given().get("/q/metrics").then()
+            app.management().get("/q/metrics").then()
                     .statusCode(HttpStatus.SC_OK)
                     .body(containsString(shouldContain));
         });

diff --git a/pom.xml b/pom.xml
@@ -19,7 +19,7 @@
         <quarkus.platform.artifact-id>quarkus-bom</quarkus.platform.artifact-id>
         <quarkus.platform.group-id>io.quarkus</quarkus.platform.group-id>
         <quarkus.platform.version>999-SNAPSHOT</quarkus.platform.version>
-        <quarkus.qe.framework.version>1.3.0.Beta9</quarkus.qe.framework.version>
+        <quarkus.qe.framework.version>1.3.0.Beta10</quarkus.qe.framework.version>
         <quarkus-qpid-jms.version>0.42.0</quarkus-qpid-jms.version>
         <quarkus-ide-config.version>2.12.1.Final</quarkus-ide-config.version>
         <apache-httpclient-fluent.version>4.5.14</apache-httpclient-fluent.version>
@@ -451,6 +451,7 @@
                 <module>http/graphql</module>
                 <module>http/graphql-telemetry</module>
                 <module>http/vertx</module>
+                <module>http/management</module>
             </modules>
         </profile>
         <profile>