Add functionality to validating macros

Author: OCopping

src/techui_builder/validator.py

@@ -4,6 +4,7 @@
 from pathlib import Path
 
 from lxml import etree
+from lxml.objectify import ObjectifiedElement
 from phoebusgen.widget.widgets import ActionButton, EmbeddedDisplay
 
 from techui_builder.utils import read_bob
@@ -74,4 +75,43 @@ def validate_bob(
                         f"{pwidget.get_element_value('file')} != {file_widget.file}"
                     )
 
+                    self._validate_macros(pwidget, file_widget)
+
         LOGGER.info(f"{screen_name}.bob has been validated successfully")
+
+    def _validate_macros(
+        self, pwidget: EmbeddedDisplay | ActionButton, file_widget: ObjectifiedElement
+    ):
+        pmacros_element = pwidget.find_element("macros")
+        # Annoyingly iterating over this also includes the element tag\
+        # so it needs ignoring, hence the '!= "macros"'
+        pmacros = {
+            macro.tag: macro.text for macro in pmacros_element if macro.tag != "macros"
+        }
+        pmacros_keys = set(pmacros.keys())
+
+        fmacros = file_widget.macros.getchildren()
+        fmacros_keys = {str(macro.tag) for macro in fmacros}
+
+        # Checks if there is any difference in expected macros
+        diff_expected_macros = pmacros_keys - fmacros_keys
+        if diff_expected_macros:
+            LOGGER.error(
+                f"Expected macros {diff_expected_macros} missing from \
+{file_widget.name}."
+            )
+
+            # ---------- This is how we could overwrite macros in the future ----------
+
+            # for expected_macro in diff_expected_macros:
+            #     macro_element = Element(expected_macro)
+            #     # Get the macro value from generated pwidget macros
+            #     macro_element.text = pmacros[expected_macro]
+            #     print(pmacros[expected_macro])
+
+            #     # Convert xml.etree.Element to ObjectifiedElement
+            #     new_macro = fromstring(tostring(macro_element))
+
+            #     file_widget.macros.append(new_macro)
+
+            # write_bob("")

tests/test_files/widget.xml

@@ -9,5 +9,6 @@
   <macros>
     <P>BL23B-DI-MOD-02</P>
     <R>CAM</R>
+    <IOC>test_url/bl23b-di-mod-02</IOC>
   </macros>
 </widget>

tests/test_validator.py

@@ -49,11 +49,12 @@ def test_validator_validate_bob(validator, example_embedded_widget):
     validator.validate = {"motor-edited": Path("tests/test_files/motor-edited.bob")}
     test_pwidget = EmbeddedDisplay(
         "motor",
-        "example/t01-services/synoptic/techui-support/bob/pmac/motor_embed.bob",
+        "tests/test-files/motor_embed.bob",
         0,
         0,
         205,
         120,
     )
+    test_pwidget.macro("macro1", "test_macro_1")
 
     validator.validate_bob("motor-edited", "motor", [test_pwidget])