test_zipkin_trace.py

# Copyright (c) 2015 Uber Technologies, Inc.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.

import base64
import json
import random

import pytest
import tornado
import tornado.gen

from tchannel import TChannel, Response
from tchannel.event import EventHook
from tchannel.tornado import Request
from tchannel.zipkin import annotation
from tchannel.zipkin.annotation import Endpoint
from tchannel.zipkin.annotation import client_send
from tchannel.zipkin.formatters import thrift_formatter, ipv4_to_int
from tchannel.zipkin.tcollector import TCollector
from tchannel.zipkin.tcollector import Response as TResponse
from tchannel.zipkin.trace import Trace, _uniq_id
from tchannel.zipkin.tracers import TChannelZipkinTracer
from tchannel.zipkin.zipkin_trace import ZipkinTraceHook
from tests.mock_server import MockServer
from tornado.concurrent import Future

try:
    from cStringIO import StringIO
except:
    from StringIO import StringIO


def register(tchannel):

    @tchannel.raw.register('endpoint1')
    @tornado.gen.coroutine
    def handler1(request):
        hostport = request.headers

        res = yield tchannel.raw(
            service='handler2',
            hostport=hostport,
            endpoint="endpoint2",
            trace=True,
        )

        raise tornado.gen.Return(Response(res.body, "from handler1"))

    @tchannel.raw.register('endpoint2')
    @tornado.gen.coroutine
    def handler2(request):
        return "from handler2"

    @tchannel.thrift.register(TCollector)
    def submit(request):
        span = request.body.span
        ok = request.transport.shard_key == base64.b64encode(span.traceId)
        return TResponse(ok=ok)


trace_buf = StringIO()


@pytest.yield_fixture
def trace_server():
    with MockServer() as server:
        register(server.tchannel)
        server.tchannel.hooks.register(
            ZipkinTraceHook(
                dst=trace_buf,
                sample_rate=1,
            ),
        )
        yield server


@pytest.mark.gen_test
def test_zipkin_trace(trace_server):
    endpoint = b'endpoint1'
    zipkin_tracer = ZipkinTraceHook(dst=trace_buf, sample_rate=1)
    tchannel = TChannel(name='test')
    tchannel.hooks.register(zipkin_tracer)

    hostport = 'localhost:%d' % trace_server.port

    response = yield tchannel.raw(
        service='test-client',
        hostport=hostport,
        endpoint=endpoint,
        headers=hostport,
        trace=True,
    )

    header = response.headers
    body = response.body
    assert header == "from handler1"
    assert body == "from handler2"
    traces = []
    for trace in trace_buf.getvalue().split("\n"):
        if trace:
            traces.append(json.loads(trace))

    parent_span_id = object()
    trace_id = traces[0][0][u'trace_id']

    assert traces

    for trace in traces:
        assert trace_id == trace[0][u'trace_id']
        if trace[0][u'name'] == u'endpoint2':
            parent_span_id = trace[0][u'parent_span_id']
        else:
            span_id = trace[0][u'span_id']
    assert parent_span_id == span_id


@pytest.mark.gen_test
def test_tcollector_submit(trace_server):
    tchannel = TChannel(name='test', known_peers=[trace_server.hostport])

    trace = Trace(
        name='endpoint', endpoint=Endpoint('1.0.0.1', 1111, 'tcollector')
    )
    anns = [client_send()]

    results = yield TChannelZipkinTracer(tchannel).record([(trace, anns)])

    assert results[0].body.ok is True


@pytest.mark.gen_test
def test_zipkin_trace_sampling():
    run_times = 100000
    sample_rate = 1.0 - random.random()
    hook = ZipkinTraceHook(sample_rate=sample_rate)
    count = 0
    for _ in range(run_times):
        if hook._lucky(_uniq_id()):
            count += 1

    assert 0.9 * run_times * sample_rate <= count
    assert count <= run_times * sample_rate * 1.1


@pytest.mark.gen_test
def test_zipkin_trace_zero_sampling():
    run_times = 100000
    hook = ZipkinTraceHook(sample_rate=0)

    request = Request()
    request.tracing.traceflags = True
    for _ in range(run_times):
        hook.before_send_request(request)

    assert not request.tracing.annotations


def test_parse_host_port():
    tchannel = TChannel('test')
    tchannel.listen()

    tracer = TChannelZipkinTracer(tchannel)
    host_span = tracer.parse_host_port()
    assert tchannel.hostport == "%s:%d" % (host_span.ipv4, host_span.port)
    assert tchannel.name == host_span.service_name


def test_span_host_field():
    tchannel = TChannel('test')
    tchannel.listen()

    tracer = TChannelZipkinTracer(tchannel)
    host_span = tracer.parse_host_port()
    thrift_obj = thrift_formatter(
        trace=Trace(name='test', endpoint=Endpoint('0.0.0.1', 90, 'test1')),
        annotations=[annotation.client_send()],
        isbased64=False,
        span_host=host_span,
    )

    assert thrift_obj.spanHost.ipv4 == ipv4_to_int(host_span.ipv4)
    assert thrift_obj.spanHost.port == host_span.port
    assert thrift_obj.spanHost.serviceName == host_span.service_name


@pytest.mark.gen_test
def test_no_infinite_trace_submit():

    def submit(request):
        count[0] += 1
        # three time (1 time as client, 2 times as server)
        if count[0] == 3:
            f.set_result(count[0])
        return TResponse(True)

    count = [0]
    f = Future()

    zipkin_server = TChannel('zipkin')
    zipkin_server.thrift.register(TCollector, handler=submit)
    zipkin_server.listen()

    class TestTraceHook(EventHook):
        def __init__(self):
            self.invalid_traceflag = 0

        def before_send_request(self, request):
            if request.service == 'tcollector' and request.tracing.traceflags:
                self.invalid_traceflag += 1

    server = TChannel('server', known_peers=[zipkin_server.hostport])
    server.hooks.register(ZipkinTraceHook(tchannel=server, sample_rate=1))
    test_trace_hook = TestTraceHook()
    server.hooks.register(test_trace_hook)
    server.thrift.register(TCollector, handler=submit)

    @server.raw.register
    @tornado.gen.coroutine
    def hello(request):
        if request.body == 'body':
            yield server.raw(
                service='server',
                endpoint='hello',
                body='boy',
                hostport=server.hostport,
                trace=True,
            )
        raise tornado.gen.Return('hello')

    server.listen()

    client = TChannel('client')
    client.thrift.register(TCollector, handler=submit)
    yield client.raw(
        service='server',
        endpoint='hello',
        hostport=server.hostport,
        body='body',
        trace=True,
    )

    count = yield f
    assert count == 3
    assert test_trace_hook.invalid_traceflag == 0