Package brave.test.http

Class ITHttpServer

java.lang.Object

brave.test.ITRemote

brave.test.http.ITHttpServer

Direct Known Subclasses:

ITServletContainer

public abstract class ITHttpServer
extends ITRemote

Field Summary

Fields

Modifier and Type	Field	Description
protected HttpTracing	httpTracing
static IllegalStateException	NOT_READY_ISE

Fields inherited from class brave.test.ITRemote

BAGGAGE_FIELD, BAGGAGE_FIELD_KEY, currentTraceContext, globalTimeout, propagationFactory, spanHandler, testName, tracing

Constructor Summary

Constructors

Constructor	Description
ITHttpServer()

Method Summary

Modifier and Type	Method	Description
void	addsStatusCode_badRequest()
void	async()	Tests that the span propagates between under asynchronous callbacks (even if explicitly)
void	childCompletesBeforeServer()	The child completes before the response code is established, so it should be contained completely by the server's interval.
void	createsChildSpan()	This ensures thread-state is propagated from trace interceptors to user code.
void	createsChildWhenJoinDisabled()
void	customSampler()
void	defaultSpanNameIsMethodNameOrRoute()
protected okhttp3.Response	get(String path)
protected okhttp3.Response	get(okhttp3.Request request)
void	httpPathTagExcludesQueryParams()
void	httpRoute()	The "/items/{itemId}" endpoint should return the itemId in the response body, which proves templating worked (including that it ignores query parameters).
void	httpRoute_async()	Sometimes state used to carry http route data is different for async requests.
void	httpRoute_nested()	The "/nested/items/{itemId}" endpoint should be implemented by two route expressions: A path prefix: "/nested" and then a relative expression "/items/{itemId}"
void	httpStatusCodeSettable_onUncaughtException()	This tests that the actual code is 503, not 500 on exception.
void	httpStatusCodeSettable_onUncaughtException_async()
void	httpStatusCodeTagMatchesResponse_onUncaughtException()	Throw NOT_READY_ISE inside your controller after setting the status code {code 503}.
void	httpStatusCodeTagMatchesResponse_onUncaughtException_async()
protected abstract void	init()	recreate the server if needed
void	notFound()	If http route is supported, then the span name should include it
void	options()	This tests both that a root path ends up as "/" (slash) not "" (empty), as well that less typical OPTIONS methods can be traced.
void	readsBaggage_existingTrace()
void	readsBaggage_newTrace()
void	readsBaggage_unsampled()
void	readsRequestAtResponseTime()
void	reportsClientAddress()
void	reportsClientAddress_XForwardedFor()
void	reportsServerKindToZipkin()
void	reusesPropagatedSpanId()
void	samplingDisabled()
void	setsErrorAndHttpStatusOnUncaughtException()
void	setsErrorAndHttpStatusOnUncaughtException_async()
void	setup()
void	spanHandlerSeesError()
void	spanHandlerSeesException_async()
void	supportsPortableCustomization()
void	supportsPortableCustomizationDeprecated()	Deprecated.
protected abstract String	url(String path)

Methods inherited from class brave.test.ITRemote

assertChildOf, assertChildOf, assertChildOf, assertNoError, assertNoErrorTag, assertSameIds, assertSequential, assertSpanInInterval, checkForLeakedScopes, close, currentTraceContextBuilder, newTraceContext, tracingBuilder

Methods inherited from class java.lang.Object

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

Field Details

NOT_READY_ISE

public static final IllegalStateException NOT_READY_ISE

httpTracing

protected HttpTracing httpTracing

Constructor Details

ITHttpServer

public ITHttpServer()

Method Details

setup

public void setup() throws IOException

Throws:

IOException

init

protected abstract void init() throws IOException

recreate the server if needed

Throws:

IOException

url

protected abstract String url(String path)

reusesPropagatedSpanId

public void reusesPropagatedSpanId() throws IOException

Throws:

IOException

createsChildWhenJoinDisabled

public void createsChildWhenJoinDisabled() throws IOException

Throws:

IOException

readsBaggage_newTrace

public void readsBaggage_newTrace() throws IOException

Throws:

IOException

readsBaggage_unsampled

public void readsBaggage_unsampled() throws IOException

Throws:

IOException

readsBaggage_existingTrace

public void readsBaggage_existingTrace() throws IOException

Throws:

IOException

samplingDisabled

public void samplingDisabled() throws IOException

Throws:

IOException

customSampler

public void customSampler() throws IOException

Throws:

IOException

async

public void async() throws IOException

Tests that the span propagates between under asynchronous callbacks (even if explicitly)

Throws:

IOException

createsChildSpan

public void createsChildSpan() throws IOException

This ensures thread-state is propagated from trace interceptors to user code. The endpoint "/child" is expected to create an in-process span. When this works, it should be a child of the "current span", in this case the span representing an incoming server request. When thread state isn't managed properly, the child span will appear as a new trace.

Throws:

IOException

childCompletesBeforeServer

public void childCompletesBeforeServer() throws IOException

The child completes before the response code is established, so it should be contained completely by the server's interval.

Throws:

IOException

reportsClientAddress

public void reportsClientAddress() throws IOException

Throws:

IOException

reportsClientAddress_XForwardedFor

public void reportsClientAddress_XForwardedFor() throws IOException

Throws:

IOException

reportsServerKindToZipkin

public void reportsServerKindToZipkin() throws IOException

Throws:

IOException

defaultSpanNameIsMethodNameOrRoute

public void defaultSpanNameIsMethodNameOrRoute() throws IOException

Throws:

IOException

readsRequestAtResponseTime

public void readsRequestAtResponseTime() throws IOException

Throws:

IOException

supportsPortableCustomization

public void supportsPortableCustomization() throws IOException

Throws:

IOException

supportsPortableCustomizationDeprecated

@Deprecated public void supportsPortableCustomizationDeprecated() throws IOException

Deprecated.

Throws:

IOException

httpRoute

public void httpRoute() throws IOException

The "/items/{itemId}" endpoint should return the itemId in the response body, which proves templating worked (including that it ignores query parameters). Note the route format is framework specific, ex "/items/:itemId" in vert.x

Throws:

IOException

httpRoute_nested

public void httpRoute_nested() throws IOException

The "/nested/items/{itemId}" endpoint should be implemented by two route expressions: A path prefix: "/nested" and then a relative expression "/items/{itemId}"

Throws:

IOException

httpRoute_async

public void httpRoute_async() throws IOException

Sometimes state used to carry http route data is different for async requests. This helps ensure we don't miss issues like this.

Throws:

IOException

notFound

public void notFound() throws IOException

If http route is supported, then the span name should include it

Throws:

IOException

options

public void options() throws IOException

This tests both that a root path ends up as "/" (slash) not "" (empty), as well that less typical OPTIONS methods can be traced.

Throws:

IOException

addsStatusCode_badRequest

public void addsStatusCode_badRequest() throws IOException

Throws:

IOException

httpPathTagExcludesQueryParams

public void httpPathTagExcludesQueryParams() throws IOException

Throws:

IOException

httpStatusCodeTagMatchesResponse_onUncaughtException

public void httpStatusCodeTagMatchesResponse_onUncaughtException() throws IOException

Throw NOT_READY_ISE inside your controller after setting the status code {code 503}.

Note: Don't throw UnavailableException as Jetty ignores the exception message!

Throws:

IOException

httpStatusCodeTagMatchesResponse_onUncaughtException_async

public void httpStatusCodeTagMatchesResponse_onUncaughtException_async() throws IOException

Throws:

IOException

httpStatusCodeSettable_onUncaughtException

public void httpStatusCodeSettable_onUncaughtException() throws IOException

This tests that the actual code is 503, not 500 on exception.

Usually, frameworks have an exception wrapper which allow you to control the status code. Other times, you have to set the status before raising the exception.

Note: Some frameworks cannot control the status code upon unhandled error in a controller at all. If this is the case, just override and ignore this test.

Throws:

IOException

httpStatusCodeSettable_onUncaughtException_async

public void httpStatusCodeSettable_onUncaughtException_async() throws IOException

Throws:

IOException

setsErrorAndHttpStatusOnUncaughtException

public void setsErrorAndHttpStatusOnUncaughtException() throws IOException

Throws:

IOException

setsErrorAndHttpStatusOnUncaughtException_async

public void setsErrorAndHttpStatusOnUncaughtException_async() throws IOException

Throws:

IOException

spanHandlerSeesError

public void spanHandlerSeesError() throws IOException

Throws:

IOException

spanHandlerSeesException_async

public void spanHandlerSeesException_async() throws IOException

Throws:

IOException

get

protected okhttp3.Response get(String path) throws IOException

Throws:

IOException

get

protected okhttp3.Response get(okhttp3.Request request) throws IOException

Throws:

IOException