Bind to the loopback device by default. Expose builder method that allows the bindingAddress to be set thus resolving #3

Author: zapodot

src/main/java/org/zapodot/junit/ldap/EmbeddedLdapRule.java

@@ -51,11 +51,12 @@ public interface EmbeddedLdapRule extends TestRule {
     /**
      * Gives access to the listening port for the currently running embedded LDAP server.
      * This will make it easier to use other integration
-     *
-     * Note: the listening address is always <em>0.0.0.0</em> which means the server will listen to all available NIC-s.
-     * This may change in a future release (should ideally only be listening on the loopback device)
+     * <p/>
+     * Note: the embedded LDAP server is by default configured to listen only on the loopback address
+     * (i.e <em>localhost/127.0.0.1</em>) unless another address has been provided to the builder when the rule was built
      *
      * @return the port number that the embedded server is listening to
+     * @see org.zapodot.junit.ldap.EmbeddedLdapRuleBuilder#bindingToAddress(String)
      */
     int embeddedServerPort();
 

src/main/java/org/zapodot/junit/ldap/EmbeddedLdapRuleBuilder.java

@@ -14,7 +14,9 @@
 
 import java.io.File;
 import java.io.IOException;
+import java.net.InetAddress;
 import java.net.URISyntaxException;
+import java.net.UnknownHostException;
 import java.util.Arrays;
 import java.util.LinkedList;
 import java.util.List;
@@ -29,6 +31,8 @@ public class EmbeddedLdapRuleBuilder {
     public static final String DEFAULT_BIND_DSN = "cn=Directory manager";
     public static final String DEFAULT_BIND_CREDENTIALS = "password";
     public static final String LDAP_SERVER_LISTENER_NAME = "test-listener";
+    public static final int MIN_PORT_EXCLUSIVE = 0;
+    public static final int MAX_PORT_EXCLUSIVE = 65535;
     private List<String> domainDsn = new LinkedList<>();
 
     private String bindDSN = DEFAULT_BIND_DSN;
@@ -39,7 +43,9 @@ public class EmbeddedLdapRuleBuilder {
 
     private List<String> schemaLdifs = new LinkedList<>();
 
-    private Integer port = null;
+    private Integer bindPort = 0;
+
+    private InetAddress bindAddress = InetAddress.getLoopbackAddress();
 
     private AuthenticationConfiguration authenticationConfiguration;
 
@@ -93,9 +99,32 @@ public EmbeddedLdapRuleBuilder usingBindCredentials(final String bindCredentials
      *
      * @param port a port number
      * @return same EmbeddedLdapRuleBuilder instance with the port field set
+     * @throws IllegalArgumentException if the provided value for port is not between @{link MIN_PORT_EXCLUSIVE}
+     *                                  and @{MAX_PORT_EXCLUSIVE} (exclusive)
      */
     public EmbeddedLdapRuleBuilder bindingToPort(final int port) {
-        this.port = Integer.valueOf(port);
+        if ((port < MIN_PORT_EXCLUSIVE) || (port > MAX_PORT_EXCLUSIVE)) {
+            throw new IllegalArgumentException(String.format("Value \"%s\" is not a valid port number", port));
+        }
+        this.bindPort = Integer.valueOf(port);
+        return this;
+    }
+
+    /**
+     * Allows the listening address for the embedded LDAP server to be set. If not set it will bind to <em>localhost/127.0.0.1</em>.
+     *
+     * @param address a valid hostname or textual representation of an IP address
+     * @return same EmbeddedLdapRuleBuilder instance with the bindAddress field set
+     * @throws IllegalArgumentException if the value provided for \"address\" is invalid
+     */
+    public EmbeddedLdapRuleBuilder bindingToAddress(final String address) {
+        Objects.requireNonNull(address);
+        try {
+            final InetAddress addressByName = InetAddress.getByName(address);
+            this.bindAddress = addressByName;
+        } catch (UnknownHostException e) {
+            throw new IllegalArgumentException(String.format("Unknown host address \"%s\"", address), e);
+        }
         return this;
     }
 
@@ -145,14 +174,12 @@ private InMemoryDirectoryServerConfig createInMemoryServerConfiguration() {
                 inMemoryDirectoryServerConfig.addAdditionalBindCredentials(bindDSN, bindCredentials);
             }
 
-            if (port != null) {
-                inMemoryDirectoryServerConfig.setListenerConfigs(InMemoryListenerConfig.createLDAPConfig(
-                        LDAP_SERVER_LISTENER_NAME,
-                        port));
-            } else {
-                inMemoryDirectoryServerConfig.setListenerConfigs(InMemoryListenerConfig.createLDAPConfig(
-                        LDAP_SERVER_LISTENER_NAME));
-            }
+            final InMemoryListenerConfig listenerConfig = InMemoryListenerConfig.createLDAPConfig(
+                    LDAP_SERVER_LISTENER_NAME,
+                    bindAddress,
+                    bindPort,
+                    null);
+            inMemoryDirectoryServerConfig.setListenerConfigs(listenerConfig);
             for (Schema s : customSchema().asSet()) {
                 inMemoryDirectoryServerConfig.setSchema(s);
             }

src/main/java/org/zapodot/junit/ldap/internal/AuthenticationConfiguration.java

@@ -1,12 +1,13 @@
 package org.zapodot.junit.ldap.internal;
 
+import com.google.common.collect.ImmutableMap;
+
 import javax.naming.Context;
-import java.util.HashMap;
 import java.util.Map;
 
 /**
  * LDAP authentication POJO.
- *
+ * <p/>
  * This class is part of the internal API and may thus be changed or removed without warning.
  */
 public class AuthenticationConfiguration {
@@ -20,14 +21,16 @@ public AuthenticationConfiguration(final String userDn, final String credentials
 
 
     public Map<String, String> toAuthenticationEnvironment() {
-        final HashMap<String, String> authenticationConfiguration = new HashMap<>();
-        if (userDn != null && credentials != null) {
-            authenticationConfiguration.put(Context.SECURITY_PRINCIPAL, userDn);
-            authenticationConfiguration.put(Context.SECURITY_PROTOCOL, "simple");
-            authenticationConfiguration.put(Context.SECURITY_CREDENTIALS, credentials);
-        } else {
-            authenticationConfiguration.put(Context.SECURITY_PROTOCOL, "none");
+
+        if (userDn == null || credentials == null) {
+            throw new IllegalStateException("userDn and credentials must be set before generating the "
+                                               + "authentication environment");
         }
-        return authenticationConfiguration;
+
+        return ImmutableMap.<String, String>builder()
+                           .put(Context.SECURITY_PRINCIPAL, userDn)
+                           .put(Context.SECURITY_PROTOCOL, "simple")
+                           .put(Context.SECURITY_CREDENTIALS, credentials)
+                           .build();
     }
 }

src/main/java/org/zapodot/junit/ldap/internal/EmbeddedLdapRuleImpl.java

@@ -119,7 +119,7 @@ private Hashtable<String, String> createLdapEnvironment() {
         final Hashtable<String, String> environment = new Hashtable<>();
         environment.put(LdapContext.CONTROL_FACTORIES, DefaultResponseControlFactory.class.getName());
         environment.put(Context.PROVIDER_URL, String.format("ldap://%s:%s",
-                                                            "localhost",
+                                                            inMemoryDirectoryServer.getListenAddress().getHostName(),
                                                             embeddedServerPort()));
         environment.put(Context.INITIAL_CONTEXT_FACTORY, LdapCtxFactory.class.getName());
         if (authenticationConfiguration != null) {

src/test/java/org/zapodot/junit/ldap/EmbeddedLdapRuleBuilderTest.java

@@ -36,7 +36,7 @@ public void testIllegalDSN() throws Exception {
 
     }
 
-    @Test(expected = IllegalStateException.class)
+    @Test(expected = IllegalArgumentException.class)
     public void testIllegalPort() throws Exception {
         EmbeddedLdapRuleBuilder.newInstance().bindingToPort(Integer.MIN_VALUE).build();
 
@@ -59,4 +59,18 @@ public void testSchemaIsInvalid() throws Exception {
         EmbeddedLdapRuleBuilder.newInstance().withSchema("invalid.ldif").build();
 
     }
+
+    @Test(expected = IllegalArgumentException.class)
+    public void testInvalidPort() throws Exception {
+        EmbeddedLdapRuleBuilder.newInstance().bindingToPort(Integer.MAX_VALUE);
+
+    }
+
+    @Test(expected = IllegalArgumentException.class)
+    public void testInvalidBindAddress() throws Exception {
+        EmbeddedLdapRuleBuilder.newInstance().bindingToAddress("åpsldfåpl");
+
+    }
+
+
 }

src/test/java/org/zapodot/junit/ldap/EmbeddedLdapRuleNoAuthTest.java

@@ -0,0 +1,23 @@
+package org.zapodot.junit.ldap;
+
+import org.junit.Rule;
+import org.junit.Test;
+
+import static org.junit.Assert.assertNotNull;
+
+public class EmbeddedLdapRuleNoAuthTest {
+
+    @Rule
+    public EmbeddedLdapRule embeddedLdapRule = EmbeddedLdapRuleBuilder
+            .newInstance()
+            .usingBindCredentials(null)
+            .usingDomainDsn("dc=zapodot,dc=org")
+            .importingLdifs("example.ldif")
+            .build();
+
+    @Test
+    public void testConnect() throws Exception {
+        assertNotNull(embeddedLdapRule.dirContext().search("cn=Sondre Eikanger Kvalo,ou=people,dc=zapodot,dc=org", null));
+
+    }
+}

src/test/java/org/zapodot/junit/ldap/EmbeddedLdapRuleWithListeningAddressProvidedTest.java

@@ -0,0 +1,34 @@
+package org.zapodot.junit.ldap;
+
+import org.junit.BeforeClass;
+import org.junit.Rule;
+import org.junit.Test;
+
+import java.net.InetAddress;
+
+import static org.junit.Assert.assertEquals;
+
+public class EmbeddedLdapRuleWithListeningAddressProvidedTest {
+
+    public static InetAddress inetAddress;
+
+    @Rule
+    public EmbeddedLdapRule embeddedLdapRule = EmbeddedLdapRuleBuilder
+            .newInstance()
+            .usingDomainDsn("dc=zapodot,dc=org")
+            .importingLdifs("example.ldif")
+            .bindingToAddress(inetAddress.getHostAddress())
+            .build();
+
+    @BeforeClass
+    public static void setupAddress() throws Exception {
+        inetAddress = InetAddress.getLocalHost();
+    }
+
+    @Test
+    public void testLookupAddress() throws Exception {
+        assertEquals(inetAddress.getHostAddress(),
+                     embeddedLdapRule.unsharedLdapConnection().getConnectedAddress());
+
+    }
+}

src/test/java/org/zapodot/junit/ldap/internal/AuthenticationConfigurationTest.java

@@ -0,0 +1,25 @@
+package org.zapodot.junit.ldap.internal;
+
+import org.junit.Test;
+
+import java.util.Map;
+
+import static org.junit.Assert.assertEquals;
+
+public class AuthenticationConfigurationTest {
+
+    @Test
+    public void testToAuthenticationEnvironment() throws Exception {
+        final AuthenticationConfiguration authenticationConfiguration = new AuthenticationConfiguration(
+                "cn=someone,ou=people,dc=net",
+                "credentials");
+        final Map<String, String> environment = authenticationConfiguration.toAuthenticationEnvironment();
+        assertEquals(3, environment.size());
+    }
+
+    @Test(expected = IllegalStateException.class)
+    public void testNotSet() throws Exception {
+        new AuthenticationConfiguration(null, null).toAuthenticationEnvironment();
+
+    }
+}