org.junitpioneer.jupiter.ClearEnvironmentVariable Maven / Gradle / Ivy
/*
* Copyright 2016-2023 the original author or authors.
*
* All rights reserved. This program and the accompanying materials are
* made available under the terms of the Eclipse Public License v2.0 which
* accompanies this distribution and is available at
*
* http://www.eclipse.org/legal/epl-v20.html
*/
package org.junitpioneer.jupiter;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.junit.jupiter.api.extension.ExtendWith;
/**
* {@code @ClearEnvironmentVariable} is a JUnit Jupiter extension to clear the value
* of an environment variable for a test execution.
*
* The key of the environment variable to be cleared must be specified via {@link #key()}.
* After the annotated element has been executed, the original value or the value of the
* higher-level container is restored.
*
* {@code ClearEnvironmentVariable} can be used on the method and on the class level.
* It is repeatable and inherited from higher-level containers. If a class is
* annotated, the configured property will be cleared before every test inside that
* class.
*
* WARNING: Java considers environment variables to be immutable, so this extension
* uses reflection to change them. This requires that the {@link SecurityManager}
* allows modifications and can potentially break on different operating systems and
* Java versions. Be aware that this is a fragile solution and consider finding a
* better one for your specific situation. If you're running on Java 9 or later and
* are encountering warnings or errors, check
* the documentation.
*
* During
* parallel test execution,
* all tests annotated with {@link ClearEnvironmentVariable}, {@link SetEnvironmentVariable}, {@link ReadsEnvironmentVariable}, and {@link WritesEnvironmentVariable}
* are executed sequentially to guarantee correctness under mutation of shared global state.
*
* For more details and examples, see
* the documentation on @ClearEnvironmentVariable and @SetEnvironmentVariable.
*
* @since 0.6
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.METHOD, ElementType.TYPE })
@Inherited
@Repeatable(ClearEnvironmentVariable.ClearEnvironmentVariables.class)
@WritesEnvironmentVariable
@ExtendWith(EnvironmentVariableExtension.class)
public @interface ClearEnvironmentVariable {
/**
* The key of the environment variable to be cleared.
*/
String key();
/**
* Containing annotation of repeatable {@code @ClearEnvironmentVariable}.
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.METHOD, ElementType.TYPE })
@Inherited
@WritesEnvironmentVariable
@ExtendWith(EnvironmentVariableExtension.class)
@interface ClearEnvironmentVariables {
ClearEnvironmentVariable[] value();
}
}