Skip to content

Cross Platform Automation Fixes + Additional Matrix Features + Additional Automation #171

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 81 commits into from
Feb 17, 2023

Conversation

jsinglet
Copy link
Contributor

@jsinglet jsinglet commented Jan 23, 2023

Description

  • Fixes for cross platform automation.
  • A host of other changes to enable matrix testing.
  • Comment based performance testing
  • Automation for updating the user manual

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 number here
  • 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!)

@github-actions
Copy link

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

@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.

@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.

@jsinglet
Copy link
Contributor Author

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

@jsinglet
Copy link
Contributor Author

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

@jsinglet
Copy link
Contributor Author

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


TEST_PASS            : True
PACKAGE              : Toolchain
COMPILE_ERROR_OUTPUT : 
TEST_DIFFERENCE      : 
COMPILE_PASS         : True
SUITE                : AUTOSAR
QUERY                : UncompliantOptimizationOptionMustBeDisabledInCompiler
RULE                 : A1-1-3

TEST_PASS            : True
PACKAGE              : DeadCode
COMPILE_ERROR_OUTPUT : 
TEST_DIFFERENCE      : 
COMPILE_PASS         : True
SUITE                : AUTOSAR
QUERY                : UselessAssignment
RULE                 : A0-1-1

TEST_PASS            : True
PACKAGE              : Toolchain
COMPILE_ERROR_OUTPUT : 
TEST_DIFFERENCE      : 
COMPILE_PASS         : True
SUITE                : AUTOSAR
QUERY                : CompilerWarningLevelNotInCompliance
RULE                 : A1-1-2

TEST_PASS            : True
PACKAGE              : Toolchain
COMPILE_ERROR_OUTPUT : 
TEST_DIFFERENCE      : 
COMPILE_PASS         : True
SUITE                : AUTOSAR
QUERY                : CompilerWarningLevelNotInCompliance
RULE                 : A1-1-2

TEST_PASS            : True
PACKAGE              : Toolchain
COMPILE_ERROR_OUTPUT : 
TEST_DIFFERENCE      : 
COMPILE_PASS         : True
SUITE                : AUTOSAR
QUERY                : CompilerWarningLevelNotInCompliance
RULE                 : A1-1-2

TEST_PASS            : True
PACKAGE              : Toolchain
COMPILE_ERROR_OUTPUT : 
TEST_DIFFERENCE      : 
COMPILE_PASS         : True
SUITE                : AUTOSAR
QUERY                : CompilerWarningLevelNotInCompliance
RULE                 : A1-1-2


@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 Author

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


PACKAGE              : Toolchain
COMPILE_ERROR_OUTPUT : 
COMPILE_PASS         : True
SUITE                : AUTOSAR
RULE                 : A1-1-3
TEST_DIFFERENCE      : 
TEST_PASS            : True
QUERY                : UncompliantOptimizationOptionMustBeDisabledInCompiler

PACKAGE              : DeadCode
COMPILE_ERROR_OUTPUT : 
COMPILE_PASS         : True
SUITE                : AUTOSAR
RULE                 : A0-1-1
TEST_DIFFERENCE      : 
TEST_PASS            : True
QUERY                : UselessAssignment

PACKAGE              : Toolchain
COMPILE_ERROR_OUTPUT : 
COMPILE_PASS         : True
SUITE                : AUTOSAR
RULE                 : A1-1-2
TEST_DIFFERENCE      : 
TEST_PASS            : True
QUERY                : CompilerWarningLevelNotInCompliance

PACKAGE              : Toolchain
COMPILE_ERROR_OUTPUT : 
COMPILE_PASS         : True
SUITE                : AUTOSAR
RULE                 : A1-1-2
TEST_DIFFERENCE      : 
TEST_PASS            : True
QUERY                : CompilerWarningLevelNotInCompliance

PACKAGE              : Toolchain
COMPILE_ERROR_OUTPUT : 
COMPILE_PASS         : True
SUITE                : AUTOSAR
RULE                 : A1-1-2
TEST_DIFFERENCE      : 
TEST_PASS            : True
QUERY                : CompilerWarningLevelNotInCompliance

PACKAGE              : Toolchain
COMPILE_ERROR_OUTPUT : 
COMPILE_PASS         : True
SUITE                : AUTOSAR
RULE                 : A1-1-2
TEST_DIFFERENCE      : --- expected
                       +++ actual
                       @@ -1,1 +1,1 @@
                       -| test.cpp:0:0:0:0 | test.cpp | No warning-level options were used in the compilation of 'test.cpp'. |
                       +
                       [1/1 eval 1.1s] FAILED(RESULT) /__w/codeql-coding-standards-release-engineering/codeql-coding-standards-release-engineering/codeql-coding-standards/cpp/autosar/test/rules/A1-1-2.3/CompilerWarningLevelNotInCompliance.qlref
                       
TEST_PASS            : False
QUERY                : CompilerWarningLevelNotInCompliance


@jsinglet
Copy link
Contributor Author

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

@jsinglet
Copy link
Contributor Author

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

@jsinglet
Copy link
Contributor Author

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

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


COMPILE_ERROR_OUTPUT : 
TEST_PASS            : True
COMPILE_PASS         : True
TEST_DIFFERENCE      : 
RULE                 : A1-1-3
QUERY                : UncompliantOptimizationOptionMustBeDisabledInCompiler
SUITE                : AUTOSAR
PACKAGE              : Toolchain

COMPILE_ERROR_OUTPUT : 
TEST_PASS            : True
COMPILE_PASS         : True
TEST_DIFFERENCE      : 
RULE                 : A0-1-1
QUERY                : UselessAssignment
SUITE                : AUTOSAR
PACKAGE              : DeadCode

COMPILE_ERROR_OUTPUT : 
TEST_PASS            : True
COMPILE_PASS         : True
TEST_DIFFERENCE      : 
RULE                 : A1-1-2
QUERY                : CompilerWarningLevelNotInCompliance
SUITE                : AUTOSAR
PACKAGE              : Toolchain

COMPILE_ERROR_OUTPUT : 
TEST_PASS            : True
COMPILE_PASS         : True
TEST_DIFFERENCE      : 
RULE                 : A1-1-2
QUERY                : CompilerWarningLevelNotInCompliance
SUITE                : AUTOSAR
PACKAGE              : Toolchain

COMPILE_ERROR_OUTPUT : 
TEST_PASS            : True
COMPILE_PASS         : True
TEST_DIFFERENCE      : 
RULE                 : A1-1-2
QUERY                : CompilerWarningLevelNotInCompliance
SUITE                : AUTOSAR
PACKAGE              : Toolchain

COMPILE_ERROR_OUTPUT : 
TEST_PASS            : False
COMPILE_PASS         : True
TEST_DIFFERENCE      : --- expected
                       +++ actual
                       @@ -1,1 +1,1 @@
                       -| test.cpp:0:0:0:0 | test.cpp | No warning-level options were used in the compilation of 'test.cpp'. |
                       +
                       [1/1 eval 1.1s] FAILED(RESULT) /__w/codeql-coding-standards-release-engineering/codeql-coding-standards-release-engineering/codeql-coding-standards/cpp/autosar/test/rules/A1-1-2.3/CompilerWarningLevelNotInCompliance.qlref
                       
RULE                 : A1-1-2
QUERY                : CompilerWarningLevelNotInCompliance
SUITE                : AUTOSAR
PACKAGE              : Toolchain


@jsinglet
Copy link
Contributor Author

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


TEST_DIFFERENCE      : 
SUITE                : AUTOSAR
RULE                 : A1-1-3
TEST_PASS            : True
PACKAGE              : Toolchain
COMPILE_PASS         : True
QUERY                : UncompliantOptimizationOptionMustBeDisabledInCompiler
COMPILE_ERROR_OUTPUT : 

TEST_DIFFERENCE      : 
SUITE                : AUTOSAR
RULE                 : A0-1-1
TEST_PASS            : True
PACKAGE              : DeadCode
COMPILE_PASS         : True
QUERY                : UselessAssignment
COMPILE_ERROR_OUTPUT : 

TEST_DIFFERENCE      : 
SUITE                : AUTOSAR
RULE                 : A1-1-2
TEST_PASS            : True
PACKAGE              : Toolchain
COMPILE_PASS         : True
QUERY                : CompilerWarningLevelNotInCompliance
COMPILE_ERROR_OUTPUT : 

TEST_DIFFERENCE      : 
SUITE                : AUTOSAR
RULE                 : A1-1-2
TEST_PASS            : True
PACKAGE              : Toolchain
COMPILE_PASS         : True
QUERY                : CompilerWarningLevelNotInCompliance
COMPILE_ERROR_OUTPUT : 

TEST_DIFFERENCE      : 
SUITE                : AUTOSAR
RULE                 : A1-1-2
TEST_PASS            : True
PACKAGE              : Toolchain
COMPILE_PASS         : True
QUERY                : CompilerWarningLevelNotInCompliance
COMPILE_ERROR_OUTPUT : 

TEST_DIFFERENCE      : 
SUITE                : AUTOSAR
RULE                 : A1-1-2
TEST_PASS            : True
PACKAGE              : Toolchain
COMPILE_PASS         : True
QUERY                : CompilerWarningLevelNotInCompliance
COMPILE_ERROR_OUTPUT : 


@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 Author

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

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

@jsinglet
Copy link
Contributor Author

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

@jsinglet
Copy link
Contributor Author

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


RULE                 : A1-1-3
QUERY                : UncompliantOptimizationOptionMustBeDisabledInCompiler
PACKAGE              : Toolchain
TEST_PASS            : True
SUITE                : AUTOSAR
COMPILE_PASS         : True
TEST_DIFFERENCE      : 
COMPILE_ERROR_OUTPUT : 

RULE                 : A0-1-1
QUERY                : UselessAssignment
PACKAGE              : DeadCode
TEST_PASS            : True
SUITE                : AUTOSAR
COMPILE_PASS         : True
TEST_DIFFERENCE      : 
COMPILE_ERROR_OUTPUT : 

RULE                 : A1-1-2
QUERY                : CompilerWarningLevelNotInCompliance
PACKAGE              : Toolchain
TEST_PASS            : True
SUITE                : AUTOSAR
COMPILE_PASS         : True
TEST_DIFFERENCE      : 
COMPILE_ERROR_OUTPUT : 

RULE                 : A1-1-2
QUERY                : CompilerWarningLevelNotInCompliance
PACKAGE              : Toolchain
TEST_PASS            : True
SUITE                : AUTOSAR
COMPILE_PASS         : True
TEST_DIFFERENCE      : 
COMPILE_ERROR_OUTPUT : 

RULE                 : A1-1-2
QUERY                : CompilerWarningLevelNotInCompliance
PACKAGE              : Toolchain
TEST_PASS            : True
SUITE                : AUTOSAR
COMPILE_PASS         : True
TEST_DIFFERENCE      : 
COMPILE_ERROR_OUTPUT : 

RULE                 : A1-1-2
QUERY                : CompilerWarningLevelNotInCompliance
PACKAGE              : Toolchain
TEST_PASS            : False
SUITE                : AUTOSAR
COMPILE_PASS         : True
TEST_DIFFERENCE      : --- expected
                       +++ actual
                       @@ -1,1 +1,1 @@
                       -| test.cpp:0:0:0:0 | test.cpp | No warning-level options were used in the compilation of 'test.cpp'. |
                       +
                       [1/1 eval 1.1s] FAILED(RESULT) /__w/codeql-coding-standards-release-engineering/codeql-coding-standards-release-engineering/codeql-coding-standards/cpp/autosar/test/rules/A1-1-2.3/CompilerWarningLevelNotInCompliance.qlref
                       
COMPILE_ERROR_OUTPUT : 


@jsinglet
Copy link
Contributor Author

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


TEST_DIFFERENCE      : 
TEST_PASS            : True
PACKAGE              : Toolchain
SUITE                : AUTOSAR
COMPILE_PASS         : True
COMPILE_ERROR_OUTPUT : 
RULE                 : A1-1-3
QUERY                : UncompliantOptimizationOptionMustBeDisabledInCompiler

TEST_DIFFERENCE      : 
TEST_PASS            : True
PACKAGE              : DeadCode
SUITE                : AUTOSAR
COMPILE_PASS         : True
COMPILE_ERROR_OUTPUT : 
RULE                 : A0-1-1
QUERY                : UselessAssignment

TEST_DIFFERENCE      : 
TEST_PASS            : True
PACKAGE              : Toolchain
SUITE                : AUTOSAR
COMPILE_PASS         : True
COMPILE_ERROR_OUTPUT : 
RULE                 : A1-1-2
QUERY                : CompilerWarningLevelNotInCompliance

TEST_DIFFERENCE      : 
TEST_PASS            : True
PACKAGE              : Toolchain
SUITE                : AUTOSAR
COMPILE_PASS         : True
COMPILE_ERROR_OUTPUT : 
RULE                 : A1-1-2
QUERY                : CompilerWarningLevelNotInCompliance

TEST_DIFFERENCE      : 
TEST_PASS            : True
PACKAGE              : Toolchain
SUITE                : AUTOSAR
COMPILE_PASS         : True
COMPILE_ERROR_OUTPUT : 
RULE                 : A1-1-2
QUERY                : CompilerWarningLevelNotInCompliance

TEST_DIFFERENCE      : 
TEST_PASS            : True
PACKAGE              : Toolchain
SUITE                : AUTOSAR
COMPILE_PASS         : True
COMPILE_ERROR_OUTPUT : 
RULE                 : A1-1-2
QUERY                : CompilerWarningLevelNotInCompliance


@jsinglet
Copy link
Contributor Author

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

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


PACKAGE              : Toolchain
COMPILE_ERROR_OUTPUT : 
COMPILE_PASS         : True
SUITE                : AUTOSAR
RULE                 : A1-1-3
TEST_DIFFERENCE      : 
TEST_PASS            : True
QUERY                : UncompliantOptimizationOptionMustBeDisabledInCompiler

PACKAGE              : DeadCode
COMPILE_ERROR_OUTPUT : 
COMPILE_PASS         : True
SUITE                : AUTOSAR
RULE                 : A0-1-1
TEST_DIFFERENCE      : 
TEST_PASS            : True
QUERY                : UselessAssignment

PACKAGE              : Toolchain
COMPILE_ERROR_OUTPUT : 
COMPILE_PASS         : True
SUITE                : AUTOSAR
RULE                 : A1-1-2
TEST_DIFFERENCE      : 
TEST_PASS            : True
QUERY                : CompilerWarningLevelNotInCompliance

PACKAGE              : Toolchain
COMPILE_ERROR_OUTPUT : 
COMPILE_PASS         : True
SUITE                : AUTOSAR
RULE                 : A1-1-2
TEST_DIFFERENCE      : 
TEST_PASS            : True
QUERY                : CompilerWarningLevelNotInCompliance

PACKAGE              : Toolchain
COMPILE_ERROR_OUTPUT : 
COMPILE_PASS         : True
SUITE                : AUTOSAR
RULE                 : A1-1-2
TEST_DIFFERENCE      : 
TEST_PASS            : True
QUERY                : CompilerWarningLevelNotInCompliance

PACKAGE              : Toolchain
COMPILE_ERROR_OUTPUT : 
COMPILE_PASS         : True
SUITE                : AUTOSAR
RULE                 : A1-1-2
TEST_DIFFERENCE      : --- expected
                       +++ actual
                       @@ -1,1 +1,1 @@
                       -| test.cpp:0:0:0:0 | test.cpp | No warning-level options were used in the compilation of 'test.cpp'. |
                       +
                       [1/1 eval 1.1s] FAILED(RESULT) /__w/codeql-coding-standards-release-engineering/codeql-coding-standards-release-engineering/codeql-coding-standards/cpp/autosar/test/rules/A1-1-2.3/CompilerWarningLevelNotInCompliance.qlref
                       
TEST_PASS            : False
QUERY                : CompilerWarningLevelNotInCompliance

@lcartey -- -w for gcc should disable all warnings but this still fails.

@lcartey
Copy link
Collaborator

lcartey commented Feb 14, 2023

@lcartey -- -w for gcc should disable all warnings but this still fails.

I think that's a query improvement, and should be filed as such. The original test cases did not include a test for -w only.

@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 jsinglet enabled auto-merge February 17, 2023 19:45
@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 jsinglet merged commit a1f760f into main Feb 17, 2023
@jsinglet jsinglet deleted the jsinglet/slash-fixes branch February 17, 2023 20:46
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.

2 participants