Wait strategy:
is the container in a state that is useful for testing. This is generally approximated as 'can we talk to this container over the network'. However, there are quite a few variations and nuances.
Startup strategy:
did a container reach the desired running state.
Almost always
this just means 'wait until the container is running' - for a daemon process in a container this is the goal. Sometimes we need to wait until the container reaches a running state and then exits - this is the 'one shot startup' strategy, only used for cases where we need to run a one off command in a container but not a daemon.
Wait Strategies
Ordinarily Testcontainers will wait for up to 60 seconds for the container's first mapped network port to start listening.
This simple measure provides a basic check whether a container is ready for use.
If the default 60s timeout is not sufficient, it can be altered with the withStartupTimeout() method.
If waiting for a listening TCP port is not sufficient to establish whether the container is ready, you can use the
waitingFor() method with other WaitStrategy implementations as shown below.
HTTP Wait strategy examples
You can choose to wait for an HTTP(S) endpoint to return a particular status code.
If the used image supports Docker's Healthcheck feature, you can directly leverage the healthy state of the container as your wait condition:
Wait.forHealthcheck();
Log output Wait Strategy
In some situations a container's log output is a simple way to determine if it is ready or not.
For example, we can wait for a `Ready' message in the container's logs as follows:
publicGenericContainercontainerWithLogWait=newGenericContainer(DockerImageName.parse("redis:6-alpine")).withExposedPorts(6379).waitingFor(Wait.forLogMessage(".*Ready to accept connections.*\\n",1));
Other Wait Strategies
For further options, check out the Wait convenience class, or the various subclasses of WaitStrategy.
If none of these options meet your requirements, you can create your own subclass of
AbstractWaitStrategy with an
appropriate wait mechanism in waitUntilReady().
The GenericContainer.waitingFor() method accepts any valid WaitStrategy.
Startup check Strategies
Ordinarily Testcontainers will check that the container has reached the running state and has not exited.
In order to do that inspect is executed against the container and state parameter is extracted.
This strategy is intended for use with containers that only run briefly and exit of their own accord. As such, success is deemed to be when
the container has stopped with exit code 0.
If none of these options meet your requirements, you can create your own subclass of
StartupCheckStrategy with an appropriate startup check mechanism in waitUntilStartupSuccessful().
Or you can leave it as is and just implement the checkStartupState(DockerClient dockerClient, String containerId) if you still want to check state
periodically.
Depending on another container
Sometimes, a container relies on another container to be ready before it should start itself. An example of this might be a database that needs to be started before your application container can link to it. You can tell a container that it depends on another container by using the dependsOn method: