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

Update spring-boot-docker-compose to use docker-test plugin

Browse Source 
See gh-41228
This commit is contained in:
Andy Wilkinson
2024-06-25 11:32:53 +01:00
parent 3f1f801461
commit 6fbf08fa9a
50 changed files with 21 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

99
spring-boot-project/spring-boot-testcontainers/src/dockerTest/java/org/springframework/boot/testcontainers/properties/TestcontainersPropertySourceAutoConfigurationTests.java Normal file
View File

@@ -0,0 +1,99 @@
/*
* 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.properties;
import java.util.ArrayList;
import java.util.List;
import org.junit.jupiter.api.Test;
import org.springframework.boot.autoconfigure.AutoConfigurations;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
import org.springframework.boot.testcontainers.lifecycle.TestcontainersLifecycleApplicationContextInitializer;
import org.springframework.boot.testsupport.container.DisabledIfDockerUnavailable;
import org.springframework.boot.testsupport.container.RedisContainer;
import org.springframework.boot.testsupport.container.TestImage;
import org.springframework.context.ApplicationEvent;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import org.springframework.test.context.DynamicPropertyRegistry;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Tests for {@link TestcontainersPropertySourceAutoConfiguration}.
*
* @author Phillip Webb
*/
@DisabledIfDockerUnavailable
class TestcontainersPropertySourceAutoConfigurationTests {
private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
.withInitializer(new TestcontainersLifecycleApplicationContextInitializer())
.withConfiguration(AutoConfigurations.of(TestcontainersPropertySourceAutoConfiguration.class));
@Test
@SuppressWarnings("removal")
void containerBeanMethodContributesProperties() {
List<ApplicationEvent> events = new ArrayList<>();
this.contextRunner.withUserConfiguration(ContainerAndPropertiesConfiguration.class)
.withInitializer((context) -> context.addApplicationListener(events::add))
.run((context) -> {
TestBean testBean = context.getBean(TestBean.class);
RedisContainer redisContainer = context.getBean(RedisContainer.class);
assertThat(testBean.getUsingPort()).isEqualTo(redisContainer.getFirstMappedPort());
assertThat(events.stream().filter(BeforeTestcontainersPropertySuppliedEvent.class::isInstance))
.hasSize(1);
});
}
@Configuration(proxyBeanMethods = false)
@EnableConfigurationProperties(ContainerProperties.class)
@Import(TestBean.class)
static class ContainerAndPropertiesConfiguration {
@Bean
RedisContainer redisContainer(DynamicPropertyRegistry properties) {
RedisContainer container = TestImage.container(RedisContainer.class);
properties.add("container.port", container::getFirstMappedPort);
return container;
}
}
@ConfigurationProperties("container")
record ContainerProperties(int port) {
}
static class TestBean {
private int usingPort;
TestBean(ContainerProperties containerProperties) {
this.usingPort = containerProperties.port();
}
int getUsingPort() {
return this.usingPort;
}
}
}

192
spring-boot-project/spring-boot-testcontainers/src/dockerTest/java/org/springframework/boot/testcontainers/service/connection/ServiceConnectionAutoConfigurationTests.java Normal file
View File

@@ -0,0 +1,192 @@
/*
* 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;
import java.util.Set;
import org.junit.jupiter.api.Test;
import org.mockito.Mockito;
import org.springframework.aot.test.generate.TestGenerationContext;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.beans.factory.support.BeanNameGenerator;
import org.springframework.beans.factory.support.RootBeanDefinition;
import org.springframework.boot.autoconfigure.ImportAutoConfiguration;
import org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration;
import org.springframework.boot.autoconfigure.data.redis.RedisConnectionDetails;
import org.springframework.boot.testcontainers.beans.TestcontainerBeanDefinition;
import org.springframework.boot.testcontainers.lifecycle.TestcontainersLifecycleApplicationContextInitializer;
import org.springframework.boot.testsupport.classpath.ClassPathExclusions;
import org.springframework.boot.testsupport.container.DisabledIfDockerUnavailable;
import org.springframework.boot.testsupport.container.RedisContainer;
import org.springframework.boot.testsupport.container.TestImage;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
import org.springframework.context.aot.ApplicationContextAotGenerator;
import org.springframework.core.annotation.MergedAnnotation;
import org.springframework.core.annotation.MergedAnnotations;
import org.springframework.core.type.AnnotationMetadata;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatNoException;
import static org.mockito.Mockito.mock;
/**
* Tests for {@link ServiceConnectionAutoConfiguration} and
* {@link ServiceConnectionAutoConfigurationRegistrar}.
*
* @author Phillip Webb
*/
@DisabledIfDockerUnavailable
class ServiceConnectionAutoConfigurationTests {
private static final String REDIS_CONTAINER_CONNECTION_DETAILS = "org.springframework.boot.testcontainers.service.connection.redis."
+ "RedisContainerConnectionDetailsFactory$RedisContainerConnectionDetails";
@Test
void whenNoExistingBeansRegistersServiceConnection() {
try (AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext()) {
applicationContext.register(WithNoExtraAutoConfiguration.class, ContainerConfiguration.class);
new TestcontainersLifecycleApplicationContextInitializer().initialize(applicationContext);
applicationContext.refresh();
RedisConnectionDetails connectionDetails = applicationContext.getBean(RedisConnectionDetails.class);
assertThat(connectionDetails.getClass().getName()).isEqualTo(REDIS_CONTAINER_CONNECTION_DETAILS);
}
}
@Test
void whenHasExistingAutoConfigurationRegistersReplacement() {
try (AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext()) {
applicationContext.register(WithRedisAutoConfiguration.class, ContainerConfiguration.class);
new TestcontainersLifecycleApplicationContextInitializer().initialize(applicationContext);
applicationContext.refresh();
RedisConnectionDetails connectionDetails = applicationContext.getBean(RedisConnectionDetails.class);
assertThat(connectionDetails.getClass().getName()).isEqualTo(REDIS_CONTAINER_CONNECTION_DETAILS);
}
}
@Test
@ClassPathExclusions("lettuce-core-*.jar")
void whenHasUserConfigurationDoesNotRegisterReplacement() {
try (AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext()) {
applicationContext.register(UserConfiguration.class, WithRedisAutoConfiguration.class,
ContainerConfiguration.class);
new TestcontainersLifecycleApplicationContextInitializer().initialize(applicationContext);
applicationContext.refresh();
RedisConnectionDetails connectionDetails = applicationContext.getBean(RedisConnectionDetails.class);
assertThat(Mockito.mockingDetails(connectionDetails).isMock()).isTrue();
}
}
@Test
void whenHasTestcontainersBeanDefinition() {
try (AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext()) {
applicationContext.register(WithNoExtraAutoConfiguration.class,
TestcontainerBeanDefinitionConfiguration.class);
new TestcontainersLifecycleApplicationContextInitializer().initialize(applicationContext);
applicationContext.refresh();
RedisConnectionDetails connectionDetails = applicationContext.getBean(RedisConnectionDetails.class);
assertThat(connectionDetails.getClass().getName()).isEqualTo(REDIS_CONTAINER_CONNECTION_DETAILS);
}
}
@Test
void serviceConnectionBeansDoNotCauseAotProcessingToFail() {
try (AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext()) {
applicationContext.register(WithNoExtraAutoConfiguration.class, ContainerConfiguration.class);
new TestcontainersLifecycleApplicationContextInitializer().initialize(applicationContext);
TestGenerationContext generationContext = new TestGenerationContext();
assertThatNoException().isThrownBy(() -> new ApplicationContextAotGenerator()
.processAheadOfTime(applicationContext, generationContext));
}
}
@Configuration(proxyBeanMethods = false)
@ImportAutoConfiguration(ServiceConnectionAutoConfiguration.class)
static class WithNoExtraAutoConfiguration {
}
@Configuration(proxyBeanMethods = false)
@ImportAutoConfiguration({ ServiceConnectionAutoConfiguration.class, RedisAutoConfiguration.class })
static class WithRedisAutoConfiguration {
}
@Configuration(proxyBeanMethods = false)
static class ContainerConfiguration {
@Bean
@ServiceConnection("redis")
RedisContainer redisContainer() {
return TestImage.container(RedisContainer.class);
}
}
@Configuration(proxyBeanMethods = false)
static class UserConfiguration {
@Bean
RedisConnectionDetails redisConnectionDetails() {
return mock(RedisConnectionDetails.class);
}
}
@Configuration(proxyBeanMethods = false)
@Import(TestcontainerBeanDefinitionRegistrar.class)
static class TestcontainerBeanDefinitionConfiguration {
}
static class TestcontainerBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {
@Override
public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry,
BeanNameGenerator importBeanNameGenerator) {
registry.registerBeanDefinition("redisContainer", new TestcontainersRootBeanDefinition());
}
}
static class TestcontainersRootBeanDefinition extends RootBeanDefinition implements TestcontainerBeanDefinition {
private final RedisContainer container = TestImage.container(RedisContainer.class);
TestcontainersRootBeanDefinition() {
setBeanClass(RedisContainer.class);
setInstanceSupplier(() -> this.container);
}
@Override
public String getContainerImageName() {
return this.container.getDockerImageName();
}
@Override
public MergedAnnotations getAnnotations() {
MergedAnnotation<ServiceConnection> annotation = MergedAnnotation.of(ServiceConnection.class);
return MergedAnnotations.of(Set.of(annotation));
}
}
}