Fix #8, Implement coverage test for SAMPLE_App

Use the UT Assert framework and stubs provided by other
modules to perform unit testing on the SAMPLE_APP.

This gets 100% line coverage on the current implementation.

Author: jphickey

CMakeLists.txt

@@ -8,10 +8,23 @@ include_directories(fsw/platform_inc)
 # to call library-provided functions
 include_directories(${sample_lib_MISSION_DIR}/fsw/public_inc)
 
-aux_source_directory(fsw/src APP_SRC_FILES)
+# Note that it is generally preferred to list the source files
+# explicitly rather than globbing using aux_source_directory()
+# The latter was also picking up sample_table.c which is not
+# intended to be built/linked with the app itself.
+set(APP_SRC_FILES fsw/src/sample_app.c)
 
 # Create the app module
 add_cfe_app(sample_app ${APP_SRC_FILES})
 
 # Add table
 add_cfe_tables(sampleTable fsw/src/sample_table.c)
+
+# If UT is enabled, then add the tests from the subdirectory
+# Note that this is an app, and therefore does not provide
+# stub functions, as other entities would not typically make 
+# direct function calls into this application.
+if (ENABLE_UNIT_TESTS)
+  add_subdirectory(unit-test)
+endif (ENABLE_UNIT_TESTS)
+

fsw/src/sample_app.c

@@ -34,9 +34,8 @@
 #include "sample_table.h"
 
 /* The sample_lib module provides the SAMPLE_Function() prototype */
-#include <sample_lib.h>
-
 #include <string.h>
+#include "sample_lib.h"
 
 /*
 ** global data

fsw/src/sample_table.c

@@ -1,6 +1,6 @@
 /*
 **
-**      GSC-18128-1, "Core Flight Executive Version 6.6"
+**      GSC-18128-1, "Core Flight Executive Version 6.7"
 **
 **      Copyright (c) 2006-2019 United States Government as represented by
 **      the Administrator of the National Aeronautics and Space Administration.

fsw/src/sample_table.h

@@ -1,6 +1,6 @@
 /*******************************************************************************
 **
-**      GSC-18128-1, "Core Flight Executive Version 6.6"
+**      GSC-18128-1, "Core Flight Executive Version 6.7"
 **
 **      Copyright (c) 2006-2019 United States Government as represented by
 **      the Administrator of the National Aeronautics and Space Administration.

unit-test/CMakeLists.txt

@@ -0,0 +1,77 @@
+##################################################################
+#
+# Coverage Unit Test build recipe
+#
+# This CMake file contains the recipe for building the sample unit tests.
+# It is invoked from the parent directory when unit tests are enabled.
+#
+##################################################################
+
+#
+#
+# NOTE on the subdirectory structures here:
+#
+# - "inc" provides local header files shared between the coveragetest,
+#    wrappers, and overrides source code units
+# - "coveragetest" contains source code for the actual unit test cases
+#    The primary objective is to get line/path coverage on the FSW 
+#    code units.
+# - "wrappers" contains wrappers for the FSW code.  The wrapper adds
+#    any UT-specific scaffolding to facilitate the coverage test, and
+#    includes the unmodified FSW source file.
+#
+ 
+set(UT_NAME sample_app)
+
+# Use the UT assert public API, and allow direct
+# inclusion of source files that are normally private
+include_directories(${osal_MISSION_DIR}/ut_assert/inc)
+include_directories(${PROJECT_SOURCE_DIR}/fsw/src)
+include_directories(${CMAKE_CURRENT_SOURCE_DIR}/inc)
+
+# The APP_SRC_FILES variable should contain the list of source files for the FSW build
+# There should be a 1:1 relationship between FSW source units and coverage tests
+# Generate a dedicated "testrunner" executable that executes the tests for each FSW code unit
+# Although sample_app has only one source file, this is done in a loop such that 
+# the general pattern should work for several files as well.
+foreach(SRCFILE ${APP_SRC_FILES})
+    get_filename_component(UNITNAME "${SRCFILE}" NAME_WE)
+    
+    set(TESTNAME                "${UT_NAME}-${UNITNAME}")
+    set(UNIT_SOURCE_FILE        "${CFE_SAMPLE_APP_SOURCE_DIR}/fsw/src/${UNITNAME}.c")
+    set(TESTCASE_SOURCE_FILE    "coveragetest/coveragetest_${UNITNAME}.c")
+    
+    # Compile the source unit under test as a OBJECT
+    add_library(ut_${TESTNAME}_object OBJECT
+        ${UNIT_SOURCE_FILE}
+    )    
+    
+    # Apply the UT_C_FLAGS to the units under test
+    # This should enable coverage analysis on platforms that support this
+    set_target_properties(ut_${TESTNAME}_object PROPERTIES
+        COMPILE_FLAGS "${UT_C_FLAGS}")
+        
+    # Compile a test runner application, which contains the
+    # actual coverage test code (test cases) and the unit under test
+    add_executable(${TESTNAME}-testrunner
+        ${TESTCASE_SOURCE_FILE}
+        $<TARGET_OBJECTS:ut_${TESTNAME}_object>
+    )
+    
+    # This also needs to be linked with UT_C_FLAGS (for coverage)
+    set_target_properties(${TESTNAME}-testrunner PROPERTIES 
+        LINK_FLAGS "${UT_C_FLAGS}")
+    
+    # This is also linked with any other stub libraries needed,
+    # as well as the UT assert framework    
+    target_link_libraries(${TESTNAME}-testrunner
+        ut_sample_lib_stubs
+        ut_cfe-core_stubs
+        ut_assert
+    )
+    
+    # Add it to the set of tests to run as part of "make test"
+    add_test(${TESTNAME} ${TESTNAME}-testrunner)
+    
+endforeach()
+