ConfigurationPropertiesBeanRegistrarTests Class — spring-boot Architecture

Source Code

core/spring-boot/src/test/java/org/springframework/boot/context/properties/ConfigurationPropertiesBeanRegistrarTests.java lines 45–190

class ConfigurationPropertiesBeanRegistrarTests {

	private final BeanDefinitionRegistry registry = new DefaultListableBeanFactory();

	private final ConfigurationPropertiesBeanRegistrar registrar = new ConfigurationPropertiesBeanRegistrar(
			this.registry);

	@Test
	void registerWhenNotAlreadyRegisteredAddBeanDefinition() {
		String beanName = "beancp-" + BeanConfigurationProperties.class.getName();
		this.registrar.register(BeanConfigurationProperties.class);
		BeanDefinition definition = this.registry.getBeanDefinition(beanName);
		assertThat(definition).isNotNull();
		assertThat(definition.getBeanClassName()).isEqualTo(BeanConfigurationProperties.class.getName());
	}

	@Test
	void registerWhenAlreadyContainsNameDoesNotReplace() {
		String beanName = "beancp-" + BeanConfigurationProperties.class.getName();
		this.registry.registerBeanDefinition(beanName, new RootBeanDefinition());
		this.registrar.register(BeanConfigurationProperties.class);
		BeanDefinition definition = this.registry.getBeanDefinition(beanName);
		assertThat(definition).isNotNull();
		assertThat(definition.getBeanClassName()).isNull();
	}

	@Test
	void registerWhenNoAnnotationThrowsException() {
		assertThatIllegalStateException()
			.isThrownBy(() -> this.registrar.register(NoAnnotationConfigurationProperties.class))
			.withMessageContaining("No ConfigurationProperties annotation found");
	}

	@Test
	void registerWhenValueObjectRegistersValueObjectBeanDefinition() {
		String beanName = "valuecp-" + ValueObjectConfigurationProperties.class.getName();
		this.registrar.register(ValueObjectConfigurationProperties.class);
		BeanDefinition definition = this.registry.getBeanDefinition(beanName);
		assertThat(definition).satisfies(hasBindMethodAttribute(BindMethod.VALUE_OBJECT));
	}

	@Test
	void registerWhenNotValueObjectRegistersRootBeanDefinitionWithJavaBeanBindMethod() {
		String beanName = MultiConstructorBeanConfigurationProperties.class.getName();
		this.registrar.register(MultiConstructorBeanConfigurationProperties.class);
		BeanDefinition definition = this.registry.getBeanDefinition(beanName);
		assertThat(definition).satisfies(hasBindMethodAttribute(BindMethod.JAVA_BEAN));
	}

	@Test
	void registerWhenNoScopeUsesSingleton() {
		String beanName = "beancp-" + BeanConfigurationProperties.class.getName();
		this.registrar.register(BeanConfigurationProperties.class);
		BeanDefinition definition = this.registry.getBeanDefinition(beanName);
		assertThat(definition).isNotNull();
		assertThat(definition.getScope()).isEqualTo(BeanDefinition.SCOPE_SINGLETON);
	}

	@Test
	void registerScopedBeanDefinition() {
		String beanName = "beancp-" + ScopedBeanConfigurationProperties.class.getName();
		this.registrar.register(ScopedBeanConfigurationProperties.class);
		BeanDefinition beanDefinition = this.registry.getBeanDefinition(beanName);
		assertThat(beanDefinition).isNotNull();
		assertThat(beanDefinition.getBeanClassName()).isEqualTo(ScopedBeanConfigurationProperties.class.getName());
		assertThat(beanDefinition.getScope()).isEqualTo(BeanDefinition.SCOPE_PROTOTYPE);
	}

	@Test
	void registerScopedBeanDefinitionWithProxyMode() {
		String beanName = "beancp-" + ProxyScopedBeanConfigurationProperties.class.getName();
		this.registrar.register(ProxyScopedBeanConfigurationProperties.class);
		BeanDefinition proxiedBeanDefinition = this.registry.getBeanDefinition(beanName);
		assertThat(proxiedBeanDefinition).isNotNull();
		assertThat(proxiedBeanDefinition.getBeanClassName()).isEqualTo(ScopedProxyFactoryBean.class.getName());
		String targetBeanName = (String) proxiedBeanDefinition.getPropertyValues().get("targetBeanName");
		assertThat(targetBeanName).isNotNull();
		BeanDefinition beanDefinition = this.registry.getBeanDefinition(targetBeanName);
		assertThat(beanDefinition).isNotNull();
		assertThat(beanDefinition.getBeanClassName()).isEqualTo(ProxyScopedBeanConfigurationProperties.class.getName());
		assertThat(beanDefinition.getScope()).isEqualTo(BeanDefinition.SCOPE_PROTOTYPE);
	}

	@Test
	void registerBeanDefinitionWithCommonDefinitionAnnotations() {
		String beanName = "beancp-" + PrimaryConfigurationProperties.class.getName();
		this.registrar.register(PrimaryConfigurationProperties.class);
		BeanDefinition beanDefinition = this.registry.getBeanDefinition(beanName);
		assertThat(beanDefinition).isNotNull();
		assertThat(beanDefinition.isPrimary()).isEqualTo(true);
	}

	private Consumer<BeanDefinition> hasBindMethodAttribute(BindMethod bindMethod) {
		return (definition) -> {
			assertThat(definition.hasAttribute(BindMethod.class.getName())).isTrue();
			assertThat(definition.getAttribute(BindMethod.class.getName())).isEqualTo(bindMethod);
		};
	}

	@ConfigurationProperties("beancp")
	static class BeanConfigurationProperties {

	}

	@ConfigurationProperties("beancp")
	@Scope(ConfigurableBeanFactory.SCOPE_PROTOTYPE)
	static class ScopedBeanConfigurationProperties {

	}

	@ConfigurationProperties("beancp")
	@Scope(scopeName = ConfigurableBeanFactory.SCOPE_PROTOTYPE, proxyMode = ScopedProxyMode.TARGET_CLASS)
	static class ProxyScopedBeanConfigurationProperties {

	}

	@ConfigurationProperties("beancp")
	@Primary
	static class PrimaryConfigurationProperties {

	}

	static class NoAnnotationConfigurationProperties {

	}

	@ConfigurationProperties("valuecp")
	static class ValueObjectConfigurationProperties {

		ValueObjectConfigurationProperties(String name) {
		}

	}

	@ConfigurationProperties
	static class MultiConstructorBeanConfigurationProperties {

		MultiConstructorBeanConfigurationProperties() {
		}

		MultiConstructorBeanConfigurationProperties(String name) {
		}

	}

}