Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ignored failing test for #28 #29

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Add ignored failing test for #28 #29

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 68 additions & 0 deletions tracing-jersey/src/test/java/com/palantir/tracing/jersey/TraceEnrichingFilterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

package com.palantir.tracing.jersey;

import static org.hamcrest.Matchers.empty;
import static org.hamcrest.Matchers.is;
import static org.hamcrest.Matchers.not;
import static org.hamcrest.Matchers.nullValue;
Expand All @@ -27,6 +28,8 @@
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

import com.google.common.collect.Lists;
import com.palantir.tracing.Trace;
import com.palantir.tracing.TraceSampler;
import com.palantir.tracing.Tracer;
import com.palantir.tracing.Tracers;
Expand All @@ -38,6 +41,17 @@
import io.dropwizard.Configuration;
import io.dropwizard.setup.Environment;
import io.dropwizard.testing.junit.DropwizardAppRule;
import java.io.IOException;
import java.util.EnumSet;
import java.util.List;
import javax.servlet.DispatcherType;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.FilterRegistration;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.ws.rs.Consumes;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
Expand All @@ -46,14 +60,17 @@
import javax.ws.rs.client.Client;
import javax.ws.rs.client.Entity;
import javax.ws.rs.client.WebTarget;
import javax.ws.rs.container.AsyncResponse;
import javax.ws.rs.container.ContainerRequestContext;
import javax.ws.rs.container.Suspended;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.UriInfo;
import org.glassfish.jersey.client.JerseyClientBuilder;
import org.junit.After;
import org.junit.Before;
import org.junit.ClassRule;
import org.junit.Ignore;
import org.junit.Test;
import org.mockito.ArgumentCaptor;
import org.mockito.Captor;
Expand Down Expand Up @@ -81,8 +98,11 @@ public final class TraceEnrichingFilterTest {

private WebTarget target;

private static final List<Trace> unexpectedTraces = Lists.newCopyOnWriteArrayList();

@Before
public void before() {
unexpectedTraces.clear();
MockitoAnnotations.initMocks(this);
String endpointUri = "http://localhost:" + APP.getLocalPort();
JerseyClientBuilder builder = new JerseyClientBuilder();
Expand All @@ -102,6 +122,11 @@ public void before() {
@After
public void after() {
Tracer.unsubscribe("");
try {
assertThat(unexpectedTraces, is(empty()));
} finally {
unexpectedTraces.clear();
}
}

@Test
Expand Down Expand Up @@ -156,6 +181,17 @@ public void testTraceState_withoutRequestHeadersGeneratesValidTraceResponseHeade
assertThat(spanCaptor.getValue().getOperation(), is("GET /trace"));
}

@Test
@Ignore("https://github.com/palantir/tracing-java/issues/28")
public void testTraceState_asyncDoesNotLeakState() {
Response response = target.path("/trace/async").request().get();
assertThat(response.getHeaderString(TraceHttpHeaders.TRACE_ID), not(nullValue()));
assertThat(response.getHeaderString(TraceHttpHeaders.PARENT_SPAN_ID), is(nullValue()));
assertThat(response.getHeaderString(TraceHttpHeaders.SPAN_ID), is(nullValue()));
verify(observer).consume(spanCaptor.capture());
assertThat(spanCaptor.getValue().getOperation(), is("GET /trace/async"));
}

@Test
public void testTraceState_withSamplingHeaderWithoutTraceIdDoesNotUseTraceSampler() {
target.path("/trace").request()
Expand Down Expand Up @@ -209,6 +245,29 @@ public void testFilter_setsMdcIfTraceIdHeaderIsNotePresent() throws Exception {
public static class TracingTestServer extends Application<Configuration> {
@Override
public final void run(Configuration config, final Environment env) throws Exception {
FilterRegistration.Dynamic filter = env.servlets().addFilter("trace-leak-validator", new Filter() {
@Override
public void init(FilterConfig filterConfig) {}

@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
throws IOException, ServletException {
if (Tracer.hasTraceId()) {
unexpectedTraces.add(Tracer.getAndClearTrace());
}
try {
chain.doFilter(request, response);
} finally {
if (Tracer.hasTraceId()) {
unexpectedTraces.add(Tracer.getAndClearTrace());
}
}
}

@Override
public void destroy() {}
});
filter.addMappingForUrlPatterns(EnumSet.allOf(DispatcherType.class), false, "/*");
env.jersey().register(new TraceEnrichingFilter());
env.jersey().register(new TracingTestResource());
}
Expand All @@ -223,6 +282,11 @@ public void postTraceOperation() {}

@Override
public void getTraceWithPathParam() {}

@Override
public void getAsync(AsyncResponse asyncResponse) {
new Thread(() -> asyncResponse.resume("complete")).start();
}
}

@Path("/")
Expand All @@ -240,5 +304,9 @@ public interface TracingTestService {
@GET
@Path("/trace/{param}")
void getTraceWithPathParam();

@GET
@Path("/trace/async")
void getAsync(@Suspended AsyncResponse asyncResponse);
}
}