Add ignore_removed param to containers.list() to control whether to

raise or ignore NotFound

Signed-off-by: Joffrey F <[email protected]>

Author: shin-

docker/models/containers.py

@@ -844,7 +844,7 @@ def get(self, container_id):
         return self.prepare_model(resp)
 
     def list(self, all=False, before=None, filters=None, limit=-1, since=None,
-             sparse=False):
+             sparse=False, ignore_removed=False):
         """
         List containers. Similar to the ``docker ps`` command.
 
@@ -882,6 +882,10 @@ def list(self, all=False, before=None, filters=None, limit=-1, since=None,
                 information, but guaranteed not to block. Use
                 :py:meth:`Container.reload` on resulting objects to retrieve
                 all attributes. Default: ``False``
+            ignore_removed (bool): Ignore failures due to missing containers
+                when attempting to inspect containers from the original list.
+                Set to ``True`` if race conditions are likely. Has no effect
+                if ``sparse=True``. Default: ``False``
 
         Returns:
             (list of :py:class:`Container`)
@@ -902,7 +906,8 @@ def list(self, all=False, before=None, filters=None, limit=-1, since=None,
                     containers.append(self.get(r['Id']))
                 # a container may have been removed while iterating
                 except NotFound:
-                    pass
+                    if not ignore_removed:
+                        raise
             return containers
 
     def prune(self, filters=None):

tests/unit/fake_api_client.py

@@ -20,15 +20,18 @@ def _mock_call(self, *args, **kwargs):
         return ret
 
 
-def make_fake_api_client():
+def make_fake_api_client(overrides=None):
     """
     Returns non-complete fake APIClient.
 
     This returns most of the default cases correctly, but most arguments that
     change behaviour will not work.
     """
+
+    if overrides is None:
+        overrides = {}
     api_client = docker.APIClient()
-    mock_client = CopyReturnMagicMock(**{
+    mock_attrs = {
         'build.return_value': fake_api.FAKE_IMAGE_ID,
         'commit.return_value': fake_api.post_fake_commit()[1],
         'containers.return_value': fake_api.get_fake_containers()[1],
@@ -47,15 +50,18 @@ def make_fake_api_client():
         'networks.return_value': fake_api.get_fake_network_list()[1],
         'start.return_value': None,
         'wait.return_value': {'StatusCode': 0},
-    })
+    }
+    mock_attrs.update(overrides)
+    mock_client = CopyReturnMagicMock(**mock_attrs)
+
     mock_client._version = docker.constants.DEFAULT_DOCKER_API_VERSION
     return mock_client
 
 
-def make_fake_client():
+def make_fake_client(overrides=None):
     """
     Returns a Client with a fake APIClient.
     """
     client = docker.DockerClient()
-    client.api = make_fake_api_client()
+    client.api = make_fake_api_client(overrides)
     return client

tests/unit/models_containers_test.py

@@ -359,6 +359,18 @@ def test_list(self):
         assert isinstance(containers[0], Container)
         assert containers[0].id == FAKE_CONTAINER_ID
 
+    def test_list_ignore_removed(self):
+        def side_effect(*args, **kwargs):
+            raise docker.errors.NotFound('Container not found')
+        client = make_fake_client({
+            'inspect_container.side_effect': side_effect
+        })
+
+        with pytest.raises(docker.errors.NotFound):
+            client.containers.list(all=True, ignore_removed=False)
+
+        assert client.containers.list(all=True, ignore_removed=True) == []
+
 
 class ContainerTest(unittest.TestCase):
     def test_name(self):