Docs and Implementation Do Not Match for Container Stop Timeout #817
Labels
Comments
|
Thanks @vbaier-mitll for the detailed issue. Would you be willing to raise a PR to fix it? Should be a case of updating the parameter name in types and interfaces, and updating the containers page in the docs |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
When trying to figure out why my containers weren't getting killed in my test suite I stumbled across a feature request for killing containers #716 . Looking into the resolution it seems that after the timeout, badly behaved containers should be killed automatically. I used some curl commands against the docker socket and discovered that this is in fact the case:
However, I also noticed that when using the timeout argument for the testcontainers stop() call it would hang without ever sending a kill signal. Replicating this directly on the API with curl I also experienced a hang where curl failed to return:
After looking into the docker API docks and the testcontainer source code, I found the source of my confusion. I was setting timeout as if it was in milliseconds because that is the behavior described in the testcontainers docs; however, the parameter is actually supposed to be in seconds per the docker API documentation. Passing a value as if it were seconds instead of milliseconds correctly resolves the issue. The below example passes a value of 1 to the container stop() call:
As a result, documentation should be updated to correctly call out the stop timeout as seconds.
Expected Behaviour
Testcontainers node documentation correctly identifies the stop timeout parameter as in seconds instead of milliseconds.
Actual Behaviour
Documentation indicates stop() calls should take milliseconds resulting in badly behaved containers (those that do not respect SIGTERM) to hang seemingly indefinitely. In reality, they are awaiting a timeout 1000 times larger than intended.
Testcontainer Logs
See above docker API logs.
Steps to Reproduce
const container = await new GenericContainer("opensearchproject/opensearch:2.13.0")container.stop({timeout: 5});Environment Information
The text was updated successfully, but these errors were encountered: