Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Test coverage for Keep the URIs in the metrics tag with 302 and 404 patterns #1838

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
package io.quarkus.ts.micrometer.prometheus;

import java.net.URI;

import jakarta.ws.rs.GET;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.PathParam;
import jakarta.ws.rs.core.Response;

@Path("/test")
public class PathPatternResource {
@GET
@Path("/redirect")
public Response redirect() {
return Response.status(Response.Status.FOUND) //302
.location(URI.create("/new-location"))
.build();
}

@GET
@Path("/not-found")
public Response notFound() {
return Response.status(Response.Status.NOT_FOUND).build(); //404
}

@GET
@Path("/not-found/{uri}")
public Response notFoundUri(@PathParam("uri") String uri) {
return Response.status(Response.Status.NOT_FOUND).build(); //404
}

@GET
@Path("/moved/{id}")
public Response moved(@PathParam("id") String id) {
return Response.status(Response.Status.MOVED_PERMANENTLY).build(); // 301
}

@GET
@Path("")
public Response emptyPath() {
return Response.status(Response.Status.NO_CONTENT).build(); //204
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
package io.quarkus.ts.micrometer.prometheus;

import static io.restassured.RestAssured.given;
import static org.awaitility.Awaitility.await;
import static org.junit.jupiter.api.Assertions.assertTrue;

import java.util.Arrays;
import java.util.List;
import java.util.concurrent.TimeUnit;

import org.apache.http.HttpStatus;
import org.junit.jupiter.api.Tag;
import org.junit.jupiter.api.Test;

import io.quarkus.test.bootstrap.RestService;
import io.quarkus.test.scenarios.QuarkusScenario;
import io.quarkus.test.services.QuarkusApplication;

@Tag("QUARKUS-4430")
@QuarkusScenario
public class HttpPathMetricsPatternIT {

private static final int ASSERT_METRICS_TIMEOUT_SECONDS = 30;
private static final List<String> HTTP_SERVER_REQUESTS_METRICS_SUFFIX = Arrays.asList("count", "sum", "max");
private static final String HTTP_SERVER_REQUESTS_METRICS_FORMAT = "http_server_requests_seconds_%s{method=\"GET\",outcome=\"%s\",status=\"%d\",uri=\"%s\"}";
private static final String REDIRECT_ENDPOINT = "/test/redirect";
private static final String NOT_FOUND_ENDPOINT = "/test/not-found";
private static final String NOT_FOUND_URI_ENDPOINT = "/test/not-found/{uri}";
private static final String MOVED_ENDPOINT = "/test/moved/{id}";
private static final String EMPTY_ENDPOINT = "/test";

@QuarkusApplication
static RestService app = new RestService();

@Test
public void verifyNotFoundInMetrics() {
whenCallNotFoundEndpoint();
thenMetricIsExposedInServiceEndpoint(404, "CLIENT_ERROR", "NOT_FOUND");
}

@Test
public void verifyUriNotFoundInMetrics() {
whenCallNotFoundWithParamEndpoint("/url123");
thenMetricIsExposedInServiceEndpoint(404, "CLIENT_ERROR", NOT_FOUND_URI_ENDPOINT);
}

@Test
public void verifyRedirectionInMetrtics() {
whenCallRedirectEndpoint();
thenMetricIsExposedInServiceEndpoint(302, "REDIRECTION", "REDIRECTION");
}

@Test
public void verifyEmptyPathInMetrics() {
whenCallEmptyPathEndpoint();
thenMetricIsExposedInServiceEndpoint(204, "SUCCESS", EMPTY_ENDPOINT);
}

@Test
public void verifyDynamicRedirectionInMetrics() {
String id = "41";
whenCallDynamicSegmentEndpoint(id);
thenMetricIsExposedInServiceEndpoint(301, "REDIRECTION", MOVED_ENDPOINT);
}

private void whenCallRedirectEndpoint() {
given()
.redirects().follow(false)
.when().get(REDIRECT_ENDPOINT)
.then().statusCode(302);
}

private void whenCallEmptyPathEndpoint() {
given()
.when().get("/test")
.then().statusCode(HttpStatus.SC_NO_CONTENT);
}

private void whenCallNotFoundEndpoint() {
given()
.when().get(NOT_FOUND_ENDPOINT)
.then().statusCode(HttpStatus.SC_NOT_FOUND);
}

private void whenCallNotFoundWithParamEndpoint(String url) {
given()
.pathParam("uri", url)
.redirects().follow(false)
.when().get(NOT_FOUND_URI_ENDPOINT)
.then().statusCode(HttpStatus.SC_NOT_FOUND);
}

private void whenCallDynamicSegmentEndpoint(String id) {
given()
.pathParam("id", id)
.redirects().follow(false)
.when().get(MOVED_ENDPOINT)
.then().statusCode(HttpStatus.SC_MOVED_PERMANENTLY);
}

private void thenMetricIsExposedInServiceEndpoint(int statusCode, String outcome, String uri) {
await().ignoreExceptions().atMost(ASSERT_METRICS_TIMEOUT_SECONDS, TimeUnit.SECONDS).untilAsserted(() -> {
String metrics = app.given().get("/q/metrics").then()
.statusCode(HttpStatus.SC_OK).extract().asString();
for (String metricSuffix : HTTP_SERVER_REQUESTS_METRICS_SUFFIX) {
String metric = String.format(HTTP_SERVER_REQUESTS_METRICS_FORMAT, metricSuffix, outcome, statusCode, uri);

assertTrue(metrics.contains(metric), "Expected metric : " + metric + ". Metrics: " + metrics);
}
});
}

}
Loading