Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Move Docker-related test support into a separate module

Browse Source 
See gh-41228
This commit is contained in:
Andy Wilkinson
2024-06-26 11:10:16 +01:00
parent fda6f19c5b
commit 654016af7f
38 changed files with 86 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
spring-boot-project/spring-boot-tools/spring-boot-test-support/src/main/java/org/springframework/boot/testsupport/container/ActiveMQContainer.java
View File

@@ -1,36 +0,0 @@
/*
* 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.testsupport.container;
import org.testcontainers.containers.GenericContainer;
import org.testcontainers.utility.DockerImageName;
/**
* A {@link GenericContainer} for ActiveMQ.
*
* @author Stephane Nicoll
*/
public final class ActiveMQContainer extends GenericContainer<ActiveMQContainer> {
private static final int DEFAULT_PORT = 61616;
public ActiveMQContainer(DockerImageName dockerImageName) {
super(dockerImageName);
addExposedPorts(DEFAULT_PORT);
}
}

39
spring-boot-project/spring-boot-tools/spring-boot-test-support/src/main/java/org/springframework/boot/testsupport/container/DisabledIfDockerUnavailable.java
View File

@@ -1,39 +0,0 @@
/*
* 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.testsupport.container;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.junit.jupiter.api.extension.ExtendWith;
/**
* Disables test execution if Docker is unavailable.
*
* @author Andy Wilkinson
* @author Phillip Webb
*/
@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@ExtendWith(DisabledIfDockerUnavailableCondition.class)
public @interface DisabledIfDockerUnavailable {
}

57
spring-boot-project/spring-boot-tools/spring-boot-test-support/src/main/java/org/springframework/boot/testsupport/container/DisabledIfDockerUnavailableCondition.java
View File

@@ -1,57 +0,0 @@
/*
* 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.testsupport.container;
import org.junit.jupiter.api.extension.ConditionEvaluationResult;
import org.junit.jupiter.api.extension.ExecutionCondition;
import org.junit.jupiter.api.extension.ExtensionContext;
import org.testcontainers.DockerClientFactory;
/**
* An {@link ExecutionCondition} that disables execution if Docker is unavailable.
*
* @author Andy Wilkinson
* @author Phillip Webb
* @author Moritz Halbritter
*/
class DisabledIfDockerUnavailableCondition implements ExecutionCondition {
private static final String SILENCE_PROPERTY = "visibleassertions.silence";
private static final ConditionEvaluationResult ENABLED = ConditionEvaluationResult.enabled("Docker available");
@Override
public ConditionEvaluationResult evaluateExecutionCondition(ExtensionContext context) {
String originalSilenceValue = System.getProperty(SILENCE_PROPERTY);
try {
DockerClientFactory.instance().client();
return ENABLED;
}
catch (Throwable ex) {
return ConditionEvaluationResult.disabled("Docker unavailable", ex.getMessage());
}
finally {
if (originalSilenceValue != null) {
System.setProperty(SILENCE_PROPERTY, originalSilenceValue);
}
else {
System.clearProperty(SILENCE_PROPERTY);
}
}
}
}

35
spring-boot-project/spring-boot-tools/spring-boot-test-support/src/main/java/org/springframework/boot/testsupport/container/RedisContainer.java
View File

@@ -1,35 +0,0 @@
/*
* 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.testsupport.container;
import org.testcontainers.containers.GenericContainer;
import org.testcontainers.utility.DockerImageName;
/**
* A {@link GenericContainer} for Redis.
*
* @author Andy Wilkinson
* @author Madhura Bhave
*/
public class RedisContainer extends GenericContainer<RedisContainer> {
public RedisContainer(DockerImageName dockerImageName) {
super(dockerImageName);
addExposedPorts(6379);
}
}

35
spring-boot-project/spring-boot-tools/spring-boot-test-support/src/main/java/org/springframework/boot/testsupport/container/RegistryContainer.java
View File

@@ -1,35 +0,0 @@
/*
* 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.testsupport.container;
import org.testcontainers.containers.GenericContainer;
import org.testcontainers.utility.DockerImageName;
/**
* A {@link GenericContainer} for Docker Registry.
*
* @author Phillip Webb
*/
public class RegistryContainer extends GenericContainer<RegistryContainer> {
public RegistryContainer(DockerImageName dockerImageName) {
super(dockerImageName);
addExposedPorts(5000);
addEnv("SERVER_NAME", "localhost");
}
}

272
spring-boot-project/spring-boot-tools/spring-boot-test-support/src/main/java/org/springframework/boot/testsupport/container/TestImage.java
View File

@@ -1,272 +0,0 @@
/*
* 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.testsupport.container;
import java.lang.reflect.Constructor;
import java.time.Duration;
import java.util.Arrays;
import java.util.List;
import java.util.function.Consumer;
import java.util.function.Supplier;
import org.testcontainers.containers.CassandraContainer;
import org.testcontainers.containers.Container;
import org.testcontainers.containers.GenericContainer;
import org.testcontainers.containers.KafkaContainer;
import org.testcontainers.containers.MongoDBContainer;
import org.testcontainers.containers.Neo4jContainer;
import org.testcontainers.containers.PostgreSQLContainer;
import org.testcontainers.containers.PulsarContainer;
import org.testcontainers.containers.RabbitMQContainer;
import org.testcontainers.couchbase.CouchbaseContainer;
import org.testcontainers.elasticsearch.ElasticsearchContainer;
import org.testcontainers.redpanda.RedpandaContainer;
import org.testcontainers.utility.DockerImageName;
import org.springframework.util.Assert;
/**
* References to container images used for integration tests. This class also acts a a
* central location for tests to {@link #container(Class) create} a correctly configured
* {@link Container testcontainer}.
*
* @author Stephane Nicoll
* @author Eddú Meléndez
* @author Moritz Halbritter
* @author Chris Bono
* @author Phillip Webb
*/
public enum TestImage {
/**
* A container image suitable for testing ActiveMQ.
*/
ACTIVE_MQ("symptoma/activemq", "5.18.0", () -> ActiveMQContainer.class),
/**
* A container image suitable for testing Cassandra.
*/
CASSANDRA("cassandra", "3.11.10", () -> CassandraContainer.class,
(container) -> ((CassandraContainer<?>) container).withStartupTimeout(Duration.ofMinutes(10))),
/**
* A Docker image suitable for running.
*/
COUCHBASE("couchbase/server", "7.1.4", () -> CouchbaseContainer.class,
(container) -> ((CouchbaseContainer) container).withStartupAttempts(5)
.withStartupTimeout(Duration.ofMinutes(10))),
/**
* A Docker image suitable for Elasticsearch 7.
*/
ELASTICSEARCH("docker.elastic.co/elasticsearch/elasticsearch", "7.17.5", () -> ElasticsearchContainer.class,
(container) -> ((ElasticsearchContainer) container).withEnv("ES_JAVA_OPTS", "-Xms32m -Xmx512m")
.withStartupAttempts(5)
.withStartupTimeout(Duration.ofMinutes(10))),
/**
* A container image suitable for testing Elasticsearch 8.
*/
ELASTICSEARCH_8("elasticsearch", "8.6.1"),
/**
* A container image suitable for testing Kafka.
*/
KAFKA("confluentinc/cp-kafka", "7.4.0", () -> KafkaContainer.class),
/**
* A container image suitable for testing MariaDB.
*/
MARIADB("mariadb", "10.10"),
/**
* A Docker image suitable for MongoDB.
*/
MONGODB("mongo", "5.0.17", () -> MongoDBContainer.class,
(container) -> ((MongoDBContainer) container).withStartupAttempts(5)
.withStartupTimeout(Duration.ofMinutes(5))),
/**
* A container image suitable for testing MySQL.
*/
MYSQL("mysql", "8.0"),
/**
* A container image suitable for testing Neo4j.
*/
NEO4J("neo4j", "4.4.11", () -> Neo4jContainer.class,
(container) -> ((Neo4jContainer<?>) container).withStartupAttempts(5)
.withStartupTimeout(Duration.ofMinutes(10))),
/**
* A container image suitable for testing Oracle Free.
*/
ORACLE_FREE("gvenzl/oracle-free", "23.3-slim", () -> org.testcontainers.oracle.OracleContainer.class,
(container) -> ((org.testcontainers.oracle.OracleContainer) container)
.withStartupTimeout(Duration.ofMinutes(2))),
/**
* A container image suitable for testing Oracle XA.
*/
ORACLE_XE("gvenzl/oracle-xe", "18.4.0-slim", () -> org.testcontainers.containers.OracleContainer.class,
(container) -> ((org.testcontainers.containers.OracleContainer) container)
.withStartupTimeout(Duration.ofMinutes(2))),
/**
* A container image suitable for testing Opentelemetry.
*/
OPENTELEMETRY("otel/opentelemetry-collector-contrib", "0.75.0"),
/**
* A container image suitable for testing Postgres.
*/
POSTGRESQL("postgres", "14.0", () -> PostgreSQLContainer.class),
/**
* A container image suitable for testing Pulsar.
*/
PULSAR("apachepulsar/pulsar", "3.1.0", () -> PulsarContainer.class,
(container) -> ((PulsarContainer) container).withStartupAttempts(2)
.withStartupTimeout(Duration.ofMinutes(3))),
/**
* A container image suitable for testing RabbitMQ.
*/
RABBITMQ("rabbitmq", "3.11-alpine", () -> RabbitMQContainer.class,
(container) -> ((RabbitMQContainer) container).withStartupTimeout(Duration.ofMinutes(4))),
/**
* A container image suitable for testing Redis.
*/
REDIS("redis", "7.0.11", () -> RedisContainer.class,
(container) -> ((RedisContainer) container).withStartupAttempts(5)
.withStartupTimeout(Duration.ofMinutes(10))),
/**
* A container image suitable for testing Redpanda.
*/
REDPANDA("redpandadata/redpanda", "v23.1.2", () -> RedpandaContainer.class,
(container) -> ((RedpandaContainer) container).withStartupTimeout(Duration.ofMinutes(5))),
/**
* A container image suitable for testing a Docker registry.
*/
REGISTRY("registry", "2.7.1", () -> RegistryContainer.class,
(container) -> ((RegistryContainer) container).withStartupAttempts(5)
.withStartupTimeout(Duration.ofMinutes(3))),
/**
* A container image suitable for testing MS SQL Server.
*/
SQL_SERVER("mcr.microsoft.com/mssql/server"),
/**
* A container image suitable for testing Zipkin.
*/
ZIPKIN("openzipkin/zipkin", "2.24.1", () -> ZipkinContainer.class);
private final String name;
private final String tag;
private final Class<?> containerClass;
private final Consumer<?> containerSetup;
TestImage(String name) {
this(name, null);
}
TestImage(String name, String tag) {
this(name, tag, null, null);
}
TestImage(String name, String tag, Supplier<Class<?>> containerClass) {
this(name, tag, containerClass, null);
}
TestImage(String name, String tag, Supplier<Class<?>> containerClass, Consumer<?> containerSetup) {
this.name = name;
this.tag = tag;
this.containerClass = getIfPossible(containerClass);
this.containerSetup = containerSetup;
}
static Class<?> getIfPossible(Supplier<Class<?>> supplier) {
try {
return (supplier != null) ? supplier.get() : null;
}
catch (NoClassDefFoundError ex) {
return null;
}
}
private boolean matchesContainerClass(Class<?> containerClass) {
return this.containerClass != null && this.containerClass.isAssignableFrom(containerClass);
}
/**
* Create a {@link GenericContainer} for the given {@link TestImage}.
* @return a generic container for the test image
*/
public GenericContainer<?> genericContainer() {
return createContainer(GenericContainer.class);
}
@SuppressWarnings({ "rawtypes", "unchecked" })
private <C extends Container<?>> C createContainer(Class<C> containerClass) {
DockerImageName dockerImageName = DockerImageName.parse(toString());
try {
Constructor<C> constructor = containerClass.getDeclaredConstructor(DockerImageName.class);
constructor.setAccessible(true);
C container = constructor.newInstance(dockerImageName);
if (this.containerSetup != null) {
((Consumer) this.containerSetup).accept(container);
}
return container;
}
catch (Exception ex) {
throw new IllegalStateException("Unable to create container " + containerClass, ex);
}
}
@Override
public String toString() {
return (this.tag != null) ? this.name + ":" + this.tag : this.name;
}
/**
* Factory method to create and configure a {@link Container} using a deduced
* {@link TestImage}.
* @param <C> the container type
* @param containerClass the container type
* @return a container instance
*/
public static <C extends Container<?>> C container(Class<C> containerClass) {
return forContainerClass(containerClass).createContainer(containerClass);
}
private static TestImage forContainerClass(Class<?> containerClass) {
List<TestImage> images = Arrays.stream(values())
.filter((image) -> image.matchesContainerClass(containerClass))
.toList();
Assert.state(!images.isEmpty(), () -> "Unknown container class " + containerClass);
Assert.state(images.size() == 1, () -> "Multiple test images match container class " + containerClass);
return images.get(0);
}
}

34
spring-boot-project/spring-boot-tools/spring-boot-test-support/src/main/java/org/springframework/boot/testsupport/container/ZipkinContainer.java
View File

@@ -1,34 +0,0 @@
/*
* 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.testsupport.container;
import org.testcontainers.containers.GenericContainer;
import org.testcontainers.utility.DockerImageName;
/**
* A {@link GenericContainer} for Zipkin.
*
* @author Phillip Webb
*/
public class ZipkinContainer extends GenericContainer<ZipkinContainer> {
public ZipkinContainer(DockerImageName dockerImageName) {
super(dockerImageName);
withExposedPorts(9411);
}
}

20
spring-boot-project/spring-boot-tools/spring-boot-test-support/src/main/java/org/springframework/boot/testsupport/container/package-info.java
View File

@@ -1,20 +0,0 @@
/*
* 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 testing with Testcontainers.
*/
package org.springframework.boot.testsupport.container;