tests can now be built as part of FSFW

This PR refactores the tests so they are built as part of the FSFW.
This is done by adding Catch2 with the FetchContent directive.

A future implementation might also use a system installation of Catch2
by first checking whether Catch2 can already be found as a package

The custom configuration folder testcfg was moved from the user folder
to the actual unittest folder.

The tests can be built by setting the CMake FSFW_BUILD_UNITTESTS option
to TRUE/ON. They are built with the static library and dropped inside
the build folders fsfw directory.

tests/src/fsfw_tests/CMakeLists.txt

@@ -3,6 +3,6 @@ if(FSFW_ADD_INTERNAL_TESTS)
     add_subdirectory(internal)
 endif()
 
-if(FSFW_ADD_UNITTESTS)
+if(FSFW_BUILD_UNITTESTS)
     add_subdirectory(unit)
 endif()

tests/src/fsfw_tests/internal/InternalUnitTester.cpp

@@ -1,9 +1,9 @@
 #include "fsfw_tests/internal/InternalUnitTester.h"
 #include "fsfw_tests/internal/UnittDefinitions.h"
 
-#include "fsfw_tests/internal/osal/IntTestMq.h"
-#include "fsfw_tests/internal/osal/IntTestSemaphore.h"
-#include "fsfw_tests/internal/osal/IntTestMutex.h"
+#include "fsfw_tests/internal/osal/testMq.h"
+#include "fsfw_tests/internal/osal/testSemaphore.h"
+#include "fsfw_tests/internal/osal/testMutex.h"
 #include "fsfw_tests/internal/serialize/IntTestSerialization.h"
 #include "fsfw_tests/internal/globalfunctions/TestArrayPrinter.h"
 

tests/src/fsfw_tests/internal/osal/CMakeLists.txt

@@ -1,5 +1,5 @@
 target_sources(${LIB_FSFW_NAME} PRIVATE
-	IntTestMq.cpp
-	IntTestMutex.cpp
-	IntTestSemaphore.cpp
+	testMq.cpp
+	testMutex.cpp
+	testSemaphore.cpp
 )

tests/src/fsfw_tests/internal/osal/testCmdExecutor.cpp

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

tests/src/fsfw_tests/internal/osal/testCmdExecutor.h

@@ -0,0 +1,10 @@
+#ifndef FSFW_TESTS_SRC_FSFW_TESTS_INTERNAL_OSAL_TESTCMDEXECUTOR_H_
+#define FSFW_TESTS_SRC_FSFW_TESTS_INTERNAL_OSAL_TESTCMDEXECUTOR_H_
+
+namespace testcmdexec {
+
+}
+
+
+
+#endif /* FSFW_TESTS_SRC_FSFW_TESTS_INTERNAL_OSAL_TESTCMDEXECUTOR_H_ */

tests/src/fsfw_tests/internal/osal/testMq.cpp

@@ -1,4 +1,4 @@
-#include "fsfw_tests/internal/osal/IntTestMq.h"
+#include "testMq.h"
 #include "fsfw_tests/internal/UnittDefinitions.h"
 
 #include <fsfw/ipc/MessageQueueIF.h>

tests/src/fsfw_tests/internal/osal/testMutex.cpp

@@ -1,4 +1,4 @@
-#include "fsfw_tests/internal/osal/IntTestMutex.h"
+#include "testMutex.h"
 #include "fsfw_tests/internal/UnittDefinitions.h"
 #include "fsfw/platform.h"
 

tests/src/fsfw_tests/internal/osal/testSemaphore.cpp

@@ -1,5 +1,5 @@
 #include "fsfw/FSFW.h"
-#include "fsfw_tests/internal/osal/IntTestSemaphore.h"
+#include "testSemaphore.h"
 #include "fsfw_tests/internal/UnittDefinitions.h"
 
 #include "fsfw/tasks/SemaphoreFactory.h"

tests/src/fsfw_tests/unit/CMakeLists.txt

@@ -1,16 +1,17 @@
-target_sources(${TARGET_NAME} PRIVATE
+target_sources(${FSFW_TEST_TGT} PRIVATE
     CatchDefinitions.cpp
     CatchFactory.cpp
     printChar.cpp
 )
 
-if(FSFW_CUSTOM_UNITTEST_RUNNER)
-    target_sources(${TARGET_NAME} PRIVATE
+# if(FSFW_CUSTOM_UNITTEST_RUNNER)
+    target_sources(${FSFW_TEST_TGT} PRIVATE
         CatchRunner.cpp
         CatchSetup.cpp
     )
-endif()
+# endif()
 
+add_subdirectory(testcfg)
 add_subdirectory(action)
 add_subdirectory(container)
 add_subdirectory(osal)

tests/src/fsfw_tests/unit/CatchFactory.h

@@ -1,7 +1,7 @@
 #ifndef FSFW_CATCHFACTORY_H_
 #define FSFW_CATCHFACTORY_H_
 
-#include "TestsConfig.h"
+#include "tests/TestsConfig.h"
 #include "fsfw/objectmanager/SystemObjectIF.h"
 #include "fsfw/objectmanager/ObjectManager.h"
 

tests/src/fsfw_tests/unit/CatchRunner.cpp

@@ -14,7 +14,7 @@
 
 extern int customSetup();
 
-int fsfwtest::customMain(int argc, char* argv[]) {
+int main(int argc, char* argv[]) {
     customSetup();
 
     // Catch internal function call

tests/src/fsfw_tests/unit/CatchRunner.h

@@ -7,7 +7,7 @@ namespace fsfwtest {
  * Can be called by upper level main() if default Catch2 main is overriden
  * @return
  */
-int customMain(int argc, char* argv[]);
+//int customMain(int argc, char* argv[]);
 
 }
 

tests/src/fsfw_tests/unit/action/CMakeLists.txt

@@ -1,3 +1,3 @@
-target_sources(${TARGET_NAME} PRIVATE
+target_sources(${FSFW_TEST_TGT} PRIVATE
 	TestActionHelper.cpp
 )

tests/src/fsfw_tests/unit/container/CMakeLists.txt

@@ -1,4 +1,4 @@
-target_sources(${TARGET_NAME} PRIVATE
+target_sources(${FSFW_TEST_TGT} PRIVATE
 	RingBufferTest.cpp
 	TestArrayList.cpp
 	TestDynamicFifo.cpp

tests/src/fsfw_tests/unit/datapoollocal/CMakeLists.txt

@@ -1,4 +1,4 @@
-target_sources(${TARGET_NAME} PRIVATE
+target_sources(${FSFW_TEST_TGT} PRIVATE
 	LocalPoolVariableTest.cpp
 	LocalPoolVectorTest.cpp
 	DataSetTest.cpp

tests/src/fsfw_tests/unit/globalfunctions/CMakeLists.txt

@@ -1,3 +1,3 @@
-target_sources(${TARGET_NAME} PRIVATE
+target_sources(${FSFW_TEST_TGT} PRIVATE
     testDleEncoder.cpp
 )

tests/src/fsfw_tests/unit/osal/CMakeLists.txt

@@ -1,4 +1,4 @@
-target_sources(${TARGET_NAME} PRIVATE
+target_sources(${FSFW_TEST_TGT} PRIVATE
 	TestMessageQueue.cpp
 	TestSemaphore.cpp
 )

tests/src/fsfw_tests/unit/serialize/CMakeLists.txt

@@ -1,4 +1,4 @@
-target_sources(${TARGET_NAME} PRIVATE
+target_sources(${FSFW_TEST_TGT} PRIVATE
 	TestSerialBufferAdapter.cpp
 	TestSerialization.cpp
 	TestSerialLinkedPacket.cpp

tests/src/fsfw_tests/unit/storagemanager/CMakeLists.txt

@@ -1,4 +1,4 @@
-target_sources(${TARGET_NAME} PRIVATE
+target_sources(${FSFW_TEST_TGT} PRIVATE
 	TestNewAccessor.cpp
 	TestPool.cpp
 )

tests/src/fsfw_tests/unit/testcfg/CMakeLists.txt

@@ -0,0 +1,28 @@
+target_sources(${FSFW_TEST_TGT} PRIVATE
+    ipc/MissionMessageTypes.cpp
+    pollingsequence/PollingSequenceFactory.cpp
+)
+
+# Add include paths for the executable
+target_include_directories(${FSFW_TEST_TGT} PUBLIC 
+    ${CMAKE_CURRENT_SOURCE_DIR}
+)
+
+# These translation files are actually not that relevant for the tests. However, the FSFW tests
+# compile against a user-configured variant of the FSFW, which might be configured to include
+# translation information. Therefore, empty dummy translation files are compiled here
+# so the tests compile in any case.
+
+# 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()

tests/src/fsfw_tests/unit/testcfg/FSFWConfig.h.in

@@ -7,33 +7,30 @@
 //! 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
+#define FSFW_CPP_OSTREAM_ENABLED 	    0
 
-//! More FSFW related printouts. Useful for development.
-#define FSFW_ENHANCED_PRINTOUT		0
+//! More FSFW related printouts depending on level. Useful for development.
+#define FSFW_VERBOSE_LEVEL			    1
 
 //! Can be used to completely disable printouts, even the C stdio ones.
-//! By default, printouts will be disabled for the unit tests.
-#if FSFW_CPP_OSTREAM_ENABLED == 0 && FSFW_ENHANCED_PRINTOUT == 0
-	#ifndef FSFW_DISABLE_PRINTOUT
-	#define FSFW_DISABLE_PRINTOUT 	1
-	#endif
+#if FSFW_CPP_OSTREAM_ENABLED == 0 && FSFW_VERBOSE_LEVEL == 0
+	#define FSFW_DISABLE_PRINTOUT 	    0
 #endif
 
-//! Can be used to enable additional debugging printouts for developing the FSFW
-#define FSFW_PRINT_VERBOSITY_LEVEL   0
+#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 		0
+#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
+#define FSFW_OBJ_EVENT_TRANSLATION	    0
 
 #if FSFW_OBJ_EVENT_TRANSLATION == 1
 //! Specify whether info events are printed too.
-#define FSFW_DEBUG_INFO				1
+#define FSFW_DEBUG_INFO				    1
 #include "objects/translateObjects.h"
 #include "events/translateEvents.h"
 #else
@@ -41,22 +38,22 @@
 
 //! 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
+#define FSFW_NO_C99_IO 	                1
 
 //! Specify whether a special mode store is used for Subsystem components.
-#define FSFW_USE_MODESTORE          0
+#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
+#define FSFW_USE_REALTIME_FOR_LINUX     1
 
 namespace fsfwconfig {
-//! Default timestamp size. The default timestamp will be an eight byte CDC
-//! short timestamp.
-static constexpr uint8_t FSFW_MISSION_TIMESTAMP_SIZE = 8;
+
+//! 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;
@@ -65,13 +62,13 @@ 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
-//! simulataneously. This will increase the required RAM for
+//! 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 = 1500;
+static constexpr size_t FSFW_MAX_TM_PACKET_SIZE = 2048;
 
 }
 

tests/src/fsfw_tests/unit/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_ */

tests/src/fsfw_tests/unit/testcfg/devices/logicalAddresses.h

@@ -2,7 +2,8 @@
 #define CONFIG_DEVICES_LOGICALADDRESSES_H_
 
 #include <fsfw/devicehandlers/CookieIF.h>
-#include <fsfw/unittest/config/objects/systemObjectList.h>
+#include "common/devices/commonAddresses.h"
+
 #include <cstdint>
 
 namespace addresses {

tests/src/fsfw_tests/unit/testcfg/events/subsystemIdRanges.h

@@ -1,8 +1,10 @@
 #ifndef CONFIG_EVENTS_SUBSYSTEMIDRANGES_H_
 #define CONFIG_EVENTS_SUBSYSTEMIDRANGES_H_
 
+#include "fsfw/events/fwSubsystemIdRanges.h"
+#include "common/events/commonSubsystemIds.h"
 #include <cstdint>
-#include <fsfw/events/fwSubsystemIdRanges.h>
+
 
 /**
  * @brief	Custom subsystem IDs can be added here
@@ -11,7 +13,8 @@
  */
 namespace SUBSYSTEM_ID {
 enum: uint8_t {
-	SUBSYSTEM_ID_START = FW_SUBSYSTEM_ID_RANGE,
+	SUBSYSTEM_ID_START =  COMMON_SUBSYSTEM_ID_RANGE,
+	SUBSYSTEM_ID_END // [EXPORT] : [END]
 };
 }
 

tests/src/fsfw_tests/unit/testcfg/events/translateEvents.cpp

@@ -0,0 +1,15 @@
+/**
+ * @brief    Auto-generated event translation file. Contains 81 translations.
+ * @details
+ * Generated on: 2021-05-18 16:28:16
+ */
+#include "translateEvents.h"
+
+
+const char * translateEvents(Event event) {
+	switch( (event & 0xffff) ) {
+	default:
+		return "UNKNOWN_EVENT";
+	}
+	return 0;
+}

tests/src/fsfw_tests/unit/testcfg/events/translateEvents.h

@@ -0,0 +1,8 @@
+#ifndef FSFWCONFIG_EVENTS_TRANSLATEEVENTS_H_
+#define FSFWCONFIG_EVENTS_TRANSLATEEVENTS_H_
+
+#include <fsfw/events/Event.h>
+
+const char * translateEvents(Event event);
+
+#endif /* FSFWCONFIG_EVENTS_TRANSLATEEVENTS_H_ */

tests/src/fsfw_tests/unit/testcfg/objects/systemObjectList.h

@@ -1,8 +1,9 @@
 #ifndef HOSTED_CONFIG_OBJECTS_SYSTEMOBJECTLIST_H_
 #define HOSTED_CONFIG_OBJECTS_SYSTEMOBJECTLIST_H_
 
+#include "fsfw/objectmanager/frameworkObjects.h"
+#include "common/objects/commonObjectsList.h"
 #include <cstdint>
-#include <fsfw/objectmanager/frameworkObjects.h>
 
 // The objects will be instantiated in the ID order
 namespace objects {
@@ -11,10 +12,6 @@ namespace objects {
 		FSFW_CONFIG_RESERVED_START = PUS_SERVICE_1_VERIFICATION,
 		FSFW_CONFIG_RESERVED_END = TM_STORE,
 
-		CCSDS_DISTRIBUTOR = 10,
-		PUS_DISTRIBUTOR = 11,
-		TM_FUNNEL = 12,
-
 		UDP_BRIDGE = 15,
 		UDP_POLLING_TASK = 16,
 

tests/src/fsfw_tests/unit/testcfg/objects/translateObjects.cpp

@@ -0,0 +1,19 @@
+/** 
+ * @brief	Auto-generated object translation file.
+ * @details
+ * Contains 69 translations.
+ * Generated on: 2021-05-18 16:37:37
+ */
+#include "translateObjects.h"
+
+const char *NO_OBJECT_STRING = "NO_OBJECT";
+
+const char* translateObject(object_id_t object) {
+	switch( (object & 0xFFFFFFFF) ) {
+	case 0xFFFFFFFF:
+		return NO_OBJECT_STRING;
+	default:
+		return "UNKNOWN_OBJECT";
+	}
+	return 0;
+}

tests/src/fsfw_tests/unit/testcfg/objects/translateObjects.h

@@ -0,0 +1,8 @@
+#ifndef FSFWCONFIG_OBJECTS_TRANSLATEOBJECTS_H_
+#define FSFWCONFIG_OBJECTS_TRANSLATEOBJECTS_H_
+
+#include <fsfw/objectmanager/SystemObjectIF.h>
+
+const char* translateObject(object_id_t object);
+
+#endif /* FSFWCONFIG_OBJECTS_TRANSLATEOBJECTS_H_ */

tests/src/fsfw_tests/unit/testcfg/pollingsequence/PollingSequenceFactory.cpp

@@ -1,6 +1,6 @@
 #include "PollingSequenceFactory.h"
 
-#include <TestsConfig.h>
+#include "tests/TestsConfig.h"
 
 #include <fsfw/serviceinterface/ServiceInterface.h>
 #include <fsfw/devicehandlers/DeviceHandlerIF.h>

tests/src/fsfw_tests/unit/testcfg/returnvalues/classIds.h

@@ -1,7 +1,8 @@
 #ifndef CONFIG_RETURNVALUES_CLASSIDS_H_
 #define CONFIG_RETURNVALUES_CLASSIDS_H_
 
-#include <fsfw/returnvalues/FwClassIds.h>
+#include "common/returnvalues/commonClassIds.h"
+#include "fsfw/returnvalues/FwClassIds.h"
 
 /**
  * @brief   CLASS_ID defintions which are required for custom returnvalues.

tests/src/fsfw_tests/unit/testcfg/tmtc/apid.h

@@ -12,6 +12,7 @@
  */
 namespace apid {
 	static const uint16_t DEFAULT_APID = 0x00;
+	static const uint16_t SOURCE_OBSW = 0x73;
 }
 
 

tests/src/fsfw_tests/unit/timemanager/CMakeLists.txt

@@ -1,3 +1,3 @@
-target_sources(${TARGET_NAME} PRIVATE
+target_sources(${FSFW_TEST_TGT} PRIVATE
 	TestCountdown.cpp
 )

tests/src/fsfw_tests/unit/tmtcpacket/CMakeLists.txt

@@ -1,3 +1,3 @@
-target_sources(${TARGET_NAME} PRIVATE
+target_sources(${FSFW_TEST_TGT} PRIVATE
 	PusTmTest.cpp
 )

tests/user/README.md

@@ -1,19 +0,0 @@
-## FSFW Testing
-
-This folder contains testing and unit testing components.
-
-### Instructions
-
-The easiest way to run the unittest contained in this folder is to follow
-the steps in the [test repository](https://egit.irs.uni-stuttgart.de/fsfw/fsfw_tests).
-This is recommended even if the goal is to set up a custom test repository to have
-a starting point.
-
-To set up a custom test repository or project, following steps can be performed:
-
-1. Copy the user folder content into the project root.
-2. Clone [Catch2](https://github.com/catchorg/Catch2) in the project root.
-3. Use the `CMakeLists.txt` as a starting point to add tests and build the test
-   executable.
-   
-

tests/user/testcfg/CMakeLists.txt

@@ -1,11 +0,0 @@
-target_sources(${TARGET_NAME} 
-	PRIVATE
-		ipc/MissionMessageTypes.cpp
-		pollingsequence/PollingSequenceFactory.cpp
-)
-
-# Add include paths for the executable
-target_include_directories(${TARGET_NAME} 
-	PUBLIC 
-		${CMAKE_CURRENT_SOURCE_DIR}
-)

tests/user/testcfg/OBSWConfig.h.in

@@ -1,8 +0,0 @@
-#ifndef TESTCFG_OBSWCONFIG_H_
-#define TESTCFG_OBSWCONFIG_H_
-
-
-
-
-
-#endif /* TESTCFG_OBSWCONFIG_H_ */