Add Spring @Conditional annotation (SpringBootCondition) to enable/disable Spring bean configuration based on missing properties.

This commit is contained in:
John Blum
2018-10-02 16:10:16 -07:00
parent 80995ef3fc
commit 7199f3c3a1
3 changed files with 355 additions and 0 deletions

View File

@@ -0,0 +1,113 @@
/*
* Copyright 2018 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.geode.boot.autoconfigure.condition;
import static org.assertj.core.api.Assertions.assertThat;
import java.util.Collections;
import java.util.function.Function;
import org.junit.Test;
import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.gemfire.tests.integration.SpringBootApplicationIntegrationTestsSupport;
/**
* The ConditionalOnMissingPropertyIntegrationTests class...
*
* @author John Blum
* @since 1.0.0
*/
@SuppressWarnings("unused")
public class ConditionalOnMissingPropertyIntegrationTests extends SpringBootApplicationIntegrationTestsSupport {
private Function<SpringApplicationBuilder, SpringApplicationBuilder> springApplicationBuilderFunction =
Function.identity();
private Function<SpringApplicationBuilder, SpringApplicationBuilder> allMatchingPropertiesFunction = builder -> {
builder.properties(Collections.singletonMap("example.app.config.propOne", ""));
builder.properties(Collections.singletonMap("example.app.config.propTwo", "test"));
return builder;
};
private Function<SpringApplicationBuilder, SpringApplicationBuilder> nonMatchingPropertyFunction = builder -> {
builder.properties(Collections.singletonMap("example.app.cfg.propertyOne", ""));
return builder;
};
private Function<SpringApplicationBuilder, SpringApplicationBuilder> singleMatchingPropertyFunction = builder -> {
builder.properties(Collections.singletonMap("example.app.config.propTwo", "test"));
return builder;
};
@Override
protected SpringApplicationBuilder processBeforeBuild(SpringApplicationBuilder springApplicationBuilder) {
return this.springApplicationBuilderFunction.apply(springApplicationBuilder);
}
private void assertBeanDefinitions(ApplicationContext applicationContext, boolean conditionalBeanExists) {
assertThat(applicationContext.containsBean("conditionalBean")).isEqualTo(conditionalBeanExists);
assertThat(applicationContext.containsBean("unconditionalBean")).isTrue();
}
@Test
public void allBeansExist() {
assertBeanDefinitions(newApplicationContext(TestConfiguration.class), true);
}
@Test
public void allBeansExistWithNonMatchingProperties() {
this.springApplicationBuilderFunction = this.nonMatchingPropertyFunction;
assertBeanDefinitions(newApplicationContext(TestConfiguration.class), true);
}
@Test
public void unconditionalBeanExistsWithAllMatchingProperties() {
this.springApplicationBuilderFunction = this.allMatchingPropertiesFunction;
assertBeanDefinitions(newApplicationContext(TestConfiguration.class), false);
}
@Test
public void unconditionalBeanExistsWithSingleMatchingProperty() {
this.springApplicationBuilderFunction = this.singleMatchingPropertyFunction;
assertBeanDefinitions(newApplicationContext(TestConfiguration.class), false);
}
@Configuration
static class TestConfiguration {
@Bean
@ConditionalOnMissingProperty(prefix = "example.app.config", name = { "propOne", "propTwo" })
Object conditionalBean() {
return "conditional";
}
@Bean
Object unconditionalBean() {
return "unconditional";
}
}
}