testcontainers / testcontainers/testcontainers-java
Container lifecycle management as Maven and Gradle plugins
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Java
- Sterne
- 8.7k
- Forks
- 1.9k
- Ø Merge
- 2 T. 17 Std.
- Gemergte PRs (30 T.)
- 9
Beschreibung
In jOOQ, one of the most re-occurring ideas is that jOOQ should tightly couple Testcontainers, Flyway/Liquibase and jOOQ's code generation. See e.g. https://github.com/jOOQ/jOOQ/issues/6551
This coupling is obviously a bad idea, because the glue code is only a few lines of code, but to make it sufficiently configurable on behalf of all 3 involved products, we'd have to go through a lot of hassle. Much better if all 3 products could be configured completely independently in a CI/CD pipeline.
This is already possible for Flyway/Liquibase and jOOQ, both in Maven and Gradle, but I think it's not trivial to do for Testcontainers yet? What I'd love to see is to have Maven and Gradle plugins available that would allow for controlling the lifecycle of a test container instance in a build, for example (in pseudo-Maven):
<plugins>
<!-- Start the database container -->
<plugin>
<artifactId>testcontainers-postgres-maven<artifactId>
<phase>initialize</phase>
<goal>start</goal>
</plugin>
<!-- Apply all schema migrations -->
<plugin>
<artifactId>flyway-maven<artifactId>
<phase>initialize</phase>
</plugin>
<!-- Generate jOOQ sources -->
<plugin>
<artifactId>jooq-codegen-maven<artifactId>
<phase>generate-sources</phase>
</plugin>
<!-- Stop the containers -->
<plugin>
<artifactId>testcontainers-postgres-maven<artifactId>
<phase>post-integration-test</phase>
<goal>stop</goal>
</plugin>
</plugin>
I don't think Maven has an equivalent of Java's finally clause (i.e. a phase that runs at the end irrespective of how many phases were run), so if the post-integration-test phase isn't reached, then the containers won't stop, but that can be handled:
- E.g. they could stop at the latest when the build VM terminates (might be possible?)
- Gradle might not have this problem
- The start goal could reset the container first, if it is already running
- They could use Maven profiles for the whole thing and put all 4 plugin executions in there
There are many details to flesh out, but you get the idea. I think the sort of versatility this offers to highly generic, configurable builds would be yet another killer feature for testcontainers, not just for testing, but for CI/CD pipelines in general.
I've found an example project here, that does something like what I have in mind:
https://github.com/squark-io/testcontainers-maven-plugin
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 damit, das verlinkte Beispiel squark-io/testcontainers-maven-plugin und die hier beschriebenen Anforderungen an den Lebenszyklus für Maven und Gradle zu prüfen. Lege fest, wie konfigurierbare Ziele zum Starten und Stoppen von Containern in die Build-Phasen integriert werden sollen, einschließlich der Bereinigung, wenn der Build vorzeitig endet; als erledigt gilt dies, wenn beide Plugin-Integrationen den vorgeschlagenen Lebenszyklus unabhängig von Flyway, Liquibase und jOOQ unterstützen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- docker, java
- Bereich
- build-system, devops, testing
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Aktiv
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100