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

Fix #986, Show CodeQL Preview #987

Merged
merged 1 commit into from
May 19, 2021
Merged

Fix #986, Show CodeQL Preview #987

merged 1 commit into from
May 19, 2021

Conversation

ArielSAdamsNASA
Copy link
Contributor

@ArielSAdamsNASA ArielSAdamsNASA commented May 6, 2021

Describe the contribution
Fix #986
Checkout just the osal repository rather than the entire cFS bundle to allow CodeQL to provide a code preview.
Code preview is not available when the entire cFS bundle is checked out. The osal itself must be the only repository checked out.
Since the tests require the cFE repo, they are removed.

Testing performed
Tested locally on forked repository
image

Tested on this PR. Example of code scanning result found here: https://github.com/nasa/osal/security/code-scanning/142?query=ref%3Arefs%2Fpull%2F987%2Fmerge
Expected behavior changes
Code preview should be available in the osal repository.

Additional context
Tests are not used.

Contributor Info - All information REQUIRED for consideration of pull request
Ariel Adams, ASRC Federal

@ArielSAdamsNASA ArielSAdamsNASA added CCB:Ready Pull request is ready for discussion at the Configuration Control Board (CCB) continuous-integration labels May 6, 2021
make prep

cp Makefile.sample Makefile
make ENABLE_UNIT_TESTS=true PERMISSIVE_MODE=true prep
Copy link
Contributor

Choose a reason for hiding this comment

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

Recommend either using all env settings or all specified on the make line, looks like at minimum ENABLE_UNIT_TESTS is set in both locations.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Set PERMISSIVE_MODE in env settings and remove ENABLE_UNIT_TESTS in make command.

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.

One impact of this change is now the analysis is run using the osal default configuration, vs what is specified in cFE. Probably OK as long as the cFE still does CodeQL, but then need to keep aware of OSAL warnings in that context. Eventually we probably want at least 2 CodeQL analysis runs in OSAL to exercise a range of options.

@ArielSAdamsNASA
Copy link
Contributor Author

One impact of this change is now the analysis is run using the osal default configuration, vs what is specified in cFE. Probably OK as long as the cFE still does CodeQL, but then need to keep aware of OSAL warnings in that context. Eventually we probably want at least 2 CodeQL analysis runs in OSAL to exercise a range of options.

Renamed newly created CodeQL workflow as codeql-default-build to allow two analysis runs of CodeQL.

@ArielSAdamsNASA ArielSAdamsNASA removed the CCB:Ready Pull request is ready for discussion at the Configuration Control Board (CCB) label May 6, 2021
@ArielSAdamsNASA ArielSAdamsNASA marked this pull request as draft May 6, 2021 18:38
@ArielSAdamsNASA ArielSAdamsNASA marked this pull request as ready for review May 6, 2021 18:45
@ArielSAdamsNASA ArielSAdamsNASA added the CCB:Ready Pull request is ready for discussion at the Configuration Control Board (CCB) label May 7, 2021
@ArielSAdamsNASA
Copy link
Contributor Author

Renamed workflow to codeql-osal-default.

@astrogeco astrogeco added CCB:Approved Indicates code review and approval by community CCB and removed CCB:Ready Pull request is ready for discussion at the Configuration Control Board (CCB) labels May 12, 2021
@astrogeco
Copy link
Contributor

Should we add the "check for duplicates" workflow to this?

@ArielSAdamsNASA
Copy link
Contributor Author

Should we add the "check for duplicates" workflow to this?

Yes! Thanks for the reminder, just added it.

@astrogeco astrogeco changed the base branch from main to integration-candidate May 19, 2021 02:22
@astrogeco astrogeco merged commit 34767d7 into nasa:integration-candidate May 19, 2021
astrogeco added a commit to nasa/cFS that referenced this pull request May 19, 2021
nasa/cFE#1491, Correctly format code block section terminator
nasa/cFE#1530, Fix #1550, typos in developer guide

nasa/osal#987, Show CodeQL Preview
astrogeco added a commit to nasa/cFS that referenced this pull request May 19, 2021
nasa/cFE#1491, Correctly format code block section terminator
nasa/cFE#1530, Fix typos in developer guide

nasa/osal#987, Show CodeQL Preview
astrogeco added a commit to nasa/cFS that referenced this pull request May 19, 2021
Combines:

nasa/cFE#1508, cFE v6.8.0-rc1+dev580
nasa/osal#1006, osal v5.1.0-rc1+dev452

Includes:

nasa/cFE#1482, Resolve sequence count auto-increment rollover bug
nasa/cFE#1491, Correctly format code block section terminator
nasa/cFE#1530, Fix typos in developer guide

nasa/osal#985, rename hooks to handlers
nasa/osal#1000, propagate status code in OS_rmdir
nasa/osal#1001, rework "unit-tests" to use macros
nasa/osal#1003, remove extra newlines in utassert logs
nasa/osal#990, Add test for object id inline functions
nasa/osal#998, fixed invalid inputs for OS_mkdir
nasa/osal#812, Improves config guide documentation
nasa/osal#987, Show CodeQL Preview
astrogeco added a commit to nasa/cFS that referenced this pull request May 19, 2021
Combines:

nasa/cFE#1508, cFE v6.8.0-rc1+dev580
nasa/osal#1006, osal v5.1.0-rc1+dev452

Includes:

nasa/cFE#1482, Resolve sequence count auto-increment rollover bug
nasa/cFE#1491, Correctly format code block section terminator
nasa/cFE#1530, Fix typos in developer guide

nasa/osal#985, rename hooks to handlers
nasa/osal#1000, propagate status code in OS_rmdir
nasa/osal#1001, rework "unit-tests" to use macros
nasa/osal#1003, remove extra newlines in utassert logs
nasa/osal#990, Add test for object id inline functions
nasa/osal#998, fixed invalid inputs for OS_mkdir
nasa/osal#812, Improves config guide documentation
nasa/osal#987, Show CodeQL Preview

Co-Authored-By: Jake Hageman <[email protected]>
Co-Authored-By: Joseph Hickey <[email protected]>
Co-Authored-By: Ariel Adams <[email protected]>
Co-Authored-By: Alex Campbell <[email protected]>
Co-Authored-By: Tobias Nießen <[email protected]>
Co-Authored-By: Jonathan Bohren <[email protected]>
Co-Authored-By: Andrei Tumbar <[email protected]>
@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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CCB:Approved Indicates code review and approval by community CCB continuous-integration
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Show CodeQL Preview
3 participants