tests: extend docker e2e tests to actually test the resulting container

Uses testinfra to check the requested changes are actually applied to
the running container.

Author: Fizzadar

.github/workflows/test.yml

@@ -73,7 +73,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-22.04, ubuntu-24.04]
-        test-name: [local, ssh, docker]
+        test-name: [local, ssh, docker, podman]
         python-version: ["3.10", "3.11", "3.12"]
         include:
           - os: macos-13

pyinfra/api/util.py

@@ -1,7 +1,8 @@
 from __future__ import annotations
 
+import hashlib
 from functools import wraps
-from hashlib import sha1
+from hashlib import sha1, sha256
 from inspect import getframeinfo, stack
 from io import BytesIO, StringIO
 from os import getcwd, path, stat
@@ -341,7 +342,7 @@ class get_file_io:
     _close: bool = False
     _file_io: IO[Any]
 
-    def __init__(self, filename_or_io, mode="rb"):
+    def __init__(self, filename_or_io: str | IO, mode: str = "rb"):
         if not (
             # Check we can be read
             hasattr(filename_or_io, "read")
@@ -390,6 +391,14 @@ def cache_key(self):
 
 
 def get_file_sha1(filename_or_io):
+    return _get_file_digest(filename_or_io, sha1())
+
+
+def get_file_sha256(filename_or_io):
+    return _get_file_digest(filename_or_io, sha256())
+
+
+def _get_file_digest(filename_or_io: str | IO, hasher: hashlib._Hash):
     """
     Calculates the SHA1 of a file or file object using a buffer to handle larger files.
     """
@@ -401,7 +410,6 @@ def get_file_sha1(filename_or_io):
         return FILE_SHAS[cache_key]
 
     with file_data as file_io:
-        hasher = sha1()
         buff = file_io.read(BLOCKSIZE)
 
         while len(buff) > 0:

pyinfra/facts/server.py

@@ -529,7 +529,7 @@ def command(self):
             PASSWORD=`(grep ^$i: /etc/shadow || grep ^$i: /etc/master.passwd) 2> /dev/null | cut -d: -f2`;
             echo "$ENTRY|`id -gn $i`|`id -Gn $i`|$LASTLOG|$PASSWORD";
         done
-    """.strip() # noqa
+    """.strip()  # noqa
 
     default = dict
 

pyinfra_cli/main.py

@@ -515,10 +515,12 @@ def _set_verbosity(state, verbosity):
         state.print_noop_info = True
 
     if verbosity > 1:
-        state.print_input = state.print_fact_input = True
+        state.print_input = True
+        state.print_fact_input = True
 
     if verbosity > 2:
-        state.print_output = state.print_fact_output = True
+        state.print_output = True
+        state.print_fact_output = True
 
     return state
 

setup.cfg

@@ -37,5 +37,6 @@ addopts = -m'not end_to_end'
 markers =
     end_to_end
     end_to_end_docker
+    end_to_end_podman
     end_to_end_local
     end_to_end_ssh

setup.py

@@ -43,6 +43,7 @@
     "pytest==8.3.5",
     "coverage==7.7.1",
     "pytest-cov==6.0.0",
+    "pytest-testinfra==10.2.2",
     # Formatting & linting
     "black==25.1.0",
     "isort==6.0.1",

tests/end-to-end/conftest.py

@@ -1,7 +1,9 @@
 import re
 import subprocess
+from typing import Callable
 
 import pytest
+import testinfra.host
 
 
 class Helpers:
@@ -38,6 +40,28 @@ def run_check_output(command, expected_lines=None, **kwargs):
                 line,
             )
 
+    @staticmethod
+    def run_container_test_host(
+        container: str,
+        cmd: str,
+        callback: Callable[[testinfra.host.Host], None],
+    ) -> None:
+        stdout, _ = Helpers.run(
+            f"docker run -d {container} tail -f /dev/null",
+        )
+        cid = stdout.strip()
+
+        try:
+            Helpers.run_check_output(
+                f"pyinfra -y @docker/{cid} {cmd}",
+                expected_lines=["docker build complete"],
+            )
+
+            host = testinfra.get_host(f"docker://{cid}")
+            callback(host)
+        finally:
+            Helpers.run(f"docker rm -f {cid}")
+
 
 @pytest.fixture(scope="module")
 def helpers():

tests/end-to-end/test_e2e_docker.py

@@ -3,21 +3,56 @@
 """
 
 import pytest
+import testinfra
+import testinfra.host
 
 
 @pytest.mark.end_to_end
 @pytest.mark.end_to_end_docker
 def test_int_docker_install_package_ubuntu(helpers):
-    helpers.run_check_output(
-        "pyinfra -y --chdir examples @docker/ubuntu:22.04 apt.packages iftop update=true",
-        expected_lines=["docker build complete"],
+    def check(host: testinfra.host.Host):
+        assert host.package("iftop").is_installed
+
+    helpers.run_container_test_host(
+        "ubuntu:22.04",
+        "apt.packages packages=iftop update=true",
+        check,
+    )
+
+
+@pytest.mark.end_to_end
+@pytest.mark.end_to_end_docker
+def test_int_docker_file(helpers):
+    def check(host: testinfra.host.Host):
+        file = host.file("/testfile")
+        assert file.is_file
+        assert file.user == "nobody"
+        assert file.group == "root"
+        assert file.mode == 0o755
+
+    helpers.run_container_test_host(
+        "ubuntu:22.04",
+        "files.file path=/testfile mode=755 user=nobody",
+        check,
     )
 
 
 @pytest.mark.end_to_end
 @pytest.mark.end_to_end_docker
-def test_int_podman_install_package_ubuntu(helpers):
-    helpers.run_check_output(
-        "pyinfra -y --chdir examples @podman/ubuntu:22.04 apt.packages iftop update=true",
-        expected_lines=["podman build complete"],
+def test_int_docker_put_file(helpers):
+    # TODO: why does importing this at top level break things?
+    from pyinfra.api.util import get_file_sha256
+
+    with open("README.md", "r") as f:
+        expected_sum = get_file_sha256(f)
+
+    def check(host: testinfra.host.Host):
+        file = host.file("/README.md")
+        assert file.is_file
+        assert file.sha256sum == expected_sum
+
+    helpers.run_container_test_host(
+        "ubuntu:22.04",
+        "files.put src=README.md dest=README.md mode=755 user=nobody",
+        check,
     )

tests/end-to-end/test_e2e_podman.py

@@ -0,0 +1,14 @@
+"""
+Podman based integration tests.
+"""
+
+import pytest
+
+
+@pytest.mark.end_to_end
+@pytest.mark.end_to_end_podman
+def test_int_podman_install_package_ubuntu(helpers):
+    helpers.run_check_output(
+        "pyinfra -y --chdir examples @podman/ubuntu:22.04 apt.packages iftop update=true",
+        expected_lines=["podman build complete"],
+    )

tests/paramiko_util.py

@@ -60,6 +60,9 @@ def __iter__(self):
 
 
 class FakeSSHClient:
+    def close(self):
+        pass
+
     def load_system_host_keys(self):
         pass
 
@@ -90,6 +93,9 @@ class FakeSFTPClient:
     def from_transport(cls, transport):
         return cls()
 
+    def close(self):
+        pass
+
     def putfo(self, file_io, remote_location):
         pass