SCH Unit Tests

[jeffstjean]

I am trying to upgrade the unit tests on the old SCH app to use UTAssert and have been coming across some issues. I set a hook for a CFE function but it never seems to get called. I also tried just setting the default return value and it appears the function isn't returning the value I've set it to. Is there something I'm missing here?

#include "sch_app.h"
#include "sch_events.h"

#include "sch_test_utils.h"

/* UT includes */
#include "uttest.h"
#include "utassert.h"
#include "utstubs.h"

int32 SCH_APP_TEST_CFE_TIME_UnregisterSynchCallbackHook(void *UserObj, int32 StubRetcode, uint32 CallCount, const UT_StubContext_t *Context)
{
    SCH_AppData.AppID = 99;

    return CFE_SUCCESS;
}

void Test_SCH_AppMain_AppInitError(void)
{
    // make SCH_AppInit fail
    UT_SetDefaultReturnValue(UT_KEY(CFE_ES_GetAppID), !CFE_SUCCESS);

    // Set the app ID to 99 to verify the end of the function has been reached (aka. CFE_TIME_UnregisterSynchCallback called)
    UT_SetHookFunction(UT_KEY(CFE_TIME_UnregisterSynchCallback), SCH_APP_TEST_CFE_TIME_UnregisterSynchCallbackHook, NULL);
    // ISSUE HERE: SCH_AppData.AppID never gets set by SCH_APP_TEST_CFE_TIME_UnregisterSynchCallbackHook to 99

    UtAssert_VOIDCALL(SCH_AppMain());

    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventID, SCH_APP_EXIT_EID);
    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventType, CFE_EVS_EventType_CRITICAL);
    UtAssert_STUB_COUNT(CFE_EVS_SendEvent, 1);
    UtAssert_STUB_COUNT(CFE_ES_WriteToSysLog, 2);
    UtAssert_INT32_EQ(SCH_AppData.AppID, 99);
}

void Test_SCH_AppMain_CustomLateInitError(void)
{
    // Set to make SCH_TblInit return success to make SCH_AppInit return success
    UT_SetDefaultReturnValue(UT_KEY(CFE_TBL_Load), CFE_SUCCESS);

    // Set to make CustomLateInit return -1, in order to generate error message SCH_MAJOR_FRAME_SUB_ERR_EID
    UT_SetDefaultReturnValue(UT_KEY(CFE_TIME_RegisterSynchCallback), !CFE_SUCCESS);
    // ISSUE HERE: CFE_TIME_RegisterSynchCallback still returns CFE_SUCCESS

    // Set the app ID to 99 to verify the end of the function has been reached (aka. CFE_TIME_UnregisterSynchCallback called)
    SCH_AppData.AppID = 99;

    UtAssert_VOIDCALL(SCH_AppMain());

    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[1].EventID, SCH_MAJOR_FRAME_SUB_ERR_EID);
    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[1].EventType, CFE_EVS_EventType_ERROR);
    UtAssert_STUB_COUNT(CFE_EVS_SendEvent, 3);
    UtAssert_STUB_COUNT(CFE_ES_WriteToSysLog, 1);
    UtAssert_INT32_EQ(SCH_AppData.AppID, 99);

}


void UtTest_Setup(void)
{
    UtTest_Add(Test_SCH_AppMain_AppInitError, SCH_Test_Setup, SCH_Test_TearDown, "Test_SCH_AppMain_AppInitError");
    UtTest_Add(Test_SCH_AppMain_CustomLateInitError, SCH_Test_Setup, SCH_Test_TearDown, "Test_SCH_AppMain_CustomLateInitError");

}

[jeffstjean]

While it should've been obvious, anything outside the c file you're testing, will be stubbed out by default. Some of the older unit tests (not sure what it was called) will trigger failure conditions from CFE calls to cause a function fail (eg. a custom init from another c file) to return a failure. With the new framework, you can just directly set the return code of any function (assuming you've created the required stubs with the generator or by hand).

Changing UT_SetDefaultReturnValue(UT_KEY(CFE_TIME_RegisterSynchCallback), !CFE_SUCCESS); to UT_SetDefaultReturnValue(UT_KEY(SCH_CustomLateInit), !CFE_SUCCESS); fixed it

[LucienMorey]

FYI dude, since I dont know how far you have gotten but I had a go at porting all of the unit tests and the app to work with the caelum bundle if that's what you're trying to do. you can see it on my fork here. the app builds and runs and I believe I have ported all intended behaviour from tests that haven't been made obsolete.

[jeffstjean]

I ended up finishing them last week but thank you!