Add support for network aliases

Author: mloesch

core/testcontainers/core/container.py

@@ -33,6 +33,7 @@ def __init__(self, image: str, docker_client_kw: Optional[dict] = None, **kwargs
         self._command = None
         self._name = None
         self._network: Optional[Network] = None
+        self._network_aliases: Optional[list] = None
         self._kwargs = kwargs
 
     def with_env(self, key: str, value: str) -> 'DockerContainer':
@@ -52,6 +53,10 @@ def with_network(self, network: Network) -> 'DockerContainer':
         self._network = network
         return self
 
+    def with_network_aliases(self, *aliases) -> 'DockerContainer':
+        self._network_aliases = aliases
+        return self
+
     def with_kwargs(self, **kwargs) -> 'DockerContainer':
         self._kwargs = kwargs
         return self
@@ -70,7 +75,7 @@ def start(self) -> 'DockerContainer':
         )
         logger.info("Container started: %s", self._container.short_id)
         if self._network:
-            self._network.connect(self._container.id)
+            self._network.connect(self._container.id, self._network_aliases)
         return self
 
     def stop(self, force=True, delete_volume=True) -> None:

core/testcontainers/core/network.py

@@ -26,8 +26,8 @@ def __init__(self, docker_client_kw: Optional[dict] = None, **kwargs) -> None:
         self._docker = DockerClient(**(docker_client_kw or {}))
         self._kwargs = kwargs
 
-    def connect(self, container_id: str):
-        self._network.connect(container_id)
+    def connect(self, container_id: str, network_aliases: Optional[list] = None):
+        self._network.connect(container_id, aliases=network_aliases)
 
     def remove(self) -> None:
         self._network.remove()

core/tests/test_network.py

@@ -2,6 +2,8 @@
 from testcontainers.core.docker_client import DockerClient
 from testcontainers.core.network import Network
 
+NGINX_ALPINE_SLIM_IMAGE = "nginx:alpine-slim"
+
 
 def test_network_gets_created_and_cleaned_up():
     with Network() as network:
@@ -14,14 +16,25 @@ def test_network_gets_created_and_cleaned_up():
 
 def test_containers_can_communicate_over_network():
     with Network() as network:
-        with DockerContainer("nginx:alpine-slim").with_name(
-                "alpine1").with_network(network) as alpine1:
-            with DockerContainer("nginx:alpine-slim").with_name(
-                    "alpine2").with_network(network) as alpine2:
-                status, output = alpine1.exec("ping -c 1 alpine2")
-                assert status == 0
-                assert "64 bytes" in str(output)
-
-                status, output = alpine2.exec("ping -c 1 alpine1")
-                assert status == 0
-                assert "64 bytes" in str(output)
+        with DockerContainer(NGINX_ALPINE_SLIM_IMAGE)\
+                .with_name("alpine1")\
+                .with_network_aliases("alpine1-alias-1", "alpine1-alias-2")\
+                .with_network(network) as alpine1:
+            with DockerContainer(NGINX_ALPINE_SLIM_IMAGE)\
+                    .with_name("alpine2")\
+                    .with_network_aliases("alpine2-alias-1", "alpine2-alias-2")\
+                    .with_network(network) as alpine2:
+
+                assert_can_ping(alpine1, "alpine2")
+                assert_can_ping(alpine1, "alpine2-alias-1")
+                assert_can_ping(alpine1, "alpine2-alias-2")
+
+                assert_can_ping(alpine2, "alpine1")
+                assert_can_ping(alpine2, "alpine1-alias-1")
+                assert_can_ping(alpine2, "alpine1-alias-2")
+
+
+def assert_can_ping(container: DockerContainer, remote_name: str):
+    status, output = container.exec("ping -c 1 %s" % remote_name)
+    assert status == 0
+    assert "64 bytes" in str(output)