Add Docker Compose service connection support for OpenLDAP

See gh-39258

spring-boot-project/spring-boot-testcontainers/src/main/java/org/springframework/boot/testcontainers/service/connection/ldap/LdapContainerConnectionDetailsFactory.java

@@ -0,0 +1,90 @@
+/*
+ * Copyright 2012-2024 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
+ *
+ *      https://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.testcontainers.service.connection.ldap;
+
+import java.util.Arrays;
+import java.util.Map;
+import java.util.stream.Collectors;
+
+import org.testcontainers.containers.Container;
+import org.testcontainers.containers.GenericContainer;
+
+import org.springframework.boot.autoconfigure.ldap.LdapConnectionDetails;
+import org.springframework.boot.testcontainers.service.connection.ContainerConnectionDetailsFactory;
+import org.springframework.boot.testcontainers.service.connection.ContainerConnectionSource;
+import org.springframework.boot.testcontainers.service.connection.ServiceConnection;
+
+/**
+ * {@link ContainerConnectionDetailsFactory} to create {@link LdapConnectionDetails} from
+ * a {@link ServiceConnection @ServiceConnection}-annotated {@link GenericContainer} using
+ * the {@code "osixia/openldap"} image.
+ *
+ * @author Philipp Kessler
+ */
+class LdapContainerConnectionDetailsFactory
+		extends ContainerConnectionDetailsFactory<Container<?>, LdapConnectionDetails> {
+
+	LdapContainerConnectionDetailsFactory() {
+		super("osixia/openldap");
+	}
+
+	@Override
+	protected LdapConnectionDetails getContainerConnectionDetails(ContainerConnectionSource<Container<?>> source) {
+		return new LdapContainerConnectionDetailsFactory.LdapContainerConnectionDetails(source);
+	}
+
+	private static final class LdapContainerConnectionDetails extends ContainerConnectionDetails<Container<?>>
+			implements LdapConnectionDetails {
+
+		private LdapContainerConnectionDetails(ContainerConnectionSource<Container<?>> source) {
+			super(source);
+		}
+
+		@Override
+		public String[] getUrls() {
+			Map<String, String> env = getContainer().getEnvMap();
+			boolean usesTls = Boolean.parseBoolean(env.getOrDefault("LDAP_TLS", "true"));
+			String ldapPort = usesTls ? env.getOrDefault("LDAPS_PORT", "636") : env.getOrDefault("LDAP_PORT", "389");
+			return new String[] { "%s://%s:%d".formatted(usesTls ? "ldaps" : "ldap", getContainer().getHost(),
+					getContainer().getMappedPort(Integer.parseInt(ldapPort))) };
+		}
+
+		@Override
+		public String getBase() {
+			String baseDn = getContainer().getEnvMap().getOrDefault("LDAP_BASE_DN", null);
+			if (baseDn == null) {
+				baseDn = Arrays
+					.stream(getContainer().getEnvMap().getOrDefault("LDAP_DOMAIN", "example.org").split("\\."))
+					.map("dc=%s"::formatted)
+					.collect(Collectors.joining(","));
+			}
+			return baseDn;
+		}
+
+		@Override
+		public String getUsername() {
+			return "cn=admin,%s".formatted(getBase());
+		}
+
+		@Override
+		public String getPassword() {
+			return getContainer().getEnvMap().getOrDefault("LDAP_ADMIN_PASSWORD", "admin");
+		}
+
+	}
+
+}

spring-boot-project/spring-boot-testcontainers/src/main/java/org/springframework/boot/testcontainers/service/connection/ldap/package-info.java

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2012-2024 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
+ *
+ *      https://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.
+ */
+
+/**
+ * Support for testcontainers Ldap service connections.
+ */
+package org.springframework.boot.testcontainers.service.connection.ldap;

spring-boot-project/spring-boot-testcontainers/src/main/resources/META-INF/spring.factories

@@ -16,6 +16,7 @@ org.springframework.boot.testcontainers.service.connection.flyway.FlywayContaine
 org.springframework.boot.testcontainers.service.connection.elasticsearch.ElasticsearchContainerConnectionDetailsFactory,\
 org.springframework.boot.testcontainers.service.connection.jdbc.JdbcContainerConnectionDetailsFactory,\
 org.springframework.boot.testcontainers.service.connection.kafka.KafkaContainerConnectionDetailsFactory,\
+org.springframework.boot.testcontainers.service.connection.ldap.LdapContainerConnectionDetailsFactory,\
 org.springframework.boot.testcontainers.service.connection.liquibase.LiquibaseContainerConnectionDetailsFactory,\
 org.springframework.boot.testcontainers.service.connection.mongo.MongoContainerConnectionDetailsFactory,\
 org.springframework.boot.testcontainers.service.connection.neo4j.Neo4jContainerConnectionDetailsFactory,\

spring-boot-project/spring-boot-testcontainers/src/test/java/org/springframework/boot/testcontainers/service/connection/ldap/LdapContainerConnectionDetailsFactoryIntegrationTests.java

@@ -0,0 +1,76 @@
+/*
+ * Copyright 2012-2024 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
+ *
+ *      https://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.testcontainers.service.connection.ldap;
+
+import java.util.List;
+
+import javax.naming.NamingException;
+import javax.naming.directory.Attributes;
+
+import org.junit.jupiter.api.Test;
+import org.testcontainers.junit.jupiter.Container;
+import org.testcontainers.junit.jupiter.Testcontainers;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.autoconfigure.ImportAutoConfiguration;
+import org.springframework.boot.autoconfigure.ldap.LdapAutoConfiguration;
+import org.springframework.boot.testcontainers.service.connection.ServiceConnection;
+import org.springframework.boot.testsupport.testcontainers.LdapContainer;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.ldap.core.AttributesMapper;
+import org.springframework.ldap.core.LdapTemplate;
+import org.springframework.ldap.query.LdapQueryBuilder;
+import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for {@link LdapContainerConnectionDetailsFactory}.
+ *
+ * @author Philipp Kessler
+ */
+@SpringJUnitConfig
+@Testcontainers(disabledWithoutDocker = true)
+class LdapContainerConnectionDetailsFactoryIntegrationTests {
+
+	@Container
+	@ServiceConnection
+	static final LdapContainer openLdap = new LdapContainer().withEnv("LDAP_TLS", "false");
+
+	@Autowired
+	private LdapTemplate ldapTemplate;
+
+	@Test
+	void connectionCanBeMadeToLdapContainer() {
+		List<String> cn = this.ldapTemplate.search(LdapQueryBuilder.query().where("objectclass").is("dcObject"),
+				new AttributesMapper<String>() {
+					@Override
+					public String mapFromAttributes(Attributes attributes) throws NamingException {
+						return attributes.get("dc").get().toString();
+					}
+				});
+		assertThat(cn).hasSize(1);
+		assertThat(cn.get(0)).isEqualTo("example");
+	}
+
+	@Configuration(proxyBeanMethods = false)
+	@ImportAutoConfiguration({ LdapAutoConfiguration.class })
+	static class TestConfiguration {
+
+	}
+
+}