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.

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

osal Integration candidate:2021-06-15 #1076

Merged
merged 32 commits into from
Jun 16, 2021
Merged

osal Integration candidate:2021-06-15 #1076

merged 32 commits into from
Jun 16, 2021

Conversation

astrogeco
Copy link
Contributor

@astrogeco astrogeco commented Jun 15, 2021

Tests

osal Checks https://github.com/nasa/osal/pull/1076/checks
cFS Bundle Checks https://github.com/nasa/cfs/issues/265/checks

Context

Part of nasa/cFS#265

Authors

@jphickey
@astrogeco
@pepepr08
@ArielSAdamsNASA
@skliper

Description

PR #1042

Fix #1025, Implement Coding Standard Rules in CodeQL

PR #1071

Fix #1068, rename doc to docs

PR #1065

Fix #1061, add mutex lock around UtAssert globals

PR #1056

Fix #1013, resolve discrepancies between file API and unit tests

PR #1057

Fix #1014, resolve discrepancies between filesys API and unit tests

PR #1055

Fix #1015, resolve discrepancies between idmap API and unit tests

PR #1064

Fix #1019, resolve discrepancies between select API and unit tests

PR #1060

Fix #1020, resolve discrepancies between socket API and unit tests

PR #1063

Fix #1062, const correct OS_SelectFdIsSet

PR #1073

HOTFIX:2021-06-15, Add missing OS_Select param doc

PR #1067

Fix #1036 Add Workflow to build and verify OSAL API Guide

PR #1070

Fix #1069, add detail design template

PR #1072

Fix #399, Update error codes and documentation

PR #1075

Fix #1074, Increase UT object limit for testing

jphickey and others added 29 commits May 27, 2021 12:00
Ensures correlation between the test cases and documented return
values for the OSAL file API.
Ensures correlation between the test cases and documented return
values for the OSAL filesys API.
Ensures correlation between the test cases and documented return
values for the OSAL idmap API.
Ensures correlation between the test cases and documented return
values for the OSAL socket API.
This function does not modify its "Set" argument, therefore
it should be qualified as "const".
Ensures correlation between the test cases and documented return
values for the OSAL select API.

This substantially overhauls the select-test to get better coverage
of the various features.
Adding a mutex around modifications to globals allows
UtAssert statements to be done from any test thread.
Also corrects various files where it referred to "doc"
This file indicates which input dirs to use for the cFE detail
design document.  It should be controlled with OSAL, as this
knows the detail of the directory tree.
Updates the documentation related to status code test/check, provide
description of how to check for any error status in a future-proof
manner.

Also updates the list of error code string conversions to match the
current set (some were missing).
…ds-codeql

Fix #1025, Implement Coding Standard Rules in CodeQL
Fix #1061, add mutex lock around UtAssert globals
Fix #1013, resolve discrepancies between file API and unit tests
Fix #1014, resolve discrepancies between filesys API and unit tests
Fix #1015, resolve discrepancies between idmap API and unit tests
Fix #1019, resolve discrepancies between select API and unit tests
Fix #1020, resolve discrepancies between socket API and unit tests
Fix usersguide doxygen warning for OS_SelectSingle and OS_SelectMultiple
msecs input parameter.
HOTFIX:2021-06-15, Add missing OS_Select param doc
Fix #1036 Add Workflow to build and verify OSAL API Guide
Fix #399, Update error codes and documentation
Fix #1074, Increase UT object limit for testing
Resolve directory name conflict with an added file and renamed "docs" directory
Replace build-osal-apiguide.yml with build-osal-documentation.yml to
match similar workflows across cFS components
@astrogeco astrogeco marked this pull request as ready for review June 16, 2021 18:59
@astrogeco astrogeco merged commit a3b7012 into main Jun 16, 2021
astrogeco added a commit to nasa/cFS that referenced this pull request Jun 17, 2021
nasa/cFE#1619 - cfe v6.8.0-rc1+dev693
nasa/osal#1076 - osal v5.1.0-rc1+dev530
nasa/PSP#296 - psp v1.5.0-rc1+dev118

*Documentation Updates:*

nasa/cFE#1598, Updated FS Read/WriteHeader API return documentation
nasa/cFE#1601, Document CFE_ES_RunLoop increment task counter behavior
nasa/cFE#1602, Document CFE_TBL_Unregister use-case
nasa/cFE#1603, Update version description per current design

*Standardize docs generation:*

nasa/cFE#1615, standardize on "docs" subdirectory
nasa/osal#1071, rename doc to docs
nasa/PSP#294, rename doc to docs

*Coding Standard:*

nasa/osal#1042
nasa/PSP#292

**Mutex for UTAssert**

nasa/cFE#1596, provide CFE assert lock/unlock
nasa/osal#1065, add mutex lock around UtAssert globals

*Resolve API-UT discrepancies:*

nasa/osal#1055, idmap API
nasa/osal#1056, file API
nasa/osal#1057, filesys API
nasa/osal#1060, socket API
nasa/osal#1064, select API

**Other cFE ixes**

nasa/cFE#1566, Simplify CFE_FS_SetTimestamp and fix syslog typo
nasa/cFE#1592, Removed redundant check/set of CFE_CPU_ID_VALUE
nasa/cFE#1593, add time get reference error bit
nasa/cFE#1600, Add workflow to build cFE documentation
nasa/cFE#1609, Requirements updates
nasa/cFE#1610, ES/ResourceID documentation cleanup
nasa/cFE#1613, allow multiple sources in add_cfe_coverage_test
nasa/cFE#1586, add ES Misc Functional test
nasa/cFE#1607, add Mempool functional tests
nasa/cFE#1605, Clean/simplify version header and reporting
nasa/cFE#1612, doxygen cleanup
nasa/cFE#1611, Prepend system log messages with function name

nasa/osal#1063, const correct OS_SelectFdIsSet
nasa/osal#1073, Fix OS_Select doxygen errors
nasa/osal#1073, Add missing OS_Select param doc
nasa/osal#1067, Add Workflow to build and verify OSAL API Guide
nasa/osal#1070, add detail design template
nasa/osal#1072, Update error codes and documentation
nasa/osal#1075, Increase UT object limit for testing

Co-authored-by: Jacob Hageman <skliper@users.noreply.github.com>
Co-authored-by: Joseph Hickey <jphickey@users.noreply.github.com>
Co-authored-by: Ariel Adams <ArielSAdamsNASA@users.noreply.github.com>
Co-authored-by: Alex Campbell <zanzaben@users.noreply.github.com>
Co-authored-by: Jose F Martinez Pedraza <pepepr08@users.noreply.github.com>
astrogeco added a commit to nasa/cFS that referenced this pull request Jun 17, 2021
nasa/cFE#1619 - cfe v6.8.0-rc1+dev693
nasa/osal#1076 - osal v5.1.0-rc1+dev530
nasa/PSP#296 - psp v1.5.0-rc1+dev118

*Documentation Updates:*

nasa/cFE#1598, Updated FS Read/WriteHeader API return documentation
nasa/cFE#1601, Document CFE_ES_RunLoop increment task counter behavior
nasa/cFE#1602, Document CFE_TBL_Unregister use-case
nasa/cFE#1603, Update version description per current design

*Standardize docs generation:*

nasa/cFE#1615, standardize on "docs" subdirectory
nasa/osal#1071, rename doc to docs
nasa/PSP#294, rename doc to docs

*Coding Standard:*

nasa/osal#1042
nasa/PSP#292

**Mutex for UTAssert**

nasa/cFE#1596, provide CFE assert lock/unlock
nasa/osal#1065, add mutex lock around UtAssert globals

*Resolve API-UT discrepancies:*

nasa/osal#1055, idmap API
nasa/osal#1056, file API
nasa/osal#1057, filesys API
nasa/osal#1060, socket API
nasa/osal#1064, select API

**Other cFE Fixes**

nasa/cFE#1566, Simplify CFE_FS_SetTimestamp and fix syslog typo
nasa/cFE#1592, Removed redundant check/set of CFE_CPU_ID_VALUE
nasa/cFE#1593, add time get reference error bit
nasa/cFE#1600, Add workflow to build cFE documentation
nasa/cFE#1609, Requirements updates
nasa/cFE#1610, ES/ResourceID documentation cleanup
nasa/cFE#1613, allow multiple sources in add_cfe_coverage_test
nasa/cFE#1586, add ES Misc Functional test
nasa/cFE#1607, add Mempool functional tests
nasa/cFE#1605, Clean/simplify version header and reporting
nasa/cFE#1612, doxygen cleanup
nasa/cFE#1611, Prepend system log messages with function name

**Other osal Fixes**

nasa/osal#1063, const correct OS_SelectFdIsSet
nasa/osal#1073, Fix OS_Select doxygen errors
nasa/osal#1073, Add missing OS_Select param doc
nasa/osal#1067, Add Workflow to build and verify OSAL API Guide
nasa/osal#1070, add detail design template
nasa/osal#1072, Update error codes and documentation
nasa/osal#1075, Increase UT object limit for testing

Co-authored-by: Jacob Hageman <skliper@users.noreply.github.com>
Co-authored-by: Joseph Hickey <jphickey@users.noreply.github.com>
Co-authored-by: Ariel Adams <ArielSAdamsNASA@users.noreply.github.com>
Co-authored-by: Alex Campbell <zanzaben@users.noreply.github.com>
Co-authored-by: Jose F Martinez Pedraza <pepepr08@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
Fix nasa#449, Add OS_printf to CFE_ES_SYSLOG_APPEND
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment