Skip to content

fix waiting for auto_remove container#3312

Open
huguesdk wants to merge 1 commit intodocker:mainfrom
huguesdk:fix_wait_auto_remove_container
Open

fix waiting for auto_remove container#3312
huguesdk wants to merge 1 commit intodocker:mainfrom
huguesdk:fix_wait_auto_remove_container

Conversation

@huguesdk
Copy link

@huguesdk huguesdk commented Feb 18, 2025

use the same logic as the cli (see here and here) to wait for the exit of a container when running one: ensure that a container run with auto_remove set to True has been removed when the function returns.

this prevents a race condition when trying to run another container with the same name directly afterwards.

the race condition can be reproduced like this:

import docker
client = docker.from_env()
while True:
    client.containers.run(
        "some_image",
        name="race_condition_test",
        command="sleep 1",
        auto_remove=True,
    )

after some time, this error happens:

Traceback (most recent call last):
  File "/usr/lib/python3.10/site-packages/docker/api/client.py", line 275, in _raise_for_status
    response.raise_for_status()
  File "/usr/lib/python3.10/site-packages/requests/models.py", line 1024, in raise_for_status
    raise HTTPError(http_error_msg, response=self)
requests.exceptions.HTTPError: 409 Client Error: Conflict for url: http+docker://localhost/v1.41/containers/create?name=race_condition_test

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "<stdin>", line 2, in <module>
  File "/usr/lib/python3.10/site-packages/docker/models/containers.py", line 876, in run
    container = self.create(image=image, command=command,
  File "/usr/lib/python3.10/site-packages/docker/models/containers.py", line 935, in create
    resp = self.client.api.create_container(**create_kwargs)
  File "/usr/lib/python3.10/site-packages/docker/api/container.py", line 440, in create_container
    return self.create_container_from_config(config, name, platform)
  File "/usr/lib/python3.10/site-packages/docker/api/container.py", line 457, in create_container_from_config
    return self._result(res, True)
  File "/usr/lib/python3.10/site-packages/docker/api/client.py", line 281, in _result
    self._raise_for_status(response)
  File "/usr/lib/python3.10/site-packages/docker/api/client.py", line 277, in _raise_for_status
    raise create_api_error_from_http_exception(e) from e
  File "/usr/lib/python3.10/site-packages/docker/errors.py", line 39, in create_api_error_from_http_exception
    raise cls(e, response=response, explanation=explanation) from e
docker.errors.APIError: 409 Client Error for http+docker://localhost/v1.41/containers/create?name=race_condition_test: Conflict ("Conflict. The container name "/race_condition_test" is already in use by container "2f632c9f52b2f9286574972a97ee615e3714204bf84aecae399623b609948301". You have to remove (or rename) that container to be able to reuse that name.")

@huguesdk huguesdk force-pushed the fix_wait_auto_remove_container branch from 825ac17 to 4418a23 Compare February 18, 2025 13:50
@legalsylvain
Copy link

legalsylvain commented Apr 12, 2025

Hi. Why CI is not executed here ?

@huguesdk huguesdk force-pushed the fix_wait_auto_remove_container branch from 4418a23 to 9c878a2 Compare April 12, 2025 16:41
@huguesdk
Copy link
Author

huguesdk commented Apr 12, 2025

@legalsylvain i think it is because someone should approve this change first. i’ve just pushed some new changes to improve the code even more.

@legalsylvain
Copy link

legalsylvain commented May 28, 2025

hi docker-py contributors. (@thaJeztah, @milas)

Could you take a look on that PR ? Thanks a lot !

@thaJeztah
Copy link
Member

thaJeztah commented May 28, 2025

Looks like CI didn't trigger; let me try a quick close/reopen

@thaJeztah thaJeztah closed this May 28, 2025
@thaJeztah thaJeztah reopened this May 28, 2025
@legalsylvain
Copy link

legalsylvain commented May 28, 2025

@huguesdk : could you take a look on red CI ?

@huguesdk huguesdk force-pushed the fix_wait_auto_remove_container branch from 9c878a2 to b503672 Compare May 30, 2025 09:46
fix waiting for auto_remove container
6fc2b9a 
use the same logic as the cli to wait for the exit of a container when
running one: ensure that a container run with auto_remove set to True
has been removed when the function returns.

this prevents a race condition when trying to run another container with
the same name directly afterwards.

signed-off-by: hugues de keyzer <docker@hugues.info>
@huguesdk huguesdk force-pushed the fix_wait_auto_remove_container branch from b503672 to 6fc2b9a Compare May 30, 2025 09:52
@huguesdk
Copy link
Author

huguesdk commented May 30, 2025

@legalsylvain i adjusted the tests to make them pass.

@thaJeztah do you think i should add tests for the new code?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@huguesdk @legalsylvain @thaJeztah