Allow @ResourceLock on @ClassTemplate classes (#5245)

uglide · raccoonback · mpkorstanje · web-flow · commit 4133d24bc557 · 2025-12-28T14:33:21.000Z
Backport of #5155 to 5.14.x. --------- Signed-off-by: Igor Malinovskiy <igor.malinovskiy@redis.com> Co-authored-by: raccoonback <kosb15@naver.com> Co-authored-by: M.P. Korstanje <mpkorstanje@users.noreply.github.com> Co-authored-by: Marc Philipp <mail@marcphilipp.de>
diff --git a/documentation/modules/ROOT/partials/release-notes/release-notes-5.14.2.adoc b/documentation/modules/ROOT/partials/release-notes/release-notes-5.14.2.adoc
@@ -3,7 +3,7 @@
 
 *Date of Release:* ❓
 
-*Scope:* ❓
+*Scope:* Bug fixes and enhancements since 5.14.1
 
 For a complete list of all _closed_ issues and pull requests for this release, consult the
 link:{junit-framework-repo}+/milestone/115?closed=1+[5.14.2] milestone page in the JUnit
@@ -35,7 +35,8 @@ repository on GitHub.
 [[v5.14.2-junit-jupiter-bug-fixes]]
 ==== Bug Fixes
 
-* ❓
+* Allow using `@ResourceLock` on classes annotated with `@ClassTemplate` (or
+  `@ParameterizedClass`).
 
 [[v5.14.2-junit-jupiter-deprecations-and-breaking-changes]]
 ==== Deprecations and Breaking Changes
diff --git a/junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/descriptor/ClassTemplateInvocationTestDescriptor.java b/junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/descriptor/ClassTemplateInvocationTestDescriptor.java
@@ -10,6 +10,7 @@
 
 package org.junit.jupiter.engine.descriptor;
 
+import static java.util.Collections.emptySet;
 import static org.apiguardian.api.API.Status.INTERNAL;
 import static org.junit.jupiter.engine.descriptor.CallbackSupport.invokeAfterCallbacks;
 import static org.junit.jupiter.engine.descriptor.CallbackSupport.invokeBeforeCallbacks;
@@ -34,6 +35,7 @@
 import org.junit.jupiter.engine.extension.MutableExtensionRegistry;
 import org.junit.platform.engine.TestSource;
 import org.junit.platform.engine.UniqueId;
+import org.junit.platform.engine.support.hierarchical.ExclusiveResource;
 import org.junit.platform.engine.support.hierarchical.ThrowableCollector;
 
 /**
@@ -108,6 +110,12 @@ public Function<ResourceLocksProvider, Set<ResourceLocksProvider.Lock>> getResou
 
 	// --- Node ----------------------------------------------------------------
 
+	@Override
+	public Set<ExclusiveResource> getExclusiveResources() {
+		// Resources are already collected and returned by the enclosing ClassTemplateTestDescriptor
+		return emptySet();
+	}
+
 	@Override
 	public JupiterEngineExecutionContext prepare(JupiterEngineExecutionContext context) {
 		MutableExtensionRegistry registry = context.getExtensionRegistry();
diff --git a/jupiter-tests/src/test/java/org/junit/jupiter/engine/ClassTemplateInvocationTests.java b/jupiter-tests/src/test/java/org/junit/jupiter/engine/ClassTemplateInvocationTests.java
@@ -78,6 +78,7 @@
 import org.junit.jupiter.api.extension.ParameterResolutionException;
 import org.junit.jupiter.api.extension.ParameterResolver;
 import org.junit.jupiter.api.extension.RegisterExtension;
+import org.junit.jupiter.api.parallel.ResourceLock;
 import org.junit.jupiter.engine.descriptor.ClassTemplateInvocationTestDescriptor;
 import org.junit.jupiter.engine.descriptor.ClassTemplateTestDescriptor;
 import org.junit.jupiter.engine.descriptor.ClassTestDescriptor;
@@ -94,6 +95,7 @@
 import org.junit.platform.engine.UniqueId;
 import org.junit.platform.engine.discovery.DiscoverySelectors;
 import org.junit.platform.engine.reporting.ReportEntry;
+import org.junit.platform.engine.support.hierarchical.ExclusiveResource;
 import org.junit.platform.testkit.engine.EngineExecutionResults;
 import org.opentest4j.AssertionFailedError;
 import org.opentest4j.TestAbortedException;
@@ -1003,6 +1005,24 @@ void ignoresComposedAnnotations() {
 		assertThat(engineDescriptor.getDescendants()).isEmpty();
 	}
 
+	@Test
+	void classTemplateWithResourceLockCollectsExclusiveResources() {
+		var results = discoverTestsForClass(ClassTemplateWithResourceLockTestCase.class);
+		var classTemplateDescriptor = (ClassTemplateTestDescriptor) getOnlyElement(
+			results.getEngineDescriptor().getChildren());
+
+		assertThat(classTemplateDescriptor.getExclusiveResources()).extracting(
+			ExclusiveResource::getKey).containsExactly("test-resource");
+	}
+
+	@Test
+	void classTemplateWithResourceLockExecutesSuccessfully() {
+		var results = executeTestsForClass(ClassTemplateWithResourceLockTestCase.class);
+
+		results.testEvents().assertStatistics(stats -> stats.started(2).succeeded(2));
+		results.containerEvents().assertStatistics(stats -> stats.started(4).succeeded(4));
+	}
+
 	// -------------------------------------------------------------------
 
 	private static Stream<String> allReportEntryValues(EngineExecutionResults results) {
@@ -1566,4 +1586,15 @@ void test() {
 		}
 	}
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
+	@ClassTemplate
+	@ExtendWith(TwoInvocationsClassTemplateInvocationContextProvider.class)
+	@ResourceLock("test-resource")
+	static class ClassTemplateWithResourceLockTestCase {
+		@Test
+		void test() {
+			// This test verifies that @ResourceLock works with @ClassTemplate (issue #5155)
+		}
+	}
+
 }
