Skip to content

Implement MISRA RULE-21-13 and RULE-21-15 #190

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

Merged
merged 44 commits into from
Mar 25, 2023

Conversation

jeongsoolee09
Copy link
Contributor

@jeongsoolee09 jeongsoolee09 commented Feb 16, 2023

Description

Implement RULE-21-13 and RULE-21-15 from MISRA.

Change request type

  • Release or process automation (GitHub workflows, internal scripts)
  • Internal documentation
  • External documentation
  • Query files (.ql, .qll, .qls or unit tests)
  • External scripts (analysis report or other code shipped as part of a release)

Rules with added or modified queries

  • No rules added
  • Queries have been added for the following rules:
    • RULE-21-13
    • RULE-21-15
  • Queries have been modified for the following rules:

Release change checklist

A change note (development_handbook.md#change-notes) is required for any pull request which modifies:

  • The structure or layout of the release artifacts.
  • The evaluation performance (memory, execution time) of an existing query.
  • The results of an existing query in any circumstance.

If you are only adding new rule queries, a change note is not required.

Author: Is a change note required?

  • Yes
  • No

🚨🚨🚨
Reviewer: Confirm that format of shared queries (not the .qll file, the
.ql file that imports it) is valid by running them within VS Code.

  • Confirmed

Reviewer: Confirm that either a change note is not required or the change note is required and has been added.

  • Confirmed

Query development review checklist

For PRs that add new queries or modify existing queries, the following checklist should be completed by both the author and reviewer:

Author

  • Have all the relevant rule package description files been checked in?
  • Have you verified that the metadata properties of each new query is set appropriately?
  • Do all the unit tests contain both "COMPLIANT" and "NON_COMPLIANT" cases?
  • Are the alert messages properly formatted and consistent with the style guide?
  • Have you run the queries on OpenPilot and verified that the performance and results are acceptable?
    As a rule of thumb, predicates specific to the query should take no more than 1 minute, and for simple queries be under 10 seconds. If this is not the case, this should be highlighted and agreed in the code review process.
  • Does the query have an appropriate level of in-query comments/documentation?
  • Have you considered/identified possible edge cases?
  • Does the query not reinvent features in the standard library?
  • Can the query be simplified further (not golfed!)

Reviewer

  • Have all the relevant rule package description files been checked in?
  • Have you verified that the metadata properties of each new query is set appropriately?
  • Do all the unit tests contain both "COMPLIANT" and "NON_COMPLIANT" cases?
  • Are the alert messages properly formatted and consistent with the style guide?
  • Have you run the queries on OpenPilot and verified that the performance and results are acceptable?
    As a rule of thumb, predicates specific to the query should take no more than 1 minute, and for simple queries be under 10 seconds. If this is not the case, this should be highlighted and agreed in the code review process.
  • Does the query have an appropriate level of in-query comments/documentation?
  • Have you considered/identified possible edge cases?
  • Does the query not reinvent features in the standard library?
  • Can the query be simplified further (not golfed!)

@jeongsoolee09 jeongsoolee09 marked this pull request as draft February 16, 2023 17:02
@github-actions

This comment was marked as outdated.

@github-actions
Copy link

🤖 Beep Boop! Matrix Testing for this PR has been initiated. Please check back later for results.

💡 If you do not hear back from me please check my status! I will report even if this PR does not contain files eligible for matrix testing.

@github-actions
Copy link

🤖 Beep Boop! Matrix Testing for this PR has been initiated. Please check back later for results.

💡 If you do not hear back from me please check my status! I will report even if this PR does not contain files eligible for matrix testing.

@github-actions
Copy link

🤖 Beep Boop! Matrix Testing for this PR has been initiated. Please check back later for results.

💡 If you do not hear back from me please check my status! I will report even if this PR does not contain files eligible for matrix testing.

@github-actions
Copy link

🤖 Beep Boop! Matrix Testing for this PR has been initiated. Please check back later for results.

💡 If you do not hear back from me please check my status! I will report even if this PR does not contain files eligible for matrix testing.

@github-actions
Copy link

🤖 Beep Boop! Matrix Testing for this PR has been initiated. Please check back later for results.

💡 If you do not hear back from me please check my status! I will report even if this PR does not contain files eligible for matrix testing.

@github-actions
Copy link

🤖 Beep Boop! Matrix Testing for this PR has been initiated. Please check back later for results.

💡 If you do not hear back from me please check my status! I will report even if this PR does not contain files eligible for matrix testing.

@github-actions
Copy link

🤖 Beep Boop! Matrix Testing for this PR has been initiated. Please check back later for results.

💡 If you do not hear back from me please check my status! I will report even if this PR does not contain files eligible for matrix testing.

@jeongsoolee09 jeongsoolee09 marked this pull request as ready for review February 18, 2023 01:01
@github-actions
Copy link

🤖 Beep Boop! Matrix Testing for this PR has been initiated. Please check back later for results.

💡 If you do not hear back from me please check my status! I will report even if this PR does not contain files eligible for matrix testing.

…ub/codeql-coding-standards into jeongsoolee09/MISRA_21-13_and-21-15
@jsinglet
Copy link
Contributor

🤖 Beep Boop! clang/cpp/X86_64 Matrix Testing for this PR has been completed but I didn't find anything to test!

@jsinglet
Copy link
Contributor

🤖 Beep Boop! gcc/cpp/X86_64 Matrix Testing for this PR has been completed but I didn't find anything to test!

@jsinglet
Copy link
Contributor

🤖 Beep Boop! clang/c/X86_64 Matrix Testing for this PR has been completed. See below for the results!


RULE                 : RULE-21-13
COMPILE_ERROR_OUTPUT : 
TEST_PASS            : True
SUITE                : MISRA-C-2012
QUERY                : CtypeFunctionArgNotUnsignedCharOrEof
COMPILE_PASS         : True
PACKAGE              : StandardLibraryFunctionTypes
TEST_DIFFERENCE      : 

RULE                 : RULE-21-15
COMPILE_ERROR_OUTPUT : 
TEST_PASS            : True
SUITE                : MISRA-C-2012
QUERY                : MemcpyMemmoveMemcmpArgNotPointersToCompatibleTypes
COMPILE_PASS         : True
PACKAGE              : StandardLibraryFunctionTypes
TEST_DIFFERENCE      : 


@jsinglet
Copy link
Contributor

🤖 Beep Boop! gcc/c/X86_64 Matrix Testing for this PR has been completed. See below for the results!


TEST_DIFFERENCE      : --- expected
                       +++ actual
                       @@ -1,2 +1,2 @@
                       -| test.c:14:7:14:13 | call to isalnum | The <ctype.h> function call to isalnum accepts an argument c3 that is not an unsigned char nor an EOF. |
                       -| test.c:20:7:20:13 | call to isalnum | The <ctype.h> function call to isalnum accepts an argument c4 that is not an unsigned char nor an EOF. |
                       +| test.c:14:7:14:17 | isalnum(c) | The <ctype.h> function isalnum(c) accepts an argument (...) that is not an unsigned char nor an EOF. |
                       +| test.c:20:7:20:17 | isalnum(c) | The <ctype.h> function isalnum(c) accepts an argument (...) that is not an unsigned char nor an EOF. |
                       [1/1 comp 43.4s eval 1.8s] FAILED(RESULT) /__w/codeql-coding-standards-release-engineering/codeql-coding-standards-release-engineering/codeql-coding-standards/c/misra/test/rules/RULE-21-13/CtypeFunctionArgNotUnsignedCharOrEof.qlref
                       
QUERY                : CtypeFunctionArgNotUnsignedCharOrEof
SUITE                : MISRA-C-2012
COMPILE_ERROR_OUTPUT : 
COMPILE_PASS         : True
PACKAGE              : StandardLibraryFunctionTypes
TEST_PASS            : False
RULE                 : RULE-21-13

TEST_DIFFERENCE      : 
QUERY                : MemcpyMemmoveMemcmpArgNotPointersToCompatibleTypes
SUITE                : MISRA-C-2012
COMPILE_ERROR_OUTPUT : 
COMPILE_PASS         : True
PACKAGE              : StandardLibraryFunctionTypes
TEST_PASS            : True
RULE                 : RULE-21-15


@github-actions
Copy link

🤖 Beep Boop! Matrix Testing for this PR has been initiated. Please check back later for results.

💡 If you do not hear back from me please check my status! I will report even if this PR does not contain files eligible for matrix testing.

@jsinglet
Copy link
Contributor

🤖 Beep Boop! qcc/cpp/AARCH64LE Matrix Testing for this PR has been completed but I didn't find anything to test!

@jsinglet
Copy link
Contributor

🤖 Beep Boop! gcc/cpp/X86_64 Matrix Testing for this PR has been completed but I didn't find anything to test!

@jsinglet
Copy link
Contributor

🤖 Beep Boop! clang/cpp/X86_64 Matrix Testing for this PR has been completed but I didn't find anything to test!

@jsinglet
Copy link
Contributor

🤖 Beep Boop! clang/c/X86_64 Matrix Testing for this PR has been completed. See below for the results!


SUITE                : MISRA-C-2012
COMPILE_ERROR_OUTPUT : 
TEST_DIFFERENCE      : 
RULE                 : RULE-21-13
PACKAGE              : StandardLibraryFunctionTypes
COMPILE_PASS         : True
TEST_PASS            : True
QUERY                : CtypeFunctionArgNotUnsignedCharOrEof

SUITE                : MISRA-C-2012
COMPILE_ERROR_OUTPUT : 
TEST_DIFFERENCE      : 
RULE                 : RULE-21-15
PACKAGE              : StandardLibraryFunctionTypes
COMPILE_PASS         : True
TEST_PASS            : True
QUERY                : MemcpyMemmoveMemcmpArgNotPointersToCompatibleTypes


@jsinglet
Copy link
Contributor

🤖 Beep Boop! gcc/c/X86_64 Matrix Testing for this PR has been completed. See below for the results!


TEST_PASS            : False
COMPILE_PASS         : True
PACKAGE              : StandardLibraryFunctionTypes
TEST_DIFFERENCE      : --- expected
                       +++ actual
                       @@ -1,2 +1,2 @@
                       -| test.c:14:7:14:13 | call to isalnum | The <ctype.h> function call to isalnum accepts an argument c3 that is not an unsigned char nor an EOF. |
                       -| test.c:20:7:20:13 | call to isalnum | The <ctype.h> function call to isalnum accepts an argument c4 that is not an unsigned char nor an EOF. |
                       +| test.c:14:7:14:17 | isalnum(c) | The <ctype.h> function isalnum(c) accepts an argument (...) that is not an unsigned char nor an EOF. |
                       +| test.c:20:7:20:17 | isalnum(c) | The <ctype.h> function isalnum(c) accepts an argument (...) that is not an unsigned char nor an EOF. |
                       [1/1 comp 40.6s eval 1.8s] FAILED(RESULT) /__w/codeql-coding-standards-release-engineering/codeql-coding-standards-release-engineering/codeql-coding-standards/c/misra/test/rules/RULE-21-13/CtypeFunctionArgNotUnsignedCharOrEof.qlref
                       
COMPILE_ERROR_OUTPUT : 
SUITE                : MISRA-C-2012
RULE                 : RULE-21-13
QUERY                : CtypeFunctionArgNotUnsignedCharOrEof

TEST_PASS            : True
COMPILE_PASS         : True
PACKAGE              : StandardLibraryFunctionTypes
TEST_DIFFERENCE      : 
COMPILE_ERROR_OUTPUT : 
SUITE                : MISRA-C-2012
RULE                 : RULE-21-15
QUERY                : MemcpyMemmoveMemcmpArgNotPointersToCompatibleTypes


@jsinglet
Copy link
Contributor

🤖 Beep Boop! qcc/cpp/AARCH64LE Matrix Testing for this PR has been completed but I didn't find anything to test!

@jsinglet
Copy link
Contributor

🤖 Beep Boop! qcc/c/AARCH64LE Matrix Testing for this PR has been completed. See below for the results!


COMPILE_ERROR_OUTPUT : 
TEST_DIFFERENCE      : 
SUITE                : MISRA-C-2012
COMPILE_PASS         : True
PACKAGE              : StandardLibraryFunctionTypes
RULE                 : RULE-21-13
TEST_PASS            : True
QUERY                : CtypeFunctionArgNotUnsignedCharOrEof

COMPILE_ERROR_OUTPUT : 
TEST_DIFFERENCE      : 
SUITE                : MISRA-C-2012
COMPILE_PASS         : True
PACKAGE              : StandardLibraryFunctionTypes
RULE                 : RULE-21-15
TEST_PASS            : True
QUERY                : MemcpyMemmoveMemcmpArgNotPointersToCompatibleTypes


@jsinglet
Copy link
Contributor

🤖 Beep Boop! Matrix Testing for this PR has been completed. If no reports were posted it means this PR does not contain things that need matrix testing!

@jsinglet
Copy link
Contributor

🤖 Beep Boop! qcc/c/AARCH64LE Matrix Testing for this PR has been completed. See below for the results!


COMPILE_PASS         : True
TEST_DIFFERENCE      : 
PACKAGE              : StandardLibraryFunctionTypes
TEST_PASS            : True
COMPILE_ERROR_OUTPUT : 
QUERY                : CtypeFunctionArgNotUnsignedCharOrEof
RULE                 : RULE-21-13
SUITE                : MISRA-C-2012

COMPILE_PASS         : True
TEST_DIFFERENCE      : 
PACKAGE              : StandardLibraryFunctionTypes
TEST_PASS            : True
COMPILE_ERROR_OUTPUT : 
QUERY                : MemcpyMemmoveMemcmpArgNotPointersToCompatibleTypes
RULE                 : RULE-21-15
SUITE                : MISRA-C-2012


@jsinglet
Copy link
Contributor

🤖 Beep Boop! Matrix Testing for this PR has been completed. If no reports were posted it means this PR does not contain things that need matrix testing!

@github-actions
Copy link

🤖 Beep Boop! Matrix Testing for this PR has been initiated. Please check back later for results.

💡 If you do not hear back from me please check my status! I will report even if this PR does not contain files eligible for matrix testing.

@jsinglet
Copy link
Contributor

🤖 Beep Boop! qcc/cpp/AARCH64LE Matrix Testing for this PR won't happen because it is outside of license window!

@jsinglet
Copy link
Contributor

🤖 Beep Boop! qcc/c/AARCH64LE Matrix Testing for this PR won't happen because it is outside of license window!

@jsinglet
Copy link
Contributor

🤖 Beep Boop! gcc/cpp/X86_64 Matrix Testing for this PR has been completed but I didn't find anything to test!

@jsinglet
Copy link
Contributor

🤖 Beep Boop! clang/cpp/X86_64 Matrix Testing for this PR has been completed but I didn't find anything to test!

@jsinglet
Copy link
Contributor

🤖 Beep Boop! gcc/c/X86_64 Matrix Testing for this PR has been completed. See below for the results!


SUITE                : MISRA-C-2012
COMPILE_PASS         : True
TEST_PASS            : True
TEST_DIFFERENCE      : 
COMPILE_ERROR_OUTPUT : 
QUERY                : CtypeFunctionArgNotUnsignedCharOrEof
RULE                 : RULE-21-13
PACKAGE              : StandardLibraryFunctionTypes

SUITE                : MISRA-C-2012
COMPILE_PASS         : True
TEST_PASS            : True
TEST_DIFFERENCE      : 
COMPILE_ERROR_OUTPUT : 
QUERY                : MemcpyMemmoveMemcmpArgNotPointersToCompatibleTypes
RULE                 : RULE-21-15
PACKAGE              : StandardLibraryFunctionTypes


@jsinglet
Copy link
Contributor

🤖 Beep Boop! clang/c/X86_64 Matrix Testing for this PR has been completed. See below for the results!


COMPILE_PASS         : True
TEST_PASS            : True
RULE                 : RULE-21-13
QUERY                : CtypeFunctionArgNotUnsignedCharOrEof
COMPILE_ERROR_OUTPUT : 
SUITE                : MISRA-C-2012
PACKAGE              : StandardLibraryFunctionTypes
TEST_DIFFERENCE      : 

COMPILE_PASS         : True
TEST_PASS            : True
RULE                 : RULE-21-15
QUERY                : MemcpyMemmoveMemcmpArgNotPointersToCompatibleTypes
COMPILE_ERROR_OUTPUT : 
SUITE                : MISRA-C-2012
PACKAGE              : StandardLibraryFunctionTypes
TEST_DIFFERENCE      : 


@jsinglet
Copy link
Contributor

🤖 Beep Boop! Matrix Testing for this PR has been completed. If no reports were posted it means this PR does not contain things that need matrix testing!

Copy link
Collaborator

@lcartey lcartey left a comment

Choose a reason for hiding this comment

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

Great work!

@jeongsoolee09 jeongsoolee09 added this pull request to the merge queue Mar 25, 2023
Merged via the queue into main with commit 15ed053 Mar 25, 2023
@jeongsoolee09 jeongsoolee09 deleted the jeongsoolee09/MISRA_21-13_and-21-15 branch March 25, 2023 10:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

3 participants