Add service connection for Docker Compose and Testcontainers ActiveMQ

See gh-39363

spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/activemq/ActiveMQClassicDockerComposeConnectionDetailsFactory.java

@@ -0,0 +1,79 @@
+/*
+ * 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.docker.compose.service.connection.activemq;
+
+import org.springframework.boot.autoconfigure.jms.activemq.ActiveMQConnectionDetails;
+import org.springframework.boot.docker.compose.core.RunningService;
+import org.springframework.boot.docker.compose.service.connection.DockerComposeConnectionDetailsFactory;
+import org.springframework.boot.docker.compose.service.connection.DockerComposeConnectionSource;
+
+/**
+ * {@link DockerComposeConnectionDetailsFactory} to create
+ * {@link ActiveMQConnectionDetails} for an {@code activemq} service.
+ *
+ * @author Stephane Nicoll
+ * @author Eddú Meléndez
+ */
+class ActiveMQClassicDockerComposeConnectionDetailsFactory
+		extends DockerComposeConnectionDetailsFactory<ActiveMQConnectionDetails> {
+
+	private static final int ACTIVEMQ_PORT = 61616;
+
+	protected ActiveMQClassicDockerComposeConnectionDetailsFactory() {
+		super("apache/activemq-classic");
+	}
+
+	@Override
+	protected ActiveMQConnectionDetails getDockerComposeConnectionDetails(DockerComposeConnectionSource source) {
+		return new ActiveMQDockerComposeConnectionDetails(source.getRunningService());
+	}
+
+	/**
+	 * {@link ActiveMQConnectionDetails} backed by a {@code activemq}
+	 * {@link RunningService}.
+	 */
+	static class ActiveMQDockerComposeConnectionDetails extends DockerComposeConnectionDetails
+			implements ActiveMQConnectionDetails {
+
+		private final ActiveMQClassicEnvironment environment;
+
+		private final String brokerUrl;
+
+		protected ActiveMQDockerComposeConnectionDetails(RunningService service) {
+			super(service);
+			this.environment = new ActiveMQClassicEnvironment(service.env());
+			this.brokerUrl = "tcp://" + service.host() + ":" + service.ports().get(ACTIVEMQ_PORT);
+		}
+
+		@Override
+		public String getBrokerUrl() {
+			return this.brokerUrl;
+		}
+
+		@Override
+		public String getUser() {
+			return this.environment.getUser();
+		}
+
+		@Override
+		public String getPassword() {
+			return this.environment.getPassword();
+		}
+
+	}
+
+}

spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/activemq/ActiveMQClassicEnvironment.java

@@ -0,0 +1,46 @@
+/*
+ * 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.docker.compose.service.connection.activemq;
+
+import java.util.Map;
+
+/**
+ * ActiveMQ environment details.
+ *
+ * @author Stephane Nicoll
+ * @author Eddú Meléndez
+ */
+class ActiveMQClassicEnvironment {
+
+	private final String user;
+
+	private final String password;
+
+	ActiveMQClassicEnvironment(Map<String, String> env) {
+		this.user = env.get("ACTIVEMQ_CONNECTION_USER");
+		this.password = env.get("ACTIVEMQ_CONNECTION_PASSWORD");
+	}
+
+	String getUser() {
+		return this.user;
+	}
+
+	String getPassword() {
+		return this.password;
+	}
+
+}

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

@@ -5,6 +5,7 @@ org.springframework.boot.docker.compose.service.connection.DockerComposeServiceC
 
 # Connection Details Factories
 org.springframework.boot.autoconfigure.service.connection.ConnectionDetailsFactory=\
+org.springframework.boot.docker.compose.service.connection.activemq.ActiveMQClassicDockerComposeConnectionDetailsFactory,\
 org.springframework.boot.docker.compose.service.connection.activemq.ActiveMQDockerComposeConnectionDetailsFactory,\
 org.springframework.boot.docker.compose.service.connection.activemq.ArtemisDockerComposeConnectionDetailsFactory,\
 org.springframework.boot.docker.compose.service.connection.cassandra.CassandraDockerComposeConnectionDetailsFactory,\

spring-boot-project/spring-boot-docker-compose/src/test/java/org/springframework/boot/docker/compose/service/connection/activemq/ActiveMQClassicDockerComposeConnectionDetailsFactoryIntegrationTests.java

@@ -0,0 +1,48 @@
+/*
+ * 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.docker.compose.service.connection.activemq;
+
+import org.junit.jupiter.api.Test;
+
+import org.springframework.boot.autoconfigure.jms.activemq.ActiveMQConnectionDetails;
+import org.springframework.boot.docker.compose.service.connection.test.AbstractDockerComposeIntegrationTests;
+import org.springframework.boot.testsupport.testcontainers.DockerImageNames;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Integration tests for {@link ActiveMQClassicDockerComposeConnectionDetailsFactory}.
+ *
+ * @author Stephane Nicoll
+ * @author Eddú Meléndez
+ */
+class ActiveMQClassicDockerComposeConnectionDetailsFactoryIntegrationTests
+		extends AbstractDockerComposeIntegrationTests {
+
+	ActiveMQClassicDockerComposeConnectionDetailsFactoryIntegrationTests() {
+		super("activemq-classic-compose.yaml", DockerImageNames.activeMqClassic());
+	}
+
+	@Test
+	void runCreatesConnectionDetails() {
+		ActiveMQConnectionDetails connectionDetails = run(ActiveMQConnectionDetails.class);
+		assertThat(connectionDetails.getBrokerUrl()).isNotNull().startsWith("tcp://");
+		assertThat(connectionDetails.getUser()).isEqualTo("root");
+		assertThat(connectionDetails.getPassword()).isEqualTo("secret");
+	}
+
+}

spring-boot-project/spring-boot-docker-compose/src/test/java/org/springframework/boot/docker/compose/service/connection/activemq/ActiveMQClassicEnvironmentTests.java

@@ -0,0 +1,60 @@
+/*
+ * 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.docker.compose.service.connection.activemq;
+
+import java.util.Collections;
+import java.util.Map;
+
+import org.junit.jupiter.api.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for {@link ActiveMQClassicEnvironment}.
+ *
+ * @author Stephane Nicoll
+ * @author Eddú Meléndez
+ */
+class ActiveMQClassicEnvironmentTests {
+
+	@Test
+	void getUserWhenHasNoActiveMqUser() {
+		ActiveMQClassicEnvironment environment = new ActiveMQClassicEnvironment(Collections.emptyMap());
+		assertThat(environment.getUser()).isNull();
+	}
+
+	@Test
+	void getUserWhenHasActiveMqUser() {
+		ActiveMQClassicEnvironment environment = new ActiveMQClassicEnvironment(
+				Map.of("ACTIVEMQ_CONNECTION_USER", "me"));
+		assertThat(environment.getUser()).isEqualTo("me");
+	}
+
+	@Test
+	void getPasswordWhenHasNoActiveMqPassword() {
+		ActiveMQClassicEnvironment environment = new ActiveMQClassicEnvironment(Collections.emptyMap());
+		assertThat(environment.getPassword()).isNull();
+	}
+
+	@Test
+	void getPasswordWhenHasActiveMqPassword() {
+		ActiveMQClassicEnvironment environment = new ActiveMQClassicEnvironment(
+				Map.of("ACTIVEMQ_CONNECTION_PASSWORD", "secret"));
+		assertThat(environment.getPassword()).isEqualTo("secret");
+	}
+
+}

spring-boot-project/spring-boot-docker-compose/src/test/resources/org/springframework/boot/docker/compose/service/connection/activemq/activemq-classic-compose.yaml

@@ -0,0 +1,8 @@
+services:
+  activemq:
+    image: '{imageName}'
+    ports:
+      - '61616'
+    environment:
+      ACTIVEMQ_CONNECTION_USER: 'root'
+      ACTIVEMQ_CONNECTION_PASSWORD: 'secret'

spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/docker-compose.adoc

@@ -70,7 +70,7 @@ The following service connections are currently supported:
 | Connection Details | Matched on
 
 | `ActiveMQConnectionDetails`
-| Containers named "symptoma/activemq"
+| Containers named "symptoma/activemq", "apache/activemq-classic"
 
 | `ArtemisConnectionDetails`
 | Containers named "apache/activemq-artemis"

spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/testing.adoc

@@ -981,7 +981,7 @@ The following service connection factories are provided in the `spring-boot-test
 | Connection Details | Matched on
 
 | `ActiveMQConnectionDetails`
-| Containers named "symptoma/activemq"
+| Containers named "symptoma/activemq" or `ActiveMQContainer`
 
 | `ArtemisConnectionDetails`
 | Containers of type `ArtemisContainer`

spring-boot-project/spring-boot-testcontainers/src/main/java/org/springframework/boot/testcontainers/service/connection/activemq/ActiveMQClassicContainerConnectionDetailsFactory.java

@@ -0,0 +1,66 @@
+/*
+ * 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.activemq;
+
+import org.testcontainers.activemq.ActiveMQContainer;
+
+import org.springframework.boot.autoconfigure.jms.activemq.ActiveMQConnectionDetails;
+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 ActiveMQConnectionDetails} *
+ * from a {@link ServiceConnection @ServiceConnection}-annotated
+ * {@link ActiveMQContainer}.
+ *
+ * @author Eddú Meléndez
+ */
+class ActiveMQClassicContainerConnectionDetailsFactory
+		extends ContainerConnectionDetailsFactory<ActiveMQContainer, ActiveMQConnectionDetails> {
+
+	@Override
+	protected ActiveMQConnectionDetails getContainerConnectionDetails(
+			ContainerConnectionSource<ActiveMQContainer> source) {
+		return new ActiveMQContainerConnectionDetails(source);
+	}
+
+	private static final class ActiveMQContainerConnectionDetails extends ContainerConnectionDetails<ActiveMQContainer>
+			implements ActiveMQConnectionDetails {
+
+		private ActiveMQContainerConnectionDetails(ContainerConnectionSource<ActiveMQContainer> source) {
+			super(source);
+		}
+
+		@Override
+		public String getBrokerUrl() {
+			return getContainer().getBrokerUrl();
+		}
+
+		@Override
+		public String getUser() {
+			return getContainer().getUser();
+		}
+
+		@Override
+		public String getPassword() {
+			return getContainer().getPassword();
+		}
+
+	}
+
+}

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

@@ -8,6 +8,7 @@ org.springframework.boot.testcontainers.service.connection.ServiceConnectionCont
 
 # Connection Details Factories
 org.springframework.boot.autoconfigure.service.connection.ConnectionDetailsFactory=\
+org.springframework.boot.testcontainers.service.connection.activemq.ActiveMQClassicContainerConnectionDetailsFactory,\
 org.springframework.boot.testcontainers.service.connection.activemq.ActiveMQContainerConnectionDetailsFactory,\
 org.springframework.boot.testcontainers.service.connection.activemq.ArtemisContainerConnectionDetailsFactory,\
 org.springframework.boot.testcontainers.service.connection.amqp.RabbitContainerConnectionDetailsFactory,\

spring-boot-project/spring-boot-testcontainers/src/test/java/org/springframework/boot/testcontainers/service/connection/activemq/ActiveMQClassicContainerConnectionDetailsFactoryIntegrationTests.java

@@ -0,0 +1,91 @@
+/*
+ * 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.activemq;
+
+import java.time.Duration;
+import java.util.ArrayList;
+import java.util.List;
+
+import org.awaitility.Awaitility;
+import org.junit.jupiter.api.Test;
+import org.testcontainers.activemq.ActiveMQContainer;
+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.jms.JmsAutoConfiguration;
+import org.springframework.boot.autoconfigure.jms.activemq.ActiveMQAutoConfiguration;
+import org.springframework.boot.testcontainers.service.connection.ServiceConnection;
+import org.springframework.boot.testsupport.testcontainers.DockerImageNames;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.jms.annotation.JmsListener;
+import org.springframework.jms.core.JmsMessagingTemplate;
+import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for {@link ActiveMQClassicContainerConnectionDetailsFactory}.
+ *
+ * @author Eddú Meléndez
+ */
+@SpringJUnitConfig
+@Testcontainers(disabledWithoutDocker = true)
+class ActiveMQClassicContainerConnectionDetailsFactoryIntegrationTests {
+
+	@Container
+	@ServiceConnection
+	static final ActiveMQContainer activemq = new ActiveMQContainer(DockerImageNames.activeMqClassic());
+
+	@Autowired
+	private JmsMessagingTemplate jmsTemplate;
+
+	@Autowired
+	private TestListener listener;
+
+	@Test
+	void connectionCanBeMadeToActiveMQContainer() {
+		this.jmsTemplate.convertAndSend("sample.queue", "message");
+		Awaitility.waitAtMost(Duration.ofMinutes(1))
+			.untilAsserted(() -> assertThat(this.listener.messages).containsExactly("message"));
+	}
+
+	@Configuration(proxyBeanMethods = false)
+	@ImportAutoConfiguration({ ActiveMQAutoConfiguration.class, JmsAutoConfiguration.class })
+	static class TestConfiguration {
+
+		@Bean
+		TestListener testListener() {
+			return new TestListener();
+		}
+
+	}
+
+	static class TestListener {
+
+		private final List<String> messages = new ArrayList<>();
+
+		@JmsListener(destination = "sample.queue")
+		void processMessage(String message) {
+			this.messages.add(message);
+		}
+
+	}
+
+}

spring-boot-project/spring-boot-tools/spring-boot-test-support/src/main/java/org/springframework/boot/testsupport/testcontainers/DockerImageNames.java

@@ -28,7 +28,7 @@ import org.testcontainers.utility.DockerImageName;
  */
 public final class DockerImageNames {
 
-	private static final String ACTIVE_MQ_VERSION = "5.18.0";
+	private static final String ACTIVE_MQ_VERSION = "5.18.3";
 
 	private static final String ARTEMIS_VERSION = "2.31.2";
 
@@ -83,6 +83,14 @@ public final class DockerImageNames {
 		return DockerImageName.parse("symptoma/activemq").withTag(ACTIVE_MQ_VERSION);
 	}
 
+	/**
+	 * Return a {@link DockerImageName} suitable for running ActiveMQ.
+	 * @return a docker image name for running activeMq
+	 */
+	public static DockerImageName activeMqClassic() {
+		return DockerImageName.parse("apache/activemq-classic").withTag(ACTIVE_MQ_VERSION);
+	}
+
 	/**
 	 * Return a {@link DockerImageName} suitable for running Artemis.
 	 * @return a docker image name for running artemis

spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-activemq/build.gradle

@@ -10,6 +10,7 @@ dependencies {
 
 	testImplementation("org.awaitility:awaitility")
 	testImplementation("org.testcontainers:junit-jupiter")
+	testImplementation("org.testcontainers:activemq")
 	testImplementation(project(":spring-boot-project:spring-boot-starters:spring-boot-starter-test"))
 	testImplementation(project(":spring-boot-project:spring-boot-testcontainers"))
 	testImplementation(project(":spring-boot-project:spring-boot-tools:spring-boot-test-support"))

spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-activemq/src/test/java/smoketest/activemq/SampleActiveMqTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2023 the original author or authors.
+ * 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.
@@ -21,6 +21,7 @@ import java.time.Duration;
 import org.awaitility.Awaitility;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
+import org.testcontainers.activemq.ActiveMQContainer;
 import org.testcontainers.junit.jupiter.Container;
 import org.testcontainers.junit.jupiter.Testcontainers;
 
@@ -29,7 +30,7 @@ import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.boot.test.system.CapturedOutput;
 import org.springframework.boot.test.system.OutputCaptureExtension;
 import org.springframework.boot.testcontainers.service.connection.ServiceConnection;
-import org.springframework.boot.testsupport.testcontainers.ActiveMQContainer;
+import org.springframework.boot.testsupport.testcontainers.DockerImageNames;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
@@ -46,7 +47,7 @@ class SampleActiveMqTests {
 
 	@Container
 	@ServiceConnection
-	private static final ActiveMQContainer container = new ActiveMQContainer();
+	private static final ActiveMQContainer container = new ActiveMQContainer(DockerImageNames.activeMqClassic());
 
 	@Autowired
 	private Producer producer;