testcontainers-python/core/tests/test_utils.py at 88acf8fdad4d249be4dd275c8f9cb6255a00679e · testcontainers/testcontainers-python · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
import io
import tarfile
from pathlib import Path

import pytest
from pytest import MonkeyPatch, raises, mark

from testcontainers.core import utils


def test_setup_logger() -> None:
    assert utils.setup_logger("test") is not None


@mark.parametrize("platform, expected", [("linux", "linux"), ("linux2", "linux"), ("darwin", "mac"), ("win32", "win")])
def test_os_name(monkeypatch: MonkeyPatch, platform: str, expected: str) -> None:
    assert utils.os_name() is not None
    monkeypatch.setattr("sys.platform", platform)
    assert utils.os_name() == expected


def test_is_mac(monkeypatch: MonkeyPatch) -> None:
    monkeypatch.setattr("testcontainers.core.utils.os_name", lambda: "mac")
    assert utils.is_mac()


def test_is_linux(monkeypatch: MonkeyPatch) -> None:
    monkeypatch.setattr("testcontainers.core.utils.os_name", lambda: "linux")
    assert utils.is_linux()


def test_is_windows(monkeypatch: MonkeyPatch) -> None:
    monkeypatch.setattr("testcontainers.core.utils.os_name", lambda: "win")
    assert utils.is_windows()


def test_is_arm(monkeypatch: MonkeyPatch) -> None:
    monkeypatch.setattr("platform.machine", lambda: "x86_64")
    assert not utils.is_arm()
    monkeypatch.setattr("platform.machine", lambda: "arm64")
    assert utils.is_arm()
    monkeypatch.setattr("platform.machine", lambda: "aarch64")
    assert utils.is_arm()


def test_inside_container(monkeypatch: MonkeyPatch) -> None:
    assert not utils.inside_container()
    monkeypatch.setattr("os.path.exists", lambda _: True)
    assert utils.inside_container()


def test_raise_for_deprecated_parameters() -> None:
    kwargs = {"key": "value"}
    current = "key"
    replacement = "new_key"
    with raises(ValueError) as e:
        result = utils.raise_for_deprecated_parameter(kwargs, current, replacement)
        assert str(e.value) == "Parameter 'deprecated' is deprecated and should be replaced by 'replacement'."
        assert result == {}


@pytest.fixture
def fake_cgroup(monkeypatch: pytest.MonkeyPatch, tmp_path: Path) -> Path:
    target = tmp_path / "cgroup"
    monkeypatch.setattr(utils, "CGROUP_FILE", target)
    return target


def test_get_running_container_id_empty_or_missing(fake_cgroup: Path) -> None:
    # non existing does not fail but is only none
    assert utils.get_running_in_container_id() is None
    fake_cgroup.write_text("12:devices:/system.slice/sshd.service\n13:cpuset:\n")
    # missing docker does also not fail
    assert utils.get_running_in_container_id() is None


def test_get_running_container_id(fake_cgroup: Path) -> None:
    container_id = "b78eebb08f89158ed6e2ed2fe"
    fake_cgroup.write_text(f"13:cpuset:/docker/{container_id}")
    assert utils.get_running_in_container_id() == container_id


# ---------------------------------------------------------------------------
# build_copy_to_tar
# ---------------------------------------------------------------------------


def test_build_copy_to_tar_bytes() -> None:
    data = b"hello world"
    tar_bytes = utils.build_tar_file("/tmp/hello.txt", data)

    with tarfile.open(fileobj=io.BytesIO(tar_bytes)) as tar:
        members = tar.getmembers()
        assert len(members) == 1
        assert members[0].name == "tmp/hello.txt"
        assert tar.extractfile(members[0]).read() == data


def test_build_copy_to_tar_file(tmp_path: Path) -> None:
    src = tmp_path / "myfile.txt"
    src.write_bytes(b"file content")

    tar_bytes = utils.build_tar_file("/tmp/myfile.txt", src)

    with tarfile.open(fileobj=io.BytesIO(tar_bytes)) as tar:
        members = tar.getmembers()
        assert len(members) == 1
        assert members[0].name == "tmp/myfile.txt"
        assert tar.extractfile(members[0]).read() == b"file content"