Use pytest functionality to lookup codebase name (#35)

Co-authored-by: Chris Guidry <[email protected]>

Author: martin-pil

src/pytest_opentelemetry/instrumentation.py

@@ -59,7 +59,7 @@ def pytest_configure(self, config: Config) -> None:
             OpenTelemetryContainerDistro().configure()
 
         configurator = OpenTelemetryContainerConfigurator()
-        configurator.resource_detectors.append(CodebaseResourceDetector())
+        configurator.resource_detectors.append(CodebaseResourceDetector(config))
         configurator.resource_detectors.append(OTELResourceDetector())
         configurator.configure()
 

src/pytest_opentelemetry/resource.py

@@ -1,9 +1,9 @@
-import os
 import subprocess
 from typing import Dict, Union
 
 from opentelemetry.sdk.resources import Resource, ResourceDetector
 from opentelemetry.semconv.resource import ResourceAttributes
+from pytest import Config
 
 Attributes = Dict[str, Union[str, bool, int, float]]
 
@@ -12,11 +12,23 @@ class CodebaseResourceDetector(ResourceDetector):
     """Detects OpenTelemetry Resource attributes for an operating system process,
     providing the `process.*` attributes"""
 
-    @staticmethod
-    def get_codebase_name() -> str:
-        # TODO: any better ways to guess the name of the codebase?
-        # TODO: look into methods for locating packaging information
-        return os.path.split(os.getcwd())[-1]
+    def __init__(self, config: Config):
+        self.config = config
+        ResourceDetector.__init__(self)
+
+    def get_codebase_name(self) -> str:
+        """Get the name of the codebase.
+
+        In order of preference:
+        junit_suite_name
+        --junitprefix
+        rootpath: Guaranteed to exist, the reference used to construct nodeid
+        """
+        return str(
+            self.config.inicfg.get('junit_suite_name')
+            or self.config.getoption("--junitprefix", None)
+            or self.config.rootpath.name
+        )
 
     @staticmethod
     def get_codebase_version() -> str:

tests/test_resource.py

@@ -3,7 +3,7 @@
 import subprocess
 import tempfile
 from typing import Generator
-from unittest.mock import patch
+from unittest.mock import MagicMock, Mock, patch
 
 import pytest
 from opentelemetry.sdk.resources import Resource
@@ -26,11 +26,27 @@ def bare_codebase() -> Generator[str, None, None]:
 
 @pytest.fixture
 def resource() -> Resource:
-    return CodebaseResourceDetector().detect()
+    return CodebaseResourceDetector(Mock()).detect()
 
 
-def test_service_name_from_directory(bare_codebase: str, resource: Resource) -> None:
-    assert resource.attributes['service.name'] == 'my-project'
+def test_get_codebase_name() -> None:
+    config = MagicMock()
+    config.inicfg = {'junit_suite_name': 'my-project'}
+    config.rootpath.name = None
+    config.getoption.return_value = None
+    assert CodebaseResourceDetector(config).get_codebase_name() == 'my-project'
+
+    config = MagicMock()
+    config.inicfg = {}
+    config.rootpath.name = None
+    config.getoption.return_value = 'my-project'
+    assert CodebaseResourceDetector(config).get_codebase_name() == 'my-project'
+
+    config = MagicMock()
+    config.inicfg = {}
+    config.rootpath.name = 'my-project'
+    config.getoption.return_value = None
+    assert CodebaseResourceDetector(config).get_codebase_name() == 'my-project'
 
 
 def test_service_version_unknown(bare_codebase: str, resource: Resource) -> None:
@@ -45,15 +61,15 @@ def test_service_version_git_problems() -> None:
             subprocess.CalledProcessError(128, ['git', 'rev-parse', 'HEAD']),
         ],
     ):
-        resource = CodebaseResourceDetector().detect()
+        resource = CodebaseResourceDetector(Mock()).detect()
         assert resource.attributes['service.version'] == (
             "[unknown: Command '['git', 'rev-parse', 'HEAD']' "
             "returned non-zero exit status 128.]"
         )
     with patch(
         'pytest_opentelemetry.resource.subprocess.check_output', side_effect=[b'false']
     ):
-        resource = CodebaseResourceDetector().detect()
+        resource = CodebaseResourceDetector(Mock()).detect()
         assert resource.attributes['service.version'] == (
             "[unknown: not a git repository]"
         )