org.junit.jupiter.engine.extension.TimeoutExtension Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of junit-jupiter-engine Show documentation
Show all versions of junit-jupiter-engine Show documentation
Module "junit-jupiter-engine" of JUnit 5.
/*
* Copyright 2015-2021 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
*
* https://www.eclipse.org/legal/epl-v20.html
*/
package org.junit.jupiter.engine.extension;
import static org.junit.jupiter.engine.config.JupiterConfiguration.TIMEOUT_MODE_PROPERTY_NAME;
import java.lang.reflect.AnnotatedElement;
import java.lang.reflect.Method;
import java.util.Optional;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
import java.util.function.Function;
import org.junit.jupiter.api.Timeout;
import org.junit.jupiter.api.extension.BeforeAllCallback;
import org.junit.jupiter.api.extension.BeforeEachCallback;
import org.junit.jupiter.api.extension.ExtensionConfigurationException;
import org.junit.jupiter.api.extension.ExtensionContext;
import org.junit.jupiter.api.extension.ExtensionContext.Store.CloseableResource;
import org.junit.jupiter.api.extension.InvocationInterceptor;
import org.junit.jupiter.api.extension.ReflectiveInvocationContext;
import org.junit.platform.commons.JUnitException;
import org.junit.platform.commons.support.AnnotationSupport;
import org.junit.platform.commons.util.ClassUtils;
import org.junit.platform.commons.util.ReflectionUtils;
import org.junit.platform.commons.util.RuntimeUtils;
/**
* @since 5.5
*/
class TimeoutExtension implements BeforeAllCallback, BeforeEachCallback, InvocationInterceptor {
private static final ExtensionContext.Namespace NAMESPACE = ExtensionContext.Namespace.create(Timeout.class);
private static final String TESTABLE_METHOD_TIMEOUT_KEY = "testable_method_timeout_from_annotation";
private static final String GLOBAL_TIMEOUT_CONFIG_KEY = "global_timeout_config";
private static final String ENABLED_MODE_VALUE = "enabled";
private static final String DISABLED_MODE_VALUE = "disabled";
private static final String DISABLED_ON_DEBUG_MODE_VALUE = "disabled_on_debug";
@Override
public void beforeAll(ExtensionContext context) {
readAndStoreTimeoutSoChildrenInheritIt(context);
}
@Override
public void beforeEach(ExtensionContext context) {
readAndStoreTimeoutSoChildrenInheritIt(context);
}
private void readAndStoreTimeoutSoChildrenInheritIt(ExtensionContext context) {
readTimeoutFromAnnotation(context.getElement()).ifPresent(
timeout -> context.getStore(NAMESPACE).put(TESTABLE_METHOD_TIMEOUT_KEY, timeout));
}
@Override
public void interceptBeforeAllMethod(Invocation invocation,
ReflectiveInvocationContext invocationContext, ExtensionContext extensionContext) throws Throwable {
interceptLifecycleMethod(invocation, invocationContext, extensionContext,
TimeoutConfiguration::getDefaultBeforeAllMethodTimeout);
}
@Override
public void interceptBeforeEachMethod(Invocation invocation,
ReflectiveInvocationContext invocationContext, ExtensionContext extensionContext) throws Throwable {
interceptLifecycleMethod(invocation, invocationContext, extensionContext,
TimeoutConfiguration::getDefaultBeforeEachMethodTimeout);
}
@Override
public void interceptTestMethod(Invocation invocation, ReflectiveInvocationContext invocationContext,
ExtensionContext extensionContext) throws Throwable {
interceptTestableMethod(invocation, invocationContext, extensionContext,
TimeoutConfiguration::getDefaultTestMethodTimeout);
}
@Override
public void interceptTestTemplateMethod(Invocation invocation,
ReflectiveInvocationContext invocationContext, ExtensionContext extensionContext) throws Throwable {
interceptTestableMethod(invocation, invocationContext, extensionContext,
TimeoutConfiguration::getDefaultTestTemplateMethodTimeout);
}
@Override
public T interceptTestFactoryMethod(Invocation invocation,
ReflectiveInvocationContext invocationContext, ExtensionContext extensionContext) throws Throwable {
return interceptTestableMethod(invocation, invocationContext, extensionContext,
TimeoutConfiguration::getDefaultTestFactoryMethodTimeout);
}
@Override
public void interceptAfterEachMethod(Invocation invocation,
ReflectiveInvocationContext invocationContext, ExtensionContext extensionContext) throws Throwable {
interceptLifecycleMethod(invocation, invocationContext, extensionContext,
TimeoutConfiguration::getDefaultAfterEachMethodTimeout);
}
@Override
public void interceptAfterAllMethod(Invocation invocation,
ReflectiveInvocationContext invocationContext, ExtensionContext extensionContext) throws Throwable {
interceptLifecycleMethod(invocation, invocationContext, extensionContext,
TimeoutConfiguration::getDefaultAfterAllMethodTimeout);
}
private void interceptLifecycleMethod(Invocation invocation,
ReflectiveInvocationContext invocationContext, ExtensionContext extensionContext,
TimeoutProvider defaultTimeoutProvider) throws Throwable {
TimeoutDuration timeout = readTimeoutFromAnnotation(Optional.of(invocationContext.getExecutable())).orElse(
null);
intercept(invocation, invocationContext, extensionContext, timeout, defaultTimeoutProvider);
}
@SuppressWarnings("OptionalUsedAsFieldOrParameterType")
private Optional readTimeoutFromAnnotation(Optional element) {
return AnnotationSupport.findAnnotation(element, Timeout.class).map(TimeoutDuration::from);
}
private T interceptTestableMethod(Invocation invocation,
ReflectiveInvocationContext invocationContext, ExtensionContext extensionContext,
TimeoutProvider defaultTimeoutProvider) throws Throwable {
TimeoutDuration timeout = extensionContext.getStore(NAMESPACE).get(TESTABLE_METHOD_TIMEOUT_KEY,
TimeoutDuration.class);
return intercept(invocation, invocationContext, extensionContext, timeout, defaultTimeoutProvider);
}
private T intercept(Invocation invocation, ReflectiveInvocationContext invocationContext,
ExtensionContext extensionContext, TimeoutDuration explicitTimeout, TimeoutProvider defaultTimeoutProvider)
throws Throwable {
TimeoutDuration timeout = explicitTimeout == null ? getDefaultTimeout(extensionContext, defaultTimeoutProvider)
: explicitTimeout;
return decorate(invocation, invocationContext, extensionContext, timeout).proceed();
}
private TimeoutDuration getDefaultTimeout(ExtensionContext extensionContext,
TimeoutProvider defaultTimeoutProvider) {
return defaultTimeoutProvider.apply(getGlobalTimeoutConfiguration(extensionContext)).orElse(null);
}
private TimeoutConfiguration getGlobalTimeoutConfiguration(ExtensionContext extensionContext) {
ExtensionContext root = extensionContext.getRoot();
return root.getStore(NAMESPACE).getOrComputeIfAbsent(GLOBAL_TIMEOUT_CONFIG_KEY,
key -> new TimeoutConfiguration(root), TimeoutConfiguration.class);
}
private Invocation decorate(Invocation invocation, ReflectiveInvocationContext invocationContext,
ExtensionContext extensionContext, TimeoutDuration timeout) {
if (timeout == null || isTimeoutDisabled(extensionContext)) {
return invocation;
}
return new TimeoutInvocation<>(invocation, timeout, getExecutor(extensionContext),
() -> describe(invocationContext, extensionContext));
}
private String describe(ReflectiveInvocationContext invocationContext, ExtensionContext extensionContext) {
Method method = invocationContext.getExecutable();
Optional> testClass = extensionContext.getTestClass();
if (testClass.isPresent() && invocationContext.getTargetClass().equals(testClass.get())) {
return String.format("%s(%s)", method.getName(), ClassUtils.nullSafeToString(method.getParameterTypes()));
}
return ReflectionUtils.getFullyQualifiedMethodName(invocationContext.getTargetClass(), method);
}
private ScheduledExecutorService getExecutor(ExtensionContext extensionContext) {
return extensionContext.getRoot().getStore(NAMESPACE).getOrComputeIfAbsent(ExecutorResource.class).get();
}
/**
* Determine if timeouts are disabled for the supplied extension context.
*/
private boolean isTimeoutDisabled(ExtensionContext extensionContext) {
Optional mode = extensionContext.getConfigurationParameter(TIMEOUT_MODE_PROPERTY_NAME);
return mode.map(this::isTimeoutDisabled).orElse(false);
}
/**
* Determine if timeouts are disabled for the supplied mode.
*/
private boolean isTimeoutDisabled(String mode) {
switch (mode) {
case ENABLED_MODE_VALUE:
return false;
case DISABLED_MODE_VALUE:
return true;
case DISABLED_ON_DEBUG_MODE_VALUE:
return RuntimeUtils.isDebugMode();
default:
throw new ExtensionConfigurationException("Unsupported timeout mode: " + mode);
}
}
@FunctionalInterface
private interface TimeoutProvider extends Function> {
}
private static class ExecutorResource implements CloseableResource {
private final ScheduledExecutorService executor;
@SuppressWarnings("unused")
ExecutorResource() {
executor = Executors.newSingleThreadScheduledExecutor(runnable -> {
Thread thread = new Thread(runnable, "junit-jupiter-timeout-watcher");
thread.setPriority(Thread.MAX_PRIORITY);
return thread;
});
}
ScheduledExecutorService get() {
return executor;
}
@Override
public void close() throws Throwable {
executor.shutdown();
boolean terminated = executor.awaitTermination(5, TimeUnit.SECONDS);
if (!terminated) {
executor.shutdownNow();
throw new JUnitException("Scheduled executor could not be stopped in an orderly manner");
}
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy