Add maintenance work

README.md

@@ -1,6 +1,6 @@
 # asam-qc-openscenarioxml
 
-This project implements the [ASAM OpenScenario XML Checker](checker_bundle_doc.md).
+This project implements the [ASAM OpenScenario XML Checker Bundle](checker_bundle_doc.md).
 
 - [asam-qc-openscenarioxml](#asam-qc-openscenarioxml)
   - [Installation and usage](#installation-and-usage)
@@ -27,8 +27,11 @@ asam-qc-openscenarioxml can be installed using pip.
 pip install asam-qc-openscenarioxml@git+https://github.com/asam-ev/qc-openscenarioxml@main
 ```
 
-**Note**: To install from different sources, you can replace `@main` with
-your desired target. For example, `develop` branch as `@develop`.
+**Note:** The above command will install `asam-qc-openscenarioxml` from the `main` branch. If you want to install `asam-qc-openscenarioxml` from another branch or tag, replace `@main` with the desired branch or tag. It is also possible to install from a local directory.
+
+```bash
+pip install /home/user/qc-openscenarioxml
+```
 
 To run the application:
 

checker_bundle_doc.md

@@ -1,3 +1,4 @@
+
 # Checker bundle: xoscBundle
 
 * Build version:  0.1.0
@@ -41,7 +42,7 @@
 
 ### check_asam_xosc_reference_control_uniquely_resolvable_entity_references
 
-* Description: Input xml file must be valid according to the schema.
+* Description: Reference names must be unique
 * Addressed rules:
   * asam.net:xosc:1.2.0:reference_control.uniquely_resolvable_entity_references
 

qc_openscenario/__init__.py

@@ -1,2 +1,3 @@
 from . import constants as constants
 from . import checks as checks
+from . import basic_preconditions as basic_preconditions

qc_openscenario/checks/reference_checker/reference_checker_precondition.py → qc_openscenario/basic_preconditions.py

@@ -7,7 +7,7 @@
 
 from qc_openscenario.checks.schema_checker import valid_schema
 
-PRECONDITIONS = {
+CHECKER_PRECONDITIONS = {
     valid_xml_document.CHECKER_ID,
     root_tag_is_openscenario.CHECKER_ID,
     fileheader_is_present.CHECKER_ID,

qc_openscenario/checks/basic_checker/__init__.py

@@ -1,4 +1,3 @@
-from . import basic_checker as basic_checker
 from . import valid_xml_document as valid_xml_document
 from . import root_tag_is_openscenario as root_tag_is_openscenario
 from . import fileheader_is_present as fileheader_is_present

qc_openscenario/checks/basic_checker/fileheader_is_present.py

@@ -1,19 +1,24 @@
 import logging
-from lxml import etree
-from qc_baselib import IssueSeverity, Result, StatusType
+from qc_baselib import IssueSeverity
 
 from qc_openscenario import constants
+from qc_openscenario.checks import models
 
 from qc_openscenario.checks.basic_checker import (
     valid_xml_document,
     root_tag_is_openscenario,
 )
 
 CHECKER_ID = "check_asam_xosc_xml_fileheader_is_present"
-PRECONDITIONS = {valid_xml_document.CHECKER_ID, root_tag_is_openscenario.CHECKER_ID}
+CHECKER_DESCRIPTION = "Below the root element a tag with FileHeader must be defined."
+CHECKER_PRECONDITIONS = {
+    valid_xml_document.CHECKER_ID,
+    root_tag_is_openscenario.CHECKER_ID,
+}
+RULE_UID = "asam.net:xosc:1.0.0:xml.fileheader_is_present"
 
 
-def check_rule(tree: etree._ElementTree, result: Result) -> None:
+def check_rule(checker_data: models.CheckerData) -> None:
     """
     Below the root element a tag with FileHeader must be defined.
 
@@ -22,31 +27,7 @@ def check_rule(tree: etree._ElementTree, result: Result) -> None:
     """
     logging.info("Executing fileheader_is_present check")
 
-    result.register_checker(
-        checker_bundle_name=constants.BUNDLE_NAME,
-        checker_id=CHECKER_ID,
-        description="Below the root element a tag with FileHeader must be defined.",
-    )
-
-    rule_uid = result.register_rule(
-        checker_bundle_name=constants.BUNDLE_NAME,
-        checker_id=CHECKER_ID,
-        emanating_entity="asam.net",
-        standard="xosc",
-        definition_setting="1.0.0",
-        rule_full_name="xml.fileheader_is_present",
-    )
-
-    if not result.all_checkers_completed_without_issue(PRECONDITIONS):
-        result.set_checker_status(
-            checker_bundle_name=constants.BUNDLE_NAME,
-            checker_id=CHECKER_ID,
-            status=StatusType.SKIPPED,
-        )
-
-        return
-
-    root = tree.getroot()
+    root = checker_data.input_file_xml_root.getroot()
 
     is_valid = False
     # Check if root contains a tag 'FileHeader'
@@ -60,24 +41,18 @@ def check_rule(tree: etree._ElementTree, result: Result) -> None:
 
     if not is_valid:
 
-        issue_id = result.register_issue(
+        issue_id = checker_data.result.register_issue(
             checker_bundle_name=constants.BUNDLE_NAME,
             checker_id=CHECKER_ID,
-            description="Issue flagging when no FileHeader is found under root element",
+            description="No FileHeader found under root element",
             level=IssueSeverity.ERROR,
-            rule_uid=rule_uid,
+            rule_uid=RULE_UID,
         )
 
-        result.add_xml_location(
+        checker_data.result.add_xml_location(
             checker_bundle_name=constants.BUNDLE_NAME,
             checker_id=CHECKER_ID,
             issue_id=issue_id,
-            xpath=tree.getpath(root),
+            xpath=checker_data.input_file_xml_root.getpath(root),
             description=f'No child element "FileHeader"',
         )
-
-    result.set_checker_status(
-        checker_bundle_name=constants.BUNDLE_NAME,
-        checker_id=CHECKER_ID,
-        status=StatusType.COMPLETED,
-    )

qc_openscenario/checks/basic_checker/root_tag_is_openscenario.py

@@ -1,16 +1,18 @@
 import logging
-from lxml import etree
-from qc_baselib import IssueSeverity, Result, StatusType
+from qc_baselib import IssueSeverity
 
 from qc_openscenario import constants
+from qc_openscenario.checks import models
 
 from qc_openscenario.checks.basic_checker import valid_xml_document
 
 CHECKER_ID = "check_asam_xosc_xml_root_tag_is_openscenario"
-PRECONDITIONS = {valid_xml_document.CHECKER_ID}
+CHECKER_DESCRIPTION = "The root element of a valid XML document must be OpenSCENARIO."
+CHECKER_PRECONDITIONS = {valid_xml_document.CHECKER_ID}
+RULE_UID = "asam.net:xosc:1.0.0:xml.root_tag_is_openscenario"
 
 
-def check_rule(tree: etree._ElementTree, result: Result) -> None:
+def check_rule(checker_data: models.CheckerData) -> None:
     """
     The root element of a valid XML document must be OpenSCENARIO
 
@@ -19,31 +21,7 @@ def check_rule(tree: etree._ElementTree, result: Result) -> None:
     """
     logging.info("Executing root_tag_is_openscenario check")
 
-    result.register_checker(
-        checker_bundle_name=constants.BUNDLE_NAME,
-        checker_id=CHECKER_ID,
-        description="The root element of a valid XML document must be OpenSCENARIO.",
-    )
-
-    rule_uid = result.register_rule(
-        checker_bundle_name=constants.BUNDLE_NAME,
-        checker_id=CHECKER_ID,
-        emanating_entity="asam.net",
-        standard="xosc",
-        definition_setting="1.0.0",
-        rule_full_name="xml.root_tag_is_openscenario",
-    )
-
-    if not result.all_checkers_completed_without_issue(PRECONDITIONS):
-        result.set_checker_status(
-            checker_bundle_name=constants.BUNDLE_NAME,
-            checker_id=CHECKER_ID,
-            status=StatusType.SKIPPED,
-        )
-
-        return
-
-    root = tree.getroot()
+    root = checker_data.input_file_xml_root.getroot()
 
     is_valid = False
     if root.tag == "OpenSCENARIO":
@@ -55,24 +33,18 @@ def check_rule(tree: etree._ElementTree, result: Result) -> None:
 
     if not is_valid:
 
-        issue_id = result.register_issue(
+        issue_id = checker_data.result.register_issue(
             checker_bundle_name=constants.BUNDLE_NAME,
             checker_id=CHECKER_ID,
-            description="Issue flagging when root tag is not OpenSCENARIO",
+            description="Root tag is not OpenSCENARIO",
             level=IssueSeverity.ERROR,
-            rule_uid=rule_uid,
+            rule_uid=RULE_UID,
         )
 
-        result.add_xml_location(
+        checker_data.result.add_xml_location(
             checker_bundle_name=constants.BUNDLE_NAME,
             checker_id=CHECKER_ID,
             issue_id=issue_id,
-            xpath=tree.getpath(root),
+            xpath=checker_data.input_file_xml_root.getpath(root),
             description=f"Root is not OpenSCENARIO",
         )
-
-    result.set_checker_status(
-        checker_bundle_name=constants.BUNDLE_NAME,
-        checker_id=CHECKER_ID,
-        status=StatusType.COMPLETED,
-    )

qc_openscenario/checks/basic_checker/valid_xml_document.py

@@ -2,10 +2,14 @@
 
 from lxml import etree
 
-from qc_baselib import Result, IssueSeverity, StatusType
+from qc_baselib import IssueSeverity
 from qc_openscenario import constants
+from qc_openscenario.checks import models
 
 CHECKER_ID = "check_asam_xosc_xml_valid_xml_document"
+CHECKER_DESCRIPTION = "The given file to check must be a valid XML document."
+CHECKER_PRECONDITIONS = set()
+RULE_UID = "asam.net:xosc:1.0.0:xml.valid_xml_document"
 
 
 def _is_xml_doc(file_path: str) -> tuple[bool, tuple[int, int]]:
@@ -21,7 +25,7 @@ def _is_xml_doc(file_path: str) -> tuple[bool, tuple[int, int]]:
         return False, (e.lineno, e.offset)
 
 
-def check_rule(input_xml_file_path: str, result: Result) -> None:
+def check_rule(checker_data: models.CheckerData) -> None:
     """
     Implements a rule to check if input file is a valid xml document
 
@@ -30,44 +34,23 @@ def check_rule(input_xml_file_path: str, result: Result) -> None:
     """
     logging.info("Executing valid_xml_document check")
 
-    result.register_checker(
-        checker_bundle_name=constants.BUNDLE_NAME,
-        checker_id=CHECKER_ID,
-        description="The given file to check must be a valid XML document.",
-    )
-
-    rule_uid = result.register_rule(
-        checker_bundle_name=constants.BUNDLE_NAME,
-        checker_id=CHECKER_ID,
-        emanating_entity="asam.net",
-        standard="xosc",
-        definition_setting="1.0.0",
-        rule_full_name="xml.valid_xml_document",
-    )
-
-    is_valid, error_location = _is_xml_doc(input_xml_file_path)
+    is_valid, error_location = _is_xml_doc(checker_data.xml_file_path)
 
     if not is_valid:
 
-        issue_id = result.register_issue(
+        issue_id = checker_data.result.register_issue(
             checker_bundle_name=constants.BUNDLE_NAME,
             checker_id=CHECKER_ID,
             description="The input file is not a valid xml document",
             level=IssueSeverity.ERROR,
-            rule_uid=rule_uid,
+            rule_uid=RULE_UID,
         )
 
-        result.add_file_location(
+        checker_data.result.add_file_location(
             checker_bundle_name=constants.BUNDLE_NAME,
             checker_id=CHECKER_ID,
             issue_id=issue_id,
             row=error_location[0],
             column=error_location[1],
             description=f"Invalid xml file.",
         )
-
-    result.set_checker_status(
-        checker_bundle_name=constants.BUNDLE_NAME,
-        checker_id=CHECKER_ID,
-        status=StatusType.COMPLETED,
-    )