Add ldap module (#9987)

Provide LLdapContainer supporting `lldap/lldap` image.

Fixes #9960

Author: eddumelendez

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -34,6 +34,7 @@ body:
         - K3S
         - K6
         - Kafka
+        - LDAP
         - LocalStack
         - MariaDB
         - Milvus

.github/ISSUE_TEMPLATE/enhancement.yaml

@@ -34,6 +34,7 @@ body:
         - K3S
         - K6
         - Kafka
+        - LDAP
         - LocalStack
         - MariaDB
         - Milvus

.github/ISSUE_TEMPLATE/feature.yaml

@@ -34,6 +34,7 @@ body:
         - K3S
         - K6
         - Kafka
+        - LDAP
         - LocalStack
         - MariaDB
         - Milvus

.github/dependabot.yml

@@ -178,6 +178,11 @@ updates:
     schedule:
       interval: "weekly"
     open-pull-requests-limit: 10
+  - package-ecosystem: "gradle"
+    directory: "/modules/ldap"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 10
   - package-ecosystem: "gradle"
     directory: "/modules/localstack"
     schedule:

.github/labeler.yml

@@ -107,6 +107,10 @@
   - changed-files:
     - any-glob-to-any-file:
       - modules/kafka/**/*
+"modules/ldap":
+  - changed-files:
+    - any-glob-to-any-file:
+      - modules/ldap/**/*
 "modules/localstack":
   - changed-files:
     - any-glob-to-any-file:

.github/settings.yml

@@ -169,6 +169,9 @@ labels:
   - name: modules/kafka
     color: '#006b75'
 
+  - name: modules/ldap
+    color: '#006b75'
+
   - name: modules/localstack
     color: '#006b75'
 

docs/modules/ldap.md

@@ -0,0 +1,30 @@
+# LDAP
+
+Testcontainers module for [LLDAP](https://hub.docker.com/r/lldap/lldap).
+
+## LLdapContainer's usage examples
+
+You can start a LLDAP container instance from any Java application by using:
+
+<!--codeinclude-->
+[LLDAP container](../../modules/ldap/src/test/java/org/testcontainers/ldap/LLdapContainerTest.java) inside_block:container
+<!--/codeinclude-->
+
+## Adding this module to your project dependencies
+
+Add the following dependency to your `pom.xml`/`build.gradle` file:
+
+=== "Gradle"
+    ```groovy
+    testImplementation "org.testcontainers:ldap:{{latest_version}}"
+    ```
+
+=== "Maven"
+    ```xml
+    <dependency>
+        <groupId>org.testcontainers</groupId>
+        <artifactId>ldap</artifactId>
+        <version>{{latest_version}}</version>
+        <scope>test</scope>
+    </dependency>
+    ```

mkdocs.yml

@@ -89,6 +89,7 @@ nav:
           - modules/k3s.md
           - modules/k6.md
           - modules/kafka.md
+          - modules/ldap.md
           - modules/localstack.md
           - modules/milvus.md
           - modules/minio.md

modules/ldap/build.gradle

@@ -0,0 +1,8 @@
+description = "Testcontainers :: LDAP"
+
+dependencies {
+    api project(':testcontainers')
+
+    testImplementation 'org.assertj:assertj-core:3.26.3'
+    testImplementation 'com.unboundid:unboundid-ldapsdk:7.0.2'
+}

modules/ldap/src/main/java/org/testcontainers/ldap/LLdapContainer.java

@@ -0,0 +1,51 @@
+package org.testcontainers.ldap;
+
+import com.github.dockerjava.api.command.InspectContainerResponse;
+import lombok.extern.slf4j.Slf4j;
+import org.testcontainers.containers.GenericContainer;
+import org.testcontainers.containers.wait.strategy.Wait;
+import org.testcontainers.utility.DockerImageName;
+
+/**
+ * Testcontainers implementation for LLDAP.
+ * <p>
+ * Supported image: {@code lldap/lldap}
+ * <p>
+ * Exposed ports:
+ * <ul>
+ *     <li>LDAP: 3890</li>
+ *     <li>UI: 17170</li>
+ * </ul>
+ */
+@Slf4j
+public class LLdapContainer extends GenericContainer<LLdapContainer> {
+
+    private static final String IMAGE_VERSION = "lldap/lldap";
+
+    private static final DockerImageName DEFAULT_IMAGE_NAME = DockerImageName.parse(IMAGE_VERSION);
+
+    private static final int LDAP_PORT = 3890;
+
+    private static final int UI_PORT = 17170;
+
+    public LLdapContainer(String image) {
+        this(DockerImageName.parse(image));
+    }
+
+    public LLdapContainer(DockerImageName image) {
+        super(image);
+        image.assertCompatibleWith(DEFAULT_IMAGE_NAME);
+        addExposedPorts(LDAP_PORT, UI_PORT);
+
+        waitingFor(Wait.forHttp("/health").forPort(UI_PORT).forStatusCode(200));
+    }
+
+    @Override
+    protected void containerIsStarted(InspectContainerResponse containerInfo) {
+        log.info("LLDAP container is ready! UI available at http://{}:{}", getHost(), getMappedPort(UI_PORT));
+    }
+
+    public int getLdapPort() {
+        return getMappedPort(LDAP_PORT);
+    }
+}

modules/ldap/src/test/java/org/testcontainers/ldap/LLdapContainerTest.java

@@ -0,0 +1,24 @@
+package org.testcontainers.ldap;
+
+import com.unboundid.ldap.sdk.BindResult;
+import com.unboundid.ldap.sdk.LDAPConnection;
+import com.unboundid.ldap.sdk.LDAPException;
+import org.junit.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class LLdapContainerTest {
+
+    @Test
+    public void test() throws LDAPException {
+        try ( // container {
+            LLdapContainer lldap = new LLdapContainer("lldap/lldap:v0.6.1-alpine")
+            // }
+        ) {
+            lldap.start();
+            LDAPConnection connection = new LDAPConnection(lldap.getHost(), lldap.getLdapPort());
+            BindResult result = connection.bind("cn=admin,ou=people,dc=example,dc=com", "password");
+            assertThat(result).isNotNull();
+        }
+    }
+}

modules/ldap/src/test/resources/logback-test.xml

@@ -0,0 +1,16 @@
+<configuration>
+
+    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+        <!-- encoders are assigned the type
+             ch.qos.logback.classic.encoder.PatternLayoutEncoder by default -->
+        <encoder>
+            <pattern>%d{HH:mm:ss.SSS} %-5level %logger - %msg%n</pattern>
+        </encoder>
+    </appender>
+
+    <root level="INFO">
+        <appender-ref ref="STDOUT"/>
+    </root>
+
+    <logger name="org.testcontainers" level="INFO"/>
+</configuration>