From 39f23bd9ea31424aa75917e56498bf6989a01e00 Mon Sep 17 00:00:00 2001
From: Tim McCormack <tmccormack@edx.org>
Date: Thu, 16 Jan 2025 21:03:52 +0000
Subject: [PATCH] feat: Add codejail service

This is just a skeleton image and doesn't have any directories or packages
that are specific to codejail yet.

Lots of differences from cookiecutter django-ida default:

- Remove MySQL system packages
- Use latest Ubuntu LTS
- Shorten the base folder from `codejail-service` to `codejail`
- Use port 8080; we'll remap it in compose anyhow
- Use ADD on a git repo rather than RUN/curl/tar, which runs afoul of
  Docker caching when a branch is used.
- Allow selecting a commit version
- Pass `DJANGO_SETTINGS_MODULE` from outside as env var to reduce
  differences between dev and prod targets and add flexibility.
- Install in /app and create virtualenv in /venv; no need to hew to the
  same pattern we used in the configuration repo.
- Remove apt cache in same RUN command so as not to create a fat layer
- Use heredoc syntax for multi-command RUN
- No log files, just log to stdout

See https://github.com/edx/edx-arch-experiments/issues/894
---
 .github/workflows/push-docker-images.yml |  1 +
 dockerfiles/codejail.Dockerfile          | 91 ++++++++++++++++++++++++
 images-data.json                         |  6 ++
 3 files changed, 98 insertions(+)
 create mode 100644 dockerfiles/codejail.Dockerfile

diff --git a/.github/workflows/push-docker-images.yml b/.github/workflows/push-docker-images.yml
index c055a30..a332148 100644
--- a/.github/workflows/push-docker-images.yml
+++ b/.github/workflows/push-docker-images.yml
@@ -26,6 +26,7 @@ on:
           - xqueue
           - portal designer
           - license manager
+          - codejail
       branch:
         description: "Target branch from which the source dockerfile from image will be sourced"
         default: "main"
diff --git a/dockerfiles/codejail.Dockerfile b/dockerfiles/codejail.Dockerfile
new file mode 100644
index 0000000..51dd3b4
--- /dev/null
+++ b/dockerfiles/codejail.Dockerfile
@@ -0,0 +1,91 @@
+# Usage:
+#
+# - Listens on port 8080 internally
+# - Set environment variable `DJANGO_SETTINGS_MODULE`, e.g. to
+#   `codejail_service.settings.production` or `codejail_service.settings.devstack`
+# - Override arg `VERSION` to a commit hash or a branch
+
+FROM ubuntu:noble AS app
+
+ARG GITHUB_REPO=openedx/codejail-service
+
+# This should be overridden with a commit hash to ensure we always get
+# a coherent result, even if things are changing on a branch as the
+# image is being built.
+#
+# Must use the full 40-character hash when specifying a commit hash.
+ARG VERSION=main
+
+# Python version
+ARG PYVER=3.12
+
+# Packages installed:
+#
+# - language-pack-en, locales: Ubuntu locale support so that system utilities
+#   have a consistent language and time zone.
+# - python*: A specific version of Python
+# - python*-dev: Header files for python extensions, required by many source wheels
+# - python*-venv: Allow creation of virtualenvs
+RUN <<EOF
+apt-get update
+DEBIAN_FRONTEND=noninteractive apt-get install \
+  --quiet --yes --no-install-recommends \
+  language-pack-en locales \
+  python${PYVER} python${PYVER}-dev python${PYVER}-venv
+# If you add a package, please add a comment above explaining why it is needed!
+rm -rf /var/lib/apt/lists/*
+EOF
+
+RUN locale-gen en_US.UTF-8
+ENV LANG en_US.UTF-8
+ENV LANGUAGE en_US:en
+ENV LC_ALL en_US.UTF-8
+
+WORKDIR /app
+
+# We'll build the virtualenv and pre-compile Python as root, but switch to user
+# `app` for actually running the application.
+RUN useradd -m --shell /bin/false app
+
+# Unpack the repo directly from GitHub, since this image is not built
+# from inside the application repo.
+#
+# Start with getting just the requirements files so that code changes
+# do not bust the image cache and require rebuilding the virtualenv.
+ADD https://github.com/${GITHUB_REPO}.git#${VERSION}:requirements requirements
+
+RUN <<EOF
+python${PYVER} -m venv /venv
+/venv/bin/pip install -r /app/requirements/pip.txt
+/venv/bin/pip install -r /app/requirements/pip-tools.txt
+EOF
+
+EXPOSE 8080
+
+
+FROM app AS dev
+
+RUN /venv/bin/pip-sync requirements/dev.txt
+RUN python${PYVER} -m compileall /venv
+
+# After the requirements so changes to the code will not bust the image cache
+ADD https://github.com/${GITHUB_REPO}.git#${VERSION} .
+RUN python${PYVER} -m compileall /app
+
+USER app
+CMD echo $PATH; while true; do /venv/bin/python ./manage.py runserver 0.0.0.0:8080; sleep 2; done
+
+
+FROM app AS prod
+
+RUN /venv/bin/pip-sync requirements/base.txt
+RUN python${PYVER} -m compileall /venv
+
+# After the requirements so changes to the code will not bust the image cache
+ADD https://github.com/${GITHUB_REPO}.git#${VERSION} .
+RUN python${PYVER} -m compileall /app
+
+USER app
+CMD /venv/bin/gunicorn -c /app/codejail_service/docker_gunicorn_configuration.py \
+    --bind '0.0.0.0:8080' --workers=2 --max-requests=1000 --name codejail \
+    codejail_service.wsgi:application
diff --git a/images-data.json b/images-data.json
index 2d7bd9a..3b120b8 100644
--- a/images-data.json
+++ b/images-data.json
@@ -133,5 +133,11 @@
     "name": "license manager",
     "os_platform": "linux/amd64,linux/arm64",
     "target": "dev"
+  },
+  {
+    "image_name": "codejail",
+    "name": "codejail",
+    "os_platform": "linux/amd64,linux/arm64",
+    "target": "dev"
   }
 ]