try to run ci in docker

Author: hjwp

.github/workflows/tests.yml

@@ -35,6 +35,8 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
+          # submodules: recursive
+          # fetch-depth: 0
 
       - name: checkout submodules
         shell: bash
@@ -43,48 +45,50 @@ jobs:
           git submodule init
           git submodule status | cut -d" " -f2 | xargs -n1 -P0 git submodule update
 
-      - name: setup Git
-        shell: bash
+      - name: warm up docker image
         run: |
-          git config --global user.email "elspeth@example.com"
-          git config --global user.name "Elspeth See-Eye"
-          git config --global init.defaultBranch main
-
-      - name: Set up Python 3.12
-        uses: actions/setup-python@v5
-        with:
-          python-version: 3.12
+          docker run --rm \
+            --mount type=volume,source=rootmount,target=/root \
+            --mount type=bind,source=./,target=/app \
+            -t hjwp/obeythetestinggoat-book-tester:latest \
+            bash -c "echo hello world"
 
-      - name: Install apt stuff and other dependencies
-        shell: bash
+      - name: uv pip install --upgrade systemwide
         run: |
-          sudo add-apt-repository ppa:mozillateam/ppa
-          sudo apt update -y
-          sudo apt install -y \
-            asciidoctor \
-            language-pack-en \
-            ruby-coderay \
-            ruby-pygments.rb \
-            firefox-esr \
-            tree \
-            locales
-          sudo locale-gen en_GB.UTF-8
-          pip install uv
+          docker run --rm \
+            --mount type=volume,source=rootmount,target=/root \
+            --mount type=bind,source=./,target=/app \
+            -t hjwp/obeythetestinggoat-book-tester:latest \
+            bash -c "uv pip install --system --upgrade ."
 
-      - name: Install Python requirements.txt globally
-        shell: bash
+      - name: uv create virtualenv in mounted /app folder at .venv
         run: |
-          uv pip install --system  .
+          docker run --rm \
+            --mount type=volume,source=rootmount,target=/root \
+            --mount type=bind,source=./,target=/app \
+            -t hjwp/obeythetestinggoat-book-tester:latest \
+            bash -c "uv venv && uv pip install --upgrade ."
 
-      - name: Install Python requirements.txt into virtualenv
-        shell: bash
+      - name: git mark dirs safe (due to volume mount perms issue)
         run: |
-          make .venv/bin
+          docker run --rm \
+            --mount type=volume,source=rootmount,target=/root \
+            --mount type=bind,source=./,target=/app \
+            -t hjwp/obeythetestinggoat-book-tester:latest \
+            bash -c "git config --global --add safe.directory '*'"
+          docker run --rm \
+            --mount type=volume,source=rootmount,target=/root \
+            --mount type=bind,source=./,target=/app \
+            -t hjwp/obeythetestinggoat-book-tester:latest \
+            bash -c "cat ~/.gitconfig"
 
-      - name: Run chapter test
-        shell: bash
+      - name: run chapter tests
         run: |
-          make  ${{ matrix.test_chapter }}
+          docker run --rm \
+            --mount type=volume,source=rootmount,target=/root \
+            --mount type=bind,source=./,target=/app \
+            -t hjwp/obeythetestinggoat-book-tester:latest \
+            bash -c "make  ${{ matrix.test_chapter }}"
 
       - name: Archive the built html files
         uses: actions/upload-artifact@v4

Dockerfile

@@ -1,40 +1,37 @@
 FROM python:slim
+# -- Dockerfile is intended mainly for use in CI --
+
+RUN apt-get update -y && \
+    apt-get install -y \
+        asciidoctor \
+        curl \
+        firefox-esr \
+        git \
+        locales \
+        make \
+        ruby-pygments.rb \
+        tree \
+        wget \
+    && rm -rf /var/lib/apt/lists/*
+
+ENV LC_ALL=en_GB.UTF-8 LANG=en_GB.UTF8 LANGUAGE=en_GB:en
+RUN echo "en_GB.UTF-8 UTF-8" > /etc/locale.gen
+RUN locale-gen
 
-# -- WIP --
-# this dockerfile is a work in progress,
-# the vague intention is to use it for CI.
-
-# RUN add-apt-repository ppa:mozillateam/ppa && \
-RUN apt-get update -y
-
-RUN apt-get install -y \
-    git \
-    asciidoctor \
-    # language-pack-en \
-    ruby-pygments.rb \
-    firefox-esr \
-    tree \
-    locales
-
-RUN apt-get install -y \
-    make \
-    curl
-
-RUN locale-gen en_GB.UTF-8
-# RUN pip install uv
 ADD --chmod=755 https://astral.sh/uv/install.sh /install.sh
-RUN /install.sh && rm /install.sh
-RUN ln -s $HOME/.cargo/bin/uv /usr/bin/uv
+RUN /install.sh && rm /install.sh && \
+    ln -s $HOME/.cargo/bin/uv /usr/bin/uv
 
 RUN git config --global user.email "elspeth@example.com" && \
     git config --global user.name "Elspeth See-Eye" && \
     git config --global init.defaultBranch main
 
 WORKDIR /app
-RUN uv venv .venv
-
 COPY pyproject.toml pyproject.toml
-RUN uv pip install .
 
+# install python deps systemwide with uv
+ENV PIP_CACHE_DIR=/var/cache/pip
+
+RUN uv pip install --system .
 
 CMD bash

Makefile

@@ -170,3 +170,7 @@ unit-test: chapter_01.html $(VENV)/bin
 clean:
 	rm -rf $(TMPDIR)
 	rm -v $(HTML_PAGES)
+
+.PHONY: docker-build
+docker-build:
+	docker build --platform=linux/amd64 -t hjwp/obeythetestinggoat-book-tester:v2 .

tests/update_source_repo.py

@@ -48,7 +48,7 @@ def update_sources_for_chapter(chapter, previous_chapter=None):
         # make sure branch for previous chapter is available to start tests
         subprocess.check_output(["git", "checkout", previous_chapter], cwd=source_dir)
         subprocess.check_output(
-            ["git", "reset", "--hard", "{}/{}".format(REMOTE, previous_chapter)],
+            ["git", "reset", "--hard", f"{REMOTE}/{previous_chapter}"],
             cwd=source_dir,
         )