From a92c57c07df7f956d6ca6baf4698dbd6b977c68b Mon Sep 17 00:00:00 2001 From: Frank Schmager Date: Tue, 18 Feb 2020 12:04:57 -0500 Subject: [PATCH 1/2] Allow Embedded directory to be used without spring-data-ldap See gh-20223 --- .../EmbeddedLdapAutoConfiguration.java | 46 +++++++++++-------- .../ldap/embedded/EmbeddedLdapProperties.java | 6 ++- .../EmbeddedLdapAutoConfigurationTests.java | 41 ++++++++++++++++- 3 files changed, 72 insertions(+), 21 deletions(-) diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/ldap/embedded/EmbeddedLdapAutoConfiguration.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/ldap/embedded/EmbeddedLdapAutoConfiguration.java index 18634cae039..ea6f1672dab 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/ldap/embedded/EmbeddedLdapAutoConfiguration.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/ldap/embedded/EmbeddedLdapAutoConfiguration.java @@ -41,7 +41,6 @@ import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean import org.springframework.boot.autoconfigure.condition.SpringBootCondition; import org.springframework.boot.autoconfigure.ldap.LdapAutoConfiguration; import org.springframework.boot.autoconfigure.ldap.LdapProperties; -import org.springframework.boot.autoconfigure.ldap.embedded.EmbeddedLdapProperties.Credential; import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.boot.context.properties.bind.Bindable; import org.springframework.boot.context.properties.bind.Binder; @@ -58,6 +57,7 @@ import org.springframework.core.env.MutablePropertySources; import org.springframework.core.env.PropertySource; import org.springframework.core.io.Resource; import org.springframework.core.type.AnnotatedTypeMetadata; +import org.springframework.ldap.core.ContextSource; import org.springframework.ldap.core.support.LdapContextSource; import org.springframework.util.StringUtils; @@ -76,6 +76,8 @@ import org.springframework.util.StringUtils; @Conditional(EmbeddedLdapAutoConfiguration.EmbeddedLdapCondition.class) public class EmbeddedLdapAutoConfiguration { + private static final String DIRECTORY_SERVER_BEAN_NAME = "directoryServer"; + private static final String PROPERTY_SOURCE_NAME = "ldap.ports"; private final EmbeddedLdapProperties embeddedProperties; @@ -86,24 +88,11 @@ public class EmbeddedLdapAutoConfiguration { this.embeddedProperties = embeddedProperties; } - @Bean - @DependsOn("directoryServer") - @ConditionalOnMissingBean - public LdapContextSource ldapContextSource(Environment environment, LdapProperties properties) { - LdapContextSource source = new LdapContextSource(); - if (hasCredentials(this.embeddedProperties.getCredential())) { - source.setUserDn(this.embeddedProperties.getCredential().getUsername()); - source.setPassword(this.embeddedProperties.getCredential().getPassword()); - } - source.setUrls(properties.determineUrls(environment)); - return source; - } - - @Bean + @Bean(name = DIRECTORY_SERVER_BEAN_NAME) public InMemoryDirectoryServer directoryServer(ApplicationContext applicationContext) throws LDAPException { String[] baseDn = StringUtils.toStringArray(this.embeddedProperties.getBaseDn()); InMemoryDirectoryServerConfig config = new InMemoryDirectoryServerConfig(baseDn); - if (hasCredentials(this.embeddedProperties.getCredential())) { + if (this.embeddedProperties.hasCredential()) { config.addAdditionalBindCredentials(this.embeddedProperties.getCredential().getUsername(), this.embeddedProperties.getCredential().getPassword()); } @@ -140,9 +129,7 @@ public class EmbeddedLdapAutoConfiguration { } } - private boolean hasCredentials(Credential credential) { - return StringUtils.hasText(credential.getUsername()) && StringUtils.hasText(credential.getPassword()); - } + private void importLdif(ApplicationContext applicationContext) throws LDAPException { String location = this.embeddedProperties.getLdif(); @@ -210,4 +197,25 @@ public class EmbeddedLdapAutoConfiguration { } + /** + * Creates an {@link LdapContextSource} for use with Embedded LDAP. + */ + @Configuration + @ConditionalOnClass(ContextSource.class) + static class EmbeddedLdapContextConfiguration { + + @Bean + @DependsOn(DIRECTORY_SERVER_BEAN_NAME) + @ConditionalOnMissingBean + public LdapContextSource ldapContextSource(Environment environment, LdapProperties properties, EmbeddedLdapProperties embeddedProperties) { + LdapContextSource source = new LdapContextSource(); + if (embeddedProperties.hasCredential()) { + source.setUserDn(embeddedProperties.getCredential().getUsername()); + source.setPassword(embeddedProperties.getCredential().getPassword()); + } + source.setUrls(properties.determineUrls(environment)); + return source; + } + } + } diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/ldap/embedded/EmbeddedLdapProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/ldap/embedded/EmbeddedLdapProperties.java index fe4b8dfca60..2b7ce93c3c5 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/ldap/embedded/EmbeddedLdapProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/ldap/embedded/EmbeddedLdapProperties.java @@ -18,10 +18,10 @@ package org.springframework.boot.autoconfigure.ldap.embedded; import java.util.ArrayList; import java.util.List; - import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.boot.convert.Delimiter; import org.springframework.core.io.Resource; +import org.springframework.util.StringUtils; /** * Configuration properties for Embedded LDAP. @@ -75,6 +75,10 @@ public class EmbeddedLdapProperties { this.credential = credential; } + public boolean hasCredential() { + return credential != null && StringUtils.hasText(credential.getUsername()) && StringUtils.hasText(credential.getPassword()); + } + public List getBaseDn() { return this.baseDn; } diff --git a/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/ldap/embedded/EmbeddedLdapAutoConfigurationTests.java b/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/ldap/embedded/EmbeddedLdapAutoConfigurationTests.java index 77604b248aa..b7e56cd29ea 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/ldap/embedded/EmbeddedLdapAutoConfigurationTests.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/ldap/embedded/EmbeddedLdapAutoConfigurationTests.java @@ -22,19 +22,23 @@ import com.unboundid.ldap.sdk.DN; import com.unboundid.ldap.sdk.LDAPConnection; import com.unboundid.ldap.sdk.LDAPException; import org.junit.jupiter.api.Test; - +import org.springframework.beans.factory.NoSuchBeanDefinitionException; import org.springframework.beans.factory.annotation.Value; import org.springframework.boot.autoconfigure.AutoConfigurations; import org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration; import org.springframework.boot.autoconfigure.ldap.LdapAutoConfiguration; +import org.springframework.boot.test.context.FilteredClassLoader; import org.springframework.boot.test.context.runner.ApplicationContextRunner; import org.springframework.boot.test.util.TestPropertyValues; import org.springframework.context.annotation.AnnotationConfigApplicationContext; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; +import org.springframework.ldap.core.ContextSource; import org.springframework.ldap.core.LdapTemplate; +import org.springframework.ldap.core.support.LdapContextSource; import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatThrownBy; /** * Tests for {@link EmbeddedLdapAutoConfiguration} @@ -146,6 +150,41 @@ class EmbeddedLdapAutoConfigurationTests { }); } + @Test + void testLdapContextSourceWithCredentials() { + this.contextRunner.withPropertyValues("spring.ldap.embedded.base-dn:dc=spring,dc=org", + "spring.ldap.embedded.credential.username:uid=root", "spring.ldap.embedded.credential.password:boot") + .run(context -> { + LdapContextSource ldapContextSource = context.getBean(LdapContextSource.class); + assertThat(ldapContextSource.getUserDn()).isEqualTo("uid=root"); + assertThat(ldapContextSource.getUrls()).isNotEmpty(); + }); + } + + @Test + void testLdapContextSourceWithoutCredentials() { + this.contextRunner.withPropertyValues("spring.ldap.embedded.base-dn:dc=spring,dc=org") + .run(context -> { + LdapContextSource ldapContextSource = context.getBean(LdapContextSource.class); + assertThat(ldapContextSource.getUserDn()).isEmpty(); + assertThat(ldapContextSource.getUrls()).isNotEmpty(); + }); + } + + @Test + void testNoLdapContextSourceWithoutContextSourceClass() { + this.contextRunner + .withPropertyValues("spring.ldap.embedded.base-dn:dc=spring,dc=org") + .withClassLoader(new FilteredClassLoader(ContextSource.class)) + .run(context -> { + NoSuchBeanDefinitionException expectedException = + new NoSuchBeanDefinitionException(LdapContextSource.class); + assertThatThrownBy(()-> context.getBean(LdapContextSource.class)) + .isInstanceOf(expectedException.getClass()) + .hasMessage(expectedException.getMessage()); + }); + } + @Configuration(proxyBeanMethods = false) static class LdapClientConfiguration { From aa4dad1d739f6abae997e1e312add1f079dae5cc Mon Sep 17 00:00:00 2001 From: Stephane Nicoll Date: Wed, 4 Mar 2020 14:46:04 +0100 Subject: [PATCH 2/2] Polish "Allow Embedded directory to be used without spring-data-ldap" See gh-20223 --- .../EmbeddedLdapAutoConfiguration.java | 27 +++++------ .../ldap/embedded/EmbeddedLdapProperties.java | 11 ++--- .../EmbeddedLdapAutoConfigurationTests.java | 45 ++++++++----------- 3 files changed, 36 insertions(+), 47 deletions(-) diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/ldap/embedded/EmbeddedLdapAutoConfiguration.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/ldap/embedded/EmbeddedLdapAutoConfiguration.java index ea6f1672dab..8abb907c1e6 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/ldap/embedded/EmbeddedLdapAutoConfiguration.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/ldap/embedded/EmbeddedLdapAutoConfiguration.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2019 the original author or authors. + * Copyright 2012-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. @@ -76,8 +76,6 @@ import org.springframework.util.StringUtils; @Conditional(EmbeddedLdapAutoConfiguration.EmbeddedLdapCondition.class) public class EmbeddedLdapAutoConfiguration { - private static final String DIRECTORY_SERVER_BEAN_NAME = "directoryServer"; - private static final String PROPERTY_SOURCE_NAME = "ldap.ports"; private final EmbeddedLdapProperties embeddedProperties; @@ -88,11 +86,11 @@ public class EmbeddedLdapAutoConfiguration { this.embeddedProperties = embeddedProperties; } - @Bean(name = DIRECTORY_SERVER_BEAN_NAME) + @Bean public InMemoryDirectoryServer directoryServer(ApplicationContext applicationContext) throws LDAPException { String[] baseDn = StringUtils.toStringArray(this.embeddedProperties.getBaseDn()); InMemoryDirectoryServerConfig config = new InMemoryDirectoryServerConfig(baseDn); - if (this.embeddedProperties.hasCredential()) { + if (this.embeddedProperties.getCredential().isAvailable()) { config.addAdditionalBindCredentials(this.embeddedProperties.getCredential().getUsername(), this.embeddedProperties.getCredential().getPassword()); } @@ -129,8 +127,6 @@ public class EmbeddedLdapAutoConfiguration { } } - - private void importLdif(ApplicationContext applicationContext) throws LDAPException { String location = this.embeddedProperties.getLdif(); if (StringUtils.hasText(location)) { @@ -197,25 +193,24 @@ public class EmbeddedLdapAutoConfiguration { } - /** - * Creates an {@link LdapContextSource} for use with Embedded LDAP. - */ - @Configuration + @Configuration(proxyBeanMethods = false) @ConditionalOnClass(ContextSource.class) static class EmbeddedLdapContextConfiguration { - + @Bean - @DependsOn(DIRECTORY_SERVER_BEAN_NAME) + @DependsOn("directoryServer") @ConditionalOnMissingBean - public LdapContextSource ldapContextSource(Environment environment, LdapProperties properties, EmbeddedLdapProperties embeddedProperties) { + LdapContextSource ldapContextSource(Environment environment, LdapProperties properties, + EmbeddedLdapProperties embeddedProperties) { LdapContextSource source = new LdapContextSource(); - if (embeddedProperties.hasCredential()) { + if (embeddedProperties.getCredential().isAvailable()) { source.setUserDn(embeddedProperties.getCredential().getUsername()); source.setPassword(embeddedProperties.getCredential().getPassword()); } source.setUrls(properties.determineUrls(environment)); return source; } + } - + } diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/ldap/embedded/EmbeddedLdapProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/ldap/embedded/EmbeddedLdapProperties.java index 2b7ce93c3c5..ef563541a64 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/ldap/embedded/EmbeddedLdapProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/ldap/embedded/EmbeddedLdapProperties.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2019 the original author or authors. + * Copyright 2012-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. @@ -18,6 +18,7 @@ package org.springframework.boot.autoconfigure.ldap.embedded; import java.util.ArrayList; import java.util.List; + import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.boot.convert.Delimiter; import org.springframework.core.io.Resource; @@ -75,10 +76,6 @@ public class EmbeddedLdapProperties { this.credential = credential; } - public boolean hasCredential() { - return credential != null && StringUtils.hasText(credential.getUsername()) && StringUtils.hasText(credential.getPassword()); - } - public List getBaseDn() { return this.baseDn; } @@ -127,6 +124,10 @@ public class EmbeddedLdapProperties { this.password = password; } + boolean isAvailable() { + return StringUtils.hasText(this.username) && StringUtils.hasText(this.password); + } + } public static class Validation { diff --git a/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/ldap/embedded/EmbeddedLdapAutoConfigurationTests.java b/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/ldap/embedded/EmbeddedLdapAutoConfigurationTests.java index b7e56cd29ea..43ecc944357 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/ldap/embedded/EmbeddedLdapAutoConfigurationTests.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/ldap/embedded/EmbeddedLdapAutoConfigurationTests.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2019 the original author or authors. + * Copyright 2012-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. @@ -22,7 +22,7 @@ import com.unboundid.ldap.sdk.DN; import com.unboundid.ldap.sdk.LDAPConnection; import com.unboundid.ldap.sdk.LDAPException; import org.junit.jupiter.api.Test; -import org.springframework.beans.factory.NoSuchBeanDefinitionException; + import org.springframework.beans.factory.annotation.Value; import org.springframework.boot.autoconfigure.AutoConfigurations; import org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration; @@ -38,7 +38,6 @@ import org.springframework.ldap.core.LdapTemplate; import org.springframework.ldap.core.support.LdapContextSource; import static org.assertj.core.api.Assertions.assertThat; -import static org.assertj.core.api.Assertions.assertThatThrownBy; /** * Tests for {@link EmbeddedLdapAutoConfiguration} @@ -47,7 +46,7 @@ import static org.assertj.core.api.Assertions.assertThatThrownBy; */ class EmbeddedLdapAutoConfigurationTests { - private ApplicationContextRunner contextRunner = new ApplicationContextRunner() + private final ApplicationContextRunner contextRunner = new ApplicationContextRunner() .withConfiguration(AutoConfigurations.of(EmbeddedLdapAutoConfiguration.class)); @Test @@ -151,38 +150,32 @@ class EmbeddedLdapAutoConfigurationTests { } @Test - void testLdapContextSourceWithCredentials() { - this.contextRunner.withPropertyValues("spring.ldap.embedded.base-dn:dc=spring,dc=org", + void ldapContextSourceWithCredentialsIsCreated() { + this.contextRunner.withPropertyValues("spring.ldap.embedded.base-dn:dc=spring,dc=org", "spring.ldap.embedded.credential.username:uid=root", "spring.ldap.embedded.credential.password:boot") - .run(context -> { - LdapContextSource ldapContextSource = context.getBean(LdapContextSource.class); - assertThat(ldapContextSource.getUserDn()).isEqualTo("uid=root"); - assertThat(ldapContextSource.getUrls()).isNotEmpty(); - }); + .run(context -> { + LdapContextSource ldapContextSource = context.getBean(LdapContextSource.class); + assertThat(ldapContextSource.getUrls()).isNotEmpty(); + assertThat(ldapContextSource.getUserDn()).isEqualTo("uid=root"); + }); } @Test - void testLdapContextSourceWithoutCredentials() { - this.contextRunner.withPropertyValues("spring.ldap.embedded.base-dn:dc=spring,dc=org") - .run(context -> { + void ldapContextSourceWithoutCredentialsIsCreated() { + this.contextRunner.withPropertyValues("spring.ldap.embedded.base-dn:dc=spring,dc=org").run(context -> { LdapContextSource ldapContextSource = context.getBean(LdapContextSource.class); - assertThat(ldapContextSource.getUserDn()).isEmpty(); assertThat(ldapContextSource.getUrls()).isNotEmpty(); + assertThat(ldapContextSource.getUserDn()).isEmpty(); }); } @Test - void testNoLdapContextSourceWithoutContextSourceClass() { - this.contextRunner - .withPropertyValues("spring.ldap.embedded.base-dn:dc=spring,dc=org") - .withClassLoader(new FilteredClassLoader(ContextSource.class)) - .run(context -> { - NoSuchBeanDefinitionException expectedException = - new NoSuchBeanDefinitionException(LdapContextSource.class); - assertThatThrownBy(()-> context.getBean(LdapContextSource.class)) - .isInstanceOf(expectedException.getClass()) - .hasMessage(expectedException.getMessage()); - }); + void ldapContextWithoutSpringLdapIsNotCreated() { + this.contextRunner.withPropertyValues("spring.ldap.embedded.base-dn:dc=spring,dc=org") + .withClassLoader(new FilteredClassLoader(ContextSource.class)).run(context -> { + assertThat(context).hasNotFailed(); + assertThat(context).doesNotHaveBean(LdapContextSource.class); + }); } @Configuration(proxyBeanMethods = false)