Multiple preparations for extended testing

.clang-format-ignore

@@ -0,0 +1,8 @@
+**/*.md
+
+.github
+.pio
+.vscode
+build_cache
+
+scripts

.github/workflows/platformio_unit_tests.yml

@@ -11,12 +11,25 @@ jobs:
     continue-on-error: true
 
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v6
       - name: Set up Python
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.13' 
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install platformio
+          pip install gcovr
       - name: Run Unit Tests
         run: pio test -e native -v
+      - 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"
+          else
+            echo "Coverage report was not generated." >> "$GITHUB_STEP_SUMMARY"
+          fi

.gitignore

@@ -11,3 +11,6 @@ build_cache
 
 Configuration_local*
 MeadeToWikiOutput.txt
+
+# macOS
+**/.DS_Store

Changelog.md

@@ -1,3 +1,8 @@
+**V1.13.20 - Updates**
+- CI adjustments
+- Dependency updates
+- Unit testing improvements
+
 **V1.13.19 - Updates**
 - Support inverting and mirroring InfoDisplays.
 

README.md

@@ -28,6 +28,16 @@ This is an open source project and everyone is welcome to contribute. We will be
 
 Even if Arduino IDE is supported, we highly recommend using VSCode with [PlatformIO](https://platformio.org/) for development. It allows automatic dependency management, powerful IDE, debugging, automatic build flags definition and more.
 
+### Native unit tests
+
+Run the host-based unit tests with PlatformIO:
+
+```shell
+pio test -e native -v
+```
+
+This executes the tests under `unit_tests/test_common` without requiring any target hardware.
+
 ### Debugging
 
 #### ATmega2560-based

Version.h

@@ -3,4 +3,4 @@
 // Also, numbers are interpreted as simple numbers.                        _   __   _
 // So 1.8 is actually 1.08, meaning that 1.12 is a later version than 1.8.  \_(..)_/
 
-#define VERSION "V1.13.19"
+#define VERSION "V1.13.20"

platformio.ini

@@ -82,7 +82,7 @@ upload_protocol = wiring
 build_flags =
 	${env.build_flags}
 	-D BOARD=BOARD_AVR_RAMPS
-src_build_flags =
+build_src_flags =
 	${env.src_build_flags}
 	-Wuseless-cast
 debug_tool = avr-stub
@@ -139,3 +139,15 @@ build_flags =
 [env:native]
 platform = native
 test_ignore = test_embedded
+build_flags =
+	-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

scripts/test-coverage.py

@@ -0,0 +1,68 @@
+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."""
+    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()

src/Mount.cpp

@@ -359,7 +359,7 @@ void Mount::configureAZStepper(byte pin1, byte pin2, int maxSpeed, int maxAccele
     #ifdef NEW_STEPPER_LIB
     _stepperAZ = new StepperAzSlew(AccelStepper::DRIVER, pin1, pin2);
     #else
-    _stepperAZ    = new AccelStepper(AccelStepper::DRIVER, pin1, pin2);
+    _stepperAZ = new AccelStepper(AccelStepper::DRIVER, pin1, pin2);
     #endif
     _stepperAZ->setMaxSpeed(maxSpeed);
     _stepperAZ->setAcceleration(maxAcceleration);
@@ -377,7 +377,7 @@ void Mount::configureALTStepper(byte pin1, byte pin2, int maxSpeed, int maxAccel
     #ifdef NEW_STEPPER_LIB
     _stepperALT = new StepperAltSlew(AccelStepper::DRIVER, pin1, pin2);
     #else
-    _stepperALT   = new AccelStepper(AccelStepper::DRIVER, pin1, pin2);
+    _stepperALT = new AccelStepper(AccelStepper::DRIVER, pin1, pin2);
     #endif
     _stepperALT->setMaxSpeed(maxSpeed);
     _stepperALT->setAcceleration(maxAcceleration);
@@ -774,7 +774,7 @@ void Mount::configureALTdriver(uint16_t ALT_SW_RX, uint16_t ALT_SW_TX, float rse
     _driverALT->pdn_disable(true);
         #if UART_CONNECTION_TEST_TXRX == 1
     bool UART_Rx_connected = false;
-    UART_Rx_connected = connectToDriver("ALT");
+    UART_Rx_connected      = connectToDriver("ALT");
     if (!UART_Rx_connected)
     {
         digitalWrite(ALT_EN_PIN,
@@ -865,7 +865,7 @@ void Mount::configureFocusDriver(
     _driverFocus->pdn_disable(true);
         #if UART_CONNECTION_TEST_TXRX == 1
     bool UART_Rx_connected = false;
-    UART_Rx_connected = connectToDriver("FOC");
+    UART_Rx_connected      = connectToDriver("FOC");
     if (!UART_Rx_connected)
     {
         digitalWrite(FOCUS_EN_PIN,
@@ -1940,7 +1940,7 @@ void Mount::getAZALTPositions(long &azPos, long &altPos)
 #if (AZ_STEPPER_TYPE != STEPPER_TYPE_NONE)
     azPos = _stepperAZ->currentPosition();
 #else
-    azPos  = 0;
+    azPos = 0;
 #endif
 #if (ALT_STEPPER_TYPE != STEPPER_TYPE_NONE)
     altPos = _stepperALT->currentPosition();

src/Mount.hpp

@@ -36,21 +36,21 @@ using StepperFocusSlew = InterruptAccelStepper<config::Focus::stepper_slew>;
     #else
         #include "AccelStepper.h"
 class AccelStepper;
-using StepperRaSlew    = AccelStepper;
-using StepperRaTrk     = AccelStepper;
-using StepperDecSlew   = AccelStepper;
-using StepperDecTrk    = AccelStepper;
+using StepperRaSlew  = AccelStepper;
+using StepperRaTrk   = AccelStepper;
+using StepperDecSlew = AccelStepper;
+using StepperDecTrk  = AccelStepper;
 
         #if AZ_STEPPER_TYPE != STEPPER_TYPE_NONE
-using StepperAzSlew    = AccelStepper;
+using StepperAzSlew = AccelStepper;
         #endif
 
         #if ALT_STEPPER_TYPE != STEPPER_TYPE_NONE
-using StepperAltSlew   = AccelStepper;
+using StepperAltSlew = AccelStepper;
         #endif
 
         #if ALT_STEPPER_TYPE != STEPPER_TYPE_NONE
-using StepperAltSlew   = AccelStepper;
+using StepperAltSlew = AccelStepper;
         #endif
 
         #if FOCUS_STEPPER_TYPE != STEPPER_TYPE_NONE
@@ -61,21 +61,21 @@ using StepperFocusSlew = AccelStepper;
 #else
     #include "AccelStepper.h"
 class AccelStepper;
-using StepperRaSlew    = AccelStepper;
-using StepperRaTrk     = AccelStepper;
-using StepperDecSlew   = AccelStepper;
-using StepperDecTrk    = AccelStepper;
+using StepperRaSlew  = AccelStepper;
+using StepperRaTrk   = AccelStepper;
+using StepperDecSlew = AccelStepper;
+using StepperDecTrk  = AccelStepper;
 
     #if AZ_STEPPER_TYPE != STEPPER_TYPE_NONE
-using StepperAzSlew    = AccelStepper;
+using StepperAzSlew = AccelStepper;
     #endif
 
     #if ALT_STEPPER_TYPE != STEPPER_TYPE_NONE
-using StepperAltSlew   = AccelStepper;
+using StepperAltSlew = AccelStepper;
     #endif
 
     #if ALT_STEPPER_TYPE != STEPPER_TYPE_NONE
-using StepperAltSlew   = AccelStepper;
+using StepperAltSlew = AccelStepper;
     #endif
 
     #if FOCUS_STEPPER_TYPE != STEPPER_TYPE_NONE

src/b_setup.hpp

@@ -216,7 +216,7 @@ void setup()
         #ifdef OAE
     RA_SERIAL_PORT.begin(57600, SERIAL_8N1, RA_RX_PIN, RA_TX_PIN);
         #else
-    RA_SERIAL_PORT.begin(57600);   // Start HardwareSerial comms with driver
+    RA_SERIAL_PORT.begin(57600);  // Start HardwareSerial comms with driver
         #endif
     //
     #endif

src/fonts128x64.h

@@ -1,6 +1,7 @@
 #pragma once
 #include <Arduino.h>
 
+// clang-format off
 // Font generated or edited with the glyphEditor
 const uint8_t Bitmap3x5[] PROGMEM = {
 0x03, // Width: 3
@@ -441,3 +442,4 @@ const uint8_t OATLogo[] PROGMEM = {
 // Font Data:
 0x00, 0x0E, 0x00, 0x80, 0x31, 0x00, 0xC0, 0x40, 0x00, 0x40, 0x00, 0x00, 0x20, 0x00, 0x00, 0x10, 0x01, 0x00, 0x10, 0x00, 0x00, 0x08, 0x01, 0x00, 0x08, 0x00, 0x00, 0x00, 0x01, 0x00, 0x20, 0x05, 0x00, 0x40, 0x03, 0x00, 0x80, 0x03, 0x00, 0xF5, 0x5F, 0x01, 0x80, 0x03, 0x00, 0x40, 0x05, 0x00, 0x40, 0x41, 0x00, 0x00, 0x41, 0x00, 0x00, 0x20, 0x00, 0x00, 0x21, 0x00, 0x00, 0x10, 0x00, 0x00, 0x11, 0x00, 0x00, 0x08, 0x00, 0x08, 0x0C, 0x00, 0x30, 0x06, 0x00, 0xC0, 0x01, // 33
 };
+// clang-format on

src/libs/.clang-format-ignore

@@ -0,0 +1 @@
+TimerInterrupt/**

unit_tests/test_common/fakes/.clang-format-ignore

@@ -0,0 +1 @@
+fff.h