def setUp(self):
self.time_patcher = patch('django_zipkin.api.time')
self.mock_time = self.time_patcher.start()
self.store = Mock(spec=BaseDataStore)
self.api = ZipkinApi(self.store)
def setUp(self):
self.time_patcher = patch('django_zipkin.api.time')
self.mock_time = self.time_patcher.start()
self.store = Mock(spec=BaseDataStore)
self.api = ZipkinApi(self.store)
class ZipkinApiTestCase(TestCase):
def setUp(self):
self.time_patcher = patch('django_zipkin.api.time')
self.mock_time = self.time_patcher.start()
self.store = Mock(spec=BaseDataStore)
self.api = ZipkinApi(self.store)
def tearDown(self):
self.time_patcher.stop()
def test_ipv4_to_long(self):
self.assertEqual(self.api._ipv4_to_long('127.0.0.1'), 2130706433)
def test_build_annotation(self):
value, duration = Mock(), Mock()
annotation = self.api._build_annotation(value, duration)
self.assertEqual(annotation.timestamp, self.mock_time.time.return_value * 1000 * 1000)
self.assertEqual(annotation.value, str(value))
self.assertEqual(annotation.duration, duration)
self.assertEqual(annotation.host, self.api.endpoint)
def test_record_event(self):
with patch.object(self.api, '_build_annotation') as mock_build_annotation:
value, duration = Mock(), Mock()
self.api.record_event(value, duration)
mock_build_annotation.assert_called_once_with(value, duration)
self.store.record.assert_called_once_with(mock_build_annotation.return_value)
def test_binary_annotation_type(self):
cases = {
'foo': AnnotationType.STRING,
True: AnnotationType.BOOL,
False: AnnotationType.BOOL,
5: AnnotationType.I64, # TODO: make type detection more granular
2**9: AnnotationType.I64, # TODO: make type detection more granular
2**17: AnnotationType.I64, # TODO: make type detection more granular
2**33: AnnotationType.I64, # TODO: make type detection more granular
3.14: AnnotationType.DOUBLE
}
for value, expected_type in cases.iteritems():
self.assertEqual(self.api._binary_annotation_type(value), expected_type, value)
def test_format_binary_annotation_value(self):
cases = {
AnnotationType.STRING: [('foo', 'foo'), (u'foo', 'foo')],
# TODO: add cases for smaller ints when type detection is made more granular
AnnotationType.BOOL: [(True, '1'), (False, '0')],
AnnotationType.I64: [(-42, '\xff\xff\xff\xff\xff\xff\xff\xd6'), (42, '\x00\x00\x00\x00\x00\x00\x00*')],
AnnotationType.DOUBLE: [(3.14, '@\t\x1e\xb8Q\xeb\x85\x1f')]
}
for type, pairs in cases.iteritems():
for input, expected in pairs:
self.assertEqual(self.api._format_binary_annotation_value(input, type), expected, input)
def test_build_binary_annotation(self):
annotation = self.api._build_binary_annotation('awesome', True)
self.assertEqual(annotation.key, 'awesome')
self.assertEqual(annotation.value, '1')
self.assertEqual(annotation.annotation_type, AnnotationType.BOOL)
self.assertEqual(annotation.host, self.api.endpoint)
def test_record_key_value(self):
with patch.object(self.api, '_build_binary_annotation') as mock_build_binary_annotation:
key, value = Mock(), Mock()
self.api.record_key_value(key, value)
mock_build_binary_annotation.assert_called_once_with(key, value)
self.store.record.assert_called_once_with(mock_build_binary_annotation.return_value)
def test_set_rpc_name(self):
self.api.set_rpc_name(sentinel.rpc_name)
self.store.set_rpc_name.assert_called_once_with(sentinel.rpc_name)
def test_build_span(self):
binary_annotations = [self.api._build_binary_annotation('awesome', True)]
annotations = [
self.api._build_annotation('sr'),
self.api._build_annotation('ss'),
]
self.store.get_annotations.return_value = annotations
self.store.get_binary_annotations.return_value = binary_annotations
span = self.api._build_span()
self.assertEqual(span.id, self.store.get.return_value.span_id.get_binary.return_value)
self.assertEqual(span.trace_id, self.store.get.return_value.trace_id.get_binary.return_value)
self.assertEqual(span.parent_id, self.store.get.return_value.parent_span_id.get_binary.return_value)
self.assertEqual(span.name, self.store.get_rpc_name.return_value)
self.assertEqual(span.annotations, annotations)
self.assertEqual(span.binary_annotations, binary_annotations)
def test_downstream_request_headers_with_parent_span_id(self):
generator = SimpleIdGenerator()
self.store.get.return_value = data = ZipkinData(
trace_id=generator.generate_trace_id(),
span_id=generator.generate_span_id(),
parent_span_id=generator.generate_span_id(),
sampled=True,
flags=True
)
self.assertDictEqual(self.api.get_headers_for_downstream_request(), {
'X-B3-TraceId': data.trace_id.get_hex(),
'X-B3-SpanId': data.span_id.get_hex(),
'X-B3-ParentSpanId': data.parent_span_id.get_hex(),
'X-B3-Sampled': 'true',
'X-B3-Flags': '1'
})
def test_downstream_request_headers_without_parent_span_id(self):
generator = SimpleIdGenerator()
self.store.get.return_value = data = ZipkinData(
trace_id=generator.generate_trace_id(),
span_id=generator.generate_span_id(),
sampled=True,
flags=0
)
self.assertDictEqual(self.api.get_headers_for_downstream_request(), {
'X-B3-TraceId': data.trace_id.get_hex(),
'X-B3-SpanId': data.span_id.get_hex(),
'X-B3-Sampled': 'true',
'X-B3-Flags': '0'
})
def test_downstream_request_headers_with_empty_data(self):
self.store.get.return_value = ZipkinData()
self.assertDictEqual(self.api.get_headers_for_downstream_request(), {
'X-B3-Sampled': 'false',
'X-B3-Flags': '0'
})
def test_nonascii_input(self):
uri_in = u'\ufffd\ufffd/\x01'
uri_out = uri_in.encode('utf-8')
self.store.get.return_value = ZipkinData(
trace_id=ZipkinId(42),
span_id=ZipkinId(4242),
parent_span_id=ZipkinId(1773),
sampled=True
)
self.store.get_binary_annotations.return_value = [self.api._build_binary_annotation('http.uri', uri_in)]
self.store.get_annotations.return_value = [self.api._build_annotation(uri_in)]
self.store.get_rpc_name.return_value = 'test-rpc-name'
self.api.build_log_message() # Assert no exception is raised
self.assertEqual(self.api._build_span().annotations[0].value, uri_out)
self.assertEqual(self.api._build_span().binary_annotations[0].value, uri_out)
def test_integration(self):
self.api.endpoint.ipv4 = 2130706433
binary_annotations = [self.api._build_binary_annotation('awesome', True)]
annotations = [
self.api._build_annotation('sr'),
self.api._build_annotation('ss'),
]
self.store.get_annotations.return_value = annotations
self.store.get_binary_annotations.return_value = binary_annotations
self.store.get.return_value = ZipkinData(
trace_id=ZipkinId(42),
span_id=ZipkinId(4242),
parent_span_id=ZipkinId(1773),
sampled=True
)
self.store.get_rpc_name.return_value = 'test-name'
self.mock_time.time.return_value = 1024
self.assertEqual(self.api.build_log_message(), self.api.build_log_message())
self.assertEqual(self.api.build_log_message(), 'CgABAAAAAAAAACoLAAMAAAAJdGVzdC1uYW1lCgAEAAAAAAAAEJIKAAUAAAAAAAAG7Q8ABgwAAAACCgABAAAAAAAAAAELAAIAAAACc3IMAAMIAAF/AAABAAAKAAEAAAAAAAAAAQsAAgAAAAJzcwwAAwgAAX8AAAEAAA8ACAwAAAABCwABAAAAB2F3ZXNvbWULAAIAAAABMQgAAwAAAAAMAAQIAAF/AAABAAACAAkAAA==')
class ZipkinApiTestCase(TestCase):
def setUp(self):
self.time_patcher = patch('django_zipkin.api.time')
self.mock_time = self.time_patcher.start()
self.store = Mock(spec=BaseDataStore)
self.api = ZipkinApi(self.store)
def tearDown(self):
self.time_patcher.stop()
def test_ipv4_to_long(self):
self.assertEqual(self.api._ipv4_to_long('127.0.0.1'), 2130706433)
def test_build_annotation(self):
value, duration = Mock(), Mock()
annotation = self.api._build_annotation(value, duration)
self.assertEqual(annotation.timestamp,
self.mock_time.time.return_value * 1000 * 1000)
self.assertEqual(annotation.value, str(value))
self.assertEqual(annotation.duration, duration)
self.assertEqual(annotation.host, self.api.endpoint)
def test_record_event(self):
with patch.object(self.api,
'_build_annotation') as mock_build_annotation:
value, duration = Mock(), Mock()
self.api.record_event(value, duration)
mock_build_annotation.assert_called_once_with(value, duration)
self.store.record.assert_called_once_with(
mock_build_annotation.return_value)
def test_binary_annotation_type(self):
cases = {
'foo': AnnotationType.STRING,
True: AnnotationType.BOOL,
False: AnnotationType.BOOL,
5: AnnotationType.I64, # TODO: make type detection more granular
2**9:
AnnotationType.I64, # TODO: make type detection more granular
2**17:
AnnotationType.I64, # TODO: make type detection more granular
2**33:
AnnotationType.I64, # TODO: make type detection more granular
3.14: AnnotationType.DOUBLE
}
for value, expected_type in cases.iteritems():
self.assertEqual(self.api._binary_annotation_type(value),
expected_type, value)
def test_format_binary_annotation_value(self):
cases = {
AnnotationType.STRING: [('foo', 'foo'), (u'foo', 'foo')],
# TODO: add cases for smaller ints when type detection is made more granular
AnnotationType.BOOL: [(True, '1'), (False, '0')],
AnnotationType.I64: [(-42, '\xff\xff\xff\xff\xff\xff\xff\xd6'),
(42, '\x00\x00\x00\x00\x00\x00\x00*')],
AnnotationType.DOUBLE: [(3.14, '@\t\x1e\xb8Q\xeb\x85\x1f')]
}
for type, pairs in cases.iteritems():
for input, expected in pairs:
self.assertEqual(
self.api._format_binary_annotation_value(input, type),
expected, input)
def test_build_binary_annotation(self):
annotation = self.api._build_binary_annotation('awesome', True)
self.assertEqual(annotation.key, 'awesome')
self.assertEqual(annotation.value, '1')
self.assertEqual(annotation.annotation_type, AnnotationType.BOOL)
self.assertEqual(annotation.host, self.api.endpoint)
def test_record_key_value(self):
with patch.object(
self.api,
'_build_binary_annotation') as mock_build_binary_annotation:
key, value = Mock(), Mock()
self.api.record_key_value(key, value)
mock_build_binary_annotation.assert_called_once_with(key, value)
self.store.record.assert_called_once_with(
mock_build_binary_annotation.return_value)
def test_set_rpc_name(self):
self.api.set_rpc_name(sentinel.rpc_name)
self.store.set_rpc_name.assert_called_once_with(sentinel.rpc_name)
def test_build_span(self):
binary_annotations = [
self.api._build_binary_annotation('awesome', True)
]
annotations = [
self.api._build_annotation('sr'),
self.api._build_annotation('ss'),
]
self.store.get_annotations.return_value = annotations
self.store.get_binary_annotations.return_value = binary_annotations
span = self.api._build_span()
self.assertEqual(
span.id,
self.store.get.return_value.span_id.get_binary.return_value)
self.assertEqual(
span.trace_id,
self.store.get.return_value.trace_id.get_binary.return_value)
self.assertEqual(
span.parent_id,
self.store.get.return_value.parent_span_id.get_binary.return_value)
self.assertEqual(span.name, self.store.get_rpc_name.return_value)
self.assertEqual(span.annotations, annotations)
self.assertEqual(span.binary_annotations, binary_annotations)
def test_downstream_request_headers_with_parent_span_id(self):
generator = SimpleIdGenerator()
self.store.get.return_value = data = ZipkinData(
trace_id=generator.generate_trace_id(),
span_id=generator.generate_span_id(),
parent_span_id=generator.generate_span_id(),
sampled=True,
flags=True)
self.assertDictEqual(
self.api.get_headers_for_downstream_request(), {
'X-B3-TraceId': data.trace_id.get_hex(),
'X-B3-SpanId': data.span_id.get_hex(),
'X-B3-ParentSpanId': data.parent_span_id.get_hex(),
'X-B3-Sampled': 'true',
'X-B3-Flags': '1'
})
def test_downstream_request_headers_without_parent_span_id(self):
generator = SimpleIdGenerator()
self.store.get.return_value = data = ZipkinData(
trace_id=generator.generate_trace_id(),
span_id=generator.generate_span_id(),
sampled=True,
flags=0)
self.assertDictEqual(
self.api.get_headers_for_downstream_request(), {
'X-B3-TraceId': data.trace_id.get_hex(),
'X-B3-SpanId': data.span_id.get_hex(),
'X-B3-Sampled': 'true',
'X-B3-Flags': '0'
})
def test_downstream_request_headers_with_empty_data(self):
self.store.get.return_value = ZipkinData()
self.assertDictEqual(self.api.get_headers_for_downstream_request(), {
'X-B3-Sampled': 'false',
'X-B3-Flags': '0'
})
def test_nonascii_input(self):
uri_in = u'\ufffd\ufffd/\x01'
uri_out = uri_in.encode('utf-8')
self.store.get.return_value = ZipkinData(trace_id=ZipkinId(42),
span_id=ZipkinId(4242),
parent_span_id=ZipkinId(1773),
sampled=True)
self.store.get_binary_annotations.return_value = [
self.api._build_binary_annotation('http.uri', uri_in)
]
self.store.get_annotations.return_value = [
self.api._build_annotation(uri_in)
]
self.store.get_rpc_name.return_value = 'test-rpc-name'
self.api.build_log_message() # Assert no exception is raised
self.assertEqual(self.api._build_span().annotations[0].value, uri_out)
self.assertEqual(self.api._build_span().binary_annotations[0].value,
uri_out)
def test_integration(self):
self.api.endpoint.ipv4 = 2130706433
binary_annotations = [
self.api._build_binary_annotation('awesome', True)
]
annotations = [
self.api._build_annotation('sr'),
self.api._build_annotation('ss'),
]
self.store.get_annotations.return_value = annotations
self.store.get_binary_annotations.return_value = binary_annotations
self.store.get.return_value = ZipkinData(trace_id=ZipkinId(42),
span_id=ZipkinId(4242),
parent_span_id=ZipkinId(1773),
sampled=True)
self.store.get_rpc_name.return_value = 'test-name'
self.mock_time.time.return_value = 1024
self.assertEqual(self.api.build_log_message(),
self.api.build_log_message())
self.assertEqual(
self.api.build_log_message(),
'CgABAAAAAAAAACoLAAMAAAAJdGVzdC1uYW1lCgAEAAAAAAAAEJIKAAUAAAAAAAAG7Q8ABgwAAAACCgABAAAAAAAAAAELAAIAAAACc3IMAAMIAAF/AAABAAAKAAEAAAAAAAAAAQsAAgAAAAJzcwwAAwgAAX8AAAEAAA8ACAwAAAABCwABAAAAB2F3ZXNvbWULAAIAAAABMQgAAwAAAAAMAAQIAAF/AAABAAACAAkAAA=='
)
