compliance_tool: add verification of Extensions

Previously, the compliance tool would ignore `Extensions` of objects.
However, during the update to V3.0 and the changes to the JSON/XML
formats, we noticed that the adapters aren't properly tested this way.

The validation of `Extensions` can be disabled via the flag
`--dont-check-extensions` or the keyword argument `check_extensions` to
`AASDataChecker`, since many users are probably only interested in
comparing the main model, without any extensions.

Author: jkhsjdhjs

basyx/aas/compliance_tool/cli.py

@@ -82,6 +82,7 @@ def parse_cli_arguments() -> argparse.ArgumentParser:
     group.add_argument('--xml', help="Use AAS xml format when checking or creating files", action='store_true')
     parser.add_argument('-l', '--logfile', help="Log file to be created in addition to output to stdout", default=None)
     parser.add_argument('--aasx', help="Create or read AASX files", action='store_true')
+    parser.add_argument('--dont-check-extensions', help="Don't compare Extensions", action='store_false')
     return parser
 
 
@@ -96,6 +97,10 @@ def main():
     logger.propagate = False
     logger.addHandler(manager)
 
+    data_checker_kwargs = {
+        'check_extensions': args.dont_check_extensions
+    }
+
     if args.action == 'create' or args.action == 'c':
         manager.add_step('Create example data')
         if args.aasx:
@@ -154,19 +159,22 @@ def main():
             compliance_tool_xml.check_deserialization(args.file_1, manager)
     elif args.action == 'example' or args.action == 'e':
         if args.aasx:
-            compliance_tool_aasx.check_aas_example(args.file_1, manager)
+            compliance_tool_aasx.check_aas_example(args.file_1, manager, **data_checker_kwargs)
         elif args.json:
-            compliance_tool_json.check_aas_example(args.file_1, manager)
+            compliance_tool_json.check_aas_example(args.file_1, manager, **data_checker_kwargs)
         elif args.xml:
-            compliance_tool_xml.check_aas_example(args.file_1, manager)
+            compliance_tool_xml.check_aas_example(args.file_1, manager, **data_checker_kwargs)
     elif args.action == 'files' or args.action == 'f':
         if args.file_2:
             if args.aasx:
-                compliance_tool_aasx.check_aasx_files_equivalence(args.file_1, args.file_2, manager)
+                compliance_tool_aasx.check_aasx_files_equivalence(args.file_1, args.file_2, manager,
+                                                                  **data_checker_kwargs)
             elif args.json:
-                compliance_tool_json.check_json_files_equivalence(args.file_1, args.file_2, manager)
+                compliance_tool_json.check_json_files_equivalence(args.file_1, args.file_2, manager,
+                                                                  **data_checker_kwargs)
             elif args.xml:
-                compliance_tool_xml.check_xml_files_equivalence(args.file_1, args.file_2, manager)
+                compliance_tool_xml.check_xml_files_equivalence(args.file_1, args.file_2, manager,
+                                                                **data_checker_kwargs)
         else:
             parser.error("f or files requires two file path.")
             exit()

basyx/aas/compliance_tool/compliance_check_aasx.py

@@ -158,7 +158,7 @@ def check_schema(file_path: str, state_manager: ComplianceToolStateManager) -> N
         reader.close()
 
 
-def check_aas_example(file_path: str, state_manager: ComplianceToolStateManager) -> None:
+def check_aas_example(file_path: str, state_manager: ComplianceToolStateManager, **kwargs) -> None:
     """
     Checks if a file contains all elements of the aas example and reports any issues using the given
     :class:`~aas.compliance_tool.state_manager.ComplianceToolStateManager`
@@ -168,6 +168,7 @@ def check_aas_example(file_path: str, state_manager: ComplianceToolStateManager)
 
     :param file_path: Given file which should be checked
     :param state_manager: :class:`~aas.compliance_tool.state_manager.ComplianceToolStateManager` to log the steps
+    :param kwargs: Additional arguments to pass to :class:`~aas.examples.data._helper.AASDataChecker`
     """
     logger = logging.getLogger('compliance_check')
     logger.addHandler(state_manager)
@@ -189,7 +190,7 @@ def check_aas_example(file_path: str, state_manager: ComplianceToolStateManager)
         state_manager.set_step_status(Status.NOT_EXECUTED)
         return
 
-    checker = AASDataChecker(raise_immediately=False)
+    checker = AASDataChecker(raise_immediately=False, **kwargs)
 
     state_manager.add_step('Check if data is equal to example data')
     example_data = create_example_aas_binding()
@@ -267,7 +268,8 @@ def check_aas_example(file_path: str, state_manager: ComplianceToolStateManager)
         state_manager.set_step_status(Status.SUCCESS)
 
 
-def check_aasx_files_equivalence(file_path_1: str, file_path_2: str, state_manager: ComplianceToolStateManager) -> None:
+def check_aasx_files_equivalence(file_path_1: str, file_path_2: str, state_manager: ComplianceToolStateManager,
+                                 **kwargs) -> None:
     """
     Checks if two aasx files contain the same elements in any order and reports any issues using the given
     :class:`~aas.compliance_tool.state_manager.ComplianceToolStateManager`
@@ -278,6 +280,7 @@ def check_aasx_files_equivalence(file_path_1: str, file_path_2: str, state_manag
     :param file_path_1: Given first file which should be checked
     :param file_path_2: Given second file which should be checked
     :param state_manager: :class:`~aas.compliance_tool.state_manager.ComplianceToolStateManager` to log the steps
+    :param kwargs: Additional arguments to pass to :class:`~aas.examples.data._helper.AASDataChecker`
     """
     logger = logging.getLogger('compliance_check')
     logger.addHandler(state_manager)
@@ -295,7 +298,7 @@ def check_aasx_files_equivalence(file_path_1: str, file_path_2: str, state_manag
         state_manager.set_step_status(Status.NOT_EXECUTED)
         return
 
-    checker = AASDataChecker(raise_immediately=False)
+    checker = AASDataChecker(raise_immediately=False, **kwargs)
     try:
         state_manager.add_step('Check if data in files are equal')
         checker.check_object_store(obj_store_1, obj_store_2)

basyx/aas/compliance_tool/compliance_check_json.py

@@ -162,7 +162,7 @@ def check_deserialization(file_path: str, state_manager: ComplianceToolStateMana
     return obj_store
 
 
-def check_aas_example(file_path: str, state_manager: ComplianceToolStateManager) -> None:
+def check_aas_example(file_path: str, state_manager: ComplianceToolStateManager, **kwargs) -> None:
     """
     Checks if a file contains all elements of the aas example and reports any issues using the given
     :class:`~aas.compliance_tool.state_manager.ComplianceToolStateManager`
@@ -172,6 +172,7 @@ def check_aas_example(file_path: str, state_manager: ComplianceToolStateManager)
 
     :param file_path: Given file which should be checked
     :param state_manager: :class:`~aas.compliance_tool.state_manager.ComplianceToolStateManager` to log the steps
+    :param kwargs: Additional arguments to pass to :class:`~aas.examples.data._helper.AASDataChecker`
     """
     # create handler to get logger info
     logger_example = logging.getLogger(example_aas.__name__)
@@ -186,15 +187,16 @@ def check_aas_example(file_path: str, state_manager: ComplianceToolStateManager)
         state_manager.set_step_status(Status.NOT_EXECUTED)
         return
 
-    checker = AASDataChecker(raise_immediately=False)
+    checker = AASDataChecker(raise_immediately=False, **kwargs)
 
     state_manager.add_step('Check if data is equal to example data')
     checker.check_object_store(obj_store, create_example())
 
     state_manager.add_log_records_from_data_checker(checker)
 
 
-def check_json_files_equivalence(file_path_1: str, file_path_2: str, state_manager: ComplianceToolStateManager) -> None:
+def check_json_files_equivalence(file_path_1: str, file_path_2: str, state_manager: ComplianceToolStateManager,
+                                 **kwargs) -> None:
     """
     Checks if two json files contain the same elements in any order and reports any issues using the given
     :class:`~aas.compliance_tool.state_manager.ComplianceToolStateManager`
@@ -205,6 +207,7 @@ def check_json_files_equivalence(file_path_1: str, file_path_2: str, state_manag
     :param file_path_1: Given first file which should be checked
     :param file_path_2: Given second file which should be checked
     :param state_manager: :class:`~aas.compliance_tool.state_manager.ComplianceToolStateManager` to log the steps
+    :param kwargs: Additional arguments to pass to :class:`~aas.examples.data._helper.AASDataChecker`
     """
     logger = logging.getLogger('compliance_check')
     logger.addHandler(state_manager)
@@ -220,7 +223,7 @@ def check_json_files_equivalence(file_path_1: str, file_path_2: str, state_manag
         state_manager.set_step_status(Status.NOT_EXECUTED)
         return
 
-    checker = AASDataChecker(raise_immediately=False)
+    checker = AASDataChecker(raise_immediately=False, **kwargs)
     try:
         state_manager.add_step('Check if data in files are equal')
         checker.check_object_store(obj_store_1, obj_store_2)

basyx/aas/compliance_tool/compliance_check_xml.py

@@ -162,7 +162,7 @@ def check_deserialization(file_path: str, state_manager: ComplianceToolStateMana
     return obj_store
 
 
-def check_aas_example(file_path: str, state_manager: ComplianceToolStateManager) -> None:
+def check_aas_example(file_path: str, state_manager: ComplianceToolStateManager, **kwargs) -> None:
     """
     Checks if a file contains all elements of the aas example and reports any issues using the given
     :class:`~aas.compliance_tool.state_manager.ComplianceToolStateManager`
@@ -172,6 +172,7 @@ def check_aas_example(file_path: str, state_manager: ComplianceToolStateManager)
 
     :param file_path: Given file which should be checked
     :param state_manager: :class:`~aas.compliance_tool.state_manager.ComplianceToolStateManager` to log the steps
+    :param kwargs: Additional arguments to pass to :class:`~aas.examples.data._helper.AASDataChecker`
     """
     # create handler to get logger info
     logger_example = logging.getLogger(example_aas.__name__)
@@ -186,15 +187,16 @@ def check_aas_example(file_path: str, state_manager: ComplianceToolStateManager)
         state_manager.set_step_status(Status.NOT_EXECUTED)
         return
 
-    checker = AASDataChecker(raise_immediately=False)
+    checker = AASDataChecker(raise_immediately=False, **kwargs)
 
     state_manager.add_step('Check if data is equal to example data')
     checker.check_object_store(obj_store, create_example())
 
     state_manager.add_log_records_from_data_checker(checker)
 
 
-def check_xml_files_equivalence(file_path_1: str, file_path_2: str, state_manager: ComplianceToolStateManager) -> None:
+def check_xml_files_equivalence(file_path_1: str, file_path_2: str, state_manager: ComplianceToolStateManager,
+                                **kwargs) -> None:
     """
     Checks if two xml files contain the same elements in any order and reports any issues using the given
     :class:`~aas.compliance_tool.state_manager.ComplianceToolStateManager`
@@ -205,6 +207,7 @@ def check_xml_files_equivalence(file_path_1: str, file_path_2: str, state_manage
     :param file_path_1: Given first file which should be checked
     :param file_path_2: Given second file which should be checked
     :param state_manager: :class:`~aas.compliance_tool.state_manager.ComplianceToolStateManager` to log the steps
+    :param kwargs: Additional arguments to pass to :class:`~aas.examples.data._helper.AASDataChecker`
     """
     logger = logging.getLogger('compliance_check')
     logger.addHandler(state_manager)
@@ -220,7 +223,7 @@ def check_xml_files_equivalence(file_path_1: str, file_path_2: str, state_manage
         state_manager.set_step_status(Status.NOT_EXECUTED)
         return
 
-    checker = AASDataChecker(raise_immediately=False)
+    checker = AASDataChecker(raise_immediately=False, **kwargs)
     try:
         state_manager.add_step('Check if data in files are equal')
         checker.check_object_store(obj_store_1, obj_store_2)