testcontainers-node: Port mapping for ipv4 & ipv6 can cause different ports to be mapped and getMappedPort function will return wrong port
Expected Behaviour
I want to get a predictable port number and host,
the problem seems to be in this file - https://github.com/testcontainers/testcontainers-node/blob/main/packages/testcontainers/src/utils/bound-ports.ts
method - resolveHostPortBinding line - return hostPortBindings[0].hostPort;
Actual Behaviour
We have tests that are running in parallel and it was quite hard to identify that issue, because locally on mac os everything is fine, but on latest ubuntu the problem auto assigning port appear
https://github.com/testcontainers/testcontainers-dotnet/issues/825 - same issue for .net
So what happening:
- Starting a redis container (doesn’t matter which one, it just an example)
- withExposedPorts(6389) - let docker to auto assign host port
- calling getMappedPort function -> may return ipv4 or ipv6 port, depends on your luck
Testcontainer Logs …
Steps to Reproduce
- In this environment ubuntu 22
- With this config.
- Run ‘…’
const container = await new GenericContainer(
`${options.imageName}:${options.imageTag}`,
)
.withExposedPorts(6379)
.start();
// eslint-disable-next-line no-console
console.timeEnd(`start redis`);
const redisConfig = {
port: container.getMappedPort(6379),
host: 'localhost',
} satisfies RedisStartedConfig;
- Run docker ps, and see that there are 2 ports actually
Environment Information
- Operating System: ubuntu
- Docker Version: 24+
- Node version: 20+
- Testcontainers version: 10.8.1
we temporary fixed it by retrieving ipv4 port from the docker inspect info:
import { StartedTestContainer } from 'testcontainers/build/test-container';
export function retrievePortFromBinding(
container: StartedTestContainer,
sourcePort: number,
): number {
return Number.parseInt(
// eslint-disable-next-line @typescript-eslint/no-explicit-any
(container as never as any).inspectResult.NetworkSettings.Ports[
`${sourcePort}/tcp`
].find((p: { HostIp: string; HostPort: string }) => p.HostIp === '0.0.0.0')
.HostPort,
);
}
About this issue
- Original URL
- State: open
- Created 3 years ago
- Reactions: 2
- Comments: 15
Thanks for raising, I’ll need to look into it. Testcontainers resolves a list of host IPs, the order of which is determined by several factors like node version and OS. When we get the mapped port we probably need to find the port where the host matches the order, similar as you’ve done
@cristianrgreco Yeah it’s Ubuntu 24.04 runners on Github Actions.
We have a few different instances where we would call up testcontainers and it’s always in the same order:
I tried switching the order and it still always binds redis with a different port on ipv6.
We ended it catching it because
localhostresolves to both the ipv4 and ipv6 loopback ip on ubuntu and sometimes our tests would try to connect to the ipv6 address, but getConnectionUrl always returnsredis://localhost:${ipv4-Port}and so our tests would say that it couldn’t connect to that port (since it’s going over ipv6 which was listening on a different port).I’ll see if I can get some time this week to try directly on an Ubuntu VM directly with Docker to reproduce this.
I’m seeing this issue cause intermittent test failures in GitHub actions
These are the running containers when the test fails
And then my test is trying to connect to 32785
which turns out to be postgres instead of redis on ipv4, I assume thats a chance thing
Yep I think docker returns the ports in random order, but we should be able to find the one we want by host