kotest-extensions / io.kotest.extensions.system / SystemEnvironmentProjectListener

SystemEnvironmentProjectListener

class SystemEnvironmentProjectListener : SystemEnvironmentListener, ProjectListener

Modifies System Environment with chosen keys and values

This is a Listener for code that uses Environment Variables. It changes the specific keys from System.getenv with the specified values, during the execution of the project.

To do this, this listener uses a trick that makes the System Environment editable, and changes the keys. Any previous environment (anything not overridden) will also be in the environment. If the chosen key is in the environment, it will be changed according to mode. If the chosen key is not in the environment, it will be included.

After the execution of the project, the environment is set to what it was before.

ATTENTION: This code is susceptible to race conditions. If you attempt to change the environment while it was already changed, the result is inconsistent, as the System Environment Map is a single map.

Constructors

<init>

Modifies System Environment with chosen keys and values

SystemEnvironmentProjectListener(key: String, value: String, mode: OverrideMode = SetOrError)
SystemEnvironmentProjectListener(environment: Pair<String, String>, mode: OverrideMode = SetOrError)
SystemEnvironmentProjectListener(environment: Map<String, String>, mode: OverrideMode = SetOrError)

Functions

afterProject

fun afterProject(): Unit

beforeProject

fun beforeProject(): Unit