Skip to content

Introduce JFR events for discovery issues #4453

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

Merged
merged 1 commit into from
Apr 8, 2025
Merged

Introduce JFR events for discovery issues #4453

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
1 change: 1 addition & 0 deletions junit-platform-commons/src/module/org.junit.platform.commons/module-info.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
org.junit.jupiter.params,
org.junit.platform.console,
org.junit.platform.engine,
org.junit.platform.jfr,
org.junit.platform.launcher,
org.junit.platform.reporting,
org.junit.platform.runner,
Expand Down
35 changes: 33 additions & 2 deletions ...t-platform-jfr/src/main/java/org/junit/platform/jfr/FlightRecordingDiscoveryListener.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@
import jdk.jfr.StackTrace;

import org.apiguardian.api.API;
import org.junit.platform.commons.util.ExceptionUtils;
import org.junit.platform.engine.DiscoveryFilter;
import org.junit.platform.engine.DiscoveryIssue;
import org.junit.platform.engine.DiscoverySelector;
import org.junit.platform.launcher.EngineDiscoveryResult;
import org.junit.platform.launcher.LauncherDiscoveryListener;
Expand Down Expand Up @@ -71,13 +73,23 @@ public void engineDiscoveryFinished(org.junit.platform.engine.UniqueId engineId,
event.commit();
}

@Override
public void issueEncountered(org.junit.platform.engine.UniqueId engineId, DiscoveryIssue issue) {
DiscoveryIssueEvent event = new DiscoveryIssueEvent();
event.engineId = engineId.toString();
event.severity = issue.severity().name();
event.message = issue.message();
event.source = issue.source().map(Object::toString).orElse(null);
event.cause = issue.cause().map(ExceptionUtils::readStackTrace).orElse(null);
event.commit();
}

@Category({ "JUnit", "Discovery" })
@StackTrace(false)
abstract static class DiscoveryEvent extends Event {
}

@Label("Test Discovery")
@Category({ "JUnit", "Discovery" })
@Name("org.junit.LauncherDiscovery")
static class LauncherDiscoveryEvent extends DiscoveryEvent {

Expand All @@ -89,7 +101,6 @@ static class LauncherDiscoveryEvent extends DiscoveryEvent {
}

@Label("Engine Discovery")
@Category({ "JUnit", "Discovery" })
@Name("org.junit.EngineDiscovery")
static class EngineDiscoveryEvent extends DiscoveryEvent {

Expand All @@ -100,4 +111,24 @@ static class EngineDiscoveryEvent extends DiscoveryEvent {
@Label("Result")
String result;
}

@Label("Discovery Issue")
@Name("org.junit.DiscoveryIssue")
static class DiscoveryIssueEvent extends DiscoveryEvent {

@Label("Engine Id")
String engineId;

@Label("Severity")
String severity;

@Label("Message")
String message;

@Label("Source")
String source;

@Label("Cause")
String cause;
}
}
14 changes: 2 additions & 12 deletions ...tform-launcher/src/main/java/org/junit/platform/launcher/core/DiscoveryIssueNotifier.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,8 @@
import static java.util.Collections.emptyList;
import static java.util.Comparator.comparing;
import static java.util.stream.Collectors.partitioningBy;
import static org.junit.platform.commons.util.ExceptionUtils.readStackTrace;

import java.io.PrintWriter;
import java.io.StringWriter;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
Expand Down Expand Up @@ -133,21 +132,12 @@ else if (source instanceof ClassSource) {
appendIdeCompatibleLink(message, classSource.getClassName(), "<no-method>");
}
});
issue.cause().ifPresent(t -> message.append("\n Cause: ").append(getStackTrace(t)));
issue.cause().ifPresent(t -> message.append("\n Cause: ").append(readStackTrace(t)));
}
return message.toString();
}

private static void appendIdeCompatibleLink(StringBuilder message, String className, String methodName) {
message.append("\n at ").append(className).append(".").append(methodName).append("(SourceFile:0)");
}

private static String getStackTrace(Throwable cause) {
StringWriter stringWriter = new StringWriter();
try (PrintWriter writer = new PrintWriter(stringWriter, true)) {
cause.printStackTrace(writer);
writer.flush();
}
return stringWriter.toString();
}
}
46 changes: 35 additions & 11 deletions ...rc/test/java/org/junit/platform/jfr/FlightRecordingDiscoveryListenerIntegrationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,22 @@

package org.junit.platform.jfr;

import static org.junit.platform.commons.util.ExceptionUtils.readStackTrace;
import static org.junit.platform.engine.discovery.DiscoverySelectors.selectClass;
import static org.junit.platform.launcher.core.LauncherDiscoveryRequestBuilder.request;
import static org.moditect.jfrunit.ExpectedEvent.event;
import static org.moditect.jfrunit.JfrEventsAssert.assertThat;

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.DisabledOnOpenJ9;
import org.junit.jupiter.engine.JupiterTestEngine;
import org.junit.platform.launcher.core.LauncherFactoryForTestingPurposesOnly;
import org.junit.platform.engine.DiscoveryIssue;
import org.junit.platform.engine.DiscoveryIssue.Severity;
import org.junit.platform.engine.EngineDiscoveryRequest;
import org.junit.platform.engine.TestDescriptor;
import org.junit.platform.engine.UniqueId;
import org.junit.platform.engine.support.descriptor.ClassSource;
import org.junit.platform.fakes.TestEngineStub;
import org.junit.platform.testkit.engine.EngineTestKit;
import org.moditect.jfrunit.EnableEvent;
import org.moditect.jfrunit.JfrEventTest;
import org.moditect.jfrunit.JfrEvents;
Expand All @@ -32,22 +39,39 @@ public class FlightRecordingDiscoveryListenerIntegrationTests {
@Test
@EnableEvent("org.junit.*")
void reportsEvents() {
var launcher = LauncherFactoryForTestingPurposesOnly.createLauncher(new JupiterTestEngine());
var request = request() //
var source = ClassSource.from(FlightRecordingDiscoveryListenerIntegrationTests.class);
var cause = new RuntimeException("boom");
var issue = DiscoveryIssue.builder(Severity.WARNING, "some message") //
.source(source) //
.cause(cause) //
.build();

var testEngine = new TestEngineStub() {
@Override
public TestDescriptor discover(EngineDiscoveryRequest discoveryRequest, UniqueId uniqueId) {
discoveryRequest.getDiscoveryListener().issueEncountered(uniqueId, issue);
return super.discover(discoveryRequest, uniqueId);
}
};

EngineTestKit.discover(testEngine, request() //
.selectors(selectClass(FlightRecordingDiscoveryListenerIntegrationTests.class)) //
.listeners(new FlightRecordingDiscoveryListener()) //
.build();
.build());

launcher.discover(request);
jfrEvents.awaitEvents();

assertThat(jfrEvents) //
.contains(event("org.junit.LauncherDiscovery") //
// TODO JfrUnit does not yey support checking int values
// .with("selectors", 1) //
// .with("filters", 0) //
) //
.with("selectors", 1) //
.with("filters", 0)) //
.contains(event("org.junit.EngineDiscovery") //
.with("uniqueId", "[engine:junit-jupiter]"));
.with("uniqueId", "[engine:TestEngineStub]")) //
.contains(event("org.junit.DiscoveryIssue") //
.with("engineId", "[engine:TestEngineStub]") //
.with("severity", "WARNING") //
.with("message", "some message") //
.with("source", source.toString()) //
.with("cause", readStackTrace(cause)));
}
}
2 changes: 1 addition & 1 deletion ...rm-tooling-support-tests/projects/jar-describe-module/junit-platform-commons.expected.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ requires java.management
requires org.apiguardian.api static transitive
uses org.junit.platform.commons.support.scanning.ClasspathScanner
qualified exports org.junit.platform.commons.logging to org.junit.jupiter.api org.junit.jupiter.engine org.junit.jupiter.migrationsupport org.junit.jupiter.params org.junit.platform.console org.junit.platform.engine org.junit.platform.launcher org.junit.platform.reporting org.junit.platform.runner org.junit.platform.suite.api org.junit.platform.suite.engine org.junit.platform.testkit org.junit.vintage.engine
qualified exports org.junit.platform.commons.util to org.junit.jupiter.api org.junit.jupiter.engine org.junit.jupiter.migrationsupport org.junit.jupiter.params org.junit.platform.console org.junit.platform.engine org.junit.platform.launcher org.junit.platform.reporting org.junit.platform.runner org.junit.platform.suite.api org.junit.platform.suite.commons org.junit.platform.suite.engine org.junit.platform.testkit org.junit.vintage.engine
qualified exports org.junit.platform.commons.util to org.junit.jupiter.api org.junit.jupiter.engine org.junit.jupiter.migrationsupport org.junit.jupiter.params org.junit.platform.console org.junit.platform.engine org.junit.platform.jfr org.junit.platform.launcher org.junit.platform.reporting org.junit.platform.runner org.junit.platform.suite.api org.junit.platform.suite.commons org.junit.platform.suite.engine org.junit.platform.testkit org.junit.vintage.engine