Repository navigation
The future of community modules (the testcontainers-* packages) #412
Description
The testcontainers-* packages, e.g.:
were added as part of the last release, but it introduces a lot of complexity, for what could be just a lot of optional dependency groups in one package.
As it stands,
the dependency tree is something like:
testcontainers
+--- testcontainers-core -> *
+--- [postgres] (to represent "group" if testcontainers[postgres] or testcontainers[minio,postgres] is requested to be installed)
+--- testcontainers-postgres (*)
+--- testcontainers-core (*)
+--- sqlalchemy (*)
\--- psycopg2-binary (*)
but it could look like:
testcontainers
+--- [postgres] (to represent "group" if testcontainers[postgres] or testcontainers[minio,postgres] is requested to be installed)
+--- sqlalchemy (*)
\--- psycopg2-binary (*)
downsides:
- of course users may get import errors, and we should then wrap those to educate users on how to install
testcontainers[postgres]rather than justtestcontainers. - temporary pain while we lack 100% parity with testcontainers-java (log + port waiting, rather than importing sqlalchemy)
upsides:
- better developer experience on both sides (library and client side)
- we can publish a single package to pypi, we still have yet to hear back from Till, and he is the only maintainer on those packages.
Activity
alexanderankin commentedon Jan 15, 2024
all three currently available maintainers have a consensus (2 strongly, and one slightly) leaning towards the consolidated package approach but I wanted to make this decision publicly recorded in github issues, as well as to let people weigh in for consideration as well. thank you.
[-]Decide what to do with the `testcontainers-*` packages[/-][+]The future of community modules (the `testcontainers-*` packages)[/+]totallyzen commentedon Jan 26, 2024
hey @alexanderankin I've modified the title and pinned this as a major issue.
We need to talk more about this with everyone as it isn't just about package layout and dependencies, it also means we have a LOT of exponential testing to do and that is becoming prohibitive with the costs to running those.
Comments on what to do are welcome!
covatic-john commentedon Feb 14, 2024
Hey happy to help where I can
totallyzen commentedon Feb 16, 2024
Hey @covatic-john thanks for the offer! We'll definitnely take that up! I need to wrap my head around how we can split some of the work.
mypyis a pain in the back because of the many modules we already have.In addition, having chatted with Testcontainers staff they are also keen on reducing the number of "official" modules and try to make the generic containers flexible and easy to use (improving wait conditions for example).
If you fancy comparing
tc-java,tc-goandtc-pythonfor features it would be awesome as it gives us some ideas on what to aim for. To be clear, no expectations, just giving you ideas on what you could help with.Cheers!
covatic-john commentedon Feb 16, 2024