Publishing tests-otel-common; fixes gh-82

Author: marcingrzejszczak

tests/common/pom.xml

@@ -34,10 +34,6 @@
 		<relativePath>..</relativePath>
 	</parent>
 
-	<properties>
-		<maven.javadoc.skip>true</maven.javadoc.skip>
-	</properties>
-
 	<dependencies>
 		<dependency>
 			<groupId>org.springframework.cloud</groupId>

tests/common/src/main/java/org/springframework/cloud/sleuth/otel/OtelTestSpanHandler.java

@@ -38,10 +38,20 @@
 import org.springframework.cloud.sleuth.otel.bridge.OtelAccessor;
 import org.springframework.cloud.sleuth.test.TestSpanHandler;
 
+/**
+ * Test abstraction to store handled spans.
+ *
+ * @author Marcin Grzejszczak
+ * @since 1.0.0
+ */
 public class OtelTestSpanHandler implements TestSpanHandler, SpanProcessor, SpanExporter {
 
 	private final ArrayListSpanProcessor spanProcessor;
 
+	/**
+	 * Creates a new instance.
+	 * @param spanProcessor span processor
+	 */
 	public OtelTestSpanHandler(ArrayListSpanProcessor spanProcessor) {
 		this.spanProcessor = spanProcessor;
 	}

tests/common/src/main/java/org/springframework/cloud/sleuth/otel/OtelTestTracing.java

@@ -49,6 +49,12 @@
 import org.springframework.cloud.sleuth.test.TracerAware;
 import org.springframework.context.ApplicationEventPublisher;
 
+/**
+ * Class containing access to all tracing related components.
+ *
+ * @author Marcin Grzejszczak
+ * @since 1.0.0
+ */
 public class OtelTestTracing implements TracerAware, TestTracingAware, TestTracingAwareSupplier, Closeable {
 
 	private final DynamicSampler sampler = new DynamicSampler();

tests/common/src/main/java/org/springframework/cloud/sleuth/otel/OtelTestTracingAssertions.java

@@ -21,6 +21,12 @@
 import org.springframework.cloud.sleuth.exporter.FinishedSpan;
 import org.springframework.cloud.sleuth.test.TestTracingAssertions;
 
+/**
+ * Class containing assertions specific to OTel.
+ *
+ * @author Marcin Grzejszczak
+ * @since 1.0.0
+ */
 public class OtelTestTracingAssertions implements TestTracingAssertions {
 
 	@Override

tests/common/src/main/java/org/springframework/cloud/sleuth/otel/bridge/OtelAccessor.java

@@ -37,12 +37,26 @@
 import org.springframework.context.ApplicationEventPublisher;
 import org.springframework.lang.Nullable;
 
+/**
+ * Wraps OTel classes in Sleuth representations.
+ *
+ * @author Marcin Grzejszczak
+ * @since 1.0.0
+ */
 public final class OtelAccessor {
 
 	private OtelAccessor() {
 		throw new IllegalStateException("Can't instantiate a utility class");
 	}
 
+	/**
+	 * Creates an OTel Tracer.
+	 * @param openTelemetry open telemetry
+	 * @param currentTraceContext current trace context
+	 * @param sleuthBaggageProperties sleuth baggage properties
+	 * @param publisher application publisher
+	 * @return tracer
+	 */
 	public static Tracer tracer(OpenTelemetry openTelemetry, CurrentTraceContext currentTraceContext,
 			SleuthBaggageProperties sleuthBaggageProperties, ApplicationEventPublisher publisher) {
 		return new OtelTracer(otelTracer(openTelemetry), publisher, new OtelBaggageManager(currentTraceContext,
@@ -53,32 +67,68 @@ private static io.opentelemetry.api.trace.Tracer otelTracer(OpenTelemetry openTe
 		return openTelemetry.getTracer("org.springframework.cloud.sleuth");
 	}
 
+	/**
+	 * Creates an OTel CurrentTraceContext.
+	 * @return current trace context
+	 */
 	public static CurrentTraceContext currentTraceContext() {
 		return new OtelCurrentTraceContext();
 	}
 
+	/**
+	 * Converts OTel SpanContext to TraceContext.
+	 * @param spanContext OTel span context
+	 * @return converted trace context
+	 */
 	public static TraceContext traceContext(SpanContext spanContext) {
 		return OtelTraceContext.fromOtel(spanContext);
 	}
 
+	/**
+	 * Converts OTel ContextPropagator to a Propagator.
+	 * @param propagators propagators
+	 * @param openTelemetry open telemetry
+	 * @return OTel propagator
+	 */
 	public static Propagator propagator(ContextPropagators propagators, OpenTelemetry openTelemetry) {
 		return new OtelPropagator(propagators, otelTracer(openTelemetry));
 	}
 
+	/**
+	 * Creates an HttpClientHandler.
+	 * @param openTelemetry open telemetry
+	 * @param httpClientRequestParser http client request parser
+	 * @param httpClientResponseParser http client response parser
+	 * @param samplerFunction sampler function
+	 * @return http client handler
+	 */
 	public static HttpClientHandler httpClientHandler(io.opentelemetry.api.OpenTelemetry openTelemetry,
 			@Nullable HttpRequestParser httpClientRequestParser, @Nullable HttpResponseParser httpClientResponseParser,
 			SamplerFunction<HttpRequest> samplerFunction) {
 		return new OtelHttpClientHandler(openTelemetry, httpClientRequestParser, httpClientResponseParser,
 				samplerFunction);
 	}
 
+	/**
+	 * Creates an HttpServerHandler.
+	 * @param openTelemetry open telemetry
+	 * @param httpServerRequestParser http server request parser
+	 * @param httpServerResponseParser http server response parser
+	 * @param skipPatternProvider skip pattern provider
+	 * @return http server handler
+	 */
 	public static HttpServerHandler httpServerHandler(io.opentelemetry.api.OpenTelemetry openTelemetry,
 			HttpRequestParser httpServerRequestParser, HttpResponseParser httpServerResponseParser,
 			SkipPatternProvider skipPatternProvider) {
 		return new OtelHttpServerHandler(openTelemetry, httpServerRequestParser, httpServerResponseParser,
 				skipPatternProvider);
 	}
 
+	/**
+	 * Converts OTel SpanData to FinishedSpan.
+	 * @param spanData OTel span data
+	 * @return finished span
+	 */
 	public static FinishedSpan finishedSpan(SpanData spanData) {
 		return new OtelFinishedSpan(spanData);
 	}

tests/pom.xml

@@ -39,18 +39,4 @@
 		<module>otel</module>
 	</modules>
 
-	<build>
-		<pluginManagement>
-			<plugins>
-				<plugin>
-					<!--skip deploy (this is just a test module) -->
-					<artifactId>maven-deploy-plugin</artifactId>
-					<configuration>
-						<skip>true</skip>
-					</configuration>
-				</plugin>
-			</plugins>
-		</pluginManagement>
-	</build>
-
 </project>