refactor: Enhance Meade command parsing and response handling (#291)

Author: andre-stefanov

.github/workflows/ci.yml

@@ -6,7 +6,7 @@ on:
       - '**'
   push:
     branches:
-      - '**'
+      - 'develop'
 
 jobs:
   unit-tests:
@@ -17,22 +17,26 @@ jobs:
       - uses: ./.github/actions/setup-pio
         with:
           install-unit-test-deps: 'true'
-      - name: Run unit tests
-        run: pio test -e native -v
+      - name: Run unit tests with coverage
+        if: always()
+        run: |
+          pip install gcovr
+          ./scripts/test-coverage.sh
       - name: Publish Coverage Summary
         if: always()
         run: |
           echo "## Native Unit Test Coverage" >> "$GITHUB_STEP_SUMMARY"
           echo >> "$GITHUB_STEP_SUMMARY"
-          if [ -f .pio/coverage.md ]; then
-            cat .pio/coverage.md >> "$GITHUB_STEP_SUMMARY"
+          if [ -f .pio/build/native/coverage_report/coverage.md ]; then
+            cat .pio/build/native/coverage_report/coverage.md >> "$GITHUB_STEP_SUMMARY"
           else
             echo "Coverage report was not generated." >> "$GITHUB_STEP_SUMMARY"
           fi
 
   build:
     name: Build (${{ matrix.board }})
     runs-on: ubuntu-latest
+    needs: unit-tests
     strategy:
       fail-fast: false
       matrix:
@@ -47,5 +51,7 @@ jobs:
       - uses: ./.github/actions/setup-pio
         with:
           install-matrix-deps: 'true'
+        env: 
+          PLATFORMIO_BUILD_CACHE_DIR: ${{ github.workspace }}/build_cache
       - name: Build ${{ matrix.board }}
         run: python matrix_build.py -b ${{ matrix.board }}

CLAUDE.md

@@ -27,6 +27,11 @@ pio run -e ramps -t upload
 # Run unit tests (native platform)
 pio test -e native
 
+# Run unit tests with coverage report (requires gcovr: pip install gcovr)
+./scripts/test-coverage.sh          # defaults to -e native
+./scripts/test-coverage.sh -e native
+# Report: .pio/build/native/coverage_report/index.html
+
 # Run matrix build (tests many configuration combinations across boards)
 python matrix_build.py -b ramps     # single board
 python matrix_build.py              # all boards

specs/plan.md PLAN.mdspecs/plan.md renamed to PLAN.md

@@ -136,6 +136,12 @@ def copy_caches_to_executors(src_proj_dir: Path, dst_executors: List[Executor]):
     dir_names_to_copy = ['.pio', 'build_cache']
     for dir_name_to_copy in dir_names_to_copy:
         src_path = Path(src_proj_dir, dir_name_to_copy)
+        # If the cache dir isn't inside the temp proj dir (e.g. when
+        # PLATFORMIO_BUILD_CACHE_DIR points at the repo root), try the repo root
+        if not src_path.exists():
+            src_path = Path('.', dir_name_to_copy)
+        if not src_path.exists():
+            continue
         for dst_executor in dst_executors:
             dst_path = Path(dst_executor.proj_dir, dir_name_to_copy)
             shutil.copytree(src_path, dst_path)

matrix_build_parallel.py

@@ -3,7 +3,6 @@ include_dir = .
 src_dir = ./src
 lib_dir = ./src/libs
 test_dir = ./unit_tests
-build_cache_dir = ./build_cache
 
 [common]
 lib_deps = 
@@ -123,31 +122,42 @@ platform = espressif32
 board = esp32dev
 upload_speed = 460800 
 monitor_filters = esp32_exception_decoder
+build_unflags = -std=gnu++11
 build_flags =
 	${env.build_flags}
+	-std=gnu++17
 	-D BOARD=BOARD_ESP32_ESP32DEV
 lib_deps = 
 	${common.lib_deps}
 	WiFi
 
 [env:oaeboardv1]
 extends = env:esp32
+build_unflags = -std=gnu++11
 build_flags =
 	${env.build_flags}
+	-std=gnu++17
 	-D BOARD=BOARD_OAE_V1 -D ESP32BOARD
 
 [env:native]
 platform = native
-test_ignore = test_embedded
-build_flags =
+test_build_src = true
+test_framework = googletest
+build_src_filter =
+	+<./core>
+	+<./ports>
+	+<./adapters>
+build_src_flags =
+	-std=gnu++17
 	-O0
-    --coverage
-    -fprofile-arcs
-    -ftest-coverage
-; Linker flag for coverage
-extra_scripts = scripts/test-coverage.py
-test_testing_command =
-	/usr/bin/env
-	python3
-	scripts/test-coverage.py
-	${platformio.build_dir}/${this.__env__}/program
+	-g
+	--coverage
+	-Wall
+	-Wextra
+	-Werror
+	-Wpedantic
+	-Wshadow
+test_lib_deps =
+	ArduinoFake@^0.4.0
+extra_scripts = pre:scripts/test-coverage.py
+test_filter = test_core

platformio.ini

@@ -11,8 +11,8 @@
 import os
 import re
 
-MEADE_CPP = "..\\src\\MeadeCommandProcessor.cpp"
-VERSION_FILE = "..\\Version.h"
+MEADE_CPP = os.path.join("..", "src", "core", "meade", "MeadeProtocol.hpp")
+VERSION_FILE = os.path.join("..", "Version.h")
 MODULE_PATH = os.path.dirname(os.path.realpath(__file__))
 START_LINE = 0
 END_LINE = 0

scripts/MeadeCommandParser.py

@@ -1,68 +1,4 @@
-import os
-import subprocess
-from pathlib import Path
-import sys
-from typing import TYPE_CHECKING, Any
+Import("env")
 
-if TYPE_CHECKING:
-    def Import(*names: str) -> tuple[Any, ...]:
-        ...
-
-def _project_root():
-    return Path(__file__).resolve().parent.parent
-
-
-def _native_build_dir():
-    return _project_root() / ".pio" / "build" / "native"
-
-
-def _has_coverage_data():
-    return any(_native_build_dir().rglob("*.gcda"))
-
-
-def ensure_gcovr_installed(build_env):
-    """Checks if gcovr is installed, and installs it via pip if not."""
-    try:
-        import gcovr
-    except ImportError:
-        print("gcovr not found! Installing it into the PlatformIO environment...")
-        # $PYTHONEXE ensures we use PlatformIO's isolated Python environment, not the system OS Python
-        build_env.Execute("$PYTHONEXE -m pip install gcovr")
-
-
-def generateCoverageInfo():
-    if not _has_coverage_data():
-        print("Skipping coverage report generation because no .gcda files were produced.")
-        return
-
-    print("Generating code coverage report...")
-    gcovr_cmd = ["gcovr"]
-    report_dir = _project_root()
-    # Adjust this path if you are testing multiple specific folders
-    subprocess.run(gcovr_cmd + ["--html-details", ".pio/coverage.html", "--filter", "src/"], check=True, cwd=report_dir)
-    print(f"Coverage report generated at: .pio/coverage.html")
-    subprocess.run(gcovr_cmd + ["--markdown", ".pio/coverage.md", "--filter", "src/"], check=True, cwd=report_dir)
-    print(f"Coverage report generated at: .pio/coverage.md")
-
-
-def configure_build():
-    Import("env")
-    build_env = globals()["env"]
-    build_env.Append(LINKFLAGS=["--coverage"])
-    ensure_gcovr_installed(build_env)
-
-
-def main(argv):
-    if not argv:
-        print("Usage: test-coverage.py <test-program> [args...]", file=sys.stderr)
-        return 2
-
-    completed = subprocess.run(argv, cwd=_project_root(), env=os.environ.copy(), check=False)
-    generateCoverageInfo()
-    return completed.returncode
-
-
-if __name__ == "__main__":
-    raise SystemExit(main(sys.argv[1:]))
-
-configure_build()
+# Ensure coverage flags reach the linker so .gcda files are produced.
+env.Append(LINKFLAGS=["--coverage"])

scripts/test-coverage.py

@@ -0,0 +1,75 @@
+#!/usr/bin/env bash
+# Run pio test and auto-generate coverage report.
+# Usage: ./scripts/test-coverage.sh [-e <env>] [extra pio test args...]
+#
+# This wrapper is needed because pio test spawns the test binary as a
+# subprocess — coverage data (.gcda files) is only flushed when that
+# subprocess exits, so we can't generate the report from inside the
+# test binary or from PlatformIO's pre-scripts.
+
+set -euo pipefail
+
+SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
+PROJECT_DIR="$(cd "$SCRIPT_DIR/.." && pwd)"
+cd "$PROJECT_DIR"
+
+# Extract environment name from args (default: native)
+ENV="native"
+NEXT_IS_ENV=0
+for arg in "$@"; do
+    if [ "$NEXT_IS_ENV" -eq 1 ]; then
+        ENV="$arg"
+        break
+    fi
+    if [ "$arg" = "-e" ]; then
+        NEXT_IS_ENV=1
+    fi
+done
+
+# Run tests (default to -e native if no args)
+if [ $# -gt 0 ]; then
+    pio test "$@" 2>&1
+else
+    pio test -e native 2>&1
+fi
+TEST_EXIT=$?
+
+if [ $TEST_EXIT -ne 0 ]; then
+    echo ""
+    echo "⚠️  Tests failed — skipping coverage report."
+    exit $TEST_EXIT
+fi
+
+# Determine gcov executable
+if [ "$(uname -s)" = "Darwin" ]; then
+    GCOV_TOOL="llvm-cov gcov"
+else
+    GCOV_TOOL="gcov"
+fi
+
+# Check if gcovr is available
+if ! command -v gcovr &>/dev/null; then
+    echo ""
+    echo "⚠️  gcovr not found — skipping coverage report (pip install gcovr)"
+    exit 0
+fi
+
+# Generate coverage report
+OUTPUT_DIR=".pio/build/$ENV/coverage_report"
+mkdir -p "$OUTPUT_DIR"
+
+echo ""
+echo "Generating coverage report..."
+gcovr \
+    --root . \
+    --gcov-executable "$GCOV_TOOL" \
+    --html-details "$OUTPUT_DIR/index.html" \
+    --markdown "$OUTPUT_DIR/coverage.md" \
+    --exclude '.pio/*' \
+    --exclude 'unit_tests/*' \
+    --gcov-ignore-errors=no_working_dir_found \
+    --gcov-ignore-errors=source_not_found \
+    --print-summary
+
+echo ""
+echo "✅ Coverage report: $OUTPUT_DIR/index.html"