Add tests for filtering in new and deprecated ways

Author: LewisGaul

tests/python_on_whales/components/test_container.py

@@ -585,7 +585,7 @@ def test_context_manager_with_create(ctr_client: DockerClient):
 
 
 @pytest.mark.parametrize("ctr_client", ["docker", "podman"], indirect=True)
-def test_filters(ctr_client: DockerClient):
+def test_list_filters(ctr_client: DockerClient):
     random_label_value = random_name()
 
     containers_with_labels = []
@@ -614,7 +614,7 @@ def test_filters(ctr_client: DockerClient):
         )
 
     expected_containers_with_labels = ctr_client.container.list(
-        filters=dict(label=f"dodo={random_label_value}")
+        filters=[("label", f"dodo={random_label_value}")]
     )
 
     assert set(expected_containers_with_labels) == set(containers_with_labels)
@@ -623,6 +623,50 @@ def test_filters(ctr_client: DockerClient):
         container.kill()
 
 
+def test_list_filters_old_signature(docker_client: DockerClient):
+    """Test backwards compatibility of DockerClient.container.list()."""
+    random_label_value = random_name()
+
+    containers_with_labels = []
+    for _ in range(3):
+        containers_with_labels.append(
+            docker_client.run(
+                "busybox",
+                ["sleep", "infinity"],
+                remove=True,
+                detach=True,
+                labels=dict(dodo=random_label_value),
+            )
+        )
+
+    containers_with_wrong_labels = []
+    for _ in range(3):
+        containers_with_wrong_labels.append(
+            docker_client.run(
+                "busybox",
+                ["sleep", "infinity"],
+                remove=True,
+                detach=True,
+                labels=dict(dodo="something"),
+            )
+        )
+
+    expected_warning = (
+        r"Passing filters as a mapping is deprecated, replace with an iterable "
+        r"of tuples instead, as so:\n"
+        r"filters=\[\(.*\)\]"
+    )
+    with pytest.warns(DeprecationWarning, match=expected_warning):
+        expected_containers_with_labels = docker_client.container.list(
+            filters=dict(label=f"dodo={random_label_value}")
+        )
+
+    assert set(expected_containers_with_labels) == set(containers_with_labels)
+
+    for container in containers_with_labels + containers_with_wrong_labels:
+        container.kill()
+
+
 @pytest.mark.parametrize("ctr_client", ["docker", "podman"], indirect=True)
 def test_wait_single_container(ctr_client: DockerClient):
     cont_1 = ctr_client.run("busybox", ["sh", "-c", "sleep 2 && exit 8"], detach=True)

tests/python_on_whales/components/test_image.py

@@ -110,32 +110,30 @@ def test_save_iterator_bytes_and_load_from_iterator_list_of_images(
         pytest.param(
             "podman",
             marks=pytest.mark.xfail(
-                reason="podman lists images with registry in image name"
+                reason="podman includes all repo tags matching images ref"
             ),
         ),
     ],
     indirect=True,
 )
-def test_filter_when_listing(ctr_client: DockerClient):
+def test_list_filters(ctr_client: DockerClient):
     ctr_client.pull(["hello-world", "busybox"])
-    images_listed = ctr_client.image.list(filters=dict(reference="hello-world"))
+    images_listed = ctr_client.image.list(filters=[("reference", "hello-world")])
     tags = {tag.split("/")[-1] for image in images_listed for tag in image.repo_tags}
     assert tags == {"hello-world:latest"}
 
 
-def test_filter_when_listing_old_signature(docker_client: DockerClient):
+def test_list_filters_old_signature(docker_client: DockerClient):
     """Check backward compatibility of the DockerClient.image.list() API."""
     docker_client.pull(["hello-world", "busybox"])
-    with pytest.warns(DeprecationWarning) as warnings_emmitted:
-        images_listed = docker_client.image.list({"reference": "hello-world"})
-
-    warning_message = str(warnings_emmitted.list[0].message)
-    assert "docker.image.list({'reference': 'hello-world'}" in warning_message
-    assert "docker.image.list(filters={'reference': 'hello-world'}" in warning_message
-    tags = set()
-    for image in images_listed:
-        for tag in image.repo_tags:
-            tags.add(tag)
+    expected_warning = (
+        r"Passing filters as a mapping is deprecated, replace with an iterable "
+        r"of tuples instead, as so:\n"
+        r"filters=\[\(.*\)\]"
+    )
+    with pytest.warns(DeprecationWarning, match=expected_warning):
+        images_listed = docker_client.image.list(filters={"reference": "hello-world"})
+    tags = {tag.split("/")[-1] for image in images_listed for tag in image.repo_tags}
     assert tags == {"hello-world:latest"}
 
 
@@ -146,13 +144,13 @@ def test_filter_when_listing_old_signature(docker_client: DockerClient):
         pytest.param(
             "podman",
             marks=pytest.mark.xfail(
-                reason="podman lists images with registry in image name"
+                reason="podman includes all repo tags matching images ref"
             ),
         ),
     ],
     indirect=True,
 )
-def test_use_first_argument_to_filter(ctr_client: DockerClient):
+def test_list_filter_by_name(ctr_client: DockerClient):
     ctr_client.pull(["hello-world", "busybox"])
     images_listed = ctr_client.image.list("hello-world")
     tags = {tag.split("/")[-1] for image in images_listed for tag in image.repo_tags}

tests/python_on_whales/components/test_network.py

@@ -92,3 +92,25 @@ def test_network_exists(ctr_client: DockerClient):
     # Outside with clause, network should be removed and no longer exist
     assert not ctr_client.network.exists(network)
     assert not network.exists()
+
+
+@pytest.mark.parametrize("ctr_client", ["docker", "podman"], indirect=True)
+def test_list_filters(ctr_client: DockerClient):
+    name = random_name()
+    with ctr_client.network.create(name) as network:
+        networks_listed = ctr_client.network.list(filters=[("name", name)])
+    assert networks_listed == [network]
+
+
+def test_list_filters_old_signature(docker_client: DockerClient):
+    """Check backward compatibility of the DockerClient.network.list() API."""
+    name = random_name()
+    expected_warning = (
+        r"Passing filters as a mapping is deprecated, replace with an iterable "
+        r"of tuples instead, as so:\n"
+        r"filters=\[\(.*\)\]"
+    )
+    with docker_client.network.create(name) as network:
+        with pytest.warns(DeprecationWarning, match=expected_warning):
+            networks_listed = docker_client.network.list(filters={"name": name})
+    assert networks_listed == [network]

tests/python_on_whales/components/test_pod.py

@@ -78,6 +78,31 @@ def test_list_multiple(podman_client: DockerClient):
         assert pod2_name in listed_pod_names
 
 
+def test_list_filters(podman_client: DockerClient):
+    pod1_name = random_name()
+    pod2_name = random_name()
+    select_label = random_name()
+    with podman_client.pod.create(pod1_name), podman_client.pod.create(
+        pod2_name, labels={select_label: None}
+    ):
+        listed_pods = podman_client.pod.list(filters=[("label", select_label)])
+        assert [p.name for p in listed_pods] == [pod2_name]
+
+
+def test_list_filters_old_signature(podman_client: DockerClient):
+    """Check backward compatibility of the DockerClient.pod.list() API."""
+    pod_name = random_name()
+    expected_warning = (
+        r"Passing filters as a mapping is deprecated, replace with an iterable "
+        r"of tuples instead, as so:\n"
+        r"filters=\[\(.*\)\]"
+    )
+    with podman_client.pod.create(pod_name):
+        with pytest.warns(DeprecationWarning, match=expected_warning):
+            listed_pods = podman_client.pod.list(filters={"name": pod_name})
+        assert [p.name for p in listed_pods] == [pod_name]
+
+
 def test_does_not_exist(podman_client: DockerClient):
     assert podman_client.pod.exists("pod-that-does-not-exist") is False
 

tests/python_on_whales/components/test_service.py

@@ -46,7 +46,7 @@ def test_get_list_of_services(docker_client: DockerClient):
 
 
 @pytest.mark.usefixtures("swarm_mode")
-def test_filters(docker_client: DockerClient):
+def test_list_filters(docker_client: DockerClient):
     random_label_value = random_name()
     with docker_client.service.create(
         "busybox",
@@ -59,11 +59,11 @@ def test_filters(docker_client: DockerClient):
             labels=dict(dodo="something"),
         ):
             expected_services = docker_client.service.list(
-                filters=dict(label=f"dodo={random_label_value}")
+                filters=[("label", f"dodo={random_label_value}")]
             )
             assert expected_services == [my_service]
             no_expected_services = docker_client.service.list(
-                filters=dict(label=f"dodo={random_name()}")
+                filters=[("label", f"dodo={random_name()}")]
             )
             assert len(no_expected_services) == 0
 

tests/python_on_whales/components/test_volume.py

@@ -7,7 +7,7 @@
 from python_on_whales import DockerClient
 from python_on_whales.components.volume.models import VolumeInspectResult
 from python_on_whales.exceptions import NoSuchVolume
-from python_on_whales.test_utils import get_all_jsons
+from python_on_whales.test_utils import get_all_jsons, random_name
 
 
 @pytest.mark.parametrize("json_file", get_all_jsons("volumes"))
@@ -84,6 +84,32 @@ def test_list(ctr_client: DockerClient):
         assert v in all_volumes
 
 
+@pytest.mark.parametrize("ctr_client", ["docker", "podman"], indirect=True)
+def test_list_filters(ctr_client: DockerClient):
+    select_label = random_name()
+    with ctr_client.volume.create(), ctr_client.volume.create(
+        labels={select_label: None}
+    ) as vol2:
+        listed_volumes = ctr_client.volume.list(filters=[("label", select_label)])
+        assert listed_volumes == [vol2]
+
+
+def test_list_filters_old_signature(docker_client: DockerClient):
+    """Check backward compatibility of the DockerClient.pod.list() API."""
+    expected_warning = (
+        r"Passing filters as a mapping is deprecated, replace with an iterable "
+        r"of tuples instead, as so:\n"
+        r"filters=\[\(.*\)\]"
+    )
+    select_label = random_name()
+    with docker_client.volume.create(), docker_client.volume.create(
+        labels={select_label: None}
+    ) as vol2:
+        with pytest.warns(DeprecationWarning, match=expected_warning):
+            listed_volumes = docker_client.volume.list(filters={"label": select_label})
+        assert listed_volumes == [vol2]
+
+
 @pytest.mark.parametrize(
     "ctr_client",
     [