Skip to content

Commit 0da53ce

Browse files
committed
Revise naming and documentation of ExtensionContextScope
1 parent 93acf9e commit 0da53ce

File tree

8 files changed

+24
-23
lines changed

8 files changed

+24
-23
lines changed

junit-jupiter-api/src/main/java/org/junit/jupiter/api/extension/ParameterResolver.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
* {@link #getExtensionContextScopeDuringTestClassInstanceConstruction} to
3636
* support injecting test specific data into constructor parameters of the test
3737
* class instance. Returning
38-
* {@link ExtensionContextScope#TEST_SCOPED TEST_SCOPED} from this method,
38+
* {@link ExtensionContextScope#TEST_METHOD TEST_SCOPED} from this method,
3939
* causes a test-specific {@link ExtensionContext} to be used while resolving
4040
* constructor parameters, unless the lifecycle is set to
4141
* {@link TestInstance.Lifecycle#PER_CLASS PER_CLASS}.

junit-jupiter-api/src/main/java/org/junit/jupiter/api/extension/TestClassInstanceConstructionParticipatingExtension.java

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ public interface TestClassInstanceConstructionParticipatingExtension extends Ext
3535
* {@link ExtensionContext} during the creation of test instances.
3636
*
3737
* <p>If an extension returns
38-
* {@link ExtensionContextScope#TEST_SCOPED TEST_SCOPED} from this method,
38+
* {@link ExtensionContextScope#TEST_METHOD TEST_SCOPED} from this method,
3939
* the following extension methods will be called with a test-scoped
4040
* {@link ExtensionContext} instead of a class-scoped one, unless the
4141
* {@link TestInstance.Lifecycle#PER_CLASS PER_CLASS} lifecycle is used:
@@ -69,7 +69,7 @@ public interface TestClassInstanceConstructionParticipatingExtension extends Ext
6969
* </ul>
7070
*
7171
* <p><strong>Note</strong>: The behavior which is enabled by returning
72-
* {@link ExtensionContextScope#TEST_SCOPED TEST_SCOPED} from this method
72+
* {@link ExtensionContextScope#TEST_METHOD TEST_SCOPED} from this method
7373
* will become the default in future versions of JUnit. To ensure future
7474
* compatibility, extension implementors are therefore advised to opt in,
7575
* even if they don't require the new functionality.
@@ -91,8 +91,8 @@ default ExtensionContextScope getExtensionContextScopeDuringTestClassInstanceCon
9191

9292
/**
9393
* {@code ExtensionContextScope} is used to define the scope of the
94-
* {@link ExtensionContext} passed to an extension during the creation of
95-
* test instances.
94+
* {@link ExtensionContext} passed to an extension during the construction
95+
* of test class instances.
9696
*
9797
* @since 5.12
9898
* @see TestClassInstanceConstructionParticipatingExtension#getExtensionContextScopeDuringTestClassInstanceConstruction
@@ -105,17 +105,18 @@ enum ExtensionContextScope {
105105
* the test class.
106106
*
107107
* @deprecated This behavior will be removed from future versions of
108-
* JUnit and {@link #TEST_SCOPED} will become the default.
108+
* JUnit and {@link #TEST_METHOD} will become the default.
109109
*/
110110
@API(status = DEPRECATED, since = "5.12") //
111111
@Deprecated
112112
DEFAULT,
113113

114114
/**
115115
* The extension should receive an {@link ExtensionContext} scoped to
116-
* the test instance.
116+
* the test method, unless the
117+
* {@link TestInstance.Lifecycle#PER_CLASS PER_CLASS} lifecycle is used.
117118
*/
118-
TEST_SCOPED
119+
TEST_METHOD
119120
}
120121

121122
}

junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/execution/ExtensionContextSupplier.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
package org.junit.jupiter.engine.execution;
1212

1313
import static org.apiguardian.api.API.Status.INTERNAL;
14-
import static org.junit.jupiter.api.extension.TestClassInstanceConstructionParticipatingExtension.ExtensionContextScope.TEST_SCOPED;
14+
import static org.junit.jupiter.api.extension.TestClassInstanceConstructionParticipatingExtension.ExtensionContextScope.TEST_METHOD;
1515

1616
import org.apiguardian.api.API;
1717
import org.junit.jupiter.api.extension.ExtensionContext;
@@ -46,6 +46,6 @@ public ExtensionContext get(TestClassInstanceConstructionParticipatingExtension
4646

4747
private boolean isTestScoped(TestClassInstanceConstructionParticipatingExtension extension) {
4848
ExtensionContext rootContext = currentExtensionContext.getRoot();
49-
return extension.getExtensionContextScopeDuringTestClassInstanceConstruction(rootContext) == TEST_SCOPED;
49+
return extension.getExtensionContextScopeDuringTestClassInstanceConstruction(rootContext) == TEST_METHOD;
5050
}
5151
}

junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/extension/TempDirectory.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
import static java.nio.file.FileVisitResult.CONTINUE;
1414
import static java.util.stream.Collectors.joining;
15-
import static org.junit.jupiter.api.extension.TestClassInstanceConstructionParticipatingExtension.ExtensionContextScope.TEST_SCOPED;
15+
import static org.junit.jupiter.api.extension.TestClassInstanceConstructionParticipatingExtension.ExtensionContextScope.TEST_METHOD;
1616
import static org.junit.jupiter.api.io.CleanupMode.DEFAULT;
1717
import static org.junit.jupiter.api.io.CleanupMode.NEVER;
1818
import static org.junit.jupiter.api.io.CleanupMode.ON_SUCCESS;
@@ -96,7 +96,7 @@ public TempDirectory(JupiterConfiguration configuration) {
9696
@Override
9797
public ExtensionContextScope getExtensionContextScopeDuringTestClassInstanceConstruction(
9898
ExtensionContext rootContext) {
99-
return TEST_SCOPED;
99+
return TEST_METHOD;
100100
}
101101

102102
/**

jupiter-tests/src/test/java/org/junit/jupiter/api/extension/KitchenSinkExtension.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ public class KitchenSinkExtension implements
7070
@Override
7171
public ExtensionContextScope getExtensionContextScopeDuringTestClassInstanceConstruction(
7272
ExtensionContext rootContext) {
73-
return ExtensionContextScope.TEST_SCOPED;
73+
return ExtensionContextScope.TEST_METHOD;
7474
}
7575

7676
// --- Lifecycle Callbacks -------------------------------------------------

jupiter-tests/src/test/java/org/junit/jupiter/engine/extension/TestInstanceFactoryTests.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
import static org.assertj.core.api.Assertions.assertThat;
1414
import static org.junit.jupiter.api.Assertions.assertEquals;
1515
import static org.junit.jupiter.api.TestInstance.Lifecycle.PER_CLASS;
16-
import static org.junit.jupiter.api.extension.TestClassInstanceConstructionParticipatingExtension.ExtensionContextScope.TEST_SCOPED;
16+
import static org.junit.jupiter.api.extension.TestClassInstanceConstructionParticipatingExtension.ExtensionContextScope.TEST_METHOD;
1717
import static org.junit.platform.commons.util.ClassUtils.nullSafeToString;
1818
import static org.junit.platform.testkit.engine.EventConditions.container;
1919
import static org.junit.platform.testkit.engine.EventConditions.engine;
@@ -725,15 +725,15 @@ private static class FooInstanceFactory extends AbstractTestInstanceFactory {
725725
@Override
726726
public ExtensionContextScope getExtensionContextScopeDuringTestClassInstanceConstruction(
727727
ExtensionContext rootContext) {
728-
return TEST_SCOPED;
728+
return TEST_METHOD;
729729
}
730730
}
731731

732732
private static class BarInstanceFactory extends AbstractTestInstanceFactory {
733733
@Override
734734
public ExtensionContextScope getExtensionContextScopeDuringTestClassInstanceConstruction(
735735
ExtensionContext rootContext) {
736-
return TEST_SCOPED;
736+
return TEST_METHOD;
737737
}
738738
}
739739

jupiter-tests/src/test/java/org/junit/jupiter/engine/extension/TestInstancePostProcessorTests.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
import static org.assertj.core.api.Assertions.assertThat;
1414
import static org.junit.jupiter.api.Assertions.assertEquals;
15-
import static org.junit.jupiter.api.extension.TestClassInstanceConstructionParticipatingExtension.ExtensionContextScope.TEST_SCOPED;
15+
import static org.junit.jupiter.api.extension.TestClassInstanceConstructionParticipatingExtension.ExtensionContextScope.TEST_METHOD;
1616

1717
import java.util.ArrayList;
1818
import java.util.HashMap;
@@ -208,7 +208,7 @@ static class FooInstancePostProcessor extends AbstractInstancePostProcessor {
208208
@Override
209209
public ExtensionContextScope getExtensionContextScopeDuringTestClassInstanceConstruction(
210210
ExtensionContext rootContext) {
211-
return TEST_SCOPED;
211+
return TEST_METHOD;
212212
}
213213
}
214214

@@ -220,7 +220,7 @@ static class BarInstancePostProcessor extends AbstractInstancePostProcessor {
220220
@Override
221221
public ExtensionContextScope getExtensionContextScopeDuringTestClassInstanceConstruction(
222222
ExtensionContext rootContext) {
223-
return TEST_SCOPED;
223+
return TEST_METHOD;
224224
}
225225
}
226226

jupiter-tests/src/test/java/org/junit/jupiter/engine/extension/TestInstancePreConstructCallbackTests.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
package org.junit.jupiter.engine.extension;
1212

1313
import static org.assertj.core.api.Assertions.assertThat;
14-
import static org.junit.jupiter.api.extension.TestClassInstanceConstructionParticipatingExtension.ExtensionContextScope.TEST_SCOPED;
14+
import static org.junit.jupiter.api.extension.TestClassInstanceConstructionParticipatingExtension.ExtensionContextScope.TEST_METHOD;
1515

1616
import java.util.ArrayList;
1717
import java.util.List;
@@ -566,7 +566,7 @@ static class InstancePreConstructCallbackRecordingFoo extends AbstractTestInstan
566566
@Override
567567
public ExtensionContextScope getExtensionContextScopeDuringTestClassInstanceConstruction(
568568
ExtensionContext rootContext) {
569-
return TEST_SCOPED;
569+
return TEST_METHOD;
570570
}
571571
}
572572

@@ -578,7 +578,7 @@ static class InstancePreConstructCallbackRecordingBar extends AbstractTestInstan
578578
@Override
579579
public ExtensionContextScope getExtensionContextScopeDuringTestClassInstanceConstruction(
580580
ExtensionContext rootContext) {
581-
return TEST_SCOPED;
581+
return TEST_METHOD;
582582
}
583583
}
584584

@@ -590,7 +590,7 @@ static class InstancePreConstructCallbackRecordingBaz extends AbstractTestInstan
590590
@Override
591591
public ExtensionContextScope getExtensionContextScopeDuringTestClassInstanceConstruction(
592592
ExtensionContext rootContext) {
593-
return TEST_SCOPED;
593+
return TEST_METHOD;
594594
}
595595
}
596596

0 commit comments

Comments
 (0)