Package brave.test

Class IntegrationTestSpanHandler

java.lang.Object

brave.handler.SpanHandler

brave.test.IntegrationTestSpanHandler

All Implemented Interfaces:

org.junit.jupiter.api.extension.Extension, org.junit.jupiter.api.extension.InvocationInterceptor

public final class IntegrationTestSpanHandler
extends brave.handler.SpanHandler
implements org.junit.jupiter.api.extension.InvocationInterceptor

This is a special span reporter for remote integration tests.

Ex. The following is similar to our base test class ITRemote:

{@code

Since:

5.12

See Also:

TestSpanHandler

Nested Class Summary

Nested classes/interfaces inherited from class brave.handler.SpanHandler

brave.handler.SpanHandler.Cause

Nested classes/interfaces inherited from interface org.junit.jupiter.api.extension.InvocationInterceptor

org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<T extends Object>

Field Summary

Fields inherited from class brave.handler.SpanHandler

NOOP

Constructor Summary

Constructors

Constructor	Description
IntegrationTestSpanHandler()

Method Summary

Modifier and Type	Method	Description
boolean	begin(brave.propagation.TraceContext context, brave.handler.MutableSpan span, brave.propagation.TraceContext parent)
boolean	end(brave.propagation.TraceContext context, brave.handler.MutableSpan span, brave.handler.SpanHandler.Cause cause)
boolean	handlesAbandoned()
void	ignoreAnySpans()	Call this before using an Assumptions.assumeTrue(boolean), when there's a chance a span was finished.
void	interceptTestMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<Void> invocation, org.junit.jupiter.api.extension.ReflectiveInvocationContext<Method> invocationContext, org.junit.jupiter.api.extension.ExtensionContext extensionContext)
brave.handler.MutableSpan	takeLocalSpan()	Blocks until a local span was finished.
brave.handler.MutableSpan	takeRemoteSpan(brave.Span.Kind kind)	Blocks until a remote span was finished.
brave.handler.MutableSpan	takeRemoteSpanWithError(brave.Span.Kind kind)	Some frameworks swallow exceptions.
brave.handler.MutableSpan	takeRemoteSpanWithError(brave.Span.Kind kind, Throwable error)	Like takeRemoteSpan(Kind) except a MutableSpan.error() must equal the given value.
brave.handler.MutableSpan	takeRemoteSpanWithErrorMessage(brave.Span.Kind kind, String errorMessage)	Use instead of takeRemoteSpanWithError(Kind, Throwable) when you cannot catch a reference to the actual raised exception during a test.
brave.handler.MutableSpan	takeRemoteSpanWithErrorTag(brave.Span.Kind kind, String errorTag)	Like takeRemoteSpan(Kind) except an error tag must match the given value.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.junit.jupiter.api.extension.InvocationInterceptor

interceptAfterAllMethod, interceptAfterEachMethod, interceptBeforeAllMethod, interceptBeforeEachMethod, interceptDynamicTest, interceptDynamicTest, interceptTestClassConstructor, interceptTestFactoryMethod, interceptTestTemplateMethod

Constructor Detail

IntegrationTestSpanHandler

public IntegrationTestSpanHandler()

Method Detail

ignoreAnySpans

public void ignoreAnySpans()

Call this before using an Assumptions.assumeTrue(boolean), when there's a chance a span was finished.

This was made for detecting features in HTTP server testing via 404. When 404 itself is instrumented, post-conditions would otherwise fail from not consuming the associated span.

takeLocalSpan

public brave.handler.MutableSpan takeLocalSpan()

Blocks until a local span was finished. This does not verify errors.

takeRemoteSpan

public brave.handler.MutableSpan takeRemoteSpan(brave.Span.Kind kind)

Blocks until a remote span was finished. We define a remote span as one with a timestamp, duration and kind.

This will fail if there's an MutableSpan.error() or an "error" tag. If you expect a failure, use takeRemoteSpanWithError(Kind, Throwable) or takeRemoteSpanWithErrorTag(Kind, String) instead.

takeRemoteSpanWithError

public brave.handler.MutableSpan takeRemoteSpanWithError(brave.Span.Kind kind,
                                                         Throwable error)

Like takeRemoteSpan(Kind) except a MutableSpan.error() must equal the given value.

Note: This enforces there is no "error" tag. If your framework clarifies the "error" tag when there is also an unhandled exception, use takeRemoteSpanWithErrorTag(Kind, String) first, then check for error using normal assertions.

See Also:

takeRemoteSpanWithError(Kind), takeRemoteSpanWithErrorMessage(Kind, String), takeRemoteSpanWithErrorTag(Kind, String)

takeRemoteSpanWithError

public brave.handler.MutableSpan takeRemoteSpanWithError(brave.Span.Kind kind)

Some frameworks swallow exceptions. This tests that either an "error" tag exists or MutableSpan.error() does, without regards to the value.

See Also:

takeRemoteSpanWithError(Kind, Throwable), takeRemoteSpanWithErrorMessage(Kind, String), takeRemoteSpanWithErrorTag(Kind, String)

takeRemoteSpanWithErrorMessage

public brave.handler.MutableSpan takeRemoteSpanWithErrorMessage(brave.Span.Kind kind,
                                                                String errorMessage)

Use instead of takeRemoteSpanWithError(Kind, Throwable) when you cannot catch a reference to the actual raised exception during a test.

This is typically used when testing framework errors result in a finished span.

See Also:

takeRemoteSpanWithError(Kind, Throwable), takeRemoteSpanWithError(Kind), takeRemoteSpanWithErrorTag(Kind, String)

takeRemoteSpanWithErrorTag

public brave.handler.MutableSpan takeRemoteSpanWithErrorTag(brave.Span.Kind kind,
                                                            String errorTag)

Like takeRemoteSpan(Kind) except an error tag must match the given value.

See Also:

takeRemoteSpanWithError(Kind, Throwable), takeRemoteSpanWithError(Kind), takeRemoteSpanWithErrorMessage(Kind, String)

begin

public boolean begin(brave.propagation.TraceContext context,
                     brave.handler.MutableSpan span,
                     @Nullable
                     brave.propagation.TraceContext parent)

Overrides:

begin in class brave.handler.SpanHandler

handlesAbandoned

public boolean handlesAbandoned()

Overrides:

handlesAbandoned in class brave.handler.SpanHandler

end

public boolean end(brave.propagation.TraceContext context,
                   brave.handler.MutableSpan span,
                   brave.handler.SpanHandler.Cause cause)

Overrides:

end in class brave.handler.SpanHandler

interceptTestMethod

public void interceptTestMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<Void> invocation,
                                org.junit.jupiter.api.extension.ReflectiveInvocationContext<Method> invocationContext,
                                org.junit.jupiter.api.extension.ExtensionContext extensionContext)
                         throws Throwable

Specified by:

interceptTestMethod in interface org.junit.jupiter.api.extension.InvocationInterceptor

Throws:

Throwable

toString

public String toString()

Overrides:

toString in class Object