refactor: Enhance Meade command parsing and response handling

.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
+          pio run -e native -t coverage
       - 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/native/coverage_report/coverage.md ]; then
+            cat .pio/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 }}

matrix_build_parallel.py

@@ -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)

platformio.ini

@@ -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
+build_src_filter =
+	+<./core>
+	+<./ports>
+	+<./adapters>
+build_src_flags =
+	-std=gnu++17
 	-O0
-    --coverage
-    -fprofile-arcs
-    -ftest-coverage
-; Linker flag for coverage
+	-g
+	--coverage
+	-Wall
+	-Wextra
+	-Werror
+	-Wpedantic
+	-Wshadow
+test_lib_deps =
+	ArduinoFake@^0.4.0
 extra_scripts = scripts/test-coverage.py
-test_testing_command =
-	/usr/bin/env
-	python3
-	scripts/test-coverage.py
-	${platformio.build_dir}/${this.__env__}/program
+test_ignore = 
+	test_embedded

scripts/MeadeCommandParser.py

@@ -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/test-coverage.py

@@ -1,68 +1,65 @@
 import os
-import subprocess
-from pathlib import Path
 import sys
-from typing import TYPE_CHECKING, Any
-
-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."""
+import subprocess
+Import("env")
+
+# Ensure the coverage flags are passed to the linker
+env.Append(LINKFLAGS=["--coverage"])
+
+def generate_coverage(*args, **kwargs):
+    print("Running tests to generate coverage data...")
+    # Run PlatformIO tests natively; exit(1) if any test fails
+    result = subprocess.run(["pio", "test", "-e", "native", "-vvv"])
+    if result.returncode != 0:
+        print("\n❌ Tests failed — aborting coverage generation.")
+        sys.exit(1)
+
+    print("\nGenerating coverage report...")
+    # macOS Clang uses llvm-cov, Windows/Linux use standard gcov
+    # gcov_tool = "llvm-cov gcov" if sys.platform == "darwin" else "gcov"
+    gcov_tool = "gcov"
+
+    output_dir = os.path.join(".pio", env["PIOENV"], "coverage_report")
+
+    # Create the output directory
+    os.makedirs(output_dir, exist_ok=True)
+
+    # gcovr command to parse data and generate an HTML report
+    cmd = [
+        "gcovr",
+        "--root", ".",                   # Ensure paths are evaluated relative to the project root
+        "--gcov-executable", gcov_tool,
+        "--html-details", os.path.join(output_dir, "index.html"),
+        "--markdown", os.path.join(output_dir, "coverage.md"),
+
+        # Explicitly INCLUDE your actual source code directories
+        # Add "--filter", r"lib/.*" or others if you have code there too
+        #"--filter", r".*/core/.*",
+        #"--filter", r".*/src/.*",
+
+        # Exclude the test code itself from the final metrics
+        "--exclude", r".pio/*",
+        "--exclude", r"unit_tests/*",
+
+        # Ignore Unity testing framework errors
+        "--gcov-ignore-errors=no_working_dir_found",
+        "--gcov-ignore-errors=source_not_found",     
+        "--print-summary"
+    ]
+
     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()
+        subprocess.run(cmd, check=True)
+        print("\n✅ Coverage report successfully generated: coverage_report/index.html")
+    except FileNotFoundError:
+        print("\n❌ Error: 'gcovr' not found. Please install it using 'pip install gcovr'")
+    except subprocess.CalledProcessError:
+        print("\n❌ Error: Failed to generate coverage report.")
+
+# Register the custom target in PlatformIO
+env.AddCustomTarget(
+    name="coverage",
+    dependencies=None,
+    actions=[generate_coverage],
+    title="Coverage Report",
+    description="Run native tests and generate an HTML code coverage report"
+)