TracingServiceTest.java

/*
 * Copyright 2016 LINE Corporation
 *
 * LINE Corporation licenses this file to you under the Apache License,
 * version 2.0 (the "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at:
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations
 * under the License.
 */

package com.linecorp.armeria.server.tracing;

import static com.linecorp.armeria.common.http.HttpSessionProtocols.H2C;
import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.ArgumentMatchers.isA;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

import java.util.Collections;
import java.util.List;
import java.util.concurrent.TimeUnit;
import java.util.function.Consumer;
import java.util.stream.Collectors;

import org.junit.Test;

import com.github.kristofa.brave.Brave;
import com.github.kristofa.brave.KeyValueAnnotation;
import com.github.kristofa.brave.Sampler;
import com.github.kristofa.brave.SpanId;
import com.github.kristofa.brave.TraceData;

import com.linecorp.armeria.common.RpcRequest;
import com.linecorp.armeria.common.RpcResponse;
import com.linecorp.armeria.common.logging.DefaultRequestLog;
import com.linecorp.armeria.common.logging.RequestLog;
import com.linecorp.armeria.common.tracing.HelloService;
import com.linecorp.armeria.common.tracing.SpanCollectingReporter;
import com.linecorp.armeria.server.Service;
import com.linecorp.armeria.server.ServiceRequestContext;

import io.netty.channel.Channel;
import zipkin.Annotation;
import zipkin.Span;

public class TracingServiceTest {

    private static final String TEST_SERVICE = "test-service";

    private static final String TEST_METHOD = "hello";

    @Test(timeout = 10000)
    public void shouldSubmitSpanWhenRequestIsSampled() throws Exception {
        SpanCollectingReporter reporter = testServiceInvocation(true /* sampled */);

        // check span name
        Span span = reporter.spans().take();
        assertThat(span.name).isEqualTo(TEST_METHOD);

        // only one span should be submitted
        assertThat(reporter.spans().poll(1, TimeUnit.SECONDS)).isNull();

        // check # of annotations
        List<Annotation> annotations = span.annotations;
        assertThat(annotations).hasSize(2);

        // check annotation values
        List<String> values = annotations.stream().map(anno -> anno.value).collect(Collectors.toList());
        assertThat(values).containsExactlyInAnyOrder("sr", "ss");

        // check service name
        List<String> serviceNames = annotations.stream()
                                               .map(anno -> anno.endpoint.serviceName)
                                               .collect(Collectors.toList());
        assertThat(serviceNames).containsExactly(TEST_SERVICE, TEST_SERVICE);
    }

    @Test
    public void shouldNotSubmitSpanWhenRequestIsNotSampled() throws Exception {
        SpanCollectingReporter reporter = testServiceInvocation(false /* not sampled */);

        // don't submit any spans
        assertThat(reporter.spans().poll(1, TimeUnit.SECONDS)).isNull();
    }

    private static SpanCollectingReporter testServiceInvocation(boolean sampled) throws Exception {
        SpanCollectingReporter reporter = new SpanCollectingReporter();

        Brave brave = new Brave.Builder(TEST_SERVICE)
                .reporter(reporter)
                .traceSampler(Sampler.create(1.0f))
                .build();

        @SuppressWarnings("unchecked")
        Service<RpcRequest, RpcResponse> delegate = mock(Service.class);

        final TraceData traceData;
        if (sampled) {
            traceData = TraceData.create(SpanId.builder().traceId(1).spanId(2).parentId(3L).build());
        } else {
            traceData = TraceData.NOT_SAMPLED;
        }

        final TracingServiceImpl stub = new TracingServiceImpl(delegate, brave, traceData);

        final ServiceRequestContext ctx = mock(ServiceRequestContext.class);
        final RpcRequest req = RpcRequest.of(HelloService.Iface.class, "hello", "trustin");
        final DefaultRequestLog log = new DefaultRequestLog(ctx);
        log.startRequest(mock(Channel.class), H2C, "localhost", TEST_METHOD, "/");
        log.endRequest();

        // AbstractTracingService prefers RpcRequest.method() to ctx.method(), so "POST" should be ignored.
        when(ctx.method()).thenReturn("POST");
        when(ctx.log()).thenReturn(log);
        when(ctx.logBuilder()).thenReturn(log);
        ctx.onEnter(isA(Consumer.class));
        ctx.onExit(isA(Consumer.class));

        RpcResponse res = RpcResponse.of("Hello, trustin!");
        when(delegate.serve(ctx, req)).thenReturn(res);

        // do invoke
        stub.serve(ctx, req);

        verify(delegate, times(1)).serve(eq(ctx), eq(req));

        log.endResponse();
        return reporter;
    }

    private static class TracingServiceImpl extends AbstractTracingService<RpcRequest, RpcResponse> {

        private final TraceData traceData;

        TracingServiceImpl(Service<RpcRequest, RpcResponse> delegate, Brave brave, TraceData traceData) {
            super(delegate, brave);
            this.traceData = traceData;
        }

        @Override
        protected TraceData getTraceData(ServiceRequestContext ctx, RpcRequest req) {
            return traceData;
        }

        @Override
        protected List<KeyValueAnnotation> annotations(ServiceRequestContext ctx, RequestLog log) {
            return Collections.emptyList();
        }
    }
}