Add explicit API DockerContainer.with_network(Network)

Author: mloesch

core/testcontainers/core/container.py

@@ -2,6 +2,7 @@
 import os
 from typing import Iterable, Optional, Tuple
 
+from .network import Network
 from .waiting_utils import wait_container_is_ready
 from .docker_client import DockerClient
 from .exceptions import ContainerStartException
@@ -31,6 +32,7 @@ def __init__(self, image: str, docker_client_kw: Optional[dict] = None, **kwargs
         self._container = None
         self._command = None
         self._name = None
+        self._network: Optional[Network] = None
         self._kwargs = kwargs
 
     def with_env(self, key: str, value: str) -> 'DockerContainer':
@@ -46,6 +48,10 @@ def with_exposed_ports(self, *ports: Iterable[int]) -> 'DockerContainer':
             self.ports[port] = None
         return self
 
+    def with_network(self, network: Network) -> 'DockerContainer':
+        self._network = network
+        return self
+
     def with_kwargs(self, **kwargs) -> 'DockerContainer':
         self._kwargs = kwargs
         return self
@@ -63,6 +69,8 @@ def start(self) -> 'DockerContainer':
             name=self._name, volumes=self.volumes, **self._kwargs
         )
         logger.info("Container started: %s", self._container.short_id)
+        if self._network:
+            self._network.connect(self._container.id)
         return self
 
     def stop(self, force=True, delete_volume=True) -> None:

core/testcontainers/core/network.py

@@ -26,6 +26,9 @@ 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 remove(self) -> None:
         self._network.remove()
 

core/tests/test_network.py

@@ -15,9 +15,9 @@ 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_kwargs(network=network.name) as alpine1:
+                "alpine1").with_network(network) as alpine1:
             with DockerContainer("nginx:alpine-slim").with_name(
-                    "alpine2").with_kwargs(network=network.name) as alpine2:
+                    "alpine2").with_network(network) as alpine2:
                 status, output = alpine1.exec("ping -c 1 alpine2")
                 assert status == 0
                 assert "64 bytes" in str(output)