Add text report module in python (#17)

* Add text report module in python Signed-off-by: romanodanilo <[email protected]> * Cleaned input and output text Signed-off-by: romanodanilo <[email protected]> * Add missing copyright notice Signed-off-by: romanodanilo <[email protected]> * Add test search_mode param Signed-off-by: romanodanilo <[email protected]> * Add newline in report module Signed-off-by: romanodanilo <[email protected]> --------- Signed-off-by: romanodanilo <[email protected]>
asam-ev · Jul 24, 2024 · 770a4ee · 770a4ee
1 parent 839a1cf
commit 770a4ee
Show file tree

Hide file tree

Showing 3 changed files with 160 additions and 4 deletions.
diff --git a/qc_baselib/models/result.py b/qc_baselib/models/result.py
@@ -44,9 +44,7 @@ class LocationType(BaseXmlModel):
     @model_validator(mode="after")
     def check_at_least_one_element(self) -> Any:
         if (
-            len(self.file_location)
-            + len(self.xml_location)
-            + len(self.inertial_location)
+            len(self.file_location) + len(self.xml_location) + len(self.inertial_location)
             < 1
         ):
             raise ValueError(
@@ -194,7 +192,7 @@ class StatusType(str, enum.Enum):
     SKIPPED = "skipped"
 
 
-class CheckerType(BaseXmlModel, validate_assignment=True):
+class CheckerType(BaseXmlModel, validate_assignment=True, search_mode="ordered"):
     addressed_rule: List[RuleType] = element(tag="AddressedRule", default=[])
     issues: List[IssueType] = element(tag="Issue", default=[])
     metadata: List[MetadataType] = element(tag="Metadata", default=[])

diff --git a/report_modules/report_module_text/report_format_text.py b/report_modules/report_module_text/report_format_text.py
@@ -0,0 +1,150 @@
+# Copyright 2024, ASAM e.V.
+# This Source Code Form is subject to the terms of the Mozilla
+# Public License, v. 2.0. If a copy of the MPL was not distributed
+# with this file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+import sys, os
+import logging
+import argparse
+
+from qc_baselib import Configuration, Result, IssueSeverity
+
+
+def is_valid_file(parser: argparse.ArgumentParser, arg: str) -> str:
+    """Check if provided argument follows specified extensions
+
+    Args:
+        parser (argparse.ArgumentParser): argparse object for handling errors
+        arg (str): input argument to check
+
+    Returns:
+        str: the argument if valid
+    """
+    if not os.path.exists(arg):
+        parser.error(f"The file {arg} does not exist!")
+    if not (arg.endswith(".xml") or arg.endswith(".xqar")):
+        parser.error("The file must have an .xml or .xqar extension!")
+    return arg
+
+
+def run_text_report(input_filename: str, report_filename: str):
+    """Execute text report logic and put the results in report_filename
+
+    Args:
+        input_filename (str): Input file from where reading the results to write
+        report_filename (str): Txt output file used for representing the result
+    """
+
+    result = Result()
+    result.load_from_file(input_filename)
+
+    # Open the file in write mode initially to wipe its content
+    report_file = open(report_filename, "w")
+    report_file.close()
+
+    # Open the file in append mode to add new content
+    report_file = open(report_filename, "a")
+
+    report_file.write("=" * 102 + "\n")
+    report_file.write("Python Text Report Module - Pooled Results\n")
+    report_file.write("=" * 102 + "\n")
+
+    # Checker bundles
+    for checker_bundle in result.get_checker_bundle_results():
+        report_file.write(f"\n    CheckerBundle: {checker_bundle.name}\n")
+        report_file.write(f"    Build date: {checker_bundle.build_date}\n")
+        report_file.write(f"    Build version: {checker_bundle.version}\n")
+        report_file.write(f"    Description: {checker_bundle.description}\n")
+        report_file.write(f"    Summary: {checker_bundle.summary}\n")
+        if len(checker_bundle.params) > 0:
+            report_file.write(f"    Parameters:\n")
+            for param in checker_bundle.params:
+                report_file.write(f"    {param.name} = {param.value}\n")
+
+        # Checkers
+        report_file.write("    " + "=" * 20 + "\n")
+        report_file.write("    " + "Checkers:\n")
+        report_file.write("    " + "=" * 20 + "\n")
+
+        for checker in checker_bundle.checkers:
+            report_file.write(f"\n        Checker:        {checker.checker_id}\n")
+            report_file.write(f"        Description:    {checker.description}\n")
+            if checker.status is None:
+                status_string = ""
+            else:
+                status_string = checker.status
+            report_file.write(f"        Status:    {status_string}\n")
+            report_file.write(f"        Summary:        {checker.summary}\n")
+
+            # Issues
+            report_file.write("        " + "=" * 20 + "\n")
+            report_file.write("        " + "Issues:\n")
+            report_file.write("        " + "=" * 20 + "\n")
+            for issue in checker.issues:
+                report_file.write(f"            Issue:              {issue.issue_id}\n")
+                report_file.write(
+                    f"            Description:        {issue.description}\n"
+                )
+                report_file.write(f"            Level:              {issue.level}\n")
+            # Addressed rules
+            if len(checker.addressed_rule) > 0:
+
+                report_file.write("        " + "=" * 20 + "\n")
+                report_file.write("        " + "Addressed rules:\n")
+                report_file.write("        " + "=" * 20 + "\n")
+                for addressed_rule in checker.addressed_rule:
+                    report_file.write(
+                        f"            Addressed Rule:     {addressed_rule.rule_uid}\n"
+                    )
+
+            # Metadata
+            if len(checker.metadata) > 0:
+                report_file.write("        " + "=" * 20 + "\n")
+                report_file.write("        " + "Metadata:\n")
+                report_file.write("        " + "=" * 20 + "\n")
+                for metadata in checker.metadata:
+                    report_file.write(f"            Metadata:        {metadata.key}\n")
+                    report_file.write(f"            Value:        {metadata.value}\n")
+                    report_file.write(
+                        f"            Description:        {metadata.description}\n"
+                    )
+
+    report_file.close()
+
+
+def main():
+    parser = argparse.ArgumentParser(description="Process XML configuration file.")
+    parser.add_argument(
+        "-f",
+        "--file",
+        type=lambda x: is_valid_file(parser, x),
+        help="Path to the input configuration file. Must be a xml or xqar file",
+        required=True,
+    )
+    args = parser.parse_args()
+
+    input_file = args.file
+    input_extension = os.path.splitext(input_file)[1]
+
+    # Default params
+    input_filename = "Result.xqar"
+    report_filename = "Report.txt"
+
+    if input_extension == ".xqar":
+        input_filename = input_file
+
+    # If xml file is provided, the reap input and output file params from it
+    if input_extension == ".xml":
+        configuration = Configuration()
+        configuration.load_from_file(input_file)
+        input_filename = configuration.get_config_param("strInputFile")
+        report_filename = configuration.get_config_param("strReportFile")
+
+    logging.debug(f"input_filename {input_filename}")
+    logging.debug(f"report_filename {report_filename}")
+
+    run_text_report(input_filename, report_filename)
+
+
+if __name__ == "__main__":
+    main()
diff --git a/report_modules/report_module_text/run.sh b/report_modules/report_module_text/run.sh
@@ -0,0 +1,8 @@
+# Copyright 2024, ASAM e.V.
+# This Source Code Form is subject to the terms of the Mozilla
+# Public License, v. 2.0. If a copy of the MPL was not distributed
+# with this file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+readonly CONFIG_FILE=$1
+
+python3 report_format_text.py -f $CONFIG_FILE