From f8ca2d3c2046301b48f8642680a69bc3e1294553 Mon Sep 17 00:00:00 2001 From: Marc Philipp Date: Thu, 10 Oct 2024 08:02:11 +0200 Subject: [PATCH] Revise naming and documentation of `ExtensionContextScope` --- .../jupiter/api/extension/ParameterResolver.java | 2 +- ...nstanceConstructionParticipatingExtension.java | 15 ++++++++------- .../execution/ExtensionContextSupplier.java | 4 ++-- .../jupiter/engine/extension/TempDirectory.java | 4 ++-- .../api/extension/KitchenSinkExtension.java | 2 +- .../extension/TestInstanceFactoryTests.java | 6 +++--- .../extension/TestInstancePostProcessorTests.java | 6 +++--- .../TestInstancePreConstructCallbackTests.java | 8 ++++---- 8 files changed, 24 insertions(+), 23 deletions(-) diff --git a/junit-jupiter-api/src/main/java/org/junit/jupiter/api/extension/ParameterResolver.java b/junit-jupiter-api/src/main/java/org/junit/jupiter/api/extension/ParameterResolver.java index 7bb065e86ce1..add7c205a753 100644 --- a/junit-jupiter-api/src/main/java/org/junit/jupiter/api/extension/ParameterResolver.java +++ b/junit-jupiter-api/src/main/java/org/junit/jupiter/api/extension/ParameterResolver.java @@ -35,7 +35,7 @@ * {@link #getExtensionContextScopeDuringTestClassInstanceConstruction} to * support injecting test specific data into constructor parameters of the test * class instance. Returning - * {@link ExtensionContextScope#TEST_SCOPED TEST_SCOPED} from this method, + * {@link ExtensionContextScope#TEST_METHOD TEST_SCOPED} from this method, * causes a test-specific {@link ExtensionContext} to be used while resolving * constructor parameters, unless the lifecycle is set to * {@link TestInstance.Lifecycle#PER_CLASS PER_CLASS}. diff --git a/junit-jupiter-api/src/main/java/org/junit/jupiter/api/extension/TestClassInstanceConstructionParticipatingExtension.java b/junit-jupiter-api/src/main/java/org/junit/jupiter/api/extension/TestClassInstanceConstructionParticipatingExtension.java index 8fbc4044be3e..2c7228d769d8 100644 --- a/junit-jupiter-api/src/main/java/org/junit/jupiter/api/extension/TestClassInstanceConstructionParticipatingExtension.java +++ b/junit-jupiter-api/src/main/java/org/junit/jupiter/api/extension/TestClassInstanceConstructionParticipatingExtension.java @@ -35,7 +35,7 @@ public interface TestClassInstanceConstructionParticipatingExtension extends Ext * {@link ExtensionContext} during the creation of test instances. * *

If an extension returns - * {@link ExtensionContextScope#TEST_SCOPED TEST_SCOPED} from this method, + * {@link ExtensionContextScope#TEST_METHOD TEST_SCOPED} from this method, * the following extension methods will be called with a test-scoped * {@link ExtensionContext} instead of a class-scoped one, unless the * {@link TestInstance.Lifecycle#PER_CLASS PER_CLASS} lifecycle is used: @@ -69,7 +69,7 @@ public interface TestClassInstanceConstructionParticipatingExtension extends Ext * * *

Note: The behavior which is enabled by returning - * {@link ExtensionContextScope#TEST_SCOPED TEST_SCOPED} from this method + * {@link ExtensionContextScope#TEST_METHOD TEST_SCOPED} from this method * will become the default in future versions of JUnit. To ensure future * compatibility, extension implementors are therefore advised to opt in, * even if they don't require the new functionality. @@ -91,8 +91,8 @@ default ExtensionContextScope getExtensionContextScopeDuringTestClassInstanceCon /** * {@code ExtensionContextScope} is used to define the scope of the - * {@link ExtensionContext} passed to an extension during the creation of - * test instances. + * {@link ExtensionContext} passed to an extension during the construction + * of test class instances. * * @since 5.12 * @see TestClassInstanceConstructionParticipatingExtension#getExtensionContextScopeDuringTestClassInstanceConstruction @@ -105,7 +105,7 @@ enum ExtensionContextScope { * the test class. * * @deprecated This behavior will be removed from future versions of - * JUnit and {@link #TEST_SCOPED} will become the default. + * JUnit and {@link #TEST_METHOD} will become the default. */ @API(status = DEPRECATED, since = "5.12") // @Deprecated @@ -113,9 +113,10 @@ enum ExtensionContextScope { /** * The extension should receive an {@link ExtensionContext} scoped to - * the test instance. + * the test method, unless the + * {@link TestInstance.Lifecycle#PER_CLASS PER_CLASS} lifecycle is used. */ - TEST_SCOPED + TEST_METHOD } } diff --git a/junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/execution/ExtensionContextSupplier.java b/junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/execution/ExtensionContextSupplier.java index f52c657f6ec2..ca1eac049ca8 100644 --- a/junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/execution/ExtensionContextSupplier.java +++ b/junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/execution/ExtensionContextSupplier.java @@ -11,7 +11,7 @@ package org.junit.jupiter.engine.execution; import static org.apiguardian.api.API.Status.INTERNAL; -import static org.junit.jupiter.api.extension.TestClassInstanceConstructionParticipatingExtension.ExtensionContextScope.TEST_SCOPED; +import static org.junit.jupiter.api.extension.TestClassInstanceConstructionParticipatingExtension.ExtensionContextScope.TEST_METHOD; import org.apiguardian.api.API; import org.junit.jupiter.api.extension.ExtensionContext; @@ -46,6 +46,6 @@ public ExtensionContext get(TestClassInstanceConstructionParticipatingExtension private boolean isTestScoped(TestClassInstanceConstructionParticipatingExtension extension) { ExtensionContext rootContext = currentExtensionContext.getRoot(); - return extension.getExtensionContextScopeDuringTestClassInstanceConstruction(rootContext) == TEST_SCOPED; + return extension.getExtensionContextScopeDuringTestClassInstanceConstruction(rootContext) == TEST_METHOD; } } diff --git a/junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/extension/TempDirectory.java b/junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/extension/TempDirectory.java index b45485f57cba..ea79a5866559 100644 --- a/junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/extension/TempDirectory.java +++ b/junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/extension/TempDirectory.java @@ -12,7 +12,7 @@ import static java.nio.file.FileVisitResult.CONTINUE; import static java.util.stream.Collectors.joining; -import static org.junit.jupiter.api.extension.TestClassInstanceConstructionParticipatingExtension.ExtensionContextScope.TEST_SCOPED; +import static org.junit.jupiter.api.extension.TestClassInstanceConstructionParticipatingExtension.ExtensionContextScope.TEST_METHOD; import static org.junit.jupiter.api.io.CleanupMode.DEFAULT; import static org.junit.jupiter.api.io.CleanupMode.NEVER; import static org.junit.jupiter.api.io.CleanupMode.ON_SUCCESS; @@ -96,7 +96,7 @@ public TempDirectory(JupiterConfiguration configuration) { @Override public ExtensionContextScope getExtensionContextScopeDuringTestClassInstanceConstruction( ExtensionContext rootContext) { - return TEST_SCOPED; + return TEST_METHOD; } /** diff --git a/jupiter-tests/src/test/java/org/junit/jupiter/api/extension/KitchenSinkExtension.java b/jupiter-tests/src/test/java/org/junit/jupiter/api/extension/KitchenSinkExtension.java index 8e9e7f70e26d..a102e5d6a1ac 100644 --- a/jupiter-tests/src/test/java/org/junit/jupiter/api/extension/KitchenSinkExtension.java +++ b/jupiter-tests/src/test/java/org/junit/jupiter/api/extension/KitchenSinkExtension.java @@ -70,7 +70,7 @@ public class KitchenSinkExtension implements @Override public ExtensionContextScope getExtensionContextScopeDuringTestClassInstanceConstruction( ExtensionContext rootContext) { - return ExtensionContextScope.TEST_SCOPED; + return ExtensionContextScope.TEST_METHOD; } // --- Lifecycle Callbacks ------------------------------------------------- diff --git a/jupiter-tests/src/test/java/org/junit/jupiter/engine/extension/TestInstanceFactoryTests.java b/jupiter-tests/src/test/java/org/junit/jupiter/engine/extension/TestInstanceFactoryTests.java index 5c712c329c44..1306ab73a351 100644 --- a/jupiter-tests/src/test/java/org/junit/jupiter/engine/extension/TestInstanceFactoryTests.java +++ b/jupiter-tests/src/test/java/org/junit/jupiter/engine/extension/TestInstanceFactoryTests.java @@ -13,7 +13,7 @@ import static org.assertj.core.api.Assertions.assertThat; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.TestInstance.Lifecycle.PER_CLASS; -import static org.junit.jupiter.api.extension.TestClassInstanceConstructionParticipatingExtension.ExtensionContextScope.TEST_SCOPED; +import static org.junit.jupiter.api.extension.TestClassInstanceConstructionParticipatingExtension.ExtensionContextScope.TEST_METHOD; import static org.junit.platform.commons.util.ClassUtils.nullSafeToString; import static org.junit.platform.testkit.engine.EventConditions.container; import static org.junit.platform.testkit.engine.EventConditions.engine; @@ -710,7 +710,7 @@ private static class FooInstanceFactory extends AbstractTestInstanceFactory { @Override public ExtensionContextScope getExtensionContextScopeDuringTestClassInstanceConstruction( ExtensionContext rootContext) { - return TEST_SCOPED; + return TEST_METHOD; } } @@ -718,7 +718,7 @@ private static class BarInstanceFactory extends AbstractTestInstanceFactory { @Override public ExtensionContextScope getExtensionContextScopeDuringTestClassInstanceConstruction( ExtensionContext rootContext) { - return TEST_SCOPED; + return TEST_METHOD; } } diff --git a/jupiter-tests/src/test/java/org/junit/jupiter/engine/extension/TestInstancePostProcessorTests.java b/jupiter-tests/src/test/java/org/junit/jupiter/engine/extension/TestInstancePostProcessorTests.java index 7d2c365ab092..d8b3eb283ca1 100644 --- a/jupiter-tests/src/test/java/org/junit/jupiter/engine/extension/TestInstancePostProcessorTests.java +++ b/jupiter-tests/src/test/java/org/junit/jupiter/engine/extension/TestInstancePostProcessorTests.java @@ -12,7 +12,7 @@ import static org.assertj.core.api.Assertions.assertThat; import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.extension.TestClassInstanceConstructionParticipatingExtension.ExtensionContextScope.TEST_SCOPED; +import static org.junit.jupiter.api.extension.TestClassInstanceConstructionParticipatingExtension.ExtensionContextScope.TEST_METHOD; import java.util.ArrayList; import java.util.HashMap; @@ -206,7 +206,7 @@ static class FooInstancePostProcessor extends AbstractInstancePostProcessor { @Override public ExtensionContextScope getExtensionContextScopeDuringTestClassInstanceConstruction( ExtensionContext rootContext) { - return TEST_SCOPED; + return TEST_METHOD; } } @@ -218,7 +218,7 @@ static class BarInstancePostProcessor extends AbstractInstancePostProcessor { @Override public ExtensionContextScope getExtensionContextScopeDuringTestClassInstanceConstruction( ExtensionContext rootContext) { - return TEST_SCOPED; + return TEST_METHOD; } } diff --git a/jupiter-tests/src/test/java/org/junit/jupiter/engine/extension/TestInstancePreConstructCallbackTests.java b/jupiter-tests/src/test/java/org/junit/jupiter/engine/extension/TestInstancePreConstructCallbackTests.java index 98c32fac50a2..da3dadc07513 100644 --- a/jupiter-tests/src/test/java/org/junit/jupiter/engine/extension/TestInstancePreConstructCallbackTests.java +++ b/jupiter-tests/src/test/java/org/junit/jupiter/engine/extension/TestInstancePreConstructCallbackTests.java @@ -11,7 +11,7 @@ package org.junit.jupiter.engine.extension; import static org.assertj.core.api.Assertions.assertThat; -import static org.junit.jupiter.api.extension.TestClassInstanceConstructionParticipatingExtension.ExtensionContextScope.TEST_SCOPED; +import static org.junit.jupiter.api.extension.TestClassInstanceConstructionParticipatingExtension.ExtensionContextScope.TEST_METHOD; import java.util.ArrayList; import java.util.List; @@ -560,7 +560,7 @@ static class InstancePreConstructCallbackRecordingFoo extends AbstractTestInstan @Override public ExtensionContextScope getExtensionContextScopeDuringTestClassInstanceConstruction( ExtensionContext rootContext) { - return TEST_SCOPED; + return TEST_METHOD; } } @@ -572,7 +572,7 @@ static class InstancePreConstructCallbackRecordingBar extends AbstractTestInstan @Override public ExtensionContextScope getExtensionContextScopeDuringTestClassInstanceConstruction( ExtensionContext rootContext) { - return TEST_SCOPED; + return TEST_METHOD; } } @@ -584,7 +584,7 @@ static class InstancePreConstructCallbackRecordingBaz extends AbstractTestInstan @Override public ExtensionContextScope getExtensionContextScopeDuringTestClassInstanceConstruction( ExtensionContext rootContext) { - return TEST_SCOPED; + return TEST_METHOD; } }