Add FreeBSD vmactions integration

This change adds vmactions support for running 14.4-RELEASE and
15.1-RELEASE images with the lutok project.

Related to:	freebsd/atf#180
Signed-off-by: Enji Cooper <ngie@FreeBSD.org>

Author: ngie-eign

.github/workflows/build.yaml

@@ -9,6 +9,13 @@
 #     * Install
 #     * Run tests
 #
+# On FreeBSD we build with:
+# * latest clang from ports
+#     * The sanitizer libs for the base system compiler are installed in the
+#       wrong directory:
+#       https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=297510 .
+# * ld from system
+#
 # On MacOS we build with:
 # * latest clang from brew (system provided clang lacks sanitizers).
 # * ld from system
@@ -108,7 +115,7 @@ jobs:
                   which -a kyua
             - name: Configure
               run: |
-                  CFG_ARGS="--enable-atf"
+                  CFG_ARGS="--enable-atf --enable-developer"
                   for i in ${{ join(matrix.sanitize, ' ') }}; do
                       CFG_ARGS="${CFG_ARGS} --enable-${i}"
                   done
@@ -122,14 +129,163 @@ jobs:
                   ./admin/ci-build/01_configure.sh ${CFG_ARGS}
             - name: Distcheck (builds and tests)
               run: |
-                  CFG_ARGS="--disable-dependency-tracking --enable-atf"
+                  CFG_ARGS="--disable-dependency-tracking --enable-developer"
+                  for i in ${{ join(matrix.sanitize, ' ') }}; do
+                      CFG_ARGS="${CFG_ARGS} --enable-${i}"
+                  done
+                  cd "${LUTOK_SRCDIR}"
+                  env "EXTRA_DISTCHECK_CONFIGURE_ARGS=${CFG_ARGS}" \
+                      ./admin/ci-build/02_distcheck.sh
+            - name: Gather/Archive Logs and Reports
+              run: |
+                  REPORTS_DIR="${LUTOK_OBJDIR}/reports"
+                  mkdir -p "${REPORTS_DIR}"
+                  (
+                    cd "${REPORTS_DIR}"
+                    mkdir -p build_logs
+                    # Gather the distcheck failure log if the target failed.
+                    # It's easier to ignore the failure than create yet another
+                    # conditional variable step.
+                    cp -a "${LUTOK_SRCDIR}"/lutok-*/_build/sub/*.log build_logs/ \
+                        2>/dev/null || true
+                    # Include the raw kyua logs.
+                    cp -a ~/.kyua/logs kyua_logs
+                    # Include the raw kyua results DBs.
+                    cp -a ~/.kyua/store kyua_store
+                  )
+                  # Create an archive of the reports.
+                  job_name_encoded=$(echo "${JOB_NAME}" | tr ' ' '_')
+                  tar -cvf "lutok-test-reports-${job_name_encoded}.tar" \
+                      -C "${REPORTS_DIR}" .
+              if: ${{ ! cancelled() }}
+            - name: Archive Build Artifacts
+              uses: actions/upload-artifact@v4
+              with:
+                  name: Test Report for ${{ env.JOB_NAME }}
+                  path: lutok-test-reports-*.tar
+                  compression-level: 0
+                  retention-days: 10
+                  overwrite: true
+              if: ${{ ! cancelled() }}
+
+    build-and-test-freebsd:
+        # yamllint disable-line rule:line-length
+        name: FreeBSD ${{ matrix.release }} ${{ matrix.compiler }} ${{ join(matrix.sanitize, '+') }}
+        env:
+            AR: ${{ matrix.llvm-bindir }}/llvm-ar${{ matrix.llvm-version }}
+            CC: ${{ matrix.llvm-bindir }}/clang${{ matrix.llvm-version }}
+            CPP: ${{ matrix.llvm-bindir }}/clang-cpp${{ matrix.llvm-version }}
+            CXX: ${{ matrix.llvm-bindir }}/clang++${{ matrix.llvm-version }}
+            NM: ${{ matrix.llvm-bindir }}/llvm-nm${{ matrix.llvm-version }}
+            # yamllint disable-line rule:line-length
+            OBJDUMP: ${{ matrix.llvm-bindir }}/llvm-objdump${{ matrix.llvm-version }}
+            # yamllint disable-line rule:line-length
+            RANLIB: ${{ matrix.llvm-bindir }}/llvm-ranlib${{ matrix.llvm-version }}
+            # yamllint disable-line rule:line-length
+            STRIP: ${{ matrix.llvm-bindir }}/llvm-strip${{ matrix.llvm-version }}
+            LUTOK_SRCDIR: ${{ github.workspace }}/src
+            LUTOK_OBJDIR: ${{ github.workspace }}/obj
+            # yamllint disable-line rule:line-length
+            JOB_NAME: FreeBSD ${{ matrix.release }} ${{ matrix.compiler }} ${{ join(matrix.sanitize, '+') }}
+        runs-on: ubuntu-latest
+        strategy:
+            fail-fast: false
+            matrix:
+                include:
+                    - release: 14.4
+                      compiler: clang-22
+                      llvm-bindir: /usr/local/bin
+                      llvm-version: 22
+                      pkgs:
+                          - autoconf
+                          - automake
+                          - doxygen
+                          - git
+                          - libtool
+                          - llvm22
+                          - lua55
+                          - m4
+                          - pkgconf
+                          - sudo
+                          # ATF and kyua are distributed in the FreeBSD-tests
+                          # package on 14.4.
+                          - FreeBSD-tests
+                    - release: 15.1
+                      compiler: clang-22
+                      llvm-bindir: /usr/local/bin
+                      llvm-version: 22
+                      pkgs:
+                          - autoconf
+                          - automake
+                          - doxygen
+                          - git
+                          - libtool
+                          - llvm22
+                          - lua55
+                          - m4
+                          - pkgconf
+                          - sudo
+                          - FreeBSD-atf
+                          - FreeBSD-kyua
+                release:
+                    - 14.4
+                    - 15.1
+                sanitize:
+                    - ""
+                    - ubsan
+
+        steps:
+            - name: Checking out source
+              uses: actions/checkout@v4
+              with:
+                  path: src
+            - name: Start FreeBSD ${{ matrix.release }} VM
+              uses: vmactions/freebsd-vm@e9ea2cef1135a17c880e9ed9956c983d58421ece # v1.5.3
+              with:
+                  envs: 'LUTOK_SRCDIR CC CPP CXX NM OBJDUMP RANLIB STRIP JOB_NAME'
+                  prepare: |
+                      cd "${LUTOK_SRCDIR}"
+                      ./admin/ci-build/00_prepare_freebsd_image.sh
+                      pkg update
+                      pkg install -y ${{ join(matrix.pkgs, ' ') }}
+                      # Set up sudo no password for :wheel.
+                      echo '%wheel ALL=(ALL:ALL) NOPASSWD: ALL' > \
+                          /usr/local/etc/sudoers.d/wheel-no-password
+                  release: "${{ matrix.release }}"
+                  # NB: I tried nfs (failed when running chflags) and sshfs
+                  # (could not find files/directories when running configure)
+                  # to no avail here. This may change in the future, but for
+                  # now use rsync.
+                  # - ngie (2026-08-16)
+                  sync: rsync
+                  sync-time: true
+            - name: Configure
+              shell: freebsd {0}
+              run: |
+                  CFG_ARGS="--enable-atf --enable-developer"
+                  for i in ${{ join(matrix.sanitize, ' ') }}; do
+                      CFG_ARGS="${CFG_ARGS} --enable-${i}"
+                  done
+                  echo "uname -a: $(uname -a)"
+                  echo "uname -m: $(uname -m)"
+                  echo "uname -p: $(uname -p)"
+                  echo "Build environment:"
+                  kyua about | head -1
+                  env
+                  cd "${LUTOK_SRCDIR}"
+                  ./admin/ci-build/01_configure.sh ${CFG_ARGS}
+            - name: Distcheck (builds and tests)
+              shell: freebsd {0}
+              run: |
+                  CFG_ARGS="--disable-dependency-tracking --enable-developer"
                   for i in ${{ join(matrix.sanitize, ' ') }}; do
                       CFG_ARGS="${CFG_ARGS} --enable-${i}"
                   done
                   cd "${LUTOK_SRCDIR}"
                   env "EXTRA_DISTCHECK_CONFIGURE_ARGS=${CFG_ARGS}" \
                       ./admin/ci-build/02_distcheck.sh
             - name: Gather/Archive Logs and Reports
+              shell: freebsd {0}
               run: |
                   REPORTS_DIR="${LUTOK_OBJDIR}/reports"
                   mkdir -p "${REPORTS_DIR}"
@@ -139,8 +295,8 @@ jobs:
                     # Gather the distcheck failure log if the target failed.
                     # It's easier to ignore the failure than create yet another
                     # conditional variable step.
-                    cp -a "${LUTOK_SRCDIR}"/lutok-*/_build/sub/*.log \
-                        build_logs/ 2>/dev/null || true
+                    cp -a "${LUTOK_SRCDIR}"/lutok-*/_build/sub/*.log build_logs/ \
+                        2>/dev/null || true
                     # Include the raw kyua logs.
                     cp -a ~/.kyua/logs kyua_logs
                     # Include the raw kyua results DBs.

admin/ci-build/00_prepare_freebsd_image.sh

@@ -0,0 +1,26 @@
+#!/bin/sh
+#
+# Step 0: Prepare the FreeBSD VM image for use.
+#
+# SPDX-License-Identifier: BSD-2-Clause
+
+set -eux
+
+VERSION_MAJOR="$(uname -r | sed -Ee 's/\..+//')"
+if [ "${VERSION_MAJOR}" != 14 ]; then
+    exit 0
+fi
+
+# NO_CHECK_STYLE_BEGIN
+pkgbasify_sha256="7f3a4d514c46d03ad52d6689b621f4971ce85db42b1a41cabb18913e593357ad"
+pkgbasify_url="https://github.com/FreeBSDFoundation/pkgbasify/raw/refs/tags/v1.1.0/pkgbasify.lua"
+# NO_CHECK_STYLE_END
+pkgbasify_script="pkgbasify.lua"
+fetch -o "${pkgbasify_script}" "${pkgbasify_url}"
+chmod +x "${pkgbasify_script}"
+sha256 -c "${pkgbasify_sha256}" "${pkgbasify_script}"
+pkg update
+pkg upgrade -y pkg
+yes y | "./${pkgbasify_script}" --force
+
+# vim: syntax=sh:expandtab:shiftwidth=4:softtabstop=4