Skip to content

Tests for Language2 #112

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 2 commits into from
Nov 7, 2022
Merged

Conversation

knewbury01
Copy link
Contributor

@knewbury01 knewbury01 commented Oct 31, 2022

Description

tests for package Language 2

I think RULE-1-1 is compiler covered, if we are assuming/currently supporting one compiler - it seems its more about edge cases from other compilers. also no concrete NON_COMPLIANT examples are given in the rule description.

I also think DIR-2-1 is compiler covered, both because it seems to be an import of A1-4-3 (which is compiler covered) but also because the compiler does seem like the best place to report compiler errors

The DIR-4-2 test will be the exact same as M7-4-1 test , checked and I agree its a plain import and the test for M7-4-1 doesnt have anything c++ specific. I forget what we do when we want to share the test file, rather than copy the content?

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-1-4
  • 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 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 Author

knewbury01 commented Oct 31, 2022

Notes RULE-1-4

  1. the annex K bit could be detected case by case but my logic was that - from this - if the __STDC_WANT_LIB_EXT1__ macro meant to guard the inclusion of these extra cases, then we can look for that instead of case by case feature use

  2. wanted to include this atomic_int i4; //NON_COMPLIANT as a test, but our included lib doesnt have the typedefs that my local apple clang stdatomic.h has so I guess not needed?

@knewbury01 knewbury01 requested a review from jsinglet November 3, 2022 14:10
@jsinglet jsinglet merged commit a1df6d4 into github:language2 Nov 7, 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.

2 participants