Provide support for publishing TestContext lifecycle events
This commit introduces a new EventPublishingTestExecutionListener for publishing events to the test ApplicationContext. These may be consumed by @EventListener annotated methods to react to the TestContext lifecycle. The listener is not registered by default. Closes gh-18490
This commit is contained in:
Frank Scheffler
committed by
Sam Brannen
Sam Brannen
parent
a7db395d9b
commit
34fee867d2
@@ -0,0 +1,170 @@
|
||||
/*
|
||||
* Copyright 2002-2019 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.test.context.event;
|
||||
|
||||
import java.lang.reflect.Method;
|
||||
|
||||
import org.junit.Before;
|
||||
import org.junit.Test;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.test.context.ContextConfiguration;
|
||||
import org.springframework.test.context.TestContext;
|
||||
import org.springframework.test.context.TestContextManager;
|
||||
import org.springframework.test.context.TestExecutionListener;
|
||||
import org.springframework.test.context.TestExecutionListeners;
|
||||
import org.springframework.test.context.event.annotation.*;
|
||||
import org.springframework.util.ReflectionUtils;
|
||||
|
||||
import static org.mockito.BDDMockito.*;
|
||||
|
||||
/**
|
||||
* Integration test for {@link EventPublishingTestExecutionListener} and
|
||||
* accompanying {@link TestContextEvent} annotations.
|
||||
*
|
||||
* @author Frank Scheffler
|
||||
* @since 5.2
|
||||
*/
|
||||
public class EventPublishingTestExecutionListenerIntegrationTests {
|
||||
|
||||
private TestContextManager testContextManager;
|
||||
private TestContext testContext;
|
||||
private TestExecutionListener trigger;
|
||||
private Object testInstance;
|
||||
private Method testMethod;
|
||||
|
||||
@Configuration
|
||||
static class EventCaptureConfiguration {
|
||||
@Bean
|
||||
public TestExecutionListener trigger() {
|
||||
return mock(TestExecutionListener.class);
|
||||
}
|
||||
|
||||
@BeforeTestClass
|
||||
public void beforeTestClass(BeforeTestClassEvent e) throws Exception {
|
||||
trigger().beforeTestClass(e.getSource());
|
||||
}
|
||||
|
||||
@PrepareTestInstance
|
||||
public void prepareTestInstance(PrepareTestInstanceEvent e) throws Exception {
|
||||
trigger().prepareTestInstance(e.getSource());
|
||||
}
|
||||
|
||||
|
||||
@BeforeTestMethod
|
||||
public void beforeTestMethod(BeforeTestMethodEvent e) throws Exception {
|
||||
trigger().beforeTestMethod(e.getSource());
|
||||
}
|
||||
|
||||
@BeforeTestExecution
|
||||
public void beforeTestExecutiob(BeforeTestExecutionEvent e) throws Exception {
|
||||
trigger().beforeTestExecution(e.getSource());
|
||||
}
|
||||
|
||||
@AfterTestExecution
|
||||
public void afterTestExecution(AfterTestExecutionEvent e) throws Exception {
|
||||
trigger().afterTestExecution(e.getSource());
|
||||
}
|
||||
|
||||
@AfterTestMethod
|
||||
public void afterTestMethod(AfterTestMethodEvent e) throws Exception {
|
||||
trigger().afterTestMethod(e.getSource());
|
||||
}
|
||||
|
||||
@AfterTestClass
|
||||
public void afterTestClass(AfterTestClassEvent e) throws Exception {
|
||||
trigger().afterTestClass(e.getSource());
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@ContextConfiguration(classes = EventCaptureConfiguration.class)
|
||||
@TestExecutionListeners(EventPublishingTestExecutionListener.class)
|
||||
static class EmptyTestCase {
|
||||
|
||||
/**
|
||||
* Serves as dummy test method.
|
||||
*/
|
||||
@SuppressWarnings("PMD.UncommentedEmptyMethodBody")
|
||||
public void dummyTestMethod() {
|
||||
}
|
||||
}
|
||||
|
||||
static class TestContextExposingTestContextManager extends TestContextManager {
|
||||
public TestContextExposingTestContextManager() {
|
||||
super(EmptyTestCase.class);
|
||||
}
|
||||
|
||||
public TestContext getProtectedTestContext() {
|
||||
return getTestContext();
|
||||
}
|
||||
}
|
||||
|
||||
@Before
|
||||
public void initialize() {
|
||||
TestContextExposingTestContextManager tcm = new TestContextExposingTestContextManager();
|
||||
testContextManager = tcm;
|
||||
testContext = tcm.getProtectedTestContext();
|
||||
trigger = testContext.getApplicationContext().getBean(EventCaptureConfiguration.class).trigger();
|
||||
// reset because mock is a cached context bean
|
||||
reset(trigger);
|
||||
testInstance = new EmptyTestCase();
|
||||
testMethod = ReflectionUtils.findMethod(EmptyTestCase.class, "dummyMethod");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void beforeTestClassAnnotation() throws Exception {
|
||||
testContextManager.beforeTestClass();
|
||||
verify(trigger, only()).beforeTestClass(testContext);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void prepareTestInstanceAnnotation() throws Exception {
|
||||
testContextManager.prepareTestInstance(testInstance);
|
||||
verify(trigger, only()).prepareTestInstance(testContext);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void beforeTestMethodAnnotation() throws Exception {
|
||||
testContextManager.beforeTestMethod(testInstance, testMethod);
|
||||
verify(trigger, only()).beforeTestMethod(testContext);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void beforeTestExecutionAnnotation() throws Exception {
|
||||
testContextManager.beforeTestExecution(testInstance, testMethod);
|
||||
verify(trigger, only()).beforeTestExecution(testContext);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void afterTestExecutionAnnotation() throws Exception {
|
||||
testContextManager.afterTestExecution(testInstance, testMethod, null);
|
||||
verify(trigger, only()).afterTestExecution(testContext);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void afterTestMethodAnnotation() throws Exception {
|
||||
testContextManager.afterTestMethod(testInstance, testMethod, null);
|
||||
verify(trigger, only()).afterTestMethod(testContext);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void afterTestClassAnnotation() throws Exception {
|
||||
testContextManager.afterTestClass();
|
||||
verify(trigger, only()).afterTestClass(testContext);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,100 @@
|
||||
/*
|
||||
* Copyright 2002-2019 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.test.context.event;
|
||||
|
||||
import org.junit.Test;
|
||||
import org.junit.runner.RunWith;
|
||||
import org.mockito.Answers;
|
||||
import org.mockito.ArgumentCaptor;
|
||||
import org.mockito.Captor;
|
||||
import org.mockito.Mock;
|
||||
import org.mockito.junit.MockitoJUnitRunner;
|
||||
import org.springframework.test.context.TestContext;
|
||||
|
||||
import static org.hamcrest.Matchers.equalTo;
|
||||
import static org.hamcrest.Matchers.instanceOf;
|
||||
import static org.junit.Assert.assertThat;
|
||||
import static org.mockito.BDDMockito.only;
|
||||
import static org.mockito.BDDMockito.verify;
|
||||
|
||||
|
||||
/**
|
||||
* Unit test for {@link EventPublishingTestExecutionListener}.
|
||||
*
|
||||
* @author Frank Scheffler
|
||||
* @since 5.2
|
||||
*/
|
||||
@RunWith(MockitoJUnitRunner.class)
|
||||
public class EventPublishingTestExecutionListenerTests {
|
||||
|
||||
@Mock(answer=Answers.RETURNS_DEEP_STUBS)
|
||||
private TestContext testContext;
|
||||
|
||||
@Captor
|
||||
private ArgumentCaptor<TestContextEvent> testExecutionEvent;
|
||||
|
||||
|
||||
private final EventPublishingTestExecutionListener cut = new EventPublishingTestExecutionListener();
|
||||
|
||||
private <T extends TestContextEvent> void assertEvent(Class<T> eventClass) {
|
||||
verify(testContext.getApplicationContext(), only()).publishEvent(testExecutionEvent.capture());
|
||||
assertThat(testExecutionEvent.getValue(), instanceOf(eventClass));
|
||||
assertThat(testExecutionEvent.getValue().getSource(), equalTo(testContext));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void publishBeforeClassTestExecutionEvent() {
|
||||
cut.beforeTestClass(testContext);
|
||||
assertEvent(BeforeTestClassEvent.class);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void publishPrepareInstanceTestExecutionEvent() {
|
||||
cut.prepareTestInstance(testContext);
|
||||
assertEvent(PrepareTestInstanceEvent.class);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void publishBeforeMethodTestExecutionEvent() {
|
||||
cut.beforeTestMethod(testContext);
|
||||
assertEvent(BeforeTestMethodEvent.class);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void publishBeforeExecutionTestExecutionEvent() {
|
||||
cut.beforeTestExecution(testContext);
|
||||
assertEvent(BeforeTestExecutionEvent.class);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void publishAfterExecutionTestExecutionEvent() {
|
||||
cut.afterTestExecution(testContext);
|
||||
assertEvent(AfterTestExecutionEvent.class);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void publishAfterMethodTestExecutionEvent() {
|
||||
cut.afterTestMethod(testContext);
|
||||
assertEvent(AfterTestMethodEvent.class);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void publishAfterClassTestExecutionEvent() {
|
||||
cut.afterTestClass(testContext);
|
||||
assertEvent(AfterTestClassEvent.class);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user