Unit testing Spring-LDAP code with ApacheDS

The Spring LDAP framework is a great library to assist in working with LDAP servers through a more manageable API. It provides the niceties that the DataSource interface does for JDBC along with support similar to the Spring JDBC framework. One area that has been lacking though is testing. With JDBC based code it is easy enough to use HSQLDB to provide an in-memory database to test against. With LDAP based code there hasn't been a good solution, until the Apache Directory project came along.

Apache Directory is a 100% Java LDAP implementation and includes support for in-memory LDAP instances for unit testing. Using this support plus a few helper classes to bridge the gap to Spring LDAP providing unit tests for LDAP related code is easy.

First add the necessary dependencies. If you are using Maven your project needs to depend on the following for testing:
<br /><dependency><br /> <groupid>junit</groupid><br /> <artifactid>junit</artifactid><br /> <version>4.4</version><br /></dependency><br /><dependency><br /> <groupid>org.apache.directory.server</groupid><br /> <artifactid>apacheds-core</artifactid><br /> <version>1.0.2</version><br /></dependency><br /><dependency><br /> <groupid>org.apache.directory.server</groupid><br /> <artifactid>apacheds-server-jndi</artifactid><br /> <version>1.0.2</version><br /></dependency> <br /><dependency><br /> <groupid>org.apache.directory.server</groupid><br /> <artifactid>apacheds-server-unit</artifactid><br /> <version>1.0.2</version><br /></dependency><br /><dependency><br /> <groupid>org.slf4j</groupid><br /> <artifactid>slf4j-log4j12</artifactid><br /> <version>1.5.2</version><br /></dependency><br /><dependency><br /> <groupid>org.springframework</groupid><br /> <artifactid>spring-core</artifactid><br /> <version>2.5.5</version><br /></dependency><br /><dependency><br /> <groupid>org.springframework.ldap</groupid><br /> <artifactid>spring-ldap</artifactid><br /> <version>1.2.1</version><br /></dependency><br />

Second, add AbstractDirContextTest.java and SingleContextSource.java to your project.

Finally extend AbstractDirContextTest for your LDAP code test class.
<br />package org.jasig.services.persondir.support.ldap;<br /><br />import java.util.Collections;<br />import java.util.HashMap;<br />import java.util.List;<br />import java.util.Map;<br /><br />import org.jasig.services.persondir.util.Util;<br />import org.springframework.core.io.ClassPathResource;<br />import org.springframework.core.io.Resource;<br />import org.springframework.ldap.test.AbstractDirContextTest;<br /><br />public class LdapPersonAttributeDaoTest extends AbstractDirContextTest {<br /> @Override<br /> protected String getPartitionName() {<br /> return "personDirectory";<br /> }<br /><br /> @Override<br /> protected Resource[] initializationData() {<br /> final ClassPathResource ldapPersonInfo = new ClassPathResource("/ldapPersonInfo.ldif");<br /> return new Resource[] { ldapPersonInfo };<br /> }<br /> <br /> public void testSingleAttrQuery() throws Exception {<br /> LdapPersonAttributeDao impl = new LdapPersonAttributeDao();<br /> <br /> Map<String, Object> ldapAttribsToPortalAttribs = new HashMap<String, Object>();<br /> ldapAttribsToPortalAttribs.put("mail", "email");<br /> impl.setResultAttributeMapping(ldapAttribsToPortalAttribs);<br /> impl.setContextSource(this.getContextSource());<br /> impl.setQueryAttributeMapping(Collections.singletonMap("uid", null));<br /> impl.afterPropertiesSet();<br /> <br /> Map<String, List<Object>> queryMap = new HashMap<String, List<Object>>();<br /> queryMap.put("uid", Util.list("edalquist"));<br /><br /> Map<String, List<Object>> attribs = impl.getMultivaluedUserAttributes(queryMap);<br /><br /> assertEquals(Util.list("eric.dalquist@example.com"), attribs.get("email"));<br /> }<br />}<br />

Your test class needs to provide a partition name, which is the root of the DN for the server to test against, and a Resource array of ldiff files to load into the LDAP server. For the test above the ldiff file looke like:
<br />dn: ou=people,o=personDirectory<br />objectClass: organizationalUnit<br />objectClass: top<br />ou: people<br />description: Contains entries which describe people<br /><br />dn: cn=Eric Dalquist,ou=people,o=personDirectory<br />objectclass: person<br />objectclass: organizationalPerson<br />objectclass: inetOrgPerson<br />objectclass: top<br />cn: Eric Dalquist<br />description: uPortal Developer<br />givenname: Eric<br />sn: Dalquist<br />uid: edalquist<br />mail: eric.dalquist@example.com<br />userpassword: {SHA}nU4eI71bcnBGqeO0t9tXvY1u5oQ=<br />