V3.0.0 (opentracing#36)

* Update our OT dependency to 2.0.0
* Implement Span propagation (opentracing#25)

Author: carlosalberto

.flake8

@@ -0,0 +1,3 @@
+[flake8]
+exclude =
+    basictracer/wire_pb2.py

.travis.yml

@@ -1,10 +1,9 @@
 language: python
-python: 
+python:
   - "2.7"
 
 install:
   - make bootstrap
 
 script:
-  - make test
-
+  - make test lint

CHANGELOG.rst

@@ -3,10 +3,10 @@
 History
 -------
 
-2.2.2 (unreleased)
-------------------
+3.0.0rc2 (2018-04-09)
+---------------------
 
-- Nothing changed yet.
+- Implement ScopeManager for in-process propagation.
 
 
 2.2.1 (2018-02-20)

Makefile

@@ -52,7 +52,7 @@ clean-test:
 	rm -fr htmlcov/
 
 lint:
-	flake8 $(project) tests
+	flake8 --config=.flake8 $(project) tests
 
 test:
 	$(pytest) $(test_args)

basictracer/tracer.py

@@ -3,6 +3,7 @@
 import opentracing
 from opentracing import Format, Tracer
 from opentracing import UnsupportedFormatException
+from opentracing.scope_managers import ThreadLocalScopeManager
 from .context import SpanContext
 from .recorder import SpanRecorder, DefaultSampler
 from .span import BasicSpan
@@ -11,7 +12,7 @@
 
 class BasicTracer(Tracer):
 
-    def __init__(self, recorder=None, sampler=None):
+    def __init__(self, recorder=None, sampler=None, scope_manager=None):
         """Initialize a BasicTracer instance.
 
         Note that the returned BasicTracer has *no* propagators registered. The
@@ -23,7 +24,10 @@ def __init__(self, recorder=None, sampler=None):
         with the binary carrier.
         """
 
-        super(BasicTracer, self).__init__()
+        scope_manager = ThreadLocalScopeManager() \
+            if scope_manager is None else scope_manager
+        super(BasicTracer, self).__init__(scope_manager)
+
         self.recorder = NoopRecorder() if recorder is None else recorder
         self.sampler = DefaultSampler(1) if sampler is None else sampler
         self._propagators = {}
@@ -44,13 +48,34 @@ def register_required_propagators(self):
         self.register_propagator(Format.HTTP_HEADERS, TextPropagator())
         self.register_propagator(Format.BINARY, BinaryPropagator())
 
-    def start_span(
-            self,
-            operation_name=None,
-            child_of=None,
-            references=None,
-            tags=None,
-            start_time=None):
+    def start_active_span(self,
+                          operation_name,
+                          child_of=None,
+                          references=None,
+                          tags=None,
+                          start_time=None,
+                          ignore_active_span=False,
+                          finish_on_close=True):
+
+        # create a new Span
+        span = self.start_span(
+            operation_name=operation_name,
+            child_of=child_of,
+            references=references,
+            tags=tags,
+            start_time=start_time,
+            ignore_active_span=ignore_active_span,
+        )
+
+        return self.scope_manager.activate(span, finish_on_close)
+
+    def start_span(self,
+                   operation_name=None,
+                   child_of=None,
+                   references=None,
+                   tags=None,
+                   start_time=None,
+                   ignore_active_span=False):
 
         start_time = time.time() if start_time is None else start_time
 
@@ -64,6 +89,12 @@ def start_span(
             # TODO only the first reference is currently used
             parent_ctx = references[0].referenced_context
 
+        # retrieve the active SpanContext
+        if not ignore_active_span and parent_ctx is None:
+            scope = self.scope_manager.active
+            if scope is not None:
+                parent_ctx = scope.span.context
+
         # Assemble the child ctx
         ctx = SpanContext(span_id=generate_id())
         if parent_ctx is not None:

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name='basictracer',
-    version='2.2.2.dev0',
+    version='3.0.0rc2',
     author='The OpenTracing Authors',
     author_email='info@opentracing.io',
     license='MIT',
@@ -22,7 +22,7 @@
     platforms='any',
     install_requires=[
         'protobuf>=3.0.0b2.post2',
-        'opentracing>=1.2.1,<2.0',
+        'opentracing==2.0.0',
         'six>=1.10.0,<2.0',
     ],
     extras_require={

tests/test_api.py

@@ -26,3 +26,10 @@ def tracer(self):
 
     def check_baggage_values(self):
         return True
+
+    def is_parent(self, parent, span):
+        # use `Span` ids to check parenting
+        if parent is None:
+            return span.parent_id is None
+
+        return parent.context.span_id == span.parent_id

tests/utils.py

@@ -0,0 +1,35 @@
+# Copyright (c) 2017 The OpenTracing Authors.
+#
+# 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.
+
+from __future__ import absolute_import
+
+from unittest import TestCase
+
+from basictracer import BasicTracer
+from basictracer.recorder import InMemoryRecorder
+
+
+class TracerTestCase(TestCase):
+    """Common TestCase to avoid duplication"""
+
+    def setUp(self):
+        # initialize an in-memory tracer
+        self.recorder = InMemoryRecorder()
+        self.tracer = BasicTracer(recorder=self.recorder)