making tests more port-independent and applying a little bit of DRY

Author: alexbarcelo

noxfile.py

@@ -3,11 +3,11 @@
 # Define which Python versions to test with
 PYPROJECT = nox.project.load_toml("pyproject.toml")
 PYTHON_VERSIONS = nox.project.python_versions(PYPROJECT)
-DEFAULT_PYTHON = "3.10"  # Arbitrary decision, choose a reliable version
+DEFAULT_PYTHON = "3.10"  # Modern-ish version compatible with the legacy-deps
 
 # Default sessions (these will be executed in Github Actions)
 # Maintain a clear separation between code checking and code altering tasks (don't add format)
-nox.options.sessions = ["lint", "tests"]
+nox.options.sessions = ["lint", "tests", "legacy_deps_tests"]
 # nox.options.reuse_existing_virtualenvs = True # TODO: Check if necessary
 
 

tests/conftest.py

@@ -1,3 +1,35 @@
+import sys
+
+import pytest
+
+
+@pytest.fixture(scope="session")
+def python_version():
+    return f"{sys.version_info.major}.{sys.version_info.minor}"
+
+
+@pytest.fixture(scope="session")
+def docker_setup(python_version, request):
+    legacy_deps = request.config.getoption("--build-legacy-deps")
+    legacy_arg = f" --build-arg LEGACY_DEPS=True " if legacy_deps else " "
+    return [
+        f"build{ legacy_arg }--build-arg PYTHON_VERSION={python_version}-bookworm",
+        "up -d",
+    ]
+
+
+@pytest.fixture(scope="session")
+def proxy_connection(docker_ip, docker_services):
+    proxy_port = docker_services.port_for("proxy", 8676)
+    return "127.0.0.1", proxy_port
+
+
+@pytest.fixture(scope="session")
+def mds_connection(docker_ip, docker_services):
+    mds_port = docker_services.port_for("metadata-service", 16587)
+    return "127.0.0.1", mds_port
+
+
 def pytest_addoption(parser):
     parser.addoption(
         "--build-legacy-deps",

tests/functional/conftest.py

@@ -1,36 +1,20 @@
 import os
-import sys
 
 import grpc
 import pytest
 
 
-@pytest.fixture(scope="session")
-def python_version():
-    return f"{sys.version_info.major}.{sys.version_info.minor}"
-
-
-@pytest.fixture(scope="session")
-def docker_setup(python_version, request):
-    legacy_deps = request.config.getoption("--build-legacy-deps")
-    legacy_arg = f" --build-arg LEGACY_DEPS=True " if legacy_deps else " "
-    return [
-        f"build{ legacy_arg }--build-arg PYTHON_VERSION={python_version}-bookworm",
-        "up -d",
-    ]
-
-
 @pytest.fixture(scope="session")
 def docker_compose_file(pytestconfig):
     return os.path.join(str(pytestconfig.rootdir), "tests/functional", "docker-compose.yml")
 
 
 @pytest.fixture(scope="session")
-def deploy_dataclay(docker_ip, docker_services):
+def wait_dataclay(mds_connection):
     """Ensure that services are up and responsive."""
 
-    mds_port = docker_services.port_for("metadata-service", 16587)
-    grpc.channel_ready_future(grpc.insecure_channel(f"127.0.0.1:{mds_port}")).result(timeout=10)
+    mds_host, mds_port = mds_connection
+    grpc.channel_ready_future(grpc.insecure_channel(f"{mds_host}:{mds_port}")).result(timeout=10)
 
     # TODO: Wait for the backend to be ready before starting the tests
     # NOTE: Below code is not working since it is not the correct ip
@@ -40,10 +24,11 @@ def deploy_dataclay(docker_ip, docker_services):
 
 
 @pytest.fixture(scope="session")
-def client(deploy_dataclay):
+def client(wait_dataclay, mds_connection):
     import dataclay
 
-    client = dataclay.Client(host="127.0.0.1")
+    mds_host, mds_port = mds_connection
+    client = dataclay.Client(host=mds_host, port=mds_port)
     client.start()
     yield client
     client.stop()

tests/functional/docker-compose.legacy-deps.yml

@@ -2,8 +2,6 @@ services:
 
   redis:
     image: redis:latest
-    ports:
-      - 6379:6379
 
   metadata-service:
     image: "ghcr.io/bsc-dom/dataclay:dev"
@@ -16,7 +14,7 @@ services:
     depends_on:
       - redis
     ports:
-      - 16587:16587
+      - 16587
     environment:
       - DATACLAY_KV_HOST=redis
       - DATACLAY_KV_PORT=6379
@@ -69,7 +67,7 @@ services:
   proxy:
       image: "ghcr.io/bsc-dom/dataclay:dev"
       ports:
-        - 8676:8676
+        - 8676
       depends_on:
         - metadata-service
         - backend_1

tests/functional/docker-compose.yml

@@ -0,0 +1,21 @@
+import os
+
+import grpc
+import pytest
+
+
+@pytest.fixture(scope="session")
+def docker_compose_file(pytestconfig):
+    return os.path.join(str(pytestconfig.rootdir), "tests/proxy", "docker-compose.yml")
+
+
+@pytest.fixture(scope="session")
+def wait_dataclay(proxy_connection):
+    """Ensure that services are up and responsive."""
+
+    proxy_host, proxy_port = proxy_connection
+    grpc.channel_ready_future(grpc.insecure_channel(f"{proxy_host}:{proxy_port}")).result(timeout=10)
+
+    # backend_port = docker_services.port_for("backend", 6867)
+    # grpc.channel_ready_future(grpc.insecure_channel(f"127.0.0.1:{backend_port}")).result(timeout=10)
+

tests/functional/test_client.py

@@ -1,41 +1,14 @@
-import os
-import sys
-
-import grpc
 import pytest
 
 import dataclay
 
 
 @pytest.fixture(scope="session")
-def python_version():
-    return f"{sys.version_info.major}.{sys.version_info.minor}"
-
-
-@pytest.fixture(scope="session")
-def docker_setup(python_version):
-    return [f"build --build-arg PYTHON_VERSION={python_version}-bookworm", "up -d"]
-
-
-@pytest.fixture(scope="session")
-def docker_compose_file(pytestconfig):
-    return os.path.join(str(pytestconfig.rootdir), "tests/proxy", "docker-compose.yml")
-
-
-@pytest.fixture(scope="session")
-def deploy_dataclay(docker_ip, docker_services):
-    """Ensure that services are up and responsive."""
-
-    proxy_port = docker_services.port_for("proxy", 8676)
-    grpc.channel_ready_future(grpc.insecure_channel(f"127.0.0.1:{proxy_port}")).result(timeout=10)
-
-    # backend_port = docker_services.port_for("backend", 6867)
-    # grpc.channel_ready_future(grpc.insecure_channel(f"127.0.0.1:{backend_port}")).result(timeout=10)
-
-
-@pytest.fixture(scope="session")
-def client(deploy_dataclay):
-    client = dataclay.Client(proxy_host="127.0.0.1", username="Marc", password="s3cret")
+def client(wait_dataclay, proxy_connection):
+    proxy_host, proxy_port = proxy_connection
+    client = dataclay.Client(
+        proxy_host=proxy_host, proxy_port=proxy_port, username="Marc", password="s3cret"
+    )
     client.start()
     yield client
     client.stop()

tests/proxy/conftest.py

@@ -1,41 +1,14 @@
-import os
-import sys
-
-import grpc
 import pytest
 
 import dataclay
 
 
 @pytest.fixture(scope="session")
-def python_version():
-    return f"{sys.version_info.major}.{sys.version_info.minor}"
-
-
-@pytest.fixture(scope="session")
-def docker_setup(python_version):
-    return [f"build --build-arg PYTHON_VERSION={python_version}-bookworm", "up -d"]
-
-
-@pytest.fixture(scope="session")
-def docker_compose_file(pytestconfig):
-    return os.path.join(str(pytestconfig.rootdir), "tests/proxy", "docker-compose.yml")
-
-
-@pytest.fixture(scope="session")
-def deploy_dataclay(docker_ip, docker_services):
-    """Ensure that services are up and responsive."""
-
-    proxy_port = docker_services.port_for("proxy", 8676)
-    grpc.channel_ready_future(grpc.insecure_channel(f"127.0.0.1:{proxy_port}")).result(timeout=10)
-
-    # backend_port = docker_services.port_for("backend", 6867)
-    # grpc.channel_ready_future(grpc.insecure_channel(f"127.0.0.1:{backend_port}")).result(timeout=10)
-
-
-@pytest.fixture(scope="session")
-def client(deploy_dataclay):
-    client = dataclay.Client(proxy_host="127.0.0.1", username="Alex", password="s3cret")
+def client(wait_dataclay, proxy_connection):
+    proxy_host, proxy_port = proxy_connection
+    client = dataclay.Client(
+        proxy_host=proxy_host, proxy_port=proxy_port, username="Alex", password="s3cret"
+    )
     client.start()
     yield client
     client.stop()