Skip to content

Commit

Permalink
Add service connection from Testcontainers Zipkin
Browse files Browse the repository at this point in the history
  • Loading branch information
eddumelendez committed Apr 22, 2023
1 parent 77c468c commit ae671d0
Show file tree
Hide file tree
Showing 5 changed files with 156 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ description = "Spring Boot Testcontainers Support"
dependencies {
api(project(":spring-boot-project:spring-boot-autoconfigure"))

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")
Expand Down
Original file line number Diff line number Diff line change
@@ -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<ZipkinConnectionDetails, Container<?>> {

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
implements ZipkinConnectionDetails {

private final String endpoint;

ZipkinContainerConnectionDetails(ContainerConnectionSource<Container<?>> source) {
super(source);
this.endpoint = "http://" + source.getContainer().getHost() + ":"
+ source.getContainer().getMappedPort(ZIPKIN_PORT) + "/api/v2/spans";
}

@Override
public String getSpanEndpoint() {
return this.endpoint;
}

}

}
Original file line number Diff line number Diff line change
@@ -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;
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,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
Original file line number Diff line number Diff line change
@@ -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 {

}

}

0 comments on commit ae671d0

Please sign in to comment.