Add summary to result file and update state machine checks (#32)

Signed-off-by: hoangtungdinh <[email protected]>
asam-ev · Sep 25, 2024 · 7116f64 · 7116f64
1 parent edf9773
commit 7116f64
Show file tree

Hide file tree

Showing 14 changed files with 154 additions and 96 deletions.
diff --git a/poetry.lock b/poetry.lock
diff --git a/qc_otx/checks/core_checker/document_name_matches_filename.py b/qc_otx/checks/core_checker/document_name_matches_filename.py
@@ -30,14 +30,18 @@ def check_rule(checker_data: models.CheckerData) -> None:
     root_attrib = root.getroot().attrib
 
     if "name" not in root_attrib:
-        logging.error("No name attribute find in otx root node. Abort...")
-
         checker_data.result.set_checker_status(
             checker_bundle_name=constants.BUNDLE_NAME,
             checker_id=CHECKER_ID,
             status=StatusType.SKIPPED,
         )
 
+        checker_data.result.add_checker_summary(
+            constants.BUNDLE_NAME,
+            CHECKER_ID,
+            "No name attribute in otx root node. Skip the check.",
+        )
+
         return
 
     document_name = root_attrib["name"]

diff --git a/qc_otx/checks/core_checker/document_name_package_uniqueness.py b/qc_otx/checks/core_checker/document_name_package_uniqueness.py
@@ -61,26 +61,34 @@ def check_rule(checker_data: models.CheckerData) -> None:
 
     document_name = root.get("name")
     if document_name is None:
-        logging.error("No name attribute find in otx root node. Abort...")
-
         checker_data.result.set_checker_status(
             checker_bundle_name=constants.BUNDLE_NAME,
             checker_id=CHECKER_ID,
             status=StatusType.SKIPPED,
         )
 
+        checker_data.result.add_checker_summary(
+            constants.BUNDLE_NAME,
+            CHECKER_ID,
+            "No name attribute in otx root node. Skip the check.",
+        )
+
         return
 
     package_name = root.get("package")
     if package_name is None:
-        logging.error("No package attribute find in otx root node. Abort...")
-
         checker_data.result.set_checker_status(
             checker_bundle_name=constants.BUNDLE_NAME,
             checker_id=CHECKER_ID,
             status=StatusType.SKIPPED,
         )
 
+        checker_data.result.add_checker_summary(
+            constants.BUNDLE_NAME,
+            CHECKER_ID,
+            "No package attribute in otx root node. Skip the check.",
+        )
+
         return
 
     document_package_dot_name = package_name + "." + document_name
@@ -110,9 +118,6 @@ def check_rule(checker_data: models.CheckerData) -> None:
     package_root = os.path.join(package_root, package_splits[0])
 
     if not os.path.exists(package_root):
-        logging.error(
-            f"Error in setting package root {package_root}. Folder not found. Abort..."
-        )
         os.chdir(previous_wd)
 
         checker_data.result.set_checker_status(
@@ -121,6 +126,12 @@ def check_rule(checker_data: models.CheckerData) -> None:
             status=StatusType.SKIPPED,
         )
 
+        checker_data.result.add_checker_summary(
+            constants.BUNDLE_NAME,
+            CHECKER_ID,
+            f"The package root folder {package_root} does not exist. Skip the check.",
+        )
+
         return
     # Collect all otx file path from package root
     package_otx_files = find_otx_files(package_root)

diff --git a/qc_otx/checks/core_checker/match_of_imported_document_data_model_version.py b/qc_otx/checks/core_checker/match_of_imported_document_data_model_version.py
@@ -35,31 +35,37 @@ def check_rule(checker_data: models.CheckerData) -> None:
 
     source_data_model_version = utils.get_data_model_version(root)
     if source_data_model_version is None:
-        logging.error(
-            "xmlns version not found in current document root. Skipping check.."
-        )
-
         checker_data.result.set_checker_status(
             checker_bundle_name=constants.BUNDLE_NAME,
             checker_id=CHECKER_ID,
             status=StatusType.SKIPPED,
         )
 
+        checker_data.result.add_checker_summary(
+            constants.BUNDLE_NAME,
+            CHECKER_ID,
+            f"xmlns version not found in current document root. Skip the check.",
+        )
+
         return
 
     logging.debug(f"source_data_model_version: {source_data_model_version}")
 
     import_nodes = root.findall(".//import", namespaces=root.nsmap)
 
     if import_nodes is None:
-        logging.error("No import nodes found. Skipping check..")
-
         checker_data.result.set_checker_status(
             checker_bundle_name=constants.BUNDLE_NAME,
             checker_id=CHECKER_ID,
             status=StatusType.SKIPPED,
         )
 
+        checker_data.result.add_checker_summary(
+            constants.BUNDLE_NAME,
+            CHECKER_ID,
+            f"No import nodes found. Skip the check.",
+        )
+
         return
 
     # Store previous working directory and move to config path dir for relative package paths

diff --git a/qc_otx/checks/core_checker/no_use_of_undefined_import_prefixes.py b/qc_otx/checks/core_checker/no_use_of_undefined_import_prefixes.py
@@ -35,14 +35,18 @@ def check_rule(checker_data: models.CheckerData) -> None:
     import_nodes = root.findall(".//import", namespaces=root.nsmap)
 
     if import_nodes is None:
-        logging.error("No import nodes found. Skipping check..")
-
         checker_data.result.set_checker_status(
             checker_bundle_name=constants.BUNDLE_NAME,
             checker_id=CHECKER_ID,
             status=StatusType.SKIPPED,
         )
 
+        checker_data.result.add_checker_summary(
+            constants.BUNDLE_NAME,
+            CHECKER_ID,
+            f"No import nodes found. Skip the check.",
+        )
+
         return
 
     import_prefixes = [x.get("prefix") for x in import_nodes]

diff --git a/qc_otx/checks/state_machine_checker/distinguished_initial_and_completed_state.py b/qc_otx/checks/state_machine_checker/distinguished_initial_and_completed_state.py
@@ -45,6 +45,12 @@ def check_rule(checker_data: models.CheckerData) -> None:
             status=StatusType.SKIPPED,
         )
 
+        checker_data.result.add_checker_summary(
+            constants.BUNDLE_NAME,
+            CHECKER_ID,
+            f"No state machine procedure prefix 'smp' found in document namespaces. Skip the check.",
+        )
+
         return
 
     state_machine_procedures = utils.get_state_machine_procedures(tree, nsmap)
@@ -56,6 +62,12 @@ def check_rule(checker_data: models.CheckerData) -> None:
             status=StatusType.SKIPPED,
         )
 
+        checker_data.result.add_checker_summary(
+            constants.BUNDLE_NAME,
+            CHECKER_ID,
+            f"State machine procedures not found. Skip the check.",
+        )
+
         return
 
     logging.debug(f"state_machine_procedures: {state_machine_procedures}")
@@ -66,30 +78,15 @@ def check_rule(checker_data: models.CheckerData) -> None:
         state_machine = utils.get_state_machine(state_machine_procedure, nsmap)
 
         if state_machine is None:
-            checker_data.result.set_checker_status(
-                checker_bundle_name=constants.BUNDLE_NAME,
-                checker_id=CHECKER_ID,
-                status=StatusType.SKIPPED,
-            )
-
-            return
+            continue
 
         smp_realisation = state_machine_procedure.xpath(
             "./smp:realisation", namespaces=nsmap
         )
         logging.debug(f"smp_realisation: {smp_realisation}")
 
         if smp_realisation is None or len(smp_realisation) != 1:
-            logging.error(
-                f"Invalid realisation found in current state machine procedure"
-            )
-
-            checker_data.result.set_checker_status(
-                checker_bundle_name=constants.BUNDLE_NAME,
-                checker_id=CHECKER_ID,
-                status=StatusType.SKIPPED,
-            )
-            return
+            continue
 
         smp_realisation = smp_realisation[0]
 

diff --git a/qc_otx/checks/state_machine_checker/mandatory_target_state.py b/qc_otx/checks/state_machine_checker/mandatory_target_state.py
@@ -31,28 +31,35 @@ def check_rule(checker_data: models.CheckerData) -> None:
     nsmap = utils.get_namespace_map(tree)
 
     if "smp" not in nsmap:
-        logging.error(
-            'No state machine procedure prefix "smp" found in document namespaces. Abort state machine procedure checks...'
-        )
-
         checker_data.result.set_checker_status(
             checker_bundle_name=constants.BUNDLE_NAME,
             checker_id=CHECKER_ID,
             status=StatusType.SKIPPED,
         )
 
+        checker_data.result.add_checker_summary(
+            constants.BUNDLE_NAME,
+            CHECKER_ID,
+            f"No state machine procedure prefix 'smp' found in document namespaces. Skip the check.",
+        )
+
         return
 
     state_machine_procedures = utils.get_state_machine_procedures(tree, nsmap)
 
     if state_machine_procedures is None:
-
         checker_data.result.set_checker_status(
             checker_bundle_name=constants.BUNDLE_NAME,
             checker_id=CHECKER_ID,
             status=StatusType.SKIPPED,
         )
 
+        checker_data.result.add_checker_summary(
+            constants.BUNDLE_NAME,
+            CHECKER_ID,
+            f"State machine procedures not found. Skip the check.",
+        )
+
         return
 
     logging.debug(f"state_machine_procedures: {state_machine_procedures}")
@@ -63,13 +70,7 @@ def check_rule(checker_data: models.CheckerData) -> None:
         state_machine = utils.get_state_machine(state_machine_procedure, nsmap)
 
         if state_machine is None:
-            checker_data.result.set_checker_status(
-                checker_bundle_name=constants.BUNDLE_NAME,
-                checker_id=CHECKER_ID,
-                status=StatusType.SKIPPED,
-            )
-
-            return
+            continue
 
         for sm_state in state_machine.states:
             has_issue = (

diff --git a/qc_otx/checks/state_machine_checker/mandatory_transition.py b/qc_otx/checks/state_machine_checker/mandatory_transition.py
@@ -33,28 +33,35 @@ def check_rule(checker_data: models.CheckerData) -> None:
     nsmap = utils.get_namespace_map(tree)
 
     if "smp" not in nsmap:
-        logging.error(
-            'No state machine procedure prefix "smp" found in document namespaces. Abort state machine procedure checks...'
-        )
-
         checker_data.result.set_checker_status(
             checker_bundle_name=constants.BUNDLE_NAME,
             checker_id=CHECKER_ID,
             status=StatusType.SKIPPED,
         )
 
+        checker_data.result.add_checker_summary(
+            constants.BUNDLE_NAME,
+            CHECKER_ID,
+            f"No state machine procedure prefix 'smp' found in document namespaces. Skip the check.",
+        )
+
         return
 
     state_machine_procedures = utils.get_state_machine_procedures(tree, nsmap)
 
     if state_machine_procedures is None:
-
         checker_data.result.set_checker_status(
             checker_bundle_name=constants.BUNDLE_NAME,
             checker_id=CHECKER_ID,
             status=StatusType.SKIPPED,
         )
 
+        checker_data.result.add_checker_summary(
+            constants.BUNDLE_NAME,
+            CHECKER_ID,
+            f"State machine procedures not found. Skip the check.",
+        )
+
         return
 
     logging.debug(f"state_machine_procedures: {state_machine_procedures}")
@@ -65,14 +72,7 @@ def check_rule(checker_data: models.CheckerData) -> None:
         state_machine = utils.get_state_machine(state_machine_procedure, nsmap)
 
         if state_machine is None:
-
-            checker_data.result.set_checker_status(
-                checker_bundle_name=constants.BUNDLE_NAME,
-                checker_id=CHECKER_ID,
-                status=StatusType.SKIPPED,
-            )
-
-            return
+            continue
 
         for sm_state in state_machine.states:
             has_issue = not sm_state.is_completed and len(sm_state.transitions) == 0

diff --git a/qc_otx/checks/state_machine_checker/mandatory_trigger.py b/qc_otx/checks/state_machine_checker/mandatory_trigger.py
@@ -33,16 +33,18 @@ def check_rule(checker_data: models.CheckerData) -> None:
     nsmap = utils.get_namespace_map(tree)
 
     if "smp" not in nsmap:
-        logging.error(
-            'No state machine procedure prefix "smp" found in document namespaces. Abort state machine procedure checks...'
-        )
-
         checker_data.result.set_checker_status(
             checker_bundle_name=constants.BUNDLE_NAME,
             checker_id=CHECKER_ID,
             status=StatusType.SKIPPED,
         )
 
+        checker_data.result.add_checker_summary(
+            constants.BUNDLE_NAME,
+            CHECKER_ID,
+            f"No state machine procedure prefix 'smp' found in document namespaces. Skip the check.",
+        )
+
         return
 
     state_machine_procedures = utils.get_state_machine_procedures(tree, nsmap)
@@ -54,6 +56,12 @@ def check_rule(checker_data: models.CheckerData) -> None:
             status=StatusType.SKIPPED,
         )
 
+        checker_data.result.add_checker_summary(
+            constants.BUNDLE_NAME,
+            CHECKER_ID,
+            f"State machine procedures not found. Skip the check.",
+        )
+
         return
 
     logging.debug(f"state_machine_procedures: {state_machine_procedures}")
@@ -64,14 +72,7 @@ def check_rule(checker_data: models.CheckerData) -> None:
         state_machine = utils.get_state_machine(state_machine_procedure, nsmap)
 
         if state_machine is None:
-
-            checker_data.result.set_checker_status(
-                checker_bundle_name=constants.BUNDLE_NAME,
-                checker_id=CHECKER_ID,
-                status=StatusType.SKIPPED,
-            )
-
-            return
+            continue
 
         for sm_state in state_machine.states:
             has_issue = not sm_state.is_completed and len(sm_state.triggers) == 0