Prevent early initialization of Container beans
Update testcontainers auto-configuration so that `Container` bean instances are no longer needed when registering `ConnectionDetails` beans. Registration now occurs based on the bean type and the `name` attribute of `@ServiceConnection`. Fixes gh-35168pull/35165/head
Phillip Webb
2 years ago
parent
c21cf31853
commit
b4cd2572d5
@ -0,0 +1,105 @@
|
||||
/*
|
||||
* 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.testcontainers.service.connection;
|
||||
|
||||
import java.util.Map;
|
||||
|
||||
import org.junit.jupiter.api.BeforeEach;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.testcontainers.containers.PostgreSQLContainer;
|
||||
|
||||
import org.springframework.beans.factory.support.DefaultListableBeanFactory;
|
||||
import org.springframework.beans.factory.support.RootBeanDefinition;
|
||||
import org.springframework.boot.autoconfigure.service.connection.ConnectionDetails;
|
||||
import org.springframework.boot.autoconfigure.service.connection.ConnectionDetailsFactories;
|
||||
import org.springframework.boot.autoconfigure.service.connection.ConnectionDetailsFactoryNotFoundException;
|
||||
import org.springframework.boot.origin.Origin;
|
||||
import org.springframework.core.annotation.MergedAnnotation;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
|
||||
import static org.mockito.BDDMockito.given;
|
||||
import static org.mockito.Mockito.mock;
|
||||
|
||||
/**
|
||||
* Tests for {@link ConnectionDetailsRegistrar}.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
*/
|
||||
class ConnectionDetailsRegistrarTests {
|
||||
|
||||
private Origin origin;
|
||||
|
||||
private PostgreSQLContainer<?> container;
|
||||
|
||||
private MergedAnnotation<ServiceConnection> annotation;
|
||||
|
||||
private ContainerConnectionSource<?> source;
|
||||
|
||||
private ConnectionDetailsFactories factories;
|
||||
|
||||
@BeforeEach
|
||||
void setup() {
|
||||
this.origin = mock(Origin.class);
|
||||
this.container = mock(PostgreSQLContainer.class);
|
||||
this.annotation = MergedAnnotation.of(ServiceConnection.class, Map.of("name", "", "type", new Class<?>[0]));
|
||||
this.source = new ContainerConnectionSource<>("test", this.origin, PostgreSQLContainer.class, null,
|
||||
this.annotation, () -> this.container);
|
||||
this.factories = mock(ConnectionDetailsFactories.class);
|
||||
}
|
||||
|
||||
@Test
|
||||
void registerBeanDefinitionsWhenConnectionDetailsFactoryNotFoundAndNoConnectionNameThrowsExceptionWithBetterMessage() {
|
||||
DefaultListableBeanFactory beanFactory = new DefaultListableBeanFactory();
|
||||
ConnectionDetailsRegistrar registrar = new ConnectionDetailsRegistrar(beanFactory, this.factories);
|
||||
given(this.factories.getConnectionDetails(this.source, true))
|
||||
.willThrow(new ConnectionDetailsFactoryNotFoundException("fail"));
|
||||
assertThatExceptionOfType(ConnectionDetailsFactoryNotFoundException.class)
|
||||
.isThrownBy(() -> registrar.registerBeanDefinitions(beanFactory, this.source))
|
||||
.withMessage("fail. You may need to add a 'name' to your @ServiceConnection annotation");
|
||||
}
|
||||
|
||||
@Test
|
||||
void registerBeanDefinitionsWhenExistingBeanSkipsRegistration() {
|
||||
DefaultListableBeanFactory beanFactory = new DefaultListableBeanFactory();
|
||||
beanFactory.registerBeanDefinition("testbean", new RootBeanDefinition(CustomTestConnectionDetails.class));
|
||||
ConnectionDetailsRegistrar registrar = new ConnectionDetailsRegistrar(beanFactory, this.factories);
|
||||
given(this.factories.getConnectionDetails(this.source, true))
|
||||
.willReturn(Map.of(TestConnectionDetails.class, new TestConnectionDetails()));
|
||||
registrar.registerBeanDefinitions(beanFactory, this.source);
|
||||
assertThat(beanFactory.getBean(TestConnectionDetails.class)).isInstanceOf(CustomTestConnectionDetails.class);
|
||||
}
|
||||
|
||||
@Test
|
||||
void registerBeanDefinitionsRegistersDefinition() {
|
||||
DefaultListableBeanFactory beanFactory = new DefaultListableBeanFactory();
|
||||
ConnectionDetailsRegistrar registrar = new ConnectionDetailsRegistrar(beanFactory, this.factories);
|
||||
given(this.factories.getConnectionDetails(this.source, true))
|
||||
.willReturn(Map.of(TestConnectionDetails.class, new TestConnectionDetails()));
|
||||
registrar.registerBeanDefinitions(beanFactory, this.source);
|
||||
assertThat(beanFactory.getBean(TestConnectionDetails.class)).isNotNull();
|
||||
}
|
||||
|
||||
static class TestConnectionDetails implements ConnectionDetails {
|
||||
|
||||
}
|
||||
|
||||
static class CustomTestConnectionDetails extends TestConnectionDetails {
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
Loading…
Reference in New Issue