Implement C Memory1 package #224

nicolaswill · 2023-03-02T21:53:39Z

Description

This pull request implements the Memory1 package. RULE-9-5 is blocked at the moment and not in this PR.

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-9-2 - closes github/coding-standards-team#755
- RULE-9-3 - closes github/coding-standards-team#756
- RULE-9-4 - closes github/coding-standards-team#757
Queries have been modified for the following rules:
- rule number here

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!)

RULE-9-5 is currently blocked due to CodeQL extractor non-support for identifying designated initializers in array aggregate literals.

knewbury01

hey, have only reviewed ~~RULE-9-4~~ (edit) 9-2! so far, so just the one tiny metadata comment, but otherwise looks good, completely agree import,

will finish my review of the other 2 rules on Mon!

rule_packages/c/Memory1.json

knewbury01

just a few minor comments for RULE-9-4 :)

will submit a separate review for RULE-9-3!

c/misra/src/rules/RULE-9-4/RepeatedInitializationOfAggregateObjectElement.ql

github-actions · 2023-03-07T09:00:42Z

🤖 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 · 2023-03-07T09:01:31Z

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

jsinglet · 2023-03-07T09:01:31Z

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

jsinglet · 2023-03-07T09:01:32Z

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

jsinglet · 2023-03-07T09:03:23Z

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

jsinglet · 2023-03-07T09:03:45Z

🤖 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 · 2023-03-07T09:03:56Z

🤖 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 · 2023-03-07T09:04:38Z

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

jsinglet · 2023-03-07T09:04:38Z

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

jsinglet · 2023-03-07T09:04:39Z

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

jsinglet · 2023-03-07T09:04:42Z

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

jsinglet · 2023-03-07T09:05:02Z

🤖 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!

knewbury01

heyo, just one small decision on RULE-9-3, I personally am fine with it going either way, but I think I had some like this before and I forget what I was told to do 😅

other than that, will be ready to approve after that small thing! :) looks good, really great testcase coverage

c/misra/src/rules/RULE-9-3/PartiallyInitializedArrayWithExplicitInitializers.ql

knewbury01

looks good! nice handling of some less than straightforward cases especially with the multidimensional arrays!

github-actions · 2023-03-08T15:44:51Z

🤖 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 · 2023-03-08T15:47:52Z

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


COMPILE_PASS         : True
RULE                 : M8-5-2
COMPILE_ERROR_OUTPUT : 
TEST_PASS            : True
QUERY                : UseInitBracesToMatchTypeStructure
PACKAGE              : Initialization
SUITE                : AUTOSAR
TEST_DIFFERENCE      : 

COMPILE_PASS         : True
RULE                 : M8-5-2
COMPILE_ERROR_OUTPUT : 
TEST_PASS            : True
QUERY                : NestedZeroValueInitialization
PACKAGE              : Initialization
SUITE                : AUTOSAR
TEST_DIFFERENCE      : 

COMPILE_PASS         : True
RULE                 : M8-5-2
COMPILE_ERROR_OUTPUT : 
TEST_PASS            : True
QUERY                : MissingExplicitInitializers
PACKAGE              : Initialization
SUITE                : AUTOSAR
TEST_DIFFERENCE      :

jsinglet · 2023-03-08T15:49:09Z

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


SUITE                : MISRA-C-2012
QUERY                : InitializerForAggregateOrUnionNotEnclosedInBraces
COMPILE_ERROR_OUTPUT : 
TEST_PASS            : True
COMPILE_PASS         : True
PACKAGE              : Memory1
TEST_DIFFERENCE      : 
RULE                 : RULE-9-2

SUITE                : MISRA-C-2012
QUERY                : PartiallyInitializedArrayWithExplicitInitializers
COMPILE_ERROR_OUTPUT : 
TEST_PASS            : True
COMPILE_PASS         : True
PACKAGE              : Memory1
TEST_DIFFERENCE      : 
RULE                 : RULE-9-3

SUITE                : MISRA-C-2012
QUERY                : RepeatedInitializationOfAggregateObjectElement
COMPILE_ERROR_OUTPUT : 
TEST_PASS            : True
COMPILE_PASS         : True
PACKAGE              : Memory1
TEST_DIFFERENCE      : 
RULE                 : RULE-9-4

jsinglet · 2023-03-08T15:49:11Z

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


RULE                 : RULE-9-2
TEST_PASS            : True
TEST_DIFFERENCE      : 
QUERY                : InitializerForAggregateOrUnionNotEnclosedInBraces
PACKAGE              : Memory1
COMPILE_ERROR_OUTPUT : 
COMPILE_PASS         : True
SUITE                : MISRA-C-2012

RULE                 : RULE-9-3
TEST_PASS            : True
TEST_DIFFERENCE      : 
QUERY                : PartiallyInitializedArrayWithExplicitInitializers
PACKAGE              : Memory1
COMPILE_ERROR_OUTPUT : 
COMPILE_PASS         : True
SUITE                : MISRA-C-2012

RULE                 : RULE-9-4
TEST_PASS            : True
TEST_DIFFERENCE      : 
QUERY                : RepeatedInitializationOfAggregateObjectElement
PACKAGE              : Memory1
COMPILE_ERROR_OUTPUT : 
COMPILE_PASS         : True
SUITE                : MISRA-C-2012

jsinglet · 2023-03-08T15:49:29Z

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


TEST_PASS            : True
QUERY                : UseInitBracesToMatchTypeStructure
RULE                 : M8-5-2
TEST_DIFFERENCE      : 
COMPILE_PASS         : True
COMPILE_ERROR_OUTPUT : 
SUITE                : AUTOSAR
PACKAGE              : Initialization

TEST_PASS            : True
QUERY                : MissingExplicitInitializers
RULE                 : M8-5-2
TEST_DIFFERENCE      : 
COMPILE_PASS         : True
COMPILE_ERROR_OUTPUT : 
SUITE                : AUTOSAR
PACKAGE              : Initialization

TEST_PASS            : True
QUERY                : NestedZeroValueInitialization
RULE                 : M8-5-2
TEST_DIFFERENCE      : 
COMPILE_PASS         : True
COMPILE_ERROR_OUTPUT : 
SUITE                : AUTOSAR
PACKAGE              : Initialization

jsinglet · 2023-03-08T15:49:45Z

🤖 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!

Implement RULE-9-2, RULE-9-3, RULE-9-4

59cc35c

nicolaswill requested a review from knewbury01 March 2, 2023 21:53

Move RULE-9-5 to the Memory2 package

321a1e9

RULE-9-5 is currently blocked due to CodeQL extractor non-support for identifying designated initializers in array aggregate literals.

github deleted a comment from github-actions bot Mar 2, 2023

github deleted a comment from jsinglet Mar 2, 2023

github deleted a comment from github-actions bot Mar 2, 2023

knewbury01 reviewed Mar 3, 2023

View reviewed changes

rule_packages/c/Memory1.json Outdated Show resolved Hide resolved

knewbury01 reviewed Mar 6, 2023

View reviewed changes

c/misra/src/rules/RULE-9-4/RepeatedInitializationOfAggregateObjectElement.ql Show resolved Hide resolved

c/misra/src/rules/RULE-9-4/RepeatedInitializationOfAggregateObjectElement.ql Outdated Show resolved Hide resolved

Fix RULE-9-4 bug, update test and metadata

20db94f

InitializerForAggregateOrUnionNotEnclosedInBrances.ql: update severity

56e6ebd

knewbury01 reviewed Mar 7, 2023

View reviewed changes

c/misra/src/rules/RULE-9-3/PartiallyInitializedArrayWithExplicitInitializers.ql Show resolved Hide resolved

knewbury01 enabled auto-merge March 8, 2023 15:41

knewbury01 approved these changes Mar 8, 2023

View reviewed changes

Merge branch 'main' into Memory1

ca169de

knewbury01 merged commit 46f16cc into github:main Mar 8, 2023

Implement C Memory1 package #224

Implement C Memory1 package #224

Uh oh!

Conversation

nicolaswill commented Mar 2, 2023 • edited by knewbury01 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Change request type

Rules with added or modified queries

Release change checklist

Query development review checklist

Author

Reviewer

Uh oh!

knewbury01 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

knewbury01 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Mar 7, 2023

Uh oh!

jsinglet commented Mar 7, 2023

Uh oh!

jsinglet commented Mar 7, 2023

Uh oh!

jsinglet commented Mar 7, 2023

Uh oh!

jsinglet commented Mar 7, 2023

Uh oh!

jsinglet commented Mar 7, 2023

Uh oh!

github-actions bot commented Mar 7, 2023

Uh oh!

jsinglet commented Mar 7, 2023

Uh oh!

jsinglet commented Mar 7, 2023

Uh oh!

jsinglet commented Mar 7, 2023

Uh oh!

jsinglet commented Mar 7, 2023

Uh oh!

jsinglet commented Mar 7, 2023

Uh oh!

knewbury01 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

knewbury01 left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Mar 8, 2023

Uh oh!

jsinglet commented Mar 8, 2023

Uh oh!

jsinglet commented Mar 8, 2023

Uh oh!

jsinglet commented Mar 8, 2023

Uh oh!

jsinglet commented Mar 8, 2023

Uh oh!

jsinglet commented Mar 8, 2023

Uh oh!

Uh oh!

nicolaswill commented Mar 2, 2023 •

edited by knewbury01

Loading

knewbury01 left a comment •

edited

Loading