New unit test for FM app does not link against stubs, causing failure

[brianrwillis]

Hello, I implemented zlib compression in our team's FM application, and am having trouble implementing unit tests.

I implemented fm_compression_zlib.c, and created a fm_compression_zlib_tests.c to test it.

I noticed my UtAssert_STUB_COUNT() call was not incrementing in my UTs, nor was my UT_SetDeferredRetcode() having any apparent effect.
However, I noticed that if I place my tests inside a pre-existing tests file, such as fm_child_tests.c, the above UT helper functions DID work as expected.

After some digging, I found that the fm_child-testrunner executable was linking against the stubs as expected, but my fm_compression-testrunner was not:

objdump snippet for coverage-fm-fm_child-testrunner:

00000000000286ea <FM_Decompress_Impl>:
 * ----------------------------------------------------
 * Generated stub function for FM_Decompress_Impl()
 * ----------------------------------------------------
 */
CFE_Status_t FM_Decompress_Impl(FM_Decompressor_State_t* State, const char* SrcFileName,
                                const char* DstFileName) {

< the stub function disassembly >

objdump snippet for coverage-fm-fm_compression_zlib-testrunner:

0000000000002b7b <FM_Decompress_Impl>:


int32 FM_Decompress_Impl(FM_Decompressor_State_t* State, const char* SrcFileName,
                         const char* DstFileName) {

< fm_compression_zlib.c's disassembly, not the stub's disassembly >

I would love assistance in debugging this strange issue. I can't find anything apparently incorrect in the way I set up this new test file.
Let me know what other information I can provide.

The changes I made to the provided CMakeLists.txt files are below:
CMakeLists.txt:

diff --git a/apps/fm/CMakeLists.txt b/apps/fm/CMakeLists.txt
index 1d156e8a..b880d5f8 100644
--- a/apps/fm/CMakeLists.txt
+++ b/apps/fm/CMakeLists.txt
@@ -6,7 +6,7 @@ project(CFS_FM C)
 #  TRUE or ON: Use default compression for the platform (TBD)
 #  CFS_FS_LIB: historical unzip implementation from older versions of CFE FS (deprecated)
 #  ZLIB: Use inflate/deflate API from zlib (http://zlib.net) (not yet implemented)
-set(FM_INCLUDE_COMPRESSION FALSE CACHE STRING "Type of data compression/decompression features to include in FM")
+set(FM_INCLUDE_COMPRESSION ZLIB CACHE STRING "Type of data compression/decompression features to include in FM")
 set(FM_DEPENDENCY_LIST)
 set(FM_OPTION_SRC_FILES)

@@ -44,6 +44,9 @@ endif()
 # Create the app module
 add_cfe_app(fm ${APP_SRC_FILES} ${FM_OPTION_SRC_FILES})

+# Link against zlib for compression
+target_link_libraries(fm z)
+
 # This permits direct access to public headers in the fsw/inc directory
 target_include_directories(fm PUBLIC fsw/inc)

unit-test/CMakeLists.txt:

diff --git a/apps/fm/unit-test/CMakeLists.txt b/apps/fm/unit-test/CMakeLists.txt
index 57328fa8..39919b0f 100644
--- a/apps/fm/unit-test/CMakeLists.txt
+++ b/apps/fm/unit-test/CMakeLists.txt
@@ -23,6 +23,9 @@ add_cfe_coverage_stubs("fm_internal"
 # Link with the cfe core stubs and unit test assert libs
 target_link_libraries(coverage-fm_internal-stubs ut_core_api_stubs ut_assert)

+# Link against zlib for compression
+target_link_libraries(coverage-fm_internal-stubs z)
+
 # Include and expose unit test utilities, fsw/inc, and fsw/src includes
 target_include_directories(coverage-fm_internal-stubs PUBLIC utilities)
 target_include_directories(coverage-fm_internal-stubs PUBLIC $<TARGET_PROPERTY:fm,INCLUDE_DIRECTORIES>)
@@ -32,10 +35,13 @@ target_include_directories(coverage-fm_internal-stubs PUBLIC $<TARGET_PROPERTY:f
 # normally these headers should not be referenced outside the module.
 include_directories(../fsw/src)

+# OSAL headers
+include_directories(${osal_MISSION_DIR}/src/os/shared/inc)
+
 # Generate a dedicated "testrunner" executable for each test file
 # Accomplish this by cycling through all the app's source files, there must be
 # a *_tests file for each
-foreach(SRCFILE ${APP_SRC_FILES})
+foreach(SRCFILE ${APP_SRC_FILES} ${FM_OPTION_SRC_FILES})

     # Get the base sourcefile name as a module name without path or the
     # extension, this will be used as the base name of the unit test file.

The stub file, fm_compression_stubs.c, is unchanged from the source.

Thanks all.