From ad4f6ffeb732da2533629f63d17b553880beefe2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edd=C3=BA=20Mel=C3=A9ndez?= Date: Fri, 21 Apr 2023 20:06:26 -0600 Subject: [PATCH 1/2] Add service connection from Testcontainers Zipkin See gh-35107 --- .../src/docs/asciidoc/features/testing.adoc | 3 + .../spring-boot-testcontainers/build.gradle | 1 + ...pkinContainerConnectionDetailsFactory.java | 70 +++++++++++++++++++ .../connection/zipkin/package-info.java | 20 ++++++ .../main/resources/META-INF/spring.factories | 3 +- ...nectionDetailsFactoryIntegrationTests.java | 63 +++++++++++++++++ 6 files changed, 159 insertions(+), 1 deletion(-) create mode 100644 spring-boot-project/spring-boot-testcontainers/src/main/java/org/springframework/boot/testcontainers/service/connection/zipkin/ZipkinContainerConnectionDetailsFactory.java create mode 100644 spring-boot-project/spring-boot-testcontainers/src/main/java/org/springframework/boot/testcontainers/service/connection/zipkin/package-info.java create mode 100644 spring-boot-project/spring-boot-testcontainers/src/test/java/org/springframework/boot/testcontainers/service/connection/zipkin/ZipkinContainerConnectionDetailsFactoryIntegrationTests.java diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/testing.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/testing.adoc index 7d59fd76a6..2e9798283e 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/testing.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/testing.adoc @@ -981,6 +981,9 @@ The following service connection factories are provided in the `spring-boot-test | `RedisConnectionDetails` | Containers named "redis" + +| `ZipkinConnectionDetails` +| Containers named "openzipkin/zipkin" |=== [TIP] diff --git a/spring-boot-project/spring-boot-testcontainers/build.gradle b/spring-boot-project/spring-boot-testcontainers/build.gradle index 0e6c1754c3..9cfb970958 100644 --- a/spring-boot-project/spring-boot-testcontainers/build.gradle +++ b/spring-boot-project/spring-boot-testcontainers/build.gradle @@ -12,6 +12,7 @@ dependencies { api(project(":spring-boot-project:spring-boot-autoconfigure")) api("org.testcontainers:testcontainers") + optional(project(":spring-boot-project:spring-boot-actuator-autoconfigure")) optional("org.springframework:spring-test") optional("org.springframework.data:spring-data-mongodb") optional("org.springframework.data:spring-data-neo4j") diff --git a/spring-boot-project/spring-boot-testcontainers/src/main/java/org/springframework/boot/testcontainers/service/connection/zipkin/ZipkinContainerConnectionDetailsFactory.java b/spring-boot-project/spring-boot-testcontainers/src/main/java/org/springframework/boot/testcontainers/service/connection/zipkin/ZipkinContainerConnectionDetailsFactory.java new file mode 100644 index 0000000000..dc58f7bdbf --- /dev/null +++ b/spring-boot-project/spring-boot-testcontainers/src/main/java/org/springframework/boot/testcontainers/service/connection/zipkin/ZipkinContainerConnectionDetailsFactory.java @@ -0,0 +1,70 @@ +/* + * 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.zipkin; + +import org.testcontainers.containers.Container; +import org.testcontainers.containers.GenericContainer; + +import org.springframework.boot.actuate.autoconfigure.tracing.zipkin.ZipkinConnectionDetails; +import org.springframework.boot.testcontainers.service.connection.ContainerConnectionDetailsFactory; +import org.springframework.boot.testcontainers.service.connection.ContainerConnectionSource; +import org.springframework.boot.testcontainers.service.connection.ServiceConnection; + +/** + * {@link ContainerConnectionDetailsFactory} to create {@link ZipkinConnectionDetails} + * from a {@link ServiceConnection @ServiceConnection}-annotated {@link GenericContainer} + * using the {@code "openzipkin/zipkin"} image. + * + * @author Eddú Meléndez + */ +class ZipkinContainerConnectionDetailsFactory + extends ContainerConnectionDetailsFactory> { + + private static final int ZIPKIN_PORT = 9411; + + ZipkinContainerConnectionDetailsFactory() { + super("openzipkin/zipkin", + "org.springframework.boot.actuate.autoconfigure.tracing.zipkin.ZipkinAutoConfiguration"); + } + + @Override + protected ZipkinConnectionDetails getContainerConnectionDetails(ContainerConnectionSource> source) { + return new ZipkinContainerConnectionDetails(source); + } + + /** + * {@link ZipkinConnectionDetails} backed by a {@link ContainerConnectionSource}. + */ + private static class ZipkinContainerConnectionDetails extends ContainerConnectionDetails + implements ZipkinConnectionDetails { + + private final String endpoint; + + ZipkinContainerConnectionDetails(ContainerConnectionSource> source) { + super(source); + this.endpoint = "http://" + source.getContainer().getHost() + ":" + + source.getContainer().getMappedPort(ZIPKIN_PORT) + "/api/v2/spans"; + } + + @Override + public String getSpanEndpoint() { + return this.endpoint; + } + + } + +} diff --git a/spring-boot-project/spring-boot-testcontainers/src/main/java/org/springframework/boot/testcontainers/service/connection/zipkin/package-info.java b/spring-boot-project/spring-boot-testcontainers/src/main/java/org/springframework/boot/testcontainers/service/connection/zipkin/package-info.java new file mode 100644 index 0000000000..25047705e7 --- /dev/null +++ b/spring-boot-project/spring-boot-testcontainers/src/main/java/org/springframework/boot/testcontainers/service/connection/zipkin/package-info.java @@ -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. + */ + +/** + * Support for testcontainers Zipkin service connections. + */ +package org.springframework.boot.testcontainers.service.connection.zipkin; diff --git a/spring-boot-project/spring-boot-testcontainers/src/main/resources/META-INF/spring.factories b/spring-boot-project/spring-boot-testcontainers/src/main/resources/META-INF/spring.factories index 226a52f024..8f9886edc6 100644 --- a/spring-boot-project/spring-boot-testcontainers/src/main/resources/META-INF/spring.factories +++ b/spring-boot-project/spring-boot-testcontainers/src/main/resources/META-INF/spring.factories @@ -24,4 +24,5 @@ org.springframework.boot.testcontainers.service.connection.r2dbc.MySqlR2dbcConta org.springframework.boot.testcontainers.service.connection.r2dbc.OracleR2dbcContainerConnectionDetailsFactory,\ org.springframework.boot.testcontainers.service.connection.r2dbc.PostgresR2dbcContainerConnectionDetailsFactory,\ org.springframework.boot.testcontainers.service.connection.redis.RedisContainerConnectionDetailsFactory,\ -org.springframework.boot.testcontainers.service.connection.redpanda.RedpandaContainerConnectionDetailsFactory +org.springframework.boot.testcontainers.service.connection.redpanda.RedpandaContainerConnectionDetailsFactory,\ +org.springframework.boot.testcontainers.service.connection.zipkin.ZipkinContainerConnectionDetailsFactory diff --git a/spring-boot-project/spring-boot-testcontainers/src/test/java/org/springframework/boot/testcontainers/service/connection/zipkin/ZipkinContainerConnectionDetailsFactoryIntegrationTests.java b/spring-boot-project/spring-boot-testcontainers/src/test/java/org/springframework/boot/testcontainers/service/connection/zipkin/ZipkinContainerConnectionDetailsFactoryIntegrationTests.java new file mode 100644 index 0000000000..203248957f --- /dev/null +++ b/spring-boot-project/spring-boot-testcontainers/src/test/java/org/springframework/boot/testcontainers/service/connection/zipkin/ZipkinContainerConnectionDetailsFactoryIntegrationTests.java @@ -0,0 +1,63 @@ +/* + * 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.zipkin; + +import org.junit.jupiter.api.Test; +import org.testcontainers.containers.GenericContainer; +import org.testcontainers.junit.jupiter.Container; +import org.testcontainers.junit.jupiter.Testcontainers; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.actuate.autoconfigure.tracing.zipkin.ZipkinAutoConfiguration; +import org.springframework.boot.actuate.autoconfigure.tracing.zipkin.ZipkinConnectionDetails; +import org.springframework.boot.autoconfigure.ImportAutoConfiguration; +import org.springframework.boot.testcontainers.service.connection.ServiceConnection; +import org.springframework.context.annotation.Configuration; +import org.springframework.test.context.junit.jupiter.SpringJUnitConfig; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Tests for {@link ZipkinContainerConnectionDetailsFactory}. + * + * @author Eddú Meléndez + */ +@SpringJUnitConfig +@Testcontainers(disabledWithoutDocker = true) +class ZipkinContainerConnectionDetailsFactoryIntegrationTests { + + @Container + @ServiceConnection + static final GenericContainer container = new GenericContainer<>("openzipkin/zipkin:2.23.2") + .withExposedPorts(9411); + + @Autowired + private ZipkinConnectionDetails connectionDetails; + + @Test + void connectionCanBeMadeToRabbitContainer() { + assertThat(this.connectionDetails.getSpanEndpoint()) + .startsWith("http://" + container.getHost() + ":" + container.getMappedPort(9411)); + } + + @Configuration(proxyBeanMethods = false) + @ImportAutoConfiguration(ZipkinAutoConfiguration.class) + static class TestConfiguration { + + } + +} From 9b5a2643cc5fbabc313359c3f8a2e0b2868d7686 Mon Sep 17 00:00:00 2001 From: Moritz Halbritter Date: Tue, 2 May 2023 10:49:00 +0200 Subject: [PATCH 2/2] Polish "Add service connection from Testcontainers Zipkin" See gh-35107 --- .../ZipkinContainerConnectionDetailsFactory.java | 12 +++++------- ...inerConnectionDetailsFactoryIntegrationTests.java | 12 +++++++----- .../testsupport/testcontainers/DockerImageNames.java | 12 ++++++++++++ 3 files changed, 24 insertions(+), 12 deletions(-) diff --git a/spring-boot-project/spring-boot-testcontainers/src/main/java/org/springframework/boot/testcontainers/service/connection/zipkin/ZipkinContainerConnectionDetailsFactory.java b/spring-boot-project/spring-boot-testcontainers/src/main/java/org/springframework/boot/testcontainers/service/connection/zipkin/ZipkinContainerConnectionDetailsFactory.java index dc58f7bdbf..3fbb5adeb7 100644 --- a/spring-boot-project/spring-boot-testcontainers/src/main/java/org/springframework/boot/testcontainers/service/connection/zipkin/ZipkinContainerConnectionDetailsFactory.java +++ b/spring-boot-project/spring-boot-testcontainers/src/main/java/org/springframework/boot/testcontainers/service/connection/zipkin/ZipkinContainerConnectionDetailsFactory.java @@ -30,9 +30,10 @@ import org.springframework.boot.testcontainers.service.connection.ServiceConnect * using the {@code "openzipkin/zipkin"} image. * * @author Eddú Meléndez + * @author Moritz Halbritter */ class ZipkinContainerConnectionDetailsFactory - extends ContainerConnectionDetailsFactory> { + extends ContainerConnectionDetailsFactory, ZipkinConnectionDetails> { private static final int ZIPKIN_PORT = 9411; @@ -49,20 +50,17 @@ class ZipkinContainerConnectionDetailsFactory /** * {@link ZipkinConnectionDetails} backed by a {@link ContainerConnectionSource}. */ - private static class ZipkinContainerConnectionDetails extends ContainerConnectionDetails + private static class ZipkinContainerConnectionDetails extends ContainerConnectionDetails> implements ZipkinConnectionDetails { - private final String endpoint; - ZipkinContainerConnectionDetails(ContainerConnectionSource> source) { super(source); - this.endpoint = "http://" + source.getContainer().getHost() + ":" - + source.getContainer().getMappedPort(ZIPKIN_PORT) + "/api/v2/spans"; } @Override public String getSpanEndpoint() { - return this.endpoint; + return "http://" + getContainer().getHost() + ":" + getContainer().getMappedPort(ZIPKIN_PORT) + + "/api/v2/spans"; } } diff --git a/spring-boot-project/spring-boot-testcontainers/src/test/java/org/springframework/boot/testcontainers/service/connection/zipkin/ZipkinContainerConnectionDetailsFactoryIntegrationTests.java b/spring-boot-project/spring-boot-testcontainers/src/test/java/org/springframework/boot/testcontainers/service/connection/zipkin/ZipkinContainerConnectionDetailsFactoryIntegrationTests.java index 203248957f..0c9a9d1abe 100644 --- a/spring-boot-project/spring-boot-testcontainers/src/test/java/org/springframework/boot/testcontainers/service/connection/zipkin/ZipkinContainerConnectionDetailsFactoryIntegrationTests.java +++ b/spring-boot-project/spring-boot-testcontainers/src/test/java/org/springframework/boot/testcontainers/service/connection/zipkin/ZipkinContainerConnectionDetailsFactoryIntegrationTests.java @@ -26,6 +26,7 @@ import org.springframework.boot.actuate.autoconfigure.tracing.zipkin.ZipkinAutoC import org.springframework.boot.actuate.autoconfigure.tracing.zipkin.ZipkinConnectionDetails; import org.springframework.boot.autoconfigure.ImportAutoConfiguration; import org.springframework.boot.testcontainers.service.connection.ServiceConnection; +import org.springframework.boot.testsupport.testcontainers.DockerImageNames; import org.springframework.context.annotation.Configuration; import org.springframework.test.context.junit.jupiter.SpringJUnitConfig; @@ -35,6 +36,7 @@ import static org.assertj.core.api.Assertions.assertThat; * Tests for {@link ZipkinContainerConnectionDetailsFactory}. * * @author Eddú Meléndez + * @author Moritz Halbritter */ @SpringJUnitConfig @Testcontainers(disabledWithoutDocker = true) @@ -42,16 +44,16 @@ class ZipkinContainerConnectionDetailsFactoryIntegrationTests { @Container @ServiceConnection - static final GenericContainer container = new GenericContainer<>("openzipkin/zipkin:2.23.2") - .withExposedPorts(9411); + static final GenericContainer zipkin = new GenericContainer<>(DockerImageNames.zipkin()).withExposedPorts(9411); - @Autowired + @Autowired(required = false) private ZipkinConnectionDetails connectionDetails; @Test - void connectionCanBeMadeToRabbitContainer() { + void connectionCanBeMadeToZipkinContainer() { + assertThat(this.connectionDetails).isNotNull(); assertThat(this.connectionDetails.getSpanEndpoint()) - .startsWith("http://" + container.getHost() + ":" + container.getMappedPort(9411)); + .startsWith("http://" + zipkin.getHost() + ":" + zipkin.getMappedPort(9411)); } @Configuration(proxyBeanMethods = false) diff --git a/spring-boot-project/spring-boot-tools/spring-boot-test-support/src/main/java/org/springframework/boot/testsupport/testcontainers/DockerImageNames.java b/spring-boot-project/spring-boot-tools/spring-boot-test-support/src/main/java/org/springframework/boot/testsupport/testcontainers/DockerImageNames.java index 10684963fa..dd35cc8902 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-test-support/src/main/java/org/springframework/boot/testsupport/testcontainers/DockerImageNames.java +++ b/spring-boot-project/spring-boot-tools/spring-boot-test-support/src/main/java/org/springframework/boot/testsupport/testcontainers/DockerImageNames.java @@ -23,6 +23,7 @@ import org.testcontainers.utility.DockerImageName; * * @author Stephane Nicoll * @author Eddú Meléndez + * @author Moritz Halbritter * @since 2.3.6 */ public final class DockerImageNames { @@ -53,6 +54,8 @@ public final class DockerImageNames { private static final String REGISTRY_VERSION = "2.7.1"; + private static final String ZIPKIN_VERSION = "2.24.1"; + private DockerImageNames() { } @@ -163,4 +166,13 @@ public final class DockerImageNames { return DockerImageName.parse("registry").withTag(REGISTRY_VERSION); } + /** + * Return a {@link DockerImageName} suitable for running Zipkin. + * @return a docker image name for running Zipkin + * @since 3.1.0 + */ + public static DockerImageName zipkin() { + return DockerImageName.parse("openzipkin/zipkin").withTag(ZIPKIN_VERSION); + } + }