Merge pull request #100 from PlummersSoftwareLLC/neon

Neon - A New Web UI for Configuring and Monitoring the NDSCPP server

Author: davepl

.claude/skills/run-tests/SKILL.md

@@ -0,0 +1,89 @@
+---
+name: run-tests
+description: This skill should be used when the user asks to "run the tests", "build and test", "run ndscpp tests", "execute the test suite", "check if tests pass", or wants to verify that the application builds correctly and the test suite passes. Handles dependency verification, building ndscpp and the test suite, running the server in the background, and executing the tests.
+version: 1.0.0
+---
+
+# Run NDSCPP Tests
+
+Build the application, start it in the background, run the full test suite, and report the outcome.
+
+## Process
+
+### 1. Verify dependencies
+
+Run the dependency check script from the project root:
+
+```bash
+bash .claude/skills/run-tests/scripts/check-deps.sh
+```
+
+If any dependencies are missing, the script prints exactly what to install and exits non-zero. Stop and show the user the output — do not proceed until dependencies are satisfied.
+
+### 2. Build the main application
+
+```bash
+make
+```
+
+If the build fails, show the compiler errors and stop.
+
+### 3. Build the test suite
+
+```bash
+make -C tests
+```
+
+If this fails, show the errors and stop.
+
+### 4. Start ndscpp in the background
+
+```bash
+./ndscpp &
+NDSCPP_PID=$!
+```
+
+Wait up to 5 seconds for the server to become ready by polling its health endpoint:
+
+```bash
+for i in $(seq 1 10); do
+    curl -sf http://localhost:7777/api/controller >/dev/null 2>&1 && break
+    sleep 0.5
+done
+```
+
+If the server hasn't responded after 5 seconds, kill the process, show its output, and stop.
+
+### 5. Run the tests
+
+On Linux:
+```bash
+LD_LIBRARY_PATH="${LD_LIBRARY_PATH}:/usr/local/lib" ./tests/tests
+TEST_EXIT=$?
+```
+
+On macOS:
+```bash
+./tests/tests
+TEST_EXIT=$?
+```
+
+### 6. Stop the server
+
+```bash
+kill $NDSCPP_PID 2>/dev/null
+wait $NDSCPP_PID 2>/dev/null
+```
+
+Always kill the server, even if the tests failed.
+
+### 7. Report
+
+Exit with `$TEST_EXIT`. Report pass/fail and any failing test names from the GoogleTest output.
+
+## Notes
+
+- The default server port is `7777`. If the config file specifies a different port, adjust the health-check URL accordingly.
+- `config.led` and `secrets.h` are auto-created from their `.example` counterparts on the first `make` run — this is expected and not an error.
+- On Ubuntu, `cpr` has no apt package and must be built from source (the dependency check script explains how). Once installed, its shared library is at `/usr/local/lib/libcpr.so`, which is why `LD_LIBRARY_PATH` must include `/usr/local/lib`.
+- To run a single test: append `--gtest_filter=SuiteName.TestName` to the test binary invocation.

.claude/skills/run-tests/scripts/check-deps.sh

@@ -0,0 +1,94 @@
+#!/usr/bin/env bash
+# Checks that all build and test dependencies are present.
+# Exits 0 if everything is in place; exits 1 and prints a diagnosis otherwise.
+
+set -euo pipefail
+
+PLATFORM=$(uname -s)
+MISSING_BUILD=()
+MISSING_TEST=()
+MISSING_CPR_SOURCE=false
+
+check_brew() {
+    brew list "$1" &>/dev/null || MISSING_BUILD+=("$1")
+}
+
+check_brew_test() {
+    brew list "$1" &>/dev/null || MISSING_TEST+=("$1")
+}
+
+check_apt() {
+    dpkg -s "$1" &>/dev/null || MISSING_BUILD+=("$1")
+}
+
+check_apt_test() {
+    dpkg -s "$1" &>/dev/null || MISSING_TEST+=("$1")
+}
+
+if [[ "$PLATFORM" == "Darwin" ]]; then
+    echo "Platform: macOS"
+    for pkg in asio ffmpeg ncurses spdlog; do
+        check_brew "$pkg"
+    done
+    check_brew_test googletest
+    check_brew_test cpr
+else
+    echo "Platform: Linux"
+    for pkg in libasio-dev zlib1g-dev libavformat-dev libavcodec-dev \
+                libavutil-dev libswscale-dev libswresample-dev \
+                libcurl4-gnutls-dev libspdlog-dev; do
+        check_apt "$pkg"
+    done
+    check_apt_test libgtest-dev
+    check_apt_test cmake
+
+    # cpr has no apt package on Ubuntu; cmake installs to /usr/local/lib which
+    # may not be registered in the ldconfig cache, so check both.
+    if ! ldconfig -p 2>/dev/null | grep -qE '^\s+libcpr\.so' && \
+       ! ls /usr/local/lib/libcpr.so* &>/dev/null; then
+        MISSING_CPR_SOURCE=true
+    fi
+fi
+
+RC=0
+
+if [[ ${#MISSING_BUILD[@]} -gt 0 ]]; then
+    echo ""
+    echo "MISSING build dependencies: ${MISSING_BUILD[*]}"
+    if [[ "$PLATFORM" == "Darwin" ]]; then
+        echo "  Install with: brew install ${MISSING_BUILD[*]}"
+    else
+        echo "  Install with: sudo apt install ${MISSING_BUILD[*]}"
+    fi
+    RC=1
+fi
+
+if [[ ${#MISSING_TEST[@]} -gt 0 ]]; then
+    echo ""
+    echo "MISSING test dependencies: ${MISSING_TEST[*]}"
+    if [[ "$PLATFORM" == "Darwin" ]]; then
+        echo "  Install with: brew install ${MISSING_TEST[*]}"
+    else
+        echo "  Install with: sudo apt install ${MISSING_TEST[*]}"
+    fi
+    RC=1
+fi
+
+if [[ "$MISSING_CPR_SOURCE" == "true" ]]; then
+    echo ""
+    echo "MISSING: cpr (C++ Requests library) — no apt package available on Ubuntu."
+    echo "  Build and install it manually:"
+    echo "    git clone https://github.com/libcpr/cpr.git"
+    echo "    cd cpr && mkdir build && cd build"
+    echo "    cmake .. -DCPR_USE_SYSTEM_CURL=ON -DBUILD_SHARED_LIBS=ON -DCMAKE_CXX_STANDARD=20"
+    echo "    cmake --build . --parallel"
+    echo "    sudo cmake --install ."
+    RC=1
+fi
+
+if [[ $RC -eq 0 ]]; then
+    echo ""
+    echo "All dependencies are present."
+fi
+
+exit $RC

.github/workflows/CI.yml

@@ -26,7 +26,7 @@ jobs:
     - name: Set up dependencies (Linux)
       if: matrix.os == 'ubuntu-latest'
       run: |
-        sudo apt-get update 
+        sudo apt-get update
         sudo apt-get install -y libasio-dev zlib1g-dev libavformat-dev libavcodec-dev libavutil-dev libswscale-dev libswresample-dev libcurl4-gnutls-dev libspdlog-dev libgtest-dev
         git clone https://github.com/libcpr/cpr.git
         cd cpr && mkdir build && cd build
@@ -46,35 +46,10 @@ jobs:
 
     - name: Run tests
       # For the API tests, we start ndscpp in the background and then run the tests.
-      # Killing ndscpp is a bit rude and technically unnecessary, but we've been 
+      # Killing ndscpp is a bit rude and technically unnecessary, but we've been
       # raised to clean up after ourselves, so that's what we do.
       run: |
         ./ndscpp > /dev/null 2>&1 &
         sleep 1
         LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:/usr/local/lib ./tests/tests
         sudo killall -9 ndscpp
-
-  build-web:
-
-    runs-on: ubuntu-latest
-
-    defaults:
-      run:
-        working-directory: ndsweb
-
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v6
-
-    - name: Set up Node.js
-      uses: actions/setup-node@v6
-      with:
-        node-version: '20'
-        cache: 'npm'
-        cache-dependency-path: ndsweb/package-lock.json
-
-    - name: Install dependencies
-      run: npm install --legacy-peer-deps
-
-    - name: Build ndsweb
-      run: npx nx build