Skip to content

Commit

Permalink
Add tests for census interceptor.
Browse files Browse the repository at this point in the history
  • Loading branch information
@voidzcy
voidzcy committed Jun 23, 2020
1 parent 4741f54 commit 2845bbc
Showing 1 changed file with 53 additions and 79 deletions.
132 changes: 53 additions & 79 deletions census/src/test/java/io/grpc/census/CensusClientInterceptorTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,49 +18,39 @@

import static com.google.common.truth.Truth.assertThat;

import com.google.common.collect.Iterables;
import io.grpc.CallOptions;
import io.grpc.Channel;
import io.grpc.ClientCall;
import io.grpc.ClientInterceptor;
import io.grpc.ClientInterceptors;
import io.grpc.ManagedChannel;
import io.grpc.Metadata;
import io.grpc.MethodDescriptor;
import io.grpc.ServerCall;
import io.grpc.ServerCallHandler;
import io.grpc.ServerServiceDefinition;
import io.grpc.Status;
import io.grpc.inprocess.InProcessChannelBuilder;
import io.grpc.inprocess.InProcessServerBuilder;
import io.grpc.inprocess.InternalInProcess;
import io.grpc.testing.GrpcCleanupRule;
import io.opencensus.trace.Tracer;
import io.opencensus.trace.propagation.BinaryFormat;
import java.io.InputStream;
import java.util.concurrent.atomic.AtomicReference;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
import org.mockito.Mock;
import org.mockito.junit.MockitoJUnit;
import org.mockito.junit.MockitoRule;

/**
* Test for {@link CensusClientInterceptor} and {@link CensusTracingModule}.
* Test for {@link CensusClientInterceptor}.
*/
@RunWith(JUnit4.class)
public class CensusClientInterceptorTest {

@Rule
public final MockitoRule mocks = MockitoJUnit.rule();
@Rule
public final GrpcCleanupRule grpcCleanupRule = new GrpcCleanupRule();

private static final CallOptions.Key<String> CUSTOM_OPTION =
CallOptions.Key.createWithDefault("option", "default");
private static final CallOptions CALL_OPTIONS =
CallOptions.DEFAULT.withOption(CUSTOM_OPTION, "customvalue");

private static class StringInputStream extends InputStream {
final String string;

Expand Down Expand Up @@ -97,92 +87,76 @@ public String parse(InputStream stream) {
.setFullMethodName("package1.service2/method3")
.build();

@Mock
private Tracer tracer;
@Mock
private BinaryFormat mockTracingPropagationHandler;
@Mock
private ClientCall.Listener<String> mockClientCallListener;
@Mock
private ServerCall.Listener<String> mockServerCallListener;
private final AtomicReference<CallOptions> callOptionsCaptor = new AtomicReference<>();

private ManagedChannel channel;


@SuppressWarnings("unchecked")
@Before
public void setUp() {
String serverName = InProcessServerBuilder.generateName();
grpcCleanupRule.register(
InProcessServerBuilder.forName(serverName)
.addService(
ServerServiceDefinition.builder("package1.service2")
.addMethod(method, new ServerCallHandler<String, String>() {
@Override
public ServerCall.Listener<String> startCall(
ServerCall<String, String> call, Metadata headers) {
call.sendHeaders(new Metadata());
call.sendMessage("Hello");
call.close(
Status.PERMISSION_DENIED.withDescription("No you don't"), new Metadata());
return mockServerCallListener;
}
}).build())
.directExecutor()
.build());
channel =
grpcCleanupRule.register(
InProcessChannelBuilder.forName(serverName).directExecutor().build());
}

@Test
public void disableDefaultClientStatsByInterceptor() {
ClientInterceptor interceptor =
CensusClientInterceptor.newBuilder().setStatsEnabled(false).build();
testDisableDefaultCensus(interceptor);
}

@Test
public void disableDefaultClientTracingByInterceptor() {

}

private void testDisableDefaultCensus(ClientInterceptor interceptor) {
final AtomicReference<CallOptions> capturedCallOptions = new AtomicReference<>();
ClientInterceptor callOptionsCaptureInterceptor = new ClientInterceptor() {
ClientInterceptor callOptionCaptureInterceptor = new ClientInterceptor() {
@Override
public <ReqT, RespT> ClientCall<ReqT, RespT> interceptCall(
MethodDescriptor<ReqT, RespT> method, CallOptions callOptions, Channel next) {
capturedCallOptions.set(callOptions);
callOptionsCaptor.set(callOptions);
return next.newCall(method, callOptions);
}
};
Channel interceptedChannel =
ClientInterceptors.intercept(channel, interceptor, callOptionsCaptureInterceptor);
ClientCall<String, String> call = interceptedChannel.newCall(method, CALL_OPTIONS);
assertThat(capturedCallOptions.get().getStreamTracerFactories()).isEmpty();
InProcessChannelBuilder builder =
InProcessChannelBuilder.forName("non-existing server").directExecutor();
InternalInProcess.setTestInterceptor(builder, callOptionCaptureInterceptor);
channel = grpcCleanupRule.register(builder.build());
}

@Test
public void stats_starts_finishes_realTime() {

}

@Test
public void stats_starts_finishes_noReaLTime() {

public void usingCensusInterceptorDisablesDefaultCensus() {
ClientInterceptor interceptor =
CensusClientInterceptor.newBuilder().build();
Channel interceptedChannel = ClientInterceptors.intercept(channel, interceptor);
interceptedChannel.newCall(method, CALL_OPTIONS);
assertThat(callOptionsCaptor.get().getStreamTracerFactories()).isEmpty();
}

@Test
public void stats_starts_noFinishes_noRealTime() {

public void customStatsConfig() {
ClientInterceptor interceptor =
CensusClientInterceptor.newBuilder()
.setStatsEnabled(true)
.setRecordStartedRpcs(false)
.setRecordFinishedRpcs(false)
.setRecordRealTimeMetrics(true)
.build();
Channel interceptedChannel = ClientInterceptors.intercept(channel, interceptor);
interceptedChannel.newCall(method, CALL_OPTIONS);
CensusStatsModule.ClientCallTracer callTracer =
(CensusStatsModule.ClientCallTracer) Iterables.getOnlyElement(
callOptionsCaptor.get().getStreamTracerFactories());
assertThat(callTracer.module.recordStartedRpcs).isEqualTo(false);
assertThat(callTracer.module.recordFinishedRpcs).isEqualTo(false);
assertThat(callTracer.module.recordRealTimeMetrics).isEqualTo(true);
}

@Test
public void stats_noStarts_finishes_noRealTime() {

public void onlyEnableTracing() {
ClientInterceptor interceptor =
CensusClientInterceptor.newBuilder().setTracingEnabled(true).build();
Channel interceptedChannel = ClientInterceptors.intercept(channel, interceptor);
interceptedChannel.newCall(method, CALL_OPTIONS);
assertThat(Iterables.getOnlyElement(callOptionsCaptor.get().getStreamTracerFactories()))
.isInstanceOf(CensusTracingModule.ClientCallTracer.class);
}

@Test
public void stats_noStarts_noFinishes_noRealTime() {

public void enableStatsAndTracing() {
ClientInterceptor interceptor =
CensusClientInterceptor.newBuilder().setStatsEnabled(true).setTracingEnabled(true).build();
Channel interceptedChannel = ClientInterceptors.intercept(channel, interceptor);
interceptedChannel.newCall(method, CALL_OPTIONS);
assertThat(callOptionsCaptor.get().getStreamTracerFactories()).hasSize(2);
assertThat(callOptionsCaptor.get().getStreamTracerFactories().get(0))
.isInstanceOf(CensusTracingModule.ClientCallTracer.class);
assertThat(callOptionsCaptor.get().getStreamTracerFactories().get(1))
.isInstanceOf(CensusStatsModule.ClientCallTracer.class);
}
}
}

0 comments on commit 2845bbc

Please sign in to comment.