separate unittest folder

unittests/testcfg/CMakeLists.txt

@@ -0,0 +1,23 @@
+target_sources(${FSFW_TEST_TGT} PRIVATE
+    ipc/MissionMessageTypes.cpp
+    pollingsequence/PollingSequenceFactory.cpp
+)
+
+# Add include paths for the executable
+target_include_directories(${FSFW_TEST_TGT} PRIVATE
+    ${CMAKE_CURRENT_SOURCE_DIR}
+)
+
+# If a special translation file for object IDs exists, compile it.
+if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/objects/translateObjects.cpp")
+    target_sources(${FSFW_TEST_TGT} PRIVATE
+        objects/translateObjects.cpp
+    )
+endif()
+
+# If a special translation file for events exists, compile it.
+if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/objects/translateObjects.cpp")
+    target_sources(${FSFW_TEST_TGT} PRIVATE
+        events/translateEvents.cpp
+    )
+endif()

unittests/testcfg/FSFWConfig.h.in

@@ -0,0 +1,77 @@
+#ifndef CONFIG_FSFWCONFIG_H_
+#define CONFIG_FSFWCONFIG_H_
+
+#include <cstddef>
+#include <cstdint>
+
+//! Used to determine whether C++ ostreams are used which can increase
+//! the binary size significantly. If this is disabled,
+//! the C stdio functions can be used alternatively
+#define FSFW_CPP_OSTREAM_ENABLED        0
+
+//! More FSFW related printouts depending on level. Useful for development.
+#define FSFW_VERBOSE_LEVEL              0
+           
+//! Can be used to completely disable printouts, even the C stdio ones.
+#if FSFW_CPP_OSTREAM_ENABLED == 0 && FSFW_VERBOSE_LEVEL == 0
+    #define FSFW_DISABLE_PRINTOUT       1
+#else
+    #define FSFW_DISABLE_PRINTOUT       0
+#endif
+
+#define FSFW_USE_PUS_C_TELEMETRY        1
+#define FSFW_USE_PUS_C_TELECOMMANDS     1
+
+//! Can be used to disable the ANSI color sequences for C stdio.
+#define FSFW_COLORED_OUTPUT             1
+
+//! If FSFW_OBJ_EVENT_TRANSLATION is set to one,
+//! additional output which requires the translation files translateObjects
+//! and translateEvents (and their compiled source files)
+#define FSFW_OBJ_EVENT_TRANSLATION      0
+
+#if FSFW_OBJ_EVENT_TRANSLATION == 1
+//! Specify whether info events are printed too.
+#define FSFW_DEBUG_INFO                 1
+#include "objects/translateObjects.h"
+#include "events/translateEvents.h"
+#else
+#endif
+
+//! When using the newlib nano library, C99 support for stdio facilities
+//! will not be provided. This define should be set to 1 if this is the case.
+#define FSFW_NO_C99_IO                  1
+
+//! Specify whether a special mode store is used for Subsystem components.
+#define FSFW_USE_MODESTORE              0
+
+//! Defines if the real time scheduler for linux should be used.
+//! If set to 0, this will also disable priority settings for linux
+//! as most systems will not allow to set nice values without privileges
+//! For embedded linux system set this to 1.
+//! If set to 1 the binary needs "cap_sys_nice=eip" privileges to run
+#define FSFW_USE_REALTIME_FOR_LINUX     1
+
+namespace fsfwconfig {
+
+//! Default timestamp size. The default timestamp will be an seven byte CDC short timestamp.
+static constexpr uint8_t FSFW_MISSION_TIMESTAMP_SIZE = 7;
+
+//! Configure the allocated pool sizes for the event manager.
+static constexpr size_t FSFW_EVENTMGMR_MATCHTREE_NODES = 240;
+static constexpr size_t FSFW_EVENTMGMT_EVENTIDMATCHERS = 120;
+static constexpr size_t FSFW_EVENTMGMR_RANGEMATCHERS   = 120;
+
+//! Defines the FIFO depth of each commanding service base which
+//! also determines how many commands a CSB service can handle in one cycle
+//! simultaneously. This will increase the required RAM for
+//! each CSB service !
+static constexpr uint8_t FSFW_CSB_FIFO_DEPTH = 6;
+
+static constexpr size_t FSFW_PRINT_BUFFER_SIZE = 124;
+
+static constexpr size_t FSFW_MAX_TM_PACKET_SIZE = 2048;
+
+}
+
+#endif /* CONFIG_FSFWCONFIG_H_ */

unittests/testcfg/OBSWConfig.h.in

@@ -0,0 +1,15 @@
+#ifndef CONFIG_TMTC_TMTCSIZE_H_
+#define CONFIG_TMTC_TMTCSIZE_H_
+
+#include <cstdint>
+#include <cstddef>
+
+#define OBSW_PRINT_MISSED_DEADLINES             0
+#define OBSW_VERBOSE_LEVEL                      0
+#define OBSW_ADD_TEST_CODE                      1
+
+namespace config {
+static constexpr uint32_t MAX_STORED_TELECOMMANDS = 2000;
+}
+
+#endif /* CONFIG_TMTC_TMTCSIZE_H_ */

unittests/testcfg/TestsConfig.h.in

@@ -0,0 +1,23 @@
+#ifndef FSFW_UNITTEST_CONFIG_TESTSCONFIG_H_
+#define FSFW_UNITTEST_CONFIG_TESTSCONFIG_H_
+
+#cmakedefine01 FSFW_CICD_BUILD
+
+#define FSFW_ADD_DEFAULT_FACTORY_FUNCTIONS 1
+
+#ifdef __cplusplus
+
+#include "objects/systemObjectList.h"
+#include "events/subsystemIdRanges.h"
+#include "returnvalues/classIds.h"
+
+namespace config {
+#endif
+
+/* Add mission configuration flags here */
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* FSFW_UNITTEST_CONFIG_TESTSCONFIG_H_ */

unittests/testcfg/devices/logicalAddresses.cpp

@@ -0,0 +1 @@
+#include "logicalAddresses.h"

unittests/testcfg/devices/logicalAddresses.h

@@ -0,0 +1,13 @@
+#ifndef CONFIG_DEVICES_LOGICALADDRESSES_H_
+#define CONFIG_DEVICES_LOGICALADDRESSES_H_
+
+#include <fsfw/devicehandlers/CookieIF.h>
+
+#include <cstdint>
+
+namespace addresses {
+/* Logical addresses have uint32_t datatype */
+enum logicalAddresses : address_t {};
+}  // namespace addresses
+
+#endif /* CONFIG_DEVICES_LOGICALADDRESSES_H_ */

unittests/testcfg/devices/powerSwitcherList.cpp

@@ -0,0 +1 @@
+#include "powerSwitcherList.h"

unittests/testcfg/devices/powerSwitcherList.h

@@ -0,0 +1,10 @@
+#ifndef CONFIG_DEVICES_POWERSWITCHERLIST_H_
+#define CONFIG_DEVICES_POWERSWITCHERLIST_H_
+
+namespace switches {
+/* Switches are uint8_t datatype and go from 0 to 255 */
+enum switcherList {};
+
+}  // namespace switches
+
+#endif /* CONFIG_DEVICES_POWERSWITCHERLIST_H_ */

unittests/testcfg/events/subsystemIdRanges.h

@@ -0,0 +1,20 @@
+#ifndef CONFIG_EVENTS_SUBSYSTEMIDRANGES_H_
+#define CONFIG_EVENTS_SUBSYSTEMIDRANGES_H_
+
+#include <cstdint>
+
+#include "fsfw/events/fwSubsystemIdRanges.h"
+
+/**
+ * @brief	Custom subsystem IDs can be added here
+ * @details
+ * Subsystem IDs are used to create unique events.
+ */
+namespace SUBSYSTEM_ID {
+enum : uint8_t {
+  SUBSYSTEM_ID_START = FW_SUBSYSTEM_ID_RANGE,
+  SUBSYSTEM_ID_END  // [EXPORT] : [END]
+};
+}
+
+#endif /* CONFIG_EVENTS_SUBSYSTEMIDRANGES_H_ */

unittests/testcfg/ipc/MissionMessageTypes.cpp

@@ -0,0 +1,10 @@
+#include "MissionMessageTypes.h"
+
+#include <fsfw/ipc/CommandMessage.h>
+
+void messagetypes::clearMissionMessage(CommandMessage* message) {
+  switch (message->getMessageType()) {
+    default:
+      break;
+  }
+}

unittests/testcfg/ipc/MissionMessageTypes.h

@@ -0,0 +1,22 @@
+#ifndef CONFIG_IPC_MISSIONMESSAGETYPES_H_
+#define CONFIG_IPC_MISSIONMESSAGETYPES_H_
+
+#include <fsfw/ipc/FwMessageTypes.h>
+
+class CommandMessage;
+
+/**
+ * Custom command messages are specified here.
+ * Most messages needed to use FSFW are already located in
+ * <fsfw/ipc/FwMessageTypes.h>
+ * @param message Generic Command Message
+ */
+namespace messagetypes {
+enum MESSAGE_TYPE {
+  MISSION_MESSAGE_TYPE_START = FW_MESSAGES_COUNT,
+};
+
+void clearMissionMessage(CommandMessage* message);
+}  // namespace messagetypes
+
+#endif /* CONFIG_IPC_MISSIONMESSAGETYPES_H_ */

unittests/testcfg/objects/systemObjectList.h

@@ -0,0 +1,34 @@
+#ifndef HOSTED_CONFIG_OBJECTS_SYSTEMOBJECTLIST_H_
+#define HOSTED_CONFIG_OBJECTS_SYSTEMOBJECTLIST_H_
+
+#include <cstdint>
+
+#include "fsfw/objectmanager/frameworkObjects.h"
+
+// The objects will be instantiated in the ID order
+namespace objects {
+enum sourceObjects : uint32_t {
+  /* All addresses between start and end are reserved for the FSFW */
+  FSFW_CONFIG_RESERVED_START = PUS_SERVICE_1_VERIFICATION,
+  FSFW_CONFIG_RESERVED_END = TM_STORE,
+
+  UDP_BRIDGE = 15,
+  UDP_POLLING_TASK = 16,
+
+  TEST_ECHO_COM_IF = 20,
+  TEST_DEVICE = 21,
+
+  HK_RECEIVER_MOCK = 22,
+  TEST_LOCAL_POOL_OWNER_BASE = 25,
+
+  SHARED_SET_ID = 26,
+
+  DUMMY_POWER_SWITCHER = 28,
+
+  DEVICE_HANDLER_MOCK = 29,
+  COM_IF_MOCK = 30,
+  DEVICE_HANDLER_COMMANDER = 40,
+};
+}
+
+#endif /* BSP_CONFIG_OBJECTS_SYSTEMOBJECTLIST_H_ */

unittests/testcfg/pollingsequence/PollingSequenceFactory.cpp

@@ -0,0 +1,30 @@
+#include "PollingSequenceFactory.h"
+
+#include <fsfw/devicehandlers/DeviceHandlerIF.h>
+#include <fsfw/serviceinterface/ServiceInterface.h>
+#include <fsfw/tasks/FixedTimeslotTaskIF.h>
+
+#include "tests/TestsConfig.h"
+
+ReturnValue_t pst::pollingSequenceInitDefault(FixedTimeslotTaskIF *thisSequence) {
+  /* Length of a communication cycle */
+  uint32_t length = thisSequence->getPeriodMs();
+
+  /* Add polling sequence table here */
+  thisSequence->addSlot(objects::TEST_DEVICE, 0, DeviceHandlerIF::PERFORM_OPERATION);
+  thisSequence->addSlot(objects::TEST_DEVICE, 0.3, DeviceHandlerIF::SEND_WRITE);
+  thisSequence->addSlot(objects::TEST_DEVICE, 0.45 * length, DeviceHandlerIF::GET_WRITE);
+  thisSequence->addSlot(objects::TEST_DEVICE, 0.6 * length, DeviceHandlerIF::SEND_READ);
+  thisSequence->addSlot(objects::TEST_DEVICE, 0.8 * length, DeviceHandlerIF::GET_READ);
+
+  if (thisSequence->checkSequence() == HasReturnvaluesIF::RETURN_OK) {
+    return HasReturnvaluesIF::RETURN_OK;
+  } else {
+#if FSFW_CPP_OSTREAM_ENABLED
+    sif::error << "pst::pollingSequenceInitDefault: Sequence invalid!" << std::endl;
+#else
+    sif::printError("pst::pollingSequenceInitDefault: Sequence invalid!");
+#endif
+    return HasReturnvaluesIF::RETURN_FAILED;
+  }
+}

unittests/testcfg/pollingsequence/PollingSequenceFactory.h

@@ -0,0 +1,32 @@
+#ifndef POLLINGSEQUENCEFACTORY_H_
+#define POLLINGSEQUENCEFACTORY_H_
+
+#include <fsfw/returnvalues/HasReturnvaluesIF.h>
+
+class FixedTimeslotTaskIF;
+
+/**
+ * All device handlers are scheduled by adding them into  Polling Sequence Tables (PST)
+ * to satisfy stricter timing requirements of device communication,
+ * A device handler has four different communication steps:
+ *   1. DeviceHandlerIF::SEND_WRITE -> Send write via interface
+ *   2. DeviceHandlerIF::GET_WRITE -> Get confirmation for write
+ *   3. DeviceHandlerIF::SEND_READ -> Send read request
+ *   4. DeviceHandlerIF::GET_READ -> Read from interface
+ * The PST specifies precisely when the respective ComIF functions are called
+ * during the communication cycle time.
+ * The task is created using the FixedTimeslotTaskIF,
+ * which utilises the underlying Operating System Abstraction Layer (OSAL)
+ *
+ * @param thisSequence FixedTimeslotTaskIF * object is passed inside the Factory class when creating
+ * the PST
+ * @return
+ */
+namespace pst {
+
+/* Default PST */
+ReturnValue_t pollingSequenceInitDefault(FixedTimeslotTaskIF *thisSequence);
+
+}  // namespace pst
+
+#endif /* POLLINGSEQUENCEINIT_H_ */

unittests/testcfg/returnvalues/classIds.h

@@ -0,0 +1,15 @@
+#ifndef CONFIG_RETURNVALUES_CLASSIDS_H_
+#define CONFIG_RETURNVALUES_CLASSIDS_H_
+
+#include "fsfw/returnvalues/FwClassIds.h"
+
+/**
+ * @brief   CLASS_ID defintions which are required for custom returnvalues.
+ */
+namespace CLASS_ID {
+enum {
+  MISSION_CLASS_ID_START = FW_CLASS_ID_COUNT,
+};
+}
+
+#endif /* CONFIG_RETURNVALUES_CLASSIDS_H_ */

unittests/testcfg/tmtc/apid.h

@@ -0,0 +1,17 @@
+#ifndef CONFIG_TMTC_APID_H_
+#define CONFIG_TMTC_APID_H_
+
+#include <cstdint>
+
+/**
+ * Application Process Definition: entity, uniquely identified by an
+ * application process ID (APID), capable of generating telemetry source
+ * packets and receiving telecommand packets.
+ *
+ * Chose APID(s) for mission and define it here.
+ */
+namespace apid {
+static const uint16_t DEFAULT_APID = 0x00;
+}
+
+#endif /* CONFIG_TMTC_APID_H_ */

unittests/testcfg/tmtc/pusIds.h

@@ -0,0 +1,25 @@
+#ifndef CONFIG_TMTC_PUSIDS_HPP_
+#define CONFIG_TMTC_PUSIDS_HPP_
+
+#include <cstdint>
+
+namespace pus {
+enum Ids : uint8_t {
+  PUS_SERVICE_1 = 1,
+  PUS_SERVICE_2 = 2,
+  PUS_SERVICE_3 = 3,
+  PUS_SERVICE_5 = 5,
+  PUS_SERVICE_6 = 6,
+  PUS_SERVICE_8 = 8,
+  PUS_SERVICE_9 = 9,
+  PUS_SERVICE_11 = 11,
+  PUS_SERVICE_17 = 17,
+  PUS_SERVICE_19 = 19,
+  PUS_SERVICE_20 = 20,
+  PUS_SERVICE_23 = 23,
+  PUS_SERVICE_200 = 200,
+  PUS_SERVICE_201 = 201,
+};
+};
+
+#endif /* CONFIG_TMTC_PUSIDS_HPP_ */