Make FSFW tests accessible from outside

1. Further reduces the amount of code the user needs to copy and paste
2. Makes FSFW tests more accessible. This can be used to simplify moving mission unit tests
   to the FSFW
3. A lot of include improvements

tests/src/fsfw_tests/unit/CMakeLists.txt

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

tests/src/fsfw_tests/unit/CatchDefinitions.cpp

@@ -0,0 +1,16 @@
+#include "CatchDefinitions.h"
+#include <fsfw/serviceinterface/ServiceInterface.h>
+#include <fsfw/objectmanager/ObjectManager.h>
+
+StorageManagerIF* tglob::getIpcStoreHandle() {
+	if(ObjectManager::instance() != nullptr) {
+		return ObjectManager::instance()->get<StorageManagerIF>(objects::IPC_STORE);
+	} else {
+#if FSFW_CPP_OSTREAM_ENABLED == 1
+		sif::error << "Global object manager uninitialized" << std::endl;
+#else
+		sif::printError("Global object manager uninitialized\n\r");
+#endif /* FSFW_CPP_OSTREAM_ENABLED == 1 */
+		return nullptr;
+	}
+}

tests/src/fsfw_tests/unit/CatchDefinitions.h

@@ -0,0 +1,21 @@
+#ifndef FSFW_UNITTEST_CORE_CATCHDEFINITIONS_H_
+#define FSFW_UNITTEST_CORE_CATCHDEFINITIONS_H_
+
+#include <fsfw/ipc/messageQueueDefinitions.h>
+#include <fsfw/returnvalues/HasReturnvaluesIF.h>
+#include <fsfw/storagemanager/StorageManagerIF.h>
+
+namespace retval {
+static constexpr int CATCH_OK = static_cast<int>(HasReturnvaluesIF::RETURN_OK);
+static constexpr int CATCH_FAILED = static_cast<int>(HasReturnvaluesIF::RETURN_FAILED);
+}
+
+namespace tconst {
+	static constexpr MessageQueueId_t testQueueId = 42;
+}
+
+namespace tglob {
+	StorageManagerIF* getIpcStoreHandle();
+}
+
+#endif /* FSFW_UNITTEST_CORE_CATCHDEFINITIONS_H_ */

tests/src/fsfw_tests/unit/CatchFactory.cpp

@@ -0,0 +1,83 @@
+#include "CatchFactory.h"
+#include "datapoollocal/LocalPoolOwnerBase.h"
+#include "mocks/HkReceiverMock.h"
+
+#include <fsfw/datapoollocal/LocalDataPoolManager.h>
+#include <fsfw/devicehandlers/DeviceHandlerBase.h>
+
+#include <fsfw/events/EventManager.h>
+#include <fsfw/health/HealthTable.h>
+#include <fsfw/internalerror/InternalErrorReporter.h>
+#include <fsfw/objectmanager/frameworkObjects.h>
+#include <fsfw/storagemanager/PoolManager.h>
+#include <fsfw/tmtcpacket/pus/tm/TmPacketStored.h>
+#include <fsfw/tmtcservices/CommandingServiceBase.h>
+#include <fsfw/tmtcservices/PusServiceBase.h>
+
+
+#if FSFW_ADD_DEFAULT_FACTORY_FUNCTIONS == 1
+
+/**
+ * @brief Produces system objects.
+ * @details
+ * Build tasks by using SystemObject Interface (Interface).
+ * Header files of all tasks must be included
+ * Please note that an object has to implement the system object interface
+ * if the interface validity is checked or retrieved later by using the
+ * get<TargetInterface>(object_id) function from the ObjectManagerIF.
+ *
+ * Framework objects are created first.
+ *
+ * @ingroup init
+ */
+void Factory::produceFrameworkObjects(void* args) {
+	setStaticFrameworkObjectIds();
+	new EventManager(objects::EVENT_MANAGER);
+	new HealthTable(objects::HEALTH_TABLE);
+	new InternalErrorReporter(objects::INTERNAL_ERROR_REPORTER);
+
+	new LocalPoolOwnerBase (objects::TEST_LOCAL_POOL_OWNER_BASE);
+	new HkReceiverMock(objects::HK_RECEIVER_MOCK);
+
+	{
+		PoolManager::LocalPoolConfig poolCfg = {
+		        {100, 16}, {50, 32}, {25, 64} , {15, 128}, {5, 1024}
+		};
+		new PoolManager(objects::TC_STORE, poolCfg);
+	}
+
+	{
+        PoolManager::LocalPoolConfig poolCfg = {
+                {100, 16}, {50, 32}, {25, 64} , {15, 128}, {5, 1024}
+        };
+		new PoolManager(objects::TM_STORE, poolCfg);
+	}
+
+	{
+        PoolManager::LocalPoolConfig poolCfg = {
+                {100, 16}, {50, 32}, {25, 64} , {15, 128}, {5, 1024}
+        };
+		new PoolManager(objects::IPC_STORE, poolCfg);
+	}
+}
+
+void Factory::setStaticFrameworkObjectIds() {
+	PusServiceBase::packetSource = objects::NO_OBJECT;
+	PusServiceBase::packetDestination = objects::NO_OBJECT;
+
+	CommandingServiceBase::defaultPacketSource = objects::NO_OBJECT;
+	CommandingServiceBase::defaultPacketDestination = objects::NO_OBJECT;
+
+	VerificationReporter::messageReceiver = objects::PUS_SERVICE_1_VERIFICATION;
+
+	DeviceHandlerBase::powerSwitcherId = objects::NO_OBJECT;
+	DeviceHandlerBase::rawDataReceiverId = objects::PUS_SERVICE_2_DEVICE_ACCESS;
+
+	LocalDataPoolManager::defaultHkDestination = objects::HK_RECEIVER_MOCK;
+
+	DeviceHandlerFailureIsolation::powerConfirmationId = objects::NO_OBJECT;
+
+	TmPacketBase::timeStamperId = objects::NO_OBJECT;
+}
+
+#endif

tests/src/fsfw_tests/unit/CatchFactory.h

@@ -0,0 +1,24 @@
+#ifndef FSFW_CATCHFACTORY_H_
+#define FSFW_CATCHFACTORY_H_
+
+#include "TestConfig.h"
+#include "fsfw/objectmanager/SystemObjectIF.h"
+#include "fsfw/objectmanager/ObjectManager.h"
+
+// TODO: It is possible to solve this more cleanly using a special class which
+// is allowed to set the object IDs and has virtual functions.
+#if FSFW_ADD_DEFAULT_FACTORY_FUNCTIONS == 1
+
+namespace Factory {
+	/**
+	 * @brief 	Creates all SystemObject elements which are persistent
+	 * 			during execution.
+	 */
+	void produceFrameworkObjects(void* args);
+	void setStaticFrameworkObjectIds();
+
+}
+
+#endif /* FSFW_ADD_DEFAULT_FSFW_FACTORY == 1 */
+
+#endif /* FSFW_CATCHFACTORY_H_ */

tests/src/fsfw_tests/unit/CatchRunner.cpp

@@ -0,0 +1,26 @@
+/**
+ * @file 	CatchRunner.cpp
+ * @brief 	Source file to compile catch framework.
+ * @details	All tests should be written in other files.
+ * For eclipse console output, install ANSI Escape in Console
+ * from the eclipse market place to get colored characters.
+ */
+
+#include "CatchRunner.h"
+
+#define CATCH_CONFIG_COLOUR_WINDOWS
+
+#include <catch2/catch_session.hpp>
+
+extern int customSetup();
+
+int fsfwtest::customMain(int argc, char* argv[]) {
+    customSetup();
+
+    // Catch internal function call
+    int result = Catch::Session().run(argc, argv);
+
+    // global clean-up
+    return result;
+}
+

tests/src/fsfw_tests/unit/CatchRunner.h

@@ -0,0 +1,14 @@
+#ifndef FSFW_TESTS_USER_UNITTEST_CORE_CATCHRUNNER_H_
+#define FSFW_TESTS_USER_UNITTEST_CORE_CATCHRUNNER_H_
+
+namespace fsfwtest {
+
+/**
+ * Can be called by upper level main() if default Catch2 main is overriden
+ * @return
+ */
+int customMain(int argc, char* argv[]);
+
+}
+
+#endif /* FSFW_TESTS_USER_UNITTEST_CORE_CATCHRUNNER_H_ */

tests/src/fsfw_tests/unit/CatchSetup.cpp

@@ -0,0 +1,33 @@
+#include "CatchFactory.h"
+#include "CatchDefinitions.h"
+
+#ifdef GCOV
+#include <gcov.h>
+#endif
+
+#include "fsfw/objectmanager/ObjectManager.h"
+#include "fsfw/storagemanager/StorageManagerIF.h"
+#include "fsfw/serviceinterface/ServiceInterface.h"
+
+
+/* Global instantiations normally done in main.cpp */
+/* Initialize Data Pool */
+
+#if FSFW_CPP_OSTREAM_ENABLED == 1
+namespace sif {
+/* Set up output streams */
+ServiceInterfaceStream debug("DEBUG");
+ServiceInterfaceStream info("INFO");
+ServiceInterfaceStream error("ERROR");
+ServiceInterfaceStream warning("WARNING");
+}
+#endif
+
+int customSetup() {
+    // global setup
+    ObjectManager* objMan = ObjectManager::instance();
+    objMan->setObjectFactoryFunction(Factory::produceFrameworkObjects, nullptr);
+    objMan->initialize();
+    return 0;
+}
+

tests/src/fsfw_tests/unit/action/TestActionHelper.cpp

@@ -1,13 +1,10 @@
 #include "TestActionHelper.h"
-
-#include <unittest/core/CatchDefinitions.h>
+#include "fsfw_tests/unit/mocks/MessageQueueMockBase.h"
 
 #include <fsfw/action/ActionHelper.h>
 #include <fsfw/ipc/CommandMessage.h>
-#include <fsfw/tests/unit/mocks/MessageQueueMockBase.h>
 
 #include <catch2/catch_test_macros.hpp>
-
 #include <array>
 
 

tests/src/fsfw_tests/unit/action/TestActionHelper.h

@@ -1,12 +1,11 @@
 #ifndef UNITTEST_HOSTED_TESTACTIONHELPER_H_
 #define UNITTEST_HOSTED_TESTACTIONHELPER_H_
 
+#include "fsfw_tests/unit/CatchDefinitions.h"
 #include <fsfw/action/HasActionsIF.h>
 #include <fsfw/ipc/MessageQueueIF.h>
-#include <unittest/core/CatchDefinitions.h>
 #include <cstring>
 
-
 class ActionHelperOwnerMockBase: public HasActionsIF {
 public:
 	bool getCommandQueueCalled = false;

tests/src/fsfw_tests/unit/container/RingBufferTest.cpp

@@ -1,4 +1,4 @@
-#include <unittest/core/CatchDefinitions.h>
+#include "fsfw_tests/unit/CatchDefinitions.h"
 #include <fsfw/container/SimpleRingBuffer.h>
 
 #include <catch2/catch_test_macros.hpp>

tests/src/fsfw_tests/unit/container/TestArrayList.cpp

@@ -1,8 +1,9 @@
+#include "fsfw_tests/unit/CatchDefinitions.h"
+
 #include <fsfw/container/ArrayList.h>
 #include <fsfw/returnvalues/HasReturnvaluesIF.h>
 
 #include <catch2/catch_test_macros.hpp>
-#include <unittest/core/CatchDefinitions.h>
 
 /**
  * @brief 	Array List test

tests/src/fsfw_tests/unit/container/TestDynamicFifo.cpp

@@ -1,9 +1,10 @@
+#include "fsfw_tests/unit/CatchDefinitions.h"
+
 #include <fsfw/container/DynamicFIFO.h>
 #include <fsfw/container/FIFO.h>
 #include <fsfw/returnvalues/HasReturnvaluesIF.h>
 
 #include <catch2/catch_test_macros.hpp>
-#include <unittest/core/CatchDefinitions.h>
 
 TEST_CASE( "Dynamic Fifo Tests", "[TestDynamicFifo]") {
 	INFO("Dynamic Fifo Tests");

tests/src/fsfw_tests/unit/container/TestFifo.cpp

@@ -1,9 +1,10 @@
+#include "fsfw_tests/unit/CatchDefinitions.h"
+
 #include <fsfw/container/DynamicFIFO.h>
 #include <fsfw/container/FIFO.h>
 #include <fsfw/returnvalues/HasReturnvaluesIF.h>
 
 #include <catch2/catch_test_macros.hpp>
-#include <unittest/core/CatchDefinitions.h>
 
 TEST_CASE( "Static Fifo Tests", "[TestFifo]") {
 	INFO("Fifo Tests");

tests/src/fsfw_tests/unit/container/TestFixedArrayList.cpp

@@ -1,8 +1,9 @@
+#include "fsfw_tests/unit/CatchDefinitions.h"
+
 #include <fsfw/container/FixedArrayList.h>
 #include <fsfw/returnvalues/HasReturnvaluesIF.h>
 
 #include <catch2/catch_test_macros.hpp>
-#include <unittest/core/CatchDefinitions.h>
 
 
 TEST_CASE( "FixedArrayList Tests", "[TestFixedArrayList]") {

tests/src/fsfw_tests/unit/container/TestFixedMap.cpp

@@ -1,8 +1,9 @@
+#include "fsfw_tests/unit/CatchDefinitions.h"
+
 #include <fsfw/container/FixedMap.h>
 #include <fsfw/returnvalues/HasReturnvaluesIF.h>
 
 #include <catch2/catch_test_macros.hpp>
-#include <unittest/core/CatchDefinitions.h>
 
 template class FixedMap<unsigned int, unsigned short>;
 

tests/src/fsfw_tests/unit/container/TestFixedOrderedMultimap.cpp

@@ -1,8 +1,9 @@
+#include "fsfw_tests/unit/CatchDefinitions.h"
+
 #include <fsfw/container/FixedOrderedMultimap.h>
 #include <fsfw/returnvalues/HasReturnvaluesIF.h>
 
 #include <catch2/catch_test_macros.hpp>
-#include <unittest/core/CatchDefinitions.h>
 
 TEST_CASE( "FixedOrderedMultimap Tests", "[TestFixedOrderedMultimap]") {
 	INFO("FixedOrderedMultimap Tests");

tests/src/fsfw_tests/unit/container/TestPlacementFactory.cpp

@@ -1,10 +1,11 @@
+#include "fsfw_tests/unit/CatchDefinitions.h"
+
 #include <fsfw/container/PlacementFactory.h>
 #include <fsfw/storagemanager/LocalPool.h>
 #include <fsfw/returnvalues/HasReturnvaluesIF.h>
 #include <fsfw/container/ArrayList.h>
 
 #include <catch2/catch_test_macros.hpp>
-#include <unittest/core/CatchDefinitions.h>
 
 TEST_CASE( "PlacementFactory Tests", "[TestPlacementFactory]") {
 	INFO("PlacementFactory Tests");

tests/src/fsfw_tests/unit/datapoollocal/DataSetTest.cpp

@@ -1,7 +1,5 @@
 #include "LocalPoolOwnerBase.h"
-
-#include <catch2/catch_test_macros.hpp>
-#include <catch2/catch_approx.hpp>
+#include "fsfw_tests/unit/CatchDefinitions.h"
 
 #include <fsfw/objectmanager/ObjectManager.h>
 #include <fsfw/datapoollocal/HasLocalDataPoolIF.h>
@@ -10,7 +8,8 @@
 #include <fsfw/datapool/PoolReadGuard.h>
 #include <fsfw/globalfunctions/bitutility.h>
 
-#include <unittest/core/CatchDefinitions.h>
+#include <catch2/catch_test_macros.hpp>
+#include <catch2/catch_approx.hpp>
 
 TEST_CASE("DataSetTest" , "[DataSetTest]") {
     LocalPoolOwnerBase* poolOwner = ObjectManager::instance()->

tests/src/fsfw_tests/unit/datapoollocal/LocalPoolManagerTest.cpp

@@ -1,7 +1,5 @@
 #include "LocalPoolOwnerBase.h"
-
-#include <catch2/catch_test_macros.hpp>
-#include <catch2/catch_approx.hpp>
+#include "fsfw_tests/unit/CatchDefinitions.h"
 
 #include <fsfw/objectmanager/ObjectManager.h>
 #include <fsfw/datapool/PoolReadGuard.h>
@@ -10,7 +8,10 @@
 #include <fsfw/housekeeping/HousekeepingSnapshot.h>
 #include <fsfw/ipc/CommandMessageCleaner.h>
 #include <fsfw/timemanager/CCSDSTime.h>
-#include <unittest/core/CatchDefinitions.h>
+
+#include <catch2/catch_test_macros.hpp>
+#include <catch2/catch_approx.hpp>
+
 #include <iostream>
 
 

tests/src/fsfw_tests/unit/datapoollocal/LocalPoolOwnerBase.h

@@ -2,6 +2,7 @@
 #define FSFW_UNITTEST_TESTS_DATAPOOLLOCAL_LOCALPOOLOWNERBASE_H_
 
 #include "objects/systemObjectList.h"
+#include "../mocks/MessageQueueMockBase.h"
 
 #include <fsfw/datapoollocal/HasLocalDataPoolIF.h>
 #include <fsfw/datapoollocal/LocalDataSet.h>
@@ -10,7 +11,6 @@
 #include <fsfw/datapoollocal/LocalPoolVector.h>
 #include <fsfw/ipc/QueueFactory.h>
 #include <fsfw/datapoollocal/StaticLocalDataSet.h>
-#include <fsfw/tests/unit/mocks/MessageQueueMockBase.h>
 #include <fsfw/datapool/PoolReadGuard.h>
 
 namespace lpool {

tests/src/fsfw_tests/unit/datapoollocal/LocalPoolVariableTest.cpp

@@ -1,10 +1,10 @@
 #include "LocalPoolOwnerBase.h"
+#include "fsfw_tests/unit/CatchDefinitions.h"
 
-#include <catch2/catch_test_macros.hpp>
 #include <fsfw/objectmanager/ObjectManager.h>
 #include <fsfw/datapoollocal/HasLocalDataPoolIF.h>
-#include <unittest/core/CatchDefinitions.h>
 
+#include <catch2/catch_test_macros.hpp>
 
 TEST_CASE("LocalPoolVariable" , "[LocPoolVarTest]") {
     LocalPoolOwnerBase* poolOwner = ObjectManager::instance()->

tests/src/fsfw_tests/unit/datapoollocal/LocalPoolVectorTest.cpp

@@ -1,9 +1,10 @@
 #include "LocalPoolOwnerBase.h"
+#include "fsfw_tests/unit/CatchDefinitions.h"
 
 #include <catch2/catch_test_macros.hpp>
 #include <fsfw/objectmanager/ObjectManager.h>
 #include <fsfw/datapoollocal/HasLocalDataPoolIF.h>
-#include <unittest/core/CatchDefinitions.h>
+
 
 TEST_CASE("LocalPoolVector" , "[LocPoolVecTest]") {
     LocalPoolOwnerBase* poolOwner = ObjectManager::instance()->

tests/src/fsfw_tests/unit/mocks/MessageQueueMockBase.h

@@ -1,9 +1,12 @@
 #ifndef FSFW_UNITTEST_TESTS_MOCKS_MESSAGEQUEUEMOCKBASE_H_
 #define FSFW_UNITTEST_TESTS_MOCKS_MESSAGEQUEUEMOCKBASE_H_
 
-#include <fsfw/ipc/MessageQueueIF.h>
-#include <fsfw/ipc/MessageQueueMessage.h>
-#include <unittest/core/CatchDefinitions.h>
+#include "fsfw_tests/unit/CatchDefinitions.h"
+
+#include "fsfw/ipc/CommandMessage.h"
+#include "fsfw/ipc/MessageQueueIF.h"
+#include "fsfw/ipc/MessageQueueMessage.h"
+
 #include <cstring>
 
 #include <queue>

tests/src/fsfw_tests/unit/osal/TestMessageQueue.cpp

@@ -1,8 +1,9 @@
+#include "fsfw_tests/unit/CatchDefinitions.h"
+
 #include <fsfw/ipc/MessageQueueIF.h>
 #include <fsfw/ipc/QueueFactory.h>
 
 #include <catch2/catch_test_macros.hpp>
-#include <unittest/core/CatchDefinitions.h>
 
 #include <array>
 

tests/src/fsfw_tests/unit/printChar.cpp

@@ -0,0 +1,10 @@
+#include "printChar.h"
+#include <cstdio>
+
+void printChar(const char* character, bool errStream) {
+	if(errStream) {
+		std::putc(*character, stderr);
+		return;
+	}
+	std::putc(*character, stdout);
+}

tests/src/fsfw_tests/unit/printChar.h

@@ -0,0 +1,8 @@
+#ifndef FSFW_UNITTEST_CORE_PRINTCHAR_H_
+#define FSFW_UNITTEST_CORE_PRINTCHAR_H_
+
+
+extern "C" void printChar(const char*, bool errStream);
+
+
+#endif /* FSFW_UNITTEST_CORE_PRINTCHAR_H_ */

tests/src/fsfw_tests/unit/serialize/TestSerialBufferAdapter.cpp

@@ -1,7 +1,9 @@
+#include "fsfw_tests/unit/CatchDefinitions.h"
+
 #include <fsfw/serialize/SerialBufferAdapter.h>
 
 #include <catch2/catch_test_macros.hpp>
-#include <unittest/core/CatchDefinitions.h>
+
 
 #include <array>
 

tests/src/fsfw_tests/unit/serialize/TestSerialLinkedPacket.cpp

@@ -1,10 +1,9 @@
 #include "TestSerialLinkedPacket.h"
-#include <unittest/core/CatchDefinitions.h>
+#include "fsfw_tests/unit/CatchDefinitions.h"
 
 #include <fsfw/globalfunctions/arrayprinter.h>
 
 #include <catch2/catch_test_macros.hpp>
-#include <unittest/core/CatchDefinitions.h>
 
 #include <array>
 

tests/src/fsfw_tests/unit/serialize/TestSerialization.cpp

@@ -1,8 +1,8 @@
+#include "fsfw_tests/unit/CatchDefinitions.h"
 #include <fsfw/serialize/SerializeAdapter.h>
 
 #include <catch2/catch_test_macros.hpp>
 #include <catch2/catch_approx.hpp>
-#include <unittest/core/CatchDefinitions.h>
 
 #include <array>
 

tests/src/fsfw_tests/unit/storagemanager/TestNewAccessor.cpp

@@ -1,6 +1,9 @@
+#include "fsfw_tests/unit/CatchDefinitions.h"
+
 #include <fsfw/storagemanager/LocalPool.h>
+
 #include <catch2/catch_test_macros.hpp>
-#include <unittest/core/CatchDefinitions.h>
+
 #include <array>
 #include <cstring>
 

tests/src/fsfw_tests/unit/storagemanager/TestPool.cpp

@@ -1,8 +1,9 @@
+#include "fsfw_tests/unit/CatchDefinitions.h"
+
 #include <fsfw/objectmanager/ObjectManager.h>
 #include <fsfw/storagemanager/LocalPool.h>
 
 #include <catch2/catch_test_macros.hpp>
-#include <unittest/core/CatchDefinitions.h>
 
 #include <cstring>