类 TestContextManager
- java.lang.Object
- org.springframework.test.context.TestContextManager
public class TestContextManager extends Object
TestContextManageris the main entry point into the Spring TestContext Framework.Specifically, a
TestContextManageris responsible for managing a singleTestContextand signaling events to each registeredTestExecutionListenerat the following test execution points.before test class execution: prior to any before class callbacks of a particular testing framework (e.g., JUnit 4's@BeforeClass)test instance preparation: immediately following instantiation of the test classbefore test setup: prior to any before method callbacks of a particular testing framework (e.g., JUnit 4's@Before)before test execution: immediately before execution of the test method but after test setupafter test execution: immediately after execution of the test method but before test tear downafter test tear down: after any after method callbacks of a particular testing framework (e.g., JUnit 4's@After)after test class execution: after any after class callbacks of a particular testing framework (e.g., JUnit 4's@AfterClass)
Support for loading and accessing application contexts, dependency injection of test instances, transactional execution of test methods, etc. is provided by
ContextLoadersandTestExecutionListeners, which are configured via@ContextConfigurationand@TestExecutionListeners, respectively.Bootstrapping of the
TestContext, the defaultContextLoader, defaultTestExecutionListeners, and their collaborators is performed by aTestContextBootstrapper, which is configured via@BootstrapWith.- 从以下版本开始:
- 2.5
- 作者:
- Sam Brannen, Juergen Hoeller
- 另请参阅:
BootstrapWith,BootstrapContext,TestContextBootstrapper,TestContext,TestExecutionListener,TestExecutionListeners,ContextConfiguration,ContextHierarchy
构造器概要
构造器 构造器 说明 TestContextManager(Class<?> testClass)Construct a newTestContextManagerfor the supplied test class.TestContextManager(TestContextBootstrapper testContextBootstrapper)Construct a newTestContextManagerusing the suppliedTestContextBootstrapperand register the necessaryTestExecutionListeners.
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 voidafterTestClass()Hook for post-processing a test class after execution of all tests within the class.voidafterTestExecution(Object testInstance, Method testMethod, Throwable exception)Hook for post-processing a test immediately after execution of the test method in the supplied test context — for example, for timing or logging purposes.voidafterTestMethod(Object testInstance, Method testMethod, Throwable exception)Hook for post-processing a test after execution of after lifecycle callbacks of the underlying test framework — for example, tearing down test fixtures, ending a transaction, etc.voidbeforeTestClass()Hook for pre-processing a test class before execution of any tests within the class.voidbeforeTestExecution(Object testInstance, Method testMethod)Hook for pre-processing a test immediately before execution of the test method in the supplied test context — for example, for timing or logging purposes.voidbeforeTestMethod(Object testInstance, Method testMethod)Hook for pre-processing a test before execution of before lifecycle callbacks of the underlying test framework — for example, setting up test fixtures, starting a transaction, etc.TestContextgetTestContext()Get theTestContextmanaged by thisTestContextManager.List<TestExecutionListener>getTestExecutionListeners()Get the currentTestExecutionListenersregistered for thisTestContextManager.voidprepareTestInstance(Object testInstance)Hook for preparing a test instance prior to execution of any individual test methods, for example for injecting dependencies, etc.voidregisterTestExecutionListeners(List<TestExecutionListener> testExecutionListeners)Register the supplied list ofTestExecutionListenersby appending them to the list of listeners used by thisTestContextManager.voidregisterTestExecutionListeners(TestExecutionListener... testExecutionListeners)Register the supplied array ofTestExecutionListenersby appending them to the list of listeners used by thisTestContextManager.
构造器详细资料
TestContextManager
public TestContextManager(Class<?> testClass)
Construct a newTestContextManagerfor the supplied test class.Delegates to
TestContextManager(TestContextBootstrapper)with theTestContextBootstrapperconfigured for the test class. If the@BootstrapWithannotation is present on the test class, either directly or as a meta-annotation, then itsvaluewill be used as the bootstrapper type; otherwise, theDefaultTestContextBootstrapperwill be used.- 参数:
testClass- the test class to be managed- 另请参阅:
TestContextManager(TestContextBootstrapper)
TestContextManager
public TestContextManager(TestContextBootstrapper testContextBootstrapper)
Construct a newTestContextManagerusing the suppliedTestContextBootstrapperand register the necessaryTestExecutionListeners.Delegates to the supplied
TestContextBootstrapperfor building theTestContextand retrieving theTestExecutionListeners.- 参数:
testContextBootstrapper- the bootstrapper to use- 另请参阅:
TestContextBootstrapper.buildTestContext(),TestContextBootstrapper.getTestExecutionListeners(),registerTestExecutionListeners(java.util.List<org.springframework.test.context.TestExecutionListener>)
方法详细资料
getTestContext
public final TestContext getTestContext()
Get theTestContextmanaged by thisTestContextManager.
registerTestExecutionListeners
public void registerTestExecutionListeners(List<TestExecutionListener> testExecutionListeners)
Register the supplied list ofTestExecutionListenersby appending them to the list of listeners used by thisTestContextManager.
registerTestExecutionListeners
public void registerTestExecutionListeners(TestExecutionListener... testExecutionListeners)
Register the supplied array ofTestExecutionListenersby appending them to the list of listeners used by thisTestContextManager.
getTestExecutionListeners
public final List<TestExecutionListener> getTestExecutionListeners()
Get the currentTestExecutionListenersregistered for thisTestContextManager.Allows for modifications, e.g. adding a listener to the beginning of the list. However, make sure to keep the list stable while actually executing tests.
beforeTestClass
public void beforeTestClass() throws Exception
Hook for pre-processing a test class before execution of any tests within the class. Should be called prior to any framework-specific before class methods (e.g., methods annotated with JUnit 4's@BeforeClass).An attempt will be made to give each registered
TestExecutionListenera chance to pre-process the test class execution. If a listener throws an exception, however, the remaining registered listeners will not be called.- 抛出:
Exception- if a registered TestExecutionListener throws an exception- 从以下版本开始:
- 3.0
- 另请参阅:
getTestExecutionListeners()
prepareTestInstance
public void prepareTestInstance(Object testInstance) throws Exception
Hook for preparing a test instance prior to execution of any individual test methods, for example for injecting dependencies, etc. Should be called immediately after instantiation of the test instance.The managed
TestContextwill be updated with the suppliedtestInstance.An attempt will be made to give each registered
TestExecutionListenera chance to prepare the test instance. If a listener throws an exception, however, the remaining registered listeners will not be called.- 参数:
testInstance- the test instance to prepare (nevernull)- 抛出:
Exception- if a registered TestExecutionListener throws an exception- 另请参阅:
getTestExecutionListeners()
beforeTestMethod
public void beforeTestMethod(Object testInstance, Method testMethod) throws Exception
Hook for pre-processing a test before execution of before lifecycle callbacks of the underlying test framework — for example, setting up test fixtures, starting a transaction, etc.This method must be called immediately prior to framework-specific before lifecycle callbacks (e.g., methods annotated with JUnit 4's
@Before). For historical reasons, this method is namedbeforeTestMethod. Since the introduction ofbeforeTestExecution(java.lang.Object, java.lang.reflect.Method), a more suitable name for this method might be something likebeforeTestSetUporbeforeEach; however, it is unfortunately impossible to rename this method due to backward compatibility concerns.The managed
TestContextwill be updated with the suppliedtestInstanceandtestMethod.An attempt will be made to give each registered
TestExecutionListenera chance to perform its pre-processing. If a listener throws an exception, however, the remaining registered listeners will not be called.- 参数:
testInstance- the current test instance (nevernull)testMethod- the test method which is about to be executed on the test instance- 抛出:
Exception- if a registered TestExecutionListener throws an exception- 另请参阅:
afterTestMethod(java.lang.Object, java.lang.reflect.Method, java.lang.Throwable),beforeTestExecution(java.lang.Object, java.lang.reflect.Method),afterTestExecution(java.lang.Object, java.lang.reflect.Method, java.lang.Throwable),getTestExecutionListeners()
beforeTestExecution
public void beforeTestExecution(Object testInstance, Method testMethod) throws Exception
Hook for pre-processing a test immediately before execution of the test method in the supplied test context — for example, for timing or logging purposes.This method must be called after framework-specific before lifecycle callbacks (e.g., methods annotated with JUnit 4's
@Before).The managed
TestContextwill be updated with the suppliedtestInstanceandtestMethod.An attempt will be made to give each registered
TestExecutionListenera chance to perform its pre-processing. If a listener throws an exception, however, the remaining registered listeners will not be called.- 参数:
testInstance- the current test instance (nevernull)testMethod- the test method which is about to be executed on the test instance- 抛出:
Exception- if a registered TestExecutionListener throws an exception- 从以下版本开始:
- 5.0
- 另请参阅:
beforeTestMethod(java.lang.Object, java.lang.reflect.Method),afterTestMethod(java.lang.Object, java.lang.reflect.Method, java.lang.Throwable),beforeTestExecution(java.lang.Object, java.lang.reflect.Method),afterTestExecution(java.lang.Object, java.lang.reflect.Method, java.lang.Throwable),getTestExecutionListeners()
afterTestExecution
public void afterTestExecution(Object testInstance, Method testMethod, @Nullable Throwable exception) throws Exception
Hook for post-processing a test immediately after execution of the test method in the supplied test context — for example, for timing or logging purposes.This method must be called before framework-specific after lifecycle callbacks (e.g., methods annotated with JUnit 4's
@After).The managed
TestContextwill be updated with the suppliedtestInstance,testMethod, andexception.Each registered
TestExecutionListenerwill be given a chance to perform its post-processing. If a listener throws an exception, the remaining registered listeners will still be called. After all listeners have executed, the first caught exception will be rethrown with any subsequent exceptions suppressed in the first exception.Note that registered listeners will be executed in the opposite order in which they were registered.
- 参数:
testInstance- the current test instance (nevernull)testMethod- the test method which has just been executed on the test instanceexception- the exception that was thrown during execution of the test method or by a TestExecutionListener, ornullif none was thrown- 抛出:
Exception- if a registered TestExecutionListener throws an exception- 从以下版本开始:
- 5.0
- 另请参阅:
beforeTestMethod(java.lang.Object, java.lang.reflect.Method),afterTestMethod(java.lang.Object, java.lang.reflect.Method, java.lang.Throwable),beforeTestExecution(java.lang.Object, java.lang.reflect.Method),getTestExecutionListeners(),Throwable.addSuppressed(Throwable)
afterTestMethod
public void afterTestMethod(Object testInstance, Method testMethod, @Nullable Throwable exception) throws Exception
Hook for post-processing a test after execution of after lifecycle callbacks of the underlying test framework — for example, tearing down test fixtures, ending a transaction, etc.This method must be called immediately after framework-specific after lifecycle callbacks (e.g., methods annotated with JUnit 4's
@After). For historical reasons, this method is namedafterTestMethod. Since the introduction ofafterTestExecution(java.lang.Object, java.lang.reflect.Method, java.lang.Throwable), a more suitable name for this method might be something likeafterTestTearDownorafterEach; however, it is unfortunately impossible to rename this method due to backward compatibility concerns.The managed
TestContextwill be updated with the suppliedtestInstance,testMethod, andexception.Each registered
TestExecutionListenerwill be given a chance to perform its post-processing. If a listener throws an exception, the remaining registered listeners will still be called. After all listeners have executed, the first caught exception will be rethrown with any subsequent exceptions suppressed in the first exception.Note that registered listeners will be executed in the opposite
- 参数:
testInstance- the current test instance (nevernull)testMethod- the test method which has just been executed on the test instanceexception- the exception that was thrown during execution of the test method or by a TestExecutionListener, ornullif none was thrown- 抛出:
Exception- if a registered TestExecutionListener throws an exception- 另请参阅:
beforeTestMethod(java.lang.Object, java.lang.reflect.Method),beforeTestExecution(java.lang.Object, java.lang.reflect.Method),afterTestExecution(java.lang.Object, java.lang.reflect.Method, java.lang.Throwable),getTestExecutionListeners(),Throwable.addSuppressed(Throwable)
afterTestClass
public void afterTestClass() throws Exception
Hook for post-processing a test class after execution of all tests within the class. Should be called after any framework-specific after class methods (e.g., methods annotated with JUnit 4's@AfterClass).Each registered
TestExecutionListenerwill be given a chance to perform its post-processing. If a listener throws an exception, the remaining registered listeners will still be called. After all listeners have executed, the first caught exception will be rethrown with any subsequent exceptions suppressed in the first exception.Note that registered listeners will be executed in the opposite
- 抛出:
Exception- if a registered TestExecutionListener throws an exception- 从以下版本开始:
- 3.0
- 另请参阅:
getTestExecutionListeners(),Throwable.addSuppressed(Throwable)