Spring/spring-boot
Spring/spring-boot
1
0
Fork 0
mirror of https://github.com/spring-projects/spring-boot.git synced 2024-08-29 03:06:45 +08:00
Code Issues Packages Projects Releases Wiki Activity

Implement ServiceConnectionContextCustomizer equals and hashcode for key

Browse Source 
Update `ServiceConnectionContextCustomizer` with `equals` and `hashcode`
methods so that it works correctly when part of a context cache key.

Closes gh-35216
This commit is contained in:
Phillip Webb 2023-05-01 21:51:40 -07:00
parent 25e3291d86
commit 632c5d7ea5
3 changed files with 88 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
spring-boot-project/spring-boot-testcontainers/src/main/java/org/springframework/boot/testcontainers/service/connection/ContainerConnectionSource.java
View File

@ -136,6 +136,10 @@ public final class ContainerConnectionSource<C extends Container<?>> implements
return this.containerSupplier;
}
Set<Class<?>> getConnectionDetailsTypes() {
return this.connectionDetailsTypes;
}
@Override
public String toString() {
return "@ServiceConnection source for %s".formatted(this.origin);

36
spring-boot-project/spring-boot-testcontainers/src/main/java/org/springframework/boot/testcontainers/service/connection/ServiceConnectionContextCustomizer.java
View File

@ -17,6 +17,10 @@
package org.springframework.boot.testcontainers.service.connection;
import java.util.List;
import java.util.Set;
import java.util.stream.Collectors;
import org.testcontainers.containers.Container;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
@ -37,6 +41,8 @@ class ServiceConnectionContextCustomizer implements ContextCustomizer {
private final List<ContainerConnectionSource<?>> sources;
private final Set<CacheKey> keys;
private final ConnectionDetailsFactories connectionDetailsFactories;
ServiceConnectionContextCustomizer(List<ContainerConnectionSource<?>> sources) {
@ -46,6 +52,7 @@ class ServiceConnectionContextCustomizer implements ContextCustomizer {
ServiceConnectionContextCustomizer(List<ContainerConnectionSource<?>> sources,
ConnectionDetailsFactories connectionDetailsFactories) {
this.sources = sources;
this.keys = sources.stream().map(CacheKey::new).collect(Collectors.toUnmodifiableSet());
this.connectionDetailsFactories = connectionDetailsFactories;
}
@ -58,8 +65,37 @@ class ServiceConnectionContextCustomizer implements ContextCustomizer {
}
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null || getClass() != obj.getClass()) {
return false;
}
return this.keys.equals(((ServiceConnectionContextCustomizer) obj).keys);
}
@Override
public int hashCode() {
return this.keys.hashCode();
}
List<ContainerConnectionSource<?>> getSources() {
return this.sources;
}
/**
* Relevant details from {@link ContainerConnectionSource} used as a
* MergedContextConfiguration cache key.
*/
private static record CacheKey(String connectionName, Set<Class<?>> connectionDetailsTypes,
Container<?> container) {
CacheKey(ContainerConnectionSource<?> source) {
this(source.getConnectionName(), source.getConnectionDetailsTypes(), source.getContainerSupplier().get());
}
}
}

48
spring-boot-project/spring-boot-testcontainers/src/test/java/org/springframework/boot/testcontainers/service/connection/ServiceConnectionContextCustomizerTests.java
View File

@ -91,6 +91,54 @@ class ServiceConnectionContextCustomizerTests {
assertThat(beanDefinition.getBeanClass()).isEqualTo(TestJdbcConnectionDetails.class);
}
@Test
void equalsAndHashCode() {
PostgreSQLContainer<?> container1 = mock(PostgreSQLContainer.class);
PostgreSQLContainer<?> container2 = mock(PostgreSQLContainer.class);
MergedAnnotation<ServiceConnection> annotation1 = MergedAnnotation.of(ServiceConnection.class,
Map.of("name", "", "type", new Class<?>[0]));
MergedAnnotation<ServiceConnection> annotation2 = MergedAnnotation.of(ServiceConnection.class,
Map.of("name", "", "type", new Class<?>[0]));
MergedAnnotation<ServiceConnection> annotation3 = MergedAnnotation.of(ServiceConnection.class,
Map.of("name", "", "type", new Class<?>[] { JdbcConnectionDetails.class }));
// Connection Names
ServiceConnectionContextCustomizer n1 = new ServiceConnectionContextCustomizer(
List.of(new ContainerConnectionSource<>("test", this.origin, PostgreSQLContainer.class, "name",
annotation1, () -> container1)));
ServiceConnectionContextCustomizer n2 = new ServiceConnectionContextCustomizer(
List.of(new ContainerConnectionSource<>("test", this.origin, PostgreSQLContainer.class, "name",
annotation1, () -> container1)));
ServiceConnectionContextCustomizer n3 = new ServiceConnectionContextCustomizer(
List.of(new ContainerConnectionSource<>("test", this.origin, PostgreSQLContainer.class, "namex",
annotation1, () -> container1)));
assertThat(n1.hashCode()).isEqualTo(n2.hashCode());
assertThat(n1).isEqualTo(n2).isNotEqualTo(n3);
// Connection Details Types
ServiceConnectionContextCustomizer t1 = new ServiceConnectionContextCustomizer(
List.of(new ContainerConnectionSource<>("test", this.origin, PostgreSQLContainer.class, "name",
annotation1, () -> container1)));
ServiceConnectionContextCustomizer t2 = new ServiceConnectionContextCustomizer(
List.of(new ContainerConnectionSource<>("test", this.origin, PostgreSQLContainer.class, "name",
annotation2, () -> container1)));
ServiceConnectionContextCustomizer t3 = new ServiceConnectionContextCustomizer(
List.of(new ContainerConnectionSource<>("test", this.origin, PostgreSQLContainer.class, "name",
annotation3, () -> container1)));
assertThat(t1.hashCode()).isEqualTo(t2.hashCode());
assertThat(t1).isEqualTo(t2).isNotEqualTo(t3);
// Container
ServiceConnectionContextCustomizer c1 = new ServiceConnectionContextCustomizer(
List.of(new ContainerConnectionSource<>("test", this.origin, PostgreSQLContainer.class, "name",
annotation1, () -> container1)));
ServiceConnectionContextCustomizer c2 = new ServiceConnectionContextCustomizer(
List.of(new ContainerConnectionSource<>("test", this.origin, PostgreSQLContainer.class, "name",
annotation1, () -> container1)));
ServiceConnectionContextCustomizer c3 = new ServiceConnectionContextCustomizer(
List.of(new ContainerConnectionSource<>("test", this.origin, PostgreSQLContainer.class, "name",
annotation1, () -> container2)));
assertThat(c1.hashCode()).isEqualTo(c2.hashCode());
assertThat(c1).isEqualTo(c2).isNotEqualTo(c3);
}
/**
* Test {@link JdbcConnectionDetails}.
*/