Spring cleaning: metadata, CI containerization, release workflow (NicTool#338)

Housekeeping
- Add root AGPL-3.0 LICENSE file
- Fix surname across all source files and Makefile.PL AUTHOR fields
- Remove stale META.yml files (generated by make dist)
- Update README with current status, Docker quickstart, fix forum link

Author: aberoham

.github/workflows/ci-image.yml

@@ -0,0 +1,43 @@
+name: CI Image
+
+on:
+  push:
+    branches: [master]
+    paths:
+      - 'dist/docker/Dockerfile'
+      - '.github/workflows/ci-image.yml'
+      - 'server/Makefile.PL'
+      - 'client/Makefile.PL'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  packages: write
+
+jobs:
+  build:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Compute image tag
+        id: meta
+        run: echo "tag=ghcr.io/${GITHUB_REPOSITORY,,}/build:latest" >> "$GITHUB_OUTPUT"
+
+      - uses: docker/setup-buildx-action@v4
+
+      - uses: docker/login-action@v4
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - uses: docker/build-push-action@v7
+        with:
+          context: .
+          file: dist/docker/Dockerfile
+          target: base
+          push: true
+          tags: ${{ steps.meta.outputs.tag }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

.github/workflows/ci.yml

@@ -13,135 +13,120 @@ on:
 
 permissions:
   contents: read
+  packages: read
 
 jobs:
   test:
-    runs-on: ubuntu-22.04
-
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v6
 
-      - name: Install system dependencies
+      - uses: docker/setup-buildx-action@v4
+
+      - uses: docker/login-action@v4
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Compute GHCR cache ref
+        id: meta
+        run: echo "ref=ghcr.io/${GITHUB_REPOSITORY,,}/build:latest" >> "$GITHUB_OUTPUT"
+
+      - name: Build CI base image
+        uses: docker/build-push-action@v7
+        with:
+          context: .
+          file: dist/docker/Dockerfile
+          target: base
+          tags: nictool-ci:latest
+          load: true
+          cache-from: |
+            type=registry,ref=${{ steps.meta.outputs.ref }}
+            type=gha,scope=ci
+          cache-to: type=gha,mode=max,scope=ci
+
+      - name: Generate test credentials
+        run: |
+          echo "DB_PW=$(openssl rand -base64 24)" >> "$GITHUB_ENV"
+          echo "ROOT_PW=$(openssl rand -base64 24)" >> "$GITHUB_ENV"
+
+      - name: Create test network and start MySQL
+        run: |
+          docker network create ci
+          docker run -d --name mysql --network ci \
+            -e MYSQL_ROOT_PASSWORD=root \
+            -e MYSQL_DATABASE=nictool \
+            --health-cmd="mysqladmin ping -h 127.0.0.1" \
+            --health-interval=5s \
+            --health-timeout=3s \
+            --health-retries=10 \
+            mysql:8
+
+      - name: Start CI container
         run: |
-          sudo apt-get update
-          sudo DEBIAN_FRONTEND=noninteractive apt-get install -y \
-            expat \
-            cpanminus \
-            libdbix-simple-perl \
-            libdbd-mysql-perl \
-            apache2 \
-            libapache2-mod-perl2 \
-            libapache2-mod-perl2-dev \
-            libapache-dbi-perl \
-            gettext \
-            libxml2 \
-            libnet-ip-perl \
-            libxml-libxml-perl \
-            libxml-parser-perl \
-            libdigest-hmac-perl \
-            libjson-perl \
-            librpc-xml-perl \
-            libsoap-lite-perl \
-            libmodule-build-perl \
-            libmime-base32-perl \
-            libmime-base64-perl \
-            libbind-confparser-perl \
-            libssl-dev \
-            libcrypt-openssl-rsa-perl \
-            libcrypt-openssl-dsa-perl \
-            libnet-dns-perl \
-            libyaml-perl \
-            bind9utils \
-            libwww-perl \
-            liburi-perl \
-            libmime-tools-perl \
-            libmailtools-perl \
-            libfile-sharedir-perl \
-            libperl-prereqscanner-perl \
-            libdbi-perl \
-            libcgi-pm-perl \
-            libtest-pod-perl \
-            libtest-output-perl \
-            libtest-simple-perl \
-            default-mysql-client
-
-      - name: Wait for MySQL service
+          docker run -d --name ci --network ci \
+            -v "$GITHUB_WORKSPACE:/workspace" \
+            -w /workspace \
+            -e NICTOOL_DB_USER_PASSWORD="$DB_PW" \
+            -e DB_ROOT_PASSWORD=root \
+            -e NICTOOL_DB_USER=nictool \
+            -e NICTOOL_DB_NAME=nictool \
+            -e DB_ENGINE=mysql \
+            -e DB_HOSTNAME=mysql \
+            -e ROOT_USER_EMAIL=ci@nictool.test \
+            -e ROOT_USER_PASSWORD="$ROOT_PW" \
+            -e NICTOOL_CLIENT_DIR=/workspace/client \
+            nictool-ci:latest sleep infinity
+
+      - name: Wait for MySQL
         run: |
-          sudo /etc/init.d/mysql start
-          for attempt in $(seq 1 10); do
-            if mysqladmin ping -h 127.0.0.1 --silent; then
+          for i in $(seq 1 60); do
+            if docker inspect --format='{{.State.Health.Status}}' mysql 2>/dev/null | grep -q healthy; then
+              echo "MySQL is healthy"
               exit 0
             fi
             sleep 2
           done
-          exit 1
+          echo "MySQL failed to become healthy" && exit 1
 
-      - name: Generate test credentials
+      - name: Install NicTool client and server
         run: |
-          DB_PW=$(openssl rand -base64 24)
-          ROOT_PW=$(openssl rand -base64 24)
-          echo "NICTOOL_DB_USER_PASSWORD=$DB_PW" >> "$GITHUB_ENV"
-          echo "DB_ROOT_PASSWORD=root" >> "$GITHUB_ENV"
-          echo "NICTOOL_DB_USER=nictool" >> "$GITHUB_ENV"
-          echo "NICTOOL_DB_NAME=nictool" >> "$GITHUB_ENV"
-          echo "DB_ENGINE=mysql" >> "$GITHUB_ENV"
-          echo "DB_HOSTNAME=localhost" >> "$GITHUB_ENV"
-          echo "ROOT_USER_EMAIL=ci@nictool.test" >> "$GITHUB_ENV"
-          echo "ROOT_USER_PASSWORD=$ROOT_PW" >> "$GITHUB_ENV"
-          echo "NICTOOL_CLIENT_DIR=$GITHUB_WORKSPACE/client" >> "$GITHUB_ENV"
-          echo "DB_SSL=1" >> "$GITHUB_ENV"
+          docker exec ci bash -c '
+            cd /workspace/client && perl Makefile.PL && cpanm -n .
+            cd /workspace/server && perl Makefile.PL && cpanm -n .
+          '
 
       - name: Allow Apache to traverse workspace path
         run: |
-          # Ubuntu 21.04+ defaults home dirs to 750; www-data needs o+x to traverse
-          dir="$GITHUB_WORKSPACE"
-          while [ "$dir" != "/" ]; do
-            sudo chmod o+x "$dir"
-            dir="$(dirname "$dir")"
-          done
+          docker exec ci bash -c '
+            dir="/workspace"
+            while [ "$dir" != "/" ]; do
+              chmod o+x "$dir"
+              dir="$(dirname "$dir")"
+            done
+          '
 
       - name: Set up NicTool configs, Apache, and TLS
-        run: sudo -E dist/setup/install-nictool.sh --nt-dir="$GITHUB_WORKSPACE"
-
-      - name: Install Perl modules for Apache/mod_perl
-        run: |
-          sudo cpanm --notest \
-            CryptX Crypt::Mac::HMAC Crypt::KeyDerivation \
-            Test::HTML::Lint Time::TAI64 DBD::MariaDB
-
-      - name: Install NicTool client and server
-        run: |
-          cd "$GITHUB_WORKSPACE/client"
-          perl Makefile.PL
-          sudo cpanm -n .
+        run: docker exec ci dist/setup/install-nictool.sh --nt-dir=/workspace
 
-          cd "$GITHUB_WORKSPACE/server"
-          perl Makefile.PL
-          sudo cpanm -n .
-
-      - name: Restart Apache
-        run: sudo service apache2 restart || sudo cat /var/log/apache2/error.log
+      - name: Start Apache
+        run: docker exec ci apachectl start
 
       - name: Create NicTool test database
-        run: |
-          cd "$GITHUB_WORKSPACE/server/sql"
-          echo "" | perl create_tables.pl --environment
+        run: docker exec ci bash -c 'cd /workspace/server/sql && echo "" | perl create_tables.pl --environment'
 
       - name: Create test user and test.cfg
-        run: perl dist/setup/setup-test-env.pl
+        run: docker exec ci perl dist/setup/setup-test-env.pl
 
       - name: Run client tests
-        run: make -C "$GITHUB_WORKSPACE/client" test
+        run: docker exec ci make -C /workspace/client test
 
       - name: Run server tests
-        run: make -C "$GITHUB_WORKSPACE/server" test
+        run: docker exec ci make -C /workspace/server test
 
       - name: Failure diagnostics
         if: failure()
         run: |
-          pwd
-          mysql --version
-          apache2 -version
-          sudo cat /var/log/apache2/error.log || true
-          cat /etc/apache2/apache2.conf || true
-          ls /usr/lib/apache2/modules/ || true
+          docker exec ci cat /var/log/apache2/error.log 2>/dev/null || true
+          docker logs mysql 2>&1 | tail -50 || true

.github/workflows/docker.yml

@@ -14,15 +14,15 @@ permissions:
 
 jobs:
   build:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v6
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
+        uses: docker/setup-buildx-action@v4
 
       - name: Build Docker image
-        uses: docker/build-push-action@v6
+        uses: docker/build-push-action@v7
         with:
           context: .
           file: dist/docker/Dockerfile
@@ -32,15 +32,15 @@ jobs:
 
   docker-tests:
     needs: build
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v6
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
+        uses: docker/setup-buildx-action@v4
 
       - name: Load Docker image from cache
-        uses: docker/build-push-action@v6
+        uses: docker/build-push-action@v7
         with:
           context: .
           file: dist/docker/Dockerfile
@@ -72,15 +72,15 @@ jobs:
 
   e2e-tests:
     needs: build
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v6
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
+        uses: docker/setup-buildx-action@v4
 
       - name: Load Docker image from cache
-        uses: docker/build-push-action@v6
+        uses: docker/build-push-action@v7
         with:
           context: .
           file: dist/docker/Dockerfile
@@ -99,14 +99,14 @@ jobs:
         timeout-minutes: 5
 
       - name: Set up Node.js
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@v6
         with:
           node-version: 22
           cache: npm
           cache-dependency-path: client/t/e2e/package-lock.json
 
       - name: Cache Playwright browsers
-        uses: actions/cache@v4
+        uses: actions/cache@v5
         id: playwright-cache
         with:
           path: ~/.cache/ms-playwright