Add GitHub Actions workflow to build run-aplus-front images

Author: ihalaij1

.github/workflows/build.yml

@@ -0,0 +1,94 @@
+name: Build and push Docker image
+
+on:
+  push:
+    tags:
+      - 'v[0-9]*'
+
+jobs:
+  build:
+    name: Build (${{ matrix.platform }})
+    runs-on: ${{ matrix.runner }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - platform: linux/amd64
+            runner: ubuntu-24.04
+          - platform: linux/arm64
+            runner: ubuntu-24.04-arm
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Log in to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      # Build and push platform-specific digest (no manifest tag yet)
+      - name: Build and push by digest
+        id: build
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          file: docker/Dockerfile
+          platforms: ${{ matrix.platform }}
+          push: true
+          outputs: type=image,name=apluslms/run-aplus-front,push-by-digest=true,name-canonical=true
+
+      # Save the digest so the merge job can find it
+      - name: Export digest
+        run: |
+          mkdir -p /tmp/digests
+          digest="${{ steps.build.outputs.digest }}"
+          touch "/tmp/digests/${digest#sha256:}"
+
+      - name: Upload digest artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: digest-${{ matrix.platform == 'linux/amd64' && 'amd64' || 'arm64' }}
+          path: /tmp/digests/*
+          retention-days: 1
+
+  merge:
+    name: Merge manifests
+    runs-on: ubuntu-24.04
+    needs: build
+
+    steps:
+      - name: Download digests
+        uses: actions/download-artifact@v4
+        with:
+          path: /tmp/digests
+          pattern: digest-*
+          merge-multiple: true
+
+      - name: Log in to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Determine tags
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: apluslms/run-aplus-front
+          tags: |
+            type=raw,value=latest
+            type=match,pattern=v(\d+\.\d+)\.\d+$,group=1
+
+      - name: Create and push multi-arch manifest
+        working-directory: /tmp/digests
+        run: |
+          docker buildx imagetools create \
+            $(jq -cr '.tags | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON") \
+            $(printf 'apluslms/run-aplus-front@sha256:%s ' *)

docker/Dockerfile

@@ -0,0 +1,52 @@
+FROM apluslms/service-base:django-1.19
+
+# Set container related configuration via environment variables
+ENV CONTAINER_TYPE="aplus" \
+    APLUS_LOCAL_SETTINGS="/srv/aplus-cont-settings.py" \
+    APLUS_SECRET_KEY_FILE="/local/aplus/secret_key.py" \
+    USE_GITMANAGER="false"
+
+RUN : \
+ && apt_install \
+      python3-lxml \
+      python3-lz4 \
+      python3-pillow \
+      redis \
+\
+  # create user
+ && adduser --system --no-create-home --disabled-password --gecos "A+ webapp server,,," --home /srv/aplus --ingroup nogroup aplus \
+ && mkdir /srv/aplus && chown aplus.nogroup /srv/aplus \
+ && git config --global --add safe.directory /srv/aplus \
+ && :
+
+COPY docker/rootfs /
+COPY . /srv/aplus
+
+RUN cd /srv/aplus \
+  # prebuild .pyc files
+ && python3 -m compileall -q . \
+  # install requirements, remove the file, remove unrequired locales and tests
+ && pip_install \
+      -r requirements.txt \
+      "django-debug-toolbar >= 6.1.0, < 7" \
+      flower \
+ && rm requirements.txt \
+ && find /usr/local/lib/python* -type d -regex '.*/locale/[a-z_A-Z]+' -not -regex '.*/\(en\|fi\|sv\)' -print0 | xargs -0 rm -rf \
+ && find /usr/local/lib/python* -type d -name 'tests' -print0 | xargs -0 rm -rf \
+\
+  # preprocess
+ && export \
+    APLUS_SECRET_KEY="-" \
+    APLUS_CACHES="{\"default\": {\"BACKEND\": \"django.core.cache.backends.dummy.DummyCache\"}}" \
+ && python3 manage.py compilemessages 2>&1 \
+ && create-db.sh aplus aplus django-migrate.sh \
+ \
+ && mkdir -p /var/celery/results \
+ && chown -R aplus:nogroup /var/celery \
+ && :
+
+
+WORKDIR /srv/aplus
+EXPOSE 8000
+EXPOSE 5555
+CMD [ "manage", "runserver", "0.0.0.0:8000" ]

docker/README.md

@@ -0,0 +1,60 @@
+# run-aplus-front
+
+A Docker container that runs the A-plus
+Learning Management System exposed to port 8000.
+
+Note that the A-plus front service alone does not provide
+capability to implement or host learning material or exercises.
+The front connects to different material or assessment services
+that provide interactive content to learners. A common
+counterpart for content services is the
+[A-plus MOOC-grader](https://hub.docker.com/r/apluslms/run-mooc-grader/).
+
+See into the [A-plus manual course](https://github.com/apluslms/aplus-manual)
+that includes a Docker compose configuration to develop and test course content.
+
+## Usage
+
+A-plus is installed in `/srv/aplus`.
+You can mount development version of the source code to `/src/aplus`.
+The container will then copy it to `/srv/aplus` and compile
+the translation file (django.mo). If you mount directly to
+`/srv/aplus`, you need to manually compile the translation file beforehand,
+but on the other hand, Django can reload the code and restart the server
+without restarting the whole container when you edit the source code files.
+
+You can mount development version of the A+ source code on top of that, if you wish.
+
+Location `/data` is a volume and contains submission files, database and secret key.
+It is world writable, so you can run this container as normal user.
+
+The environment variable `APLUS_ENABLE_DJANGO_DEBUG_TOOLBAR` can be set to `'true'` or `'false'` in `docker-compose.yml`.
+It controls the Django Debug Toolbar, which provides useful debug data in a set panels on the right side of the web pages.
+The debug data comes from the a-plus code, not from course contents or exercise graders.
+Therefore, the toolbar is useful to A+ platform developers.
+If there is a reason to disable the toolbar (e.g., in some cases, it might slow down the performance),
+then it is easy to switch it on or off with the environment variable.
+By default when the env variable is not defined, the toolbar is disabled.
+
+Partial example of `docker-compose.yml` (volumes are optional of course):
+
+```yaml
+services:
+  plus:
+    image: apluslms/run-aplus-front
+    environment:
+      APLUS_ENABLE_DJANGO_DEBUG_TOOLBAR: 'true'
+    volumes:
+    # named persistent volume (until removed)
+    # - data:/data
+    # mount development version to /src/aplus
+    # - /home/user/a-plus/:/src/aplus/:ro
+    # or to /srv/aplus
+    # - /home/user/a-plus/:/srv/aplus/:ro
+    ports:
+      - "8000:8000"
+    depends_on:
+      - grader
+volumes:
+  data:
+```

docker/rootfs/etc/cont-init.d/aplus

@@ -0,0 +1,21 @@
+#!/bin/sh
+
+. /usr/local/lib/cont-init-functions.sh
+ENSURE_DIR_MODE=2755
+ENSURE_DIR_USER=aplus
+ENSURE_DIR_GROUP=nogroup
+
+ensure_dir /run/aplus
+ensure_dir /local/aplus
+ensure_dir /local/aplus/static
+ensure_dir /local/aplus/media
+
+ensure_dir /local/lti-services-in 2777 root root
+
+# Take this container's IP (v4) address, change the last component to .1 and
+# output it in a JSON list (like ["127.0.0.1"]) to Aplus settings.py.
+# The IP address with the .1 ending should be the host machine's IP address in
+# the Docker network, in other words, the IP address of the client (web browser).
+echo '["'$(hostname -i | cut -s -d. -f1-3)'.1"]' > /var/run/s6/container_environment/APLUS_INTERNAL_IPS
+
+echo "127.0.0.1 redis" >> /etc/hosts

docker/rootfs/etc/services.d/aplus-course-update/down

@@ -0,0 +1 @@
+/usr/local/lib/prefix-logs

docker/rootfs/etc/services.d/aplus-course-update/log/run

@@ -0,0 +1,26 @@
+#!/bin/execlineb -P
+
+define home /srv/aplus
+define run /run/aplus
+fdmove -c 2 1
+
+# Conditionally define celery
+# (-s is undocumented magic, that seems to move _prog_ to end of _then_ or
+# _else_ blocks and thus makes _define_ work)
+ifthenelse -s { test -e /local/venv_aplus/bin/python3 }
+{ define python3 /local/venv_aplus/bin/python3 }
+{ define python3 /usr/bin/python3 }
+
+# Use container environment
+with-contenv
+
+# user and workdir
+s6-setuidgid aplus
+s6-env HOME=${home}
+cd ${home}
+
+# Loop with 1s delay until course update succeeds
+loopwhilex -x 0
+if -n -t { ${python3} manage.py reload_course_configuration def/current }
+s6-sleep 1
+exit 1

docker/rootfs/etc/services.d/aplus-course-update/run

@@ -0,0 +1 @@
+/usr/local/lib/prefix-logs

docker/rootfs/etc/services.d/aplus-lti-services/down

@@ -0,0 +1,34 @@
+#!/bin/execlineb -P
+
+define user aplus
+define home /srv/${user}
+fdmove -c 2 1
+
+# Conditionally define celery
+# (-s is undocumented magic, that seems to move _prog_ to end of _then_ or
+# _else_ blocks and thus makes _define_ work)
+ifthenelse -s { test -e /local/venv_aplus/bin/python3 }
+{ define python3 /local/venv_aplus/bin/python3 }
+{ define python3 /usr/bin/python3 }
+
+# Use container environment
+with-contenv
+
+# Loop with 1s delay until course update succeeds
+loopwhilex -o 0
+foreground {
+    elglob -0 -- lti_jsons /local/lti-services-in/*.json
+    forx -- lti_json { ${lti_jsons} }
+    importas -u lti_json lti_json
+    if {
+        # user, workdir and exec django command
+        s6-setuidgid ${user}
+        s6-env HOME=${home}
+        cd ${home}
+        #${python3} manage.py configure_external_service_from_json -c all ${lti_json}
+        ${python3} manage.py configure_external_service_from_json -c def/current ${lti_json}
+    }
+    rm -rf ${lti_json}
+}
+s6-sleep 1
+exit 0 # continue the loop