From 1e2541a0a31eee6f137b83590768a3c12a467f83 Mon Sep 17 00:00:00 2001 From: Sam Brannen Date: Tue, 13 Sep 2022 11:14:51 +0200 Subject: [PATCH] Remove support for setting default CacheAwareContextLoaderDelegate The ability to set a system property to change the default CacheAwareContextLoaderDelegate was only needed by the Spring Native project in the Spring Framework 5.3.x line and should not be used by other projects. This commit therefore reverts the changes made in conjunction with gh-27540. Closes gh-29061 --- .../test/context/BootstrapUtils.java | 25 ++--- .../CacheAwareContextLoaderDelegate.java | 16 +--- ...tCacheAwareContextLoaderDelegateTests.java | 95 ------------------- 3 files changed, 9 insertions(+), 127 deletions(-) delete mode 100644 spring-test/src/test/java/org/springframework/test/context/support/CustomDefaultCacheAwareContextLoaderDelegateTests.java diff --git a/spring-test/src/main/java/org/springframework/test/context/BootstrapUtils.java b/spring-test/src/main/java/org/springframework/test/context/BootstrapUtils.java index f11f7ebf0d..be013af022 100644 --- a/spring-test/src/main/java/org/springframework/test/context/BootstrapUtils.java +++ b/spring-test/src/main/java/org/springframework/test/context/BootstrapUtils.java @@ -25,11 +25,9 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.springframework.beans.BeanUtils; -import org.springframework.core.SpringProperties; import org.springframework.lang.Nullable; import org.springframework.test.context.TestContextAnnotationUtils.AnnotationDescriptor; import org.springframework.util.ClassUtils; -import org.springframework.util.StringUtils; /** * {@code BootstrapUtils} is a collection of utility methods to assist with @@ -68,12 +66,8 @@ public abstract class BootstrapUtils { /** * Create the {@code BootstrapContext} for the specified {@linkplain Class test class}. - *

Uses reflection to create a {@link org.springframework.test.context.support.DefaultBootstrapContext} - * that uses a default {@link CacheAwareContextLoaderDelegate} — configured - * via the {@link CacheAwareContextLoaderDelegate#DEFAULT_CACHE_AWARE_CONTEXT_LOADER_DELEGATE_PROPERTY_NAME} - * system property or falling back to the - * {@link org.springframework.test.context.cache.DefaultCacheAwareContextLoaderDelegate} - * if the system property is not defined. + *

Uses reflection to create a {@link org.springframework.test.context.support.DefaultBootstrapContext}. + * that uses a {@link org.springframework.test.context.cache.DefaultCacheAwareContextLoaderDelegate}. * @param testClass the test class for which the bootstrap context should be created * @return a new {@code BootstrapContext}; never {@code null} */ @@ -98,21 +92,18 @@ public abstract class BootstrapUtils { @SuppressWarnings("unchecked") private static CacheAwareContextLoaderDelegate createCacheAwareContextLoaderDelegate() { - String className = SpringProperties.getProperty( - CacheAwareContextLoaderDelegate.DEFAULT_CACHE_AWARE_CONTEXT_LOADER_DELEGATE_PROPERTY_NAME); - className = (StringUtils.hasText(className) ? className.trim() : - DEFAULT_CACHE_AWARE_CONTEXT_LOADER_DELEGATE_CLASS_NAME); + Class clazz = null; try { - Class clazz = - (Class) ClassUtils.forName( - className, BootstrapUtils.class.getClassLoader()); + clazz = (Class) ClassUtils.forName( + DEFAULT_CACHE_AWARE_CONTEXT_LOADER_DELEGATE_CLASS_NAME, BootstrapUtils.class.getClassLoader()); if (logger.isDebugEnabled()) { - logger.debug(String.format("Instantiating CacheAwareContextLoaderDelegate from class [%s]", className)); + logger.debug(String.format("Instantiating CacheAwareContextLoaderDelegate from class [%s]", + clazz.getName())); } return BeanUtils.instantiateClass(clazz, CacheAwareContextLoaderDelegate.class); } catch (Throwable ex) { - throw new IllegalStateException("Could not create CacheAwareContextLoaderDelegate [" + className + "]", ex); + throw new IllegalStateException("Could not load CacheAwareContextLoaderDelegate [" + clazz + "]", ex); } } diff --git a/spring-test/src/main/java/org/springframework/test/context/CacheAwareContextLoaderDelegate.java b/spring-test/src/main/java/org/springframework/test/context/CacheAwareContextLoaderDelegate.java index d05da0c51d..efd6dca178 100644 --- a/spring-test/src/main/java/org/springframework/test/context/CacheAwareContextLoaderDelegate.java +++ b/spring-test/src/main/java/org/springframework/test/context/CacheAwareContextLoaderDelegate.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2021 the original author or authors. + * 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. @@ -36,20 +36,6 @@ import org.springframework.test.annotation.DirtiesContext.HierarchyMode; */ public interface CacheAwareContextLoaderDelegate { - /** - * System property used to configure the fully qualified class name of the - * default {@code CacheAwareContextLoaderDelegate}. - *

May alternatively be configured via the - * {@link org.springframework.core.SpringProperties} mechanism. - *

If this property is not defined, the - * {@link org.springframework.test.context.cache.DefaultCacheAwareContextLoaderDelegate - * DefaultCacheAwareContextLoaderDelegate} will be used as the default. - * @since 5.3.11 - */ - String DEFAULT_CACHE_AWARE_CONTEXT_LOADER_DELEGATE_PROPERTY_NAME = - "spring.test.context.default.CacheAwareContextLoaderDelegate"; - - /** * Determine if the {@linkplain ApplicationContext application context} for * the supplied {@link MergedContextConfiguration} has been loaded (i.e., diff --git a/spring-test/src/test/java/org/springframework/test/context/support/CustomDefaultCacheAwareContextLoaderDelegateTests.java b/spring-test/src/test/java/org/springframework/test/context/support/CustomDefaultCacheAwareContextLoaderDelegateTests.java deleted file mode 100644 index 963b616354..0000000000 --- a/spring-test/src/test/java/org/springframework/test/context/support/CustomDefaultCacheAwareContextLoaderDelegateTests.java +++ /dev/null @@ -1,95 +0,0 @@ -/* - * Copyright 2002-2021 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.support; - -import org.junit.jupiter.api.Test; -import org.junit.platform.testkit.engine.EngineTestKit; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.context.ApplicationContext; -import org.springframework.context.annotation.Bean; -import org.springframework.context.annotation.Configuration; -import org.springframework.context.support.GenericApplicationContext; -import org.springframework.core.SpringProperties; -import org.springframework.test.context.CacheAwareContextLoaderDelegate; -import org.springframework.test.context.MergedContextConfiguration; -import org.springframework.test.context.cache.DefaultCacheAwareContextLoaderDelegate; -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; - -/** - * Integration tests for configuring a custom default {@link CacheAwareContextLoaderDelegate} - * via {@link SpringProperties}. - * - * @author sbrannen - * @since 5.3.11 - */ -class CustomDefaultCacheAwareContextLoaderDelegateTests { - - @Test - void customDefaultCacheAwareContextLoaderDelegateConfiguredViaSpringProperties() { - String key = CacheAwareContextLoaderDelegate.DEFAULT_CACHE_AWARE_CONTEXT_LOADER_DELEGATE_PROPERTY_NAME; - - try { - SpringProperties.setProperty(key, AotCacheAwareContextLoaderDelegate.class.getName()); - - EngineTestKit.engine("junit-jupiter")// - .selectors(selectClass(TestCase.class))// - .execute()// - .testEvents()// - .assertStatistics(stats -> stats.started(1).succeeded(1).failed(0)); - } - finally { - SpringProperties.setProperty(key, null); - } - } - - - @SpringJUnitConfig - static class TestCase { - - @Test - void test(@Autowired String foo) { - // foo will be "bar" unless the AotCacheAwareContextLoaderDelegate is registered. - assertThat(foo).isEqualTo("AOT"); - } - - - @Configuration - static class Config { - - @Bean - String foo() { - return "bar"; - } - } - } - - static class AotCacheAwareContextLoaderDelegate extends DefaultCacheAwareContextLoaderDelegate { - - @Override - protected ApplicationContext loadContextInternal(MergedContextConfiguration mergedContextConfiguration) { - GenericApplicationContext applicationContext = new GenericApplicationContext(); - applicationContext.registerBean("foo", String.class, () -> "AOT"); - applicationContext.refresh(); - return applicationContext; - } - } - -}