add const UID attribute to allow constant IDs

tests/vspec/test_static_uids/test_static_uids.py

@@ -27,14 +27,24 @@
 # HELPERS
 
 
-def get_cla_test(test_file: str):
-    return (
-        "../../../vspec2id.py "
-        + test_file
-        + " ./out.vspec --validate-static-uid "
-        + "./validation_vspecs/validation.vspec "
-        + "--only-validate-no-export"
-    )
+def get_cla_test(test_file: str, overlay: str | None = None):
+    if overlay:
+        return (
+            "../../../vspec2id.py "
+            + test_file
+            + " -o "
+            + overlay
+            + " ./out.vspec --validate-static-uid "
+            + "./validation_vspecs/validation.vspec "
+        )
+    else:
+        return (
+            "../../../vspec2id.py "
+            + test_file
+            + " ./out.vspec --validate-static-uid "
+            + "./validation_vspecs/validation.vspec "
+            + "--only-validate-no-export"
+        )
 
 
 def get_cla_validation(validation_file: str):
@@ -341,3 +351,31 @@ def test_deleted_attribute(caplog: pytest.LogCaptureFixture):
     )
     for record in caplog.records:
         assert "DELETED ATTRIBUTE" in record.msg
+
+
+@pytest.mark.usefixtures("change_test_dir")
+def test_overlay(caplog: pytest.LogCaptureFixture):
+    test_file: str = "./test_vspecs/test.vspec"
+    overlay: str = "./test_vspecs/test_overlay.vspec"
+    clas = shlex.split(get_cla_test(test_file, overlay))
+    vspec2id.main(clas[1:])
+
+    assert len(caplog.records) == 1 and all(
+        log.levelname == "WARNING" for log in caplog.records
+    )
+
+    for record in caplog.records:
+        assert "ADDED ATTRIBUTE" in record.msg
+
+
+@pytest.mark.usefixtures("change_test_dir")
+def test_const_id(caplog: pytest.LogCaptureFixture):
+    test_file: str = "./test_vspecs/test.vspec"
+    overlay: str = "./test_vspecs/test_const_id.vspec"
+    clas = shlex.split(get_cla_test(test_file, overlay))
+    vspec2id.main(clas[1:])
+
+    result = yaml.load(open("./out.vspec"), Loader=yaml.FullLoader)
+    for key, value in get_all_keys_values(result):
+        if key == "A.B.Int32":
+            assert value["staticUID"] == "0x00112233"

tests/vspec/test_static_uids/test_vspecs/test_const_id.vspec

@@ -0,0 +1,12 @@
+# Copyright (c) 2024 Contributors to COVESA
+#
+# This program and the accompanying materials are made available under the
+# terms of the Mozilla Public License 2.0 which is available at
+# https://www.mozilla.org/en-US/MPL/2.0/
+#
+# SPDX-License-Identifier: MPL-2.0
+
+A.B.Int32:
+  datatype: int32
+  type: sensor
+  constUID: '0x00112233'

tests/vspec/test_static_uids/test_vspecs/test_overlay.vspec

@@ -0,0 +1,12 @@
+# Copyright (c) 2024 Contributors to COVESA
+#
+# This program and the accompanying materials are made available under the
+# terms of the Mozilla Public License 2.0 which is available at
+# https://www.mozilla.org/en-US/MPL/2.0/
+#
+# SPDX-License-Identifier: MPL-2.0
+
+A.B.OverlayNode:
+  datatype: int32
+  type: sensor
+  description: This is the description of the overlay node.

vspec/model/vsstree.py

@@ -68,6 +68,7 @@ class VSSNode(Node):
         "$file_name$",
         "fka",
         "delete",
+        "constUID",
     ]
 
     # List of accepted extended attributes. In strict terminate if an attribute is
@@ -90,6 +91,7 @@ class VSSNode(Node):
     deprecation = ""
     fka = ""
     delete: bool = False
+    constUID: str | None = None
 
     def __deepcopy__(self, memo):
         # Deep copy of source_dict and children needed as overlay or programmatic changes
@@ -252,7 +254,7 @@ def validate_name_style(self, sourcefile):
                 )
             )
 
-        camel_regexp = re.compile('[A-Z][A-Za-z0-9]*$')
+        camel_regexp = re.compile("[A-Z][A-Za-z0-9]*$")
         # relax camel case requirement for struct properties
         if not self.is_property() and not camel_regexp.match(self.name):
             raise NameStyleValidationException(

vspec/vssexporters/vss2id.py

@@ -22,16 +22,18 @@
 from vspec.model.constants import VSSTreeType
 from vspec.model.vsstree import VSSNode
 from vspec.utils import vss2id_val
-from vspec.utils.idgen_utils import (fnv1_32_hash, get_all_keys_values,
-                                     get_node_identifier_bytes)
+from vspec.utils.idgen_utils import (
+    fnv1_32_hash,
+    get_all_keys_values,
+    get_node_identifier_bytes,
+)
 from vspec.vss2x import Vss2X
 from vspec.vspec2vss_config import Vspec2VssConfig
 
 
 def generate_split_id(
     node: VSSNode, id_counter: int, strict_mode: bool
 ) -> Tuple[str, int]:
-
     """Generates static UIDs using 4-byte FNV-1 hash.
 
     @param node: VSSNode that we want to generate a static UID for
@@ -68,7 +70,15 @@ def export_node(yaml_dict, node, id_counter, strict_mode: bool) -> Tuple[int, in
     @param strict_mode: strict mode means case sensitivity for static UID generation
     @return: id_counter, id_counter
     """
-    node_id, id_counter = generate_split_id(node, id_counter, strict_mode)
+
+    if not node.constUID:
+        node_id, id_counter = generate_split_id(node, id_counter, strict_mode)
+    else:
+        assert node.constUID.startswith(
+            "0x"
+        ), f"constUID has to begin with '0x': {node.constUID}"
+        assert len(node.constUID) == 10, f"Invalid constUID: {node.constUID}"
+        node_id = node.constUID[2:]
 
     # check for hash duplicates
     for key, value in get_all_keys_values(yaml_dict):
@@ -121,7 +131,10 @@ def add_arguments(self, parser: argparse.ArgumentParser) -> None:
         @param parser: the pre-existing argument parser
         """
         parser.add_argument(
-            "--validate-static-uid", type=str, default="", help="Path to validation file."
+            "--validate-static-uid",
+            type=str,
+            default="",
+            help="Path to validation file.",
         )
         parser.add_argument(
             "--only-validate-no-export",
@@ -135,9 +148,13 @@ def add_arguments(self, parser: argparse.ArgumentParser) -> None:
             help="Strict mode means that the generation of static UIDs is case-sensitive.",
         )
 
-    def generate(self, config: argparse.Namespace, signal_root: VSSNode, vspec2vss_config: Vspec2VssConfig,
-                 data_type_root: Optional[VSSNode] = None) -> None:
-
+    def generate(
+        self,
+        config: argparse.Namespace,
+        signal_root: VSSNode,
+        vspec2vss_config: Vspec2VssConfig,
+        data_type_root: Optional[VSSNode] = None,
+    ) -> None:
         """Main export function used to generate the output id vspec.
 
         @param config: Command line arguments it was run with