refactor(translator): move into src layout and use uv properly

Author: crankynetman

.vscode/launch.json

@@ -44,7 +44,7 @@
             },
             "pathMappings": [
                 {
-                    "localRoot": "${workspaceFolder}/translator",
+                    "localRoot": "${workspaceFolder}/translator/src/translator",
                     "remoteRoot": "/app"
                 }
             ]
@@ -59,7 +59,7 @@
           },
           "pathMappings": [
               {
-                  "localRoot": "${workspaceFolder}/translator",
+                  "localRoot": "${workspaceFolder}/translator/src/translator",
                   "remoteRoot": "/app"
               }
           ]

compose.override.local.yml

@@ -105,6 +105,9 @@ services:
       replicas: 1
 
   translator:
+    build:
+      context: .
+      dockerfile: ./compose/local/translator/Dockerfile
     volumes:
       - ./translator/tests/:/app/tests/
     env_file:
@@ -117,6 +120,9 @@ services:
       - DEBUG=${DEBUG:-}
 
   translator-secondary:
+    build:
+      context: .
+      dockerfile: ./compose/local/translator/Dockerfile
     volumes:
       - ./translator/tests/:/app/tests/
     env_file:

compose.yml

@@ -101,7 +101,7 @@ services:
   translator:
     build:
       context: .
-      dockerfile: ./compose/local/translator/Dockerfile
+      dockerfile: ./compose/production/translator/Dockerfile
     depends_on:
       redis:
         condition: service_healthy
@@ -119,7 +119,7 @@ services:
   translator-secondary:
     build:
       context: .
-      dockerfile: ./compose/local/translator/Dockerfile
+      dockerfile: ./compose/production/translator/Dockerfile
     depends_on:
       redis:
         condition: service_healthy

compose/local/translator/Dockerfile

@@ -1,7 +1,6 @@
-FROM python:3.13-slim-bookworm
+FROM ghcr.io/astral-sh/uv:python3.13-bookworm-slim
 
-ENV PYTHONUNBUFFERED 1
-ENV PYTHONDONTWRITEBYTECODE 1
+ENV PYTHONUNBUFFERED=1
 
 RUN apt-get update \
   # dependencies for building Python packages
@@ -10,24 +9,26 @@ RUN apt-get update \
   && apt-get purge -y --auto-remove -o APT::AutoRemove::RecommendsImportant=false \
   && rm -rf /var/lib/apt/lists/*
 
-# Requirements are installed here to ensure they will be cached.
-COPY ./translator/requirements /requirements
-RUN pip install uv
-RUN uv pip install --system -r /requirements/base.txt
+WORKDIR /app
 
-RUN mkdir /app \
-  && cd /app \
-  && git clone -b v3.33.0 https://github.com/osrg/gobgp.git \
-  && cd gobgp/api \
-  && python3 -m grpc_tools.protoc -I./ --python_out=/app/ --pyi_out=/app/ --grpc_python_out=/app/ *.proto
+COPY ./translator/pyproject.toml ./translator/uv.lock* ./
 
-COPY ./translator/translator.py /app
-COPY ./translator/gobgp.py /app
-COPY ./translator/exceptions.py /app
-COPY ./translator/shared.py /app
+# Install deps only (as protobuf stuff doesn't exist yet but we need deps to setup protobufs)
+RUN uv sync --locked --no-install-project
 
-RUN chmod +x /app/translator.py
+# put the venv into PATH
+ENV PATH="/app/.venv/bin:$PATH"
 
-WORKDIR /app
+COPY ./translator/src /app/
+
+# Generate protobuf files
+# TODO: Make this less jank and don't do the git clone crap?
+RUN git clone -b v3.33.0 https://github.com/osrg/gobgp.git gobgp \
+  && cd gobgp/api \
+  && python3 -m grpc_tools.protoc -I./ --python_out=/app/translator/ --pyi_out=/app/translator/ --grpc_python_out=/app/translator/ *.proto \
+  && cd /app && rm -rf gobgp
+
+# Install the project itself (including the protobuff stuff)
+RUN uv sync --locked
 
-ENTRYPOINT ["/app/translator.py"]
+ENTRYPOINT ["python", "-m", "translator.translator"]

compose/production/translator/Dockerfile

@@ -0,0 +1,35 @@
+FROM ghcr.io/astral-sh/uv:python3.13-bookworm-slim
+
+ENV PYTHONUNBUFFERED=1
+ENV UV_NO_DEV=1
+
+RUN apt-get update \
+  # dependencies for building Python packages
+  && apt-get install -y build-essential git \
+  # cleaning up unused files
+  && apt-get purge -y --auto-remove -o APT::AutoRemove::RecommendsImportant=false \
+  && rm -rf /var/lib/apt/lists/*
+
+WORKDIR /app
+
+COPY ./translator/pyproject.toml ./translator/uv.lock* ./
+
+# Install deps only (as protobuf stuff doesn't exist yet but we need deps to setup protobufs)
+RUN uv sync --locked --no-install-project
+
+# put the venv into PATH
+ENV PATH="/app/.venv/bin:$PATH"
+
+COPY ./translator/src /app/
+
+# Generate protobuf files
+# TODO: Make this less jank and don't do the git clone crap?
+RUN git clone -b v3.33.0 https://github.com/osrg/gobgp.git gobgp \
+    && cd gobgp/api \
+    && python3 -m grpc_tools.protoc -I./ --python_out=/app/translator/ --pyi_out=/app/translator/ --grpc_python_out=/app/translator/ *.proto \
+    && cd /app && rm -rf gobgp
+
+# Install the project itself (including the protobuff stuff)
+RUN uv sync --locked
+
+ENTRYPOINT ["python", "-m", "translator.translator"]

pyproject.toml

@@ -150,4 +150,4 @@ django_settings_module = "config.settings.test"
 
 
 [tool.uv.workspace]
-exclude = ["scheduler"]
+exclude = ["scheduler", "translator"]

translator/pyproject.toml

@@ -0,0 +1,21 @@
+[project]
+name = "translator"
+dependencies = [
+  "aiohttp-sse-client>=0.2.1",
+  "behave>=1.2.6",
+  "coverage>=5.5",
+  "grpcio-tools>=1.69.0",
+  "websockets>=10.3",
+]
+requires-python = ">=3.13"
+version = "0.1.0"
+
+[dependency-groups]
+dev = [
+  "debugpy",
+  "pydevd-pycharm",
+]
+
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"

translator/requirements/base.txt

@@ -0,0 +1 @@
+"""Translator package for SCRAM."""