mirror of
https://github.com/spring-projects/spring-boot.git
synced 2024-08-29 03:06:45 +08:00
Polish "Add service connection for Testcontainers ActiveMQ"
This also adds support for Docker Compose. See gh-35080
This commit is contained in:
parent
63121dd08a
commit
311fa6272d
@ -22,14 +22,27 @@ import org.springframework.boot.autoconfigure.service.connection.ConnectionDetai
|
|||||||
* Details required to establish a connection to an ActiveMQ service.
|
* Details required to establish a connection to an ActiveMQ service.
|
||||||
*
|
*
|
||||||
* @author Eddú Meléndez
|
* @author Eddú Meléndez
|
||||||
* @since 3.1.0
|
* @author Stephane Nicoll
|
||||||
|
* @since 3.2.0
|
||||||
*/
|
*/
|
||||||
public interface ActiveMQConnectionDetails extends ConnectionDetails {
|
public interface ActiveMQConnectionDetails extends ConnectionDetails {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Broker URL to use.
|
||||||
|
* @return the url of the broker
|
||||||
|
*/
|
||||||
String getBrokerUrl();
|
String getBrokerUrl();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Login user to authenticate to the broker.
|
||||||
|
* @return the login user to authenticate to the broker or {@code null}
|
||||||
|
*/
|
||||||
String getUser();
|
String getUser();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Login to authenticate against the broker.
|
||||||
|
* @return the login to authenticate against the broker or {@code null}
|
||||||
|
*/
|
||||||
String getPassword();
|
String getPassword();
|
||||||
|
|
||||||
}
|
}
|
||||||
|
@ -0,0 +1,79 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2012-2023 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.amqp.RabbitConnectionDetails;
|
||||||
|
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
|
||||||
|
*/
|
||||||
|
class ActiveMQDockerComposeConnectionDetailsFactory
|
||||||
|
extends DockerComposeConnectionDetailsFactory<ActiveMQConnectionDetails> {
|
||||||
|
|
||||||
|
private static final int ACTIVEMQ_PORT = 61616;
|
||||||
|
|
||||||
|
protected ActiveMQDockerComposeConnectionDetailsFactory() {
|
||||||
|
super("symptoma/activemq");
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
protected ActiveMQConnectionDetails getDockerComposeConnectionDetails(DockerComposeConnectionSource source) {
|
||||||
|
return new ActiveMQDockerComposeConnectionDetails(source.getRunningService());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* {@link RabbitConnectionDetails} backed by a {@code rabbitmq}
|
||||||
|
* {@link RunningService}.
|
||||||
|
*/
|
||||||
|
static class ActiveMQDockerComposeConnectionDetails extends DockerComposeConnectionDetails
|
||||||
|
implements ActiveMQConnectionDetails {
|
||||||
|
|
||||||
|
private final ActiveMQEnvironment environment;
|
||||||
|
|
||||||
|
private final String brokerUrl;
|
||||||
|
|
||||||
|
protected ActiveMQDockerComposeConnectionDetails(RunningService service) {
|
||||||
|
super(service);
|
||||||
|
this.environment = new ActiveMQEnvironment(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();
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@ -0,0 +1,45 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2012-2023 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
|
||||||
|
*/
|
||||||
|
class ActiveMQEnvironment {
|
||||||
|
|
||||||
|
private final String user;
|
||||||
|
|
||||||
|
private final String password;
|
||||||
|
|
||||||
|
ActiveMQEnvironment(Map<String, String> env) {
|
||||||
|
this.user = env.get("ACTIVEMQ_USERNAME");
|
||||||
|
this.password = env.get("ACTIVEMQ_PASSWORD");
|
||||||
|
}
|
||||||
|
|
||||||
|
String getUser() {
|
||||||
|
return this.user;
|
||||||
|
}
|
||||||
|
|
||||||
|
String getPassword() {
|
||||||
|
return this.password;
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@ -0,0 +1,20 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2012-2023 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.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Auto-configuration for docker compose ActiveMQ service connections.
|
||||||
|
*/
|
||||||
|
package org.springframework.boot.docker.compose.service.connection.activemq;
|
@ -5,6 +5,7 @@ org.springframework.boot.docker.compose.service.connection.DockerComposeServiceC
|
|||||||
|
|
||||||
# Connection Details Factories
|
# Connection Details Factories
|
||||||
org.springframework.boot.autoconfigure.service.connection.ConnectionDetailsFactory=\
|
org.springframework.boot.autoconfigure.service.connection.ConnectionDetailsFactory=\
|
||||||
|
org.springframework.boot.docker.compose.service.connection.activemq.ActiveMQDockerComposeConnectionDetailsFactory,\
|
||||||
org.springframework.boot.docker.compose.service.connection.cassandra.CassandraDockerComposeConnectionDetailsFactory,\
|
org.springframework.boot.docker.compose.service.connection.cassandra.CassandraDockerComposeConnectionDetailsFactory,\
|
||||||
org.springframework.boot.docker.compose.service.connection.elasticsearch.ElasticsearchDockerComposeConnectionDetailsFactory,\
|
org.springframework.boot.docker.compose.service.connection.elasticsearch.ElasticsearchDockerComposeConnectionDetailsFactory,\
|
||||||
org.springframework.boot.docker.compose.service.connection.flyway.JdbcAdaptingFlywayConnectionDetailsFactory,\
|
org.springframework.boot.docker.compose.service.connection.flyway.JdbcAdaptingFlywayConnectionDetailsFactory,\
|
||||||
|
@ -0,0 +1,45 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2012-2023 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 static org.assertj.core.api.Assertions.assertThat;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Integration tests for {@link ActiveMQDockerComposeConnectionDetailsFactory}.
|
||||||
|
*
|
||||||
|
* @author Stephane Nicoll
|
||||||
|
*/
|
||||||
|
class ActiveMQDockerComposeConnectionDetailsFactoryIntegrationTests extends AbstractDockerComposeIntegrationTests {
|
||||||
|
|
||||||
|
ActiveMQDockerComposeConnectionDetailsFactoryIntegrationTests() {
|
||||||
|
super("activemq-compose.yaml");
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void runCreatesConnectionDetails() {
|
||||||
|
ActiveMQConnectionDetails connectionDetails = run(ActiveMQConnectionDetails.class);
|
||||||
|
assertThat(connectionDetails.getBrokerUrl()).isNotNull().startsWith("tcp://");
|
||||||
|
assertThat(connectionDetails.getUser()).isEqualTo("root");
|
||||||
|
assertThat(connectionDetails.getPassword()).isEqualTo("secret");
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@ -0,0 +1,57 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2012-2023 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 ActiveMQEnvironment}.
|
||||||
|
*
|
||||||
|
* @author Stephane Nicoll
|
||||||
|
*/
|
||||||
|
class ActiveMQEnvironmentTests {
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void getUserWhenHasNoActiveMqUser() {
|
||||||
|
ActiveMQEnvironment environment = new ActiveMQEnvironment(Collections.emptyMap());
|
||||||
|
assertThat(environment.getUser()).isNull();
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void getUserWhenHasActiveMqUser() {
|
||||||
|
ActiveMQEnvironment environment = new ActiveMQEnvironment(Map.of("ACTIVEMQ_USERNAME", "me"));
|
||||||
|
assertThat(environment.getUser()).isEqualTo("me");
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void getPasswordWhenHasNoActiveMqPassword() {
|
||||||
|
ActiveMQEnvironment environment = new ActiveMQEnvironment(Collections.emptyMap());
|
||||||
|
assertThat(environment.getPassword()).isNull();
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void getPasswordWhenHasActiveMqPassword() {
|
||||||
|
ActiveMQEnvironment environment = new ActiveMQEnvironment(Map.of("ACTIVEMQ_PASSWORD", "secret"));
|
||||||
|
assertThat(environment.getPassword()).isEqualTo("secret");
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@ -0,0 +1,8 @@
|
|||||||
|
services:
|
||||||
|
activemq:
|
||||||
|
image: 'symptoma/activemq:5.18.0'
|
||||||
|
ports:
|
||||||
|
- '61616'
|
||||||
|
environment:
|
||||||
|
ACTIVEMQ_USERNAME: 'root'
|
||||||
|
ACTIVEMQ_PASSWORD: 'secret'
|
@ -58,6 +58,9 @@ The following service connections are currently supported:
|
|||||||
|===
|
|===
|
||||||
| Connection Details | Matched on
|
| Connection Details | Matched on
|
||||||
|
|
||||||
|
| `ActiveMQConnectionDetails`
|
||||||
|
| Containers named "symptoma/activemq"
|
||||||
|
|
||||||
| `CassandraConnectionDetails`
|
| `CassandraConnectionDetails`
|
||||||
| Containers named "cassandra"
|
| Containers named "cassandra"
|
||||||
|
|
||||||
|
@ -16,8 +16,6 @@
|
|||||||
|
|
||||||
package org.springframework.boot.testcontainers.service.connection.activemq;
|
package org.springframework.boot.testcontainers.service.connection.activemq;
|
||||||
|
|
||||||
import java.util.Map;
|
|
||||||
|
|
||||||
import org.testcontainers.containers.Container;
|
import org.testcontainers.containers.Container;
|
||||||
import org.testcontainers.containers.GenericContainer;
|
import org.testcontainers.containers.GenericContainer;
|
||||||
|
|
||||||
@ -34,7 +32,7 @@ import org.springframework.boot.testcontainers.service.connection.ServiceConnect
|
|||||||
* @author Eddú Meléndez
|
* @author Eddú Meléndez
|
||||||
*/
|
*/
|
||||||
class ActiveMQContainerConnectionDetailsFactory
|
class ActiveMQContainerConnectionDetailsFactory
|
||||||
extends ContainerConnectionDetailsFactory<ActiveMQConnectionDetails, Container<?>> {
|
extends ContainerConnectionDetailsFactory<Container<?>, ActiveMQConnectionDetails> {
|
||||||
|
|
||||||
ActiveMQContainerConnectionDetailsFactory() {
|
ActiveMQContainerConnectionDetailsFactory() {
|
||||||
super("symptoma/activemq");
|
super("symptoma/activemq");
|
||||||
@ -45,33 +43,26 @@ class ActiveMQContainerConnectionDetailsFactory
|
|||||||
return new ActiveMQContainerConnectionDetails(source);
|
return new ActiveMQContainerConnectionDetails(source);
|
||||||
}
|
}
|
||||||
|
|
||||||
private static final class ActiveMQContainerConnectionDetails extends ContainerConnectionDetails
|
private static final class ActiveMQContainerConnectionDetails extends ContainerConnectionDetails<Container<?>>
|
||||||
implements ActiveMQConnectionDetails {
|
implements ActiveMQConnectionDetails {
|
||||||
|
|
||||||
private final String brokerUrl;
|
|
||||||
|
|
||||||
private final Map<String, String> envVars;
|
|
||||||
|
|
||||||
private ActiveMQContainerConnectionDetails(ContainerConnectionSource<Container<?>> source) {
|
private ActiveMQContainerConnectionDetails(ContainerConnectionSource<Container<?>> source) {
|
||||||
super(source);
|
super(source);
|
||||||
this.brokerUrl = "tcp://" + source.getContainer().getHost() + ":"
|
|
||||||
+ source.getContainer().getFirstMappedPort();
|
|
||||||
this.envVars = source.getContainer().getEnvMap();
|
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public String getBrokerUrl() {
|
public String getBrokerUrl() {
|
||||||
return this.brokerUrl;
|
return "tcp://" + getContainer().getHost() + ":" + getContainer().getFirstMappedPort();
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public String getUser() {
|
public String getUser() {
|
||||||
return this.envVars.get("ACTIVEMQ_USERNAME");
|
return getContainer().getEnvMap().get("ACTIVEMQ_USERNAME");
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public String getPassword() {
|
public String getPassword() {
|
||||||
return this.envVars.get("ACTIVEMQ_PASSWORD");
|
return getContainer().getEnvMap().get("ACTIVEMQ_PASSWORD");
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
@ -9,7 +9,6 @@ dependencies {
|
|||||||
implementation(project(":spring-boot-project:spring-boot-starters:spring-boot-starter-activemq"))
|
implementation(project(":spring-boot-project:spring-boot-starters:spring-boot-starter-activemq"))
|
||||||
|
|
||||||
testImplementation("org.awaitility:awaitility")
|
testImplementation("org.awaitility:awaitility")
|
||||||
testImplementation("org.testcontainers:testcontainers")
|
|
||||||
testImplementation("org.testcontainers:junit-jupiter")
|
testImplementation("org.testcontainers:junit-jupiter")
|
||||||
testImplementation(project(":spring-boot-project:spring-boot-starters:spring-boot-starter-test"))
|
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-testcontainers"))
|
||||||
|
Loading…
Reference in New Issue
Block a user