ISSUE #2949: fix(tests/containers/): extract the dict assertion to a common utility library (#2960)

Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Author: 3 people

ci/cached-builds/makefile_helper.py

@@ -61,10 +61,12 @@ class TestMakefile:
     MINIMAL_IMAGE = "jupyter-minimal-ubi9-python-3.12"
 
     def test_makefile__build_image__konflux(self):
+        import ntb  # noqa: PLC0415 `import` should be at the top-level of a file
+
         konflux_default = dry_run_makefile(target=self.MINIMAL_IMAGE, makefile_dir=PROJECT_ROOT)
         konflux_yes = dry_run_makefile(target=self.MINIMAL_IMAGE, makefile_dir=PROJECT_ROOT, env={"KONFLUX": "yes"})
 
-        _assert_subdict(
+        ntb.assert_subdict(
             {
                 "VARIANT": "cpu",
                 "DOCKERFILE_NAME": "Dockerfile.cpu",
@@ -73,7 +75,7 @@ def test_makefile__build_image__konflux(self):
             _extract_assignments(konflux_default),
         )
 
-        _assert_subdict(
+        ntb.assert_subdict(
             {
                 "VARIANT": "cpu",
                 "DOCKERFILE_NAME": "Dockerfile.konflux.cpu",
@@ -99,10 +101,3 @@ def _extract_assignments(makefile_output: str) -> dict[str, str]:
         key, value = line.split(":=", 1)
         assignments[key.strip()] = value.strip()
     return assignments
-
-
-# see also https://pypi.org/project/pytest-assert-utils/
-def _assert_subdict(subdict: dict[str, str], superdict: dict[str, str]):
-    """Filter subdict to only keys in superdict, then compare the remaining items."""
-    __tracebackhide__ = True
-    assert subdict == {k: superdict[k] for k in subdict if k in superdict}

ntb/__init__.py

@@ -2,7 +2,8 @@
 
 from __future__ import annotations
 
+from .asserts import assert_subdict
 from .constants import ROOT_DIR
 from .strings import blockinfile, process_template_with_indents
 
-__all__ = ["ROOT_DIR", "blockinfile", "process_template_with_indents"]
+__all__ = ["ROOT_DIR", "assert_subdict", "blockinfile", "process_template_with_indents"]

ntb/asserts.py

@@ -0,0 +1,10 @@
+"""Shared test assertion helpers."""
+
+from __future__ import annotations
+
+
+# see also https://pypi.org/project/pytest-assert-utils/
+def assert_subdict(subdict: dict[str, str], superdict: dict[str, str]):
+    """Assert that subdict is a subset of superdict (matching keys have equal values)."""
+    __tracebackhide__ = True
+    assert subdict == {k: superdict[k] for k in subdict if k in superdict}

tests/containers/base_image_test.py

@@ -16,6 +16,7 @@
 import pytest
 import testcontainers.core.container
 
+import ntb
 from tests.containers import conftest, docker_utils, skopeo_utils, utils
 
 logging.basicConfig(level=logging.DEBUG)
@@ -27,13 +28,6 @@
     import pytest_subtests
 
 
-# see also https://pypi.org/project/pytest-assert-utils/
-def _assert_subdict(subdict: dict[str, str], superdict: dict[str, str]):
-    """Filter subdict to only keys in superdict, then compare the remaining items."""
-    __tracebackhide__ = True
-    assert subdict == {k: superdict[k] for k in subdict if k in superdict}
-
-
 class TestBaseImage:
     """Tests that are applicable for all images we have in this repository."""
 
@@ -330,7 +324,7 @@ def _check_aipcc_env_vars(actual: dict[str, str], subtests: pytest_subtests.SubT
         pypi_index_vars = ("PIP_INDEX_URL", "UV_INDEX_URL", "UV_DEFAULT_INDEX")
 
         with subtests.test("AIPCC images have config file env vars"):
-            _assert_subdict(aipcc_config_vars, actual)
+            ntb.assert_subdict(aipcc_config_vars, actual)
         with subtests.test("AIPCC images do not have index URL env vars"):
             for key in pypi_index_vars:
                 assert key not in actual, f"Expected {key} to NOT be present (image uses uv.lock.d)"
@@ -346,7 +340,7 @@ def _check_pypi_env_vars(actual: dict[str, str], subtests: pytest_subtests.SubTe
             "UV_DEFAULT_INDEX": "https://pypi.org/simple",
         }
         with subtests.test("Non-AIPCC images have index URL env vars"):
-            _assert_subdict(pypi_env_vars, actual)
+            ntb.assert_subdict(pypi_env_vars, actual)
 
     @allure.issue("RHAIENG-2189")
     def test_python_package_index(self, image: str, subtests: pytest_subtests.SubTests):

tests/containers/workbenches/jupyterlab/jupyterlab_datascience_test.py

@@ -84,9 +84,7 @@ def test_sklearn_smoke(self, jupyterlab_datascience_image: conftest.Image) -> No
     def test_mysql_connection(self, tf: TestFrame, datascience_image: Image, subtests):
         name_label = datascience_image.labels.get("name", "")
         if "-rstudio-" in name_label:
-            pytest.skip(
-                f"Image {datascience_image.name} does have -rstudio- in {datascience_image.labels['name']=}'"
-            )
+            pytest.skip(f"Image {datascience_image.name} has '-rstudio-' in {datascience_image.labels['name']=}")
 
         MYSQL_CONNECTOR_PYTHON_VERSION = "9.5.0"
 
@@ -170,11 +168,7 @@ def test_mysql_connection(self, tf: TestFrame, datascience_image: Image, subtest
             # Detection: label "name" contains "-code-server-" (set in Dockerfile.cpu). Fallback: image ref
             # contains "codeserver" when daemon is Podman and labels came from ContainerConfig (conftest handles that).
             is_codeserver = "-code-server-" in name_label or "codeserver" in datascience_image.name.lower()
-            python_exe = (
-                "/opt/app-root/bin/python3"
-                if is_codeserver
-                else "python"
-            )
+            python_exe = "/opt/app-root/bin/python3" if is_codeserver else "python"
             print(f"Using python executable: {python_exe}")
 
             # RHOAIENG-140: code-server image users are expected to install their own db clients