Skip to content

Commit

Permalink
Revise naming and documentation of ExtensionContextScope
Browse files Browse the repository at this point in the history
  • Loading branch information
marcphilipp committed Oct 10, 2024
1 parent bbafe10 commit f8ca2d3
Show file tree
Hide file tree
Showing 8 changed files with 24 additions and 23 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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}.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ public interface TestClassInstanceConstructionParticipatingExtension extends Ext
* {@link ExtensionContext} during the creation of test instances.
*
* <p>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:
Expand Down Expand Up @@ -69,7 +69,7 @@ public interface TestClassInstanceConstructionParticipatingExtension extends Ext
* </ul>
*
* <p><strong>Note</strong>: 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.
Expand All @@ -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
Expand All @@ -105,17 +105,18 @@ 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
DEFAULT,

/**
* 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
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -96,7 +96,7 @@ public TempDirectory(JupiterConfiguration configuration) {
@Override
public ExtensionContextScope getExtensionContextScopeDuringTestClassInstanceConstruction(
ExtensionContext rootContext) {
return TEST_SCOPED;
return TEST_METHOD;
}

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ public class KitchenSinkExtension implements
@Override
public ExtensionContextScope getExtensionContextScopeDuringTestClassInstanceConstruction(
ExtensionContext rootContext) {
return ExtensionContextScope.TEST_SCOPED;
return ExtensionContextScope.TEST_METHOD;
}

// --- Lifecycle Callbacks -------------------------------------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -710,15 +710,15 @@ private static class FooInstanceFactory extends AbstractTestInstanceFactory {
@Override
public ExtensionContextScope getExtensionContextScopeDuringTestClassInstanceConstruction(
ExtensionContext rootContext) {
return TEST_SCOPED;
return TEST_METHOD;
}
}

private static class BarInstanceFactory extends AbstractTestInstanceFactory {
@Override
public ExtensionContextScope getExtensionContextScopeDuringTestClassInstanceConstruction(
ExtensionContext rootContext) {
return TEST_SCOPED;
return TEST_METHOD;
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -206,7 +206,7 @@ static class FooInstancePostProcessor extends AbstractInstancePostProcessor {
@Override
public ExtensionContextScope getExtensionContextScopeDuringTestClassInstanceConstruction(
ExtensionContext rootContext) {
return TEST_SCOPED;
return TEST_METHOD;
}
}

Expand All @@ -218,7 +218,7 @@ static class BarInstancePostProcessor extends AbstractInstancePostProcessor {
@Override
public ExtensionContextScope getExtensionContextScopeDuringTestClassInstanceConstruction(
ExtensionContext rootContext) {
return TEST_SCOPED;
return TEST_METHOD;
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -560,7 +560,7 @@ static class InstancePreConstructCallbackRecordingFoo extends AbstractTestInstan
@Override
public ExtensionContextScope getExtensionContextScopeDuringTestClassInstanceConstruction(
ExtensionContext rootContext) {
return TEST_SCOPED;
return TEST_METHOD;
}
}

Expand All @@ -572,7 +572,7 @@ static class InstancePreConstructCallbackRecordingBar extends AbstractTestInstan
@Override
public ExtensionContextScope getExtensionContextScopeDuringTestClassInstanceConstruction(
ExtensionContext rootContext) {
return TEST_SCOPED;
return TEST_METHOD;
}
}

Expand All @@ -584,7 +584,7 @@ static class InstancePreConstructCallbackRecordingBaz extends AbstractTestInstan
@Override
public ExtensionContextScope getExtensionContextScopeDuringTestClassInstanceConstruction(
ExtensionContext rootContext) {
return TEST_SCOPED;
return TEST_METHOD;
}
}

Expand Down

0 comments on commit f8ca2d3

Please sign in to comment.