From b014039a341582892b55035c11b3602baef29f44 Mon Sep 17 00:00:00 2001 From: Moritz Halbritter Date: Tue, 25 Oct 2022 13:51:43 +0200 Subject: [PATCH] Disable WebTestClientContextCustomizer after AOT processing After AOT processing, a WebTestClient bean will be defined directly so the context customizer that initiates its registration is not needed. Closes gh-32859 --- .../WebTestClientContextCustomizer.java | 7 ++ .../WebTestClientContextCustomizerTests.java | 91 +++++++++++++++++++ 2 files changed, 98 insertions(+) create mode 100644 spring-boot-project/spring-boot-test/src/test/java/org/springframework/boot/test/web/reactive/server/WebTestClientContextCustomizerTests.java diff --git a/spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/web/reactive/server/WebTestClientContextCustomizer.java b/spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/web/reactive/server/WebTestClientContextCustomizer.java index 3d90095d08..7bc6d6aad0 100644 --- a/spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/web/reactive/server/WebTestClientContextCustomizer.java +++ b/spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/web/reactive/server/WebTestClientContextCustomizer.java @@ -18,6 +18,7 @@ package org.springframework.boot.test.web.reactive.server; import java.util.Collection; +import org.springframework.aot.AotDetector; import org.springframework.beans.BeansException; import org.springframework.beans.factory.BeanFactory; import org.springframework.beans.factory.BeanFactoryAware; @@ -58,6 +59,9 @@ class WebTestClientContextCustomizer implements ContextCustomizer { @Override public void customizeContext(ConfigurableApplicationContext context, MergedContextConfiguration mergedConfig) { + if (AotDetector.useGeneratedArtifacts()) { + return; + } SpringBootTest springBootTest = TestContextAnnotationUtils.findMergedAnnotation(mergedConfig.getTestClass(), SpringBootTest.class); if (springBootTest.webEnvironment().isEmbedded()) { @@ -109,6 +113,9 @@ class WebTestClientContextCustomizer implements ContextCustomizer { @Override public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException { + if (AotDetector.useGeneratedArtifacts()) { + return; + } if (BeanFactoryUtils.beanNamesForTypeIncludingAncestors((ListableBeanFactory) this.beanFactory, WebTestClient.class, false, false).length == 0) { registry.registerBeanDefinition(WebTestClient.class.getName(), diff --git a/spring-boot-project/spring-boot-test/src/test/java/org/springframework/boot/test/web/reactive/server/WebTestClientContextCustomizerTests.java b/spring-boot-project/spring-boot-test/src/test/java/org/springframework/boot/test/web/reactive/server/WebTestClientContextCustomizerTests.java new file mode 100644 index 0000000000..d14dd54e18 --- /dev/null +++ b/spring-boot-project/spring-boot-test/src/test/java/org/springframework/boot/test/web/reactive/server/WebTestClientContextCustomizerTests.java @@ -0,0 +1,91 @@ +/* + * Copyright 2012-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.boot.test.web.reactive.server; + +import org.junit.jupiter.api.Test; + +import org.springframework.beans.factory.config.ConfigurableListableBeanFactory; +import org.springframework.beans.factory.support.DefaultListableBeanFactory; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.boot.test.context.SpringBootTest.WebEnvironment; +import org.springframework.boot.test.context.runner.ApplicationContextRunner; +import org.springframework.boot.test.web.reactive.server.WebTestClientContextCustomizer.WebTestClientRegistrar; +import org.springframework.context.ConfigurableApplicationContext; +import org.springframework.context.support.AbstractApplicationContext; +import org.springframework.test.context.MergedContextConfiguration; +import org.springframework.test.web.reactive.server.WebTestClient; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.mockito.BDDMockito.given; +import static org.mockito.Mockito.mock; + +/** + * Tests for {@link WebTestClientContextCustomizer}. + * + * @author Moritz Halbritter + */ +class WebTestClientContextCustomizerTests { + + @Test + void whenContextIsNotABeanDefinitionRegistryWebTestClientIsRegistered() { + new ApplicationContextRunner(TestApplicationContext::new) + .withInitializer(this::applyWebTestClientContextCustomizer) + .run((context) -> assertThat(context).hasSingleBean(WebTestClient.class)); + } + + @Test + void whenUsingAotGeneratedArtifactsWebTestClientIsNotRegistered() { + new ApplicationContextRunner().withSystemProperties("spring.aot.enabled:true") + .withInitializer(this::applyWebTestClientContextCustomizer).run((context) -> { + assertThat(context).doesNotHaveBean(WebTestClientRegistrar.class); + assertThat(context).doesNotHaveBean(WebTestClient.class); + }); + } + + @SuppressWarnings({ "unchecked", "rawtypes" }) + void applyWebTestClientContextCustomizer(ConfigurableApplicationContext context) { + MergedContextConfiguration configuration = mock(MergedContextConfiguration.class); + given(configuration.getTestClass()).willReturn((Class) TestClass.class); + new WebTestClientContextCustomizer().customizeContext(context, configuration); + } + + @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT) + static class TestClass { + + } + + static class TestApplicationContext extends AbstractApplicationContext { + + private final ConfigurableListableBeanFactory beanFactory = new DefaultListableBeanFactory(); + + @Override + protected void refreshBeanFactory() { + } + + @Override + protected void closeBeanFactory() { + + } + + @Override + public ConfigurableListableBeanFactory getBeanFactory() { + return this.beanFactory; + } + + } + +}