Class TempDirectory

java.lang.Object

org.junit.jupiter.engine.extension.TempDirectory

All Implemented Interfaces:

org.junit.jupiter.api.extension.BeforeAllCallback, org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.Extension, org.junit.jupiter.api.extension.ParameterResolver, org.junit.jupiter.api.extension.TestInstantiationAwareExtension

class TempDirectory
extends Object
implements org.junit.jupiter.api.extension.BeforeAllCallback, org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.ParameterResolver

TempDirectory is a JUnit Jupiter extension that creates and cleans up temporary directories if a field in a test class or a parameter in a test class constructor, lifecycle method, or test method is annotated with @TempDir.

Consult the Javadoc for TempDir for details on the contract.

Since:

5.4

See Also:

• @TempDir
• Files.createTempDirectory(Path, String, FileAttribute...)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	TempDirectory.CloseablePath
private static class	TempDirectory.FailureTracker
private static class	TempDirectory.FieldContext
(package private) static interface	TempDirectory.FileOperations
(package private) static enum	TempDirectory.Scope

Nested classes/interfaces inherited from interface org.junit.jupiter.api.extension.TestInstantiationAwareExtension

org.junit.jupiter.api.extension.TestInstantiationAwareExtension.ExtensionContextScope

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	CHILD_FAILED
private final JupiterConfiguration	configuration
private static final String	FAILURE_TRACKER
(package private) static final String	FILE_OPERATIONS_KEY
private static final String	KEY
(package private) static final org.junit.jupiter.api.extension.ExtensionContext.Namespace	NAMESPACE

Constructor Summary

Constructors

Constructor	Description
TempDirectory(JupiterConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
private static void	assertNonFinalField(Field field)
private static void	assertSupportedType(String target, Class<?> type)
void	beforeAll(org.junit.jupiter.api.extension.ExtensionContext context)	Perform field injection for non-private, static fields (i.e., class fields) of type Path or File that are annotated with @TempDir.
void	beforeEach(org.junit.jupiter.api.extension.ExtensionContext context)	Perform field injection for non-private, non-static fields (i.e., instance fields) of type Path or File that are annotated with @TempDir.
(package private) static TempDirectory.CloseablePath	createTempDir(org.junit.jupiter.api.io.TempDirFactory factory, org.junit.jupiter.api.io.CleanupMode cleanupMode, Class<?> elementType, org.junit.jupiter.api.extension.AnnotatedElementContext elementContext, org.junit.jupiter.api.extension.ExtensionContext extensionContext)
private org.junit.jupiter.api.io.CleanupMode	determineCleanupMode(org.junit.jupiter.api.io.TempDir tempDir)
private org.junit.jupiter.api.io.CleanupMode	determineCleanupModeForField(Field field)
private org.junit.jupiter.api.io.CleanupMode	determineCleanupModeForParameter(org.junit.jupiter.api.extension.ParameterContext parameterContext)
private org.junit.jupiter.api.io.TempDirFactory	determineTempDirFactory(org.junit.jupiter.api.io.TempDir tempDir, TempDirectory.Scope scope)
private org.junit.jupiter.api.io.TempDirFactory	determineTempDirFactoryForField(Field field, TempDirectory.Scope scope)
private org.junit.jupiter.api.io.TempDirFactory	determineTempDirFactoryForParameter(org.junit.jupiter.api.extension.ParameterContext parameterContext, TempDirectory.Scope scope)
private static org.junit.jupiter.api.extension.ExtensionContext.Store	getContextSpecificStore(org.junit.jupiter.api.extension.ExtensionContext context)
private static Object	getPathOrFile(Class<?> elementType, org.junit.jupiter.api.extension.AnnotatedElementContext elementContext, org.junit.jupiter.api.io.TempDirFactory factory, org.junit.jupiter.api.io.CleanupMode cleanupMode, TempDirectory.Scope scope, org.junit.jupiter.api.extension.ExtensionContext extensionContext)
private TempDirectory.Scope	getScope(org.junit.jupiter.api.extension.ExtensionContext context)
org.junit.jupiter.api.extension.TestInstantiationAwareExtension.ExtensionContextScope	getTestInstantiationExtensionContextScope(org.junit.jupiter.api.extension.ExtensionContext rootContext)
private void	injectFields(org.junit.jupiter.api.extension.ExtensionContext context, Object testInstance, Class<?> testClass, Predicate<Field> predicate)
private void	injectInstanceFields(org.junit.jupiter.api.extension.ExtensionContext context, Object instance)
private void	injectStaticFields(org.junit.jupiter.api.extension.ExtensionContext context, Class<?> testClass)
private static void	installFailureTracker(org.junit.jupiter.api.extension.ExtensionContext context)
private static void	installFailureTracker(org.junit.jupiter.api.extension.ExtensionContext context, org.junit.jupiter.api.extension.ExtensionContext parentContext)
Object	resolveParameter(org.junit.jupiter.api.extension.ParameterContext parameterContext, org.junit.jupiter.api.extension.ExtensionContext extensionContext)	Resolve the current temporary directory for the Parameter in the supplied ParameterContext.
private static boolean	selfOrChildFailed(org.junit.jupiter.api.extension.ExtensionContext context)
boolean	supportsParameter(org.junit.jupiter.api.extension.ParameterContext parameterContext, org.junit.jupiter.api.extension.ExtensionContext extensionContext)	Determine if the Parameter in the supplied ParameterContext is annotated with @TempDir.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NAMESPACE

static final org.junit.jupiter.api.extension.ExtensionContext.Namespace NAMESPACE

FILE_OPERATIONS_KEY

static final String FILE_OPERATIONS_KEY

See Also:

• Constant Field Values

KEY

private static final String KEY

See Also:

• Constant Field Values

FAILURE_TRACKER

private static final String FAILURE_TRACKER

See Also:

• Constant Field Values

CHILD_FAILED

private static final String CHILD_FAILED

See Also:

• Constant Field Values

configuration

private final JupiterConfiguration configuration

Constructor Details

TempDirectory

public TempDirectory(JupiterConfiguration configuration)

Method Details

getTestInstantiationExtensionContextScope

public org.junit.jupiter.api.extension.TestInstantiationAwareExtension.ExtensionContextScope getTestInstantiationExtensionContextScope(org.junit.jupiter.api.extension.ExtensionContext rootContext)

Specified by:

getTestInstantiationExtensionContextScope in interface org.junit.jupiter.api.extension.TestInstantiationAwareExtension

beforeAll

public void beforeAll(org.junit.jupiter.api.extension.ExtensionContext context)

Perform field injection for non-private, static fields (i.e., class fields) of type Path or File that are annotated with @TempDir.

Specified by:

beforeAll in interface org.junit.jupiter.api.extension.BeforeAllCallback

beforeEach

public void beforeEach(org.junit.jupiter.api.extension.ExtensionContext context)

Perform field injection for non-private, non-static fields (i.e., instance fields) of type Path or File that are annotated with @TempDir.

Specified by:

beforeEach in interface org.junit.jupiter.api.extension.BeforeEachCallback

installFailureTracker

private static void installFailureTracker(org.junit.jupiter.api.extension.ExtensionContext context)

installFailureTracker

private static void installFailureTracker(org.junit.jupiter.api.extension.ExtensionContext context,
 org.junit.jupiter.api.extension.ExtensionContext parentContext)

injectStaticFields

private void injectStaticFields(org.junit.jupiter.api.extension.ExtensionContext context,
 Class<?> testClass)

injectInstanceFields

private void injectInstanceFields(org.junit.jupiter.api.extension.ExtensionContext context,
 Object instance)

injectFields

private void injectFields(org.junit.jupiter.api.extension.ExtensionContext context,
 Object testInstance,
 Class<?> testClass,
 Predicate<Field> predicate)

supportsParameter

public boolean supportsParameter(org.junit.jupiter.api.extension.ParameterContext parameterContext,
 org.junit.jupiter.api.extension.ExtensionContext extensionContext)

Determine if the Parameter in the supplied ParameterContext is annotated with @TempDir.

Specified by:

supportsParameter in interface org.junit.jupiter.api.extension.ParameterResolver

resolveParameter

public Object resolveParameter(org.junit.jupiter.api.extension.ParameterContext parameterContext,
 org.junit.jupiter.api.extension.ExtensionContext extensionContext)

Resolve the current temporary directory for the Parameter in the supplied ParameterContext.

Specified by:

resolveParameter in interface org.junit.jupiter.api.extension.ParameterResolver

determineCleanupModeForField

private org.junit.jupiter.api.io.CleanupMode determineCleanupModeForField(Field field)

determineCleanupModeForParameter

private org.junit.jupiter.api.io.CleanupMode determineCleanupModeForParameter(org.junit.jupiter.api.extension.ParameterContext parameterContext)

determineCleanupMode

private org.junit.jupiter.api.io.CleanupMode determineCleanupMode(org.junit.jupiter.api.io.TempDir tempDir)

getScope

private TempDirectory.Scope getScope(org.junit.jupiter.api.extension.ExtensionContext context)

determineTempDirFactoryForField

private org.junit.jupiter.api.io.TempDirFactory determineTempDirFactoryForField(Field field,
 TempDirectory.Scope scope)

determineTempDirFactoryForParameter

private org.junit.jupiter.api.io.TempDirFactory determineTempDirFactoryForParameter(org.junit.jupiter.api.extension.ParameterContext parameterContext,
 TempDirectory.Scope scope)

determineTempDirFactory

private org.junit.jupiter.api.io.TempDirFactory determineTempDirFactory(org.junit.jupiter.api.io.TempDir tempDir,
 TempDirectory.Scope scope)

assertNonFinalField

private static void assertNonFinalField(Field field)

assertSupportedType

private static void assertSupportedType(String target,
 Class<?> type)

getPathOrFile

private static Object getPathOrFile(Class<?> elementType,
 org.junit.jupiter.api.extension.AnnotatedElementContext elementContext,
 org.junit.jupiter.api.io.TempDirFactory factory,
 org.junit.jupiter.api.io.CleanupMode cleanupMode,
 TempDirectory.Scope scope,
 org.junit.jupiter.api.extension.ExtensionContext extensionContext)

createTempDir

static TempDirectory.CloseablePath createTempDir(org.junit.jupiter.api.io.TempDirFactory factory,
 org.junit.jupiter.api.io.CleanupMode cleanupMode,
 Class<?> elementType,
 org.junit.jupiter.api.extension.AnnotatedElementContext elementContext,
 org.junit.jupiter.api.extension.ExtensionContext extensionContext)

selfOrChildFailed

private static boolean selfOrChildFailed(org.junit.jupiter.api.extension.ExtensionContext context)

getContextSpecificStore

private static org.junit.jupiter.api.extension.ExtensionContext.Store getContextSpecificStore(org.junit.jupiter.api.extension.ExtensionContext context)