chore: update development mode scripts to containerize Poetry and other relevant dependencies (#2144)

Author: nicomiguelino

bin/deploy_to_balena.sh

@@ -88,21 +88,6 @@ function prepare_balena_file() {
     envsubst > balena-deploy/docker-compose.yml
 }
 
-function initialize_python_environment() {
-    ./bin/install_poetry.sh
-
-    # Add `pyenv` to the load path.
-    export PYENV_ROOT="$HOME/.pyenv"
-    [[ -d $PYENV_ROOT/bin ]] && \
-        export PATH="$PYENV_ROOT/bin:$PATH"
-    eval "$(pyenv init -)"
-
-    # Add `poetry to the load path.
-    export PATH="$HOME/.local/bin:$PATH"
-
-    poetry install --only=docker-image-builder
-}
-
 if ! balena whoami; then
     echo "Please login to Balena with `balena login` command, then run this script again."
     exit 0
@@ -117,11 +102,9 @@ if [[ -z "${DEV_MODE+x}" ]]; then
 else
     echo "Running in dev mode..."
 
-    initialize_python_environment
-    poetry run python tools/image_builder \
-        --dockerfiles-only \
-        --disable-cache-mounts \
-        --build-target=${BOARD}
+    ENVIRONMENT="production" \
+    BUILD_TARGET="$BOARD" \
+        bin/generate_dev_mode_dockerfiles.sh
 
     cat docker-compose.balena.dev.yml.tmpl | \
         envsubst > docker-compose.yml

bin/generate_dev_mode_dockerfiles.sh

@@ -0,0 +1,26 @@
+#!/bin/bash
+
+set -euo pipefail
+
+BUILDER_DOCKERFILE='docker/Dockerfile.dev'
+BUILDER_IMAGE_NAME='anthias-dockerfile-image-builder'
+BUILDER_CONTAINER_NAME="${BUILDER_IMAGE_NAME}-instance"
+BUILD_TARGET="${BUILD_TARGET:-x86}"
+ENVIRONMENT="${ENVIRONMENT:-development}"
+
+docker build \
+    --pull \
+    -f "$BUILDER_DOCKERFILE" \
+    -t "$BUILDER_IMAGE_NAME" .
+
+docker rm -f "$BUILDER_CONTAINER_NAME" || true
+docker run \
+    --rm \
+    --name="$BUILDER_CONTAINER_NAME" \
+    -v "$(pwd):/app" \
+    "$BUILDER_IMAGE_NAME" \
+    poetry run python -m tools.image_builder \
+        --environment="$ENVIRONMENT" \
+        --dockerfiles-only \
+        --disable-cache-mounts \
+        --build-target="$BUILD_TARGET"

bin/install_poetry.sh

@@ -6,29 +6,7 @@ COMPOSE_ARGS=(
     '-f' 'docker-compose.dev.yml'
 )
 
-function initialize_python_environment() {
-    ./bin/install_poetry.sh
+bin/generate_dev_mode_dockerfiles.sh
 
-    # Add `pyenv` to the load path.
-    export PYENV_ROOT="$HOME/.pyenv"
-    [[ -d $PYENV_ROOT/bin ]] && \
-        export PATH="$PYENV_ROOT/bin:$PATH"
-    eval "$(pyenv init -)"
-
-    # Add `poetry to the load path.
-    export PATH="$HOME/.local/bin:$PATH"
-
-    poetry install --only=docker-image-builder
-}
-
-function generate_dockerfiles() {
-    poetry run python tools/image_builder \
-        --environment=development \
-        --dockerfiles-only \
-        --disable-cache-mounts
-}
-
-initialize_python_environment
-generate_dockerfiles
 docker compose "${COMPOSE_ARGS[@]}" down
 docker compose "${COMPOSE_ARGS[@]}" up -d --build

bin/start_development_server.sh

@@ -0,0 +1,12 @@
+FROM python:3.11-bookworm
+
+RUN apt-get update -y && \
+    curl -sSL https://install.python-poetry.org | python3 - && \
+    ln -s /root/.local/bin/poetry /usr/local/bin/poetry
+
+WORKDIR /app
+
+COPY pyproject.toml poetry.lock /app/
+
+RUN poetry install --only=docker-image-builder
+RUN git config --global --add safe.directory /app

docker/Dockerfile.dev

@@ -21,7 +21,8 @@ These components and their dependencies are mostly installed and handled with An
 To simplify development of the server module of Anthias, we've created a Docker container. This is intended to run on your local machine with the Anthias repository mounted as a volume.
 
 > [!IMPORTANT]
-> Anthias is using Docker's [buildx](https://docs.docker.com/engine/reference/commandline/buildx/) for the image builds. This is used both for cross compilation as well as for local caching. You might need to run `docker buildx create --use` first.
+> * Make sure that you have [installed Docker](https://docs.docker.com/engine/install/) on your machine before proceeding.
+> * Anthias is using Docker's [buildx](https://docs.docker.com/engine/reference/commandline/buildx/) for the image builds. This is used both for cross compilation as well as for local caching. You might need to run `docker buildx create --use` first.
 
 Assuming you're in the source code repository, simply run:
 
@@ -40,7 +41,15 @@ $ ./bin/start_development_server.sh
  ✔ Container anthias-anthias-nginx-1      Started                            0.5s
 ```
 
-Running the command above will start the development server and you should be able to
+> [!NOTE]
+> Running the script will install Python 3.11, [pyenv](https://github.com/pyenv/pyenv),
+> and [Poetry](https://python-poetry.org/) inside a Docker container on your machine.
+> This is to ensure that the development environment is consistent across different
+> machines.
+>
+> The script currently supports Debian-based systems and macOS.
+
+unning the command above will start the development server and you should be able to
 access the web interface at `http://localhost:8000`.
 
 To stop the development server, run the following: