Introduce before/after test execution support in the SpringExtension
Issue: SPR-4365
This commit is contained in:
Sam Brannen
parent
da89332840
commit
80018c67e7
|
|
@ -23,8 +23,10 @@ import java.lang.reflect.Parameter;
|
|||
|
||||
import org.junit.jupiter.api.extension.AfterAllCallback;
|
||||
import org.junit.jupiter.api.extension.AfterEachCallback;
|
||||
import org.junit.jupiter.api.extension.AfterTestExecutionCallback;
|
||||
import org.junit.jupiter.api.extension.BeforeAllCallback;
|
||||
import org.junit.jupiter.api.extension.BeforeEachCallback;
|
||||
import org.junit.jupiter.api.extension.BeforeTestExecutionCallback;
|
||||
import org.junit.jupiter.api.extension.ContainerExtensionContext;
|
||||
import org.junit.jupiter.api.extension.ExtensionContext;
|
||||
import org.junit.jupiter.api.extension.ExtensionContext.Namespace;
|
||||
|
|
@ -54,7 +56,8 @@ import org.springframework.util.Assert;
|
|||
* @see org.springframework.test.context.TestContextManager
|
||||
*/
|
||||
public class SpringExtension implements BeforeAllCallback, AfterAllCallback, TestInstancePostProcessor,
|
||||
BeforeEachCallback, AfterEachCallback, ParameterResolver {
|
||||
BeforeEachCallback, AfterEachCallback, BeforeTestExecutionCallback, AfterTestExecutionCallback,
|
||||
ParameterResolver {
|
||||
|
||||
/**
|
||||
* {@link Namespace} in which {@code TestContextManagers} are stored, keyed
|
||||
|
|
@ -101,6 +104,27 @@ public class SpringExtension implements BeforeAllCallback, AfterAllCallback, Tes
|
|||
getTestContextManager(context).beforeTestMethod(testInstance, testMethod);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delegates to {@link TestContextManager#beforeTestExecution}.
|
||||
*/
|
||||
@Override
|
||||
public void beforeTestExecution(TestExtensionContext context) throws Exception {
|
||||
Object testInstance = context.getTestInstance();
|
||||
Method testMethod = context.getTestMethod().get();
|
||||
getTestContextManager(context).beforeTestExecution(testInstance, testMethod);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delegates to {@link TestContextManager#afterTestExecution}.
|
||||
*/
|
||||
@Override
|
||||
public void afterTestExecution(TestExtensionContext context) throws Exception {
|
||||
Object testInstance = context.getTestInstance();
|
||||
Method testMethod = context.getTestMethod().get();
|
||||
Throwable testException = context.getTestException().orElse(null);
|
||||
getTestContextManager(context).afterTestExecution(testInstance, testMethod, testException);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delegates to {@link TestContextManager#afterTestMethod}.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -0,0 +1,264 @@
|
|||
/*
|
||||
* Copyright 2002-2016 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.junit.jupiter;
|
||||
|
||||
import java.util.stream.Stream;
|
||||
|
||||
import javax.sql.DataSource;
|
||||
|
||||
import org.junit.jupiter.api.DynamicTest;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.junit.jupiter.api.TestFactory;
|
||||
import org.junit.jupiter.api.extension.ExtendWith;
|
||||
import org.junit.platform.launcher.Launcher;
|
||||
import org.junit.platform.launcher.core.LauncherFactory;
|
||||
import org.junit.platform.launcher.listeners.SummaryGeneratingListener;
|
||||
import org.junit.platform.launcher.listeners.TestExecutionSummary;
|
||||
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.jdbc.datasource.DataSourceTransactionManager;
|
||||
import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseBuilder;
|
||||
import org.springframework.test.context.TestContext;
|
||||
import org.springframework.test.context.TestExecutionListener;
|
||||
import org.springframework.test.context.TestExecutionListeners;
|
||||
import org.springframework.test.context.transaction.AfterTransaction;
|
||||
import org.springframework.test.context.transaction.BeforeTransaction;
|
||||
import org.springframework.transaction.PlatformTransactionManager;
|
||||
import org.springframework.transaction.annotation.Transactional;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.*;
|
||||
import static org.junit.jupiter.api.DynamicTest.*;
|
||||
import static org.junit.platform.engine.discovery.DiscoverySelectors.*;
|
||||
import static org.junit.platform.launcher.core.LauncherDiscoveryRequestBuilder.*;
|
||||
|
||||
/**
|
||||
* Integration tests which verify that '<i>before</i>' and '<i>after</i>'
|
||||
* methods of {@link TestExecutionListener TestExecutionListeners} as well as
|
||||
* {@code @BeforeTransaction} and {@code @AfterTransaction} methods can fail
|
||||
* tests run via the {@link SpringExtension} in a JUnit 5 (Jupiter) environment.
|
||||
*
|
||||
* <p>See: <a href="https://jira.spring.io/browse/SPR-3960" target="_blank">SPR-3960</a>
|
||||
* and <a href="https://jira.spring.io/browse/SPR-4365" target="_blank">SPR-4365</a>.
|
||||
*
|
||||
* <p>Indirectly, this class also verifies that all {@code TestExecutionListener}
|
||||
* lifecycle callbacks are called.
|
||||
*
|
||||
* @author Sam Brannen
|
||||
* @since 5.0
|
||||
*/
|
||||
class FailingBeforeAndAfterMethodsSpringExtensionTestCase {
|
||||
|
||||
private static Stream<Class<?>> testClasses() {
|
||||
// @formatter:off
|
||||
return Stream.of(
|
||||
AlwaysFailingBeforeTestClassTestCase.class,
|
||||
AlwaysFailingAfterTestClassTestCase.class,
|
||||
AlwaysFailingPrepareTestInstanceTestCase.class,
|
||||
AlwaysFailingBeforeTestMethodTestCase.class,
|
||||
AlwaysFailingBeforeTestExecutionTestCase.class,
|
||||
AlwaysFailingAfterTestExecutionTestCase.class,
|
||||
AlwaysFailingAfterTestMethodTestCase.class,
|
||||
FailingBeforeTransactionTestCase.class,
|
||||
FailingAfterTransactionTestCase.class);
|
||||
// @formatter:on
|
||||
}
|
||||
|
||||
@TestFactory
|
||||
Stream<DynamicTest> generateTests() throws Exception {
|
||||
return testClasses().map(clazz -> dynamicTest(clazz.getSimpleName(), () -> runTestAndAssertCounters(clazz)));
|
||||
}
|
||||
|
||||
private void runTestAndAssertCounters(Class<?> testClass) {
|
||||
Launcher launcher = LauncherFactory.create();
|
||||
SummaryGeneratingListener listener = new SummaryGeneratingListener();
|
||||
launcher.registerTestExecutionListeners(listener);
|
||||
|
||||
launcher.execute(request().selectors(selectClass(testClass)).build());
|
||||
TestExecutionSummary summary = listener.getSummary();
|
||||
|
||||
String name = testClass.getSimpleName();
|
||||
int expectedStartedCount = getExpectedStartedCount(testClass);
|
||||
int expectedSucceededCount = getExpectedSucceededCount(testClass);
|
||||
int expectedFailedCount = getExpectedFailedCount(testClass);
|
||||
|
||||
// @formatter:off
|
||||
assertAll(
|
||||
() -> assertEquals(1, summary.getTestsFoundCount(), () -> name + ": tests found"),
|
||||
() -> assertEquals(0, summary.getTestsSkippedCount(), () -> name + ": tests skipped"),
|
||||
() -> assertEquals(0, summary.getTestsAbortedCount(), () -> name + ": tests aborted"),
|
||||
() -> assertEquals(expectedStartedCount, summary.getTestsStartedCount(), () -> name + ": tests started"),
|
||||
() -> assertEquals(expectedSucceededCount, summary.getTestsSucceededCount(), () -> name + ": tests succeeded"),
|
||||
() -> assertEquals(expectedFailedCount, summary.getTestsFailedCount(), () -> name + ": tests failed")
|
||||
);
|
||||
// @formatter:on
|
||||
}
|
||||
|
||||
private int getExpectedStartedCount(Class<?> testClass) {
|
||||
return (testClass == AlwaysFailingBeforeTestClassTestCase.class ? 0 : 1);
|
||||
}
|
||||
|
||||
private int getExpectedSucceededCount(Class<?> testClass) {
|
||||
return (testClass == AlwaysFailingAfterTestClassTestCase.class ? 1 : 0);
|
||||
}
|
||||
|
||||
private int getExpectedFailedCount(Class<?> testClass) {
|
||||
if (testClass == AlwaysFailingBeforeTestClassTestCase.class
|
||||
|| testClass == AlwaysFailingAfterTestClassTestCase.class) {
|
||||
return 0;
|
||||
}
|
||||
return 1;
|
||||
}
|
||||
|
||||
|
||||
// -------------------------------------------------------------------
|
||||
|
||||
private static class AlwaysFailingBeforeTestClassTestExecutionListener implements TestExecutionListener {
|
||||
|
||||
@Override
|
||||
public void beforeTestClass(TestContext testContext) {
|
||||
fail("always failing beforeTestClass()");
|
||||
}
|
||||
}
|
||||
|
||||
private static class AlwaysFailingAfterTestClassTestExecutionListener implements TestExecutionListener {
|
||||
|
||||
@Override
|
||||
public void afterTestClass(TestContext testContext) {
|
||||
fail("always failing afterTestClass()");
|
||||
}
|
||||
}
|
||||
|
||||
private static class AlwaysFailingPrepareTestInstanceTestExecutionListener implements TestExecutionListener {
|
||||
|
||||
@Override
|
||||
public void prepareTestInstance(TestContext testContext) throws Exception {
|
||||
fail("always failing prepareTestInstance()");
|
||||
}
|
||||
}
|
||||
|
||||
private static class AlwaysFailingBeforeTestMethodTestExecutionListener implements TestExecutionListener {
|
||||
|
||||
@Override
|
||||
public void beforeTestMethod(TestContext testContext) {
|
||||
fail("always failing beforeTestMethod()");
|
||||
}
|
||||
}
|
||||
|
||||
private static class AlwaysFailingBeforeTestExecutionTestExecutionListener implements TestExecutionListener {
|
||||
|
||||
@Override
|
||||
public void beforeTestExecution(TestContext testContext) {
|
||||
fail("always failing beforeTestExecution()");
|
||||
}
|
||||
}
|
||||
|
||||
private static class AlwaysFailingAfterTestMethodTestExecutionListener implements TestExecutionListener {
|
||||
|
||||
@Override
|
||||
public void afterTestMethod(TestContext testContext) {
|
||||
fail("always failing afterTestMethod()");
|
||||
}
|
||||
}
|
||||
|
||||
private static class AlwaysFailingAfterTestExecutionTestExecutionListener implements TestExecutionListener {
|
||||
|
||||
@Override
|
||||
public void afterTestExecution(TestContext testContext) {
|
||||
fail("always failing afterTestExecution()");
|
||||
}
|
||||
}
|
||||
|
||||
@ExtendWith(SpringExtension.class)
|
||||
private static abstract class BaseTestCase {
|
||||
|
||||
@Test
|
||||
void testNothing() {
|
||||
}
|
||||
}
|
||||
|
||||
@TestExecutionListeners(AlwaysFailingBeforeTestClassTestExecutionListener.class)
|
||||
private static class AlwaysFailingBeforeTestClassTestCase extends BaseTestCase {
|
||||
}
|
||||
|
||||
@TestExecutionListeners(AlwaysFailingAfterTestClassTestExecutionListener.class)
|
||||
private static class AlwaysFailingAfterTestClassTestCase extends BaseTestCase {
|
||||
}
|
||||
|
||||
@TestExecutionListeners(AlwaysFailingPrepareTestInstanceTestExecutionListener.class)
|
||||
private static class AlwaysFailingPrepareTestInstanceTestCase extends BaseTestCase {
|
||||
}
|
||||
|
||||
@TestExecutionListeners(AlwaysFailingBeforeTestMethodTestExecutionListener.class)
|
||||
private static class AlwaysFailingBeforeTestMethodTestCase extends BaseTestCase {
|
||||
}
|
||||
|
||||
@TestExecutionListeners(AlwaysFailingBeforeTestExecutionTestExecutionListener.class)
|
||||
private static class AlwaysFailingBeforeTestExecutionTestCase extends BaseTestCase {
|
||||
}
|
||||
|
||||
@TestExecutionListeners(AlwaysFailingAfterTestExecutionTestExecutionListener.class)
|
||||
private static class AlwaysFailingAfterTestExecutionTestCase extends BaseTestCase {
|
||||
}
|
||||
|
||||
@TestExecutionListeners(AlwaysFailingAfterTestMethodTestExecutionListener.class)
|
||||
private static class AlwaysFailingAfterTestMethodTestCase extends BaseTestCase {
|
||||
}
|
||||
|
||||
@SpringJUnitConfig(DatabaseConfig.class)
|
||||
@Transactional
|
||||
private static class FailingBeforeTransactionTestCase {
|
||||
|
||||
@Test
|
||||
void testNothing() {
|
||||
}
|
||||
|
||||
@BeforeTransaction
|
||||
void beforeTransaction() {
|
||||
fail("always failing beforeTransaction()");
|
||||
}
|
||||
}
|
||||
|
||||
@SpringJUnitConfig(DatabaseConfig.class)
|
||||
@Transactional
|
||||
private static class FailingAfterTransactionTestCase {
|
||||
|
||||
@Test
|
||||
void testNothing() {
|
||||
}
|
||||
|
||||
@AfterTransaction
|
||||
void afterTransaction() {
|
||||
fail("always failing afterTransaction()");
|
||||
}
|
||||
}
|
||||
|
||||
@Configuration
|
||||
private static class DatabaseConfig {
|
||||
|
||||
@Bean
|
||||
PlatformTransactionManager transactionManager() {
|
||||
return new DataSourceTransactionManager(dataSource());
|
||||
}
|
||||
|
||||
@Bean
|
||||
DataSource dataSource() {
|
||||
return new EmbeddedDatabaseBuilder().generateUniqueName(true).build();
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
Loading…
Reference in New Issue