Add integration tests

Author: nateinaction

FprimeZephyrReference/Components/Drv/Rv3028Manager/Rv3028Manager.cpp

@@ -41,7 +41,7 @@ void Rv3028Manager ::timeGetPort_handler(FwIndexType portNum, Fw::Time& time) {
     time.set(TimeBase::TB_WORKSTATION_TIME, 0, static_cast<U32>(posix_time), 0);
 }
 
-U32 Rv3028Manager ::timeRead_handler(FwIndexType portNum) {
+U32 Rv3028Manager ::timeGet_handler(FwIndexType portNum) {
     // Check device readiness
     if (!device_is_ready(this->rv3028)) {
         this->log_WARNING_HI_DeviceNotReady();
@@ -69,7 +69,7 @@ void Rv3028Manager ::timeSet_handler(FwIndexType portNum, const Drv::TimeData& t
 
     // Populate rtc_time structure from TimeData
     const struct rtc_time time_rtc = {
-        .tm_sec = 0,
+        .tm_sec = static_cast<int>(t.get_Second()),
         .tm_min = static_cast<int>(t.get_Minute()),
         .tm_hour = static_cast<int>(t.get_Hour()),
         .tm_mday = static_cast<int>(t.get_Day()),

FprimeZephyrReference/Components/Drv/Rv3028Manager/Rv3028Manager.fpp

@@ -6,13 +6,14 @@ module Drv {
         Day: U32 @< Day value.
         Hour: U32 @< Hour value.
         Minute: U32 @< Minute value.
+        Second: U32 @< Second value.
     }
 }
 
 # Port definition
 module Drv {
     port TimeSet(t: TimeData)
-    port TimeRead -> U32
+    port TimeGet -> U32
 }
 
 module Drv {
@@ -24,9 +25,9 @@ module Drv {
         @ Requirement Rv3028Manager-001
         sync input port timeSet: TimeSet
 
-        @ timeRead port to get the time from the RTC
+        @ timeGet port to get the time from the RTC
         @ Requirement Rv3028Manager-002
-        sync input port timeRead: TimeRead
+        sync input port timeGet: TimeGet
 
         ##############################################################################
         #### Uncomment the following examples to start customizing your component ####
@@ -41,7 +42,7 @@ module Drv {
         @ TimeGet event indicates that the time was read successfully
         event TimeGet(
             t: U32 @< POSIX time read from RTC
-        ) severity activity high id 2 format "RV3028 Time: {}"
+        ) severity activity high id 2 format "{}"
 
         @ TimeSet event indicates that the time was set successfully
         event TimeSet() severity activity high id 3 format "Time set on RV3028"

FprimeZephyrReference/Components/Drv/Rv3028Manager/Rv3028Manager.hpp

@@ -45,12 +45,12 @@ class Rv3028Manager final : public Rv3028ManagerComponentBase {
                              Fw::Time& time        //!< Reference to Time object
                              ) override;
 
-    //! Handler implementation for timeRead
+    //! Handler implementation for timeGet
     //!
-    //! timeRead port to get the time from the RTC
+    //! timeGet port to get the time from the RTC
     //! Requirement Rv3028Manager-002
-    U32 timeRead_handler(FwIndexType portNum  //!< The port number
-                         ) override;
+    U32 timeGet_handler(FwIndexType portNum  //!< The port number
+                        ) override;
 
     //! Handler implementation for timeSet
     //!

FprimeZephyrReference/Components/Drv/Rv3028Manager/docs/sdd.md

@@ -8,9 +8,9 @@ The RV3028 Manager component interfaces with the RV3028 Real Time Clock (RTC) to
 1. The component is instantiated and initialized during system startup
 2. In a deployment topology, a `time connection` is made to the component's `timeGetPort` port
 
-#### `timeRead` Port Usage
+#### `timeGet` Port Usage
 1. The component is instantiated and initialized during system startup
-2. A manager calls the `timeRead` ports
+2. A manager calls the `timeGet` ports
 3. On each call, the component:
     - Fetches and returns the time from the RV3028 RTC
     - Emits a `DeviceNotReady` event if the device is not ready
@@ -38,7 +38,7 @@ The RV3028 Manager component interfaces with the RV3028 Real Time Clock (RTC) to
 |---|---|
 | timeGetPort | Time port for FPrime topology connection to get the time from the RV3028 |
 | timeSet | Input port sets the time on the RV3028 |
-| timeRead | Input port reads the time from the RV3028 |
+| timeGet | Input port reads the time from the RV3028 |
 
 ## Events
 | Name | Description |
@@ -59,7 +59,7 @@ classDiagram
             + Rv3028Manager(char* compName)
             + ~Rv3028Manager()
             - void timeGetPort_handler(FwIndexType portNum, Fw::Time& time)
-            - U32 timeRead_handler(FwIndexType portNum)
+            - U32 timeGet_handler(FwIndexType portNum)
             - void timeSet_handler(FwIndexType portNum, const Drv::TimeData& time)
         }
     }
@@ -104,9 +104,9 @@ sequenceDiagram
     RV3028 Manager->>Deployment Time Connection: Return 0 time
 ```
 
-### `timeRead` port
+### `timeGet` port
 
-The `timeRead` port is called from a manager component to get the current time from the RTC.
+The `timeGet` port is called from a manager component to get the current time from the RTC.
 
 #### Success
 ```mermaid
@@ -116,7 +116,7 @@ sequenceDiagram
     participant RV3028 Manager
     participant Zephyr Time API
     participant RV3028 RTC
-    Manager-->>RV3028 Manager: Call timeRead synchronous input port
+    Manager-->>RV3028 Manager: Call timeGet synchronous input port
     RV3028 Manager->>Zephyr Time API: Read time
     Zephyr Time API->>RV3028 RTC: Read time
     RV3028 RTC->>Zephyr Time API: Return time
@@ -132,7 +132,7 @@ sequenceDiagram
     participant RV3028 Manager
     participant Zephyr Time API
     participant RV3028 RTC
-    Manager-->>RV3028 Manager: Call timeRead synchronous input port
+    Manager-->>RV3028 Manager: Call timeGet synchronous input port
     RV3028 Manager->>Zephyr Time API: Read time
     Zephyr Time API->>RV3028 RTC: Read time
     RV3028 RTC->>Zephyr Time API: Return device not ready

FprimeZephyrReference/Components/RtcManager/RtcManager.cpp

@@ -4,6 +4,7 @@
 // ======================================================================
 
 #include "FprimeZephyrReference/Components/RtcManager/RtcManager.hpp"
+#include <string>
 
 namespace Components {
 
@@ -25,16 +26,25 @@ void RtcManager ::SET_TIME_cmdHandler(FwOpcodeType opCode, U32 cmdSeq, Drv::Time
 }
 
 void RtcManager ::GET_TIME_cmdHandler(FwOpcodeType opCode, U32 cmdSeq) {
-    U32 t = this->timeRead_out(0);
+    U32 t = this->timeGet_out(0);
 
     // Convert POSIX time to tm struct for human readable logging
     time_t time_posix = static_cast<time_t>(t);
     struct tm time_tm_buf;
     struct tm* time_tm = gmtime_r(&time_posix, &time_tm_buf);
 
-    // Report time retrieved
-    this->log_ACTIVITY_HI_GetTime(time_tm->tm_year + 1900, time_tm->tm_mon + 1, time_tm->tm_mday + 1, time_tm->tm_hour,
-                                  time_tm->tm_min, time_tm->tm_sec);
+    // Convert to ISO format
+    char iso_time[32];
+    int result = snprintf(iso_time, sizeof(iso_time), "%04d-%02d-%02dT%02d:%02d:%02d", time_tm->tm_year + 1900,
+                          time_tm->tm_mon + 1, time_tm->tm_mday, time_tm->tm_hour, time_tm->tm_min, time_tm->tm_sec);
+
+    // Ensure snprintf succeeded and output was not truncated
+    FW_ASSERT(sizeof(iso_time) > static_cast<size_t>(result));
+
+    Fw::String iso_time_str(iso_time);
+
+    // Report time retrieved in ISO format
+    this->log_ACTIVITY_HI_GetTime(iso_time_str);
 
     this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
 }

FprimeZephyrReference/Components/RtcManager/RtcManager.fpp

@@ -13,14 +13,14 @@ module Components {
         #### Uncomment the following examples to start customizing your component ####
         ##############################################################################
 
-        @ Event to log the time retrieved from the Rv3028Manager
-        event GetTime(year: U32, month: U32, day: U32, hour:U32, minute:U32, second:U32) severity activity high id 1 format "Time: {}/{}/{} at {}:{}:{}"
+        @ Event to log the time retrieved from the Rv3028Manager in ISO 8601 format
+        event GetTime(t: string) severity activity high id 1 format "{}"
 
         @ Output port to set the time on the Rv3028Manager
         output port timeSet: Drv.TimeSet
 
         @ Output port to get the time from the Rv3028Manager
-        output port timeRead: Drv.TimeRead
+        output port timeGet: Drv.TimeGet
 
         ###############################################################################
         # Standard AC Ports: Required for Channels, Events, Commands, and Parameters  #

FprimeZephyrReference/Components/RtcManager/docs/sdd.md

@@ -14,7 +14,7 @@ The RtcManager component manages interactions with a Real Time Clock (RTC) devic
 1. The component is instantiated and initialized during system startup
 2. A ground station sends a `GET_TIME` command
 3. On each command, the component:
-    - Calls the `timeRead` port to get the current time from the RTC device
+    - Calls the `timeGet` port to get the current time from the RTC device
     - Emits a `GetTime` event with the retrieved time
 
 ## Requirements
@@ -28,7 +28,7 @@ The RtcManager component manages interactions with a Real Time Clock (RTC) devic
 | Name | Description |
 |---|---|
 | timeSet | Output port to reach out to driver to set the time |
-| TimeRead | Output port to reach out to driver to read the time |
+| TimeGet | Output port to reach out to driver to read the time |
 
 ## Commands
 | Name | Description |
@@ -80,7 +80,7 @@ sequenceDiagram
     participant RtcManager
     participant RV3028 Manager
     Ground Station-->>RtcManager: Send GET_TIME command
-    RtcManager->>RV3028 Manager: Call timeRead port
+    RtcManager->>RV3028 Manager: Call timeGet port
     RV3028 Manager->>RtcManager: Return time data
     RtcManager->>Event Log: Emit GetTime event with retrieved time
 ```

FprimeZephyrReference/ReferenceDeployment/Top/topology.fpp

@@ -101,7 +101,7 @@ module ReferenceDeployment {
 
     connections RtcManager {
       rtcManager.timeSet -> rv3028Manager.timeSet
-      rtcManager.timeRead -> rv3028Manager.timeRead
+      rtcManager.timeGet -> rv3028Manager.timeGet
     }
 
     connections ReferenceDeployment {

FprimeZephyrReference/test/int/rtc_test.py

@@ -0,0 +1,106 @@
+"""
+watchdog_test.py:
+
+Simple integration tests for the Watchdog component.
+Tests are ordered so that stop tests run last.
+"""
+
+import time
+import pytest
+from datetime import datetime, timezone
+import json
+
+@pytest.fixture(autouse=True)
+def set_now_time(fprime_test_api):
+    """Fixture to set the time to test runner's time before and after each test"""
+    set_time(fprime_test_api)
+    yield
+    set_time(fprime_test_api)
+
+def set_time(fprime_test_api, dt: datetime = None):
+    """Helper function to set the time to now or to a specified datetime"""
+    if dt is None:
+        dt = datetime.now(timezone.utc)
+
+    time_data = dict(
+        Year=dt.year,
+        Month=dt.month,
+        Day=dt.day,
+        Hour=dt.hour,
+        Minute=dt.minute,
+        Second=dt.second,
+    )
+    time_data_str = json.dumps(time_data)
+    fprime_test_api.send_and_assert_command(
+        "ReferenceDeployment.rtcManager.SET_TIME",
+        [
+            time_data_str,
+        ],
+        max_delay=2
+    )
+    fprime_test_api.assert_event(
+        "ReferenceDeployment.rv3028Manager.TimeSet",
+        timeout=2
+    )
+
+def get_time(fprime_test_api):
+    """Helper function to request packet and get fresh WatchdogTransitions telemetry"""
+    fprime_test_api.clear_histories()
+    fprime_test_api.send_and_assert_command("ReferenceDeployment.rtcManager.GET_TIME", max_delay=2)
+    result = fprime_test_api.assert_event(
+        "ReferenceDeployment.rtcManager.GetTime",
+        timeout=2
+    )
+
+    # EventData get_dict() https://github.com/nasa/fprime-gds/blob/67d0ec62f829ed23d72776f1d323f71eaafd31cc/src/fprime_gds/common/data_types/event_data.py#L130C9-L130C17
+    return result.get_dict()
+
+
+def test_01_current_time_set(fprime_test_api):
+    """Test that we can read WatchdogTransitions telemetry"""
+    event_data = get_time(fprime_test_api)
+    event_display_text_time = datetime.fromisoformat(event_data["display_text"])
+
+    # Assert time is within 30 seconds of now
+    pytest.approx(event_display_text_time, abs=30) == datetime.now(timezone.utc)
+
+
+def test_02_set_time_in_past(fprime_test_api):
+    """Test that we can set the time to a past time"""
+    curiosity_landing = datetime(2012, 8, 6, 5, 17, 57, tzinfo=timezone.utc)
+    set_time(fprime_test_api, curiosity_landing)
+
+    event_data = get_time(fprime_test_api)
+    event_display_text_time = datetime.fromisoformat(event_data["display_text"])
+
+    # Assert time is within 30 seconds of curiosity landing
+    pytest.approx(event_display_text_time, abs=30) == curiosity_landing
+
+
+def test_03_time_incrementing(fprime_test_api):
+    """Test that time increments over time"""
+    initial_event_data = get_time(fprime_test_api)
+    initial_time = datetime.fromisoformat(initial_event_data["display_text"])
+
+    time.sleep(2.0)  # Wait for time to increment
+
+    updated_event_data = get_time(fprime_test_api)
+    updated_time = datetime.fromisoformat(updated_event_data["display_text"])
+
+    assert updated_time > initial_time, \
+        f"Time should increase. Initial: {initial_time}, Updated: {updated_time}"
+
+
+def test_04_time_in_telemetry(fprime_test_api):
+    """Test that we can get Time telemetry"""
+    # result in ChData object https://github.com/nasa/fprime-gds/blob/67d0ec62f829ed23d72776f1d323f71eaafd31cc/src/fprime_gds/common/data_types/ch_data.py#L18
+    result = fprime_test_api.assert_telemetry(
+        "CdhCore.cmdDisp.CommandsDispatched",
+        timeout=3
+    )
+
+    # result.time is TimeType object https://github.com/nasa/fprime-tools/blob/aaa5840181146ca38b195c2a4d3f1bcbb35234c1/src/fprime/common/models/serialize/time_type.py#L49
+    tlm_time = datetime.fromtimestamp(result.time.seconds, tz=timezone.utc)
+
+    # Assert time is within 30 seconds of now
+    pytest.approx(tlm_time, abs=30) == datetime.now(timezone.utc)