Avoid unnecessarily parsing unique IDs

Author: marcphilipp

documentation/src/docs/asciidoc/release-notes/release-notes-5.9.2.adoc

@@ -23,7 +23,8 @@ JUnit repository on GitHub.
 
 ==== New Features and Improvements
 
-* ❓
+* Introduce `TestPlan.getTestIdentifier(UniqueId)` and `TestPlan.getChildren(UniqueId)` to
+  avoid parsing unique IDs unnecessarily during test execution.
 
 
 [[release-notes-5.9.2-junit-jupiter]]

junit-jupiter-engine/src/test/java/org/junit/jupiter/engine/OverloadedTestMethodTests.java

@@ -18,6 +18,7 @@
 
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.TestInfo;
+import org.junit.platform.engine.UniqueId;
 import org.junit.platform.launcher.TestIdentifier;
 import org.junit.platform.testkit.engine.Event;
 import org.junit.platform.testkit.engine.Events;
@@ -40,7 +41,7 @@ void executeTestCaseWithOverloadedMethodsAndThenRerunOnlyOneOfTheMethodsSelected
 			event -> event.getTestDescriptor().getUniqueId().toString().contains(TestInfo.class.getName())).findFirst();
 		assertTrue(first.isPresent());
 		TestIdentifier testIdentifier = TestIdentifier.from(first.get().getTestDescriptor());
-		String uniqueId = testIdentifier.getUniqueId();
+		UniqueId uniqueId = testIdentifier.getUniqueIdObject();
 
 		tests = executeTests(selectUniqueId(uniqueId)).testEvents();
 

junit-platform-console/src/main/java/org/junit/platform/console/tasks/TreePrintingListener.java

@@ -17,6 +17,7 @@
 
 import org.junit.platform.console.options.Theme;
 import org.junit.platform.engine.TestExecutionResult;
+import org.junit.platform.engine.UniqueId;
 import org.junit.platform.engine.reporting.ReportEntry;
 import org.junit.platform.launcher.TestExecutionListener;
 import org.junit.platform.launcher.TestIdentifier;
@@ -27,23 +28,22 @@
  */
 class TreePrintingListener implements TestExecutionListener {
 
-	private final Map<String, TreeNode> nodesByUniqueId = new ConcurrentHashMap<>();
+	private final Map<UniqueId, TreeNode> nodesByUniqueId = new ConcurrentHashMap<>();
 	private TreeNode root;
 	private final TreePrinter treePrinter;
 
 	TreePrintingListener(PrintWriter out, ColorPalette colorPalette, Theme theme) {
 		this.treePrinter = new TreePrinter(out, theme, colorPalette);
 	}
 
-	private TreeNode addNode(TestIdentifier testIdentifier, Supplier<TreeNode> nodeSupplier) {
+	private void addNode(TestIdentifier testIdentifier, Supplier<TreeNode> nodeSupplier) {
 		TreeNode node = nodeSupplier.get();
-		nodesByUniqueId.put(testIdentifier.getUniqueId(), node);
-		testIdentifier.getParentId().map(nodesByUniqueId::get).orElse(root).addChild(node);
-		return node;
+		nodesByUniqueId.put(testIdentifier.getUniqueIdObject(), node);
+		testIdentifier.getParentIdObject().map(nodesByUniqueId::get).orElse(root).addChild(node);
 	}
 
 	private TreeNode getNode(TestIdentifier testIdentifier) {
-		return nodesByUniqueId.get(testIdentifier.getUniqueId());
+		return nodesByUniqueId.get(testIdentifier.getUniqueIdObject());
 	}
 
 	@Override

junit-platform-jfr/src/main/java/org/junit/platform/jfr/FlightRecordingExecutionListener.java

@@ -42,7 +42,7 @@
 public class FlightRecordingExecutionListener implements TestExecutionListener {
 
 	private final AtomicReference<TestPlanExecutionEvent> testPlanExecutionEvent = new AtomicReference<>();
-	private final Map<String, TestExecutionEvent> testExecutionEvents = new ConcurrentHashMap<>();
+	private final Map<org.junit.platform.engine.UniqueId, TestExecutionEvent> testExecutionEvents = new ConcurrentHashMap<>();
 
 	@Override
 	public void testPlanExecutionStarted(TestPlan plan) {
@@ -70,15 +70,15 @@ public void executionSkipped(TestIdentifier test, String reason) {
 	@Override
 	public void executionStarted(TestIdentifier test) {
 		TestExecutionEvent event = new TestExecutionEvent();
-		testExecutionEvents.put(test.getUniqueId(), event);
+		testExecutionEvents.put(test.getUniqueIdObject(), event);
 		event.initialize(test);
 		event.begin();
 	}
 
 	@Override
 	public void executionFinished(TestIdentifier test, TestExecutionResult result) {
 		Optional<Throwable> throwable = result.getThrowable();
-		TestExecutionEvent event = testExecutionEvents.remove(test.getUniqueId());
+		TestExecutionEvent event = testExecutionEvents.remove(test.getUniqueIdObject());
 		event.end();
 		event.result = result.getStatus().toString();
 		event.exceptionClass = throwable.map(Throwable::getClass).orElse(null);

junit-platform-launcher/src/main/java/org/junit/platform/launcher/TestPlan.java

@@ -158,19 +158,19 @@ public Set<TestIdentifier> getRoots() {
 	 */
 	public Optional<TestIdentifier> getParent(TestIdentifier child) {
 		Preconditions.notNull(child, "child must not be null");
-		return child.getParentId().map(this::getTestIdentifier);
+		return child.getParentIdObject().map(this::getTestIdentifier);
 	}
 
 	/**
 	 * Get the children of the supplied {@link TestIdentifier}.
 	 *
 	 * @param parent the identifier to look up the children for; never {@code null}
 	 * @return an unmodifiable set of the parent's children, potentially empty
-	 * @see #getChildren(String)
+	 * @see #getChildren(UniqueId)
 	 */
 	public Set<TestIdentifier> getChildren(TestIdentifier parent) {
 		Preconditions.notNull(parent, "parent must not be null");
-		return getChildren(parent.getUniqueId());
+		return getChildren(parent.getUniqueIdObject());
 	}
 
 	/**
@@ -180,11 +180,26 @@ public Set<TestIdentifier> getChildren(TestIdentifier parent) {
 	 * {@code null} or blank
 	 * @return an unmodifiable set of the parent's children, potentially empty
 	 * @see #getChildren(TestIdentifier)
+	 * @deprecated Use {@link #getChildren(UniqueId)}
 	 */
+	@API(status = DEPRECATED, since = "1.10")
+	@Deprecated
 	public Set<TestIdentifier> getChildren(String parentId) {
 		Preconditions.notBlank(parentId, "parent ID must not be null or blank");
-		UniqueId uniqueId = UniqueId.parse(parentId);
-		return children.containsKey(uniqueId) ? unmodifiableSet(children.get(uniqueId)) : emptySet();
+		return getChildren(UniqueId.parse(parentId));
+	}
+
+	/**
+	 * Get the children of the supplied unique ID.
+	 *
+	 * @param parentId the unique ID to look up the children for; never
+	 * {@code null}
+	 * @return an unmodifiable set of the parent's children, potentially empty
+	 * @see #getChildren(TestIdentifier)
+	 */
+	@API(status = MAINTAINED, since = "1.10")
+	public Set<TestIdentifier> getChildren(UniqueId parentId) {
+		return children.containsKey(parentId) ? unmodifiableSet(children.get(parentId)) : emptySet();
 	}
 
 	/**
@@ -195,13 +210,29 @@ public Set<TestIdentifier> getChildren(String parentId) {
 	 * @return the identifier with the supplied unique ID; never {@code null}
 	 * @throws PreconditionViolationException if no {@code TestIdentifier}
 	 * with the supplied unique ID is present in this test plan
+	 * @deprecated Use {@link #getTestIdentifier(UniqueId)}
 	 */
+	@API(status = DEPRECATED, since = "1.10")
+	@Deprecated
 	public TestIdentifier getTestIdentifier(String uniqueId) throws PreconditionViolationException {
 		Preconditions.notBlank(uniqueId, "unique ID must not be null or blank");
-		UniqueId uniqueIdObject = UniqueId.parse(uniqueId);
-		Preconditions.condition(allIdentifiers.containsKey(uniqueIdObject),
+		return getTestIdentifier(UniqueId.parse(uniqueId));
+	}
+
+	/**
+	 * Get the {@link TestIdentifier} with the supplied unique ID.
+	 *
+	 * @param uniqueId the unique ID to look up the identifier for; never
+	 * {@code null}
+	 * @return the identifier with the supplied unique ID; never {@code null}
+	 * @throws PreconditionViolationException if no {@code TestIdentifier}
+	 * with the supplied unique ID is present in this test plan
+	 */
+	@API(status = MAINTAINED, since = "1.10")
+	public TestIdentifier getTestIdentifier(UniqueId uniqueId) {
+		Preconditions.notNull(uniqueId, () -> "uniqueId must not be null");
+		return Preconditions.notNull(allIdentifiers.get(uniqueId),
 			() -> "No TestIdentifier with unique ID [" + uniqueId + "] has been added to this TestPlan.");
-		return allIdentifiers.get(uniqueIdObject);
 	}
 
 	/**

junit-platform-launcher/src/main/java/org/junit/platform/launcher/core/ExecutionListenerAdapter.java

@@ -62,7 +62,7 @@ public void reportingEntryPublished(TestDescriptor testDescriptor, ReportEntry e
 	}
 
 	private TestIdentifier getTestIdentifier(TestDescriptor testDescriptor) {
-		return this.testPlan.getTestIdentifier(testDescriptor.getUniqueId().toString());
+		return this.testPlan.getTestIdentifier(testDescriptor.getUniqueId());
 	}
 
 }

junit-platform-launcher/src/main/java/org/junit/platform/launcher/core/InternalTestPlan.java

@@ -16,6 +16,7 @@
 import java.util.function.Predicate;
 
 import org.junit.platform.commons.PreconditionViolationException;
+import org.junit.platform.engine.UniqueId;
 import org.junit.platform.launcher.TestIdentifier;
 import org.junit.platform.launcher.TestPlan;
 
@@ -80,16 +81,28 @@ public Set<TestIdentifier> getChildren(TestIdentifier parent) {
 		return delegate.getChildren(parent);
 	}
 
+	@SuppressWarnings("deprecation")
 	@Override
 	public Set<TestIdentifier> getChildren(String parentId) {
 		return delegate.getChildren(parentId);
 	}
 
+	@Override
+	public Set<TestIdentifier> getChildren(UniqueId parentId) {
+		return delegate.getChildren(parentId);
+	}
+
+	@SuppressWarnings("deprecation")
 	@Override
 	public TestIdentifier getTestIdentifier(String uniqueId) throws PreconditionViolationException {
 		return delegate.getTestIdentifier(uniqueId);
 	}
 
+	@Override
+	public TestIdentifier getTestIdentifier(UniqueId uniqueId) {
+		return delegate.getTestIdentifier(uniqueId);
+	}
+
 	@Override
 	public long countTestIdentifiers(Predicate<? super TestIdentifier> predicate) {
 		return delegate.countTestIdentifiers(predicate);

junit-platform-reporting/src/main/java/org/junit/platform/reporting/legacy/xml/LegacyXmlReportGeneratingListener.java

@@ -24,7 +24,6 @@
 
 import org.apiguardian.api.API;
 import org.junit.platform.engine.TestExecutionResult;
-import org.junit.platform.engine.UniqueId;
 import org.junit.platform.engine.reporting.ReportEntry;
 import org.junit.platform.launcher.TestExecutionListener;
 import org.junit.platform.launcher.TestIdentifier;
@@ -107,7 +106,7 @@ public void executionFinished(TestIdentifier testIdentifier, TestExecutionResult
 
 	private void writeXmlReportInCaseOfRoot(TestIdentifier testIdentifier) {
 		if (isRoot(testIdentifier)) {
-			String rootName = UniqueId.parse(testIdentifier.getUniqueId()).getSegments().get(0).getValue();
+			String rootName = testIdentifier.getUniqueIdObject().getSegments().get(0).getValue();
 			writeXmlReportSafely(testIdentifier, rootName);
 		}
 	}
@@ -123,7 +122,7 @@ private void writeXmlReportSafely(TestIdentifier testIdentifier, String rootName
 	}
 
 	private boolean isRoot(TestIdentifier testIdentifier) {
-		return !testIdentifier.getParentId().isPresent();
+		return !testIdentifier.getParentIdObject().isPresent();
 	}
 
 	private void printException(String message, Exception exception) {

junit-platform-runner/src/main/java/org/junit/platform/runner/JUnitPlatform.java

@@ -191,7 +191,7 @@ public void filter(Filter filter) throws NoTestsRemainException {
 	private LauncherDiscoveryRequest createDiscoveryRequestForUniqueIds(Set<TestIdentifier> testIdentifiers) {
 		// @formatter:off
 		List<DiscoverySelector> selectors = testIdentifiers.stream()
-				.map(TestIdentifier::getUniqueId)
+				.map(TestIdentifier::getUniqueIdObject)
 				.map(DiscoverySelectors::selectUniqueId)
 				.collect(toList());
 		// @formatter:on

junit-platform-runner/src/main/java/org/junit/platform/runner/JUnitPlatformRunnerListener.java

@@ -15,6 +15,7 @@
 
 import org.junit.platform.engine.TestExecutionResult;
 import org.junit.platform.engine.TestExecutionResult.Status;
+import org.junit.platform.engine.UniqueId;
 import org.junit.platform.engine.reporting.ReportEntry;
 import org.junit.platform.launcher.TestExecutionListener;
 import org.junit.platform.launcher.TestIdentifier;
@@ -37,7 +38,7 @@ class JUnitPlatformRunnerListener implements TestExecutionListener {
 
 	@Override
 	public void dynamicTestRegistered(TestIdentifier testIdentifier) {
-		String parentId = testIdentifier.getParentId().get();
+		UniqueId parentId = testIdentifier.getParentIdObject().get();
 		testTree.addDynamicDescription(testIdentifier, parentId);
 	}