Skip to content
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

Adds optional Json Format Report module #188

Closed

Conversation

MatteoRagni
Copy link
Collaborator

Description

This commit introduces a new optional (and disabled by default) report format module for JSON file. Really similar to the Text Report module, uses nlohmann-json as dependency which is obtained automatically by CMake via FetchContent.

To enable compilation of the module a specific option (ASAM_QC_JSON_REPORT_FORMAT_ENABLE) should be enabled in CMake at configuration time.

Side note, adding .vscode as ignored directory for the project.

Main changes

  1. Adding a new report module subdirectory for report_module_json, with its own CMakeLists and dependency handling.
  2. Added the subdirectory in report_modules CMakeLists, conditional to a specific cmake configuration option
  3. Configuration option added with documentation in root CMakeLists file. Default value keeps the project as is.

How was the PR tested?

  • Unit-test with some sample data. All unit tests passed.
  • Print output values. The printed outputs look reasonable.
  • Executed container locally and it worked.

Notes

Adding .vscode as ignored directory (.gitignore)

This commit introduces a new optional (and disabled by default) report format module for JSON file. Really similar to the Text Report module, uses nlohmann-json as dependency which is obtained automatically by CMake via `FetchContent`.

To enable compilation of the module a specific option (`ASAM_QC_JSON_REPORT_FORMAT_ENABLE`) should be enabled in CMake at configuration time.

Side note, adding `.vscode` as ignored directory for the project.

Signed-off-by: Matteo Ragni <[email protected]>
@MatteoRagni MatteoRagni self-assigned this Sep 25, 2024
@MatteoRagni MatteoRagni added the isState:New A new issue that needs to be classified to a type. label Sep 25, 2024
@MatteoRagni
Copy link
Collaborator Author

@hoangtungdinh error in build for Linux Bare is related to XODR bundle. Do you know why it is raising while executing? I actually can reproduce the error on my machine. Should I open an issue?

@hoangtungdinh
Copy link
Collaborator

hoangtungdinh commented Sep 25, 2024

@MatteoRagni , thanks for the PR.

The error was because we refactored the checker bundles to follow the new architecture of "one checker per rule" (see #163). The configurations for the tests on the main branch are therefore outdated and not compatible with the latest checker bundles.

Can you rebase your PR on top of https://github.com/asam-ev/qc-framework/tree/2024-09-25, which will be merged tomorrow. This branch contains the updated configuration for the new checker bundles.

@hoangtungdinh
Copy link
Collaborator

I think this JSON Format Report is definitely useful. What do you think about implementing it in Python @MatteoRagni ?

Given the functionality of this module, a Python implementation seems trivial (a lot of effort goes into the schema, which can be reused). Having it in Python would simplify installation and manifest file registration a lot (just pip install).

Here are some related issues:

@MatteoRagni MatteoRagni changed the base branch from main to 2024-09-25 September 25, 2024 16:40
@MatteoRagni MatteoRagni marked this pull request as draft September 26, 2024 09:35
@MatteoRagni
Copy link
Collaborator Author

MatteoRagni commented Sep 26, 2024

  • Rebase
  • Add python implementation (I'll keep the C++ just because it is already there...)

This commit introduces a new optional (and disabled by default) report format module for JSON file. Really similar to the Text Report module, uses nlohmann-json as dependency which is obtained automatically by CMake via `FetchContent`.

To enable compilation of the module a specific option (`ASAM_QC_JSON_REPORT_FORMAT_ENABLE`) should be enabled in CMake at configuration time.

Side note, adding `.vscode` as ignored directory for the project.

Signed-off-by: Matteo Ragni <[email protected]>
@andreaskern74 andreaskern74 deleted the branch asam-ev:2024-09-25 September 26, 2024 14:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
isState:New A new issue that needs to be classified to a type.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants