client.containers.run returns None if none of json-file or journald logging drivers used

Signed-off-by: Artem Bolshakov <[email protected]>

Author: bolshakov

docker/errors.py

@@ -127,8 +127,14 @@ def __init__(self, container, exit_status, command, image, stderr):
         self.command = command
         self.image = image
         self.stderr = stderr
-        msg = ("Command '{}' in image '{}' returned non-zero exit status {}: "
-               "{}").format(command, image, exit_status, stderr)
+
+        if stderr is None:
+            msg = ("Command '{}' in image '{}' returned non-zero exit "
+                   "status {}").format(command, image, exit_status, stderr)
+        else:
+            msg = ("Command '{}' in image '{}' returned non-zero exit "
+                   "status {}: {}").format(command, image, exit_status, stderr)
+
         super(ContainerError, self).__init__(msg)
 
 

docker/models/containers.py

@@ -667,6 +667,13 @@ def run(self, image, command=None, stdout=True, stderr=False,
             The container logs, either ``STDOUT``, ``STDERR``, or both,
             depending on the value of the ``stdout`` and ``stderr`` arguments.
 
+            ``STDOUT`` and ``STDERR`` may be read only if either ``json-file``
+            or ``journald`` logging driver used. Thus, if you are using none of
+            these drivers, a ``None`` object is returned instead. See the
+            `Engine API documentation
+            <https://docs.docker.com/engine/api/v1.30/#operation/ContainerLogs/>`_
+            for full details.
+
             If ``detach`` is ``True``, a :py:class:`Container` object is
             returned instead.
 
@@ -709,7 +716,14 @@ def run(self, image, command=None, stdout=True, stderr=False,
         if exit_status != 0:
             stdout = False
             stderr = True
-        out = container.logs(stdout=stdout, stderr=stderr)
+
+        logging_driver = container.attrs['HostConfig']['LogConfig']['Type']
+
+        if logging_driver == 'json-file' or logging_driver == 'journald':
+            out = container.logs(stdout=stdout, stderr=stderr)
+        else:
+            out = None
+
         if remove:
             container.remove()
         if exit_status != 0:

tests/integration/models_containers_test.py

@@ -88,6 +88,24 @@ def test_run_with_network(self):
         assert 'Networks' in attrs['NetworkSettings']
         assert list(attrs['NetworkSettings']['Networks'].keys()) == [net_name]
 
+    def test_run_with_none_driver(self):
+        client = docker.from_env(version=TEST_API_VERSION)
+
+        out = client.containers.run(
+            "alpine", "echo hello",
+            log_config=dict(type='none')
+        )
+        self.assertEqual(out, None)
+
+    def test_run_with_json_file_driver(self):
+        client = docker.from_env(version=TEST_API_VERSION)
+
+        out = client.containers.run(
+            "alpine", "echo hello",
+            log_config=dict(type='json-file')
+        )
+        self.assertEqual(out, b'hello\n')
+
     def test_get(self):
         client = docker.from_env(version=TEST_API_VERSION)
         container = client.containers.run("alpine", "sleep 300", detach=True)

tests/unit/errors_test.py

@@ -2,8 +2,10 @@
 
 import requests
 
-from docker.errors import (APIError, DockerException,
+from docker.errors import (APIError, ContainerError, DockerException,
                            create_unexpected_kwargs_error)
+from .fake_api import FAKE_CONTAINER_ID, FAKE_IMAGE_ID
+from .fake_api_client import make_fake_client
 
 
 class APIErrorTest(unittest.TestCase):
@@ -77,6 +79,36 @@ def test_is_client_error_400(self):
         assert err.is_client_error() is True
 
 
+class ContainerErrorTest(unittest.TestCase):
+    def test_container_without_stderr(self):
+        """The massage does not contain stderr"""
+        client = make_fake_client()
+        container = client.containers.get(FAKE_CONTAINER_ID)
+        command = "echo Hello World"
+        exit_status = 42
+        image = FAKE_IMAGE_ID
+        stderr = None
+
+        err = ContainerError(container, exit_status, command, image, stderr)
+        msg = ("Command '{}' in image '{}' returned non-zero exit status {}"
+               ).format(command, image, exit_status, stderr)
+        assert str(err) == msg
+
+    def test_container_with_stderr(self):
+        """The massage contains stderr"""
+        client = make_fake_client()
+        container = client.containers.get(FAKE_CONTAINER_ID)
+        command = "echo Hello World"
+        exit_status = 42
+        image = FAKE_IMAGE_ID
+        stderr = "Something went wrong"
+
+        err = ContainerError(container, exit_status, command, image, stderr)
+        msg = ("Command '{}' in image '{}' returned non-zero exit status {}: "
+               "{}").format(command, image, exit_status, stderr)
+        assert str(err) == msg
+
+
 class CreateUnexpectedKwargsErrorTest(unittest.TestCase):
     def test_create_unexpected_kwargs_error_single(self):
         e = create_unexpected_kwargs_error('f', {'foo': 'bar'})

tests/unit/fake_api.py

@@ -146,6 +146,12 @@ def get_fake_inspect_container(tty=False):
             "StartedAt": "2013-09-25T14:01:18.869545111+02:00",
             "Ghost": False
         },
+        "HostConfig": {
+            "LogConfig": {
+                "Type": "json-file",
+                "Config": {}
+            },
+        },
         "MacAddress": "02:42:ac:11:00:0a"
     }
     return status_code, response