Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix #1016, resolve discrepancies between module API and unit tests #1043

Merged
merged 1 commit into from
Jun 1, 2021
Merged

Fix #1016, resolve discrepancies between module API and unit tests #1043

merged 1 commit into from
Jun 1, 2021

Conversation

jphickey
Copy link
Contributor

Describe the contribution
Ensures correlation between the unit-tests and documented return values for the OSAL module API.

Fixes #1016

Testing performed
Build and run unit tests, re-run cross reference script to confirm

Expected behavior changes
All documented return values are tested or noted that they cannot be tested in functional test

System(s) tested on
Ubuntu

Contributor Info - All information REQUIRED for consideration of pull request
Joseph Hickey, Vantage Systems, Inc.

skliper
skliper reviewed May 24, 2021
View reviewed changes
Copy link
Contributor

@skliper skliper left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Add OS_ModuleUnload test with UNDEFINED ID returns INVALID ID, separate OS_ModuleInfo NULL and UNDEFINED ID test (overloaded, only checks for invalid pointer).
  • OS_SymbolTableDump document OS_ERR_OUTPUT_TOO_LARGE and test with a size 0.
  • OS_ModuleSymbolLookup overloads the error test, needs test with UNDEFINED ID returns INVALID ID

@jphickey
Copy link
Contributor Author

See also #1052, my plan is to do another scrub of all tests to ensure OS_ERR_INVALID_ID is validated with both UNDEFINED and a nonzero bad ID value.

@jphickey
Copy link
Contributor Author

Commit f384359 adds documentation and a test case for the OS_SymbolTableDump routines.

@jphickey jphickey added the CCB:Ready Pull request is ready for discussion at the Configuration Control Board (CCB) label May 25, 2021
skliper
skliper previously requested changes May 25, 2021
View reviewed changes
Copy link
Contributor

@skliper skliper left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still needs fixing:

osal/src/unit-tests/osloader-test/ut_osloader_symtable_test.c

Line 134 in ebc789a

UT_RETVAL(OS_ModuleSymbolLookup(OS_OBJECT_ID_UNDEFINED, 0, "Sym"), OS_INVALID_POINTER);

@skliper skliper dismissed their stale review May 26, 2021 13:43

This will be fixed in #1052

@astrogeco astrogeco added the CCB:Approved Indicates code review and approval by community CCB label May 26, 2021
@jphickey
Fix nasa#1016, resolve discrepancies between module API and unit tests
b420e8d 
Ensures correlation between the unit-tests and documented return
values for the OSAL module API.

Adds documentation for OS_ERR_OUTPUT_TOO_LARGE and
OS_ERR_NAME_TOO_LONG.  These are primarily validated
via coverage test, as symbol table dump is only
possible on VxWorks.

Move the test for OS_INVALID_POINTER to after setup,
where the module ID is valid.
@jphickey jphickey force-pushed the fix-1016-module-api-retcodes branch from ebc789a to b420e8d Compare May 26, 2021 17:52
@jphickey
Copy link
Contributor Author

Re-Pushed to correct commit message typo and squash commits where necessary

@jphickey jphickey changed the title Fix #1016, resolve descrepancies between module API and unit tests Fix #1016, resolve discrepancies between module API and unit tests May 27, 2021
@astrogeco astrogeco removed the CCB:Ready Pull request is ready for discussion at the Configuration Control Board (CCB) label May 27, 2021
@astrogeco astrogeco changed the base branch from main to integration-candidate June 1, 2021 17:15
@astrogeco astrogeco mentioned this pull request Jun 1, 2021
Merged
@astrogeco astrogeco merged commit 976d1fa into nasa:integration-candidate Jun 1, 2021
astrogeco added a commit to nasa/cFS that referenced this pull request Jun 1, 2021
@astrogeco
IC:2021-06-01, Add osal PRs
97224f1 
Update nasa/osal#1058

Includes:

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
@astrogeco astrogeco mentioned this pull request Jun 4, 2021
Merged
@jphickey jphickey deleted the fix-1016-module-api-retcodes branch June 8, 2021 18:22
astrogeco added a commit to nasa/cFS that referenced this pull request Jun 8, 2021
@astrogeco
IC:2021-06-01, cfe, osal, sch_lab
2cf3638 
- #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
@astrogeco @jphickey
@skliper @zanzaben @ArielSAdamsNASA @rosspeters6
IC:2021-06-01, cfe, osal, sch_lab
b0c92ee 
- #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 <jphickey@users.noreply.github.com>
Co-authored-by: Jake Hageman skliper <skliper@users.noreply.github.com>
Co-authored-by: Alex Campbell <zanzaben@users.noreply.github.com>
Co-authored-by: Ariel Adams <ArielSAdamsNASA@users.noreply.github.com>
Co-authored-by: Ross Peters <rosspeters6@users.noreply.github.com>
@skliper skliper added this to the 6.0.0 milestone Sep 24, 2021
jphickey pushed a commit to jphickey/osal that referenced this pull request Aug 10, 2022
@astrogeco
Merge pull request nasa#1043 from jphickey/fix-1042-osal-header
e77486a 
Fix nasa#1042, remove use of osapi-os-loader.h
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@skliper skliper skliper approved these changes

Assignees
No one assigned
Labels
CCB:Approved Indicates code review and approval by community CCB
Projects
None yet
Milestone
Caelum
Development

Successfully merging this pull request may close these issues.

Unit test status code discrepancies in osapi-module.h
3 participants
@jphickey @skliper @astrogeco