Skip to content

Fix analysis_report crash on MISRA C++ results#1163

Open
castler wants to merge 1 commit into
github:mainfrom
castler:fix-misra-report-keyerror
Open

Fix analysis_report crash on MISRA C++ results#1163
castler wants to merge 1 commit into
github:mainfrom
castler:fix-misra-report-keyerror

Conversation

@castler

@castler castler commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Description

generate_guideline_compliance_summary() renders the Guideline Compliance Summary report by mapping each applied standard's short name to a display name via the standard_pretty_name dict. That dict only contained entries for "cert" and "autosar", so analyzing a database against the MISRA C++ pack (codeql/misra-cpp-coding-standards) aborted the report generation with:

KeyError: 'misra'

at the "Coding Standards applied" line (and the same lookup is used again when tabulating per-guideline results). Add the missing "misra" -> "MISRA C++ 2023" mapping so MISRA C++ analyses can produce the compliance summary report like the other supported standards.

Fixes #667

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

Comment thread scripts/reports/utils.py Outdated
"cert": "CERT C++ 2016", "autosar": "AUTOSAR C++ R22-11, R21-11, R20-11, R19-11 and R19-03"}
"cert": "CERT C++ 2016",
"autosar": "AUTOSAR C++ R22-11, R21-11, R20-11, R19-11 and R19-03",
"misra": "MISRA C++ 2023",

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"misra": "MISRA C++ 2023",
"misra": "MISRA C++:2023",

Before you change it, maybe a maintainer can confirm if they intentionally avoid special characters but this would be the official name.

@castler
castler force-pushed the fix-misra-report-keyerror branch from 7212079 to 464c304 Compare July 24, 2026 06:43
generate_guideline_compliance_summary() renders the Guideline Compliance
Summary report by mapping each applied standard's short name to a display name
via the standard_pretty_name dict. That dict only contained entries for "cert"
and "autosar", so analyzing a database against the MISRA C++ pack
(codeql/misra-cpp-coding-standards) aborted the report generation with:

    KeyError: 'misra'

at the "**Coding Standards applied**" line (and the same lookup is used again
when tabulating per-guideline results). Add the missing "misra" ->
"MISRA C++:2023" mapping so MISRA C++ analyses can produce the compliance
summary report like the other supported standards.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Missing pretty name for MISRA in report generation

2 participants