feat: pytest integration

.circleci/config.yml

@@ -617,6 +617,12 @@ jobs:
       - run_tox_scenario:
           pattern: '^pylibmc_contrib-'
 
+  pytest:
+    executor: ddtrace_dev
+    steps:
+      - run_tox_scenario:
+          pattern: '^pytest_contrib'
+
   pymemcache:
     <<: *contrib_job
     docker:
@@ -915,6 +921,7 @@ requires_tests: &requires_tests
   - pynamodb
   - pyodbc
   - pyramid
+  - pytest
   - redis
   - rediscluster
   - requests
@@ -1016,6 +1023,7 @@ workflows:
       - pynamodb: *requires_pre_test
       - pyodbc: *requires_pre_test
       - pyramid: *requires_pre_test
+      - pytest: *requires_pre_test
       - redis: *requires_pre_test
       - rediscluster: *requires_pre_test
       - requests: *requires_pre_test

conftest.py

@@ -11,6 +11,9 @@
 
 import pytest
 
+# DEV: Enable "testdir" fixture https://docs.pytest.org/en/stable/reference.html#testdir
+pytest_plugins = ("pytester",)
+
 PY_DIR_PATTERN = re.compile(r"^py[23][0-9]$")
 
 

ddtrace/constants.py

@@ -11,6 +11,7 @@
 VERSION_KEY = 'version'
 SERVICE_KEY = 'service.name'
 SERVICE_VERSION_KEY = 'service.version'
+SPAN_KIND = 'span.kind'
 SPAN_MEASURED_KEY = '_dd.measured'
 
 NUMERIC_TAGS = (ANALYTICS_SAMPLE_RATE_KEY, )

ddtrace/contrib/pytest/__init__.py

@@ -0,0 +1,49 @@
+"""
+The pytest integration traces test executions.
+
+Enabling
+~~~~~~~~
+
+Enable traced execution of tests using ``pytest`` runner by
+running ``pytest --ddtrace`` or by modifying any configuration
+file read by pytest (``pytest.ini``, ``setup.cfg``, ...)::
+
+    [pytest]
+    ddtrace = 1
+
+
+Global Configuration
+~~~~~~~~~~~~~~~~~~~~
+
+.. py:data:: ddtrace.config.pytest["service"]
+
+   The service name reported by default for pytest traces.
+
+   This option can also be set with the ``DD_PYTEST_SERVICE`` environment
+   variable.
+
+   Default: ``"pytest"``
+
+
+.. py:data:: ddtrace.config.pytest["operation_name"]
+
+   The operation name reported by default for pytest traces.
+
+   This option can also be set with the ``DD_PYTEST_OPERATION_NAME`` environment
+   variable.
+
+   Default: ``"pytest.test"``
+"""
+
+from ddtrace import config
+
+from ...utils.formats import get_env
+
+# pytest default settings
+config._add(
+    "pytest",
+    dict(
+        _default_service="pytest",
+        operation_name=get_env("pytest", "operation_name", default="pytest.test"),
+    ),
+)

ddtrace/contrib/pytest/constants.py

@@ -0,0 +1,4 @@
+FRAMEWORK = "pytest"
+KIND = "test"
+
+HELP_MSG = "Enable tracing of pytest functions."

ddtrace/contrib/pytest/plugin.py

@@ -0,0 +1,124 @@
+import pytest
+
+from ddtrace import config as ddconfig
+
+from ..trace_utils import int_service
+from ...constants import SPAN_KIND
+from ...ext import SpanTypes, ci, test
+from ...pin import Pin
+from .constants import FRAMEWORK, HELP_MSG, KIND
+
+
+def is_enabled(config):
+    """Check if the ddtrace plugin is enabled."""
+    return config.getoption("ddtrace") or config.getini("ddtrace")
+
+
+def _extract_span(item):
+    """Extract span from `pytest.Item` instance."""
+    return getattr(item, "_datadog_span", None)
+
+
+def _store_span(item, span):
+    """Store span at `pytest.Item` instance."""
+    setattr(item, "_datadog_span", span)
+
+
+def pytest_addoption(parser):
+    """Add ddtrace options."""
+    group = parser.getgroup("ddtrace")
+
+    group._addoption(
+        "--ddtrace",
+        action="store_true",
+        dest="ddtrace",
+        default=False,
+        help=HELP_MSG,
+    )
+
+    parser.addini("ddtrace", HELP_MSG, type="bool")
+
+
+def pytest_configure(config):
+    config.addinivalue_line("markers", "dd_tags(**kwargs): add tags to current span")
+
+    if is_enabled(config):
+        Pin(tags=ci.tags(), _config=ddconfig.pytest).onto(config)
+
+
+def pytest_sessionfinish(session, exitstatus):
+    """Flush open tracer."""
+    pin = Pin.get_from(session.config)
+    if pin is not None:
+        pin.tracer.shutdown()
+
+
+@pytest.fixture(scope="function")
+def ddspan(request):
+    pin = Pin.get_from(request.config)
+    if pin:
+        return _extract_span(request.node)
+
+
+@pytest.hookimpl(tryfirst=True, hookwrapper=True)
+def pytest_runtest_protocol(item, nextitem):
+    pin = Pin.get_from(item.config)
+    if pin is None:
+        yield
+        return
+
+    with pin.tracer.trace(
+        ddconfig.pytest.operation_name,
+        service=int_service(pin, ddconfig.pytest),
+        resource=item.nodeid,
+        span_type=SpanTypes.TEST.value,
+    ) as span:
+        span.set_tags(pin.tags)
+        span.set_tag(SPAN_KIND, KIND)
+        span.set_tag(test.FRAMEWORK, FRAMEWORK)
+        span.set_tag(test.NAME, item.name)
+        span.set_tag(test.SUITE, item.module.__name__)
+        span.set_tag(test.TYPE, SpanTypes.TEST.value)
+
+        markers = [marker.kwargs for marker in item.iter_markers(name="dd_tags")]
+        for tags in markers:
+            span.set_tags(tags)
+
+        _store_span(item, span)
+
+        yield
+
+
+def _extract_reason(call):
+    if call.excinfo is not None:
+        return call.excinfo.value
+
+
+@pytest.hookimpl(hookwrapper=True)
+def pytest_runtest_makereport(item, call):
+    """Store outcome for tracing."""
+    outcome = yield
+
+    span = _extract_span(item)
+    if span is None:
+        return
+
+    called_without_status = call.when == "call" and span.get_tag(test.STATUS) is None
+    failed_setup = call.when == "setup" and call.excinfo is not None
+    if not called_without_status and not failed_setup:
+        return
+
+    try:
+        result = outcome.get_result()
+        if result.skipped:
+            span.set_tag(test.STATUS, test.Status.SKIP.value)
+            reason = _extract_reason(call)
+            if reason is not None:
+                span.set_tag(test.SKIP_REASON, reason)
+        elif result.passed:
+            span.set_tag(test.STATUS, test.Status.PASS.value)
+        else:
+            raise RuntimeWarning(result)
+    except Exception:
+        span.set_traceback()
+        span.set_tag(test.STATUS, test.Status.FAIL.value)

ddtrace/ext/__init__.py

@@ -14,6 +14,7 @@ class SpanTypes(Enum):
     REDIS = "redis"
     SQL = "sql"
     TEMPLATE = "template"
+    TEST = "test"
     WEB = "web"
     WORKER = "worker"