Fix #179, Implement Coding Standard in CodeQL #180
Merged
Conversation
This file contains 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
ArielSAdamsNASA
added
CCB:Ready
ArielSAdamsNASA
force-pushed
the
fix-179-implement-coding-standard-codeql
branch
from
38dd188
to
746268a
Compare
ArielSAdamsNASA
force-pushed
the
fix-179-implement-coding-standard-codeql
branch
from
746268a
to
bcd991b
Compare
|
Removed configuration files and used cFS configuration files instead. CodeQL workflow is not successful. Error "The configuration file "nasa/cFS/.github/codeql/codeql-coding-standard.yml@main" is invalid: property "queries.uses" is invalid as the local path "codeql/cpp/ql/src/JPL_C" does not exist in the repository". Tested locally, error goes away when full path of queries are used in cFS/.github/codeql/codeql-coding-standard.yml. For example, instead of ./codeql/cpp/ql/src/JPL_C use github/codeql/cpp/ql/src/JPL_C@main. Some repositories such as cFE does not require the full path. Created PR for cFS to resolve this issue: nasa/cFS#262 |
astrogeco
removed
the
CCB:Ready
astrogeco
added a commit
to nasa/cFS
that referenced
this pull request
Jun 10, 2021
*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 *Implement Coding Standard:* nasa/ci_lab#87 nasa/sample_app#149 nasa/sample_lib#63 nasa/sch_lab#79 nasa/to_lab#98 nasa/cFS-GroundSystem#180 nasa/elf2cfetbl#80 nasa/tblCRCTool#48 nasa/osal#1042 nasa/PSP#292
astrogeco
added a commit
to nasa/cFS
that referenced
this pull request
Jun 23, 2021
nasa/cFS-GroundSystem#182, Add test start command script for cmdUtil nasa/tblCRCTool#51, add printf conversion casts **Coding Standard** tblCRCTool#49, Implement Coding Standard in CodeQL nasa/cFS-GroundSystem#180, Implement Coding Standard in CodeQL
This was referenced Jun 23, 2021
astrogeco
added a commit
to nasa/cFS
that referenced
this pull request
Jun 24, 2021
*Combines* - nasa/elf2cfetbl#81 - nasa/tblCRCTool#52 - nasa/ci_lab#88 - nasa/sch_lab#83 - nasa/sample_app#150 - nasa/sample_lib#64 - nasa/to_lab#100 *Includes* - nasa/cFE#1630, correct path to users guide warning log - nasa/cFE#1621, add additional test cases for Child Tasks - nasa/cFE#1608, Add cfe functional tests to CI - nasa/cFE#1627, rename/clean CFE coverage assert macros - nasa/cFE#1623, Added UT tests for cFE ES Api - nasa/cFE#1634, Expand CDS Functional Tests. - nasa/cFE#1633, add test log file - nasa/cFE#1594, Event ID updates - nasa/cFE#1624, scrub all UT_Report calls - nasa/osal#1066, implement missing parameter/retcode test permutations - nasa/cFS-GroundSystem#182, Add test start command script for cmdUtil - nasa/tblCRCTool#51, add printf conversion casts ** Implement Coding Standard in CodeQL ** - nasa/cFS-GroundSystem#180 - nasa/elf2cfetbl#80 - nasa/tblCRCTool#49 - nasa/ci_lab#87 - nasa/sch_lab#79 - nasa/sample_app#149 - nasa/sample_lib#63 - nasa/to_lab#99
astrogeco
added a commit
to nasa/cFS
that referenced
this pull request
Jun 24, 2021
*Combines* - nasa/cFE#1632, v6.8.0-rc1+dev726 - nasa/osal#1079, v5.1.0-rc1+dev548 - nasa/ci_lab#88, v2.4.0-rc1+dev42 - nasa/sch_lab#83, v2.4.0-rc1+dev40 - nasa/sample_app#150, v1.2.0-rc1+dev66 - nasa/sample_lib#64, v1.2.0-rc1+dev38 - nasa/to_lab#100, v2.4.0-rc1+dev49 - nasa/elf2cfetbl#81, v3.2.0-rc1+dev30 - nasa/tblCRCTool#52, v1.2.0-rc1+dev33 - nasa/cFS-GroundSystem#183, v2.2.0-rc1+dev52 *Includes* - nasa/cFE#1630, correct path to users guide warning log - nasa/cFE#1621, add additional test cases for Child Tasks - nasa/cFE#1608, Add cfe functional tests to CI - nasa/cFE#1627, rename/clean CFE coverage assert macros - nasa/cFE#1623, Added UT tests for cFE ES Api - nasa/cFE#1634, Expand CDS Functional Tests. - nasa/cFE#1633, add test log file - nasa/cFE#1594, Event ID updates - nasa/cFE#1624, scrub all UT_Report calls - nasa/osal#1066, implement missing parameter/retcode test permutations - nasa/cFS-GroundSystem#182, Add test start command script for cmdUtil - nasa/tblCRCTool#51, add printf conversion casts ** Implement Coding Standard in CodeQL ** - nasa/cFS-GroundSystem#180 - nasa/elf2cfetbl#80 - nasa/tblCRCTool#49 - nasa/ci_lab#87 - nasa/sch_lab#79 - nasa/sample_app#149 - nasa/sample_lib#63 - nasa/to_lab#99 Co-authored-by: Jacob 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: Jose F Martinez Pedraza <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Fix #179
Added the duplicate jobs action to avoid duplicate jobs from running. Added a separate job for coding standard queries. Created two configuration files, one for default queries and security queries and another for jpl rules. Removed push on main branch so when users push code to their forked repos, the workflow runs. Added main branch to pull request, so CodeQL runs on pull request made in the main branch. This is the same logic used in the cFS bundle repo.
Testing performed
Testing done on cFE forked repository, ArielSAdamsNASA/cFE which used the same files, but with different configuration paths.
Jobs were failing when the entire path of the configuration file were not used. Have to use nasa/cFE/.github/codeql/config-name@branch-name. The branch must be included in the path.
The CodeQL analysis workflow will fail for this PR since it is calling for a configuration file in main the main branch. It will not work until the configuration files are merged into main.
In the screenshot is the same workflow as in this pull request, but the configuration path is changed to the forked repo and tested branch.
Expected behavior changes
There should be one job for security queries and one job for JPL and MISRA queries.
Describe alternatives you've considered
Can allow all branches to run CodeQL for pull requests as seen in cFE and PSP instead of just the main branch like cFS.
Third party code
Skip duplicate workflows license: https://github.com/fkirc/skip-duplicate-actions/blob/master/LICENSE
CodeQL license: https://github.com/github/codeql-action/blob/main/LICENSE
Contributor Info - All information REQUIRED for consideration of pull request
Ariel Adams, ASRC Federal