From abd9a5bd29525af969f7ab188e5e8e36ca548c53 Mon Sep 17 00:00:00 2001
From: Diego Hurtado <ocelotl@users.noreply.github.com>
Date: Tue, 24 May 2022 18:00:39 +0200
Subject: [PATCH] Document usage of stat_as_current_span as decorator (#2708)

---
 .../src/opentelemetry/trace/__init__.py       |  8 +++
 opentelemetry-api/tests/trace/test_tracer.py  | 52 +++++++++++++++----
 2 files changed, 51 insertions(+), 9 deletions(-)

diff --git a/opentelemetry-api/src/opentelemetry/trace/__init__.py b/opentelemetry-api/src/opentelemetry/trace/__init__.py
index 53eb0e96db4..be0d8933b7e 100644
--- a/opentelemetry-api/src/opentelemetry/trace/__init__.py
+++ b/opentelemetry-api/src/opentelemetry/trace/__init__.py
@@ -371,6 +371,14 @@ def start_as_current_span(
             with opentelemetry.trace.use_span(span, end_on_exit=True):
                 do_work()
 
+        This can also be used as a decorator::
+
+            @tracer.start_as_current_span("name"):
+            def function():
+                ...
+
+            function()
+
         Args:
             name: The name of the span to be created.
             context: An optional Context containing the span's parent. Defaults to the
diff --git a/opentelemetry-api/tests/trace/test_tracer.py b/opentelemetry-api/tests/trace/test_tracer.py
index 774746d41a6..a7ad589ae60 100644
--- a/opentelemetry-api/tests/trace/test_tracer.py
+++ b/opentelemetry-api/tests/trace/test_tracer.py
@@ -12,25 +12,59 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import unittest
 
-from opentelemetry import trace
+from contextlib import contextmanager
+from unittest import TestCase
+from unittest.mock import Mock
 
+from opentelemetry.trace import (
+    INVALID_SPAN,
+    NoOpTracer,
+    Span,
+    Tracer,
+    get_current_span,
+)
 
-class TestTracer(unittest.TestCase):
+
+class TestTracer(TestCase):
     def setUp(self):
-        self.tracer = trace.NoOpTracer()
+        self.tracer = NoOpTracer()
 
     def test_start_span(self):
         with self.tracer.start_span("") as span:
-            self.assertIsInstance(span, trace.Span)
+            self.assertIsInstance(span, Span)
 
-    def test_start_as_current_span(self):
+    def test_start_as_current_span_context_manager(self):
         with self.tracer.start_as_current_span("") as span:
-            self.assertIsInstance(span, trace.Span)
+            self.assertIsInstance(span, Span)
+
+    def test_start_as_current_span_decorator(self):
+
+        mock_call = Mock()
+
+        class MockTracer(Tracer):
+            def start_span(self, *args, **kwargs):
+                return INVALID_SPAN
+
+            @contextmanager
+            def start_as_current_span(self, *args, **kwargs):  # type: ignore
+                mock_call()
+                yield INVALID_SPAN
+
+        mock_tracer = MockTracer()
+
+        @mock_tracer.start_as_current_span("name")
+        def function():  # type: ignore
+            pass
+
+        function()  # type: ignore
+        function()  # type: ignore
+        function()  # type: ignore
+
+        self.assertEqual(mock_call.call_count, 3)
 
     def test_get_current_span(self):
         with self.tracer.start_as_current_span("test") as span:
-            trace.get_current_span().set_attribute("test", "test")
-            self.assertEqual(span, trace.INVALID_SPAN)
+            get_current_span().set_attribute("test", "test")
+            self.assertEqual(span, INVALID_SPAN)
             self.assertFalse(hasattr("span", "attributes"))