org.junit.jupiter.api.extension.BeforeEachCallback Maven / Gradle / Ivy
Show all versions of junit-jupiter-api Show documentation
/*
* Copyright 2015-2024 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.api.extension;
import static org.apiguardian.api.API.Status.STABLE;
import org.apiguardian.api.API;
/**
* {@code BeforeEachCallback} defines the API for {@link Extension Extensions}
* that wish to provide additional behavior to tests before an individual test
* and any user-defined setup methods (e.g.,
* {@link org.junit.jupiter.api.BeforeEach @BeforeEach} methods) for that test
* have been executed.
*
* Concrete implementations often implement {@link AfterEachCallback} as well.
* If you do not wish to have your callbacks wrapped around user-defined
* setup and teardown methods, implement {@link BeforeTestExecutionCallback} and
* {@link AfterTestExecutionCallback} instead of {@link BeforeEachCallback} and
* {@link AfterEachCallback}.
*
*
Constructor Requirements
*
* Consult the documentation in {@link Extension} for details on
* constructor requirements.
*
*
Wrapping Behavior
*
* JUnit Jupiter guarantees wrapping behavior for multiple
* registered extensions that implement lifecycle callbacks such as
* {@link BeforeAllCallback}, {@link AfterAllCallback},
* {@link BeforeEachCallback}, {@link AfterEachCallback},
* {@link BeforeTestExecutionCallback}, and {@link AfterTestExecutionCallback}.
*
*
That means that, given two extensions {@code Extension1} and
* {@code Extension2} with {@code Extension1} registered before
* {@code Extension2}, any "before" callbacks implemented by {@code Extension1}
* are guaranteed to execute before any "before" callbacks implemented by
* {@code Extension2}. Similarly, given the two same two extensions registered
* in the same order, any "after" callbacks implemented by {@code Extension1}
* are guaranteed to execute after any "after" callbacks implemented by
* {@code Extension2}. {@code Extension1} is therefore said to wrap
* {@code Extension2}.
*
* @since 5.0
* @see org.junit.jupiter.api.BeforeEach
* @see AfterEachCallback
* @see BeforeTestExecutionCallback
* @see AfterTestExecutionCallback
* @see BeforeAllCallback
* @see AfterAllCallback
*/
@FunctionalInterface
@API(status = STABLE, since = "5.0")
public interface BeforeEachCallback extends Extension {
/**
* Callback that is invoked before an individual test and any
* user-defined setup methods for that test have been executed.
*
* @param context the current extension context; never {@code null}
*/
void beforeEach(ExtensionContext context) throws Exception;
}