Merge pull request nasa#1481 from nasa/integration-candidate

cFE Integration candidate: 2021-05-04

README.md

@@ -10,8 +10,15 @@ The detailed cFE user's guide can be viewed at <https://github.com/nasa/cFS/blob
 
 ## Version History
 
-### Development Build: v6.8.0-rc1+dev540
+### Development Build: v6.8.0-rc1+dev559
+
+- Adds tests for nominal use cases of the ES Critical Data Store API.
+- Adds functional tests for nominal uses of FS Header API.
+- Adds functional tests for Time Current API.
+- [docs] Makes comment blocks in source and header files more consistent for all internal, CFE core APIs. Moves information about the function behavior to its prototype in the header in doxygen format. Comment blocks on the function implementation refer back to the prototype, it does not duplicate the info. Local helper functions that are not separately prototyped, are exceptions to this pattern. Adds intended scope to all functions: global, application-internal, or file/local.
+- See <https://github.com/nasa/cFE/pull/1481> and <https://github.com/nasa/cFS/pull/252>
 
+### Development Build: v6.8.0-rc1+dev540
 
 - Changes the type of pointer for `MemPtr` in `CFE_ES_PoolCreateNoSem` API from uint8* to void* to be more consistent and easier to use. Should be backward compatible.
 Updates the doxygen documentation for this parameter, as it was incorrectly specifying a 32-bit alignment requirement.

modules/cfe_testcase/CMakeLists.txt

@@ -4,6 +4,9 @@ add_cfe_app(cfe_testcase
     src/cfe_test.c
     src/es_info_test.c
     src/es_task_test.c
+    src/es_cds_test.c
+    src/fs_header_test.c
+    src/time_current_test.c
 )
 
 # register the dependency on cfe_assert

modules/cfe_testcase/src/cfe_test.c

@@ -52,6 +52,9 @@ void CFE_TestMain(void)
      */
     ESInfoTestSetup();
     ESTaskTestSetup();
+    ESCDSTestSetup();
+    FSHeaderTestSetup();
+    TimeCurrentTestSetup();
 
     /*
      * Execute the tests

modules/cfe_testcase/src/cfe_test.h

@@ -55,5 +55,8 @@
 void CFE_TestMain(void);
 void ESInfoTestSetup(void);
 void ESTaskTestSetup(void);
+void ESCDSTestSetup(void);
+void FSHeaderTestSetup(void);
+void TimeCurrentTestSetup(void);
 
 #endif /* CFE_TEST_H */

modules/cfe_testcase/src/es_cds_test.c

@@ -0,0 +1,90 @@
+/*************************************************************************
+**
+**      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.
+**      All Rights Reserved.
+**
+**      Licensed under the Apache License, Version 2.0 (the "License");
+**      you may not use this file except in compliance with the License.
+**      You may obtain a copy of the License at
+**
+**        http://www.apache.org/licenses/LICENSE-2.0
+**
+**      Unless required by applicable law or agreed to in writing, software
+**      distributed under the License is distributed on an "AS IS" BASIS,
+**      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+**      See the License for the specific language governing permissions and
+**      limitations under the License.
+**
+** File: es_info_test.c
+**
+** Purpose:
+**   Functional test of basic ES Critical Data Store APIs
+**
+**   Demonstration of how to register and use the UT assert functions.
+**
+*************************************************************************/
+
+/*
+ * Includes
+ */
+
+#include "cfe_test.h"
+
+void TestCDS(void)
+{
+    CFE_ES_CDSHandle_t CDSHandlePtr;
+    size_t             BlockSize = 10;
+    const char *       Name      = "CDS_Test";
+    const char *       CDSName   = "CFE_TEST_APP.CDS_Test";
+    CFE_ES_CDSHandle_t IdByName;
+    char               CDSNameBuf[CFE_MISSION_ES_CDS_MAX_FULL_NAME_LEN];
+    CFE_Status_t       status;
+
+    UtPrintf("Testing: CFE_ES_RegisterCDS, CFE_ES_GetCDSBlockIDByName, CFE_ES_GetCDSBlockName");
+
+    status = CFE_ES_RegisterCDS(&CDSHandlePtr, BlockSize, Name);
+
+    if (status == CFE_ES_CDS_ALREADY_EXISTS)
+    {
+        UtAssert_NA("CDS already exists. CFE_ES_RegisterCDS new allocation could not be properly tested");
+    }
+    else
+    {
+        UtAssert_INT32_EQ(status, CFE_SUCCESS);
+    }
+
+    UtAssert_INT32_EQ(CFE_ES_GetCDSBlockName(CDSNameBuf, CDSHandlePtr, sizeof(CDSNameBuf)), CFE_SUCCESS);
+    UtAssert_StrCmp(CDSNameBuf, CDSName, "CFE_ES_GetCDSBlockName() = %s", CDSNameBuf);
+    UtAssert_INT32_EQ(CFE_ES_GetCDSBlockIDByName(&IdByName, CDSNameBuf), CFE_SUCCESS);
+    UtAssert_ResourceID_EQ(CDSHandlePtr, IdByName);
+}
+
+void TestCopyRestoreCDS(void)
+{
+    CFE_ES_CDSHandle_t CDSHandlePtr;
+    size_t             BlockSize = 10;
+    const char *       Name      = "CDS_Copy_Test";
+    CFE_Status_t       status;
+    char               Data[BlockSize];
+    char               DataBuff[BlockSize];
+
+    UtPrintf("Testing: CFE_ES_CopyToCDS, CFE_ES_RestoreFromCDS");
+
+    snprintf(Data, BlockSize, "Test Data");
+    status = CFE_ES_RegisterCDS(&CDSHandlePtr, BlockSize, Name);
+
+    UtAssert_True(status == CFE_SUCCESS || status == CFE_ES_CDS_ALREADY_EXISTS, "Register CDS status = %d",
+                  (int)status);
+    UtAssert_INT32_EQ(CFE_ES_CopyToCDS(CDSHandlePtr, Data), CFE_SUCCESS);
+    UtAssert_INT32_EQ(CFE_ES_RestoreFromCDS(DataBuff, CDSHandlePtr), CFE_SUCCESS);
+    UtAssert_StrCmp(Data, DataBuff, "RestoreFromCDS = %s", DataBuff);
+}
+
+void ESCDSTestSetup(void)
+{
+    UtTest_Add(TestCDS, NULL, NULL, "Test CDS");
+    UtTest_Add(TestCopyRestoreCDS, NULL, NULL, "Test Copy Restore CDS");
+}

modules/cfe_testcase/src/fs_header_test.c

@@ -0,0 +1,111 @@
+/*************************************************************************
+**
+**      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.
+**      All Rights Reserved.
+**
+**      Licensed under the Apache License, Version 2.0 (the "License");
+**      you may not use this file except in compliance with the License.
+**      You may obtain a copy of the License at
+**
+**        http://www.apache.org/licenses/LICENSE-2.0
+**
+**      Unless required by applicable law or agreed to in writing, software
+**      distributed under the License is distributed on an "AS IS" BASIS,
+**      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+**      See the License for the specific language governing permissions and
+**      limitations under the License.
+**
+** File: es_info_test.c
+**
+** Purpose:
+**   Functional test of basic FS Header APIs
+**
+**   Demonstration of how to register and use the UT assert functions.
+**
+*************************************************************************/
+
+/*
+ * Includes
+ */
+
+#include "cfe_test.h"
+
+#define OS_TEST_HEADER_FILENAME "/drive0/header_test.txt"
+char *fsAddrPtr = NULL;
+
+static osal_id_t setup_file(void)
+{
+    osal_id_t id;
+    OS_mkfs(fsAddrPtr, "/ramdev1", "RAM", 512, 20);
+    OS_mount("/ramdev1", "/drive0");
+    UtAssert_INT32_EQ(OS_OpenCreate(&id, OS_TEST_HEADER_FILENAME, OS_FILE_FLAG_CREATE, OS_READ_WRITE), OS_SUCCESS);
+    return id;
+}
+
+void TestCreateHeader(void)
+{
+    CFE_FS_Header_t Header;
+    const char *    TestDescription = "TEST_HEADER";
+    osal_id_t       fd              = setup_file();
+
+    UtPrintf("Testing: CFE_FS_InitHeader, CFE_FS_WriteHeader");
+
+    CFE_FS_InitHeader(&Header, TestDescription, CFE_FS_SubType_ES_ERLOG);
+    UtAssert_INT32_EQ(CFE_FS_WriteHeader(fd, &Header), sizeof(CFE_FS_Header_t));
+
+    OS_close(fd);
+    OS_remove(OS_TEST_HEADER_FILENAME);
+}
+
+void TestReadHeader(void)
+{
+    CFE_FS_Header_t Header;
+    CFE_FS_Header_t ReadHeader;
+    const char *    TestDescription = "TEST_HEADER";
+    osal_id_t       fd              = setup_file();
+
+    UtPrintf("Testing: CFE_FS_ReadHeader");
+
+    CFE_FS_InitHeader(&Header, TestDescription, CFE_FS_SubType_ES_ERLOG);
+    UtAssert_INT32_EQ(CFE_FS_WriteHeader(fd, &Header), sizeof(CFE_FS_Header_t));
+    UtAssert_INT32_EQ(CFE_FS_ReadHeader(&ReadHeader, fd), sizeof(CFE_FS_Header_t));
+
+    UtAssert_INT32_EQ(Header.ContentType, ReadHeader.ContentType);
+    UtAssert_INT32_EQ(Header.SubType, ReadHeader.SubType);
+    UtAssert_StrCmp(TestDescription, ReadHeader.Description, "ReadHeader.Description = %s", ReadHeader.Description);
+
+    OS_close(fd);
+    OS_remove(OS_TEST_HEADER_FILENAME);
+}
+
+void TestTimeStamp(void)
+{
+    CFE_FS_Header_t    Header;
+    CFE_FS_Header_t    ReadHeader;
+    const char *       TestDescription = "TEST_HEADER";
+    CFE_TIME_SysTime_t NewTimestamp    = {10, 10};
+    osal_id_t          fd              = setup_file();
+
+    UtPrintf("Testing: CFE_FS_SetTimestamp");
+
+    CFE_FS_InitHeader(&Header, TestDescription, CFE_FS_SubType_ES_ERLOG);
+    UtAssert_INT32_EQ(CFE_FS_WriteHeader(fd, &Header), sizeof(CFE_FS_Header_t));
+    UtAssert_INT32_EQ(CFE_FS_SetTimestamp(fd, NewTimestamp), OS_SUCCESS);
+    UtAssert_INT32_EQ(CFE_FS_ReadHeader(&ReadHeader, fd), sizeof(CFE_FS_Header_t));
+
+    UtAssert_INT32_EQ(10, ReadHeader.TimeSeconds);
+    UtAssert_INT32_EQ(10, ReadHeader.TimeSubSeconds);
+
+    OS_close(fd);
+    OS_remove(OS_TEST_HEADER_FILENAME);
+}
+
+void FSHeaderTestSetup(void)
+{
+    UtTest_Add(TestCreateHeader, NULL, NULL, "Test Create Header");
+    UtTest_Add(TestReadHeader, NULL, NULL, "Test Read Header");
+    UtTest_Add(TestTimeStamp, NULL, NULL, "Test Time Stamp");
+}

modules/cfe_testcase/src/time_current_test.c

@@ -0,0 +1,126 @@
+/*************************************************************************
+**
+**      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.
+**      All Rights Reserved.
+**
+**      Licensed under the Apache License, Version 2.0 (the "License");
+**      you may not use this file except in compliance with the License.
+**      You may obtain a copy of the License at
+**
+**        http://www.apache.org/licenses/LICENSE-2.0
+**
+**      Unless required by applicable law or agreed to in writing, software
+**      distributed under the License is distributed on an "AS IS" BASIS,
+**      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+**      See the License for the specific language governing permissions and
+**      limitations under the License.
+**
+** File: es_info_test.c
+**
+** Purpose:
+**   Functional test of basic Time Current APIs
+**
+**   Demonstration of how to register and use the UT assert functions.
+**
+*************************************************************************/
+
+/*
+ * Includes
+ */
+
+#include "cfe_test.h"
+
+bool TimeInRange(CFE_TIME_SysTime_t Time, CFE_TIME_SysTime_t Target, OS_time_t difference)
+{
+    OS_time_t Max;
+    OS_time_t TimeT   = OS_TimeAssembleFromSubseconds(Time.Seconds, Time.Subseconds);
+    OS_time_t TargetT = OS_TimeAssembleFromSubseconds(Target.Seconds, Target.Subseconds);
+
+    Max = OS_TimeAdd(TimeT, difference);
+
+    if (TargetT.ticks >= TimeT.ticks && TargetT.ticks <= Max.ticks)
+    {
+        return true;
+    }
+    else
+    {
+        return false;
+    }
+}
+
+void TestGetTime(void)
+{
+    UtPrintf("Testing: CFE_TIME_GetTime, CFE_TIME_GetTAI, CFE_TIME_GetUTC, CFE_TIME_GetMET, CFE_TIME_GetSTCF, "
+             "CFE_TIME_GetLeapSeconds");
+    OS_time_t          start;
+    OS_time_t          end;
+    OS_time_t          difference;
+    CFE_TIME_SysTime_t Time;
+    CFE_TIME_SysTime_t TAI;
+    CFE_TIME_SysTime_t UTC;
+    CFE_TIME_SysTime_t MET;
+    CFE_TIME_SysTime_t STCF;
+    uint32             METSeconds;
+    uint32             METSubSeconds;
+
+    int16              LeapSeconds;
+    CFE_TIME_SysTime_t Buf;
+
+    char timeBuf1[sizeof("yyyy-ddd-hh:mm:ss.xxxxx_")];
+    char timeBuf2[sizeof("yyyy-ddd-hh:mm:ss.xxxxx_")];
+
+    OS_GetLocalTime(&start);
+
+    Time          = CFE_TIME_GetTime();
+    TAI           = CFE_TIME_GetTAI();
+    UTC           = CFE_TIME_GetUTC();
+    MET           = CFE_TIME_GetMET();
+    METSeconds    = CFE_TIME_GetMETseconds();
+    METSubSeconds = CFE_TIME_GetMETsubsecs();
+    STCF          = CFE_TIME_GetSTCF();
+    LeapSeconds   = CFE_TIME_GetLeapSeconds();
+
+    OS_GetLocalTime(&end);
+
+    CFE_TIME_Print(timeBuf1, Time);
+    UtPrintf("The current time is (%d) %s", Time.Seconds, timeBuf1);
+
+    difference = OS_TimeSubtract(end, start);
+
+#if (CFE_MISSION_TIME_CFG_DEFAULT_TAI == true)
+    CFE_TIME_Print(timeBuf2, TAI);
+    UtAssert_True(TimeInRange(Time, TAI, difference), "Get Time (%s) = TAI (%s)", timeBuf1, timeBuf2);
+#else
+    CFE_TIME_Print(timeBuf2, UTC);
+    UtAssert_True(TimeInRange(Time, UTC, difference), "Get Time (%s) = UTC(%s)", timeBuf1, timeBuf2);
+#endif
+
+    CFE_TIME_Print(timeBuf1, TAI);
+    Buf = CFE_TIME_Add(MET, STCF);
+    CFE_TIME_Print(timeBuf2, Buf);
+    UtAssert_True(TimeInRange(TAI, Buf, difference), "TAI (%s) = MET + STCF (%s)", timeBuf1, timeBuf2);
+
+    CFE_TIME_Print(timeBuf1, UTC);
+    Buf.Seconds = Buf.Seconds - LeapSeconds;
+    CFE_TIME_Print(timeBuf2, Buf);
+    UtAssert_True(TimeInRange(UTC, Buf, difference), "UTC (%s) = MET + STCF - Leap Seconds (%s)", timeBuf1, timeBuf2);
+
+    CFE_TIME_Print(timeBuf1, MET);
+    Buf.Seconds    = METSeconds;
+    Buf.Subseconds = MET.Subseconds;
+    CFE_TIME_Print(timeBuf2, Buf);
+    UtAssert_True(TimeInRange(MET, Buf, difference), "MET (%s) = METSeconds (%s)", timeBuf1, timeBuf2);
+
+    Buf.Seconds    = MET.Seconds;
+    Buf.Subseconds = METSubSeconds;
+    CFE_TIME_Print(timeBuf2, Buf);
+    UtAssert_True(TimeInRange(MET, Buf, difference), "MET (%s) = METSubSeconds (%s)", timeBuf1, timeBuf2);
+}
+
+void TimeCurrentTestSetup(void)
+{
+    UtTest_Add(TestGetTime, NULL, NULL, "Test Current Time");
+}