Merge pull request #35107 from eddumelendez

* pr/35107:
  Polish "Add service connection from Testcontainers Zipkin"
  Add service connection from Testcontainers Zipkin

Closes gh-35107

Author: mhalbritter

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]

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")

spring-boot-project/spring-boot-testcontainers/src/main/java/org/springframework/boot/testcontainers/service/connection/zipkin/ZipkinContainerConnectionDetailsFactory.java

@@ -0,0 +1,68 @@
+/*
+ * 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
+ * @author Moritz Halbritter
+ */
+class ZipkinContainerConnectionDetailsFactory
+		extends ContainerConnectionDetailsFactory<Container<?>, ZipkinConnectionDetails> {
+
+	private static final int ZIPKIN_PORT = 9411;
+
+	ZipkinContainerConnectionDetailsFactory() {
+		super("openzipkin/zipkin",
+				"org.springframework.boot.actuate.autoconfigure.tracing.zipkin.ZipkinAutoConfiguration");
+	}
+
+	@Override
+	protected ZipkinConnectionDetails getContainerConnectionDetails(ContainerConnectionSource<Container<?>> source) {
+		return new ZipkinContainerConnectionDetails(source);
+	}
+
+	/**
+	 * {@link ZipkinConnectionDetails} backed by a {@link ContainerConnectionSource}.
+	 */
+	private static class ZipkinContainerConnectionDetails extends ContainerConnectionDetails<Container<?>>
+			implements ZipkinConnectionDetails {
+
+		ZipkinContainerConnectionDetails(ContainerConnectionSource<Container<?>> source) {
+			super(source);
+		}
+
+		@Override
+		public String getSpanEndpoint() {
+			return "http://" + getContainer().getHost() + ":" + getContainer().getMappedPort(ZIPKIN_PORT)
+					+ "/api/v2/spans";
+		}
+
+	}
+
+}

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;

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

spring-boot-project/spring-boot-testcontainers/src/test/java/org/springframework/boot/testcontainers/service/connection/zipkin/ZipkinContainerConnectionDetailsFactoryIntegrationTests.java

@@ -0,0 +1,65 @@
+/*
+ * 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.boot.testsupport.testcontainers.DockerImageNames;
+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
+ * @author Moritz Halbritter
+ */
+@SpringJUnitConfig
+@Testcontainers(disabledWithoutDocker = true)
+class ZipkinContainerConnectionDetailsFactoryIntegrationTests {
+
+	@Container
+	@ServiceConnection
+	static final GenericContainer<?> zipkin = new GenericContainer<>(DockerImageNames.zipkin()).withExposedPorts(9411);
+
+	@Autowired(required = false)
+	private ZipkinConnectionDetails connectionDetails;
+
+	@Test
+	void connectionCanBeMadeToZipkinContainer() {
+		assertThat(this.connectionDetails).isNotNull();
+		assertThat(this.connectionDetails.getSpanEndpoint())
+			.startsWith("http://" + zipkin.getHost() + ":" + zipkin.getMappedPort(9411));
+	}
+
+	@Configuration(proxyBeanMethods = false)
+	@ImportAutoConfiguration(ZipkinAutoConfiguration.class)
+	static class TestConfiguration {
+
+	}
+
+}

spring-boot-project/spring-boot-tools/spring-boot-test-support/src/main/java/org/springframework/boot/testsupport/testcontainers/DockerImageNames.java

@@ -23,6 +23,7 @@
  *
  * @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 static DockerImageName registry() {
 		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);
+	}
+
 }