Add typehinting

Author: nateinaction

.pre-commit-config.yaml

@@ -24,3 +24,12 @@ repos:
     - id: cpplint
       args:
         - --config=cpplint.cfg
+
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.13.2
+  hooks:
+    - id: ruff-check
+      args: [--fix]
+    - id: ruff-check
+      args: [--fix, --select, I] # import sorting
+    - id: ruff-format

FprimeZephyrReference/Components/Watchdog/docs/sdd.md

@@ -12,7 +12,7 @@ Requirement | Description | Verification Method | Verified?
 ----------- | ----------- | ------------------- | ---------
 WD-001 | The `Components::Watchdog` component shall activate upon startup. | Inspection | Yes
 WD-002 | The `Components::Watchdog` component shall oscillate the watchdog GPIO pin (24) on/off on each rategroup tick. | Inspection | Yes
-WD-003 | The `Components::Watchdog` component shall provide telemetry for watchdog transition count. | Integration Test | In Progress
+WD-003 | The `Components::Watchdog` component shall provide telemetry for watchdog transition count. | Integration Test | Yes
 WD-004 | The `Components::Watchdog` component shall respond to stop signals to halt the watchdog. | Integration Test | Yes
 WD-005 | The `Components::Watchdog` component shall provide a test command to stop the watchdog. | Integration Test | Yes
 WD-006 | The `Components::Watchdog` component shall emit an event when the watchdog stops. | Integration Test | Yes

FprimeZephyrReference/test/int/watchdog_test.py

@@ -6,55 +6,61 @@
 """
 
 import time
+
 import pytest
+from fprime_gds.common.data_types.ch_data import ChData
+from fprime_gds.common.testing_fw.api import IntegrationTestAPI
+
 
 @pytest.fixture(autouse=True)
-def ensure_watchdog_running(fprime_test_api):
+def ensure_watchdog_running(fprime_test_api: IntegrationTestAPI):
     """Fixture to ensure watchdog is started before and after each test"""
     start_watchdog(fprime_test_api)
     yield
     start_watchdog(fprime_test_api)
 
-def start_watchdog(fprime_test_api):
+
+def start_watchdog(fprime_test_api: IntegrationTestAPI):
     """Helper function to start the watchdog"""
     fprime_test_api.send_and_assert_command(
-        "ReferenceDeployment.watchdog.START_WATCHDOG",
-        max_delay=2
+        "ReferenceDeployment.watchdog.START_WATCHDOG", max_delay=2
     )
     fprime_test_api.assert_event(
-        "ReferenceDeployment.watchdog.WatchdogStart",
-        timeout=2
+        "ReferenceDeployment.watchdog.WatchdogStart", timeout=2
     )
 
-def get_watchdog_transitions(fprime_test_api):
+
+def get_watchdog_transitions(fprime_test_api: IntegrationTestAPI) -> int:
     """Helper function to request packet and get fresh WatchdogTransitions telemetry"""
     fprime_test_api.clear_histories()
-    fprime_test_api.send_and_assert_command("CdhCore.tlmSend.SEND_PKT", ["5"], max_delay=2)
-    result = fprime_test_api.assert_telemetry(
-        "ReferenceDeployment.watchdog.WatchdogTransitions",
-        start="NOW", timeout=3
+    fprime_test_api.send_and_assert_command(
+        "CdhCore.tlmSend.SEND_PKT", ["5"], max_delay=2
+    )
+    result: ChData = fprime_test_api.assert_telemetry(
+        "ReferenceDeployment.watchdog.WatchdogTransitions", start="NOW", timeout=3
     )
     return result.get_val()
 
 
-def test_01_watchdog_telemetry_basic(fprime_test_api):
+def test_01_watchdog_telemetry_basic(fprime_test_api: IntegrationTestAPI):
     """Test that we can read WatchdogTransitions telemetry"""
     value = get_watchdog_transitions(fprime_test_api)
     assert value >= 0, f"WatchdogTransitions should be >= 0, got {value}"
 
 
-def test_02_watchdog_increments(fprime_test_api):
+def test_02_watchdog_increments(fprime_test_api: IntegrationTestAPI):
     """Test that WatchdogTransitions increments over time"""
 
     initial_value = get_watchdog_transitions(fprime_test_api)
     time.sleep(2.0)  # Wait for watchdog to run more cycles
     updated_value = get_watchdog_transitions(fprime_test_api)
 
-    assert updated_value > initial_value, \
+    assert updated_value > initial_value, (
         f"WatchdogTransitions should increase. Initial: {initial_value}, Updated: {updated_value}"
+    )
 
 
-def test_03_stop_watchdog_command(fprime_test_api):
+def test_03_stop_watchdog_command(fprime_test_api: IntegrationTestAPI):
     """
     Test STOP_WATCHDOG command sends and emits WatchdogStop
     event and WatchdogTransitions stops incrementing
@@ -63,15 +69,11 @@ def test_03_stop_watchdog_command(fprime_test_api):
 
     # Send stop command
     fprime_test_api.send_and_assert_command(
-        "ReferenceDeployment.watchdog.STOP_WATCHDOG",
-        max_delay=2
+        "ReferenceDeployment.watchdog.STOP_WATCHDOG", max_delay=2
     )
 
     # Check for watchdog stop event
-    fprime_test_api.assert_event(
-        "ReferenceDeployment.watchdog.WatchdogStop",
-        timeout=2
-    )
+    fprime_test_api.assert_event("ReferenceDeployment.watchdog.WatchdogStop", timeout=2)
 
     # Get watchdog transition count
     initial_value = get_watchdog_transitions(fprime_test_api)
@@ -80,5 +82,6 @@ def test_03_stop_watchdog_command(fprime_test_api):
     time.sleep(2.0)
     final_value = get_watchdog_transitions(fprime_test_api)
 
-    assert final_value == initial_value, \
+    assert final_value == initial_value, (
         f"Watchdog should remain stopped. Initial: {initial_value}, Final: {final_value}"
+    )