Add @Suite classes via which issue is encountered to message

Author: marcphilipp

junit-platform-suite-engine/src/main/java/org/junit/platform/suite/engine/SuiteTestDescriptor.java

@@ -10,11 +10,16 @@
 
 package org.junit.platform.suite.engine;
 
+import static java.util.function.Predicate.isEqual;
+import static java.util.stream.Collectors.joining;
 import static org.junit.platform.commons.support.AnnotationSupport.findAnnotation;
+import static org.junit.platform.commons.util.FunctionUtils.where;
 import static org.junit.platform.suite.commons.SuiteLauncherDiscoveryRequestBuilder.request;
 
 import java.lang.reflect.Method;
 import java.util.List;
+import java.util.function.BiFunction;
+import java.util.function.Predicate;
 
 import org.junit.platform.commons.JUnitException;
 import org.junit.platform.commons.support.ReflectionSupport;
@@ -27,6 +32,7 @@
 import org.junit.platform.engine.TestDescriptor;
 import org.junit.platform.engine.TestExecutionResult;
 import org.junit.platform.engine.UniqueId;
+import org.junit.platform.engine.UniqueId.Segment;
 import org.junit.platform.engine.discovery.DiscoverySelectors;
 import org.junit.platform.engine.reporting.OutputDirectoryProvider;
 import org.junit.platform.engine.support.descriptor.AbstractTestDescriptor;
@@ -75,7 +81,7 @@ final class SuiteTestDescriptor extends AbstractTestDescriptor {
 		this.failIfNoTests = getFailIfNoTests(suiteClass);
 		this.suiteClass = suiteClass;
 		this.lifecycleMethods = new LifecycleMethods(suiteClass, issueReporter);
-		this.discoveryRequestBuilder.listener(new DiscoveryIssueForwardingListener(discoveryListener));
+		this.discoveryRequestBuilder.listener(DiscoveryIssueForwardingListener.create(id, discoveryListener));
 	}
 
 	private static Boolean getFailIfNoTests(Class<?> suiteClass) {
@@ -216,25 +222,43 @@ private static class LifecycleMethods {
 
 	private static class DiscoveryIssueForwardingListener implements LauncherDiscoveryListener {
 
+		private static final Predicate<Segment> SUITE_SEGMENTS = where(Segment::getType, isEqual(SEGMENT_TYPE));
+
+		static DiscoveryIssueForwardingListener create(UniqueId id, EngineDiscoveryListener discoveryListener) {
+			boolean isNestedSuite = id.getSegments().stream().filter(SUITE_SEGMENTS).count() > 1;
+			if (isNestedSuite) {
+				return new DiscoveryIssueForwardingListener(discoveryListener, (__, issue) -> issue);
+			}
+			return new DiscoveryIssueForwardingListener(discoveryListener,
+				(engineUniqueId, issue) -> issue.withMessage(message -> {
+					String engineId = engineUniqueId.getLastSegment().getValue();
+					if (SuiteEngineDescriptor.ENGINE_ID.equals(engineId)) {
+						return message;
+					}
+					String suitePath = engineUniqueId.getSegments().stream() //
+							.filter(SUITE_SEGMENTS) //
+							.map(Segment::getValue) //
+							.collect(joining(" > "));
+					if (message.endsWith(".")) {
+						message = message.substring(0, message.length() - 1);
+					}
+					return String.format("[%s] %s (via @Suite %s).", engineId, message, suitePath);
+				}));
+		}
+
 		private final EngineDiscoveryListener discoveryListener;
+		private final BiFunction<UniqueId, DiscoveryIssue, DiscoveryIssue> issueTransformer;
 
-		DiscoveryIssueForwardingListener(EngineDiscoveryListener discoveryListener) {
+		private DiscoveryIssueForwardingListener(EngineDiscoveryListener discoveryListener,
+				BiFunction<UniqueId, DiscoveryIssue, DiscoveryIssue> issueTransformer) {
 			this.discoveryListener = discoveryListener;
+			this.issueTransformer = issueTransformer;
 		}
 
 		@Override
 		public void issueEncountered(UniqueId engineUniqueId, DiscoveryIssue issue) {
-			String engineId = engineUniqueId.getLastSegment().getValue();
-			if (!SuiteEngineDescriptor.ENGINE_ID.equals(engineId)) {
-				issue = issue.withMessage(message -> {
-					String prefix = String.format("[%s] ", engineId);
-					if (message.startsWith(prefix)) {
-						return message;
-					}
-					return prefix + message;
-				});
-			}
-			discoveryListener.issueEncountered(engineUniqueId, issue);
+			DiscoveryIssue transformedIssue = this.issueTransformer.apply(engineUniqueId, issue);
+			this.discoveryListener.issueEncountered(engineUniqueId, transformedIssue);
 		}
 	}
 }

platform-tests/src/test/java/org/junit/platform/suite/engine/SuiteEngineTests.java

@@ -60,6 +60,7 @@
 import org.junit.platform.suite.engine.testsuites.EmptyDynamicTestWithFailIfNoTestFalseSuite;
 import org.junit.platform.suite.engine.testsuites.EmptyTestCaseSuite;
 import org.junit.platform.suite.engine.testsuites.EmptyTestCaseWithFailIfNoTestFalseSuite;
+import org.junit.platform.suite.engine.testsuites.ErroneousTestSuite;
 import org.junit.platform.suite.engine.testsuites.InheritedSuite;
 import org.junit.platform.suite.engine.testsuites.MultiEngineSuite;
 import org.junit.platform.suite.engine.testsuites.MultipleSuite;
@@ -602,7 +603,10 @@ void discoveryIssueOfNestedTestEnginesAreReported() throws Exception {
 		assertThat(discoveryIssues).hasSize(1);
 
 		var issue = discoveryIssues.getFirst();
-		assertThat(issue.message()).startsWith("[junit-jupiter] @BeforeAll method");
+		assertThat(issue.message()) //
+				.startsWith("[junit-jupiter] @BeforeAll method") //
+				.endsWith(" (via @Suite %s > %s).".formatted(SuiteWithErroneousTestSuite.class.getName(),
+						ErroneousTestSuite.class.getName()));
 
 		var method = ErroneousTestCase.class.getDeclaredMethod("nonStaticLifecycleMethod");
 		assertThat(issue.source()).contains(MethodSource.from(method));

platform-tests/src/test/java/org/junit/platform/suite/engine/testsuites/ErroneousTestSuite.java

@@ -16,5 +16,5 @@
 
 @Suite
 @SelectClasses(ErroneousTestCase.class)
-class ErroneousTestSuite {
+public class ErroneousTestSuite {
 }