org.junit.jupiter.engine.extension

Class TempDirectory

java.lang.Object

org.junit.jupiter.engine.extension.TempDirectory

All Implemented Interfaces:

BeforeAllCallback, BeforeEachCallback, Extension, ParameterResolver

class TempDirectory
extends java.lang.Object
implements BeforeAllCallback, BeforeEachCallback, ParameterResolver

TempDirectory is a JUnit Jupiter extension that creates and cleans up temporary directories if field in a test class or a parameter in a 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(java.nio.file.Path, java.lang.String, java.nio.file.attribute.FileAttribute<?>...)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	TempDirectory.CloseablePath

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	KEY
private static ExtensionContext.Namespace	NAMESPACE
private static java.lang.String	TEMP_DIR_PREFIX

Constructor Summary

Constructors

Constructor and Description
TempDirectory()

Method Summary

Modifier and Type	Method and Description
private void	assertSupportedType(java.lang.String target, java.lang.Class<?> type)
private void	assertValidFieldCandidate(java.lang.reflect.Field field)
void	beforeAll(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(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.
private static TempDirectory.CloseablePath	createTempDir()
private java.lang.Object	getPathOrFile(java.lang.Class<?> type, ExtensionContext extensionContext)
private void	injectFields(ExtensionContext context, java.lang.Object testInstance, java.util.function.Predicate<java.lang.reflect.Field> predicate)
java.lang.Object	resolveParameter(ParameterContext parameterContext, ExtensionContext extensionContext) Resolve the current temporary directory for the Parameter in the supplied ParameterContext.
boolean	supportsParameter(ParameterContext parameterContext, ExtensionContext extensionContext) Determine if the Parameter in the supplied ParameterContext is annotated with @TempDir.

Methods inherited from class java.lang.Object

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

Field Detail

NAMESPACE

private static final ExtensionContext.Namespace NAMESPACE

KEY

private static final java.lang.String KEY

See Also:

Constant Field Values

TEMP_DIR_PREFIX

private static final java.lang.String TEMP_DIR_PREFIX

See Also:

Constant Field Values

Constructor Detail

TempDirectory

TempDirectory()

Method Detail

beforeAll

public void beforeAll(ExtensionContext context)
               throws java.lang.Exception

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 BeforeAllCallback

Parameters:

context - the current extension context; never null

Throws:

java.lang.Exception

beforeEach

public void beforeEach(ExtensionContext context)
                throws java.lang.Exception

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 BeforeEachCallback

Parameters:

context - the current extension context; never null

Throws:

java.lang.Exception

injectFields

private void injectFields(ExtensionContext context,
                          java.lang.Object testInstance,
                          java.util.function.Predicate<java.lang.reflect.Field> predicate)

assertValidFieldCandidate

private void assertValidFieldCandidate(java.lang.reflect.Field field)

supportsParameter

public boolean supportsParameter(ParameterContext parameterContext,
                                 ExtensionContext extensionContext)

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

Specified by:

supportsParameter in interface ParameterResolver

Parameters:

parameterContext - the context for the parameter for which an argument should be resolved; never null

extensionContext - the extension context for the Executable about to be invoked; never null

Returns:

true if this resolver can resolve an argument for the parameter

See Also:

ParameterResolver.resolveParameter(org.junit.jupiter.api.extension.ParameterContext, org.junit.jupiter.api.extension.ExtensionContext), ParameterContext

resolveParameter

public java.lang.Object resolveParameter(ParameterContext parameterContext,
                                         ExtensionContext extensionContext)

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

Specified by:

resolveParameter in interface ParameterResolver

Parameters:

parameterContext - the context for the parameter for which an argument should be resolved; never null

extensionContext - the extension context for the Executable about to be invoked; never null

Returns:

the resolved argument for the parameter; may only be null if the parameter type is not a primitive

See Also:

ParameterResolver.supportsParameter(org.junit.jupiter.api.extension.ParameterContext, org.junit.jupiter.api.extension.ExtensionContext), ParameterContext

assertSupportedType

private void assertSupportedType(java.lang.String target,
                                 java.lang.Class<?> type)

getPathOrFile

private java.lang.Object getPathOrFile(java.lang.Class<?> type,
                                       ExtensionContext extensionContext)

createTempDir

private static TempDirectory.CloseablePath createTempDir()