[Modules]: add examples/modules on the most uses services/images

[mdelapenya]

Proposal

Given there is a tool to generate the scaffolding for new examples as Go modules (https://golang.testcontainers.org/examples), let's use it to start adding examples.

We have elaborated the list below from Testcontainers for Java. If you're interested in adding any example, please comment here the module you want to work on (we'll add your username to next to it in the list), use the tool to generate the scaffolding for the module you are interested in, and send a PR. We'll link your PR here next to the item in the list.

Our recommendation is to visit the Java module and start porting its behavior and settings to the Go example module.

Modules

• azure cosmosdb
• cassandra @anilsenay feat: Add Cassandra module #1726
• clickhouse @anilsenay feat: add clickhouse module #1372
• cockroachdb @mdelapenya feat: provide a tool to generate examples from code #618
• consul @bo-er add consul example #722 @Chris-AS1 Added Consul module #2194
• @alihanyalcin Implement couchbase module #932 add couchbase module #876
• db2
• dragonflydb
• dynalite
• elasticsearch @mdelapenya feat: add Elasticsearch module #1574
• gcloud
  • datastore @eddumelendez Add datastore example #638
  • firestore @eddumelendez Add firestore example #637
  • pubsub @eddumelendez Add pubsub example #640
  • spanner @eddumelendez Add spanner example #642
• hivemq
• inbucket @jespino Adding inbucket module #2142
• influxdb
• k3s @mritunjaysharma394 feat: adds k3s module #1194
• k6 @pablochacin K6 module #1721
• kafka @noctarius feat: add kafka (KRaft mode only) module #1610
• localstack @mdelapenya Create localstack example module #795
• mariadb @mdelapenya feat: add mariadb module #1548
• minio @adoublef feat: Add Minio module #2132
• mockserver @jespino Adding mockserver module #2085
• mongodb @ravilushqa MongoDB example #723 and simplify mongodb test #726
• mssqlserver @agosmou feat: add module to support Microsoft SQL Server #1969
• mysql @mdelapenya chore: add mysql example #700 @eddumelendez Add MySQL module #943
• nats @adoublef added NATS JetStream example #1190 @mdelapenya feat: convert NATS example into a module #1559
• neo4j @fbiville Implement neo4j as a Go module #921
• nginx @mdelapenya feat: provide a tool to generate examples from code #618
• openldap @jespino Openldap module support #2117
• oracle-xe
• orientdb
• postgresql @mdelapenya chore: postgres example #674 feat: add Postgres module #945
• presto
• pulsar @mdelapenya feat: provide a tool to generate examples from code #618
• questdb
• rabbitmq @mdelapenya feat: add RabbitMQ support #1618 @Tingaev Added example for RabbitMQ #1031
• redis @mdelapenya feat: provide a tool to generate examples from code #618
• redpanda @weeco feat: Add Redpanda module #1058
• selenium
• solr
• tidb
• toxiproxy @eddumelendez Add toxiproxy example #643
• trino
• vault @alihanyalcin feat: add Vault Module #942
• yugabytedb

[ravilushqa]

@mdelapenya can I pick mongodb?

[mdelapenya]

@mdelapenya can I pick mongodb?

Please do it! 🙏

[fbiville]

Interested in tackling Neo4j :)

[mdelapenya]

Interested in tackling Neo4j :)

@fbiville Amazing! Please do it, and thanks for your support :)

I created the subtask for you: #921

[Tingaev]

@mdelapenya can I pick RabbitMQ?

[mdelapenya]

@mdelapenya can I pick RabbitMQ?

@Tingaev please go for it! Do you want to create an example or a real Go module? We should probably communicate the difference in a clearer manner, but modules for designed as dependencies to be consumed by downstream project, and examples for simply demonstrations, copying the code snippets, which include private APIs. Whatever you prefer is welcome

[Tingaev]

Do you want to create an example or a real Go module?

@mdelapenya I thought and decided to make a module instead of just an example
I will close the PR with an example

[mdelapenya]

Do you want to create an example or a real Go module?

@mdelapenya I thought and decided to make a module instead of just an example I will close the PR with an example

@Tingaev please take a look at https://github.com/testcontainers/testcontainers-go/pull/1016/files#diff-bf2f2ea9f93d17fd1a016e2893c5b7fe7dae04263b1662c8e03926e4e728f495. In this PR we try to explain how to create it

[adoublef]

I would be keen to including a NATS example (possibly module in the future) what would be required to do so?

[eddumelendez]

@adoublef you can probably start with a NATS example similar to what we have in Testcontainers for Java, see this. If you know more about NATS and how Testcontainers can help then we are all ears to build a NATS module.

[adoublef]

@eddumelendez cool, I have been in the slack groups for a while & been learning how to use NATS personally so will be able to showcase a usage. I also know from the NATS slack group, a lot are using jetstream.

I could likely port this over as I have found myself being able to get this working on many small projects

EDIT: I have forked and created an example for NATS here would the next step in the process be to submit a PR? what would be recommended.

[mdelapenya]

@adoublef I'd suggest starting with an example is great for experimenting with a module, like an incubation stage. Once you are happy with it, you could convert it into a real module, as described in https://golang.testcontainers.org/modules

You could use the code generation tool to bootstrap the scaffolding, and/or migrate the existing example following this:

• File structure: https://golang.testcontainers.org/modules/#interested-in-converting-an-example-into-a-module
• Types and exposed functions/methods: https://golang.testcontainers.org/modules/#adding-types-and-methods-to-the-module

Please consider that the modules design is still in dev (see #1042) so it's evolving using proper, better abstractions in it.

[mritunjaysharma394]

Hi @mdelapenya, I am interested for k3s, can i pick iit up :))

Thanks!

[mdelapenya]

@mritunjaysharma394 be my guest and do it! There is a Java implementation you can follow (j terms of API), will post here a link to it as I'm AFK

[mritunjaysharma394]

That was quick, thanks a lot @mdelapenya, I guess you meant this link right?

also, loving this blog by you already!

[adoublef]

I wanted to request adding a minio module? I have a version that I use in a persoanl sdk where the API is near enough similar to what I'd find with the official modules.

Cc @mdelapenya

[mdelapenya]

I'm going to close this issue, as the modules catalog has grown a lot, and I think we do not need to track them all here.

Thank you all for your work creating modules!