Small PARAMETRIC cleanups (#5761)

Author: cbeauchesne

utils/_context/_scenarios/parametric.py

@@ -160,26 +160,16 @@ def get_apm_library(
         library_env: dict,
         library_extra_command_arguments: list[str],
     ) -> Generator[ParametricTestClientApi, None, None]:
-        log_path = f"{self.host_log_folder}/outputs/{request.cls.__name__}/{request.node.name}/server_log.log"
-        Path(log_path).parent.mkdir(parents=True, exist_ok=True)
-
-        with (
-            open(log_path, "w+", encoding="utf-8") as log_file,
-            self._test_client_factory.get_apm_library(
-                worker_id=worker_id,
-                test_id=test_id,
-                test_agent=test_agent,
-                library_env=library_env,
-                library_extra_command_arguments=library_extra_command_arguments,
-                test_server_log_file=log_file,
-            ) as result,
-        ):
+        with self._test_client_factory.get_apm_library(
+            request=request,
+            worker_id=worker_id,
+            test_id=test_id,
+            test_agent=test_agent,
+            library_env=library_env,
+            library_extra_command_arguments=library_extra_command_arguments,
+        ) as result:
             yield result
 
-        request.node.add_report_section(
-            "teardown", f"{self.library.name.capitalize()} Library Output", f"Log file:\n./{log_path}"
-        )
-
 
 def _get_base_directory() -> str:
     return str(Path.cwd())

utils/docker_fixtures/_test_clients/_core.py

@@ -2,6 +2,7 @@
 from pathlib import Path
 import shutil
 import subprocess
+from typing import TextIO
 
 from docker.models.images import Image
 import pytest
@@ -110,3 +111,9 @@ def image(self) -> Image:
     @property
     def command(self) -> list[str]:
         return self.image.attrs["Config"]["Cmd"]
+
+    def get_client_log_file(self, request: pytest.FixtureRequest) -> TextIO:
+        log_path = Path(f"{self.host_log_folder}/outputs/{request.cls.__name__}/{request.node.name}/server_log.log")
+        log_path.parent.mkdir(parents=True, exist_ok=True)
+
+        return log_path.open("w+", encoding="utf-8")

utils/docker_fixtures/_test_clients/_test_client_framework_integrations.py

@@ -1,7 +1,6 @@
 from collections.abc import Generator
 import contextlib
 from http import HTTPStatus
-from pathlib import Path
 import time
 import urllib.parse
 
@@ -67,11 +66,8 @@ def get_client(
         # overwrite env with the one provided by the test
         environment |= library_env
 
-        log_path = f"{self.host_log_folder}/outputs/{request.cls.__name__}/{request.node.name}/server_log.log"
-        Path(log_path).parent.mkdir(parents=True, exist_ok=True)
-
         with (
-            open(log_path, "w+", encoding="utf-8") as log_file,
+            self.get_client_log_file(request) as log_file,
             docker_run(
                 image=self.tag,
                 name=f"{self.container_name}-{test_id}",
@@ -88,7 +84,7 @@ def get_client(
             yield client
 
         request.node.add_report_section(
-            "teardown", f"{self.library.capitalize()} Library Output", f"Log file:\n./{log_path}"
+            "teardown", f"{self.library.capitalize()} Library Output", f"Log file:\n./{log_file.name}"
         )
 
 

utils/docker_fixtures/_test_clients/_test_client_parametric.py

@@ -3,7 +3,7 @@
 from http import HTTPStatus
 import time
 from types import TracebackType
-from typing import TextIO, TypedDict
+from typing import TypedDict
 import urllib.parse
 
 from _pytest.outcomes import Failed
@@ -31,12 +31,12 @@ class ParametricTestClientFactory(TestClientFactory):
     @contextlib.contextmanager
     def get_apm_library(
         self,
+        request: pytest.FixtureRequest,
         worker_id: str,
         test_id: str,
         test_agent: TestAgentAPI,
         library_env: dict,
         library_extra_command_arguments: list[str],
-        test_server_log_file: TextIO,
     ) -> Generator["ParametricTestClientApi", None, None]:
         host_port = get_host_port(worker_id, 4500)
         container_port = 8080
@@ -67,16 +67,19 @@ def get_apm_library(
                 # temporary workaround for the test server to be able to run the command
                 env["SYSTEM_TESTS_EXTRA_COMMAND_ARGUMENTS"] = " ".join(library_extra_command_arguments)
 
-        with docker_run(
-            image=self.tag,
-            name=f"{self.container_name}-{test_id}",
-            command=command,
-            env=env,
-            ports={f"{container_port}/tcp": host_port},
-            volumes=self.container_volumes,
-            log_file=test_server_log_file,
-            network=test_agent.network,
-        ) as container:
+        with (
+            self.get_client_log_file(request) as log_file,
+            docker_run(
+                image=self.tag,
+                name=f"{self.container_name}-{test_id}",
+                command=command,
+                env=env,
+                ports={f"{container_port}/tcp": host_port},
+                volumes=self.container_volumes,
+                log_file=log_file,
+                network=test_agent.network,
+            ) as container,
+        ):
             test_server_timeout = 60
 
             client = ParametricTestClientApi(
@@ -88,6 +91,10 @@ def get_apm_library(
 
             yield client
 
+        request.node.add_report_section(
+            "teardown", f"{self.library.capitalize()} Library Output", f"Log file:\n./{log_file.name}"
+        )
+
 
 def _fail(message: str):
     """Used to mak a test as failed"""