feat: prepare modules for the new API

testcontainers / testcontainers-go

Testcontainers for Go is a Go package that makes it simple to create and clean up container-based dependencies for automated integration/smoke tests. The clean, easy-to-use API enables developers to programmatically define containers that should be run as part of a test and clean up those resources when the test is done.

MIT License

3.3k stars 450 forks source link

feat: define new API for modules using Run
chore: update module generator
docs: update module generation
fixup: modulegen
docs: update module pages

What does this PR do?

This PR updates all the modules, the module generator and the current docs to use the new API:

deprecates RunContainer in favor of Run
the Run function needs the Docker image as second argument, which forces users to know which image is used in their tests.
updates the Go templates to generate new modules following this new API

Why is it important?

Prepare for a more consistent API that makes evident which image is used.

Follow-ups

Modules catalog examples will need to be udpated in consequence.

Name	Link
Latest commit	88ced06512c242d68a6b672a986052b8a7082dd1
Latest deploy log	https://app.netlify.com/sites/testcontainers-go/deploys/6683d0915ccfd00008efb377
Deploy Preview	https://deploy-preview-2610--testcontainers-go.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

Name

Link

Latest commit

88ced06512c242d68a6b672a986052b8a7082dd1

Latest deploy log

https://app.netlify.com/sites/testcontainers-go/deploys/6683d0915ccfd00008efb377

Deploy Preview

https://deploy-preview-2610--testcontainers-go.netlify.app

Preview on mobile

Toggle QR Code...

Use your smartphone camera to open QR code link.

testcontainers / testcontainers-go