Class EnvironmentVariableExtension

java.lang.Object

org.junitpioneer.jupiter.AbstractEntryBasedExtension<String, String, ClearEnvironmentVariable, SetEnvironmentVariable, RestoreEnvironmentVariables>

org.junitpioneer.jupiter.EnvironmentVariableExtension

All Implemented Interfaces:

org.junit.jupiter.api.extension.AfterAllCallback, org.junit.jupiter.api.extension.AfterEachCallback, org.junit.jupiter.api.extension.BeforeAllCallback, org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.Extension

class EnvironmentVariableExtension
extends AbstractEntryBasedExtension<String, String, ClearEnvironmentVariable, SetEnvironmentVariable, RestoreEnvironmentVariables>

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final AtomicBoolean	REPORTED_WARNING
(package private) static final String	WARNING_KEY
(package private) static final String	WARNING_VALUE

Constructor Summary

Constructors

Constructor	Description
EnvironmentVariableExtension()

Method Summary

Modifier and Type	Method	Description
protected void	clearEntry(String key)	Removes the entry indicated by the specified key.
protected Function<ClearEnvironmentVariable, String>	clearKeyMapper()
protected String	getEntry(String key)	Gets the entry indicated by the specified key.
protected Properties	prepareToEnterRestorableContext()	This implementation uses the "Post swap" strategy, returning a clone of the environment variables which will be restored in AbstractEntryBasedExtension.prepareToExitRestorableContext(Properties).
protected void	prepareToExitRestorableContext(Properties restoreMe)	Prepare to exit a restorable context for the entry based environment.
protected void	reportWarning(org.junit.jupiter.api.extension.ExtensionContext context)	Reports a warning about potentially unsafe practices.
protected void	setEntry(String key, String value)	Sets the entry indicated by the specified key.
protected Function<SetEnvironmentVariable, String>	setKeyMapper()
protected Function<SetEnvironmentVariable, String>	setValueMapper()

Methods inherited from class AbstractEntryBasedExtension

afterAll, afterEach, beforeAll, beforeEach

Methods inherited from class Object

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

Field Details

REPORTED_WARNING

static final AtomicBoolean REPORTED_WARNING

WARNING_KEY

static final String WARNING_KEY

WARNING_VALUE

static final String WARNING_VALUE

See Also:

• Constant Field Values

Constructor Details

EnvironmentVariableExtension

EnvironmentVariableExtension()

Method Details

clearKeyMapper

protected Function<ClearEnvironmentVariable, String> clearKeyMapper()

Specified by:

clearKeyMapper in class AbstractEntryBasedExtension<String, String, ClearEnvironmentVariable, SetEnvironmentVariable, RestoreEnvironmentVariables>

Returns:

Mapper function to get the key from a clear annotation.

setKeyMapper

protected Function<SetEnvironmentVariable, String> setKeyMapper()

Specified by:

setKeyMapper in class AbstractEntryBasedExtension<String, String, ClearEnvironmentVariable, SetEnvironmentVariable, RestoreEnvironmentVariables>

Returns:

Mapper function to get the key from a set annotation.

setValueMapper

protected Function<SetEnvironmentVariable, String> setValueMapper()

Specified by:

setValueMapper in class AbstractEntryBasedExtension<String, String, ClearEnvironmentVariable, SetEnvironmentVariable, RestoreEnvironmentVariables>

Returns:

Mapper function to get the value from a set annotation.

reportWarning

protected void reportWarning(org.junit.jupiter.api.extension.ExtensionContext context)

Description copied from class: AbstractEntryBasedExtension

Reports a warning about potentially unsafe practices.

Overrides:

reportWarning in class AbstractEntryBasedExtension<String, String, ClearEnvironmentVariable, SetEnvironmentVariable, RestoreEnvironmentVariables>

clearEntry

protected void clearEntry(String key)

Description copied from class: AbstractEntryBasedExtension

Removes the entry indicated by the specified key.

Specified by:

clearEntry in class AbstractEntryBasedExtension<String, String, ClearEnvironmentVariable, SetEnvironmentVariable, RestoreEnvironmentVariables>

getEntry

protected String getEntry(String key)

Description copied from class: AbstractEntryBasedExtension

Gets the entry indicated by the specified key.

Specified by:

getEntry in class AbstractEntryBasedExtension<String, String, ClearEnvironmentVariable, SetEnvironmentVariable, RestoreEnvironmentVariables>

setEntry

protected void setEntry(String key,
 String value)

Description copied from class: AbstractEntryBasedExtension

Sets the entry indicated by the specified key.

Specified by:

setEntry in class AbstractEntryBasedExtension<String, String, ClearEnvironmentVariable, SetEnvironmentVariable, RestoreEnvironmentVariables>

prepareToEnterRestorableContext

protected Properties prepareToEnterRestorableContext()

This implementation uses the "Post swap" strategy, returning a clone of the environment variables which will be restored in AbstractEntryBasedExtension.prepareToExitRestorableContext(Properties).

See AbstractEntryBasedExtension.prepareToEnterRestorableContext() for more details.

Specified by:

prepareToEnterRestorableContext in class AbstractEntryBasedExtension<String, String, ClearEnvironmentVariable, SetEnvironmentVariable, RestoreEnvironmentVariables>

Returns:

A clone of the current environment variables, as a Properties object.

prepareToExitRestorableContext

protected void prepareToExitRestorableContext(Properties restoreMe)

Description copied from class: AbstractEntryBasedExtension

Prepare to exit a restorable context for the entry based environment.

The entry environment will be restored to the state passed in as Properties. The Properties entries must follow the rules for entries of this environment, e.g., environment variables contain only Strings while System Properties may contain Objects.

Specified by:

prepareToExitRestorableContext in class AbstractEntryBasedExtension<String, String, ClearEnvironmentVariable, SetEnvironmentVariable, RestoreEnvironmentVariables>

Parameters:

restoreMe - A non-null Properties that contains all entries of the entry environment.