Capture stdout and stderr when executing docker compose (#18859)

* commit

* linter

* get compose logs

* linter

* linter

* import SubprocessError

* fix SubprocessError

* remove -f

* capture output

* linter

* docker compose output

* remove import subprocesserror

* removed capture

* force ci

* capture

* propagate capture

* propagate capture

* self.capture

* linter

* test case for docker_run capture=True

* restored README.md

* add change log

Author: nenadnoveljic

datadog_checks_dev/changelog.d/18878.added

@@ -0,0 +1 @@
+Add ``capture`` parameter to ``docker_run`` to capture ``docker compose`` output.

datadog_checks_dev/datadog_checks/dev/docker.py

@@ -121,6 +121,7 @@ def docker_run(
     wrappers=None,
     attempts=None,
     attempts_wait=1,
+    capture=None,
 ):
     """
     A convenient context manager for safely setting up and tearing down Docker environments.
@@ -169,7 +170,10 @@ def docker_run(
         if not isinstance(compose_file, str):
             raise TypeError('The path to the compose file is not a string: {}'.format(repr(compose_file)))
 
-        set_up = ComposeFileUp(compose_file, build=build, service_name=service_name)
+        composeFileArgs = {'compose_file': compose_file, 'build': build, 'service_name': service_name}
+        if capture is not None:
+            composeFileArgs['capture'] = capture
+        set_up = ComposeFileUp(**composeFileArgs)
         if down is not None:
             tear_down = down
         else:
@@ -229,10 +233,11 @@ def docker_run(
 
 
 class ComposeFileUp(LazyFunction):
-    def __init__(self, compose_file, build=False, service_name=None):
+    def __init__(self, compose_file, build=False, service_name=None, capture=None):
         self.compose_file = compose_file
         self.build = build
         self.service_name = service_name
+        self.capture = capture
         self.command = ['docker', 'compose', '-f', self.compose_file, 'up', '-d', '--force-recreate']
 
         if self.build:
@@ -242,7 +247,10 @@ def __init__(self, compose_file, build=False, service_name=None):
             self.command.append(self.service_name)
 
     def __call__(self):
-        return run_command(self.command, check=True)
+        args = {'check': True}
+        if self.capture is not None:
+            args['capture'] = self.capture
+        return run_command(self.command, **args)
 
 
 class ComposeFileLogs(LazyFunction):

datadog_checks_dev/tests/test_docker.py

@@ -36,11 +36,21 @@ def test_up(self):
 
 
 class TestDockerRun:
-    def test_compose_file(self):
+    @pytest.mark.parametrize(
+        "capture",
+        [
+            None,
+            True,
+        ],
+    )
+    def test_compose_file(self, capture):
         compose_file = os.path.join(DOCKER_DIR, 'test_default.yaml')
 
         try:
-            with docker_run(compose_file):
+            args = {}
+            if capture is not None:
+                args['capture'] = capture
+            with docker_run(compose_file, **args):
                 assert compose_file_active(compose_file) is True
             assert compose_file_active(compose_file) is False
         finally:

sqlserver/tests/conftest.py

@@ -328,5 +328,7 @@ def high_cardinality_env_is_ready():
 
     conditions += [CheckDockerLogs(compose_file, completion_message)]
 
-    with docker_run(compose_file=compose_file, conditions=conditions, mount_logs=True, build=True, attempts=3):
+    with docker_run(
+        compose_file=compose_file, conditions=conditions, mount_logs=True, build=True, attempts=3, capture=True
+    ):
         yield full_e2e_config, E2E_METADATA