Implement Types Package #237

jeongsoolee09 · 2023-03-03T20:48:27Z

Description

Implement the Types Package.

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-12-5
- RULE-7-4
- INT34-C
- INT36-C
- DIR-4-6
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!)

github-actions · 2023-03-03T20:48:45Z

🤖 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-03T20:51:14Z

🤖 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-03T20:52:40Z

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


RULE                 : INT34-C
COMPILE_ERROR_OUTPUT : 
SUITE                : CERT-C
QUERY                : ExprShiftedbyNegativeOrGreaterPrecisionOperand
TEST_DIFFERENCE      : 
TEST_PASS            : True
PACKAGE              : Types
COMPILE_PASS         : True

RULE                 : INT36-C
COMPILE_ERROR_OUTPUT : 
SUITE                : CERT-C
QUERY                : ConvertingAPointerToIntegerOrIntegerToPointer
TEST_DIFFERENCE      : 
TEST_PASS            : True
PACKAGE              : Types
COMPILE_PASS         : True

RULE                 : DIR-4-6
COMPILE_ERROR_OUTPUT : 
SUITE                : MISRA-C-2012
QUERY                : PlainNumericalTypeUsedOverExplicitTypedef
TEST_DIFFERENCE      : --- expected
                       +++ actual
                       @@ -1,1 +1,1 @@
                       -No expected results have yet been specified
                       +| test.c:27:5:27:26 | _astronomical_number_t | The type _astronomical_number_t is not a fixed-width numeric type nor an alias to one. |
                       [1/1 comp 29.2s eval 1.1s] FAILED(RESULT) /__w/codeql-coding-standards-release-engineering/codeql-coding-standards-release-engineering/codeql-coding-standards/c/misra/test/rules/DIR-4-6/PlainNumericalTypeUsedOverExplicitTypedef.qlref
                       
TEST_PASS            : False
PACKAGE              : Types
COMPILE_PASS         : True

RULE                 : RULE-12-5
COMPILE_ERROR_OUTPUT : 
SUITE                : MISRA-C-2012
QUERY                : SizeofOperatorUsedOnArrayTypeParam
TEST_DIFFERENCE      : 
TEST_PASS            : True
PACKAGE              : Types
COMPILE_PASS         : True

RULE                 : RULE-7-4
COMPILE_ERROR_OUTPUT : 
SUITE                : MISRA-C-2012
QUERY                : StringLiteralAssignedToNonConstChar
TEST_DIFFERENCE      : 
TEST_PASS            : True
PACKAGE              : Types
COMPILE_PASS         : True

jsinglet · 2023-03-24T17:14:27Z

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


COMPILE_PASS         : True
QUERY                : VariableWidthIntegerTypesUsed
TEST_DIFFERENCE      : 
TEST_PASS            : True
PACKAGE              : Declarations
SUITE                : AUTOSAR
RULE                 : A3-9-1
COMPILE_ERROR_OUTPUT :

jsinglet · 2023-03-24T17:16:16Z

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


RULE                 : A3-9-1
QUERY                : VariableWidthIntegerTypesUsed
SUITE                : AUTOSAR
TEST_PASS            : True
COMPILE_ERROR_OUTPUT : 
COMPILE_PASS         : True
TEST_DIFFERENCE      : 
PACKAGE              : Declarations

jsinglet · 2023-03-24T17:16:23Z

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


TEST_DIFFERENCE      : 
COMPILE_PASS         : True
TEST_PASS            : True
RULE                 : A3-9-1
QUERY                : VariableWidthIntegerTypesUsed
COMPILE_ERROR_OUTPUT : 
SUITE                : AUTOSAR
PACKAGE              : Declarations

jsinglet · 2023-03-24T17:16:24Z

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


QUERY                : ExprShiftedbyNegativeOrGreaterPrecisionOperand
TEST_PASS            : True
TEST_DIFFERENCE      : 
RULE                 : INT34-C
COMPILE_ERROR_OUTPUT : 
PACKAGE              : Types1
SUITE                : CERT-C
COMPILE_PASS         : True

QUERY                : ConvertingAPointerToIntegerOrIntegerToPointer
TEST_PASS            : True
TEST_DIFFERENCE      : 
RULE                 : INT36-C
COMPILE_ERROR_OUTPUT : 
PACKAGE              : Types1
SUITE                : CERT-C
COMPILE_PASS         : True

QUERY                : PlainNumericalTypeUsedOverExplicitTypedef
TEST_PASS            : True
TEST_DIFFERENCE      : 
RULE                 : DIR-4-6
COMPILE_ERROR_OUTPUT : 
PACKAGE              : Types1
SUITE                : MISRA-C-2012
COMPILE_PASS         : True

QUERY                : SizeofOperatorUsedOnArrayTypeParam
TEST_PASS            : True
TEST_DIFFERENCE      : 
RULE                 : RULE-12-5
COMPILE_ERROR_OUTPUT : 
PACKAGE              : Types1
SUITE                : MISRA-C-2012
COMPILE_PASS         : True

QUERY                : StringLiteralAssignedToNonConstChar
TEST_PASS            : True
TEST_DIFFERENCE      : 
RULE                 : RULE-7-4
COMPILE_ERROR_OUTPUT : 
PACKAGE              : Types1
SUITE                : MISRA-C-2012
COMPILE_PASS         : True

jsinglet · 2023-03-24T17:16:39Z

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


COMPILE_ERROR_OUTPUT : 
TEST_PASS            : True
COMPILE_PASS         : True
RULE                 : INT34-C
SUITE                : CERT-C
TEST_DIFFERENCE      : 
QUERY                : ExprShiftedbyNegativeOrGreaterPrecisionOperand
PACKAGE              : Types1

COMPILE_ERROR_OUTPUT : 
TEST_PASS            : True
COMPILE_PASS         : True
RULE                 : INT36-C
SUITE                : CERT-C
TEST_DIFFERENCE      : 
QUERY                : ConvertingAPointerToIntegerOrIntegerToPointer
PACKAGE              : Types1

COMPILE_ERROR_OUTPUT : 
TEST_PASS            : True
COMPILE_PASS         : True
RULE                 : DIR-4-6
SUITE                : MISRA-C-2012
TEST_DIFFERENCE      : 
QUERY                : PlainNumericalTypeUsedOverExplicitTypedef
PACKAGE              : Types1

COMPILE_ERROR_OUTPUT : 
TEST_PASS            : True
COMPILE_PASS         : True
RULE                 : RULE-12-5
SUITE                : MISRA-C-2012
TEST_DIFFERENCE      : 
QUERY                : SizeofOperatorUsedOnArrayTypeParam
PACKAGE              : Types1

COMPILE_ERROR_OUTPUT : 
TEST_PASS            : True
COMPILE_PASS         : True
RULE                 : RULE-7-4
SUITE                : MISRA-C-2012
TEST_DIFFERENCE      : 
QUERY                : StringLiteralAssignedToNonConstChar
PACKAGE              : Types1

jsinglet · 2023-03-24T17:21:18Z

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


TEST_PASS            : True
PACKAGE              : Types1
QUERY                : ExprShiftedbyNegativeOrGreaterPrecisionOperand
COMPILE_ERROR_OUTPUT : 
SUITE                : CERT-C
RULE                 : INT34-C
TEST_DIFFERENCE      : 
COMPILE_PASS         : True

TEST_PASS            : True
PACKAGE              : Types1
QUERY                : ConvertingAPointerToIntegerOrIntegerToPointer
COMPILE_ERROR_OUTPUT : 
SUITE                : CERT-C
RULE                 : INT36-C
TEST_DIFFERENCE      : 
COMPILE_PASS         : True

TEST_PASS            : True
PACKAGE              : Types1
QUERY                : PlainNumericalTypeUsedOverExplicitTypedef
COMPILE_ERROR_OUTPUT : 
SUITE                : MISRA-C-2012
RULE                 : DIR-4-6
TEST_DIFFERENCE      : 
COMPILE_PASS         : True

TEST_PASS            : True
PACKAGE              : Types1
QUERY                : SizeofOperatorUsedOnArrayTypeParam
COMPILE_ERROR_OUTPUT : 
SUITE                : MISRA-C-2012
RULE                 : RULE-12-5
TEST_DIFFERENCE      : 
COMPILE_PASS         : True

TEST_PASS            : True
PACKAGE              : Types1
QUERY                : StringLiteralAssignedToNonConstChar
COMPILE_ERROR_OUTPUT : 
SUITE                : MISRA-C-2012
RULE                 : RULE-7-4
TEST_DIFFERENCE      : 
COMPILE_PASS         : True

jsinglet · 2023-03-24T17:24:40Z

🤖 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 · 2023-03-24T17:28:49Z

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


TEST_PASS            : True
COMPILE_ERROR_OUTPUT : 
RULE                 : INT34-C
TEST_DIFFERENCE      : 
QUERY                : ExprShiftedbyNegativeOrGreaterPrecisionOperand
SUITE                : CERT-C
COMPILE_PASS         : True
PACKAGE              : Types1

TEST_PASS            : True
COMPILE_ERROR_OUTPUT : 
RULE                 : INT36-C
TEST_DIFFERENCE      : 
QUERY                : ConvertingAPointerToIntegerOrIntegerToPointer
SUITE                : CERT-C
COMPILE_PASS         : True
PACKAGE              : Types1

TEST_PASS            : True
COMPILE_ERROR_OUTPUT : 
RULE                 : DIR-4-6
TEST_DIFFERENCE      : 
QUERY                : PlainNumericalTypeUsedOverExplicitTypedef
SUITE                : MISRA-C-2012
COMPILE_PASS         : True
PACKAGE              : Types1

TEST_PASS            : True
COMPILE_ERROR_OUTPUT : 
RULE                 : RULE-12-5
TEST_DIFFERENCE      : 
QUERY                : SizeofOperatorUsedOnArrayTypeParam
SUITE                : MISRA-C-2012
COMPILE_PASS         : True
PACKAGE              : Types1

TEST_PASS            : True
COMPILE_ERROR_OUTPUT : 
RULE                 : RULE-7-4
TEST_DIFFERENCE      : 
QUERY                : StringLiteralAssignedToNonConstChar
SUITE                : MISRA-C-2012
COMPILE_PASS         : True
PACKAGE              : Types1

jsinglet · 2023-03-24T17:29:12Z

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

lcartey · 2023-03-27T13:44:11Z

/test-performance

github-actions · 2023-03-27T13:44:28Z

🏁 Beep Boop! Performance testing for this PR has been initiated. Please check back later for results. Note that the query package generation step must complete before testing will start so it might be a minute.

💡 If you do not hear back from me please check my status! I will report even if I fail!

c/misra/src/rules/RULE-7-4/StringLiteralAssignedToNonConstChar.ql

c/cert/src/rules/INT34-C/ExprShiftedbyNegativeOrGreaterPrecisionOperand.ql

If the expression is explicitly converted to a larger type, the shift happens on the larger type.

* Include uncertainty in the alert message (e.g. "may") * Report upper bound if relevant.

Recursively identify typedefs that are to the built in numeric types, but do not use the size alias.

Comments addressed.

jeongsoolee09 added 24 commits February 24, 2023 15:44

Initialize Types package

2dc3ba3

Create test.c for RULE-12-5

d5259e2

Remove file staged by mistake and really add test.c

c6682eb

Remove bogus case and make test.c compile

6b57f8d

Remove bogus files

405f28b

Implement RULE-12-5

d8cd0bf

Remove bogus files for RULE-7-4

3a3eba2

Remove main

3034493

Add test.c for RULE-7-4

25286ad

modified test.c for 7-4

14350d0

Slim down test.c for 7-4

2ebcf85

Draft of 7-4

16fe159

Update .expected for 7-4

b51ac0e

Remove bogus files

ccf9f5f

Remove bogus file

ccfeb06

Add test cases for DIR-4-6

7e837dc

Draft of 4-6

87a0a3d

Initialize INT34-C

b1d08d3

Prepare test cases for INT34

1b5c862

Implement INT34-C

3d30316

Draft for INT36-C

9ddb2c6

Add test.c for INT36-C

0b242cb

Implement INT36-C

2c36364

Some minor comment adjustments

20bc3ab

jeongsoolee09 requested review from rvermeulen and lcartey March 3, 2023 20:48

Add missing help query help file for INT36-c

887c215

jeongsoolee09 added 3 commits March 27, 2023 09:54

Merge branch 'main' into jeongsoolee09/Types

09eab92

Update DIR-4-6 to include size check for typedef

37d59bb

Address inconsistency in rules.csv

2889a5d

jeongsoolee09 enabled auto-merge March 27, 2023 21:20

Format test.c for DIR-4-6

ea31308

lcartey requested changes Mar 28, 2023

View reviewed changes

jeongsoolee09 and others added 7 commits March 28, 2023 11:40

Tidy up overall

207d908

Merge branch 'main' into jeongsoolee09/Types

f0023d6

INT34-C: Use fully converted type for precision

b79e1e8

If the expression is explicitly converted to a larger type, the shift happens on the larger type.

INT34-C: Improve alert message.

4e5e05a

* Include uncertainty in the alert message (e.g. "may") * Report upper bound if relevant.

DIR-4-6: Only flag aliases of built-in numeric types.

9fc57bd

DIR-4-6: typedefs should be to numeric types

93b9391

Recursively identify typedefs that are to the built in numeric types, but do not use the size alias.

Merge branch 'main' into jeongsoolee09/Types

b33391d

lcartey approved these changes Mar 29, 2023

View reviewed changes

jeongsoolee09 added this pull request to the merge queue Mar 29, 2023

Merged via the queue into main with commit 6628857 Mar 29, 2023

jeongsoolee09 deleted the jeongsoolee09/Types branch March 29, 2023 12:20

Implement Types Package #237

Implement Types Package #237

Uh oh!

Conversation

jeongsoolee09 commented Mar 3, 2023 • edited 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!

github-actions bot commented Mar 3, 2023

Uh oh!

jsinglet commented Mar 3, 2023

Uh oh!

jsinglet commented Mar 3, 2023

Uh oh!

jsinglet commented Mar 24, 2023

Uh oh!

jsinglet commented Mar 24, 2023

Uh oh!

jsinglet commented Mar 24, 2023

Uh oh!

jsinglet commented Mar 24, 2023

Uh oh!

jsinglet commented Mar 24, 2023

Uh oh!

jsinglet commented Mar 24, 2023

Uh oh!

jsinglet commented Mar 24, 2023

Uh oh!

jsinglet commented Mar 24, 2023

Uh oh!

jsinglet commented Mar 24, 2023

Uh oh!

lcartey commented Mar 27, 2023

Uh oh!

github-actions bot commented Mar 27, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jeongsoolee09 commented Mar 3, 2023 •

edited

Loading