程序包 cn.taketoday.test.context.web

类 ServletTestExecutionListener

java.lang.Object

cn.taketoday.test.context.support.AbstractTestExecutionListener

cn.taketoday.test.context.web.ServletTestExecutionListener

所有已实现的接口:

cn.taketoday.core.Ordered, TestExecutionListener

public class ServletTestExecutionListener
extends AbstractTestExecutionListener

TestExecutionListener which provides mock Servlet API support to WebServletApplicationContext loaded by the Infra TestContext Framework.

Specifically, ServletTestExecutionListener sets up thread-local state via Infra Web's RequestContextHolder during test instance preparation and before each test method and creates a MockHttpServletRequest, MockHttpServletResponse, and RequestContext based on the MockServletContext present in the WebApplicationContext. This listener also ensures that the MockHttpServletResponse and ServletWebRequest can be injected into the test instance, and once the test is complete this listener cleans up thread-local state.

Note that ServletTestExecutionListener is enabled by default but generally takes no action if the test class is not annotated with @WebAppConfiguration. See the javadocs for individual methods in this class for details.

从以下版本开始:

4.0

作者:

Sam Brannen, Phillip Webb

字段概要

字段

修饰符和类型	字段	说明
static final String	ACTIVATE_LISTENER	Attribute name for a TestContext attribute which indicates that the ServletTestExecutionListener should be activated.
static final String	CREATED_BY_THE_TESTCONTEXT_FRAMEWORK	Attribute name for a request attribute which indicates that the MockHttpServletRequest stored in the RequestContext in Infra Web's RequestContextHolder was created by the TestContext framework.
private static final cn.taketoday.logging.Logger	logger
static final String	POPULATED_REQUEST_CONTEXT_HOLDER_ATTRIBUTE	Attribute name for a TestContext attribute which indicates that ServletTestExecutionListener has already populated Infra Web's RequestContextHolder.
static final String	RESET_REQUEST_CONTEXT_HOLDER_ATTRIBUTE	Attribute name for a TestContext attribute which indicates whether or not the ServletTestExecutionListener should reset Infra Web's RequestContextHolder in afterTestMethod(TestContext).

从接口继承的字段 cn.taketoday.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

构造器概要

构造器

构造器	说明
ServletTestExecutionListener()

方法概要

修饰符和类型	方法	说明
void	afterTestMethod(TestContext testContext)	If the RESET_REQUEST_CONTEXT_HOLDER_ATTRIBUTE in the supplied TestContext has a value of Boolean.TRUE, this method will (1) clean up thread-local state after each test method by resetting Infra Web's RequestContextHolder and (2) ensure that new mocks are injected into the test instance for subsequent tests by setting the DependencyInjectionTestExecutionListener.REINJECT_DEPENDENCIES_ATTRIBUTE in the test context to true.
private boolean	alreadyPopulatedRequestContextHolder(TestContext testContext)
void	beforeTestMethod(TestContext testContext)	Sets up thread-local state before each test method via Infra Web's RequestContextHolder, but only if the test class is annotated with @WebAppConfiguration.
final int	getOrder()	Returns 1000.
private boolean	isActivated(TestContext testContext)
void	prepareTestInstance(TestContext testContext)	Sets up thread-local state during the test instance preparation callback phase via Infra Web's RequestContextHolder, but only if the test class is annotated with @WebAppConfiguration.
private void	setUpRequestContextIfNecessary(TestContext testContext)

从类继承的方法 cn.taketoday.test.context.support.AbstractTestExecutionListener

afterTestClass, afterTestExecution, beforeTestClass, beforeTestExecution

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

RESET_REQUEST_CONTEXT_HOLDER_ATTRIBUTE

public static final String RESET_REQUEST_CONTEXT_HOLDER_ATTRIBUTE

Attribute name for a TestContext attribute which indicates whether or not the ServletTestExecutionListener should reset Infra Web's RequestContextHolder in afterTestMethod(TestContext).

Permissible values include Boolean.TRUE and Boolean.FALSE.

POPULATED_REQUEST_CONTEXT_HOLDER_ATTRIBUTE

public static final String POPULATED_REQUEST_CONTEXT_HOLDER_ATTRIBUTE

Attribute name for a TestContext attribute which indicates that ServletTestExecutionListener has already populated Infra Web's RequestContextHolder.

Permissible values include Boolean.TRUE and Boolean.FALSE.

CREATED_BY_THE_TESTCONTEXT_FRAMEWORK

public static final String CREATED_BY_THE_TESTCONTEXT_FRAMEWORK

Attribute name for a request attribute which indicates that the MockHttpServletRequest stored in the RequestContext in Infra Web's RequestContextHolder was created by the TestContext framework.

Permissible values include Boolean.TRUE and Boolean.FALSE.

ACTIVATE_LISTENER

public static final String ACTIVATE_LISTENER

Attribute name for a TestContext attribute which indicates that the ServletTestExecutionListener should be activated. When not set to true, activation occurs when the test class is annotated with @WebAppConfiguration.

Permissible values include Boolean.TRUE and Boolean.FALSE.

logger

private static final cn.taketoday.logging.Logger logger

构造器详细资料

ServletTestExecutionListener

public ServletTestExecutionListener()

方法详细资料

getOrder

public final int getOrder()

Returns 1000.

指定者:

getOrder 在接口中 cn.taketoday.core.Ordered

覆盖:

getOrder 在类中 AbstractTestExecutionListener

prepareTestInstance

public void prepareTestInstance(TestContext testContext)
                         throws Exception

Sets up thread-local state during the test instance preparation callback phase via Infra Web's RequestContextHolder, but only if the test class is annotated with @WebAppConfiguration.

指定者:

prepareTestInstance 在接口中 TestExecutionListener

覆盖:

prepareTestInstance 在类中 AbstractTestExecutionListener

参数:

testContext - the test context for the test; never null

抛出:

Exception - allows any exception to propagate

另请参阅:

• TestExecutionListener.prepareTestInstance(TestContext)
• setUpRequestContextIfNecessary(TestContext)

beforeTestMethod

public void beforeTestMethod(TestContext testContext)
                      throws Exception

Sets up thread-local state before each test method via Infra Web's RequestContextHolder, but only if the test class is annotated with @WebAppConfiguration.

指定者:

beforeTestMethod 在接口中 TestExecutionListener

覆盖:

beforeTestMethod 在类中 AbstractTestExecutionListener

参数:

testContext - the test context in which the test method will be executed; never null

抛出:

Exception - allows any exception to propagate

另请参阅:

• TestExecutionListener.beforeTestMethod(TestContext)
• setUpRequestContextIfNecessary(TestContext)

afterTestMethod

public void afterTestMethod(TestContext testContext)
                     throws Exception

If the RESET_REQUEST_CONTEXT_HOLDER_ATTRIBUTE in the supplied TestContext has a value of Boolean.TRUE, this method will (1) clean up thread-local state after each test method by resetting Infra Web's RequestContextHolder and (2) ensure that new mocks are injected into the test instance for subsequent tests by setting the DependencyInjectionTestExecutionListener.REINJECT_DEPENDENCIES_ATTRIBUTE in the test context to true.

The RESET_REQUEST_CONTEXT_HOLDER_ATTRIBUTE and POPULATED_REQUEST_CONTEXT_HOLDER_ATTRIBUTE will be subsequently removed from the test context, regardless of their values.

指定者:

afterTestMethod 在接口中 TestExecutionListener

覆盖:

afterTestMethod 在类中 AbstractTestExecutionListener

参数:

testContext - the test context in which the test method was executed; never null

抛出:

Exception - allows any exception to propagate

另请参阅:

• TestExecutionListener.afterTestMethod(TestContext)

isActivated

private boolean isActivated(TestContext testContext)

alreadyPopulatedRequestContextHolder

private boolean alreadyPopulatedRequestContextHolder(TestContext testContext)

setUpRequestContextIfNecessary

private void setUpRequestContextIfNecessary(TestContext testContext)