fix[pytest]: extract module name from DoctestItem (#2794)

* Find module name from Doctest Item when using pytest with doctest

* Fix changelog

* Add type checking for Doctest object

Author: Yun-Kim

ddtrace/contrib/pytest/plugin.py

@@ -1,3 +1,4 @@
+from doctest import DocTest
 import json
 from typing import Dict
 
@@ -118,7 +119,10 @@ def pytest_runtest_protocol(item, nextitem):
         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__)
+        if hasattr(item, "module"):
+            span.set_tag(test.SUITE, item.module.__name__)
+        elif hasattr(item, "dtest") and isinstance(item.dtest, DocTest):
+            span.set_tag(test.SUITE, item.dtest.globs["__name__"])
         span.set_tag(test.TYPE, SpanTypes.TEST.value)
 
         # Parameterized test cases will have a `callspec` attribute attached to the pytest Item object.

docs/spelling_wordlist.txt

@@ -45,6 +45,7 @@ dbapi
 ddtrace
 deprecations
 django
+doctest
 dogpile
 dogpile.cache
 dogstatsd

releasenotes/notes/fix-pytest-doctest-4918b724f736ef88.yaml

@@ -0,0 +1,4 @@
+---
+fixes:
+  - |
+    Fixes an issue when using the pytest plugin with doctest which raises an ``AttributeError`` on ``DoctestItem``.

tests/contrib/pytest/test_pytest.py

@@ -498,6 +498,36 @@ def test_service(ddspan, pytestconfig):
         for span in decoded_trace:
             assert span[b"meta"][b"_dd.origin"] == b"ciapp-test"
 
+    def test_pytest_doctest_module(self):
+        """Test that pytest with doctest works as expected."""
+        py_file = self.testdir.makepyfile(
+            """
+        '''
+        This module supplies one function foo(). For example,
+        >>> foo()
+        42
+        '''
+
+        def foo():
+            '''Returns the answer to life, the universe, and everything.
+            >>> foo()
+            42
+            '''
+            return 42
+
+        def test_foo():
+            assert foo() == 42
+        """
+        )
+        file_name = os.path.basename(py_file.strpath)
+        rec = self.inline_run("--ddtrace", "--doctest-modules", file_name)
+        rec.assertoutcome(passed=3)
+        spans = self.pop_spans()
+
+        assert len(spans) == 3
+        for span in spans:
+            assert span.get_tag(test.SUITE) == file_name.partition(".py")[0]
+
 
 @pytest.mark.parametrize(
     "repository_url,repository_name",