Merge remote-tracking branch 'origin/master' into processed-tracking-rating-callable

Author: adamtheturtle

tests/mock_vws/test_docker.py

@@ -4,6 +4,7 @@
 
 from __future__ import annotations
 
+import time
 import uuid
 from http import HTTPStatus
 from pathlib import Path
@@ -23,10 +24,44 @@
     from docker.models.networks import Network
 
 
+# We do not cover this function because hitting particular branches depends on
+# timing.
+def wait_for_flask_app_to_start(base_url: str) -> None:  # pragma: no cover
+    """
+    Wait for a server to start.
+
+    Args:
+        base_url: The base URL of the Flask app to wait for.
+    """
+    max_attempts = 10
+    sleep_seconds = 0.5
+    url = f"{base_url}/{uuid.uuid4().hex}"
+    for _ in range(max_attempts):
+        try:
+            response = requests.get(url, timeout=30)
+        except requests.exceptions.ConnectionError:
+            time.sleep(sleep_seconds)
+        else:
+            if response.status_code in (
+                HTTPStatus.NOT_FOUND,
+                HTTPStatus.UNAUTHORIZED,
+                HTTPStatus.FORBIDDEN,
+            ):
+                return
+    error_message = (
+        f"Could not connect to {url} after "
+        f"{max_attempts * sleep_seconds} seconds."
+    )
+    raise RuntimeError(error_message)
+
+
 @pytest.fixture(name="custom_bridge_network")
 def fixture_custom_bridge_network() -> Iterator[Network]:
     """
     Yield a custom bridge network which containers can connect to.
+
+    This also cleans up all containers connected to the network and the network
+    after the test.
     """
     client = docker.from_env()
     try:
@@ -44,6 +79,11 @@ def fixture_custom_bridge_network() -> Iterator[Network]:
     try:
         yield network
     finally:
+        network.reload()
+        for container in network.containers:
+            network.disconnect(container=container)
+            container.stop()
+            container.remove()
         network.remove()
 
 
@@ -103,7 +143,9 @@ def test_build_and_run(
 
     database = VuforiaDatabase()
     target_manager_container_name = "vws-mock-target-manager-" + random
-    target_manager_base_url = f"http://{target_manager_container_name}:5000"
+    target_manager_internal_base_url = (
+        f"http://{target_manager_container_name}:5000"
+    )
 
     target_manager_container = client.containers.run(
         image=target_manager_image,
@@ -118,15 +160,19 @@ def test_build_and_run(
         name="vws-mock-vws-" + random,
         publish_all_ports=True,
         network=custom_bridge_network.name,
-        environment={"TARGET_MANAGER_BASE_URL": target_manager_base_url},
+        environment={
+            "TARGET_MANAGER_BASE_URL": target_manager_internal_base_url,
+        },
     )
     vwq_container = client.containers.run(
         image=vwq_image,
         detach=True,
         name="vws-mock-vwq-" + random,
         publish_all_ports=True,
         network=custom_bridge_network.name,
-        environment={"TARGET_MANAGER_BASE_URL": target_manager_base_url},
+        environment={
+            "TARGET_MANAGER_BASE_URL": target_manager_internal_base_url,
+        },
     )
 
     for container in (target_manager_container, vws_container, vwq_container):
@@ -135,8 +181,8 @@ def test_build_and_run(
     target_manager_port_attrs = target_manager_container.attrs[
         "NetworkSettings"
     ]["Ports"]
-    target_manager_host_ip = target_manager_port_attrs["5000/tcp"][0]["HostIp"]
-    target_manager_host_port = target_manager_port_attrs["5000/tcp"][0][
+    task_manager_host_ip = target_manager_port_attrs["5000/tcp"][0]["HostIp"]
+    task_manager_host_port = target_manager_port_attrs["5000/tcp"][0][
         "HostPort"
     ]
 
@@ -148,11 +194,21 @@ def test_build_and_run(
     vwq_host_ip = vwq_port_attrs["5000/tcp"][0]["HostIp"]
     vwq_host_port = vwq_port_attrs["5000/tcp"][0]["HostPort"]
 
-    target_manager_host_url = (
-        f"http://{target_manager_host_ip}:{target_manager_host_port}"
+    base_vws_url = f"http://{vws_host_ip}:{vws_host_port}"
+    base_vwq_url = f"http://{vwq_host_ip}:{vwq_host_port}"
+    base_task_manager_url = (
+        f"http://{task_manager_host_ip}:{task_manager_host_port}"
     )
+
+    for base_url in (
+        base_vws_url,
+        base_vwq_url,
+        base_task_manager_url,
+    ):
+        wait_for_flask_app_to_start(base_url=base_url)
+
     response = requests.post(
-        url=f"{target_manager_host_url}/databases",
+        url=f"{base_task_manager_url}/databases",
         json=database.to_dict(),
         timeout=30,
     )
@@ -162,7 +218,7 @@ def test_build_and_run(
     vws_client = VWS(
         server_access_key=database.server_access_key,
         server_secret_key=database.server_secret_key,
-        base_vws_url=f"http://{vws_host_ip}:{vws_host_port}",
+        base_vws_url=base_vws_url,
     )
 
     target_id = vws_client.add_target(
@@ -178,13 +234,9 @@ def test_build_and_run(
     cloud_reco_client = CloudRecoService(
         client_access_key=database.client_access_key,
         client_secret_key=database.client_secret_key,
-        base_vwq_url=f"http://{vwq_host_ip}:{vwq_host_port}",
+        base_vwq_url=base_vwq_url,
     )
 
     matching_targets = cloud_reco_client.query(image=high_quality_image)
 
-    for container in (target_manager_container, vws_container, vwq_container):
-        container.stop()
-        container.remove()
-
     assert matching_targets[0].target_id == target_id