testcontainers / testcontainers/testcontainers-python
Feature: Ryuk support in ComposeContainer class (like in Java)
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 2.3k
- Forks
- 386
- Ø Merge
- 4 Std. 40 Min.
- Gemergte PRs (30 T.)
- 1
Beschreibung
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.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne in src/testcontainers/compose/compose.py, insbesondere bei der ComposeContainer-Klasse rund um die referenzierte start()-Methode, und vergleiche sie mit den verknüpften Implementierungen von Java ComposeContainer und ComposeDelegate. Verfolge zunächst die bestehenden APIs zur Registrierung von Python Ryuk, bevor du entscheidest, wie Labels für Compose-Projekte registriert werden sollten. Erledigt ist die Aufgabe, wenn von ComposeContainer gestartete Container nach Abstürzen oder erzwungenen Stopps sicher bereinigt werden, mit entsprechender Abdeckung dieses Verhaltens.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- docker, docker-compose, python
- Bereich
- devops, testing-qa
- Issue-Typ
- Feature
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Aktiv
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 68/100