Skip to content

Fix Duplicate and Incorrect Rule IDs #124

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 21 commits into from
Nov 8, 2022

Conversation

jsinglet
Copy link
Contributor

@jsinglet jsinglet commented Nov 3, 2022

Description

Fixes duplicate and incorrect rule ids.

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:
    • DIR/RULE-4-4
    • DIR/RULE-4-8
    • DIR/RULE-4-10
    • DIR/RULE-4-12

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

@knewbury01
Copy link
Contributor

knewbury01 commented Nov 3, 2022

@jsinglet I think this PR will be deprecated when the Language2 tests go through
https://github.com/github/codeql-coding-standards/pull/112/files#diff-cdb9077faf1b88ec6d03150af6359fa4acc5d204ad16528b20342d5a3f93fc66R603

sorry only just pushed those rules.csv file changes... !

@lcartey
Copy link
Collaborator

lcartey commented Nov 3, 2022

@jsinglet @knewbury01 let's fix all the instances at once, ideally in main (i.e. this PR). Every line from 602 to 618 should be a DIR instead of a rule.

@jsinglet jsinglet changed the title fix rule dir-2-1 Fix Duplicate Rules Nov 3, 2022
@jsinglet
Copy link
Contributor Author

jsinglet commented Nov 3, 2022

Thanks @knewbury01 -- this PR also includes a script that will automatically check for violations in the future.

@jsinglet jsinglet marked this pull request as ready for review November 3, 2022 18:05
@lcartey
Copy link
Collaborator

lcartey commented Nov 3, 2022

We'll need to move the existing queries which should have been DIR queries and update query IDs. This will also need a change note.

@jsinglet jsinglet changed the title Fix Duplicate Rules Fix Duplicate and Incorrect Rule IDs Nov 3, 2022
@jsinglet jsinglet enabled auto-merge November 4, 2022 16:25
@jsinglet jsinglet requested a review from lcartey November 4, 2022 16:26
@jsinglet jsinglet merged commit ee795e6 into github:main Nov 8, 2022
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