-
Notifications
You must be signed in to change notification settings - Fork 61
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
support cert c optional rule help generation #880
base: main
Are you sure you want to change the base?
support cert c optional rule help generation #880
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR updates the CERT help extraction script to support optional recommendations for CERT-C rules.
- Introduces support for optional "Recommendations" listings via a new constant and generator function.
- Refactors the rules retrieval process by iterating over multiple listings.
- Fixes a broken URL by adding an additional elif block for unexpected behavior.
Files not reviewed (1)
- rules.csv: Language not supported
Comments suppressed due to low confidence (1)
scripts/help/cert-help-extraction.py:55
- Replace 'if soup == None:' with 'if soup is None:' to follow Python's recommended identity comparison for None.
if soup == None:
Tip: Copilot code review supports C#, Go, Java, JavaScript, Markdown, Python, Ruby and TypeScript, with more languages coming soon. Learn more
def get_rules(): | ||
rules = [] | ||
for soup in [soupify(f"{CERT_WIKI}{RULES_LIST_C}"), soupify(f"{CERT_WIKI}{RULES_LIST_CPP}")]: | ||
def get_rule_listings() -> Generator[Tag, None, None]: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The type 'Tag' is used in the function signature without an import; add 'from bs4 import Tag' to ensure proper type checking.
Copilot is powered by AI, so mistakes are possible. Review output carefully before use.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems incorrect, file has from bs4.element import NavigableString, Tag
ed70a09
to
9df912f
Compare
9df912f
to
9fd31cc
Compare
9fd31cc
to
14bd937
Compare
Description
Update cert-help-extraction.py to support the "recommendations" (optional rules).
Change request type
.ql
,.qll
,.qls
or unit tests)Rules with added or modified queries
Release change checklist
A change note (development_handbook.md#change-notes) is required for any pull request which modifies:
If you are only adding new rule queries, a change note is not required.
Author: Is a change note required?
🚨🚨🚨
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.
Reviewer: Confirm that either a change note is not required or the change note is required and has been added.
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
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.
Reviewer
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.