tests should work with and without LEGACY_DEPS. legacydeps-flavour image generation documented and configured in CI

Author: alexbarcelo

.dockerignore

@@ -6,13 +6,17 @@
 # Now un-exclude:
 #
 !src
-!compile-protos.sh
+!compile_protos.py
+!dynamic_dependencies.py
 !dataclay-common
+!requirements.txt
 !requirements-legacydeps.txt
-!requirements-dev.txt
 !pyproject.toml
 !README.md
 !MANIFEST.in
 !tests
 !tox.ini
 .dockerignore
+
+# Reexclude protos
+src/dataclay/proto

.github/workflows/docker-publish.yml

@@ -84,10 +84,10 @@ jobs:
         uses: docker/build-push-action@v6
         with:
           context: .
-          file: Dockerfile.legacy-deps
           platforms: linux/amd64,linux/arm64
           build-args: 
             PYTHON_VERSION=${{ matrix.python-version }}-bullseye
+            LEGACY_DEPS=True
           push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta.outputs.tags }}-legacydeps
           labels: ${{ steps.meta.outputs.labels }}

Dockerfile

@@ -5,8 +5,10 @@ ARG PYTHON_VERSION=3.10-bookworm
 # install dataclay
 FROM python:$PYTHON_VERSION
 COPY . /app
+
+ARG LEGACY_DEPS=False
 RUN python -m pip install --upgrade pip \
-  && python -m pip install /app[telemetry]
+  && python -m pip install --config-settings=LEGACY_DEPS=$LEGACY_DEPS /app[telemetry]
 
 # prepare dataclay storage dir
 RUN mkdir -p /data/storage; 

Dockerfile.dev

@@ -5,8 +5,10 @@ ARG PYTHON_VERSION=3.10-bookworm
 # install dataclay
 FROM python:$PYTHON_VERSION
 COPY . /app
+
+ARG LEGACY_DEPS=False
 RUN python -m pip install --upgrade pip \
-  && python -m pip install -e /app[telemetry,dev]
+  && python -m pip install --config-settings=LEGACY_DEPS=$LEGACY_DEPS -e /app[telemetry,dev]
 
 # prepare dataclay storage dir
 RUN mkdir -p /data/storage; 

Dockerfile.legacy-deps

@@ -68,6 +68,22 @@
         docker buildx build --platform linux/amd64,linux/arm64 \
         -t ghcr.io/bsc-dom/dataclay:$VERSION-py3.13-bookworm \
         --build-arg PYTHON_VERSION=3.13-bookworm --push .
+
+        # Repeat for Python 3.9 and 3.10 with the _legacy dependency flavour_
+        # Build and push Python 3.9 bookworm
+        docker buildx build --platform linux/amd64,linux/arm64 \
+        -t ghcr.io/bsc-dom/dataclay:$VERSION-legacydeps-py3.9-bookworm \
+        --build-arg PYTHON_VERSION=3.9-bookworm \
+        --build-arg LEGACY_DEPS=True \
+        --push .
+
+        # Build and push Python 3.10 bookworm
+        docker buildx build --platform linux/amd64,linux/arm64 \
+        -t ghcr.io/bsc-dom/dataclay:$VERSION-legacydeps-py3.10-bookworm \
+        -t ghcr.io/bsc-dom/dataclay:$VERSION-legacydeps \
+        --build-arg PYTHON_VERSION=3.10-bookworm \
+        --build-arg LEGACY_DEPS=True \
+        --push .
         ```
 
 6. Publish the release distribution to PyPI:

Dockerfile.legacy-deps.dev

@@ -46,7 +46,7 @@ def find_config_settings_in_hatchling() -> dict[str, Any]:
             and module.__name__.startswith("hatchling.build")
             and "config_settings" in frame.f_locals
         ):
-            return frame.f_locals["config_settings"]
+            return frame.f_locals["config_settings"] or {}
 
     return {}
 

PUBLISH.md

@@ -27,7 +27,7 @@ def find_config_settings_in_hatchling() -> dict[str, Any]:
             and module.__name__.startswith("hatchling.build")
             and "config_settings" in frame.f_locals
         ):
-            return frame.f_locals["config_settings"]
+            return frame.f_locals["config_settings"] or {}
 
     return {}
 

compile_protos.py

@@ -22,21 +22,9 @@ def tests(session):
 @nox.session(python=["3.9", "3.10"], tags=["citests"])
 def legacy_deps_tests(session):
     """Run the test suite with legacy dependencies."""
-    session.install("grpcio-tools==1.48.2", "pytest", "pytest-asyncio", "pytest-docker", "pytest-cov", "-r", "requirements-legacydeps.txt")
-    session.run(
-        # See compile-protos.sh, it should be the same command
-        "python3",
-        "-m",
-        "grpc_tools.protoc",
-        "--proto_path=dataclay-common",
-        "--python_out=src",
-        "--grpc_python_out=src",
-        "dataclay-common/dataclay/proto/common/common.proto",
-        "dataclay-common/dataclay/proto/backend/backend.proto",
-        "dataclay-common/dataclay/proto/metadata/metadata.proto",
-    )
-
-    session.install(".", "--no-deps")
+    session.install("pytest", "pytest-asyncio", "pytest-docker", "pytest-cov")
+
+    session.install("--config-settings=LEGACY_DEPS=True", ".")
     session.run("pytest", "--disable-warnings", "--cov", "--cov-report=term-missing", "--build-legacy-deps", "tests/functional")