Added config interceptor for in-memory server

Closes spring-projects#938

Signed-off-by: Emanuel Trandafir <[email protected]>

modules/ROOT/pages/testing.adoc

@@ -225,3 +225,54 @@ To use it, create a bean similar to the following:
 ====
 
 Also, `org.springframework.ldap.test.unboundid.LdapTestUtils` provide methods to programmatically work with an embedded LDAP server.
+
+'''
+
+Moreover, all the options enumerated ahead will support a variation that allows us to pass an `EmbeddedLdapServer.ConfigInterceptor` as a parameter.
+This functional interface extends `Consumer<InMemoryDirectoryServerConfig>` and will be invoked before initializing the server.
+
+This is how we can implement the `ConfigInterceptor` to make the in-memory server use a temporary file for logging the code:
+====
+[source,java]
+----
+class UpdateCodeLogDetails implements EmbeddedLdapServer.ConfigInterceptor {
+    @Override
+    public void accept(InMemoryDirectoryServerConfig config) {
+        config.setCodeLogDetails(tempLogFile, true);
+    }
+}
+----
+====
+
+Now, let's update our configuration to initialize our custom `ConfigInterceptor` and pass as a parameter to `TestContextSourceFactoryBean`:
+
+====
+[source,xml]
+----
+<bean id="updateCodeLogDetails" class="org.springframework.ldap.test.unboundid.TestContextSourceFactoryBeanTests.UpdateCodeLogDetails">
+</bean>
+
+<bean id="contextSource" class="org.springframework.ldap.test.unboundid.TestContextSourceFactoryBean">
+    <property name="defaultPartitionSuffix" value="dc=jayway,dc=se" />
+    <property name="defaultPartitionName" value="jayway" />
+    <property name="principal" value="uid=admin,ou=system" />
+    <property name="password" value="secret" />
+    <property name="ldifFile" value="setup_data.ldif" />
+    <property name="port" value="18881" />
+    <property name="configInterceptor" ref="updateCodeLogDetails" />
+</bean>
+----
+====
+
+Even if we choose to programmatically start the embedded LDAP server using `LdapTestUtils`,
+we can still supply the `ConfigInterceptor` as a lambda expression:
+
+====
+
+[source,java]
+----
+LdapTestUtils.startEmbeddedServer(1888, "dc=jayway,dc=se", "jayway",
+    config -> config.setCodeLogDetails(tempLogFile, true));
+----
+====
+

test-support/src/main/java/org/springframework/ldap/test/unboundid/EmbeddedLdapServer.java

@@ -16,6 +16,8 @@
 
 package org.springframework.ldap.test.unboundid;
 
+import java.util.function.Consumer;
+
 import com.unboundid.ldap.listener.InMemoryDirectoryServer;
 import com.unboundid.ldap.listener.InMemoryDirectoryServerConfig;
 import com.unboundid.ldap.listener.InMemoryListenerConfig;
@@ -38,13 +40,18 @@ private EmbeddedLdapServer(InMemoryDirectoryServer directoryServer) {
 
 	public static EmbeddedLdapServer newEmbeddedServer(String defaultPartitionName, String defaultPartitionSuffix,
 			int port) throws Exception {
+		return newEmbeddedServer(defaultPartitionName, defaultPartitionSuffix, port, ConfigInterceptor.doNothing());
+	}
+
+	public static EmbeddedLdapServer newEmbeddedServer(String defaultPartitionName, String defaultPartitionSuffix,
+			int port, ConfigInterceptor configInterceptor) throws Exception {
+
 		InMemoryDirectoryServerConfig config = new InMemoryDirectoryServerConfig(defaultPartitionSuffix);
 		config.addAdditionalBindCredentials("uid=admin,ou=system", "secret");
-
 		config.setListenerConfigs(InMemoryListenerConfig.createLDAPConfig("LDAP", port));
-
 		config.setEnforceSingleStructuralObjectClass(false);
 		config.setEnforceAttributeSyntaxCompliance(true);
+		configInterceptor.accept(config);
 
 		Entry entry = new Entry(new DN(defaultPartitionSuffix));
 		entry.addAttribute("objectClass", "top", "domain", "extensibleObject");
@@ -56,6 +63,16 @@ public static EmbeddedLdapServer newEmbeddedServer(String defaultPartitionName,
 		return new EmbeddedLdapServer(directoryServer);
 	}
 
+	@FunctionalInterface
+	public interface ConfigInterceptor extends Consumer<InMemoryDirectoryServerConfig> {
+
+		static ConfigInterceptor doNothing() {
+			return config -> {
+			};
+		}
+
+	}
+
 	public void shutdown() throws Exception {
 		this.directoryServer.shutDown(true);
 	}

test-support/src/main/java/org/springframework/ldap/test/unboundid/EmbeddedLdapServerFactoryBean.java

@@ -17,6 +17,7 @@
 package org.springframework.ldap.test.unboundid;
 
 import org.springframework.beans.factory.config.AbstractFactoryBean;
+import org.springframework.ldap.test.unboundid.EmbeddedLdapServer.ConfigInterceptor;
 
 /**
  * @author Mattias Hellborg Arthursson
@@ -29,6 +30,8 @@ public class EmbeddedLdapServerFactoryBean extends AbstractFactoryBean<EmbeddedL
 
 	private String partitionSuffix;
 
+	private ConfigInterceptor configInterceptor = ConfigInterceptor.doNothing();
+
 	@Override
 	public Class<?> getObjectType() {
 		return EmbeddedLdapServer.class;
@@ -42,13 +45,18 @@ public void setPartitionSuffix(String partitionSuffix) {
 		this.partitionSuffix = partitionSuffix;
 	}
 
+	public void setConfigInterceptor(ConfigInterceptor configInterceptor) {
+		this.configInterceptor = configInterceptor;
+	}
+
 	public void setPort(int port) {
 		this.port = port;
 	}
 
 	@Override
 	protected EmbeddedLdapServer createInstance() throws Exception {
-		return EmbeddedLdapServer.newEmbeddedServer(this.partitionName, this.partitionSuffix, this.port);
+		return EmbeddedLdapServer.newEmbeddedServer(this.partitionName, this.partitionSuffix, this.port,
+				this.configInterceptor);
 	}
 
 	@Override

test-support/src/main/java/org/springframework/ldap/test/unboundid/LdapTestUtils.java

@@ -29,20 +29,22 @@
 import javax.naming.directory.DirContext;
 import javax.naming.ldap.LdapName;
 
-import com.unboundid.ldap.listener.InMemoryDirectoryServer;
-import com.unboundid.ldap.sdk.LDAPException;
-import com.unboundid.ldif.LDIFReader;
 import org.apache.commons.io.IOUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-
 import org.springframework.core.io.Resource;
 import org.springframework.ldap.UncategorizedLdapException;
 import org.springframework.ldap.core.ContextSource;
 import org.springframework.ldap.core.LdapAttributes;
 import org.springframework.ldap.core.support.DefaultDirObjectFactory;
 import org.springframework.ldap.ldif.parser.LdifParser;
 import org.springframework.ldap.support.LdapUtils;
+import org.springframework.ldap.test.unboundid.EmbeddedLdapServer.ConfigInterceptor;
+
+import com.unboundid.ldap.listener.InMemoryDirectoryServer;
+import com.unboundid.ldap.listener.InMemoryDirectoryServerConfig;
+import com.unboundid.ldap.sdk.LDAPException;
+import com.unboundid.ldif.LDIFReader;
 
 /**
  * Utilities for starting, stopping and populating an in-process Apache Directory Server
@@ -73,12 +75,30 @@ private LdapTestUtils() {
 	 * @throws IllegalStateException if an embedded server is already started.
 	 */
 	public static void startEmbeddedServer(int port, String defaultPartitionSuffix, String defaultPartitionName) {
+		startEmbeddedServer(port, defaultPartitionSuffix, defaultPartitionName, ConfigInterceptor.doNothing());
+	}
+
+	/**
+	 * Start an embedded Apache Directory Server. Only one embedded server will be
+	 * permitted in the same JVM.
+	 * @param port the port on which the server will be listening.
+	 * @param defaultPartitionSuffix The default base suffix that will be used for the
+	 * LDAP server.
+	 * @param defaultPartitionName The name to use in the directory server configuration
+	 * for the default base suffix.
+	 * @param configInterceptor a function that can intercept and modify the
+	 * {@link InMemoryDirectoryServerConfig} before initiating the in-memory server.
+	 * @throws IllegalStateException if an embedded server is already started.
+	 */
+	public static void startEmbeddedServer(int port, String defaultPartitionSuffix, String defaultPartitionName,
+			ConfigInterceptor configInterceptor) {
 		if (embeddedServer != null) {
 			throw new IllegalStateException("An embedded server is already started");
 		}
 
 		try {
-			embeddedServer = EmbeddedLdapServer.newEmbeddedServer(defaultPartitionName, defaultPartitionSuffix, port);
+			embeddedServer = EmbeddedLdapServer.newEmbeddedServer(defaultPartitionName, defaultPartitionSuffix, port,
+					configInterceptor);
 		}
 		catch (Exception ex) {
 			throw new UncategorizedLdapException("Failed to start embedded server", ex);

test-support/src/main/java/org/springframework/ldap/test/unboundid/TestContextSourceFactoryBean.java

@@ -25,6 +25,7 @@
 import org.springframework.ldap.core.support.DefaultDirObjectFactory;
 import org.springframework.ldap.core.support.LdapContextSource;
 import org.springframework.ldap.support.LdapUtils;
+import org.springframework.ldap.test.unboundid.EmbeddedLdapServer.ConfigInterceptor;
 
 /**
  * @author Mattias Hellborg Arthursson
@@ -53,6 +54,8 @@ public class TestContextSourceFactoryBean extends AbstractFactoryBean<ContextSou
 
 	private ContextSource contextSource;
 
+	private ConfigInterceptor configInterceptor = ConfigInterceptor.doNothing();
+
 	public void setAuthenticationSource(AuthenticationSource authenticationSource) {
 		this.authenticationSource = authenticationSource;
 	}
@@ -97,8 +100,13 @@ public void setContextSource(ContextSource contextSource) {
 		this.contextSource = contextSource;
 	}
 
+	public void setConfigInterceptor(ConfigInterceptor configInterceptor) {
+		this.configInterceptor = configInterceptor;
+	}
+
 	protected ContextSource createInstance() throws Exception {
-		LdapTestUtils.startEmbeddedServer(this.port, this.defaultPartitionSuffix, this.defaultPartitionName);
+		LdapTestUtils.startEmbeddedServer(this.port, this.defaultPartitionSuffix, this.defaultPartitionName,
+				this.configInterceptor);
 
 		if (this.contextSource == null) {
 			// If not explicitly configured, create a new instance.

test-support/src/test/java/org/springframework/ldap/test/unboundid/TestContextSourceFactoryBeanTests.java

@@ -16,12 +16,17 @@
 
 package org.springframework.ldap.test.unboundid;
 
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
 import java.util.List;
 
 import javax.naming.NamingException;
 import javax.naming.directory.Attributes;
 
+import com.unboundid.ldap.listener.InMemoryDirectoryServerConfig;
 import org.junit.After;
+import org.junit.BeforeClass;
 import org.junit.Test;
 
 import org.springframework.context.support.ClassPathXmlApplicationContext;
@@ -35,15 +40,31 @@ public class TestContextSourceFactoryBeanTests {
 
 	ClassPathXmlApplicationContext ctx;
 
-	@After
-	public void setup() {
-		if (this.ctx != null) {
-			this.ctx.close();
-		}
+	static String tempLogFile;
+
+	@BeforeClass
+	public static void before() throws IOException {
+		tempLogFile = Files.createTempFile("ldap-log-", ".txt").toAbsolutePath().toString();
+	}
+
+	@Test
+	public void testServerStartup_withCustomConfig() {
+		this.ctx = new ClassPathXmlApplicationContext(
+				"/applicationContext-testContextSource-withCustomInterceptor.xml");
+		LdapTemplate ldapTemplate = this.ctx.getBean(LdapTemplate.class);
+		assertThat(ldapTemplate).isNotNull();
+
+		ldapTemplate.search(LdapQueryBuilder.query().where("objectclass").is("person"), new AttributesMapper<>() {
+			public String mapFromAttributes(Attributes attrs) throws NamingException {
+				return (String) attrs.get("cn").get();
+			}
+		});
+
+		assertThat(Path.of(tempLogFile)).isNotEmptyFile();
 	}
 
 	@Test
-	public void testServerStartup() throws Exception {
+	public void testServerStartup() {
 		this.ctx = new ClassPathXmlApplicationContext("/applicationContext-testContextSource.xml");
 		LdapTemplate ldapTemplate = this.ctx.getBean(LdapTemplate.class);
 		assertThat(ldapTemplate).isNotNull();
@@ -57,4 +78,20 @@ public String mapFromAttributes(Attributes attrs) throws NamingException {
 		assertThat(list.size()).isEqualTo(5);
 	}
 
+	@After
+	public void setup() {
+		if (this.ctx != null) {
+			this.ctx.close();
+		}
+	}
+
+	static class UpdateCodeLogDetails implements EmbeddedLdapServer.ConfigInterceptor {
+
+		@Override
+		public void accept(InMemoryDirectoryServerConfig config) {
+			config.setCodeLogDetails(tempLogFile, true);
+		}
+
+	}
+
 }

test-support/src/test/resources/applicationContext-testContextSource-withCustomInterceptor.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<beans xmlns="http://www.springframework.org/schema/beans"
+       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xsi:schemaLocation="http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd">
+
+    <bean id="ldapTemplate" class="org.springframework.ldap.core.LdapTemplate">
+        <property name="contextSource" ref="contextSource" />
+    </bean>
+
+    <bean id="updateCodeLogDetails" class="org.springframework.ldap.test.unboundid.TestContextSourceFactoryBeanTests.UpdateCodeLogDetails">
+    </bean>
+
+    <bean id="contextSource" class="org.springframework.ldap.test.unboundid.TestContextSourceFactoryBean">
+        <property name="defaultPartitionSuffix" value="dc=jayway,dc=se" />
+        <property name="defaultPartitionName" value="jayway" />
+        <property name="principal" value="uid=admin,ou=system" />
+        <property name="password" value="secret" />
+        <property name="ldifFile" value="setup_data.ldif" />
+        <property name="port" value="18881" />
+        <property name="configInterceptor" ref="updateCodeLogDetails" />
+    </bean>
+
+</beans>