Fix #1024, check misc API return codes#1030
Merged
astrogeco merged 1 commit intonasa:integration-candidatefrom Jun 2, 2021
Merged
Fix #1024, check misc API return codes#1030astrogeco merged 1 commit intonasa:integration-candidatefrom
astrogeco merged 1 commit intonasa:integration-candidatefrom
Conversation
jphickey
added
the
CCB:Ready
jphickey
force-pushed
the
fix-1024-api-test-retcodes
branch
from
327b181 to
8989f7b
Compare
skliper
reviewed
May 20, 2021
Contributor
skliper
left a comment
skliper
left a comment
There was a problem hiding this comment.
OS_ShellOutputToFile overloads undefined and NULL test. Should be separate tests (one for NULL pointer, one for OS_OBJECT_ID_UNDEFINED returns OS_ERR_INVALID_ID.
jphickey
force-pushed
the
fix-1024-api-test-retcodes
branch
from
8989f7b to
e3bd1ad
Compare
Contributor
Author
|
Commit e54acfc fixes the OS_ShellOutputToFile test by moving the null pointer test to be after setup (where the file ID is valid). This also changes the tests done before OS_API_Init() - instead of checking specifically for OS_ERROR (which is not specifically documented) this just checks that the result is not success. Technically, calling any other API before OS_API_Init is not valid an no specific behavior is completely guaranteed here. |
Fix missing doxygen retvals Note, other tests were OK, but depend on support being enabled and supported by RTOS. Script will report N/A items (due to no impl) as missing. Confirmed OS_HeapGetInfo OK on RTEMS. For test cases where a function is invoked before OS_API_Init, only check that the result is not success. This will remain as "undocumented" behavior - users should not call functions before init, because it is not valid to do so. A specific error code is not guaranteed here.
jphickey
force-pushed
the
fix-1024-api-test-retcodes
branch
from
e3bd1ad to
e54acfc
Compare
skliper
reviewed
May 24, 2021
skliper
previously requested changes
May 24, 2021
Contributor
skliper
left a comment
skliper
left a comment
There was a problem hiding this comment.
OS_ShellOutputToFile needs ID UNDEFINED test returns INVALID ID
skliper
approved these changes
May 26, 2021
astrogeco
added
CCB:Approved
astrogeco
added a commit
to nasa/cFS
that referenced
this pull request
Jun 2, 2021
Update nasa/osal#1058 Includes: nasa/osal#1044, resolve discrepancies between mutex API and unit tests nasa/osal#1038, resolve discrepancies between queue API and unit tests nasa/osal#1037, resolve discrepancies between task API and unit tests nasa/osal#1051, resolve discrepancies between timebase API and unit tests nasa/osal#1030, check misc API return codes nasa/osal#1039, Rename CodeQL cFE Build and add Duplicate Job nasa/osal#1049, filter only whole words for keyword match
astrogeco
added a commit
to nasa/cFS
that referenced
this pull request
Jun 2, 2021
Update nasa/osal#1058 Includes: nasa/osal#1044, resolve discrepancies between mutex API and unit tests nasa/osal#1038, resolve discrepancies between queue API and unit tests nasa/osal#1037, resolve discrepancies between task API and unit tests nasa/osal#1051, resolve discrepancies between timebase API and unit tests nasa/osal#1030, check misc API return codes nasa/osal#1039, Rename CodeQL cFE Build and add Duplicate Job nasa/osal#1049, filter only whole words for keyword match
astrogeco
added a commit
to nasa/cFS
that referenced
this pull request
Jun 8, 2021
- #263, bundle Combines: - nasa/cFE#1584, v6.8.0-rc1+dev642 - nasa/osal#1058, v5.1.0-rc1+dev500 - nasa/sch_lab#82, v2.4.0-rc1+dev36 Includes: - nasa/cFE#1580, Update ES verify errors to match test - nasa/cFE#1578, Resolve mismatched endforeach of CMakeList.txt - nasa/cFE#1579, Improve event filter documentation - nasa/cFE#1576, EVS/FS documentation cleanup - nasa/cFE#1575, Remove shell file subtype and clarify scope - nasa/cFE#1582, Simplify file open/truncate logic - nasa/cFE#1567, Remove deprecated elements - nasa/cFE#1556, Replace Header Content Type magic number - nasa/cFE#1553, Remove unused EVS LogMode defines - nasa/cFE#1570, Document cleanup from SB/MSG/SBR review, Remove unused CFE_SB_NO_SUBSCRIBERS - nasa/cFE#1565, Add CFE_SB_DestinationD tag and use for pointers - nasa/cFE#1564, Use CFE_MSG_SequenceCount_t for seqcnt type - nasa/cFE#1562, Document CFE_ES_PoolCreateEx NumBlockSizes error handling - nasa/cFE#1560, Documentation cleanup in TBL/TIME - nasa/cFE#1558, Document TblName as app specific - nasa/cFE#1563, use OSAL script to generate API guide - nasa/cFE#1557, Include verify headers to validate config - nasa/cFE#1555, add doxygen aliases for OSAL parameter/retvals - nasa/osal#1033, include doxygen targets locally - nasa/osal#1031, Document OS_ObjectIdToArrayIndex as public - nasa/osal#1040, resolve discrepancies between binsem API and unit tests - nasa/osal#1029, add missing clock retcode tests - nasa/osal#1046, resolve discrepancies between common API and unit tests - nasa/osal#1041, resolve discrepancies between countsem API and unit tests - nasa/osal#1045, resolve discrepancies between dir API and unit tests - nasa/osal#1043, resolve discrepancies between module API and unit tests - nasa/osal#1044, resolve discrepancies between mutex API and unit tests - nasa/osal#1038, resolve discrepancies between queue API and unit tests - nasa/osal#1037, resolve discrepancies between task API and unit tests - nasa/osal#1051, resolve discrepancies between timebase API and unit tests - nasa/osal#1030, check misc API return codes - nasa/osal#1039, Rename CodeQL cFE Build and add Duplicate Job - nasa/osal#1049, filter only whole words for keyword match - nasa/osal#962, update OSAL Config Guide link - nasa/sch_lab#81, exit the main loop if init fails - HOTFIX cFS-bundle, Use new osalguide logfile to fix documentation build workflow errors,
astrogeco
added a commit
to nasa/cFS
that referenced
this pull request
Jun 8, 2021
- #263, bundle Combines: - nasa/cFE#1584, v6.8.0-rc1+dev642 - nasa/osal#1058, v5.1.0-rc1+dev500 - nasa/sch_lab#82, v2.4.0-rc1+dev36 Includes: - nasa/cFE#1580, Update ES verify errors to match test - nasa/cFE#1578, Resolve mismatched endforeach of CMakeList.txt - nasa/cFE#1579, Improve event filter documentation - nasa/cFE#1576, EVS/FS documentation cleanup - nasa/cFE#1575, Remove shell file subtype and clarify scope - nasa/cFE#1582, Simplify file open/truncate logic - nasa/cFE#1567, Remove deprecated elements - nasa/cFE#1556, Replace Header Content Type magic number - nasa/cFE#1553, Remove unused EVS LogMode defines - nasa/cFE#1570, Document cleanup from SB/MSG/SBR review, Remove unused CFE_SB_NO_SUBSCRIBERS - nasa/cFE#1565, Add CFE_SB_DestinationD tag and use for pointers - nasa/cFE#1564, Use CFE_MSG_SequenceCount_t for seqcnt type - nasa/cFE#1562, Document CFE_ES_PoolCreateEx NumBlockSizes error handling - nasa/cFE#1560, Documentation cleanup in TBL/TIME - nasa/cFE#1558, Document TblName as app specific - nasa/cFE#1563, use OSAL script to generate API guide - nasa/cFE#1557, Include verify headers to validate config - nasa/cFE#1555, add doxygen aliases for OSAL parameter/retvals - nasa/osal#1033, include doxygen targets locally - nasa/osal#1031, Document OS_ObjectIdToArrayIndex as public - nasa/osal#1040, resolve discrepancies between binsem API and unit tests - nasa/osal#1029, add missing clock retcode tests - nasa/osal#1046, resolve discrepancies between common API and unit tests - nasa/osal#1041, resolve discrepancies between countsem API and unit tests - nasa/osal#1045, resolve discrepancies between dir API and unit tests - nasa/osal#1043, resolve discrepancies between module API and unit tests - nasa/osal#1044, resolve discrepancies between mutex API and unit tests - nasa/osal#1038, resolve discrepancies between queue API and unit tests - nasa/osal#1037, resolve discrepancies between task API and unit tests - nasa/osal#1051, resolve discrepancies between timebase API and unit tests - nasa/osal#1030, check misc API return codes - nasa/osal#1039, Rename CodeQL cFE Build and add Duplicate Job - nasa/osal#1049, filter only whole words for keyword match - nasa/osal#962, update OSAL Config Guide link - nasa/sch_lab#81, exit the main loop if init fails - HOTFIX cFS-bundle, Use new osalguide logfile to fix documentation build workflow errors, Co-authored-by: Joseph Hickey <[email protected]> Co-authored-by: Jake Hageman skliper <[email protected]> Co-authored-by: Alex Campbell <[email protected]> Co-authored-by: Ariel Adams <[email protected]> Co-authored-by: Ross Peters <[email protected]>
jphickey
pushed a commit
to jphickey/osal
that referenced
this pull request
Aug 10, 2022
jphickey
pushed a commit
to jphickey/osal
that referenced
this pull request
Aug 10, 2022
…intMsg fix nasa#1030 change test_MSG to UT_DisplayPkt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Describe the contribution
Correct missing doxygen retvals and other discrepancies between test and documentation
Note, other tests were OK, but depend on support being enabled and supported by RTOS. Script will report N/A items (due to no impl) as missing. Confirmed OS_HeapGetInfo() is OK on RTEMS.
Fixes #1024
Testing performed
Run unit tests, revalidate test log against documentation
Expected behavior changes
No change to FSW, test/doc only
System(s) tested on
Ubuntu
RTEMS 4.11
Contributor Info - All information REQUIRED for consideration of pull request
Joseph Hickey, Vantage Systems, Inc.