From 89df2fd1a3b012355ee99124a70e323e533fe7b1 Mon Sep 17 00:00:00 2001 From: John Blum Date: Thu, 16 Sep 2021 11:13:50 -0700 Subject: [PATCH] Add Integration Test asserting the behavior of SDG Annotation-based configuration when Spring container bean definition overriding is disabled. https://stackoverflow.com/questions/69202828/error-bean-definition-overriding-clientgemfirepropertiesconfigurer --- ...ionOverridingDisabledIntegrationTests.java | 137 ++++++++++++++++++ 1 file changed, 137 insertions(+) create mode 100644 spring-data-geode/src/test/java/org/springframework/data/gemfire/config/annotation/UsingAnnotationConfigWithBeanDefinitionOverridingDisabledIntegrationTests.java diff --git a/spring-data-geode/src/test/java/org/springframework/data/gemfire/config/annotation/UsingAnnotationConfigWithBeanDefinitionOverridingDisabledIntegrationTests.java b/spring-data-geode/src/test/java/org/springframework/data/gemfire/config/annotation/UsingAnnotationConfigWithBeanDefinitionOverridingDisabledIntegrationTests.java new file mode 100644 index 00000000..55d62839 --- /dev/null +++ b/spring-data-geode/src/test/java/org/springframework/data/gemfire/config/annotation/UsingAnnotationConfigWithBeanDefinitionOverridingDisabledIntegrationTests.java @@ -0,0 +1,137 @@ +/* + * Copyright 2020 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.data.gemfire.config.annotation; + +import static org.assertj.core.api.Assertions.assertThat; + +import java.util.Optional; +import java.util.Properties; + +import org.junit.Before; +import org.junit.Test; +import org.junit.runner.RunWith; + +import org.apache.geode.cache.GemFireCache; +import org.apache.geode.distributed.DistributedSystem; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.beans.factory.config.ConfigurableListableBeanFactory; +import org.springframework.beans.factory.support.DefaultListableBeanFactory; +import org.springframework.context.ApplicationContextInitializer; +import org.springframework.context.ConfigurableApplicationContext; +import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.Import; +import org.springframework.context.annotation.Profile; +import org.springframework.data.gemfire.GemFireProperties; +import org.springframework.data.gemfire.test.mock.annotation.EnableGemFireMockObjects; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit4.SpringRunner; + +/** + * Integration Tests testing the use of SDG's Annotation configuration metadata when bean definition overriding + * in the Spring container has been disabled. + * + * @author John Blum + * @see org.junit.Test + * @see java.util.Properties + * @see org.apache.geode.cache.GemFireCache + * @see org.apache.geode.distributed.DistributedSystem + * @see org.springframework.beans.factory.config.ConfigurableListableBeanFactory + * @see org.springframework.context.ApplicationContextInitializer + * @see org.springframework.context.ConfigurableApplicationContext + * @see org.springframework.context.annotation.Configuration + * @see org.springframework.context.annotation.Import + * @see org.springframework.context.annotation.Profile + * @see org.springframework.data.gemfire.GemFireProperties + * @see org.springframework.data.gemfire.test.mock.annotation.EnableGemFireMockObjects + * @see org.springframework.test.context.ContextConfiguration + * @see org.springframework.test.context.junit4.SpringRunner + * @see Error - Bean Definition Overriding - ClientGemFirePropertiesConfigurer + * @since 2.6.0 + */ +@RunWith(SpringRunner.class) +//@ActiveProfiles("incorrect-test-configuration") +@ContextConfiguration(initializers = UsingAnnotationConfigWithBeanDefinitionOverridingDisabledIntegrationTests + .DisableBeanDefinitionOverridingApplicationContextInitializer.class) +@SuppressWarnings("unused") +public class UsingAnnotationConfigWithBeanDefinitionOverridingDisabledIntegrationTests { + + @Autowired + private ConfigurableApplicationContext applicationContext; + + @Autowired + private GemFireCache cache; + + @Before + public void assertApplicationContextBeanDefinitionOverridingIsDisabled() { + + assertThat(this.applicationContext).isNotNull(); + + ConfigurableListableBeanFactory beanFactory = this.applicationContext.getBeanFactory(); + + assertThat(beanFactory).isInstanceOf(DefaultListableBeanFactory.class); + assertThat(((DefaultListableBeanFactory) beanFactory).isAllowBeanDefinitionOverriding()).isFalse(); + } + + @Test + public void gemfireCacheSecurityAndSslConfigurationIsCorrect() { + + assertThat(this.cache).isNotNull(); + //assertThat(this.cache.getName()) + // .isEqualTo(UsingAnnotationConfigWithBeanDefinitionOverridingDisabledIntegrationTests.class.getSimpleName()); + + DistributedSystem distributedSystem = this.cache.getDistributedSystem(); + + assertThat(distributedSystem).isNotNull(); + + Properties gemfireProperties = distributedSystem.getProperties(); + + assertThat(gemfireProperties).isNotNull(); + assertThat(gemfireProperties).isNotEmpty(); + assertThat(gemfireProperties.getProperty(GemFireProperties.SECURITY_MANAGER.getName())) + .isEqualTo(String.valueOf(TestSecurityManager.class)); + assertThat(gemfireProperties.getProperty(GemFireProperties.SSL_KEYSTORE.getName())).isEqualTo("/path/to/test/keystore.jks"); + } + + @EnableGemFireMockObjects + @ClientCacheApplication(name = "UsingAnnotationConfigWithBeanDefinitionOverridingDisabledIntegrationTests") + @EnableSecurity(securityManagerClass = TestSecurityManager.class) + @EnableSsl(keystore = "/path/to/test/keystore.jks", keystorePassword = "p@55w0rd") + static class TestConfiguration { } + + @Configuration + @Import(TestConfiguration.class) + @EnableSsl(keystore = "/spoofed/path/to/keystore.jks", keystorePassword = "h@cK3r") + @Profile("incorrect-test-configuration") + static class IncorrectTestConfiguration { } + + public static final class DisableBeanDefinitionOverridingApplicationContextInitializer + implements ApplicationContextInitializer { + + /** + * @inheritDoc + */ + @Override + public void initialize(ConfigurableApplicationContext applicationContext) { + + Optional.ofNullable(applicationContext) + .map(ConfigurableApplicationContext::getBeanFactory) + .filter(DefaultListableBeanFactory.class::isInstance) + .map(DefaultListableBeanFactory.class::cast) + .ifPresent(beanFactory -> beanFactory.setAllowBeanDefinitionOverriding(false)); + } + } +}