Add CI on PR

Author: gtaylor

.clang-tidy

@@ -1,5 +1,5 @@
 Checks: 'clang-analyzer-*,-clang-analyzer-security.insecureAPI.*,-clang-analyzer-deadcode.DeadStores,-clang-analyzer-optin.performance.Padding,-clang-analyzer-cplusplus.NewDelete,bugprone-narrowing-conversions,bugprone-suspicious-string-compare,bugprone-switch-missing-default-case,bugprone-branch-clone'
-HeaderFilterRegex: '^.*/src/.*'
+HeaderFilterRegex: '^.*/src/(mux|btech)/.*'
 CheckOptions:
   - key: bugprone-suspicious-string-compare.WarnOnImplicitComparison
     value: false

.devcontainer/Dockerfile

@@ -1,7 +1,35 @@
-FROM mcr.microsoft.com/devcontainers/cpp:1-ubuntu-24.04
+FROM mcr.microsoft.com/devcontainers/base:ubuntu24.04
+
+ARG CMAKE_VERSION=4.4.0
+ARG JUST_VERSION=1.50.0
 
 # [Optional] Uncomment this section to install additional vcpkg ports.
 # RUN su vscode -c "${VCPKG_ROOT}/vcpkg install <your-port-name-here>"
 
 RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
-    && apt-get -y install --no-install-recommends build-essential automake libevent-dev libdbi-dev libcrypt-dev libtool
+    && apt-get -y install --no-install-recommends \
+    build-essential ca-certificates clang-20 clang-format-20 clang-tidy-20 clang-tools-20 \
+    clangd-20 curl libsqlite3-dev sqlite3
+
+RUN case "$(uname -m)" in \
+    x86_64) CMAKE_ARCH=x86_64 ;; \
+    aarch64|arm64) CMAKE_ARCH=aarch64 ;; \
+    *) echo "Unsupported architecture: $(uname -m)" >&2; exit 1 ;; \
+    esac \
+    && CMAKE_ARCHIVE="cmake-${CMAKE_VERSION}-linux-${CMAKE_ARCH}.tar.gz" \
+    && curl --proto '=https' --tlsv1.2 --fail --silent --show-error \
+    "https://github.com/Kitware/CMake/releases/download/v${CMAKE_VERSION}/${CMAKE_ARCHIVE}" \
+    --output "/tmp/${CMAKE_ARCHIVE}" \
+    && curl --proto '=https' --tlsv1.2 --fail --silent --show-error \
+    "https://github.com/Kitware/CMake/releases/download/v${CMAKE_VERSION}/cmake-${CMAKE_VERSION}-SHA-256.txt" \
+    --output /tmp/cmake-SHA-256.txt \
+    && grep " ${CMAKE_ARCHIVE}$" /tmp/cmake-SHA-256.txt > /tmp/cmake-archive.sha256 \
+    && cd /tmp \
+    && sha256sum --check cmake-archive.sha256 \
+    && tar --extract --gzip --file "${CMAKE_ARCHIVE}" --strip-components=1 --directory /usr/local \
+    && rm "${CMAKE_ARCHIVE}" cmake-SHA-256.txt cmake-archive.sha256
+
+RUN curl --proto '=https' --tlsv1.2 --fail --silent --show-error \
+    https://just.systems/install.sh --output /tmp/just-install.sh \
+    && bash /tmp/just-install.sh --to /usr/local/bin --tag "${JUST_VERSION}" \
+    && rm /tmp/just-install.sh

.github/workflows/ci.yml

@@ -0,0 +1,35 @@
+name: Build and test
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ci-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-24.04
+    timeout-minutes: 30
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v6
+        with:
+          submodules: recursive
+          persist-credentials: false
+
+      - name: Build and test in devcontainer
+        uses: devcontainers/ci@v0.3
+        with:
+          configFile: .devcontainer/devcontainer.json
+          push: never
+          runCmd: |
+            just ci
+            git diff --exit-code

AGENTS.md

@@ -34,7 +34,7 @@ When writing C code, use the following naming conventions:
 ## Development workflows
 
 * We use the `just` command runner
-* When making changes, run `just lint-changes`, `just build`, `just test`, and then `just install` to validate end to end.
+* When making changes, run `just agent-checks` to validate end to end.
 * Make sure that updates to behaviors are reflected in `game/help/`, and `docs/`.
 * Check the various `game/*.conf` and `game/*.config` files when making changes to mudconfs, configs, and settings.
 * If making DB schema changes, offer to update the game's database at `game/data/stompymux.db.sqlite`. If a `stompymux` process is running, direct me to shutdown the game before making changes or instability could occur.

justfile

@@ -2,12 +2,16 @@ set shell := ["bash", "-eu", "-o", "pipefail", "-c"]
 
 build_dir := "build"
 build_type := env_var_or_default("CMAKE_BUILD_TYPE", "RelWithDebInfo")
-# clang-tidy must understand C23 `constexpr`, which landed in Clang 19; the
-# bare `clang-tidy` on this system still resolves to v18.
+# clang-tidy must understand C23 `constexpr`, which landed in Clang 19.
 clang_tidy := env_var_or_default("CLANG_TIDY", "clang-tidy-20")
+run_clang_tidy := env_var_or_default("RUN_CLANG_TIDY", "run-clang-tidy-20")
 clang_format := env_var_or_default("CLANG_FORMAT", "clang-format-20")
 
-default: lint build test install
+default: fmt build test install
+
+ci: fmt-check build test
+
+agent-checks: ci
 
 fmt:
     find src -type f \( -name '*.c' -o -name '*.h' -o -name '*.h.in' \) -print0 | xargs -0 -r {{clang_format}} -i
@@ -16,32 +20,7 @@ fmt-check:
     find src -type f \( -name '*.c' -o -name '*.h' -o -name '*.h.in' \) -print0 | xargs -0 -r {{clang_format}} --dry-run --Werror
 
 tidy:
-    cmake -S . -B {{build_dir}} -DCMAKE_BUILD_TYPE={{build_type}} -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
-    find src -type f -name '*.c' -print0 | xargs -0 -r -n1 {{clang_tidy}} -p {{build_dir}}
-
-lint: fmt lint-legacy-context tidy
-
-# Core and BTech code must use scoped contexts rather than legacy aliases.
-lint-legacy-context:
-    count="$(rg -l '\b(mudstate|mudconf)\b' src/mux src/btech --glob '*.c' --glob '*.h' | wc -l || true)"; test "$count" -eq 0 || { echo "legacy context used by $count source files" >&2; exit 1; }
-    count="$(rg -o 'btech_context_(current_unthreaded|bind_unthreaded)|BTECH_EVALUATION_CONTEXT|\bDOCHECK(N|0|1)?\(' src/mux src/btech --glob '*.c' --glob '*.h' | wc -l || true)"; test "$count" -eq 0 || { echo "legacy ambient BTech context usage returned ($count occurrences)" >&2; exit 1; }
-    count="$(rg -o '\b(getMap|getMech|WhichSpecial|FindObjectsData|IsMech|IsAuto|IsMap)\(' src/btech --glob '*.c' --glob '*.h' | wc -l || true)"; test "$count" -eq 0 || { echo "legacy BTech object lookup APIs used $count times" >&2; exit 1; }
-    count="$(rg -o '\b(Number|Roll)\(|\b(init_genrand|genrand_[a-z0-9_]+)\(|\brollstat\b|mt19937ar\.h' src/btech --glob '*.c' --glob '*.h' | wc -l || true)"; test "$count" -eq 0 || { echo "legacy ambient BTech random API used $count times" >&2; exit 1; }
-    count="$(rg -o '\bMissileHitTable\b|\bmissile_hit_table_struct\b' src/btech --glob '*.c' --glob '*.h' | wc -l || true)"; test "$count" -eq 0 || { echo "legacy mutable missile-hit table used $count times" >&2; exit 1; }
-    count="$(rg -o 'MechWeapons\[[^]]+\]\.(vrt|battlevalue)[[:space:]]*=' src/btech --glob '*.c' --glob '*.h' | wc -l || true)"; test "$count" -eq 0 || { echo "canonical weapon definitions mutated $count times" >&2; exit 1; }
-    count="$(rg -o 'btech_context_evaluation\(' src/btech --glob '*.c' --glob '*.h' | wc -l || true)"; test "$count" -le 506 || { echo "ambient BTech evaluation accessor grew to $count uses (maximum 506)" >&2; exit 1; }
-    count="$(rg -o 'LuaRuntime[[:space:]]*\*\*|\bspath_map\b' src/mux src/btech --glob '*.c' --glob '*.h' | wc -l || true)"; test "$count" -eq 0 || { echo "removed raw owner-slot or path-map global returned ($count occurrences)" >&2; exit 1; }
-    count="$(rg -o '\b(MechIDS|GetMechID|GetMechToMechID|GetMechToMechID_base|UnitPartsList|TraceLOS|ShortArmorSectionString|getStatusString|AI_Info|auto_show_command|silly_get_uptime_to_string|silly_atr_get_from|my_dump_flag|sensor_mode_name|add_color|GetLRSMech|LRSTerrain|LRSElevation|get_lrshexstr|MakeMapText|BuildBitString|BuildBitString2|BuildBitString2WithDelim|BuildBitString3|PrintArmorDamageString|ArmorKeyInfo|RetrieveValue)\(' src/btech --glob '*.c' --glob '*.h' | wc -l || true)"; test "$count" -eq 0 || { echo "legacy static-buffer helper returned ($count occurrences)" >&2; exit 1; }
-    count="$(rg -o 'static char (buf|buf2|buffer)\[[^]]+\]' src/btech/src/glue.scode.c src/btech/src/btech/mech.sensor.c src/btech/src/btech/mech.status.c src/btech/src/btech/template.c src/btech/src/btech/mech.advanced.c | wc -l || true)"; test "$count" -eq 0 || { echo "BTech callback or formatter static buffer returned ($count occurrences)" >&2; exit 1; }
-    count="$(rg -o 'char[[:space:]]*\*[[:space:]]*(structure_name|center_string)\(' src/btech --glob '*.c' --glob '*.h' | wc -l || true)"; test "$count" -eq 0 || { echo "caller-owned formatter regressed to a pointer return ($count occurrences)" >&2; exit 1; }
-    count="$(rg -o '\b(cachemech|cacheref)\b' src/btech --glob '*.c' --glob '*.h' | wc -l || true)"; test "$count" -eq 0 || { echo "ambient reference-mech cache returned ($count occurrences)" >&2; exit 1; }
-    count="$(rg -o '\bDestroySpecialObjects\b|free\(server->configuration\)' src/mux src/btech --glob '*.c' --glob '*.h' | wc -l || true)"; test "$count" -eq 0 || { echo "legacy composition-root teardown returned ($count occurrences)" >&2; exit 1; }
-
-lint-changes:
-    git diff --name-only -z --diff-filter=ACMR HEAD -- src | while IFS= read -r -d '' file; do case "$file" in *.c|*.h|*.h.in) {{clang_format}} -i "$file" ;; esac; done
-    just lint-legacy-context
-    cmake -S . -B {{build_dir}} -DCMAKE_BUILD_TYPE={{build_type}} -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
-    git diff --name-only -z --diff-filter=ACMR HEAD -- src | while IFS= read -r -d '' file; do case "$file" in *.c) {{clang_tidy}} -p {{build_dir}} "$file" ;; esac; done
+    {{run_clang_tidy}} -clang-tidy-binary {{clang_tidy}} -p {{build_dir}} -j "$(nproc)" '^.*/src/(mux|btech)/.*[.]c$'
 
 build:
     cmake -S . -B {{build_dir}} -DCMAKE_BUILD_TYPE={{build_type}} -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
@@ -50,12 +29,14 @@ build:
 test:
     ctest --test-dir {{build_dir}} --output-on-failure
 
-install: build
+install:
     cmake --install {{build_dir}} --prefix "$PWD/game"
 
 run:
     cd game && ulimit -c unlimited && exec ./stompymux stompymux.toml
 
+install-and-run: install run
+
 docsite:
     npm --prefix docs run build
 

src/mux/commands/command_invocation.c

@@ -43,4 +43,3 @@ void command_invocation_call_two_vectors(CommandTwoVectorsHandler handler,
           invocation->first, invocation->vector, invocation->vector_count,
           invocation->command_arguments, invocation->command_argument_count);
 }
-

src/mux/communication/comsys_context.c

@@ -4,9 +4,7 @@
 
 void comsys_context_initialize(ComsysContext *context,
                                const ServerConfiguration *configuration,
-                               RuntimeClock *clock,
-                               ChannelRegistry *channels) {
-  *context = (ComsysContext){.configuration = configuration,
-                            .clock = clock,
-                            .channels = channels};
+                               RuntimeClock *clock, ChannelRegistry *channels) {
+  *context = (ComsysContext){
+      .configuration = configuration, .clock = clock, .channels = channels};
 }

src/mux/network/connection_runtime.h

@@ -22,9 +22,8 @@ struct ConnectionRuntime {
 };
 
 static inline void connection_runtime_initialize(
-    ConnectionRuntime *runtime,
-    const ServerConfiguration *configuration, RuntimeClock *clock,
-    DescriptorRegistry *descriptors, ServerLog *log,
+    ConnectionRuntime *runtime, const ServerConfiguration *configuration,
+    RuntimeClock *clock, DescriptorRegistry *descriptors, ServerLog *log,
     AccessControlStore *access_control, FileCache **files_owner) {
   *runtime = (ConnectionRuntime){
       .configuration = configuration,

src/mux/server/diagnostics.c

@@ -12,7 +12,7 @@
 #include "mux/server/diagnostics.h"
 
 static void diagnostics_print_prefix(const char *file, int line,
-                                      const char *func) {
+                                     const char *func) {
   struct timeval tv;
   struct tm tm;
   time_t now;
@@ -25,7 +25,7 @@ static void diagnostics_print_prefix(const char *file, int line,
 }
 
 void diagnostics_log(const char *file, int line, const char *func,
-                      const char *format, ...) {
+                     const char *format, ...) {
   va_list args;
 
   diagnostics_print_prefix(file, line, func);
@@ -36,15 +36,15 @@ void diagnostics_log(const char *file, int line, const char *func,
 }
 
 [[noreturn]] void diagnostics_assert_failed(const char *file, int line,
-                                             const char *func,
-                                             const char *expr) {
+                                            const char *func,
+                                            const char *expr) {
   diagnostics_print_prefix(file, line, func);
   fprintf(stderr, "failed assertion '%s'\n", expr);
   abort();
 }
 
 void diagnostics_perror(const char *file, int line, const char *func,
-                         const char *expr, int saved_errno) {
+                        const char *expr, int saved_errno) {
   diagnostics_print_prefix(file, line, func);
   fprintf(stderr, "'%s' failed with '%s'\n", expr, strerror(saved_errno));
 }

src/mux/server/diagnostics.h

@@ -5,13 +5,12 @@
 #include <errno.h>
 
 void diagnostics_log(const char *file, int line, const char *func,
-                      const char *format, ...)
+                     const char *format, ...)
     __attribute__((format(printf, 4, 5)));
 [[noreturn]] void diagnostics_assert_failed(const char *file, int line,
-                                             const char *func,
-                                             const char *expr);
+                                            const char *func, const char *expr);
 void diagnostics_perror(const char *file, int line, const char *func,
-                         const char *expr, int saved_errno);
+                        const char *expr, int saved_errno);
 
 /* dassert: abort with a timestamped message if `x` is false. Always active,
  * regardless of the DEBUG build option. */