de.tum.in.test.api.StrictTimeout Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of artemis-java-test-sandbox Show documentation

The Artemis Java Test Sandbox. A JUnit 5 Extension for secure Artemis Java Testing.

There is a newer version: 1.13.0

Show newest version

package de.tum.in.test.api;

import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import java.util.concurrent.TimeUnit;

import org.apiguardian.api.API;
import org.apiguardian.api.API.Status;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Timeout;

import de.tum.in.test.api.jqwik.JqwikStrictTimeoutExtension;
import de.tum.in.test.api.jupiter.Hidden;
import de.tum.in.test.api.jupiter.JupiterStrictTimeoutExtension;
import de.tum.in.test.api.jupiter.Public;

/**
 * Works like
 * {@link Assertions#assertTimeoutPreemptively(java.time.Duration, org.junit.jupiter.api.function.Executable)
 * Assertions.assertTimeoutPreemptively} and {@link Assertions}, section
 * preemptive timeout. Very different in behavior to {@link Timeout}. This
 * annotation does no cause problems with the ArtemisSecurityManager and can
 * terminate tests stuck in endless loops (which {@link Timeout} can not).
 * 
 * To use {@link StrictTimeout} without any {@link Public} or
 * {@link Hidden}, you need to declare the {@link JupiterStrictTimeoutExtension}
 * for JUnit 5 Jupiter or {@link JqwikStrictTimeoutExtension} for jqwik
 * explicitly. However, this is not recommended as it is less effective.
 *
 * @author Christian Femers
 * @since 0.1.0
 * @version 2.0.0
 */
@API(status = Status.MAINTAINED)
@Documented
@Retention(RUNTIME)
@Target({ TYPE, METHOD, ANNOTATION_TYPE })
public @interface StrictTimeout {
	/**
	 * The duration of this timeout. (per default in seconds)
	 */
	long value();

	/**
	 * The time unit of this timeout, defaults to seconds.
	 *
	 * @see TimeUnit
	 */
	TimeUnit unit() default TimeUnit.SECONDS;

}