Testcontainers for Java: Add showcase examples for different scenarios #54

amotl · 2023-04-06T13:11:08Z

About

Foundation for a potential tutorial about how to use Testcontainers for Java with CrateDB, and for re-using blueprints at, for example, crate/crate-jdbc#377.

=> README -- direct view

References

Details

The patch exercises different features of Testcontainers for Java with a basic query SELECT * FROM sys.summits LIMIT 3;.

TestClassScope: Class-scoped testcontainer instance with JUnit 4 @Rule/@ClassRule integration.
TestFunctionScope: Function-scoped testcontainer instance with JUnit 4 @Rule/@ClassRule integration.
TestJdbcUrlScheme: Database containers launched via Testcontainers "TC" JDBC URL scheme.
TestManual: Function-scoped testcontainer instance with manual setup/teardown.
TestSharedSingleton: Testcontainer instance shared across multiple test classes ¹, implemented using the Singleton pattern.
TestSharedSingletonEnvironmentVersion: Testcontainer instance honoring the CRATEDB_VERSION environment variable, suitable for running a test matrix on different versions of CrateDB, shared across multiple test classes.

Backlog

Startup

Propagating command-line options to CrateDB

Database provisioning

Other test frameworks

Testcontainers for Java also provides integrations for other test frameworks. Currently, all test cases are based on JUnit 4.

Sometimes it might be useful to define a container that is only started once for several test classes. There is no special support for this use case provided by the Testcontainers extension. Instead, this can be implemented using the Singleton pattern. See also Manual container lifecycle control » Singleton containers. ↩

BaurzhanSakhariev

Cool, thanks!

Left some minor comments but please wait for comments from others

testing/testcontainers/java/src/main/java/io/crate/example/testing/Application.java

testing/testcontainers/java/src/test/java/io/crate/example/testing/TestJDBCURLScheme.java

...ng/testcontainers/java/src/test/java/io/crate/example/testing/TestSharedSingletonMatrix.java

matriv

Thx @amotl !
Left some first comments, but I will also checkout the branch and give it a try locally as well.

testing/testcontainers/java/README.rst

testing/testcontainers/java/src/test/java/io/crate/example/testing/TestJDBCURLScheme.java

testing/testcontainers/java/README.rst

testing/testcontainers/java/build.gradle

Wrap connection into the try-with-resources so that it closes Statement and result set, and will get closed itself at the end.

matriv · 2023-04-07T12:06:56Z

@amotl I've pushed several changes/improvements, please take a look. (apologies, but It was easier than providing comments).

I've also added TestManualWithLegacyCrateJdbcDriver which shows how to use the legacy crate jdbc driver with testcontainers.

amotl

@matriv: Thanks for giving this some more love. I've added a few remarks to acknowledge my learning from your adjustments, and further suggestions for improvements.

testing/testcontainers/java/src/main/java/io/crate/example/testing/Application.java

testing/testcontainers/java/src/test/java/io/crate/example/testing/TestClassScope.java

testing/testcontainers/java/src/test/java/io/crate/example/testing/utils/TestingHelpers.java

...ng/testcontainers/java/src/test/java/io/crate/example/testing/TestSharedSingletonMatrix.java

...iners/java/src/test/java/io/crate/example/testing/TestSharedSingletonEnvironmentVersion.java

testing/testcontainers/java/src/test/java/io/crate/example/testing/TestManual.java

...tainers/java/src/test/java/io/crate/example/testing/TestManualWithLegacyCrateJdbcDriver.java

testing/testcontainers/java/src/test/java/io/crate/example/testing/TestSharedSingleton.java

hlcianfagna · 2023-04-12T14:09:33Z

testing/testcontainers/java/README.rst

+
+    # Start CrateDB.
+    docker run -it --rm --publish=4200:4200 --publish=5432:5432 \
+      crate:latest -Cdiscovery.type=single-node


Did I miss something or the discovery-type option is not passed to the JdbcDatabaseContainer ?

Thanks for bringing this up.

In this particular case, outlining basic examples only, CrateDB will also happily start without any options, right? So it would be acceptable to omit the -Cdiscovery.type=single-node option?

However, propagating command-line options to CrateDB will become important when aiming to use this in a multi-node scenario like what crate-java-testing provides per CrateTestCluster ¹, right? Did you already take this into account, @matriv, or would this be up to a second iteration?

Footnotes

See also https://github.com/crate/crate-jdbc/issues/377. ↩

I haven't tried testcontainers in multi-node setup, don't even know if that's supported by their existing infrastructure.

This test, doesn't have to do with testcontainers, the script starts a docker container manually and then runs the tests, connecting to the bound port of the container.

CrateDB will also happily start without any options, right?

That is correct, it goes ahead with a "best-effort cluster bootstrapping" and it works.

amotl · 2023-04-14T08:50:43Z

Hi. I've just added a final commit per 32fb516, effectively carrying over the summary from the pull request description into the "What's inside" section of the README. Can you have another look at this? Thanks already!

P.S.: The backlog items also outlined within the PR description have been converged into GH-55, so this would be ready for merging if you agree ¹. Thanks.

As you've all already acknowledged the PR, just leave a 👍 on this comment if you do. ↩

matriv

thank you!

amotl · 2023-04-14T13:05:58Z

Merged. Thanks!

amotl requested review from matriv and BaurzhanSakhariev April 6, 2023 13:16

amotl marked this pull request as ready for review April 6, 2023 13:16

amotl requested a review from hlcianfagna April 6, 2023 13:19

amotl mentioned this pull request Apr 6, 2023

Use Testcontainers instead of custom CrateDB integration test helper crate/crate-jdbc#377

Open

Testcontainers for Java: Add showcase examples for different scenarios

a6287c4

amotl force-pushed the amo/testing-testcontainers-java branch from b3224c9 to a6287c4 Compare April 6, 2023 13:51

BaurzhanSakhariev approved these changes Apr 6, 2023

View reviewed changes

testing/testcontainers/java/src/main/java/io/crate/example/testing/Application.java Outdated Show resolved Hide resolved

testing/testcontainers/java/src/main/java/io/crate/example/testing/Application.java Outdated Show resolved Hide resolved

amotl commented Apr 6, 2023

View reviewed changes

matriv reviewed Apr 6, 2023

View reviewed changes

testing/testcontainers/java/README.rst Show resolved Hide resolved

testing/testcontainers/java/src/test/java/io/crate/example/testing/TestJDBCURLScheme.java Outdated Show resolved Hide resolved

testing/testcontainers/java/README.rst Outdated Show resolved Hide resolved

amotl force-pushed the amo/testing-testcontainers-java branch 3 times, most recently from 27a1fa4 to 67c7050 Compare April 6, 2023 16:20

amotl requested a review from matriv April 6, 2023 16:22

amotl force-pushed the amo/testing-testcontainers-java branch from 67c7050 to 5178c77 Compare April 6, 2023 16:37

amotl commented Apr 6, 2023

View reviewed changes

testing/testcontainers/java/build.gradle Outdated Show resolved Hide resolved

testing/testcontainers/java/build.gradle Show resolved Hide resolved

testing/testcontainers/java/build.gradle Show resolved Hide resolved

amotl added 2 commits April 6, 2023 18:42

Testcontainers for Java: Improve documentation, and naming things

b03974d

Testcontainers for Java: Improve implementation of Application.query()

310f397

Wrap connection into the try-with-resources so that it closes Statement and result set, and will get closed itself at the end.

amotl force-pushed the amo/testing-testcontainers-java branch from 5178c77 to 310f397 Compare April 6, 2023 16:42

matriv added 2 commits April 7, 2023 15:02

Further improvements

4f59167

Rename class

507c898

matriv requested a review from BaurzhanSakhariev April 7, 2023 12:25

BaurzhanSakhariev approved these changes Apr 7, 2023

View reviewed changes

amotl commented Apr 7, 2023

View reviewed changes

Introduce helper methods for docker images

1f4f08c

matriv approved these changes Apr 8, 2023

View reviewed changes

hlcianfagna reviewed Apr 12, 2023

View reviewed changes

hlcianfagna approved these changes Apr 13, 2023

View reviewed changes

Testcontainers for Java: Improve docs at "What's inside" section

32fb516

amotl mentioned this pull request Apr 14, 2023

Testcontainers for Java: Backlog #55

Open

1 task

matriv approved these changes Apr 14, 2023

View reviewed changes

amotl merged commit 9c79faa into main Apr 14, 2023

amotl deleted the amo/testing-testcontainers-java branch April 14, 2023 13:05

amotl mentioned this pull request Apr 17, 2023

Testcontainers for Java: Add examples for init scripts and function #59

Merged

amotl mentioned this pull request Jun 2, 2023

Testcontainers for Python #72

Open

amotl mentioned this pull request Feb 29, 2024

[Java] Educate about io.crate:crate-testing package (crate-java-testing) #342

Closed

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Testcontainers for Java: Add showcase examples for different scenarios #54

Testcontainers for Java: Add showcase examples for different scenarios #54

amotl commented Apr 6, 2023 •

edited

Loading

BaurzhanSakhariev left a comment

matriv left a comment

matriv commented Apr 7, 2023

amotl left a comment •

edited

Loading

hlcianfagna Apr 12, 2023

amotl Apr 12, 2023 •

edited

Loading

matriv Apr 12, 2023

hlcianfagna Apr 13, 2023 •

edited

Loading

amotl commented Apr 14, 2023 •

edited

Loading

matriv left a comment

amotl commented Apr 14, 2023

Testcontainers for Java: Add showcase examples for different scenarios #54

Testcontainers for Java: Add showcase examples for different scenarios #54

Conversation

amotl commented Apr 6, 2023 • edited Loading

About

References

Details

Backlog

Startup

Database provisioning

Other test frameworks

Footnotes

BaurzhanSakhariev left a comment

Choose a reason for hiding this comment

matriv left a comment

Choose a reason for hiding this comment

matriv commented Apr 7, 2023

amotl left a comment • edited Loading

Choose a reason for hiding this comment

hlcianfagna Apr 12, 2023

Choose a reason for hiding this comment

amotl Apr 12, 2023 • edited Loading

Choose a reason for hiding this comment

Footnotes

matriv Apr 12, 2023

Choose a reason for hiding this comment

hlcianfagna Apr 13, 2023 • edited Loading

Choose a reason for hiding this comment

amotl commented Apr 14, 2023 • edited Loading

Footnotes

matriv left a comment

Choose a reason for hiding this comment

amotl commented Apr 14, 2023

amotl commented Apr 6, 2023 •

edited

Loading

amotl left a comment •

edited

Loading

amotl Apr 12, 2023 •

edited

Loading

hlcianfagna Apr 13, 2023 •

edited

Loading

amotl commented Apr 14, 2023 •

edited

Loading