asam-ev / qc-framework

Mozilla Public License 2.0
13 stars 6 forks source link

Add violated and checked rule list in text report #80

Closed romanodanilo closed 4 weeks ago

romanodanilo commented 1 month ago

Description

Addressing #26 -> Add to text report module the list of checked and violated ruleUID

Also adding a new test for the runtime in which DemoCheckerBundle+ResultPooling+TextReport is executed

How was the PR tested?

  1. Previous and new test executed -> OK

Example output

====================================================================================================
QC4OpenX - Pooled results
====================================================================================================

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

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

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

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

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

Addressed vs Violated rules report 

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

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

Notes

Current xsd has:

Given this, there could be the chance that in a report file there are ruleUID present in the issue attribute, but not in the addressedRule Something like "I am addressing rule A,B,C, in my findings rule D gets violated"