upgraded director-v0 to be compatible with both registries

Author: sanderegg

packages/pytest-simcore/src/pytest_simcore/docker_registry.py

@@ -22,35 +22,45 @@
 
 from .helpers.host import get_localhost_ip
 
-log = logging.getLogger(__name__)
+_logger = logging.getLogger(__name__)
 
 
 @pytest.fixture(scope="session")
 def docker_registry(keep_docker_up: bool) -> Iterator[str]:
+    """sets up and runs a docker registry container locally and returns its URL"""
+    yield from _docker_registry_impl(keep_docker_up, registry_version="3")
+
+
+@pytest.fixture(scope="session")
+def docker_registry_v2() -> Iterator[str]:
+    """sets up and runs a docker registry v2 container locally and returns its URL"""
+    yield from _docker_registry_impl(keep_docker_up=False, registry_version="2")
+
+
+def _docker_registry_impl(keep_docker_up: bool, registry_version: str) -> Iterator[str]:
     """sets up and runs a docker registry container locally and returns its URL"""
     # run the registry outside of the stack
     docker_client = docker.from_env()
     # try to login to private registry
     host = "127.0.0.1"
-    port = 5000
+    port = 5000 if registry_version == "3" else 5001
     url = f"{host}:{port}"
+    container_name = f"pytest_registry_v{registry_version}"
+    volume_name = f"pytest_registry_v{registry_version}_data"
+
     container = None
     try:
         docker_client.login(registry=url, username="simcore")
-        container = docker_client.containers.list(filters={"name": "pytest_registry"})[
-            0
-        ]
+        container = docker_client.containers.list(filters={"name": container_name})[0]
         print("Warning: docker registry is already up!")
     except Exception:  # pylint: disable=broad-except
         container = docker_client.containers.run(
-            "registry:3",
-            ports={"5000": "5000"},
-            name="pytest_registry",
+            f"registry:{registry_version}",
+            ports={"5000": port},
+            name=container_name,
             environment=["REGISTRY_STORAGE_DELETE_ENABLED=true"],
             restart_policy={"Name": "always"},
-            volumes={
-                "pytest_registry_data": {"bind": "/var/lib/registry", "mode": "rw"}
-            },
+            volumes={volume_name: {"bind": "/var/lib/registry", "mode": "rw"}},
             detach=True,
         )
 
@@ -79,9 +89,9 @@ def docker_registry(keep_docker_up: bool) -> Iterator[str]:
     os.environ["REGISTRY_SSL"] = "False"
     os.environ["REGISTRY_AUTH"] = "False"
     # the registry URL is how to access from the container (e.g. for accessing the API)
-    os.environ["REGISTRY_URL"] = f"{get_localhost_ip()}:5000"
+    os.environ["REGISTRY_URL"] = f"{get_localhost_ip()}:{port}"
     # the registry PATH is how the docker engine shall access the images (usually same as REGISTRY_URL but for testing)
-    os.environ["REGISTRY_PATH"] = "127.0.0.1:5000"
+    os.environ["REGISTRY_PATH"] = f"127.0.0.1:{port}"
     os.environ["REGISTRY_USER"] = "simcore"
     os.environ["REGISTRY_PW"] = ""
 
@@ -124,7 +134,7 @@ def registry_settings(
 @tenacity.retry(
     wait=tenacity.wait_fixed(2),
     stop=tenacity.stop_after_delay(20),
-    before_sleep=tenacity.before_sleep_log(log, logging.INFO),
+    before_sleep=tenacity.before_sleep_log(_logger, logging.INFO),
     reraise=True,
 )
 def wait_till_registry_is_responsive(url: str) -> bool:

services/director/tests/unit/fixtures/fake_services.py

@@ -117,7 +117,6 @@ async def _build_and_push_image(
     bad_json_format: bool = False,
     app_settings: ApplicationSettings,
 ) -> ServiceInRegistryInfoDict:
-
     # crate image
     service_description = _create_service_description(service_type, name, tag)
     docker_labels = _create_docker_labels(
@@ -214,12 +213,13 @@ async def _build_and_push_image(
     )
 
 
-def _clean_registry(registry_url: str, list_of_images: list[ServiceInRegistryInfoDict]):
+def _clean_registry(list_of_images: list[ServiceInRegistryInfoDict]):
     request_headers = {"accept": "application/vnd.docker.distribution.manifest.v2+json"}
     for image in list_of_images:
         service_description = image["service_description"]
         # get the image digest
         tag = service_description["version"]
+        registry_url = image["image_path"].split("/")[0]
         url = "http://{host}/v2/{name}/manifests/{tag}".format(
             host=registry_url, name=service_description["key"], tag=tag
         )
@@ -243,15 +243,13 @@ async def __call__(
         inter_dependent_services: bool = False,
         bad_json_format: bool = False,
         version="1.0.",
-    ) -> list[ServiceInRegistryInfoDict]:
-        ...
+    ) -> list[ServiceInRegistryInfoDict]: ...
 
 
 @pytest.fixture
 def push_services(
     docker_registry: str, app_settings: ApplicationSettings
 ) -> Iterator[PushServicesCallable]:
-    registry_url = docker_registry
     list_of_pushed_images_tags: list[ServiceInRegistryInfoDict] = []
     dependent_images = []
 
@@ -262,8 +260,13 @@ async def _build_push_images_to_docker_registry(
         inter_dependent_services=False,
         bad_json_format=False,
         version="1.0.",
+        override_registry_url: str | None = None,
     ) -> list[ServiceInRegistryInfoDict]:
         try:
+            registry_url = docker_registry
+            if override_registry_url:
+                _logger.info("Overriding registry URL with %s", override_registry_url)
+                registry_url = override_registry_url
             dependent_image = None
             if inter_dependent_services:
                 dependent_image = await _build_and_push_image(
@@ -317,5 +320,5 @@ async def _build_push_images_to_docker_registry(
     yield _build_push_images_to_docker_registry
 
     _logger.info("clean registry")
-    _clean_registry(registry_url, list_of_pushed_images_tags)
-    _clean_registry(registry_url, dependent_images)
+    _clean_registry(list_of_pushed_images_tags)
+    _clean_registry(dependent_images)

services/director/tests/unit/test_registry_proxy.py

@@ -21,7 +21,6 @@ async def test_list_no_services_available(
     configure_registry_access: EnvVarsDict,
     app: FastAPI,
 ):
-
     computational_services = await registry_proxy.list_services(
         app, registry_proxy.ServiceType.COMPUTATIONAL
     )
@@ -116,13 +115,36 @@ async def test_list_interactive_service_dependencies(
             assert image_dependencies[0]["tag"] == docker_dependencies[0]["tag"]
 
 
+@pytest.fixture(
+    params=["docker_registry", "docker_registry_v2"], ids=["registry_v3", "registry_v2"]
+)
+def configure_registry_access_both_versions(
+    app_environment: EnvVarsDict,
+    monkeypatch: pytest.MonkeyPatch,
+    request: pytest.FixtureRequest,
+) -> EnvVarsDict:
+    """Parametrized fixture that tests with both registry v3 and v2 - use only for specific tests that need both"""
+    registry_url = request.getfixturevalue(request.param)
+    return app_environment | setenvs_from_dict(
+        monkeypatch,
+        envs={
+            "REGISTRY_URL": registry_url,
+            "REGISTRY_PATH": registry_url,
+            "REGISTRY_SSL": False,
+            "DIRECTOR_REGISTRY_CACHING": False,
+        },
+    )
+
+
 async def test_get_image_labels(
-    configure_registry_access: EnvVarsDict,
+    configure_registry_access_both_versions: EnvVarsDict,
     app: FastAPI,
     push_services,
 ):
     images = await push_services(
-        number_of_computational_services=1, number_of_interactive_services=1
+        number_of_computational_services=1,
+        number_of_interactive_services=1,
+        override_registry_url=configure_registry_access_both_versions["REGISTRY_URL"],
     )
     images_digests = set()
     for image in images: