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.

Sign up for GitHub

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

Rework vertx-rx tests to reduce flakiness #13190

Merged
merged 1 commit into from
Feb 6, 2025
Merged

Rework vertx-rx tests to reduce flakiness #13190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
107 changes: 107 additions & 0 deletions ...emetry/javaagent/instrumentation/vertx/reactive/server/AbstractVertxRxHttpServerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/

package io.opentelemetry.javaagent.instrumentation.vertx.reactive.server;

import static io.opentelemetry.instrumentation.testing.junit.http.ServerEndpoint.EXCEPTION;

import io.opentelemetry.instrumentation.api.internal.HttpConstants;
import io.opentelemetry.instrumentation.testing.junit.http.AbstractHttpServerTest;
import io.opentelemetry.instrumentation.testing.junit.http.HttpServerTestOptions;
import io.opentelemetry.instrumentation.testing.junit.http.ServerEndpoint;
import io.vertx.core.DeploymentOptions;
import io.vertx.core.Promise;
import io.vertx.core.Vertx;
import io.vertx.core.VertxOptions;
import io.vertx.core.json.JsonObject;
import io.vertx.reactivex.core.AbstractVerticle;
import io.vertx.reactivex.ext.web.Router;
import io.vertx.reactivex.ext.web.RoutingContext;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.TimeUnit;

abstract class AbstractVertxRxHttpServerTest extends AbstractHttpServerTest<Vertx> {
static final String CONFIG_HTTP_SERVER_PORT = "http.server.port";

@Override
protected Vertx setupServer() throws Exception {
Vertx server =
Vertx.vertx(
new VertxOptions()
// Useful for debugging:
// .setBlockedThreadCheckInterval(Integer.MAX_VALUE)
);
CompletableFuture<Void> future = new CompletableFuture<>();
server.deployVerticle(
verticle().getName(),
new DeploymentOptions()
.setConfig(new JsonObject().put(CONFIG_HTTP_SERVER_PORT, port))
.setInstances(3),
result -> {
if (!result.succeeded()) {
throw new IllegalStateException("Cannot deploy server Verticle", result.cause());
}
future.complete(null);
});

future.get(30, TimeUnit.SECONDS);
return server;
}

@Override
protected void stopServer(Vertx vertx) {
vertx.close();
}

@Override
protected void configure(HttpServerTestOptions options) {
super.configure(options);

options.setTestPathParam(true);
// server spans are ended inside the controller spans
options.setVerifyServerSpanEndTime(false);
options.setExpectedHttpRoute(
(endpoint, method) -> {
if (HttpConstants._OTHER.equals(method)) {
return getContextPath() + endpoint.getPath();
}
return expectedHttpRoute(endpoint, method);
});
}

protected Class<? extends AbstractVerticle> verticle() {
return VertxReactiveWebServer.class;
}

public static class VertxReactiveWebServer extends AbstractVertxRxVerticle {
@Override
void handle(RoutingContext ctx, ServerEndpoint endpoint, Runnable action) {
controller(endpoint, action::run);
}

@Override
public void start(Promise<Void> startFuture) {
int port = config().getInteger(CONFIG_HTTP_SERVER_PORT);
Router router = Router.router(vertx);

configure(router);
router
.route(EXCEPTION.getPath())
.handler(
ctx ->
handle(
ctx,
EXCEPTION,
() -> {
throw new IllegalStateException(EXCEPTION.getBody());
}));

vertx
.createHttpServer()
.requestHandler(router)
.listen(port, httpServerAsyncResult -> startFuture.complete());
}
}
}
8 changes: 7 additions & 1 deletion .../javaagent/instrumentation/vertx/reactive/server/VertxRxCircuitBreakerHttpServerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

import static io.opentelemetry.instrumentation.testing.junit.http.ServerEndpoint.EXCEPTION;

import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
import io.opentelemetry.instrumentation.testing.junit.http.HttpServerInstrumentationExtension;
import io.opentelemetry.instrumentation.testing.junit.http.HttpServerTestOptions;
import io.opentelemetry.instrumentation.testing.junit.http.ServerEndpoint;
import io.vertx.circuitbreaker.CircuitBreakerOptions;
Expand All @@ -15,8 +17,12 @@
import io.vertx.reactivex.core.AbstractVerticle;
import io.vertx.reactivex.ext.web.Router;
import io.vertx.reactivex.ext.web.RoutingContext;
import org.junit.jupiter.api.extension.RegisterExtension;

class VertxRxCircuitBreakerHttpServerTest extends VertxRxHttpServerTest {
class VertxRxCircuitBreakerHttpServerTest extends AbstractVertxRxHttpServerTest {

@RegisterExtension
static final InstrumentationExtension testing = HttpServerInstrumentationExtension.forAgent();

@Override
protected void configure(HttpServerTestOptions options) {
Expand Down
57 changes: 1 addition & 56 deletions .../opentelemetry/javaagent/instrumentation/vertx/reactive/server/VertxRxHttpServerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,76 +7,21 @@

import static io.opentelemetry.instrumentation.testing.junit.http.ServerEndpoint.EXCEPTION;

import io.opentelemetry.instrumentation.api.internal.HttpConstants;
import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
import io.opentelemetry.instrumentation.testing.junit.http.AbstractHttpServerTest;
import io.opentelemetry.instrumentation.testing.junit.http.HttpServerInstrumentationExtension;
import io.opentelemetry.instrumentation.testing.junit.http.HttpServerTestOptions;
import io.opentelemetry.instrumentation.testing.junit.http.ServerEndpoint;
import io.vertx.core.DeploymentOptions;
import io.vertx.core.Promise;
import io.vertx.core.Vertx;
import io.vertx.core.VertxOptions;
import io.vertx.core.json.JsonObject;
import io.vertx.reactivex.core.AbstractVerticle;
import io.vertx.reactivex.ext.web.Router;
import io.vertx.reactivex.ext.web.RoutingContext;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.TimeUnit;
import org.junit.jupiter.api.extension.RegisterExtension;

class VertxRxHttpServerTest extends AbstractHttpServerTest<Vertx> {
static final String CONFIG_HTTP_SERVER_PORT = "http.server.port";
class VertxRxHttpServerTest extends AbstractVertxRxHttpServerTest {

@RegisterExtension
static final InstrumentationExtension testing = HttpServerInstrumentationExtension.forAgent();

@Override
protected Vertx setupServer() throws Exception {
Vertx server =
Vertx.vertx(
new VertxOptions()
// Useful for debugging:
// .setBlockedThreadCheckInterval(Integer.MAX_VALUE)
);
CompletableFuture<Void> future = new CompletableFuture<>();
server.deployVerticle(
verticle().getName(),
new DeploymentOptions()
.setConfig(new JsonObject().put(CONFIG_HTTP_SERVER_PORT, port))
.setInstances(3),
result -> {
if (!result.succeeded()) {
throw new IllegalStateException("Cannot deploy server Verticle", result.cause());
}
future.complete(null);
});

future.get(30, TimeUnit.SECONDS);
return server;
}

@Override
protected void stopServer(Vertx vertx) {
vertx.close();
}

@Override
protected void configure(HttpServerTestOptions options) {
super.configure(options);

options.setTestPathParam(true);
// server spans are ended inside the controller spans
options.setVerifyServerSpanEndTime(false);
options.setExpectedHttpRoute(
(endpoint, method) -> {
if (HttpConstants._OTHER.equals(method)) {
return getContextPath() + endpoint.getPath();
}
return expectedHttpRoute(endpoint, method);
});
}

protected Class<? extends AbstractVerticle> verticle() {
return VertxReactiveWebServer.class;
}
Expand Down
69 changes: 69 additions & 0 deletions ...emetry/javaagent/instrumentation/vertx/reactive/server/AbstractVertxRxHttpServerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/

package io.opentelemetry.javaagent.instrumentation.vertx.reactive.server;

import io.opentelemetry.instrumentation.api.internal.HttpConstants;
import io.opentelemetry.instrumentation.testing.junit.http.AbstractHttpServerTest;
import io.opentelemetry.instrumentation.testing.junit.http.HttpServerTestOptions;
import io.vertx.core.DeploymentOptions;
import io.vertx.core.Vertx;
import io.vertx.core.VertxOptions;
import io.vertx.core.json.JsonObject;
import io.vertx.reactivex.core.AbstractVerticle;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.TimeUnit;

abstract class AbstractVertxRxHttpServerTest extends AbstractHttpServerTest<Vertx> {
static final String CONFIG_HTTP_SERVER_PORT = "http.server.port";

@Override
protected Vertx setupServer() throws Exception {
Vertx server =
Vertx.vertx(
new VertxOptions()
// Useful for debugging:
// .setBlockedThreadCheckInterval(Integer.MAX_VALUE)
.setClusterPort(port));
CompletableFuture<Void> future = new CompletableFuture<>();
server.deployVerticle(
verticle().getName(),
new DeploymentOptions()
.setConfig(new JsonObject().put(CONFIG_HTTP_SERVER_PORT, port))
.setInstances(3),
result -> {
if (!result.succeeded()) {
throw new IllegalStateException("Cannot deploy server Verticle", result.cause());
}
future.complete(null);
});

future.get(30, TimeUnit.SECONDS);
return server;
}

@Override
protected void stopServer(Vertx vertx) {
vertx.close();
}

@Override
protected void configure(HttpServerTestOptions options) {
super.configure(options);

options.setTestPathParam(true);
// server spans are ended inside the controller spans
options.setVerifyServerSpanEndTime(false);
options.setExpectedHttpRoute(
(endpoint, method) -> {
if (HttpConstants._OTHER.equals(method)) {
return getContextPath() + endpoint.getPath();
}
return expectedHttpRoute(endpoint, method);
});
}

protected abstract Class<? extends AbstractVerticle> verticle();
}
8 changes: 7 additions & 1 deletion .../javaagent/instrumentation/vertx/reactive/server/VertxRxCircuitBreakerHttpServerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

import static io.opentelemetry.instrumentation.testing.junit.http.ServerEndpoint.EXCEPTION;

import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
import io.opentelemetry.instrumentation.testing.junit.http.HttpServerInstrumentationExtension;
import io.opentelemetry.instrumentation.testing.junit.http.HttpServerTestOptions;
import io.opentelemetry.instrumentation.testing.junit.http.ServerEndpoint;
import io.vertx.circuitbreaker.CircuitBreakerOptions;
Expand All @@ -15,8 +17,12 @@
import io.vertx.reactivex.core.AbstractVerticle;
import io.vertx.reactivex.ext.web.Router;
import io.vertx.reactivex.ext.web.RoutingContext;
import org.junit.jupiter.api.extension.RegisterExtension;

class VertxRxCircuitBreakerHttpServerTest extends VertxRxHttpServerTest {
class VertxRxCircuitBreakerHttpServerTest extends AbstractVertxRxHttpServerTest {

@RegisterExtension
static final InstrumentationExtension testing = HttpServerInstrumentationExtension.forAgent();

@Override
protected void configure(HttpServerTestOptions options) {
Expand Down
57 changes: 1 addition & 56 deletions .../opentelemetry/javaagent/instrumentation/vertx/reactive/server/VertxRxHttpServerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,76 +7,21 @@

import static io.opentelemetry.instrumentation.testing.junit.http.ServerEndpoint.EXCEPTION;

import io.opentelemetry.instrumentation.api.internal.HttpConstants;
import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
import io.opentelemetry.instrumentation.testing.junit.http.AbstractHttpServerTest;
import io.opentelemetry.instrumentation.testing.junit.http.HttpServerInstrumentationExtension;
import io.opentelemetry.instrumentation.testing.junit.http.HttpServerTestOptions;
import io.opentelemetry.instrumentation.testing.junit.http.ServerEndpoint;
import io.vertx.core.DeploymentOptions;
import io.vertx.core.Future;
import io.vertx.core.Vertx;
import io.vertx.core.VertxOptions;
import io.vertx.core.json.JsonObject;
import io.vertx.reactivex.core.AbstractVerticle;
import io.vertx.reactivex.ext.web.Router;
import io.vertx.reactivex.ext.web.RoutingContext;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.TimeUnit;
import org.junit.jupiter.api.extension.RegisterExtension;

class VertxRxHttpServerTest extends AbstractHttpServerTest<Vertx> {
static final String CONFIG_HTTP_SERVER_PORT = "http.server.port";
class VertxRxHttpServerTest extends AbstractVertxRxHttpServerTest {

@RegisterExtension
static final InstrumentationExtension testing = HttpServerInstrumentationExtension.forAgent();

@Override
protected Vertx setupServer() throws Exception {
Vertx server =
Vertx.vertx(
new VertxOptions()
// Useful for debugging:
// .setBlockedThreadCheckInterval(Integer.MAX_VALUE)
.setClusterPort(port));
CompletableFuture<Void> future = new CompletableFuture<>();
server.deployVerticle(
verticle().getName(),
new DeploymentOptions()
.setConfig(new JsonObject().put(CONFIG_HTTP_SERVER_PORT, port))
.setInstances(3),
result -> {
if (!result.succeeded()) {
throw new IllegalStateException("Cannot deploy server Verticle", result.cause());
}
future.complete(null);
});

future.get(30, TimeUnit.SECONDS);
return server;
}

@Override
protected void stopServer(Vertx vertx) {
vertx.close();
}

@Override
protected void configure(HttpServerTestOptions options) {
super.configure(options);

options.setTestPathParam(true);
// server spans are ended inside the controller spans
options.setVerifyServerSpanEndTime(false);
options.setExpectedHttpRoute(
(endpoint, method) -> {
if (HttpConstants._OTHER.equals(method)) {
return getContextPath() + endpoint.getPath();
}
return expectedHttpRoute(endpoint, method);
});
}

protected Class<? extends AbstractVerticle> verticle() {
return VertxReactiveWebServer.class;
}
Expand Down