testcontainers / testcontainers/testcontainers-python
Feature: Ryuk support in ComposeContainer class (like in Java)
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 2.3k
- Forks
- 386
- Merge moyen
- 4 h 40 min
- PR mergées (30 j)
- 1
Description
What are you trying to do?
When using testcontainers for Python in a CI/CD environment containers started using the ComposeContainer class are not stopped in crash or force-stop scenarios. The same class in Java cleaned up the started Containers via Ryuk.
It would be nice if the Python class ComposeContainer provides the same functionality of cleaning up the containers it started in a safe manner. (for example with Ryuk)
Safe cleanup of containers seems to be a core feature of the other *Container classes and is missing for compose files using the ComposeContainer class.
Here is a brief summary of how it is implemented in Java and potential changes:
ComposeContainer class in Java:
In the "start()" method "registerContainersForShutdown" is called. See:
In "registerContainersForShutdown"
the line ".registerLabelsFilterForCleanup(Collections.singletonMap("com.docker.compose.project", project));" effectivly adds a label filter to Ryuk using the official Docker property com.docker.compose.project with a random project ID. (see constructor of ComposeDelegate for "project" property)
Python doesn't have this functionality, see https://github.com/testcontainers/testcontainers-python/blob/a3476488ac1f7526a9c22d65251c8639d7089326/src/testcontainers/compose/compose.py#L84 for the analog of the ComposeContainer class in Python and https://github.com/testcontainers/testcontainers-python/blob/a3476488ac1f7526a9c22d65251c8639d7089326/src/testcontainers/compose/compose.py#L318 for the "start()" method that has no code to interact with Ryuk.
Why should it be done this way?
Please provide the same or similar functionality to allow safe usage of ComposeContainer class like in Java.
Thank you.
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez dans src/testcontainers/compose/compose.py, en particulier dans la classe ComposeContainer autour de la méthode start() référencée, et comparez-la aux implémentations Java ComposeContainer et ComposeDelegate liées. Examinez d’abord les API existantes d’enregistrement de Python Ryuk avant de décider comment les labels des projets Compose doivent être enregistrés. La tâche est terminée lorsque les conteneurs démarrés par ComposeContainer sont nettoyés en toute sécurité après des plantages ou des arrêts forcés, avec une couverture pertinente de ce comportement.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- docker, docker-compose, python
- Domaine
- devops, testing-qa
- Type d'issue
- Fonctionnalité
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- Active
- Clarté
- Clairement spécifiée
- Accessibilité débutants
- 68/100