Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve documentation for TestContext events
This commit improves the documentation for test execution events, especially with regard to the fact that, by default, a BeforeTestClassEvent is not published for the first test class using a particular ApplicationContext. This commit also introduces tests that verify the default behavior and the ability to change the default behavior with a custom TestExecutionListener that eagerly loads the context. Closes gh-27757
- Loading branch information
Showing
11 changed files
with
264 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...ng-test/src/main/java/org/springframework/test/context/event/annotation/package-info.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| /** | ||
| * Test event annotations for the <em>Spring TestContext Framework</em>. | ||
| * Test execution event annotations for the <em>Spring TestContext Framework</em>. | ||
| */ | ||
| package org.springframework.test.context.event.annotation; |
190 changes: 190 additions & 0 deletions
190
...t/java/org/springframework/test/context/event/EagerTestExecutionEventPublishingTests.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,190 @@ | ||
| /* | ||
| * Copyright 2002-2022 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 | ||
| * | ||
| * https://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.util.ArrayList; | ||
| import java.util.List; | ||
|
|
||
| import org.junit.jupiter.api.AfterEach; | ||
| import org.junit.jupiter.api.BeforeEach; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.platform.testkit.engine.EngineTestKit; | ||
|
|
||
| import org.springframework.context.annotation.Configuration; | ||
| import org.springframework.core.annotation.Order; | ||
| import org.springframework.test.context.TestContext; | ||
| import org.springframework.test.context.TestExecutionListener; | ||
| import org.springframework.test.context.TestExecutionListeners; | ||
| import org.springframework.test.context.TestExecutionListeners.MergeMode; | ||
| import org.springframework.test.context.event.annotation.AfterTestClass; | ||
| import org.springframework.test.context.event.annotation.AfterTestExecution; | ||
| import org.springframework.test.context.event.annotation.AfterTestMethod; | ||
| import org.springframework.test.context.event.annotation.BeforeTestClass; | ||
| import org.springframework.test.context.event.annotation.BeforeTestExecution; | ||
| import org.springframework.test.context.event.annotation.BeforeTestMethod; | ||
| import org.springframework.test.context.event.annotation.PrepareTestInstance; | ||
| import org.springframework.test.context.junit.jupiter.SpringJUnitConfig; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
| import static org.junit.platform.engine.discovery.DiscoverySelectors.selectClass; | ||
|
|
||
| /** | ||
| * Tests for the {@link EventPublishingTestExecutionListener} which verify that | ||
| * a {@link BeforeTestClassEvent} can be eagerly published; whereas, such an | ||
| * event is not published by default for the first run of a test class for a | ||
| * specific {@code ApplicationContext}. | ||
| * | ||
| * @author Sam Brannen | ||
| * @since 5.3.17 | ||
| * @see https://github.com/spring-projects/spring-framework/issues/27757 | ||
| */ | ||
| class EagerTestExecutionEventPublishingTests { | ||
|
|
||
| private static final List<Class<? extends TestContextEvent>> events = new ArrayList<>(); | ||
|
|
||
|
|
||
| @BeforeEach | ||
| @AfterEach | ||
| void resetEvents() { | ||
| events.clear(); | ||
| } | ||
|
|
||
| @Test | ||
| void beforeTestClassEventIsNotPublishedByDefaultForFirstTestClass() { | ||
| EngineTestKit.engine("junit-jupiter")// | ||
| .selectors(selectClass(LazyTestCase1.class), selectClass(LazyTestCase2.class))// | ||
| .execute()// | ||
| .testEvents()// | ||
| .assertStatistics(stats -> stats.started(2).succeeded(2).failed(0)); | ||
|
|
||
| assertThat(events).containsExactly(// | ||
| // 1st test class | ||
| // BeforeTestClassEvent.class -- missing for 1st test class | ||
| PrepareTestInstanceEvent.class, // | ||
| BeforeTestMethodEvent.class, // | ||
| BeforeTestExecutionEvent.class, // | ||
| AfterTestExecutionEvent.class, // | ||
| AfterTestMethodEvent.class, // | ||
| AfterTestClassEvent.class, // | ||
| // 2nd test class | ||
| BeforeTestClassEvent.class, // | ||
| PrepareTestInstanceEvent.class, // | ||
| BeforeTestMethodEvent.class, // | ||
| BeforeTestExecutionEvent.class, // | ||
| AfterTestExecutionEvent.class, // | ||
| AfterTestMethodEvent.class, // | ||
| AfterTestClassEvent.class// | ||
| ); | ||
| } | ||
|
|
||
| @Test | ||
| void beforeTestClassEventIsPublishedForAllTestClassesIfCustomListenerEagerlyLoadsContext() { | ||
| EngineTestKit.engine("junit-jupiter")// | ||
| .selectors(selectClass(EagerTestCase1.class), selectClass(EagerTestCase2.class))// | ||
| .execute()// | ||
| .testEvents()// | ||
| .assertStatistics(stats -> stats.started(2).succeeded(2).failed(0)); | ||
|
|
||
| assertThat(events).containsExactly(// | ||
| // 1st test class | ||
| BeforeTestClassEvent.class, // | ||
| PrepareTestInstanceEvent.class, // | ||
| BeforeTestMethodEvent.class, // | ||
| BeforeTestExecutionEvent.class, // | ||
| AfterTestExecutionEvent.class, // | ||
| AfterTestMethodEvent.class, // | ||
| AfterTestClassEvent.class, // | ||
| // 2nd test class | ||
| BeforeTestClassEvent.class, // | ||
| PrepareTestInstanceEvent.class, // | ||
| BeforeTestMethodEvent.class, // | ||
| BeforeTestExecutionEvent.class, // | ||
| AfterTestExecutionEvent.class, // | ||
| AfterTestMethodEvent.class, // | ||
| AfterTestClassEvent.class// | ||
| ); | ||
| } | ||
|
|
||
|
|
||
| @SpringJUnitConfig(Config.class) | ||
| static class LazyTestCase1 { | ||
|
|
||
| @Test | ||
| void test() { | ||
| } | ||
| } | ||
|
|
||
| static class LazyTestCase2 extends LazyTestCase1 { | ||
| } | ||
|
|
||
| @TestExecutionListeners(listeners = EagerLoadingTestExecutionListener.class, mergeMode = MergeMode.MERGE_WITH_DEFAULTS) | ||
| static class EagerTestCase1 extends LazyTestCase1 { | ||
| } | ||
|
|
||
| static class EagerTestCase2 extends EagerTestCase1 { | ||
| } | ||
|
|
||
| @Configuration | ||
| static class Config { | ||
|
|
||
| @BeforeTestClass | ||
| public void beforeTestClass(BeforeTestClassEvent e) { | ||
| events.add(e.getClass()); | ||
| } | ||
|
|
||
| @PrepareTestInstance | ||
| public void prepareTestInstance(PrepareTestInstanceEvent e) { | ||
| events.add(e.getClass()); | ||
| } | ||
|
|
||
| @BeforeTestMethod | ||
| public void beforeTestMethod(BeforeTestMethodEvent e) { | ||
| events.add(e.getClass()); | ||
| } | ||
|
|
||
| @BeforeTestExecution | ||
| public void beforeTestExecution(BeforeTestExecutionEvent e) { | ||
| events.add(e.getClass()); | ||
| } | ||
|
|
||
| @AfterTestExecution | ||
| public void afterTestExecution(AfterTestExecutionEvent e) { | ||
| events.add(e.getClass()); | ||
| } | ||
|
|
||
| @AfterTestMethod | ||
| public void afterTestMethod(AfterTestMethodEvent e) { | ||
| events.add(e.getClass()); | ||
| } | ||
|
|
||
| @AfterTestClass | ||
| public void afterTestClass(AfterTestClassEvent e) { | ||
| events.add(e.getClass()); | ||
| } | ||
|
|
||
| } | ||
|
|
||
| @Order(0) | ||
| static class EagerLoadingTestExecutionListener implements TestExecutionListener { | ||
|
|
||
| @Override | ||
| public void beforeTestClass(TestContext testContext) { | ||
| testContext.getApplicationContext(); | ||
| } | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.