Add service connection support for Hazelcast

See gh-42416

spring-boot-project/spring-boot-testcontainers/src/dockerTest/java/org/springframework/boot/testcontainers/service/connection/hazelcast/CustomClusterNameHazelcastContainerConnectionDetailsFactoryIntegrationTests.java

@@ -0,0 +1,86 @@
+/*
+ * 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.hazelcast;
+
+import java.util.UUID;
+import java.util.function.Consumer;
+
+import com.hazelcast.client.config.ClientConfig;
+import com.hazelcast.client.impl.clientside.HazelcastClientProxy;
+import com.hazelcast.core.HazelcastInstance;
+import com.hazelcast.map.IMap;
+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.hazelcast.HazelcastAutoConfiguration;
+import org.springframework.boot.autoconfigure.hazelcast.HazelcastConnectionDetails;
+import org.springframework.boot.testcontainers.service.connection.ServiceConnection;
+import org.springframework.boot.testsupport.container.HazelcastContainer;
+import org.springframework.boot.testsupport.container.TestImage;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for {@link HazelcastContainerConnectionDetailsFactory} with a custom hazelcast
+ * cluster name.
+ *
+ * @author Dmytro Nosan
+ */
+@SpringJUnitConfig
+@Testcontainers(disabledWithoutDocker = true)
+class CustomClusterNameHazelcastContainerConnectionDetailsFactoryIntegrationTests {
+
+	@Container
+	@ServiceConnection
+	static final HazelcastContainer hazelcast = TestImage.container(HazelcastContainer.class)
+		.withEnv("HZ_CLUSTERNAME", "spring-boot");
+
+	@Autowired(required = false)
+	private HazelcastConnectionDetails connectionDetails;
+
+	@Autowired
+	private HazelcastInstance hazelcastInstance;
+
+	@Test
+	void connectionCanBeMadeToHazelcastContainer() {
+		assertThat(this.connectionDetails).isNotNull();
+		assertThat(this.hazelcastInstance).satisfies(clusterName("spring-boot"));
+		IMap<String, String> map = this.hazelcastInstance.getMap(UUID.randomUUID().toString());
+		map.put("test", "containers");
+		assertThat(map.get("test")).isEqualTo("containers");
+	}
+
+	private static Consumer<HazelcastInstance> clusterName(String name) {
+		return (hazelcastInstance) -> {
+			assertThat(hazelcastInstance).isInstanceOf(HazelcastClientProxy.class);
+			HazelcastClientProxy proxy = (HazelcastClientProxy) hazelcastInstance;
+			assertThat(proxy.getClientConfig()).extracting(ClientConfig::getClusterName).isEqualTo(name);
+		};
+	}
+
+	@Configuration(proxyBeanMethods = false)
+	@ImportAutoConfiguration(HazelcastAutoConfiguration.class)
+	static class TestConfiguration {
+
+	}
+
+}

spring-boot-project/spring-boot-testcontainers/src/dockerTest/java/org/springframework/boot/testcontainers/service/connection/hazelcast/HazelcastContainerConnectionDetailsFactoryIntegrationTests.java

@@ -0,0 +1,72 @@
+/*
+ * 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.hazelcast;
+
+import java.util.UUID;
+
+import com.hazelcast.core.HazelcastInstance;
+import com.hazelcast.map.IMap;
+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.hazelcast.HazelcastAutoConfiguration;
+import org.springframework.boot.autoconfigure.hazelcast.HazelcastConnectionDetails;
+import org.springframework.boot.testcontainers.service.connection.ServiceConnection;
+import org.springframework.boot.testsupport.container.HazelcastContainer;
+import org.springframework.boot.testsupport.container.TestImage;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for {@link HazelcastContainerConnectionDetailsFactory}.
+ *
+ * @author Dmytro Nosan
+ */
+@SpringJUnitConfig
+@Testcontainers(disabledWithoutDocker = true)
+class HazelcastContainerConnectionDetailsFactoryIntegrationTests {
+
+	@Container
+	@ServiceConnection
+	static final HazelcastContainer hazelcast = TestImage.container(HazelcastContainer.class);
+
+	@Autowired(required = false)
+	private HazelcastConnectionDetails connectionDetails;
+
+	@Autowired
+	private HazelcastInstance hazelcastInstance;
+
+	@Test
+	void connectionCanBeMadeToHazelcastContainer() {
+		assertThat(this.connectionDetails).isNotNull();
+		IMap<String, String> map = this.hazelcastInstance.getMap(UUID.randomUUID().toString());
+		map.put("test", "containers");
+		assertThat(map.get("test")).isEqualTo("containers");
+	}
+
+	@Configuration(proxyBeanMethods = false)
+	@ImportAutoConfiguration(HazelcastAutoConfiguration.class)
+	static class TestConfiguration {
+
+	}
+
+}

spring-boot-project/spring-boot-testcontainers/src/main/java/org/springframework/boot/testcontainers/service/connection/hazelcast/HazelcastContainerConnectionDetailsFactory.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.hazelcast;
+
+import java.util.Map;
+import java.util.Optional;
+
+import com.hazelcast.client.config.ClientConfig;
+import org.testcontainers.containers.Container;
+import org.testcontainers.containers.GenericContainer;
+
+import org.springframework.boot.autoconfigure.hazelcast.HazelcastConnectionDetails;
+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 HazelcastConnectionDetails}
+ * from a {@link ServiceConnection @ServiceConnection}-annotated {@link GenericContainer}
+ * using the {@code "hazelcast/hazelcast"} image.
+ *
+ * @author Dmytro Nosan
+ */
+class HazelcastContainerConnectionDetailsFactory
+		extends ContainerConnectionDetailsFactory<Container<?>, HazelcastConnectionDetails> {
+
+	private static final int DEFAULT_PORT = 5701;
+
+	private static final String CLUSTER_NAME_ENV = "HZ_CLUSTERNAME";
+
+	HazelcastContainerConnectionDetailsFactory() {
+		super("hazelcast/hazelcast", "com.hazelcast.client.config.ClientConfig");
+	}
+
+	@Override
+	protected HazelcastConnectionDetails getContainerConnectionDetails(ContainerConnectionSource<Container<?>> source) {
+		return new HazelcastContainerConnectionDetails(source);
+	}
+
+	/**
+	 * {@link HazelcastConnectionDetails} backed by a {@link ContainerConnectionSource}.
+	 */
+	private static final class HazelcastContainerConnectionDetails extends ContainerConnectionDetails<Container<?>>
+			implements HazelcastConnectionDetails {
+
+		private HazelcastContainerConnectionDetails(ContainerConnectionSource<Container<?>> source) {
+			super(source);
+		}
+
+		@Override
+		public ClientConfig getClientConfig() {
+			ClientConfig config = new ClientConfig();
+			Container<?> container = getContainer();
+			Map<String, String> env = container.getEnvMap();
+			Optional.ofNullable(env.get(CLUSTER_NAME_ENV)).ifPresent(config::setClusterName);
+			config.getNetworkConfig().addAddress(container.getHost() + ":" + container.getMappedPort(DEFAULT_PORT));
+			return config;
+		}
+
+	}
+
+}

spring-boot-project/spring-boot-testcontainers/src/main/java/org/springframework/boot/testcontainers/service/connection/hazelcast/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 Hazelcast service connections.
+ */
+package org.springframework.boot.testcontainers.service.connection.hazelcast;

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

@@ -14,8 +14,9 @@ org.springframework.boot.testcontainers.service.connection.activemq.ArtemisConta
 org.springframework.boot.testcontainers.service.connection.amqp.RabbitContainerConnectionDetailsFactory,\
 org.springframework.boot.testcontainers.service.connection.cassandra.CassandraContainerConnectionDetailsFactory,\
 org.springframework.boot.testcontainers.service.connection.couchbase.CouchbaseContainerConnectionDetailsFactory,\
-org.springframework.boot.testcontainers.service.connection.flyway.FlywayContainerConnectionDetailsFactory,\
 org.springframework.boot.testcontainers.service.connection.elasticsearch.ElasticsearchContainerConnectionDetailsFactory,\
+org.springframework.boot.testcontainers.service.connection.flyway.FlywayContainerConnectionDetailsFactory,\
+org.springframework.boot.testcontainers.service.connection.hazelcast.HazelcastContainerConnectionDetailsFactory,\
 org.springframework.boot.testcontainers.service.connection.jdbc.JdbcContainerConnectionDetailsFactory,\
 org.springframework.boot.testcontainers.service.connection.kafka.ApacheKafkaContainerConnectionDetailsFactory,\
 org.springframework.boot.testcontainers.service.connection.kafka.ConfluentKafkaContainerConnectionDetailsFactory,\