Fix nasa#294: Use alternate setup function for Tests

Implements a more layered architecture for test code.
Rather than having each test provide OS_Application_Startup() directly,
now the UT assert library provides OS_Application_Startup() in common code.
This also introduces a new function OS_Application_Run() to implement the
test routine.  This replaces UtTest_Run.

The actual test setup is now done by a function called UtTest_Setup().

This allows for better layering where UT-Assert provides the
notion of an "OSAL application".  This is a step toward simplifying
the BSP architecture, eventually combining the normal application
and unit test BSP code into a single BSP.

CMakeLists.txt

@@ -16,8 +16,8 @@ function(add_osal_ut_exe TGTNAME)
   # It is not an issue for UT builds that use OSAL stubs or no OSAL at all.
   set_target_properties(${TGTNAME} PROPERTIES COMPILE_DEFINITIONS "_UNIT_TEST_")
   set_target_properties(${TGTNAME} PROPERTIES COMPILE_FLAGS "${UT_C_FLAGS}")  
-  set_target_properties(${TGTNAME} PROPERTIES LINK_FLAGS "${UT_C_FLAGS} -u OS_VolumeTable -u OS_STATIC_SYMBOL_TABLE -u UT_BSP_DoText")  
-  target_link_libraries(${TGTNAME} ut_bsp osal ut_assert ${OSAL_LINK_LIBS})
+  set_target_properties(${TGTNAME} PROPERTIES LINK_FLAGS "${UT_C_FLAGS} -u OS_VolumeTable -u OS_Application_Startup")  
+  target_link_libraries(${TGTNAME} ut_assert osal)
   add_test(${TGTNAME} ${TGTNAME})
   foreach(TGT ${INSTALL_TARGET_LIST})
     install(TARGETS ${TGTNAME} DESTINATION ${TGT}/${UT_INSTALL_SUBDIR})
@@ -206,6 +206,7 @@ if (IS_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/src/bsp/${UT_OSAL_BSPTYPE}/ut-src)
     aux_source_directory(${CMAKE_CURRENT_SOURCE_DIR}/src/bsp/${UT_OSAL_BSPTYPE}/ut-src UT_BSPFILES)
     add_library(ut_bsp STATIC EXCLUDE_FROM_ALL ${UT_BSPFILES})    
     set_target_properties(ut_bsp PROPERTIES COMPILE_DEFINITIONS "_UNIT_TEST_")
+    target_link_libraries(ut_assert ut_bsp)
 endif()
 
 if (ENABLE_UNIT_TESTS)
@@ -246,7 +247,6 @@ if (ENABLE_UNIT_TESTS)
     src/ut-stubs/osapi-utstub-timebase.c)
 
   add_library(ut_osapi_stubs STATIC ${UT_OSAPI_STUB_SRCFILES})
-  target_link_libraries(ut_osapi_stubs ut_assert)
 
   add_subdirectory(src/tests tests)
   add_subdirectory(src/unit-tests unit-tests)

src/bsp/genppc-vxworks6.4/ut-src/bsp_ut.c

@@ -162,9 +162,9 @@ void UT_BSP_DoTestSegmentReport(const char *SegmentName, const UtAssert_TestCoun
     UT_BSP_DoText(UTASSERT_CASETYPE_END, ReportBuffer);
 }
 
-void UT_BSP_Setup(const char *Name)
+void UT_BSP_Setup(void)
 {
-    UT_BSP_DoText(UTASSERT_CASETYPE_BEGIN, Name);
+    UT_BSP_DoText(UTASSERT_CASETYPE_BEGIN, "VxWorks UNIT TEST");
 }
 
 
@@ -203,20 +203,15 @@ int RunTest(void)
 
     if (RetVal == 0)
     {
-        UT_BSP_Setup("VxWorks UNIT TEST");
-
         /*
         ** Call application specific entry point.
         */
         OS_Application_Startup();
 
         /*
-        ** In unit test mode, call the UtTest_Run function (part of UT Assert library)
+        ** The OS_Application_Run function is part of UT Assert library
         */
-        UtTest_Run();
-
-        UT_BSP_EndTest(UtAssert_GetCounters());
-
+        OS_Application_Run();
 
         RetVal = (UtAssert_GetCounters()->CaseCount[UTASSERT_CASETYPE_FAILURE] +
            UtAssert_GetCounters()->CaseCount[UTASSERT_CASETYPE_TSF]);

src/bsp/pc-linux/ut-src/bsp_ut.c

@@ -111,7 +111,7 @@ void UT_BSP_ParseCommandLine(int argc, char *argv[])
     }
 }
 
-void UT_BSP_Setup(const char *Name)
+void UT_BSP_Setup(void)
 {
     int      mode;
     uint32   i;
@@ -125,7 +125,7 @@ void UT_BSP_Setup(const char *Name)
     EnableTermCodes = isatty(STDOUT_FILENO);
 
 
-    UT_BSP_DoText(UTASSERT_CASETYPE_BEGIN, Name);
+    UT_BSP_DoText(UTASSERT_CASETYPE_BEGIN, "PC-LINUX UNIT TEST");
 
     /*
     ** Create local directories for "disk" mount points
@@ -344,7 +344,6 @@ void UT_BSP_EndTest(const UtAssert_TestCounter_t *TestCounters)
 
 int main(int argc, char *argv[])
 {
-   UT_BSP_Setup("PC-LINUX UNIT TEST");
    UT_BSP_ParseCommandLine(argc, argv);
 
    /*
@@ -353,10 +352,9 @@ int main(int argc, char *argv[])
    OS_Application_Startup();
 
    /*
-   ** In unit test mode, call the UtTest_Run function (part of UT Assert library)
+   ** The OS_Application_Run function is part of UT Assert library
    */
-   UtTest_Run();
-   UT_BSP_EndTest(UtAssert_GetCounters());
+   OS_Application_Run();
 
    /* Should typically never get here */
    return(EXIT_SUCCESS);

src/bsp/pc-rtems/ut-src/bsp_ut.c

@@ -121,7 +121,7 @@ const char * UT_BSP_GetOptionString(int32 OptionNum)
 }
 
 
-void UT_BSP_Setup(const char *Name)
+void UT_BSP_Setup(void)
 {
     int status;
     int i;
@@ -280,7 +280,7 @@ void UT_BSP_Setup(const char *Name)
        be sent to the console in case of a slow port */
     rtems_task_wake_after(50);
 
-    UT_BSP_DoText(UTASSERT_CASETYPE_BEGIN, Name);
+    UT_BSP_DoText(UTASSERT_CASETYPE_BEGIN, "PC-RTEMS UNIT TEST");
 }
 
 
@@ -465,19 +465,16 @@ rtems_task Init(
   rtems_task_argument ignored
 )
 {
-   UT_BSP_Setup("PC-RTEMS UNIT TEST");
-
    /*
    ** Call application specific entry point.
    ** This is supposed to call OS_API_Init()
    */
    OS_Application_Startup();
 
    /*
-   ** In unit test mode, call the UtTest_Run function (part of UT Assert library)
+   ** The OS_Application_Run function is part of UT Assert library
    */
-   UtTest_Run();
-   UT_BSP_EndTest(UtAssert_GetCounters());
+   OS_Application_Run();
 
    rtems_shutdown_executive(UtAssert_GetFailCount() != 0);
 }

src/os/inc/osapi-os-core.h

@@ -142,10 +142,15 @@ typedef void (*OS_ArgCallback_t)(uint32 object_id, void *arg);
 
 /*
 ** Prototype for application startup function.
-** This is implemented by the user application
+** This is implemented by the BSP or user application
 */
 void OS_Application_Startup(void);
 
+/*
+** Prototype for application run function.
+** This is implemented by the BSP or user application
+*/
+void OS_Application_Run(void);
 
 /*
 ** Exported Functions

src/tests/bin-sem-flush-test/bin-sem-flush-test.c

@@ -156,7 +156,7 @@ void task_3(void)
 /*
 ** Main function
 */
-void OS_Application_Startup(void)
+void UtTest_Setup(void)
 {
     if (OS_API_Init() != OS_SUCCESS)
     {

src/tests/bin-sem-test/bin-sem-test.c

@@ -147,7 +147,7 @@ void BinSemCheck(void)
 }
 
 
-void OS_Application_Startup(void)
+void UtTest_Setup(void)
 {
     if (OS_API_Init() != OS_SUCCESS)
     {

src/tests/bin-sem-timeout-test/bin-sem-timeout-test.c

@@ -153,7 +153,7 @@ void BinSemTimeoutCheck(void)
     UtAssert_True(task_1_timeouts <= limit, "Task 1 timeouts=%u <= %u", (unsigned int)task_1_timeouts, (unsigned int)limit);
 }
 
-void OS_Application_Startup(void)
+void UtTest_Setup(void)
 {
     if (OS_API_Init() != OS_SUCCESS)
     {

src/tests/count-sem-test/count-sem-test.c

@@ -129,7 +129,7 @@ void task_3(void)
     }
 }
 
-void OS_Application_Startup(void)
+void UtTest_Setup(void)
 {
     if (OS_API_Init() != OS_SUCCESS)
     {

src/tests/file-api-test/file-api-test.c

@@ -25,7 +25,7 @@ os_fs_err_name_t errname;
 
 /* *************************************** MAIN ************************************** */
 
-void OS_Application_Startup(void)
+void UtTest_Setup(void)
 {
     errname[0] = 0;
 

src/tests/mutex-test/mutex-test.c

@@ -193,7 +193,7 @@ void task_3(void)
    }
 }
 
-void OS_Application_Startup(void)
+void UtTest_Setup(void)
 {
     if (OS_API_Init() != OS_SUCCESS)
     {

src/tests/osal-core-test/osal-core-test.c

@@ -22,7 +22,7 @@ void TestMutexes(void);
 void TestGetInfos(void);
 
 /* *************************************** MAIN ************************************** */
-void OS_Application_Startup(void)
+void UtTest_Setup(void)
 {
     if (OS_API_Init() != OS_SUCCESS)
     {

src/tests/queue-timeout-test/queue-timeout-test.c

@@ -110,7 +110,7 @@ void QueueTimeoutCheck(void)
 
 }
 
-void OS_Application_Startup(void)
+void UtTest_Setup(void)
 {
     if (OS_API_Init() != OS_SUCCESS)
     {

src/tests/sem-speed-test/sem-speed-test.c

@@ -119,7 +119,7 @@ void task_2(void)
     }
 }
 
-void OS_Application_Startup(void)
+void UtTest_Setup(void)
 {
     if (OS_API_Init() != OS_SUCCESS)
     {

src/tests/symbol-api-test/symbol-api-test.c

@@ -66,7 +66,7 @@ void TestSymbolApi(void)
 } /* end TestSymbolApi */
 
 
-void OS_Application_Startup(void)
+void UtTest_Setup(void)
 {
     if (OS_API_Init() != OS_SUCCESS)
     {

src/tests/timer-test/timer-test.c

@@ -47,7 +47,7 @@ void test_func(uint32 timer_id)
 
 /* ********************** MAIN **************************** */
 
-void OS_Application_Startup(void)
+void UtTest_Setup(void)
 {
 
   if (OS_API_Init() != OS_SUCCESS)

src/unit-test-coverage/portable/coveragetest-posixfile.c

@@ -187,12 +187,12 @@ void Osapi_TearDown(void)
 
 #define ADD_TEST(test) UtTest_Add((Test_ ## test), Osapi_Task_Setup, Osapi_TearDown, #test)
 
-/* Osapi_AddTestCase_Tasks
+/* UtTest_Setup
  *
  * Purpose:
  *   Registers the test cases to execute with the unit test tool
  */
-void OS_Application_Startup(void)
+void UtTest_Setup(void)
 {
     ADD_TEST(OS_FileOpen_Impl);
     ADD_TEST(OS_FileStat_Impl);

src/unit-test-coverage/portable/coveragetest-posixgettime.c

@@ -87,12 +87,12 @@ void Osapi_TearDown(void)
 
 #define ADD_TEST(test) UtTest_Add((Test_ ## test), Osapi_Task_Setup, Osapi_TearDown, #test)
 
-/* Osapi_AddTestCase_Tasks
+/* UtTest_Setup
  *
  * Purpose:
  *   Registers the test cases to execute with the unit test tool
  */
-void OS_Application_Startup(void)
+void UtTest_Setup(void)
 {
     ADD_TEST(OS_GetLocalTime_Impl);
     ADD_TEST(OS_SetLocalTime_Impl);

src/unit-test-coverage/portable/coveragetest-posixio.c

@@ -159,12 +159,12 @@ void Osapi_TearDown(void)
 
 #define ADD_TEST(test) UtTest_Add((Test_ ## test), Osapi_Task_Setup, Osapi_TearDown, #test)
 
-/* Osapi_AddTestCase_Tasks
+/* UtTest_Setup
  *
  * Purpose:
  *   Registers the test cases to execute with the unit test tool
  */
-void OS_Application_Startup(void)
+void UtTest_Setup(void)
 {
     ADD_TEST(OS_GenericClose_Impl);
     ADD_TEST(OS_GenericSeek_Impl);

src/unit-test-coverage/posix/src/coveragetest-osapi.c

@@ -521,12 +521,12 @@ void Osapi_TearDown(void)
 
 #define ADD_TEST(test) UtTest_Add((Test_ ## test), Osapi_Task_Setup, Osapi_TearDown, #test)
 
-/* Osapi_AddTestCase_Tasks
+/* UtTest_Setup
  *
  * Purpose:
  *   Registers the test cases to execute with the unit test tool
  */
-void OS_Application_Startup(void)
+void UtTest_Setup(void)
 {
     ADD_TEST(OS_Lock_Global_Impl);
     ADD_TEST(OS_Unlock_Global_Impl);

src/unit-test-coverage/shared/src/coveragetest-binsem.c

@@ -207,7 +207,7 @@ void Osapi_TearDown(void)
 /*
  * Register the test cases to execute with the unit test tool
  */
-void OS_Application_Startup(void)
+void UtTest_Setup(void)
 {
     ADD_TEST(OS_BinSemAPI_Init);
     ADD_TEST(OS_BinSemCreate);

src/unit-test-coverage/shared/src/coveragetest-clock.c

@@ -74,7 +74,7 @@ void Osapi_TearDown(void)
 /*
  * Register the test cases to execute with the unit test tool
  */
-void OS_Application_Startup(void)
+void UtTest_Setup(void)
 {
     ADD_TEST(OS_GetLocalTime);
     ADD_TEST(OS_SetLocalTime);

src/unit-test-coverage/shared/src/coveragetest-common.c

@@ -276,7 +276,7 @@ void Osapi_TearDown(void)
 /*
  * Register the test cases to execute with the unit test tool
  */
-void OS_Application_Startup(void)
+void UtTest_Setup(void)
 {
     ADD_TEST(OS_API_Init);
     ADD_TEST(OS_DeleteAllObjects);

src/unit-test-coverage/shared/src/coveragetest-countsem.c

@@ -194,7 +194,7 @@ void Osapi_TearDown(void)
 /*
  * Register the test cases to execute with the unit test tool
  */
-void OS_Application_Startup(void)
+void UtTest_Setup(void)
 {
     ADD_TEST(OS_CountSemAPI_Init);
     ADD_TEST(OS_CountSemCreate);

src/unit-test-coverage/shared/src/coveragetest-dir.c

@@ -205,7 +205,7 @@ void Osapi_TearDown(void)
 /*
  * Register the test cases to execute with the unit test tool
  */
-void OS_Application_Startup(void)
+void UtTest_Setup(void)
 {
     ADD_TEST(OS_DirAPI_Init);
     ADD_TEST(OS_mkdir);

src/unit-test-coverage/shared/src/coveragetest-errors.c

@@ -61,7 +61,7 @@ void Osapi_TearDown(void)
 /*
  * Register the test cases to execute with the unit test tool
  */
-void OS_Application_Startup(void)
+void UtTest_Setup(void)
 {
     ADD_TEST(OS_GetErrorName);
 }

src/unit-test-coverage/shared/src/coveragetest-file.c

@@ -472,7 +472,7 @@ void Osapi_TearDown(void)
 /*
  * Register the test cases to execute with the unit test tool
  */
-void OS_Application_Startup(void)
+void UtTest_Setup(void)
 {
     ADD_TEST(OS_FileAPI_Init);
     ADD_TEST(OS_creat);

src/unit-test-coverage/shared/src/coveragetest-filesys.c

@@ -605,7 +605,7 @@ void Osapi_TearDown(void)
 /*
  * Register the test cases to execute with the unit test tool
  */
-void OS_Application_Startup(void)
+void UtTest_Setup(void)
 {
     ADD_TEST(OS_FileSysAPI_Init);
     ADD_TEST(OS_FileSysAddFixedMap);

src/unit-test-coverage/shared/src/coveragetest-fpu.c

@@ -120,7 +120,7 @@ void Osapi_TearDown(void)
 /*
  * Register the test cases to execute with the unit test tool
  */
-void OS_Application_Startup(void)
+void UtTest_Setup(void)
 {
     ADD_TEST(OS_FPUExcAttachHandler);
     ADD_TEST(OS_FPUExcEnable);