asam-ev / qc-framework

Mozilla Public License 2.0
15 stars 8 forks source link

Add metadata and domain info to text report #89

Closed romanodanilo closed 3 months ago

romanodanilo commented 3 months ago

Description

How was the PR tested?

  1. Unit-test with sample data. All unit tests passed.
  2. Generated text report
    
    ====================================================================================================
    QC4OpenX - Pooled results
    ====================================================================================================

==================================================================================================== CheckerBundle: DemoCheckerBundle Build date:
Build version:
Description:
Summary: Found 4 issues

Checker:        exampleChecker
Description:    This is a description
Status:         completed
Summary:        
    Info:       #0: This is an information from the demo usecase

Checker:        exampleInertialChecker
Description:    This is a description of inertial checker
Status:         completed
Summary:        
    Info:       #1: This is an information from the demo usecase
                inertial position
                   Location: x=1 y=2 z=3

Checker:        exampleRuleUIDChecker
Description:    This is a description of ruleUID checker
Status:         completed
Summary:        

    Addressed Rules:        
    - rule:        test.com::qwerty.qwerty

    Metadata:        
    ----------------
    - key:          run date
    - value:        2024/06/06
    - description:  Date in which the checker was executed
    ----------------
    ----------------
    - key:          reference project
    - value:        project01
    - description:  Name of the project that created the checker
    ----------------

Checker:        exampleIssueRuleChecker
Description:    This is a description of checker with issue and the involved ruleUID
Status:         completed
Summary:        
    Error:      #2: This is an information from the demo usecase

Checker:        exampleSkippedChecker
Description:    This is a description of checker with skipped status
Status:         skipped
Summary:        Skipped execution

Checker:        exampleDomainChecker
Description:    This is a description of example domain info checker
Status:         completed
Summary:        
    Info:       #3: This is an information from the demo usecase
    Name:       test_domain
                <DomainSpecificInfo name="test_domain">

                  <RoadLocation b="5.4" c="0.0" id="aa"></RoadLocation>

                </DomainSpecificInfo>

====================================================================================================

Addressed vs Violated rules report

Total number of addressed rules: 1 -> Addressed RuleUID: test.com::qwerty.qwerty

Total number of violated rules: 1 -> Violated RuleUID: test.com::qwerty.qwerty

====================================================================================================