org.junitpioneer.jupiter.ClearSystemProperty 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 @ClearSystemProperty} is a JUnit Jupiter extension to clear the value
* of a system property for a test execution.
*
* The key of the system property 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 ClearSystemProperty} 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.
*
* During
* parallel test execution,
* all tests annotated with {@link ClearSystemProperty}, {@link SetSystemProperty}, {@link ReadsSystemProperty}, and {@link WritesSystemProperty}
* are scheduled in a way that guarantees correctness under mutation of shared global state.
*
* For more details and examples, see
* the documentation on @ClearSystemProperty and @SetSystemProperty.
*
* @since 0.5
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.METHOD, ElementType.TYPE })
@Inherited
@Repeatable(ClearSystemProperty.ClearSystemProperties.class)
@WritesSystemProperty
@ExtendWith(SystemPropertyExtension.class)
public @interface ClearSystemProperty {
/**
* The key of the system property to be cleared.
*/
String key();
/**
* Containing annotation of repeatable {@code @ClearSystemProperty}.
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.METHOD, ElementType.TYPE })
@Inherited
@WritesSystemProperty
@ExtendWith(SystemPropertyExtension.class)
@interface ClearSystemProperties {
ClearSystemProperty[] value();
}
}