8000 fix(network): Now able to use Network without context, and has labels to be automatically cleaned up (#627) by dogukancagatay · Pull Request #630 · testcontainers/testcontainers-python · GitHub
[go: up one dir, main page]
Skip to content

fix(network): Now able to use Network without context, and has labels to be automatically cleaned up (#627) #630

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alexanderankin merged 2 commits into from
Jul 1, 2024
Merged

fix(network): Now able to use Network without context, and has labels to be automatically cleaned up (#627) #630

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ccfc8da
feat(network): Add create method to Network class (#627)
dogukancagatay Jun 30, 2024
2995ccb
make sure networks are also labelled for cleanup
alexanderankin Jul 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions core/testcontainers/core/docker_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,10 @@ def login(self, docker_auth_config: str) -> None:
login_info = self.client.login(**auth_config._asdict())
LOGGER.debug(f"logged in using {login_info}")

def client_networks_create(self, name: str, param: dict):
labels = create_labels("", param.get("labels"))
return self.client.networks.create(name, **{**param, "labels": labels})


def get_docker_host() -> Optional[str]:
return c.tc_properties_get_tc_host() or os.getenv("DOCKER_HOST")
Expand Down
7 changes: 5 additions & 2 deletions core/testcontainers/core/network.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,13 @@ def connect(self, container_id: str, network_aliases: Optional[list] = None):
def remove(self) -> None:
self._network.remove()

def __enter__(self) -> "Network":
self._network = self._docker.client.networks.create(self.name, **self._docker_network_kw)
def create(self) -> "Network":
self._network = self._docker.client_networks_create(self.name, self._docker_network_kw)
self.id = self._network.id
return self

def __enter__(self) -> "Network":
return self.create()

def __exit__(self, exc_type, exc_val, exc_tb) -> None:
self.remove()
40 changes: 40 additions & 0 deletions core/tests/test_network.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
from http import HTTPStatus
from testcontainers.core.container import DockerContainer
from testcontainers.core.docker_client import DockerClient
from testcontainers.core.labels import LABEL_SESSION_ID
from testcontainers.core.network import Network

import docker.errors
import pytest

NGINX_ALPINE_SLIM_IMAGE = "nginx:1.25.4-alpine-slim"


Expand All @@ -14,6 +19,31 @@ def test_network_gets_created_and_cleaned_up():
assert not docker.client.networks.list(network.name)


def test_network_create_wo_cm():
network = Network()
network.create()
docker = DockerClient()
networks_list = docker.client.networks.list(network.name)
assert networks_list[0].name == network.name
assert networks_list[0].id == network.id

network.remove()
assert not docker.client.networks.list(network.name)


def test_network_create_errors():
network = Network()
network.create()

# calling create the second time should raise an error
with pytest.raises(docker.errors.APIError) as excinfo:
network.create()

assert excinfo.value.response.status_code == HTTPStatus.CONFLICT
excinfo.match(f"network with name {network.name} already exists")
network.remove()


def test_containers_can_communicate_over_network():
with Network() as network:
with (
Expand Down Expand Up @@ -41,3 +71,13 @@ 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)


def test_network_has_labels():
network = Network()
try:
network.create()
network = network._docker.client.networks.get(network_id=network.id)
assert LABEL_SESSION_ID in network.attrs.get("Labels")
finally:
network.remove()
0