search

testcontainers / testcontainers-java

Testcontainers is a Java library that supports JUnit tests, providing lightweight, throwaway instances of common databases, Selenium web browsers, or anything else that can run in a Docker container.
https://testcontainers.org
MIT License
8.02k stars 1.65k forks source link

Some errors cause a NoClassDefFoundError and the real error is hidden #1872

Open amirabiri opened 5 years ago

amirabiri commented 5 years ago

In certain cases a test may fail with a NoClassDefFoundError, and it's a nightmare to find the real error.

For example:

static final PostgreSQLContainer = PostgreSQLContainer("postgresxxx:11.5") 
    .withDatabaseName("netonomy")
    .withUsername("postgres")
    .withPassword("password");

Then running gradle test results in:

com.example.SomeIntegrationTest > testPostgres() FAILED
    java.lang.NoClassDefFoundError: Could not initialize class com.example.SomeIntegrationTest

To find out the actual error, it was necessary to run Gradle with --info. I only used a bad image name here as an example to reproduce - the real error was "Docker environment should have more than 2GB free disk space", and it happened only on the CI build agent - so this was a real nightmare to diagnose!

What makes this even more difficult to pin down is the fact that even removing the @Testcontainers and @Container still results in the exact same behaviour!

The reason for all of this, is the fact that GenericContainer's constructor calls this.setDockerImageName() which in turn calls getDockerImageName() which actually attempts to get the image: https://github.com/testcontainers/testcontainers-java/blob/master/core/src/main/java/org/testcontainers/containers/GenericContainer.java#L1057

IMO this is an action that should not take place in a constructor - this should happen only later during start(). Either way there ought to be some better solution, because diagnosing errors this way is a nightmare.

bsideup commented 5 years ago

Hi @amirabiri,

We're aware of that problem. Some old time ago, a decision was made to fail fast if image fails to resolve.

We do plan to change it to resolve on start, but delayed it until 2.x. Although we could do it sooner, e.g. as part of #1345, see this conversation: https://github.com/testcontainers/testcontainers-java/pull/1345#discussion_r270116389

rnorth commented 5 years ago

We do plan to change it to resolve on start, but delayed it until 2.x. Although we could do it sooner, e.g. as part of #1345

Yes, I think we can and should

almed4 commented 3 years ago

Any progress on this? I would never have been able to solve my problem without reading @amirabiri's comment.

jeantil commented 8 months ago

Hello,

It looks like #1345 did not change the policy on image resolution and based on the 2.x milestone activity, 2.x seems to have been stalled for around 5 years.

Are there any recent plans regarding this issue ?

thanks,