Browse Source
This commit adds new annotation `@DataLdapTest` which provides test infrastructure for LDAP. By default, embedded ldap server is initialized if available. See gh-8536pull/8592/merge
13 changed files with 605 additions and 0 deletions
@ -0,0 +1,44 @@
@@ -0,0 +1,44 @@
|
||||
/* |
||||
* Copyright 2012-2017 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.boot.test.autoconfigure.data.ldap; |
||||
|
||||
import java.lang.annotation.Documented; |
||||
import java.lang.annotation.ElementType; |
||||
import java.lang.annotation.Inherited; |
||||
import java.lang.annotation.Retention; |
||||
import java.lang.annotation.RetentionPolicy; |
||||
import java.lang.annotation.Target; |
||||
|
||||
import org.springframework.boot.autoconfigure.ImportAutoConfiguration; |
||||
|
||||
/** |
||||
* {@link ImportAutoConfiguration Auto-configuration imports} for typical Data LDAP |
||||
* tests. Most tests should consider using {@link DataLdapTest @DataLdapTest} rather |
||||
* than using this annotation directly. |
||||
* |
||||
* @author Eddú Meléndez |
||||
* @since 2.0.0 |
||||
* @see DataLdapTest |
||||
*/ |
||||
@Target(ElementType.TYPE) |
||||
@Retention(RetentionPolicy.RUNTIME) |
||||
@Documented |
||||
@Inherited |
||||
@ImportAutoConfiguration |
||||
public @interface AutoConfigureDataLdap { |
||||
|
||||
} |
||||
@ -0,0 +1,93 @@
@@ -0,0 +1,93 @@
|
||||
/* |
||||
* Copyright 2012-2017 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.boot.test.autoconfigure.data.ldap; |
||||
|
||||
import java.lang.annotation.Documented; |
||||
import java.lang.annotation.ElementType; |
||||
import java.lang.annotation.Inherited; |
||||
import java.lang.annotation.Retention; |
||||
import java.lang.annotation.RetentionPolicy; |
||||
import java.lang.annotation.Target; |
||||
|
||||
import org.springframework.boot.autoconfigure.ImportAutoConfiguration; |
||||
import org.springframework.boot.autoconfigure.SpringBootApplication; |
||||
import org.springframework.boot.test.autoconfigure.OverrideAutoConfiguration; |
||||
import org.springframework.boot.test.autoconfigure.core.AutoConfigureCache; |
||||
import org.springframework.boot.test.autoconfigure.filter.TypeExcludeFilters; |
||||
import org.springframework.boot.test.context.SpringBootTestContextBootstrapper; |
||||
import org.springframework.context.annotation.ComponentScan.Filter; |
||||
import org.springframework.core.annotation.AliasFor; |
||||
import org.springframework.test.context.BootstrapWith; |
||||
|
||||
/** |
||||
* Annotation that can be used in combination with {@code @RunWith(SpringRunner.class)} |
||||
* for a typical LDAP test. Can be used when a test focuses <strong>only</strong> on |
||||
* LDAP components. |
||||
* <p> |
||||
* Using this annotation will disable full auto-configuration and instead apply only |
||||
* configuration relevant to LDAP tests. |
||||
* <p> |
||||
* By default, tests annotated with {@code @DataLdapTest} will use an embedded in-memory |
||||
* LDAP process (if available). |
||||
* |
||||
* @author Eddú Meléndez |
||||
* @since 2.0.0 |
||||
*/ |
||||
@Target(ElementType.TYPE) |
||||
@Retention(RetentionPolicy.RUNTIME) |
||||
@Documented |
||||
@Inherited |
||||
@BootstrapWith(SpringBootTestContextBootstrapper.class) |
||||
@OverrideAutoConfiguration(enabled = false) |
||||
@TypeExcludeFilters(DataLdapTypeExcludeFilter.class) |
||||
@AutoConfigureCache |
||||
@AutoConfigureDataLdap |
||||
@ImportAutoConfiguration |
||||
public @interface DataLdapTest { |
||||
|
||||
/** |
||||
* Determines if default filtering should be used with |
||||
* {@link SpringBootApplication @SpringBootApplication}. By default no beans are |
||||
* included. |
||||
* @see #includeFilters() |
||||
* @see #excludeFilters() |
||||
* @return if default filters should be used |
||||
*/ |
||||
boolean useDefaultFilters() default true; |
||||
|
||||
/** |
||||
* A set of include filters which can be used to add otherwise filtered beans to the |
||||
* application context. |
||||
* @return include filters to apply |
||||
*/ |
||||
Filter[] includeFilters() default {}; |
||||
|
||||
/** |
||||
* A set of exclude filters which can be used to filter beans that would otherwise be |
||||
* added to the application context. |
||||
* @return exclude filters to apply |
||||
*/ |
||||
Filter[] excludeFilters() default {}; |
||||
|
||||
/** |
||||
* Auto-configuration exclusions that should be applied for this test. |
||||
* @return auto-configuration exclusions to apply |
||||
*/ |
||||
@AliasFor(annotation = ImportAutoConfiguration.class, attribute = "exclude") |
||||
Class<?>[] excludeAutoConfiguration() default {}; |
||||
|
||||
} |
||||
@ -0,0 +1,73 @@
@@ -0,0 +1,73 @@
|
||||
/* |
||||
* Copyright 2012-2017 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.boot.test.autoconfigure.data.ldap; |
||||
|
||||
import java.util.Collections; |
||||
import java.util.Set; |
||||
|
||||
import org.springframework.boot.context.TypeExcludeFilter; |
||||
import org.springframework.boot.test.autoconfigure.filter.AnnotationCustomizableTypeExcludeFilter; |
||||
import org.springframework.context.annotation.ComponentScan.Filter; |
||||
import org.springframework.core.annotation.AnnotatedElementUtils; |
||||
|
||||
/** |
||||
* {@link TypeExcludeFilter} for {@link DataLdapTest @DataLdapTest}. |
||||
* |
||||
* @author Eddú Meléndez |
||||
*/ |
||||
class DataLdapTypeExcludeFilter extends AnnotationCustomizableTypeExcludeFilter { |
||||
|
||||
private final DataLdapTest annotation; |
||||
|
||||
DataLdapTypeExcludeFilter(Class<?> testClass) { |
||||
this.annotation = AnnotatedElementUtils.getMergedAnnotation(testClass, |
||||
DataLdapTest.class); |
||||
} |
||||
|
||||
@Override |
||||
protected boolean hasAnnotation() { |
||||
return this.annotation != null; |
||||
} |
||||
|
||||
@Override |
||||
protected Filter[] getFilters(FilterType type) { |
||||
switch (type) { |
||||
case INCLUDE: |
||||
return this.annotation.includeFilters(); |
||||
case EXCLUDE: |
||||
return this.annotation.excludeFilters(); |
||||
default: |
||||
throw new IllegalStateException("Unsupported type " + type); |
||||
} |
||||
} |
||||
|
||||
@Override |
||||
protected boolean isUseDefaultFilters() { |
||||
return this.annotation.useDefaultFilters(); |
||||
} |
||||
|
||||
@Override |
||||
protected Set<Class<?>> getDefaultIncludes() { |
||||
return Collections.emptySet(); |
||||
} |
||||
|
||||
@Override |
||||
protected Set<Class<?>> getComponentIncludes() { |
||||
return Collections.emptySet(); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,75 @@
@@ -0,0 +1,75 @@
|
||||
/* |
||||
* Copyright 2012-2017 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.boot.test.autoconfigure.data.ldap; |
||||
|
||||
import org.junit.Rule; |
||||
import org.junit.Test; |
||||
import org.junit.rules.ExpectedException; |
||||
import org.junit.runner.RunWith; |
||||
|
||||
import org.springframework.beans.factory.NoSuchBeanDefinitionException; |
||||
import org.springframework.beans.factory.annotation.Autowired; |
||||
import org.springframework.context.ApplicationContext; |
||||
import org.springframework.ldap.core.LdapTemplate; |
||||
import org.springframework.ldap.query.LdapQuery; |
||||
import org.springframework.ldap.query.LdapQueryBuilder; |
||||
import org.springframework.ldap.support.LdapUtils; |
||||
import org.springframework.test.context.TestPropertySource; |
||||
import org.springframework.test.context.junit4.SpringRunner; |
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat; |
||||
|
||||
/** |
||||
* Sample test for {@link DataLdapTest @DataLdapTest} |
||||
* |
||||
* @author Eddú Meléndez |
||||
*/ |
||||
@RunWith(SpringRunner.class) |
||||
@DataLdapTest |
||||
@TestPropertySource(properties = {"spring.ldap.embedded.base-dn=dc=spring,dc=org", |
||||
"spring.ldap.embedded.ldif=classpath:org/springframework/boot/test/autoconfigure/data/ldap/schema.ldif"}) |
||||
public class DataLdapTestIntegrationTests { |
||||
|
||||
@Rule |
||||
public ExpectedException thrown = ExpectedException.none(); |
||||
|
||||
@Autowired |
||||
private LdapTemplate ldapTemplate; |
||||
|
||||
@Autowired |
||||
private ExampleRepository exampleRepository; |
||||
|
||||
@Autowired |
||||
private ApplicationContext applicationContext; |
||||
|
||||
@Test |
||||
public void testRepository() { |
||||
LdapQuery ldapQuery = LdapQueryBuilder.query().where("cn").is("Bob Smith"); |
||||
ExampleEntry entry = this.exampleRepository.findOne(ldapQuery); |
||||
assertThat(entry.getDn()) |
||||
.isEqualTo(LdapUtils.newLdapName("cn=Bob Smith,ou=company1,c=Sweden,dc=spring,dc=org")); |
||||
assertThat(this.ldapTemplate.findOne(ldapQuery, ExampleEntry.class).getDn()) |
||||
.isEqualTo(LdapUtils.newLdapName("cn=Bob Smith,ou=company1,c=Sweden,dc=spring,dc=org")); |
||||
} |
||||
|
||||
@Test |
||||
public void didNotInjectExampleService() { |
||||
this.thrown.expect(NoSuchBeanDefinitionException.class); |
||||
this.applicationContext.getBean(ExampleService.class); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,52 @@
@@ -0,0 +1,52 @@
|
||||
/* |
||||
* Copyright 2012-2017 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.boot.test.autoconfigure.data.ldap; |
||||
|
||||
import org.junit.Test; |
||||
import org.junit.runner.RunWith; |
||||
|
||||
import org.springframework.beans.factory.annotation.Autowired; |
||||
import org.springframework.context.annotation.ComponentScan.Filter; |
||||
import org.springframework.ldap.query.LdapQuery; |
||||
import org.springframework.ldap.query.LdapQueryBuilder; |
||||
import org.springframework.stereotype.Service; |
||||
import org.springframework.test.context.TestPropertySource; |
||||
import org.springframework.test.context.junit4.SpringRunner; |
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat; |
||||
|
||||
/** |
||||
* Integration test with custom include filter for {@link DataLdapTest}. |
||||
* |
||||
* @author Eddú Meléndez |
||||
*/ |
||||
@RunWith(SpringRunner.class) |
||||
@DataLdapTest(includeFilters = @Filter(Service.class)) |
||||
@TestPropertySource(properties = {"spring.ldap.embedded.base-dn=dc=spring,dc=org", |
||||
"spring.ldap.embedded.ldif=classpath:org/springframework/boot/test/autoconfigure/data/ldap/schema.ldif"}) |
||||
public class DataLdapTestWithIncludeFilterIntegrationTests { |
||||
|
||||
@Autowired |
||||
private ExampleService service; |
||||
|
||||
@Test |
||||
public void testService() { |
||||
LdapQuery ldapQuery = LdapQueryBuilder.query().where("cn").is("Will Smith"); |
||||
assertThat(this.service.hasEntry(ldapQuery)).isFalse(); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,42 @@
@@ -0,0 +1,42 @@
|
||||
/* |
||||
* Copyright 2012-2017 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.boot.test.autoconfigure.data.ldap; |
||||
|
||||
import javax.naming.Name; |
||||
|
||||
import org.springframework.ldap.odm.annotations.Entry; |
||||
import org.springframework.ldap.odm.annotations.Id; |
||||
|
||||
/** |
||||
* Example entrey used with {@link DataLdapTest} tests. |
||||
* |
||||
* @author Eddú Meléndez |
||||
*/ |
||||
@Entry(objectClasses = { "person", "top" }) |
||||
public class ExampleEntry { |
||||
|
||||
@Id |
||||
private Name dn; |
||||
|
||||
public Name getDn() { |
||||
return this.dn; |
||||
} |
||||
|
||||
public void setDn(Name dn) { |
||||
this.dn = dn; |
||||
} |
||||
} |
||||
@ -0,0 +1,29 @@
@@ -0,0 +1,29 @@
|
||||
/* |
||||
* Copyright 2012-2017 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.boot.test.autoconfigure.data.ldap; |
||||
|
||||
import org.springframework.boot.autoconfigure.SpringBootApplication; |
||||
|
||||
/** |
||||
* Example {@link SpringBootApplication} used with {@link DataLdapTest} tests. |
||||
* |
||||
* @author Eddú Meléndez |
||||
*/ |
||||
@SpringBootApplication |
||||
public class ExampleLdapApplication { |
||||
|
||||
} |
||||
@ -0,0 +1,28 @@
@@ -0,0 +1,28 @@
|
||||
/* |
||||
* Copyright 2012-2017 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.boot.test.autoconfigure.data.ldap; |
||||
|
||||
import org.springframework.data.ldap.repository.LdapRepository; |
||||
|
||||
/** |
||||
* Example repository used with {@link DataLdapTest} tests. |
||||
* |
||||
* @author Eddú Meléndez |
||||
*/ |
||||
public interface ExampleRepository extends LdapRepository<ExampleEntry> { |
||||
|
||||
} |
||||
@ -0,0 +1,41 @@
@@ -0,0 +1,41 @@
|
||||
/* |
||||
* Copyright 2012-2017 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.boot.test.autoconfigure.data.ldap; |
||||
|
||||
import org.springframework.ldap.core.LdapTemplate; |
||||
import org.springframework.ldap.query.LdapQuery; |
||||
import org.springframework.stereotype.Service; |
||||
|
||||
/** |
||||
* Example service used with {@link DataLdapTest} tests. |
||||
* |
||||
* @author Eddú Meléndez |
||||
*/ |
||||
@Service |
||||
public class ExampleService { |
||||
|
||||
private final LdapTemplate ldapTemplate; |
||||
|
||||
public ExampleService(LdapTemplate ldapTemplate) { |
||||
this.ldapTemplate = ldapTemplate; |
||||
} |
||||
|
||||
public boolean hasEntry(LdapQuery query) { |
||||
return this.ldapTemplate.find(query, ExampleEntry.class).size() == 1; |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,62 @@
@@ -0,0 +1,62 @@
|
||||
dn: dc=spring,dc=org |
||||
objectclass: top |
||||
objectclass: domain |
||||
objectclass: extensibleObject |
||||
dc: spring |
||||
|
||||
dn: ou=groups,dc=spring,dc=org |
||||
objectclass: top |
||||
objectclass: organizationalUnit |
||||
ou: groups |
||||
|
||||
dn: cn=ROLE_USER,ou=groups,dc=spring,dc=org |
||||
objectclass: top |
||||
objectclass: groupOfUniqueNames |
||||
cn: ROLE_USER |
||||
uniqueMember: cn=Some Person,ou=company1,c=Sweden,dc=spring,dc=org |
||||
uniqueMember: cn=Some Person2,ou=company1,c=Sweden,dc=spring,dc=org |
||||
uniqueMember: cn=Some Person,ou=company1,c=Sweden,dc=spring,dc=org |
||||
uniqueMember: cn=Some Person3,ou=company1,c=Sweden,dc=spring,dc=org |
||||
|
||||
dn: cn=ROLE_ADMIN,ou=groups,dc=spring,dc=org |
||||
objectclass: top |
||||
objectclass: groupOfUniqueNames |
||||
cn: ROLE_ADMIN |
||||
uniqueMember: cn=Some Person2,ou=company1,c=Sweden,dc=spring,dc=org |
||||
|
||||
dn: c=Sweden,dc=spring,dc=org |
||||
objectclass: top |
||||
objectclass: country |
||||
c: Sweden |
||||
description: The country of Sweden |
||||
|
||||
dn: ou=company1,c=Sweden,dc=spring,dc=org |
||||
objectclass: top |
||||
objectclass: organizationalUnit |
||||
ou: company1 |
||||
description: First company in Sweden |
||||
|
||||
dn: cn=Alice Smith,ou=company1,c=Sweden,dc=spring,dc=org |
||||
objectclass: top |
||||
objectclass: person |
||||
objectclass: organizationalPerson |
||||
objectclass: inetOrgPerson |
||||
uid: alice.smith |
||||
userPassword: password |
||||
cn: Alice Smith |
||||
sn: Alice Smith |
||||
description: Sweden, Company1, Alice Smith |
||||
telephoneNumber: +46 555-123456 |
||||
|
||||
dn: cn=Bob Smith,ou=company1,c=Sweden,dc=spring,dc=org |
||||
objectclass: top |
||||
objectclass: person |
||||
objectclass: organizationalPerson |
||||
objectclass: inetOrgPerson |
||||
uid: bob.smith |
||||
userPassword: password |
||||
cn: Bob Smith |
||||
sn: Bob Smith |
||||
description: Sweden, Company1, Some Person2 |
||||
telephoneNumber: +46 555-654321 |
||||
|
||||
Loading…
Reference in new issue